AgentSummary¶

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

Bases: object

Summary information about an agent.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this AgentSummary.
`defined_tags`	Gets the defined_tags of this AgentSummary.
`description`	Gets the description of this AgentSummary.
`display_name`	Gets the display_name of this AgentSummary.
`freeform_tags`	Gets the freeform_tags of this AgentSummary.
`id`	[Required] Gets the id of this AgentSummary.
`knowledge_base_ids`	Gets the knowledge_base_ids of this AgentSummary.
`lifecycle_details`	Gets the lifecycle_details of this AgentSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this AgentSummary.
`system_tags`	Gets the system_tags of this AgentSummary.
`time_created`	[Required] Gets the time_created of this AgentSummary.
`time_updated`	Gets the time_updated of this AgentSummary.
`welcome_message`	Gets the welcome_message of this AgentSummary.

__init__(**kwargs)¶

Initializes a new AgentSummary 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 AgentSummary.
display_name (str) – The value to assign to the display_name property of this AgentSummary.
description (str) – The value to assign to the description property of this AgentSummary.
compartment_id (str) – The value to assign to the compartment_id property of this AgentSummary.
knowledge_base_ids (list[str]) – The value to assign to the knowledge_base_ids property of this AgentSummary.
welcome_message (str) – The value to assign to the welcome_message property of this AgentSummary.
time_created (datetime) – The value to assign to the time_created property of this AgentSummary.
time_updated (datetime) – The value to assign to the time_updated property of this AgentSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AgentSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this AgentSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AgentSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AgentSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AgentSummary.

compartment_id¶

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

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

defined_tags¶

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

description¶

Gets the description of this AgentSummary. Description about the agent.

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

display_name¶

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

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

freeform_tags¶

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

id¶

[Required] Gets the id of this AgentSummary. The OCID of the Agent.

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

knowledge_base_ids¶

Gets the knowledge_base_ids of this AgentSummary. List of OCID of the knowledgeBases associated with agent.

Returns:	The knowledge_base_ids of this AgentSummary.
Return type:	list[str]

lifecycle_details¶

Gets the lifecycle_details of this AgentSummary. A message that describes the current state of the agent in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:	The lifecycle_details of this AgentSummary.
Return type:	str

lifecycle_state¶

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

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

system_tags¶

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

time_created¶

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

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

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

time_updated¶

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

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

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

welcome_message¶

Gets the welcome_message of this AgentSummary. Details about purpose and responsibility of the agent

Returns:	The welcome_message of this AgentSummary.
Return type:	str