CreateDataSourceDetails

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

Bases: object

CreateDataSourceDetails

The data to create a data source.

Methods

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

Attributes

compartment_id [Required] Gets the compartment_id of this CreateDataSourceDetails.
data_source_config [Required] Gets the data_source_config of this CreateDataSourceDetails.
defined_tags Gets the defined_tags of this CreateDataSourceDetails.
description Gets the description of this CreateDataSourceDetails.
display_name Gets the display_name of this CreateDataSourceDetails.
freeform_tags Gets the freeform_tags of this CreateDataSourceDetails.
knowledge_base_id [Required] Gets the knowledge_base_id of this CreateDataSourceDetails.
__init__(**kwargs)

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

[Required] Gets the compartment_id of this CreateDataSourceDetails. The OCID of the compartment to create the data source in.

Returns:The compartment_id of this CreateDataSourceDetails.
Return type:str
data_source_config

[Required] Gets the data_source_config of this CreateDataSourceDetails.

Returns:The data_source_config of this CreateDataSourceDetails.
Return type:oci.generative_ai_agent.models.DataSourceConfig
defined_tags

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

Gets the description of this CreateDataSourceDetails. A description of the data source.

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

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

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

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

[Required] Gets the knowledge_base_id of this CreateDataSourceDetails. The OCID of the parent KnowledgeBase.

Returns:The knowledge_base_id of this CreateDataSourceDetails.
Return type:str