AgentEndpointSummary¶
- class oci.generative_ai_agent.models.AgentEndpointSummary(**kwargs)¶
Bases:
objectSummary information about an endpoint.
Methods:
__init__(**kwargs)Initializes a new AgentEndpointSummary object with values from keyword arguments.
Attributes:
[Required] Gets the agent_id of this AgentEndpointSummary.
[Required] Gets the compartment_id of this AgentEndpointSummary.
Gets the content_moderation_config of this AgentEndpointSummary.
Gets the defined_tags of this AgentEndpointSummary.
Gets the description of this AgentEndpointSummary.
Gets the display_name of this AgentEndpointSummary.
Gets the freeform_tags of this AgentEndpointSummary.
Gets the guardrail_config of this AgentEndpointSummary.
Gets the human_input_config of this AgentEndpointSummary.
[Required] Gets the id of this AgentEndpointSummary.
Gets the lifecycle_details of this AgentEndpointSummary.
[Required] Gets the lifecycle_state of this AgentEndpointSummary.
Gets the metadata of this AgentEndpointSummary.
Gets the output_config of this AgentEndpointSummary.
Gets the provisioned_capacity_config of this AgentEndpointSummary.
Gets the session_config of this AgentEndpointSummary.
Gets the should_enable_citation of this AgentEndpointSummary.
Gets the should_enable_multi_language of this AgentEndpointSummary.
Gets the should_enable_session of this AgentEndpointSummary.
Gets the should_enable_trace of this AgentEndpointSummary.
Gets the system_tags of this AgentEndpointSummary.
[Required] Gets the time_created of this AgentEndpointSummary.
Gets the time_updated of this AgentEndpointSummary.
- __init__(**kwargs)¶
Initializes a new AgentEndpointSummary 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 AgentEndpointSummary.
display_name (str) – The value to assign to the display_name property of this AgentEndpointSummary.
description (str) – The value to assign to the description property of this AgentEndpointSummary.
compartment_id (str) – The value to assign to the compartment_id property of this AgentEndpointSummary.
agent_id (str) – The value to assign to the agent_id property of this AgentEndpointSummary.
content_moderation_config (oci.generative_ai_agent.models.ContentModerationConfig) – The value to assign to the content_moderation_config property of this AgentEndpointSummary.
guardrail_config (oci.generative_ai_agent.models.GuardrailConfig) – The value to assign to the guardrail_config property of this AgentEndpointSummary.
metadata (dict(str, str)) – The value to assign to the metadata property of this AgentEndpointSummary.
human_input_config (oci.generative_ai_agent.models.HumanInputConfig) – The value to assign to the human_input_config property of this AgentEndpointSummary.
output_config (oci.generative_ai_agent.models.OutputConfig) – The value to assign to the output_config property of this AgentEndpointSummary.
should_enable_trace (bool) – The value to assign to the should_enable_trace property of this AgentEndpointSummary.
should_enable_citation (bool) – The value to assign to the should_enable_citation property of this AgentEndpointSummary.
should_enable_session (bool) – The value to assign to the should_enable_session property of this AgentEndpointSummary.
should_enable_multi_language (bool) – The value to assign to the should_enable_multi_language property of this AgentEndpointSummary.
session_config (oci.generative_ai_agent.models.SessionConfig) – The value to assign to the session_config property of this AgentEndpointSummary.
time_created (datetime) – The value to assign to the time_created property of this AgentEndpointSummary.
time_updated (datetime) – The value to assign to the time_updated property of this AgentEndpointSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AgentEndpointSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this AgentEndpointSummary.
provisioned_capacity_config (oci.generative_ai_agent.models.ProvisionedCapacityConfig) – The value to assign to the provisioned_capacity_config property of this AgentEndpointSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AgentEndpointSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AgentEndpointSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AgentEndpointSummary.
- property agent_id¶
[Required] Gets the agent_id of this AgentEndpointSummary. The OCID of the agent that this AgentEndpoint is associated with.
- Returns
The agent_id of this AgentEndpointSummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this AgentEndpointSummary. The OCID of the compartment.
- Returns
The compartment_id of this AgentEndpointSummary.
- Return type
str
- property content_moderation_config¶
Gets the content_moderation_config of this AgentEndpointSummary.
- Returns
The content_moderation_config of this AgentEndpointSummary.
- Return type
- property defined_tags¶
Gets the defined_tags of this AgentEndpointSummary. 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 AgentEndpointSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this AgentEndpointSummary. An optional description of the endpoint.
- Returns
The description of this AgentEndpointSummary.
- Return type
str
- property display_name¶
Gets the display_name of this AgentEndpointSummary. A user-friendly name. Does not have to be unique, and it’s changeable.
- Returns
The display_name of this AgentEndpointSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this AgentEndpointSummary. 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 AgentEndpointSummary.
- Return type
dict(str, str)
- property guardrail_config¶
Gets the guardrail_config of this AgentEndpointSummary.
- Returns
The guardrail_config of this AgentEndpointSummary.
- Return type
- property human_input_config¶
Gets the human_input_config of this AgentEndpointSummary.
- Returns
The human_input_config of this AgentEndpointSummary.
- Return type
- property id¶
[Required] Gets the id of this AgentEndpointSummary. The OCID of the AgentEndpoint.
- Returns
The id of this AgentEndpointSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this AgentEndpointSummary. 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 AgentEndpointSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this AgentEndpointSummary. The current state of the endpoint.
- Returns
The lifecycle_state of this AgentEndpointSummary.
- Return type
str
- property metadata¶
Gets the metadata of this AgentEndpointSummary. Key-value pairs to allow additional configurations.
- Returns
The metadata of this AgentEndpointSummary.
- Return type
dict(str, str)
- property output_config¶
Gets the output_config of this AgentEndpointSummary.
- Returns
The output_config of this AgentEndpointSummary.
- Return type
- property provisioned_capacity_config¶
Gets the provisioned_capacity_config of this AgentEndpointSummary.
- Returns
The provisioned_capacity_config of this AgentEndpointSummary.
- Return type
- property session_config¶
Gets the session_config of this AgentEndpointSummary.
- Returns
The session_config of this AgentEndpointSummary.
- Return type
- property should_enable_citation¶
Gets the should_enable_citation of this AgentEndpointSummary. Whether to show citations in the chat result.
- Returns
The should_enable_citation of this AgentEndpointSummary.
- Return type
bool
- property should_enable_multi_language¶
Gets the should_enable_multi_language of this AgentEndpointSummary. Whether to enable multi-language for chat.
- Returns
The should_enable_multi_language of this AgentEndpointSummary.
- Return type
bool
- property should_enable_session¶
Gets the should_enable_session of this AgentEndpointSummary. Whether or not to enable Session-based chat.
- Returns
The should_enable_session of this AgentEndpointSummary.
- Return type
bool
- property should_enable_trace¶
Gets the should_enable_trace of this AgentEndpointSummary. Whether to show traces in the chat result.
- Returns
The should_enable_trace of this AgentEndpointSummary.
- Return type
bool
- property system_tags¶
Gets the system_tags of this AgentEndpointSummary. 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 AgentEndpointSummary.
- Return type
dict(str, dict(str, object))