/AWS1/CL_BDAINGESTIONJOB¶
Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.
This data type is used in the following API operations:
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_knowledgebaseid TYPE /AWS1/BDAID /AWS1/BDAID¶
The unique identifier of the knowledge for the data ingestion job.
iv_datasourceid TYPE /AWS1/BDAID /AWS1/BDAID¶
The unique identifier of the data source for the data ingestion job.
iv_ingestionjobid TYPE /AWS1/BDAID /AWS1/BDAID¶
The unique identifier of the data ingestion job.
iv_status TYPE /AWS1/BDAINGESTIONJOBSTATUS /AWS1/BDAINGESTIONJOBSTATUS¶
The status of the data ingestion job.
iv_startedat TYPE /AWS1/BDADATETIMESTAMP /AWS1/BDADATETIMESTAMP¶
The time the data ingestion job started.
If you stop a data ingestion job, the
startedAttime is the time the job was started before the job was stopped.
iv_updatedat TYPE /AWS1/BDADATETIMESTAMP /AWS1/BDADATETIMESTAMP¶
The time the data ingestion job was last updated.
If you stop a data ingestion job, the
updatedAttime is the time the job was stopped.
Optional arguments:¶
iv_description TYPE /AWS1/BDADESCRIPTION /AWS1/BDADESCRIPTION¶
The description of the data ingestion job.
io_statistics TYPE REF TO /AWS1/CL_BDAINGESTIONJOBSTATS /AWS1/CL_BDAINGESTIONJOBSTATS¶
Contains statistics about the data ingestion job.
it_failurereasons TYPE /AWS1/CL_BDAFAILUREREASONS_W=>TT_FAILUREREASONS TT_FAILUREREASONS¶
A list of reasons that the data ingestion job failed.
iv_textreadyat TYPE /AWS1/BDADATETIMESTAMP /AWS1/BDADATETIMESTAMP¶
The time at which all text content in the data ingestion job finished extraction and became available to query.
This time isn't returned until text extraction is complete for all the documents in the job.
Queryable Attributes¶
knowledgeBaseId¶
The unique identifier of the knowledge for the data ingestion job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KNOWLEDGEBASEID() |
Getter for KNOWLEDGEBASEID, with configurable default |
ASK_KNOWLEDGEBASEID() |
Getter for KNOWLEDGEBASEID w/ exceptions if field has no val |
HAS_KNOWLEDGEBASEID() |
Determine if KNOWLEDGEBASEID has a value |
dataSourceId¶
The unique identifier of the data source for the data ingestion job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATASOURCEID() |
Getter for DATASOURCEID, with configurable default |
ASK_DATASOURCEID() |
Getter for DATASOURCEID w/ exceptions if field has no value |
HAS_DATASOURCEID() |
Determine if DATASOURCEID has a value |
ingestionJobId¶
The unique identifier of the data ingestion job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INGESTIONJOBID() |
Getter for INGESTIONJOBID, with configurable default |
ASK_INGESTIONJOBID() |
Getter for INGESTIONJOBID w/ exceptions if field has no valu |
HAS_INGESTIONJOBID() |
Determine if INGESTIONJOBID has a value |
description¶
The description of the data ingestion job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
status¶
The status of the data ingestion job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
statistics¶
Contains statistics about the data ingestion job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATISTICS() |
Getter for STATISTICS |
failureReasons¶
A list of reasons that the data ingestion job failed.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREREASONS() |
Getter for FAILUREREASONS, with configurable default |
ASK_FAILUREREASONS() |
Getter for FAILUREREASONS w/ exceptions if field has no valu |
HAS_FAILUREREASONS() |
Determine if FAILUREREASONS has a value |
startedAt¶
The time the data ingestion job started.
If you stop a data ingestion job, the
startedAttime is the time the job was started before the job was stopped.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTEDAT() |
Getter for STARTEDAT, with configurable default |
ASK_STARTEDAT() |
Getter for STARTEDAT w/ exceptions if field has no value |
HAS_STARTEDAT() |
Determine if STARTEDAT has a value |
updatedAt¶
The time the data ingestion job was last updated.
If you stop a data ingestion job, the
updatedAttime is the time the job was stopped.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
textReadyAt¶
The time at which all text content in the data ingestion job finished extraction and became available to query.
This time isn't returned until text extraction is complete for all the documents in the job.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEXTREADYAT() |
Getter for TEXTREADYAT, with configurable default |
ASK_TEXTREADYAT() |
Getter for TEXTREADYAT w/ exceptions if field has no value |
HAS_TEXTREADYAT() |
Determine if TEXTREADYAT has a value |