RagToolConfig¶
- class oci.generative_ai_agent.models.RagToolConfig(**kwargs)¶
Bases:
ToolConfigThe configuration for RAG Tool.
Attributes:
A constant which can be used with the tool_config_type property of a ToolConfig.
A constant which can be used with the tool_config_type property of a ToolConfig.
A constant which can be used with the tool_config_type property of a ToolConfig.
A constant which can be used with the tool_config_type property of a ToolConfig.
A constant which can be used with the tool_config_type property of a ToolConfig.
Gets the embedding_llm_customization of this RagToolConfig.
Gets the generation_llm_customization of this RagToolConfig.
[Required] Gets the knowledge_base_configs of this RagToolConfig.
Gets the reasoning_llm_customization of this RagToolConfig.
Gets the reranking_llm_customization of this RagToolConfig.
Gets the runtime_version of this RagToolConfig.
[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_AGENT_TOOL_CONFIG = 'AGENT_TOOL_CONFIG'¶
A constant which can be used with the tool_config_type property of a ToolConfig. This constant has a value of “AGENT_TOOL_CONFIG”
- TOOL_CONFIG_TYPE_FUNCTION_CALLING_TOOL_CONFIG = 'FUNCTION_CALLING_TOOL_CONFIG'¶
A constant which can be used with the tool_config_type property of a ToolConfig. This constant has a value of “FUNCTION_CALLING_TOOL_CONFIG”
- TOOL_CONFIG_TYPE_HTTP_ENDPOINT_TOOL_CONFIG = 'HTTP_ENDPOINT_TOOL_CONFIG'¶
A constant which can be used with the tool_config_type property of a ToolConfig. This constant has a value of “HTTP_ENDPOINT_TOOL_CONFIG”
- TOOL_CONFIG_TYPE_RAG_TOOL_CONFIG = 'RAG_TOOL_CONFIG'¶
A constant which can be used with the tool_config_type property of a ToolConfig. This constant has a value of “RAG_TOOL_CONFIG”
- TOOL_CONFIG_TYPE_SQL_TOOL_CONFIG = 'SQL_TOOL_CONFIG'¶
A constant which can be used with the tool_config_type property of a ToolConfig. This constant has a value of “SQL_TOOL_CONFIG”
- __init__(**kwargs)¶
Initializes a new RagToolConfig object with values from keyword arguments. The default value of the
tool_config_typeattribute of this class isRAG_TOOL_CONFIGand 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”, “AGENT_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.
runtime_version (str) – The value to assign to the runtime_version property of this RagToolConfig.
embedding_llm_customization (oci.generative_ai_agent.models.LlmCustomization) – The value to assign to the embedding_llm_customization property of this RagToolConfig.
reranking_llm_customization (oci.generative_ai_agent.models.LlmCustomization) – The value to assign to the reranking_llm_customization property of this RagToolConfig.
reasoning_llm_customization (oci.generative_ai_agent.models.LlmCustomization) – The value to assign to the reasoning_llm_customization property of this RagToolConfig.
- property embedding_llm_customization¶
Gets the embedding_llm_customization of this RagToolConfig.
- Returns
The embedding_llm_customization of this RagToolConfig.
- Return type
- property generation_llm_customization¶
Gets the generation_llm_customization of this RagToolConfig.
- Returns
The generation_llm_customization of this RagToolConfig.
- Return type
- 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.
- property 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
- property reasoning_llm_customization¶
Gets the reasoning_llm_customization of this RagToolConfig.
- Returns
The reasoning_llm_customization of this RagToolConfig.
- Return type
- property reranking_llm_customization¶
Gets the reranking_llm_customization of this RagToolConfig.
- Returns
The reranking_llm_customization of this RagToolConfig.
- Return type
- property runtime_version¶
Gets the runtime_version of this RagToolConfig. The runtimeVersion of the system prompt.
- Returns
The runtime_version of this RagToolConfig.
- Return type
str
- property tool_config_type¶
[Required] Gets the tool_config_type of this ToolConfig. The type of the Tool config.
Allowed values for this property are: “SQL_TOOL_CONFIG”, “RAG_TOOL_CONFIG”, “FUNCTION_CALLING_TOOL_CONFIG”, “HTTP_ENDPOINT_TOOL_CONFIG”, “AGENT_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