Package com.oracle.bmc.generativeaiagentruntime.model

Class ChatResult

java.lang.Object

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

com.oracle.bmc.generativeaiagentruntime.model.ChatResult

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public final class ChatResult
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The response of a chat request.
Note: Objects should always be created or deserialized using the ChatResult.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 ChatResult.Builder, which maintain a set of all explicitly set fields called ChatResult.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	ChatResult.Builder

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
ChatResult(Message message, List<Trace> traces, Map<String,String> toolResults, List<ToolOutput> toolOutputs, List<RequiredAction> requiredActions, String guardrailResult)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ChatResult.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getGuardrailResult()	Captures the result of guardrail evaluations as JSON string performed on either the input to the agent or the output generated by the agent.
Message	getMessage()
List<RequiredAction>	getRequiredActions()	A list of actions the agent requires the user or agent client to perform.
List<ToolOutput>	getToolOutputs()	Array of tool outputs in execution order.
Map<String,String>	getToolResults()	A map where each key is a toolId and the value contains tool type and additional dynamic results.
List<Trace>	getTraces()	The trace that displays the internal progression, such as reasoning and actions during an execution.
int	hashCode()
ChatResult.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

ChatResult

@Deprecated
@ConstructorProperties({"message","traces","toolResults","toolOutputs","requiredActions","guardrailResult"})
public ChatResult(Message message,
                  List<Trace> traces,
                  Map<String,String> toolResults,
                  List<ToolOutput> toolOutputs,
                  List<RequiredAction> requiredActions,
                  String guardrailResult)

Deprecated.

Method Detail

builder

public static ChatResult.Builder builder()

Create a new builder.

toBuilder

public ChatResult.Builder toBuilder()

getMessage

public Message getMessage()

getTraces

public List<Trace> getTraces()

The trace that displays the internal progression, such as reasoning and actions during an execution.

Returns:

the value

getToolResults

public Map<String,String> getToolResults()

A map where each key is a toolId and the value contains tool type and additional dynamic results.

This field is deprecated and will be removed after July 02 2026.

Returns:

the value

getToolOutputs

public List<ToolOutput> getToolOutputs()

Array of tool outputs in execution order.

Each item includes the tool OCID, output type, and corresponding content. The result structure is defined by the toolOutputType discriminator.

Returns:

the value

getRequiredActions

public List<RequiredAction> getRequiredActions()

A list of actions the agent requires the user or agent client to perform.

Returns:

the value

getGuardrailResult

public String getGuardrailResult()

Captures the result of guardrail evaluations as JSON string performed on either the input to the agent or the output generated by the agent.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel