HttpEndpointToolConfig¶

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

Bases: oci.generative_ai_agent.models.tool_config.ToolConfig

The configuration for HTTP endpoint 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
`api_schema`	[Required] Gets the api_schema of this HttpEndpointToolConfig.
`http_endpoint_auth_config`	[Required] Gets the http_endpoint_auth_config of this HttpEndpointToolConfig.
`subnet_id`	[Required] Gets the subnet_id of this HttpEndpointToolConfig.
`tool_config_type`	[Required] Gets the tool_config_type of this ToolConfig.

Methods

`__init__`(**kwargs)	Initializes a new HttpEndpointToolConfig 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 HttpEndpointToolConfig object with values from keyword arguments. The default value of the tool_config_type attribute of this class is HTTP_ENDPOINT_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 HttpEndpointToolConfig. Allowed values for this property are: “SQL_TOOL_CONFIG”, “RAG_TOOL_CONFIG”, “FUNCTION_CALLING_TOOL_CONFIG”, “HTTP_ENDPOINT_TOOL_CONFIG”
api_schema (oci.generative_ai_agent.models.ApiSchemaInputLocation) – The value to assign to the api_schema property of this HttpEndpointToolConfig.
subnet_id (str) – The value to assign to the subnet_id property of this HttpEndpointToolConfig.
http_endpoint_auth_config (oci.generative_ai_agent.models.HttpEndpointAuthConfig) – The value to assign to the http_endpoint_auth_config property of this HttpEndpointToolConfig.

api_schema¶

[Required] Gets the api_schema of this HttpEndpointToolConfig.

Returns:	The api_schema of this HttpEndpointToolConfig.
Return type:	oci.generative_ai_agent.models.ApiSchemaInputLocation

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.

http_endpoint_auth_config¶

[Required] Gets the http_endpoint_auth_config of this HttpEndpointToolConfig.

Returns:	The http_endpoint_auth_config of this HttpEndpointToolConfig.
Return type:	oci.generative_ai_agent.models.HttpEndpointAuthConfig

subnet_id¶

[Required] Gets the subnet_id of this HttpEndpointToolConfig. The subnet ID from agent developer tenancy through which the egress is going to be routed.

Returns:	The subnet_id of this HttpEndpointToolConfig.
Return type:	str

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