ReadDocumentOutput

@forge/monorepo

---

@forge/monorepo / backend/src / ReadDocumentOutput

Type Alias: ReadDocumentOutput

ReadDocumentOutput = object

Defined in: backend/src/documents/read-tool.ts:34

Properties

blocksReturned

readonly blocksReturned: number

Defined in: backend/src/documents/read-tool.ts:38

---

confidence?

readonly optional confidence?: number

Defined in: backend/src/documents/read-tool.ts:50

OCR/vision confidence, 0–1, and only when the extraction was probabilistic (#132).

Present alongside the low-confidence warning rather than instead of it: the warning is the sentence a model should pass on, and the number is what a caller comparing two extractions needs.

---

documentTruncated?

readonly optional documentTruncated?: boolean

Defined in: backend/src/documents/read-tool.ts:43

Present when extraction itself truncated the document — a different fact from this window truncating.

---

fileId

readonly fileId: string

Defined in: backend/src/documents/read-tool.ts:35

---

fromBlock

readonly fromBlock: number

Defined in: backend/src/documents/read-tool.ts:37

---

lowConfidence?

readonly optional lowConfidence?: boolean

Defined in: backend/src/documents/read-tool.ts:51

---

nextBlock?

readonly optional nextBlock?: number

Defined in: backend/src/documents/read-tool.ts:41

---

text

readonly text: string

Defined in: backend/src/documents/read-tool.ts:36

---

totalBlocks

readonly totalBlocks: number

Defined in: backend/src/documents/read-tool.ts:39

---

truncated

readonly truncated: boolean

Defined in: backend/src/documents/read-tool.ts:40

---

warnings?

readonly optional warnings?: readonly string[]

Defined in: backend/src/documents/read-tool.ts:52