get_ingestion_job¶
Operation¶
get_ingestion_job
async
¶
get_ingestion_job(input: GetIngestionJobInput, plugins: list[Plugin] | None = None) -> GetIngestionJobOutput
Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetIngestionJobInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetIngestionJobOutput
|
An instance of |
Input¶
GetIngestionJobInput
dataclass
¶
Dataclass for GetIngestionJobInput structure.
Attributes¶
data_source_id
class-attribute
instance-attribute
¶
data_source_id: str | None = None
The unique identifier of the data source for the data ingestion job you want to get information on.
ingestion_job_id
class-attribute
instance-attribute
¶
ingestion_job_id: str | None = None
The unique identifier of the data ingestion job you want to get information on.
knowledge_base_id
class-attribute
instance-attribute
¶
knowledge_base_id: str | None = None
The unique identifier of the knowledge base for the data ingestion job you want to get information on.
Output¶
GetIngestionJobOutput
dataclass
¶
Dataclass for GetIngestionJobOutput structure.
Attributes¶
ingestion_job
instance-attribute
¶
ingestion_job: IngestionJob
Contains details about the data ingestion job.