CreateToolDetails¶

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

Bases: object

The data to create a Tool.

Methods

__init__(**kwargs) Initializes a new CreateToolDetails object with values from keyword arguments.

Attributes

`agent_id`	[Required] Gets the agent_id of this CreateToolDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateToolDetails.
`defined_tags`	Gets the defined_tags of this CreateToolDetails.
`description`	[Required] Gets the description of this CreateToolDetails.
`display_name`	Gets the display_name of this CreateToolDetails.
`freeform_tags`	Gets the freeform_tags of this CreateToolDetails.
`metadata`	Gets the metadata of this CreateToolDetails.
`tool_config`	[Required] Gets the tool_config of this CreateToolDetails.

__init__(**kwargs)¶

Initializes a new CreateToolDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateToolDetails.
description (str) – The value to assign to the description property of this CreateToolDetails.
agent_id (str) – The value to assign to the agent_id property of this CreateToolDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateToolDetails.
tool_config (oci.generative_ai_agent.models.ToolConfig) – The value to assign to the tool_config property of this CreateToolDetails.
metadata (dict(str, str)) – The value to assign to the metadata property of this CreateToolDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateToolDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateToolDetails.

agent_id¶

[Required] Gets the agent_id of this CreateToolDetails. The OCID of the agent that this Tool is attached to.

Returns:	The agent_id of this CreateToolDetails.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this CreateToolDetails. The OCID of the compartment.

Returns:	The compartment_id of this CreateToolDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateToolDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this CreateToolDetails.
Return type:	dict(str, dict(str, object))

description¶

[Required] Gets the description of this CreateToolDetails. Description about the Tool.

Returns:	The description of this CreateToolDetails.
Return type:	str

display_name¶

Gets the display_name of this CreateToolDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this CreateToolDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateToolDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this CreateToolDetails.
Return type:	dict(str, str)

metadata¶

Gets the metadata of this CreateToolDetails. Key-value pairs to allow additional configurations.

Returns:	The metadata of this CreateToolDetails.
Return type:	dict(str, str)

tool_config¶

[Required] Gets the tool_config of this CreateToolDetails.

Returns:	The tool_config of this CreateToolDetails.
Return type:	oci.generative_ai_agent.models.ToolConfig