RagToolOutput¶

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

Bases: oci.generative_ai_agent_runtime.models.tool_output.ToolOutput

Specifies the output format for RAG tool, including the generated answer and citations.

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
`citations`	Gets the citations of this RagToolOutput.
`paragraph_citations`	Gets the paragraph_citations of this RagToolOutput.
`text`	[Required] Gets the text of this RagToolOutput.
`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 RagToolOutput 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 RagToolOutput object with values from keyword arguments. The default value of the tool_output_type attribute of this class is RAG_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 RagToolOutput.
tool_name (str) – The value to assign to the tool_name property of this RagToolOutput.
tool_output_type (str) – The value to assign to the tool_output_type property of this RagToolOutput. Allowed values for this property are: “GENERIC_TOOL_OUTPUT”, “SQL_TOOL_OUTPUT”, “RAG_TOOL_OUTPUT”
text (str) – The value to assign to the text property of this RagToolOutput.
citations (list[oci.generative_ai_agent_runtime.models.Citation]) – The value to assign to the citations property of this RagToolOutput.
paragraph_citations (list[oci.generative_ai_agent_runtime.models.ParagraphCitation]) – The value to assign to the paragraph_citations property of this RagToolOutput.

citations¶

Gets the citations of this RagToolOutput. Citations to data sources used for tool’s generated answer.

Returns:	The citations of this RagToolOutput.
Return type:	list[oci.generative_ai_agent_runtime.models.Citation]

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.

paragraph_citations¶

Gets the paragraph_citations of this RagToolOutput. A list of citations used to generate the paragraphs of the tool’s generated answer.

Returns:	The paragraph_citations of this RagToolOutput.
Return type:	list[oci.generative_ai_agent_runtime.models.ParagraphCitation]

text¶

[Required] Gets the text of this RagToolOutput. Specifies the generated answer from the RAG tool.

Returns:	The text of this RagToolOutput.
Return type:	str

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