DeepFellow DOCS

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.

PropertyTypeRequiredDescription
idstringYesThe job identifier, which can be referenced in the API endpoints.
project_idstringYesThe project identifier this job belongs to.
statusserver__models__metadata_expansion__JobStatusYesAggregate 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.
fieldsMetadataFieldSpec[]YesMetadata fields requested for this job.
documentsDocumentMetadataRecord[]YesPer-document status and extracted metadata.
describe_imagesbooleanNoWhether image descriptions were requested at job creation; applies to every document in the job. Default: false.
created_atintegerNoThe Unix timestamp (in seconds) for when the job was created.
finished_atinteger | nullNoThe 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.