CohereToolMessage (Oracle Cloud Infrastructure Java SDK - 3.63.0)

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.generativeaiinference.model.CohereMessage
  - - com.oracle.bmc.generativeaiinference.model.CohereToolMessage

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class CohereToolMessage
extends CohereMessage
```
A message that represents a single chat dialog as TOOL role.
Note: Objects should always be created or deserialized using the CohereToolMessage.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CohereToolMessage.Builder, which maintain a set of all explicitly set fields called CohereToolMessage.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CohereToolMessage.Builder
- Nested classes/interfaces inherited from class com.oracle.bmc.generativeaiinference.model.CohereMessage
  CohereMessage.Role

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor Description

CohereToolMessage(List<CohereToolResult> toolResults)
Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CohereToolMessage.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`List<CohereToolResult>`	`getToolResults()`	A list of results from invoking tools recommended by the model in the previous chat turn.
`int`	`hashCode()`
`CohereToolMessage.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CohereToolMessage
```
@Deprecated
public CohereToolMessage(List<CohereToolResult> toolResults)
```
    Deprecated.
- Method Detail
  - builder
```
public static CohereToolMessage.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public CohereToolMessage.Builder toBuilder()
```
  - getToolResults
```
public List<CohereToolResult> getToolResults()
```
    A list of results from invoking tools recommended by the model in the previous chat turn.
    
    Returns:
    
    the value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class CohereMessage
  - toString
```
public String toString(boolean includeByteArrayContents)
```
    Return a string representation of the object.
    
    Overrides:
    
    toString in class CohereMessage
    
    Parameters:
    
    includeByteArrayContents - true to include the full contents of byte arrays
    
    Returns:
    
    string representation
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class CohereMessage
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class CohereMessage