DataSource¶

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

Bases: object

A data source points to the source of your data. After you add a data source to a knowledge base, you must ingest the data source’s data, so that agents using the knowledge base can refer to the data.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DataSource.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DataSource.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DataSource.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DataSource.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DataSource.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DataSource.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DataSource.
`compartment_id`	[Required] Gets the compartment_id of this DataSource.
`data_source_config`	[Required] Gets the data_source_config of this DataSource.
`defined_tags`	[Required] Gets the defined_tags of this DataSource.
`description`	Gets the description of this DataSource.
`display_name`	[Required] Gets the display_name of this DataSource.
`freeform_tags`	[Required] Gets the freeform_tags of this DataSource.
`id`	[Required] Gets the id of this DataSource.
`knowledge_base_id`	[Required] Gets the knowledge_base_id of this DataSource.
`lifecycle_details`	Gets the lifecycle_details of this DataSource.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DataSource.
`system_tags`	Gets the system_tags of this DataSource.
`time_created`	[Required] Gets the time_created of this DataSource.
`time_updated`	Gets the time_updated of this DataSource.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DataSource. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DataSource. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DataSource. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DataSource. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DataSource. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a DataSource. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DataSource. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new DataSource object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this DataSource.
display_name (str) – The value to assign to the display_name property of this DataSource.
description (str) – The value to assign to the description property of this DataSource.
compartment_id (str) – The value to assign to the compartment_id property of this DataSource.
knowledge_base_id (str) – The value to assign to the knowledge_base_id property of this DataSource.
data_source_config (oci.generative_ai_agent.models.DataSourceConfig) – The value to assign to the data_source_config property of this DataSource.
time_created (datetime) – The value to assign to the time_created property of this DataSource.
time_updated (datetime) – The value to assign to the time_updated property of this DataSource.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DataSource. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DataSource.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DataSource.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DataSource.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DataSource.

compartment_id¶

[Required] Gets the compartment_id of this DataSource. The OCID of the compartment.

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

data_source_config¶

[Required] Gets the data_source_config of this DataSource.

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

defined_tags¶

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

description¶

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

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

display_name¶

[Required] Gets the display_name of this DataSource. A user-friendly name. Does not have to be unique, and it’s changeable.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this DataSource. The OCID of the data source.

Returns:	The id of this DataSource.
Return type:	str

knowledge_base_id¶

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

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

lifecycle_details¶

Gets the lifecycle_details of this DataSource. A message that describes the current state of the data source in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:	The lifecycle_details of this DataSource.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DataSource. The current state of the data source.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this DataSource.
Return type:	str

system_tags¶

Gets the system_tags of this DataSource. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this DataSource.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this DataSource. The date and time the data source was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this DataSource.
Return type:	datetime

time_updated¶

Gets the time_updated of this DataSource. The date and time the data source was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this DataSource.
Return type:	datetime