UpdateAgentEndpointDetails¶

class oci.generative_ai_agent.models.UpdateAgentEndpointDetails(**kwargs)¶

Bases: object

The data to update an endpoint.

Methods

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

Attributes

`content_moderation_config`	Gets the content_moderation_config of this UpdateAgentEndpointDetails.
`defined_tags`	Gets the defined_tags of this UpdateAgentEndpointDetails.
`description`	Gets the description of this UpdateAgentEndpointDetails.
`display_name`	Gets the display_name of this UpdateAgentEndpointDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateAgentEndpointDetails.
`guardrail_config`	Gets the guardrail_config of this UpdateAgentEndpointDetails.
`human_input_config`	Gets the human_input_config of this UpdateAgentEndpointDetails.
`metadata`	Gets the metadata of this UpdateAgentEndpointDetails.
`output_config`	Gets the output_config of this UpdateAgentEndpointDetails.
`session_config`	Gets the session_config of this UpdateAgentEndpointDetails.
`should_enable_citation`	Gets the should_enable_citation of this UpdateAgentEndpointDetails.
`should_enable_multi_language`	Gets the should_enable_multi_language of this UpdateAgentEndpointDetails.
`should_enable_trace`	Gets the should_enable_trace of this UpdateAgentEndpointDetails.

__init__(**kwargs)¶

Initializes a new UpdateAgentEndpointDetails 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 UpdateAgentEndpointDetails.
description (str) – The value to assign to the description property of this UpdateAgentEndpointDetails.
content_moderation_config (oci.generative_ai_agent.models.ContentModerationConfig) – The value to assign to the content_moderation_config property of this UpdateAgentEndpointDetails.
guardrail_config (oci.generative_ai_agent.models.GuardrailConfig) – The value to assign to the guardrail_config property of this UpdateAgentEndpointDetails.
metadata (dict(str, str)) – The value to assign to the metadata property of this UpdateAgentEndpointDetails.
human_input_config (oci.generative_ai_agent.models.HumanInputConfig) – The value to assign to the human_input_config property of this UpdateAgentEndpointDetails.
output_config (oci.generative_ai_agent.models.OutputConfig) – The value to assign to the output_config property of this UpdateAgentEndpointDetails.
should_enable_trace (bool) – The value to assign to the should_enable_trace property of this UpdateAgentEndpointDetails.
should_enable_citation (bool) – The value to assign to the should_enable_citation property of this UpdateAgentEndpointDetails.
should_enable_multi_language (bool) – The value to assign to the should_enable_multi_language property of this UpdateAgentEndpointDetails.
session_config (oci.generative_ai_agent.models.SessionConfig) – The value to assign to the session_config property of this UpdateAgentEndpointDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateAgentEndpointDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateAgentEndpointDetails.

content_moderation_config¶

Gets the content_moderation_config of this UpdateAgentEndpointDetails.

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

defined_tags¶

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

description¶

Gets the description of this UpdateAgentEndpointDetails. An optional description of the AgentEndpoint.

Returns:	The description of this UpdateAgentEndpointDetails.
Return type:	str

display_name¶

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

Returns:	The display_name of this UpdateAgentEndpointDetails.
Return type:	str

freeform_tags¶

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

guardrail_config¶

Gets the guardrail_config of this UpdateAgentEndpointDetails.

Returns:	The guardrail_config of this UpdateAgentEndpointDetails.
Return type:	oci.generative_ai_agent.models.GuardrailConfig

human_input_config¶

Gets the human_input_config of this UpdateAgentEndpointDetails.

Returns:	The human_input_config of this UpdateAgentEndpointDetails.
Return type:	oci.generative_ai_agent.models.HumanInputConfig

metadata¶

Gets the metadata of this UpdateAgentEndpointDetails. Key-value pairs to allow additional configurations.

Returns:	The metadata of this UpdateAgentEndpointDetails.
Return type:	dict(str, str)

output_config¶

Gets the output_config of this UpdateAgentEndpointDetails.

Returns:	The output_config of this UpdateAgentEndpointDetails.
Return type:	oci.generative_ai_agent.models.OutputConfig

session_config¶

Gets the session_config of this UpdateAgentEndpointDetails.

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

should_enable_citation¶

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

Returns:	The should_enable_citation of this UpdateAgentEndpointDetails.
Return type:	bool

should_enable_multi_language¶

Gets the should_enable_multi_language of this UpdateAgentEndpointDetails. Whether to enable multi-language for chat.

Returns:	The should_enable_multi_language of this UpdateAgentEndpointDetails.
Return type:	bool

should_enable_trace¶

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

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