CreateAgentDetails¶

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

Bases: object

The data to create an agent.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateAgentDetails.
`defined_tags`	Gets the defined_tags of this CreateAgentDetails.
`description`	Gets the description of this CreateAgentDetails.
`display_name`	Gets the display_name of this CreateAgentDetails.
`freeform_tags`	Gets the freeform_tags of this CreateAgentDetails.
`knowledge_base_ids`	Gets the knowledge_base_ids of this CreateAgentDetails.
`llm_config`	Gets the llm_config of this CreateAgentDetails.
`welcome_message`	Gets the welcome_message of this CreateAgentDetails.

__init__(**kwargs)¶

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

compartment_id¶

[Required] Gets the compartment_id of this CreateAgentDetails. The OCID of the compartment to create the agent in.

Returns:	The compartment_id of this CreateAgentDetails.
Return type:	str

defined_tags¶

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

description¶

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

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

display_name¶

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

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

freeform_tags¶

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

knowledge_base_ids¶

Gets the knowledge_base_ids of this CreateAgentDetails. List of OCID of the knowledgeBases associated with agent. This field is deprecated and will be removed after March 26 2026.

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

llm_config¶

Gets the llm_config of this CreateAgentDetails.

Returns:	The llm_config of this CreateAgentDetails.
Return type:	oci.generative_ai_agent.models.LlmConfig

welcome_message¶

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

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