CreateAgentEndpointDetails

class oci.generative_ai_agent.models.CreateAgentEndpointDetails(**kwargs)

Bases: object

The data to create an endpoint.

Methods

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

Attributes

agent_id [Required] Gets the agent_id of this CreateAgentEndpointDetails.
compartment_id [Required] Gets the compartment_id of this CreateAgentEndpointDetails.
content_moderation_config Gets the content_moderation_config of this CreateAgentEndpointDetails.
defined_tags Gets the defined_tags of this CreateAgentEndpointDetails.
description Gets the description of this CreateAgentEndpointDetails.
display_name Gets the display_name of this CreateAgentEndpointDetails.
freeform_tags Gets the freeform_tags of this CreateAgentEndpointDetails.
session_config Gets the session_config of this CreateAgentEndpointDetails.
should_enable_citation Gets the should_enable_citation of this CreateAgentEndpointDetails.
should_enable_session Gets the should_enable_session of this CreateAgentEndpointDetails.
should_enable_trace Gets the should_enable_trace of this CreateAgentEndpointDetails.
__init__(**kwargs)

Initializes a new CreateAgentEndpointDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • display_name (str) – The value to assign to the display_name property of this CreateAgentEndpointDetails.
  • description (str) – The value to assign to the description property of this CreateAgentEndpointDetails.
  • agent_id (str) – The value to assign to the agent_id property of this CreateAgentEndpointDetails.
  • content_moderation_config (oci.generative_ai_agent.models.ContentModerationConfig) – The value to assign to the content_moderation_config property of this CreateAgentEndpointDetails.
  • should_enable_trace (bool) – The value to assign to the should_enable_trace property of this CreateAgentEndpointDetails.
  • should_enable_citation (bool) – The value to assign to the should_enable_citation property of this CreateAgentEndpointDetails.
  • should_enable_session (bool) – The value to assign to the should_enable_session property of this CreateAgentEndpointDetails.
  • session_config (oci.generative_ai_agent.models.SessionConfig) – The value to assign to the session_config property of this CreateAgentEndpointDetails.
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateAgentEndpointDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateAgentEndpointDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateAgentEndpointDetails.
agent_id

[Required] Gets the agent_id of this CreateAgentEndpointDetails. The OCID of the agent that this endpoint is associated with.

Returns:The agent_id of this CreateAgentEndpointDetails.
Return type:str
compartment_id

[Required] Gets the compartment_id of this CreateAgentEndpointDetails. The OCID of the compartment to create the endpoint in.

Returns:The compartment_id of this CreateAgentEndpointDetails.
Return type:str
content_moderation_config

Gets the content_moderation_config of this CreateAgentEndpointDetails.

Returns:The content_moderation_config of this CreateAgentEndpointDetails.
Return type:oci.generative_ai_agent.models.ContentModerationConfig
defined_tags

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

Gets the description of this CreateAgentEndpointDetails. An optional description of the endpoint.

Returns:The description of this CreateAgentEndpointDetails.
Return type:str
display_name

Gets the display_name of this CreateAgentEndpointDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:The display_name of this CreateAgentEndpointDetails.
Return type:str
freeform_tags

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

Gets the session_config of this CreateAgentEndpointDetails.

Returns:The session_config of this CreateAgentEndpointDetails.
Return type:oci.generative_ai_agent.models.SessionConfig
should_enable_citation

Gets the should_enable_citation of this CreateAgentEndpointDetails. Whether to show citations in the chat result.

Returns:The should_enable_citation of this CreateAgentEndpointDetails.
Return type:bool
should_enable_session

Gets the should_enable_session of this CreateAgentEndpointDetails. Whether or not to enable Session-based chat.

Returns:The should_enable_session of this CreateAgentEndpointDetails.
Return type:bool
should_enable_trace

Gets the should_enable_trace of this CreateAgentEndpointDetails. Whether to show traces in the chat result.

Returns:The should_enable_trace of this CreateAgentEndpointDetails.
Return type:bool