FileExtraction

@forge/monorepo

---

@forge/monorepo / backend/src / FileExtraction

Type Alias: FileExtraction

FileExtraction = object

Defined in: backend/src/persistence/index.ts:1167

Properties

at?

readonly optional at?: string

Defined in: backend/src/persistence/index.ts:1184

---

blockCount?

readonly optional blockCount?: number

Defined in: backend/src/persistence/index.ts:1174

---

confidence?

readonly optional confidence?: number

Defined in: backend/src/persistence/index.ts:1183

OCR/vision confidence, 0–1 (#132).

On the record as well as inside the extracted document, so a listing can flag a low-confidence extraction without fetching the blob to find out. Absent means the extraction was not probabilistic — a PDF's text layer is read, not recognised — which is a different fact from "confidence unknown".

---

failureMessage?

readonly optional failureMessage?: string

Defined in: backend/src/persistence/index.ts:1172

---

failureReason?

readonly optional failureReason?: string

Defined in: backend/src/persistence/index.ts:1171

---

pageCount?

readonly optional pageCount?: number

Defined in: backend/src/persistence/index.ts:1173

---

ref?

readonly optional ref?: BlobRef

Defined in: backend/src/persistence/index.ts:1170

Where the extracted document lives. BlobStore holds JSON, which is exactly what it is.

---

state

readonly state: "pending" | "running" | "extracted" | "failed" | "skipped"

Defined in: backend/src/persistence/index.ts:1168

---

truncated?

readonly optional truncated?: boolean

Defined in: backend/src/persistence/index.ts:1175