Logo
Interfaces

ExtractedData

Defined in: packages/cloud/src/beta/agent/types.ts:34

Base extracted data interface

Type Parameters

T

T = unknown

Properties

original_data

original_data: T

Defined in: packages/cloud/src/beta/agent/types.ts:36

The original data that was extracted from the document. For tracking changes. Should not be updated.


data?

optional data: T

Defined in: packages/cloud/src/beta/agent/types.ts:38

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:40

The status of the extracted data. Prefer to use the StatusType values, but any string is allowed.


confidence?

optional confidence: Record<string, unknown>

Defined in: packages/cloud/src/beta/agent/types.ts:42

Confidence scores, if any, for each primitive field in the original_data data.


file_id?

optional file_id: string

Defined in: packages/cloud/src/beta/agent/types.ts:44

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:46

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:48

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:50

Additional metadata about the extracted data, such as errors, tokens, etc.