AgentEndpoint¶
- class oci.generative_ai_agent.models.AgentEndpoint(**kwargs)¶
Bases:
objectThe endpoint to access a deployed agent.
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:
A constant which can be used with the lifecycle_state property of a AgentEndpoint.
A constant which can be used with the lifecycle_state property of a AgentEndpoint.
A constant which can be used with the lifecycle_state property of a AgentEndpoint.
A constant which can be used with the lifecycle_state property of a AgentEndpoint.
A constant which can be used with the lifecycle_state property of a AgentEndpoint.
A constant which can be used with the lifecycle_state property of a AgentEndpoint.
[Required] Gets the agent_id of this AgentEndpoint.
[Required] Gets the compartment_id of this AgentEndpoint.
Gets the content_moderation_config of this AgentEndpoint.
Gets the defined_tags of this AgentEndpoint.
Gets the description of this AgentEndpoint.
Gets the display_name of this AgentEndpoint.
Gets the freeform_tags of this AgentEndpoint.
Gets the guardrail_config of this AgentEndpoint.
Gets the human_input_config of this AgentEndpoint.
[Required] Gets the id of this AgentEndpoint.
Gets the lifecycle_details of this AgentEndpoint.
[Required] Gets the lifecycle_state of this AgentEndpoint.
Gets the metadata of this AgentEndpoint.
Gets the output_config of this AgentEndpoint.
Gets the provisioned_capacity_config of this AgentEndpoint.
Gets the session_config of this AgentEndpoint.
Gets the should_enable_citation of this AgentEndpoint.
Gets the should_enable_multi_language of this AgentEndpoint.
Gets the should_enable_session of this AgentEndpoint.
Gets the should_enable_trace of this AgentEndpoint.
Gets the system_tags of this AgentEndpoint.
[Required] Gets the time_created of this AgentEndpoint.
Gets the time_updated of this AgentEndpoint.
Methods:
__init__(**kwargs)Initializes a new AgentEndpoint object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a AgentEndpoint. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a AgentEndpoint. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a AgentEndpoint. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a AgentEndpoint. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a AgentEndpoint. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a AgentEndpoint. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new AgentEndpoint 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 AgentEndpoint.
display_name (str) – The value to assign to the display_name property of this AgentEndpoint.
description (str) – The value to assign to the description property of this AgentEndpoint.
compartment_id (str) – The value to assign to the compartment_id property of this AgentEndpoint.
agent_id (str) – The value to assign to the agent_id property of this AgentEndpoint.
content_moderation_config (oci.generative_ai_agent.models.ContentModerationConfig) – The value to assign to the content_moderation_config property of this AgentEndpoint.
guardrail_config (oci.generative_ai_agent.models.GuardrailConfig) – The value to assign to the guardrail_config property of this AgentEndpoint.
metadata (dict(str, str)) – The value to assign to the metadata property of this AgentEndpoint.
human_input_config (oci.generative_ai_agent.models.HumanInputConfig) – The value to assign to the human_input_config property of this AgentEndpoint.
output_config (oci.generative_ai_agent.models.OutputConfig) – The value to assign to the output_config property of this AgentEndpoint.
should_enable_trace (bool) – The value to assign to the should_enable_trace property of this AgentEndpoint.
should_enable_citation (bool) – The value to assign to the should_enable_citation property of this AgentEndpoint.
should_enable_session (bool) – The value to assign to the should_enable_session property of this AgentEndpoint.
should_enable_multi_language (bool) – The value to assign to the should_enable_multi_language property of this AgentEndpoint.
session_config (oci.generative_ai_agent.models.SessionConfig) – The value to assign to the session_config property of this AgentEndpoint.
time_created (datetime) – The value to assign to the time_created property of this AgentEndpoint.
time_updated (datetime) – The value to assign to the time_updated property of this AgentEndpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AgentEndpoint. 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 AgentEndpoint.
provisioned_capacity_config (oci.generative_ai_agent.models.ProvisionedCapacityConfig) – The value to assign to the provisioned_capacity_config property of this AgentEndpoint.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AgentEndpoint.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AgentEndpoint.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AgentEndpoint.
- property agent_id¶
[Required] Gets the agent_id of this AgentEndpoint. The OCID of the agent that this endpoint is associated with.
- Returns
The agent_id of this AgentEndpoint.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this AgentEndpoint. The OCID of the compartment.
- Returns
The compartment_id of this AgentEndpoint.
- Return type
str
- property content_moderation_config¶
Gets the content_moderation_config of this AgentEndpoint.
- Returns
The content_moderation_config of this AgentEndpoint.
- Return type
- property defined_tags¶
Gets the defined_tags of this AgentEndpoint. 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 AgentEndpoint.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this AgentEndpoint. An optional description of the endpoint.
- Returns
The description of this AgentEndpoint.
- Return type
str
- property display_name¶
Gets the display_name of this AgentEndpoint. A user-friendly name. Does not have to be unique, and it’s changeable.
- Returns
The display_name of this AgentEndpoint.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this AgentEndpoint. 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 AgentEndpoint.
- Return type
dict(str, str)
- property guardrail_config¶
Gets the guardrail_config of this AgentEndpoint.
- Returns
The guardrail_config of this AgentEndpoint.
- Return type
- property human_input_config¶
Gets the human_input_config of this AgentEndpoint.
- Returns
The human_input_config of this AgentEndpoint.
- Return type
- property id¶
[Required] Gets the id of this AgentEndpoint. The OCID of the endpoint.
- Returns
The id of this AgentEndpoint.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this AgentEndpoint. A message that describes the current state of the endpoint 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 AgentEndpoint.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this AgentEndpoint. The current state of the endpoint.
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 AgentEndpoint.
- Return type
str
- property metadata¶
Gets the metadata of this AgentEndpoint. Key-value pairs to allow additional configurations.
- Returns
The metadata of this AgentEndpoint.
- Return type
dict(str, str)
- property output_config¶
Gets the output_config of this AgentEndpoint.
- Returns
The output_config of this AgentEndpoint.
- Return type
- property provisioned_capacity_config¶
Gets the provisioned_capacity_config of this AgentEndpoint.
- Returns
The provisioned_capacity_config of this AgentEndpoint.
- Return type
- property session_config¶
Gets the session_config of this AgentEndpoint.
- Returns
The session_config of this AgentEndpoint.
- Return type
- property should_enable_citation¶
Gets the should_enable_citation of this AgentEndpoint. Whether to show citations in the chat result.
- Returns
The should_enable_citation of this AgentEndpoint.
- Return type
bool
- property should_enable_multi_language¶
Gets the should_enable_multi_language of this AgentEndpoint. Whether to enable multi-language for chat.
- Returns
The should_enable_multi_language of this AgentEndpoint.
- Return type
bool
- property should_enable_session¶
Gets the should_enable_session of this AgentEndpoint. Whether or not to enable Session-based chat.
- Returns
The should_enable_session of this AgentEndpoint.
- Return type
bool
- property should_enable_trace¶
Gets the should_enable_trace of this AgentEndpoint. Whether to show traces in the chat result.
- Returns
The should_enable_trace of this AgentEndpoint.
- Return type
bool
- property system_tags¶
Gets the system_tags of this AgentEndpoint. 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 AgentEndpoint.
- Return type
dict(str, dict(str, object))