MetadataExpansionJob
A metadata expansion job — extracts the requested fields from each of its documents.
A metadata expansion job — extracts the requested fields from each of its documents.
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The job identifier, which can be referenced in the API endpoints. |
project_id | string | Yes | The project identifier this job belongs to. |
status | server__models__metadata_expansion__JobStatus | Yes | Aggregate status across all documents in the job. 'completed' covers partial failures too — check each document's own status for details; 'failed' is only set when every document in the job failed; 'cancelled' is a terminal state set by the caller and is never resumed. |
fields | MetadataFieldSpec[] | Yes | Metadata fields requested for this job. |
documents | DocumentMetadataRecord[] | Yes | Per-document status and extracted metadata. |
describe_images | boolean | No | Whether image descriptions were requested at job creation; applies to every document in the job. Default: false. |
created_at | integer | No | The Unix timestamp (in seconds) for when the job was created. |
finished_at | integer | null | No | The Unix timestamp (in seconds) for when every document reached a terminal state. |
We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.
Metadata-Output
Set of 16 key-value pairs that can be attached to an object.This can be useful for storing additional information about the objectin a structured format, and querying for objects via API or the dashboard.Keys are strings with a maximum length of 64 characters.Values are strings with a maximum length of 512 characters.
MetadataFieldSpec
A single metadata field the caller wants extracted from each document.