DeepFellow DOCS

File

The `File` object represents a document that has been uploaded.

The File object represents a document that has been uploaded.

PropertyTypeRequiredDescription
idstringYesThe file identifier, which can be referenced in the API endpoints.
project_idstringYesThe project identifier file belongs to.
objectenumNoThe object type, which is always file. One of: file, list. Default: "file".
bytesinteger | nullNoThe size of the file, in bytes. Default: 0.
filenamestringYesThe name of the file.
purposePurposeNoThe intended purpose of the file. Default: "assistants".
created_atintegerNoThe Unix timestamp (in seconds) for when the file was created.
expires_atintegerNoThe Unix timestamp (in seconds) for when the file will expire.
graph_ingestion_statusGraphIngestionStatus | nullNoStatus of the file's most recent graph-ingestion job, or null if never ingested.
graph_ingestion_job_idstring | nullNoID of the graph-ingestion job that last wrote graph_ingestion_status.
extracted_metadataobject | nullNoMetadata fields extracted via the metadata expansion pipeline, keyed by field name.
summarystring | nullNoSummary generated via the document summarization pipeline.
content_typestring | nullNoThe file's content type, taken from the upload's Content-Type header or guessed from the filename.
summary_provenanceSummaryProvenance | nullNoHow summary was produced: model, options, job, time, and whether the document was truncated.

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.