ToolMessage (Oracle Cloud Infrastructure Java SDK - 3.63.0)

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.generativeaiinference.model.Message
  - - com.oracle.bmc.generativeaiinference.model.ToolMessage

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class ToolMessage
extends Message
```
Represents a single instance of tool message.
Note: Objects should always be created or deserialized using the ToolMessage.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 ToolMessage.Builder, which maintain a set of all explicitly set fields called ToolMessage.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 ToolMessage.Builder
- Nested classes/interfaces inherited from class com.oracle.bmc.generativeaiinference.model.Message
  Message.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

ToolMessage(List<ChatContent> content, String toolCallId)
Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ToolMessage.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getToolCallId()`	Tool call that this message is responding to.
`int`	`hashCode()`
`ToolMessage.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.generativeaiinference.model.Message
getContent

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
  - ToolMessage
```
@Deprecated
public ToolMessage(List<ChatContent> content,
                   String toolCallId)
```
    Deprecated.
- Method Detail
  - builder
```
public static ToolMessage.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public ToolMessage.Builder toBuilder()
```
  - getToolCallId
```
public String getToolCallId()
```
    Tool call that this message is responding to.
    
    Returns:
    
    the value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Message
  - toString
```
public String toString(boolean includeByteArrayContents)
```
    Return a string representation of the object.
    
    Overrides:
    
    toString in class Message
    
    Parameters:
    
    includeByteArrayContents - true to include the full contents of byte arrays
    
    Returns:
    
    string representation
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Message
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Message