Interface: InputRequestDeclaration

Defined in: src/tools/inputRequest.ts:47

Properties

absence?

readonly optional absence?: ToolAbsence

Defined in: src/tools/inputRequest.ts:71

What the tool LOOKED AT before it asked (9.114.0): the envelope absent() returns, when a lookup found nothing and raises this request about the miss. Recognized at raise time by the one recognizer (../semantics/coverage/absent.ts · readAbsence) — anything it does not read is refused, and null is the field omitted — and filed by the dispatch door at the raise, before the checkpoint is returned: the same tools.absent event and coverageDeclared row a RETURNED absence files (core/agent/stages/toolCalls.ts · declareRaisedAbsence). Data for the record, not for the ask: it never rides the awaiting-input shape or the paused call's served result, and nothing on resume reads it, so the pending question says the miss only if question says it in words. Under .limitsTravelWithTheAnswer() the final answer's limits block carries it, as it does a returned miss.

---

context?

readonly optional context?: Readonly<Record<string, unknown>>

Defined in: src/tools/inputRequest.ts:54

Opaque JSON authored by the collecting tool, never editable by the reply.

---

fields

readonly fields: readonly InputField[]

Defined in: src/tools/inputRequest.ts:50

---

id

readonly id: string

Defined in: src/tools/inputRequest.ts:48

---

question

readonly question: string

Defined in: src/tools/inputRequest.ts:49

---

refused?

readonly optional refused?: InputRefusal

Defined in: src/tools/inputRequest.ts:85

The previous answer to this ask was REFUSED, and why: the app validated what the person gave, turned it down, and asks again. Carried on the awaiting-input shape the person receives — the checkpoint's pauseData, the pause outcome, the pause.request event — so a UI can say "Your answer '…' was not accepted: " instead of repeating the same question in silence. The reason is the APP'S words — with one exception the app arms itself: a time field's answer the library's check refused (InputField.format), whose reason is a catalog sentence the app can override (defaultTimeAskMessages, .time({ messages })). answer is optional and judged against fields like any answer; null is the field omitted.

---

supplied?

readonly optional supplied?: Readonly<Record<string, InputValue>>

Defined in: src/tools/inputRequest.ts:52

Values the collection tool already knows; never labelled as a person's answer.