Skip to main content

ExtractionRecord

@forge/monorepo


@forge/monorepo / backend/src / ExtractionRecord

Type Alias: ExtractionRecord

ExtractionRecord = object

Defined in: backend/src/documents/index.ts:206

What the file metadata records about its derived text.

Properties

at?

readonly optional at?: string

Defined in: backend/src/documents/index.ts:214


blockCount?

readonly optional blockCount?: number

Defined in: backend/src/documents/index.ts:212


failure?

readonly optional failure?: ExtractionFailure

Defined in: backend/src/documents/index.ts:210


pageCount?

readonly optional pageCount?: number

Defined in: backend/src/documents/index.ts:211


ref?

readonly optional ref?: BlobRef

Defined in: backend/src/documents/index.ts:209

Where the ExtractedDocument lives. BlobStore holds JSON, which is exactly what this is.


state

readonly state: ExtractionState

Defined in: backend/src/documents/index.ts:207


truncated?

readonly optional truncated?: boolean

Defined in: backend/src/documents/index.ts:213