Package com.oracle.bmc.generativeaiinference.model

Class AssistantMessage

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiinference.model.Message

com.oracle.bmc.generativeaiinference.model.AssistantMessage

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class AssistantMessage
extends Message

Represents a single instance of assistant message.

Note: When responding to a tool call, set content to null (not ""). This ensures the model correctly processes tool call messages in multi-step interactions.
Note: Objects should always be created or deserialized using the AssistantMessage.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 AssistantMessage.Builder, which maintain a set of all explicitly set fields called AssistantMessage.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	AssistantMessage.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
AssistantMessage(List<ChatContent> content, String name, String refusal, List<ToolCall> toolCalls, List<Annotation> annotations)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static AssistantMessage.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<Annotation>	getAnnotations()	List of annotations generated by the model, including inline citations from web search results.
String	getName()	An optional name for the participant.
String	getRefusal()	The refusal message by the assistant.
List<ToolCall>	getToolCalls()	The tool calls generated by the model, such as function calls.
int	hashCode()
AssistantMessage.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

AssistantMessage

@Deprecated
public AssistantMessage(List<ChatContent> content,
                        String name,
                        String refusal,
                        List<ToolCall> toolCalls,
                        List<Annotation> annotations)

Deprecated.

Method Detail

builder

public static AssistantMessage.Builder builder()

Create a new builder.

toBuilder

public AssistantMessage.Builder toBuilder()

getName

public String getName()

An optional name for the participant.

Provides the model information to differentiate between participants of the same role.

Returns:

the value

getRefusal

public String getRefusal()

The refusal message by the assistant.

Returns:

the value

getToolCalls

public List<ToolCall> getToolCalls()

The tool calls generated by the model, such as function calls.

Returns:

the value

getAnnotations

public List<Annotation> getAnnotations()

List of annotations generated by the model, including inline citations from web search results.

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