ChatDetails

class oci.generative_ai_agent_runtime.models.ChatDetails(**kwargs)

Bases: object

Chat details for managing user interactions and tool executions.

Methods

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

Attributes

performed_actions Gets the performed_actions of this ChatDetails.
session_id Gets the session_id of this ChatDetails.
should_stream Gets the should_stream of this ChatDetails.
tool_parameters Gets the tool_parameters of this ChatDetails.
user_message Gets the user_message of this ChatDetails.
__init__(**kwargs)

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

Parameters:
  • user_message (str) – The value to assign to the user_message property of this ChatDetails.
  • should_stream (bool) – The value to assign to the should_stream property of this ChatDetails.
  • session_id (str) – The value to assign to the session_id property of this ChatDetails.
  • tool_parameters (dict(str, str)) – The value to assign to the tool_parameters property of this ChatDetails.
  • performed_actions (list[oci.generative_ai_agent_runtime.models.PerformedAction]) – The value to assign to the performed_actions property of this ChatDetails.
performed_actions

Gets the performed_actions of this ChatDetails. A list of actions that have been performed based on prior required actions.

Returns:The performed_actions of this ChatDetails.
Return type:list[oci.generative_ai_agent_runtime.models.PerformedAction]
session_id

Gets the session_id of this ChatDetails. Optional sessionId. If not provided, will chat without any prior context.

Returns:The session_id of this ChatDetails.
Return type:str
should_stream

Gets the should_stream of this ChatDetails. Whether to stream the response.

Returns:The should_stream of this ChatDetails.
Return type:bool
tool_parameters

Gets the tool_parameters of this ChatDetails. A map where each key is a toolId and the value contains tool type and additional dynamic parameters.

Returns:The tool_parameters of this ChatDetails.
Return type:dict(str, str)
user_message

Gets the user_message of this ChatDetails. The input user message content for the chat.

Returns:The user_message of this ChatDetails.
Return type:str