RagToolConfig¶

class oci.generative_ai_agent.models.RagToolConfig(**kwargs)¶

Bases: oci.generative_ai_agent.models.tool_config.ToolConfig

The configuration for RAG Tool.

Attributes

`TOOL_CONFIG_TYPE_FUNCTION_CALLING_TOOL_CONFIG`	str(object=’’) -> str
`TOOL_CONFIG_TYPE_HTTP_ENDPOINT_TOOL_CONFIG`	str(object=’’) -> str
`TOOL_CONFIG_TYPE_RAG_TOOL_CONFIG`	str(object=’’) -> str
`TOOL_CONFIG_TYPE_SQL_TOOL_CONFIG`	str(object=’’) -> str
`generation_llm_customization`	Gets the generation_llm_customization of this RagToolConfig.
`knowledge_base_configs`	[Required] Gets the knowledge_base_configs of this RagToolConfig.
`tool_config_type`	[Required] Gets the tool_config_type of this ToolConfig.

Methods

`__init__`(**kwargs)	Initializes a new RagToolConfig 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_CONFIG_TYPE_FUNCTION_CALLING_TOOL_CONFIG = 'FUNCTION_CALLING_TOOL_CONFIG'¶

TOOL_CONFIG_TYPE_HTTP_ENDPOINT_TOOL_CONFIG = 'HTTP_ENDPOINT_TOOL_CONFIG'¶

TOOL_CONFIG_TYPE_RAG_TOOL_CONFIG = 'RAG_TOOL_CONFIG'¶

TOOL_CONFIG_TYPE_SQL_TOOL_CONFIG = 'SQL_TOOL_CONFIG'¶

__init__(**kwargs)¶

Initializes a new RagToolConfig object with values from keyword arguments. The default value of the tool_config_type attribute of this class is RAG_TOOL_CONFIG and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

tool_config_type (str) – The value to assign to the tool_config_type property of this RagToolConfig. Allowed values for this property are: “SQL_TOOL_CONFIG”, “RAG_TOOL_CONFIG”, “FUNCTION_CALLING_TOOL_CONFIG”, “HTTP_ENDPOINT_TOOL_CONFIG”
knowledge_base_configs (list[oci.generative_ai_agent.models.KnowledgeBaseConfig]) – The value to assign to the knowledge_base_configs property of this RagToolConfig.
generation_llm_customization (oci.generative_ai_agent.models.LlmCustomization) – The value to assign to the generation_llm_customization property of this RagToolConfig.

generation_llm_customization¶

Gets the generation_llm_customization of this RagToolConfig.

Returns:	The generation_llm_customization of this RagToolConfig.
Return type:	oci.generative_ai_agent.models.LlmCustomization

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.

knowledge_base_configs¶

[Required] Gets the knowledge_base_configs of this RagToolConfig. The KnowledgeBase configurations that this RAG Tool uses

Returns:	The knowledge_base_configs of this RagToolConfig.
Return type:	list[oci.generative_ai_agent.models.KnowledgeBaseConfig]

tool_config_type¶

[Required] Gets the tool_config_type of this ToolConfig. The type of the Tool config. The allowed values are: - SQL_TOOL_CONFIG: The config for sql Tool. - RAG_TOOL_CONFIG: The config for rag Tool. - FUNCTION_CALLING_TOOL_CONFIG: The config for Function calling Tool. - HTTP_ENDPOINT_TOOL_CONFIG: The config for HTTP endpoint Tool.

Allowed values for this property are: “SQL_TOOL_CONFIG”, “RAG_TOOL_CONFIG”, “FUNCTION_CALLING_TOOL_CONFIG”, “HTTP_ENDPOINT_TOOL_CONFIG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The tool_config_type of this ToolConfig.
Return type:	str