SqlToolOutput¶

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

Bases: oci.generative_ai_agent_runtime.models.tool_output.ToolOutput

Specifies the output format for SQL tools, including the generated SQL statement and an optional preview of the query result.

Attributes

`TOOL_OUTPUT_TYPE_GENERIC_TOOL_OUTPUT`	str(object=’’) -> str
`TOOL_OUTPUT_TYPE_RAG_TOOL_OUTPUT`	str(object=’’) -> str
`TOOL_OUTPUT_TYPE_SQL_TOOL_OUTPUT`	str(object=’’) -> str
`additional_info`	Gets the additional_info of this SqlToolOutput.
`generated_sql`	[Required] Gets the generated_sql of this SqlToolOutput.
`result`	Gets the result of this SqlToolOutput.
`result_files`	Gets the result_files of this SqlToolOutput.
`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 SqlToolOutput 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'¶

TOOL_OUTPUT_TYPE_RAG_TOOL_OUTPUT = 'RAG_TOOL_OUTPUT'¶

TOOL_OUTPUT_TYPE_SQL_TOOL_OUTPUT = 'SQL_TOOL_OUTPUT'¶

__init__(**kwargs)¶

Initializes a new SqlToolOutput object with values from keyword arguments. The default value of the tool_output_type attribute of this class is SQL_TOOL_OUTPUT and it should not be changed. 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 SqlToolOutput.
tool_name (str) – The value to assign to the tool_name property of this SqlToolOutput.
tool_output_type (str) – The value to assign to the tool_output_type property of this SqlToolOutput. Allowed values for this property are: “GENERIC_TOOL_OUTPUT”, “SQL_TOOL_OUTPUT”, “RAG_TOOL_OUTPUT”
generated_sql (str) – The value to assign to the generated_sql property of this SqlToolOutput.
result (list[object]) – The value to assign to the result property of this SqlToolOutput.
result_files (oci.generative_ai_agent_runtime.models.SqlResultFiles) – The value to assign to the result_files property of this SqlToolOutput.
additional_info (str) – The value to assign to the additional_info property of this SqlToolOutput.

additional_info¶

Gets the additional_info of this SqlToolOutput. Specifies optional metadata content.

Returns:	The additional_info of this SqlToolOutput.
Return type:	str

generated_sql¶

[Required] Gets the generated_sql of this SqlToolOutput. Specifies the generated SQL query.

Returns:	The generated_sql of this SqlToolOutput.
Return type:	str

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.

result¶

Gets the result of this SqlToolOutput. Represents preview rows from the SQL query.

Returns:	The result of this SqlToolOutput.
Return type:	list[object]

result_files¶

Gets the result_files of this SqlToolOutput.

Returns:	The result_files of this SqlToolOutput.
Return type:	oci.generative_ai_agent_runtime.models.SqlResultFiles

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