ChatResult¶

class oci.generative_ai_agent_runtime.models.ChatResult(**kwargs)¶

Bases: object

The response of a chat request.

Methods

__init__(**kwargs) Initializes a new ChatResult object with values from keyword arguments.

Attributes

`guardrail_result`	Gets the guardrail_result of this ChatResult.
`message`	Gets the message of this ChatResult.
`required_actions`	Gets the required_actions of this ChatResult.
`tool_results`	Gets the tool_results of this ChatResult.
`traces`	Gets the traces of this ChatResult.

__init__(**kwargs)¶

Initializes a new ChatResult object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

message (oci.generative_ai_agent_runtime.models.Message) – The value to assign to the message property of this ChatResult.
traces (list[oci.generative_ai_agent_runtime.models.Trace]) – The value to assign to the traces property of this ChatResult.
tool_results (dict(str, str)) – The value to assign to the tool_results property of this ChatResult.
required_actions (list[oci.generative_ai_agent_runtime.models.RequiredAction]) – The value to assign to the required_actions property of this ChatResult.
guardrail_result (str) – The value to assign to the guardrail_result property of this ChatResult.

guardrail_result¶

Gets the guardrail_result of this ChatResult. 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 guardrail_result of this ChatResult.
Return type:	str

message¶

Gets the message of this ChatResult.

Returns:	The message of this ChatResult.
Return type:	oci.generative_ai_agent_runtime.models.Message

required_actions¶

Gets the required_actions of this ChatResult. A list of actions the agent requires the user or agent client to perform.

Returns:	The required_actions of this ChatResult.
Return type:	list[oci.generative_ai_agent_runtime.models.RequiredAction]

tool_results¶

Gets the tool_results of this ChatResult. A map where each key is a toolId and the value contains tool type and additional dynamic results.

Returns:	The tool_results of this ChatResult.
Return type:	dict(str, str)

traces¶

Gets the traces of this ChatResult. The trace that displays the internal progression, such as reasoning and actions during an execution.

Returns:	The traces of this ChatResult.
Return type:	list[oci.generative_ai_agent_runtime.models.Trace]