Agent¶

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

Bases: object

An agent is an LLM-based autonomous system that understands and generates human-like text, enabling natural-language processing interactions. OCI Generative AI Agents supports retrieval-augmented generation (RAG) agents. A RAG agent connects to a data source, retrieves data, and augments model responses with the information from the data sources to generate more relevant responses.

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 Agent.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Agent.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Agent.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Agent.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Agent.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Agent.
`compartment_id`	[Required] Gets the compartment_id of this Agent.
`defined_tags`	Gets the defined_tags of this Agent.
`description`	Gets the description of this Agent.
`display_name`	Gets the display_name of this Agent.
`freeform_tags`	Gets the freeform_tags of this Agent.
`id`	[Required] Gets the id of this Agent.
`knowledge_base_ids`	Gets the knowledge_base_ids of this Agent.
`lifecycle_details`	Gets the lifecycle_details of this Agent.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Agent.
`system_tags`	Gets the system_tags of this Agent.
`time_created`	[Required] Gets the time_created of this Agent.
`time_updated`	Gets the time_updated of this Agent.
`welcome_message`	Gets the welcome_message of this Agent.

Methods

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

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

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

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

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

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

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

__init__(**kwargs)¶

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

compartment_id¶

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

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

defined_tags¶

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

description¶

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

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

display_name¶

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

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

freeform_tags¶

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

id¶

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

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

knowledge_base_ids¶

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

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

lifecycle_details¶

Gets the lifecycle_details of this Agent. 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 Agent.
Return type:	str

lifecycle_state¶

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

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 Agent.
Return type:	str

system_tags¶

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

time_created¶

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

time_updated¶

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

welcome_message¶

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

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