Class DataIngestionJob

When 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.

Inheritance
object
DataIngestionJob
Inherited Members
Namespace: Oci.GenerativeaiagentService.Models
Assembly: OCI.DotNetSDK.Generativeaiagent.dll
Syntax
public class DataIngestionJob

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment.
Remarks

Required

DataIngestionJobStatistics

Declaration
[Required(ErrorMessage = "DataIngestionJobStatistics is required.")]
[JsonProperty(PropertyName = "dataIngestionJobStatistics")]
public DataIngestionJobStatistics DataIngestionJobStatistics { get; set; }
Property Value
Type Description
DataIngestionJobStatistics
Remarks

Required

DataSourceId

Declaration
[Required(ErrorMessage = "DataSourceId is required.")]
[JsonProperty(PropertyName = "dataSourceId")]
public string DataSourceId { get; set; }
Property Value
Type Description
string

The OCID of the parent DataSource.
Remarks

Required

DefinedTags

Declaration
[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
Remarks

Required

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A user-friendly name. Does not have to be unique, and it's changeable.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name. Does not have to be unique, and it's changeable.
Remarks

Required

FreeformTags

Declaration
[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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"}
Remarks

Required

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the DataIngestionJob.
Remarks

Required

KnowledgeBaseId

Declaration
[JsonProperty(PropertyName = "knowledgeBaseId")]
public string KnowledgeBaseId { get; set; }
Property Value
Type Description
string

The OCID of the parent KnowledgeBase.

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

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.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DataIngestionJob.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
DataIngestionJob.LifecycleStateEnum?

The current state of the data ingestion job.
Remarks

Required

SystemTags

Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the data ingestion job was created, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z
Remarks

Required

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time the data ingestion job was updated, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z