DataIngestionJob¶
- class oci.generative_ai_agent.models.DataIngestionJob(**kwargs)¶
Bases:
objectWhen you create a data source, you specify the location of the data files. To make those files usable by an agent, you must download them into the agent’s associated knowledge base, a process known as data ingestion. Data ingestion is a process that extracts data from data source documents, converts it into a structured format suitable for analysis, and then stores it in a knowledge base.
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:
A constant which can be used with the lifecycle_state property of a DataIngestionJob.
A constant which can be used with the lifecycle_state property of a DataIngestionJob.
A constant which can be used with the lifecycle_state property of a DataIngestionJob.
A constant which can be used with the lifecycle_state property of a DataIngestionJob.
A constant which can be used with the lifecycle_state property of a DataIngestionJob.
A constant which can be used with the lifecycle_state property of a DataIngestionJob.
A constant which can be used with the lifecycle_state property of a DataIngestionJob.
[Required] Gets the compartment_id of this DataIngestionJob.
[Required] Gets the data_ingestion_job_statistics of this DataIngestionJob.
[Required] Gets the data_ingestion_job_type of this DataIngestionJob.
[Required] Gets the data_source_id of this DataIngestionJob.
[Required] Gets the defined_tags of this DataIngestionJob.
Gets the description of this DataIngestionJob.
[Required] Gets the display_name of this DataIngestionJob.
[Required] Gets the freeform_tags of this DataIngestionJob.
[Required] Gets the id of this DataIngestionJob.
Gets the knowledge_base_id of this DataIngestionJob.
Gets the lifecycle_details of this DataIngestionJob.
[Required] Gets the lifecycle_state of this DataIngestionJob.
Gets the system_tags of this DataIngestionJob.
[Required] Gets the time_created of this DataIngestionJob.
Gets the time_updated of this DataIngestionJob.
Methods:
__init__(**kwargs)Initializes a new DataIngestionJob object with values from keyword arguments.
- LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶
A constant which can be used with the lifecycle_state property of a DataIngestionJob. This constant has a value of “ACCEPTED”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a DataIngestionJob. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a DataIngestionJob. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a DataIngestionJob. This constant has a value of “FAILED”
- LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶
A constant which can be used with the lifecycle_state property of a DataIngestionJob. This constant has a value of “IN_PROGRESS”
- LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶
A constant which can be used with the lifecycle_state property of a DataIngestionJob. This constant has a value of “SUCCEEDED”
- LIFECYCLE_STATE_WAITING = 'WAITING'¶
A constant which can be used with the lifecycle_state property of a DataIngestionJob. This constant has a value of “WAITING”
- __init__(**kwargs)¶
Initializes a new DataIngestionJob 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 DataIngestionJob.
display_name (str) – The value to assign to the display_name property of this DataIngestionJob.
description (str) – The value to assign to the description property of this DataIngestionJob.
compartment_id (str) – The value to assign to the compartment_id property of this DataIngestionJob.
data_source_id (str) – The value to assign to the data_source_id property of this DataIngestionJob.
knowledge_base_id (str) – The value to assign to the knowledge_base_id property of this DataIngestionJob.
data_ingestion_job_type (oci.generative_ai_agent.models.DataIngestionJobType) – The value to assign to the data_ingestion_job_type property of this DataIngestionJob.
data_ingestion_job_statistics (oci.generative_ai_agent.models.DataIngestionJobStatistics) – The value to assign to the data_ingestion_job_statistics property of this DataIngestionJob.
time_created (datetime) – The value to assign to the time_created property of this DataIngestionJob.
time_updated (datetime) – The value to assign to the time_updated property of this DataIngestionJob.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DataIngestionJob. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “FAILED”, “SUCCEEDED”, “DELETING”, “DELETED”, ‘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 DataIngestionJob.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DataIngestionJob.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DataIngestionJob.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DataIngestionJob.
- property compartment_id¶
[Required] Gets the compartment_id of this DataIngestionJob. The OCID of the compartment.
- Returns
The compartment_id of this DataIngestionJob.
- Return type
str
- property data_ingestion_job_statistics¶
[Required] Gets the data_ingestion_job_statistics of this DataIngestionJob.
- Returns
The data_ingestion_job_statistics of this DataIngestionJob.
- Return type
- property data_ingestion_job_type¶
[Required] Gets the data_ingestion_job_type of this DataIngestionJob.
- Returns
The data_ingestion_job_type of this DataIngestionJob.
- Return type
- property data_source_id¶
[Required] Gets the data_source_id of this DataIngestionJob. The OCID of the parent DataSource.
- Returns
The data_source_id of this DataIngestionJob.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this DataIngestionJob. 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 DataIngestionJob.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this DataIngestionJob. A user-friendly name. Does not have to be unique, and it’s changeable.
- Returns
The description of this DataIngestionJob.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this DataIngestionJob. A user-friendly name. Does not have to be unique, and it’s changeable.
- Returns
The display_name of this DataIngestionJob.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this DataIngestionJob. 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 DataIngestionJob.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this DataIngestionJob. The OCID of the DataIngestionJob.
- Returns
The id of this DataIngestionJob.
- Return type
str
- property knowledge_base_id¶
Gets the knowledge_base_id of this DataIngestionJob. The OCID of the parent KnowledgeBase.
- Returns
The knowledge_base_id of this DataIngestionJob.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this DataIngestionJob. A message that describes the current state of the data ingestion job 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 DataIngestionJob.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this DataIngestionJob. The current state of the data ingestion job.
Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “FAILED”, “SUCCEEDED”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this DataIngestionJob.
- Return type
str
- property system_tags¶
Gets the system_tags of this DataIngestionJob. 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 DataIngestionJob.
- Return type
dict(str, dict(str, object))