CreateKnowledgeBaseDetails¶

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

Bases: object

CreateKnowledgeBaseDetails

The data to create a knowledge base.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateKnowledgeBaseDetails.
`defined_tags`	Gets the defined_tags of this CreateKnowledgeBaseDetails.
`description`	Gets the description of this CreateKnowledgeBaseDetails.
`display_name`	Gets the display_name of this CreateKnowledgeBaseDetails.
`freeform_tags`	Gets the freeform_tags of this CreateKnowledgeBaseDetails.
`index_config`	[Required] Gets the index_config of this CreateKnowledgeBaseDetails.

__init__(**kwargs)¶

Initializes a new CreateKnowledgeBaseDetails 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 CreateKnowledgeBaseDetails.
description (str) – The value to assign to the description property of this CreateKnowledgeBaseDetails.
index_config (oci.generative_ai_agent.models.IndexConfig) – The value to assign to the index_config property of this CreateKnowledgeBaseDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateKnowledgeBaseDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateKnowledgeBaseDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateKnowledgeBaseDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateKnowledgeBaseDetails. The OCID of the compartment to create the knowledge base in.

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

defined_tags¶

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

description¶

Gets the description of this CreateKnowledgeBaseDetails. A user-friendly description of the knowledge base.

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

display_name¶

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

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

freeform_tags¶

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

index_config¶

[Required] Gets the index_config of this CreateKnowledgeBaseDetails.

Returns:	The index_config of this CreateKnowledgeBaseDetails.
Return type:	oci.generative_ai_agent.models.IndexConfig