ToolOutput¶

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

Bases: object

Base schema for tool outputs. Identified by toolOutputType, which determines the format of the output content.

Attributes

`TOOL_OUTPUT_TYPE_GENERIC_TOOL_OUTPUT`	A constant which can be used with the tool_output_type property of a ToolOutput.
`TOOL_OUTPUT_TYPE_RAG_TOOL_OUTPUT`	A constant which can be used with the tool_output_type property of a ToolOutput.
`TOOL_OUTPUT_TYPE_SQL_TOOL_OUTPUT`	A constant which can be used with the tool_output_type property of a ToolOutput.
`tool_id`	[Required] Gets the tool_id of this ToolOutput.
`tool_name`	Gets the tool_name of this ToolOutput.
`tool_output_type`	[Required] Gets the tool_output_type of this ToolOutput.

Methods

`__init__`(**kwargs)	Initializes a new ToolOutput object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

TOOL_OUTPUT_TYPE_GENERIC_TOOL_OUTPUT = 'GENERIC_TOOL_OUTPUT'¶: A constant which can be used with the tool_output_type property of a ToolOutput. This constant has a value of “GENERIC_TOOL_OUTPUT”

TOOL_OUTPUT_TYPE_RAG_TOOL_OUTPUT = 'RAG_TOOL_OUTPUT'¶: A constant which can be used with the tool_output_type property of a ToolOutput. This constant has a value of “RAG_TOOL_OUTPUT”

TOOL_OUTPUT_TYPE_SQL_TOOL_OUTPUT = 'SQL_TOOL_OUTPUT'¶: A constant which can be used with the tool_output_type property of a ToolOutput. This constant has a value of “SQL_TOOL_OUTPUT”

__init__(**kwargs)¶

Initializes a new ToolOutput object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

tool_id (str) – The value to assign to the tool_id property of this ToolOutput.
tool_name (str) – The value to assign to the tool_name property of this ToolOutput.
tool_output_type (str) – The value to assign to the tool_output_type property of this ToolOutput. Allowed values for this property are: “GENERIC_TOOL_OUTPUT”, “SQL_TOOL_OUTPUT”, “RAG_TOOL_OUTPUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

tool_id¶

[Required] Gets the tool_id of this ToolOutput. Specifies the unique OCID of the tool.

Returns:	The tool_id of this ToolOutput.
Return type:	str

tool_name¶

Gets the tool_name of this ToolOutput. Specifies the display name of the tool.

Returns:	The tool_name of this ToolOutput.
Return type:	str

tool_output_type¶

[Required] Gets the tool_output_type of this ToolOutput. Specifies the type of tool output (e.g., GENERIC_TOOL_OUTPUT, SQL_TOOL_OUTPUT).

Allowed values for this property are: “GENERIC_TOOL_OUTPUT”, “SQL_TOOL_OUTPUT”, “RAG_TOOL_OUTPUT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The tool_output_type of this ToolOutput.
Return type:	str