ToolSummary¶

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

Bases: object

Summary information of a Tool.

Methods

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

Attributes

`agent_id`	[Required] Gets the agent_id of this ToolSummary.
`compartment_id`	[Required] Gets the compartment_id of this ToolSummary.
`defined_tags`	Gets the defined_tags of this ToolSummary.
`description`	Gets the description of this ToolSummary.
`display_name`	Gets the display_name of this ToolSummary.
`freeform_tags`	Gets the freeform_tags of this ToolSummary.
`id`	[Required] Gets the id of this ToolSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ToolSummary.
`metadata`	Gets the metadata of this ToolSummary.
`system_tags`	Gets the system_tags of this ToolSummary.
`time_created`	[Required] Gets the time_created of this ToolSummary.
`time_updated`	Gets the time_updated of this ToolSummary.
`tool_config`	[Required] Gets the tool_config of this ToolSummary.

__init__(**kwargs)¶

Initializes a new ToolSummary 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 ToolSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ToolSummary.
time_created (datetime) – The value to assign to the time_created property of this ToolSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ToolSummary.
display_name (str) – The value to assign to the display_name property of this ToolSummary.
description (str) – The value to assign to the description property of this ToolSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ToolSummary.
agent_id (str) – The value to assign to the agent_id property of this ToolSummary.
tool_config (oci.generative_ai_agent.models.ToolConfig) – The value to assign to the tool_config property of this ToolSummary.
metadata (dict(str, str)) – The value to assign to the metadata property of this ToolSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ToolSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ToolSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ToolSummary.

agent_id¶

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

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

compartment_id¶

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

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

defined_tags¶

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

description¶

Gets the description of this ToolSummary. Description about the Tool.

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

display_name¶

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

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

freeform_tags¶

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

id¶

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

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

lifecycle_state¶

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

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

metadata¶

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

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

system_tags¶

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

time_created¶

[Required] Gets the time_created of this ToolSummary. 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 ToolSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this ToolSummary. 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 ToolSummary.
Return type:	datetime

tool_config¶

[Required] Gets the tool_config of this ToolSummary.

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