ExtractedData
Defined in: packages/cloud/src/beta/agent/types.ts:57
Base extracted data interface
Type Parameters
T
T
= unknown
Properties
original_data
original_data:
T
Defined in: packages/cloud/src/beta/agent/types.ts:59
The original data that was extracted from the document. For tracking changes. Should not be updated.
data
data:
T
Defined in: packages/cloud/src/beta/agent/types.ts:61
The latest state of the data. Will differ if data has been updated.
status
status:
string
Defined in: packages/cloud/src/beta/agent/types.ts:63
The status of the extracted data. Prefer to use the StatusType values, but any string is allowed.
overall_confidence?
optional
overall_confidence:number
Defined in: packages/cloud/src/beta/agent/types.ts:65
The overall confidence score for the extracted data.
field_metadata?
optional
field_metadata:ExtractedFieldMetadataDict
Defined in: packages/cloud/src/beta/agent/types.ts:67
Page links, and perhaps eventually bounding boxes, for individual fields in the extracted data.
file_id?
optional
file_id:string
Defined in: packages/cloud/src/beta/agent/types.ts:69
The ID of the file that was used to extract the data.
file_name?
optional
file_name:string
Defined in: packages/cloud/src/beta/agent/types.ts:71
The name of the file that was used to extract the data.
file_hash?
optional
file_hash:string
Defined in: packages/cloud/src/beta/agent/types.ts:73
The hash of the file that was used to extract the data.
metadata?
optional
metadata:Record
<string
,unknown
>
Defined in: packages/cloud/src/beta/agent/types.ts:75
Additional metadata about the extracted data, such as errors, tokens, etc.