Data Source: oci_generative_ai_agent_agents
This data source provides the list of Agents in Oracle Cloud Infrastructure Generative Ai Agent service.
ListAgents
Gets a list of agents.
Example Usage
data "oci_generative_ai_agent_agents" "test_agents" {
#Optional
compartment_id = var.compartment_id
display_name = var.agent_display_name
state = var.agent_state
}
Argument Reference
The following arguments are supported:
compartment_id
- (Optional) The OCID of the compartment in which to list resources.display_name
- (Optional) A filter to return only resources that match the given display name exactly.state
- (Optional) A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
Attributes Reference
The following attributes are exported:
agent_collection
- The list of agent_collection.
Agent Reference
The following attributes are exported:
compartment_id
- The OCID of the compartment.defined_tags
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:{"Operations.CostCenter": "42"}
description
- Description about the agent.display_name
- A user-friendly name. Does not have to be unique, and it’s changeable.freeform_tags
- 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"}
id
- The OCID of the agent.knowledge_base_ids
- List of OCID of the knowledgeBases associated with agent.lifecycle_details
- 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.state
- The current state of the agent.system_tags
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:{"orcl-cloud.free-tier-retained": "true"}
time_created
- The date and time the agent was created, in the format defined by RFC 3339. Example:2016-08-25T21:10:29.600Z
time_updated
- The date and time the agent was updated, in the format defined by RFC 3339. Example:2016-08-25T21:10:29.600Z
welcome_message
- Details about purpose and responsibility of the agent