@Generated(value="OracleSDKGenerator",
comments="API Version: 20240531")
public final class Agent
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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](https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
Note: Objects should always be created or deserialized using the Agent.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the Agent.Builder, which maintain a
set of all explicitly set fields called Agent.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Agent.Builder |
static class |
Agent.LifecycleState
The current state of the agent.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Agent(String id,
String displayName,
String description,
String compartmentId,
List<String> knowledgeBaseIds,
String welcomeMessage,
Date timeCreated,
Date timeUpdated,
Agent.LifecycleState lifecycleState,
String lifecycleDetails,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Agent.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of
the compartment.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
Description about the agent.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of
the agent.
|
List<String> |
getKnowledgeBaseIds()
List of OCID
of the knowledgeBases associated with agent.
|
String |
getLifecycleDetails()
A message that describes the current state of the agent in more detail.
|
Agent.LifecycleState |
getLifecycleState()
The current state of the agent.
|
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time the agent was created, in the format defined by RFC
3339.
|
Date |
getTimeUpdated()
The date and time the agent was updated, in the format defined by RFC
3339.
|
String |
getWelcomeMessage()
Details about purpose and responsibility of the agent
|
int |
hashCode() |
Agent.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","description","compartmentId","knowledgeBaseIds","welcomeMessage","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags","systemTags"}) public Agent(String id, String displayName, String description, String compartmentId, List<String> knowledgeBaseIds, String welcomeMessage, Date timeCreated, Date timeUpdated, Agent.LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static Agent.Builder builder()
Create a new builder.
public Agent.Builder toBuilder()
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable.
public String getDescription()
Description about the agent.
public List<String> getKnowledgeBaseIds()
List of OCID of the knowledgeBases associated with agent.
public String getWelcomeMessage()
Details about purpose and responsibility of the agent
public Date getTimeCreated()
The date and time the agent was created, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z
public Date getTimeUpdated()
The date and time the agent was updated, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z
public Agent.LifecycleState getLifecycleState()
The current state of the agent.
public String getLifecycleDetails()
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.
public Map<String,String> getFreeformTags()
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"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
public Map<String,Map<String,Object>> getSystemTags()
System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.