Tool¶

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

Bases: object

The description of Tool.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Tool.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Tool.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Tool.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Tool.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Tool.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Tool.
`agent_id`	[Required] Gets the agent_id of this Tool.
`compartment_id`	[Required] Gets the compartment_id of this Tool.
`defined_tags`	Gets the defined_tags of this Tool.
`description`	[Required] Gets the description of this Tool.
`display_name`	Gets the display_name of this Tool.
`freeform_tags`	Gets the freeform_tags of this Tool.
`id`	[Required] Gets the id of this Tool.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Tool.
`metadata`	Gets the metadata of this Tool.
`system_tags`	Gets the system_tags of this Tool.
`time_created`	[Required] Gets the time_created of this Tool.
`time_updated`	Gets the time_updated of this Tool.
`tool_config`	[Required] Gets the tool_config of this Tool.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Tool. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Tool. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Tool. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Tool. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Tool. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Tool. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this Tool.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Tool. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this Tool.
time_updated (datetime) – The value to assign to the time_updated property of this Tool.
display_name (str) – The value to assign to the display_name property of this Tool.
description (str) – The value to assign to the description property of this Tool.
compartment_id (str) – The value to assign to the compartment_id property of this Tool.
agent_id (str) – The value to assign to the agent_id property of this Tool.
tool_config (oci.generative_ai_agent.models.ToolConfig) – The value to assign to the tool_config property of this Tool.
metadata (dict(str, str)) – The value to assign to the metadata property of this Tool.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Tool.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Tool.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Tool.

agent_id¶

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

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

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this Tool. 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 Tool.
Return type:	dict(str, dict(str, object))

description¶

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

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

display_name¶

Gets the display_name of this Tool. A user-friendly name. Does not have to be unique, and it’s changeable.

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

freeform_tags¶

Gets the freeform_tags of this Tool. 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 Tool.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Tool. The OCID of the Tool.

Returns:	The id of this Tool.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this Tool. The current state of the Tool.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Tool.
Return type:	str

metadata¶

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

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

system_tags¶

Gets the system_tags of this Tool. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this Tool.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this Tool. The date and time the Tool was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this Tool.
Return type:	datetime

time_updated¶

Gets the time_updated of this Tool. The date and time the Tool was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this Tool.
Return type:	datetime

tool_config¶

[Required] Gets the tool_config of this Tool.

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