UpdateAgentDetails¶

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

Bases: object

UpdateAgentDetails

The data to update an agent.

Methods

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

Attributes

`defined_tags`	Gets the defined_tags of this UpdateAgentDetails.
`description`	Gets the description of this UpdateAgentDetails.
`display_name`	Gets the display_name of this UpdateAgentDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateAgentDetails.
`knowledge_base_ids`	Gets the knowledge_base_ids of this UpdateAgentDetails.
`welcome_message`	Gets the welcome_message of this UpdateAgentDetails.

__init__(**kwargs)¶

Initializes a new UpdateAgentDetails 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 UpdateAgentDetails.
description (str) – The value to assign to the description property of this UpdateAgentDetails.
knowledge_base_ids (list[str]) – The value to assign to the knowledge_base_ids property of this UpdateAgentDetails.
welcome_message (str) – The value to assign to the welcome_message property of this UpdateAgentDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateAgentDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateAgentDetails.

defined_tags¶

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

description¶

Gets the description of this UpdateAgentDetails. Description about the agent.

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

display_name¶

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

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

freeform_tags¶

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

knowledge_base_ids¶

Gets the knowledge_base_ids of this UpdateAgentDetails. List of OCID of the knowledgeBases associated with agent.

Returns:	The knowledge_base_ids of this UpdateAgentDetails.
Return type:	list[str]

welcome_message¶

Gets the welcome_message of this UpdateAgentDetails. Details about purpose and responsibility of the agent

Returns:	The welcome_message of this UpdateAgentDetails.
Return type:	str