Skip to main content

QuestionSpec

@forge/monorepo


@forge/monorepo / backend/src / QuestionSpec

Type Alias: QuestionSpec

QuestionSpec = object

Defined in: backend/src/hitl/service.ts:47

One question the agent asks a person.

options + multiple + allowOther cover the three shapes a UI actually needs: pick one, pick several, or write your own — and any combination. Previously only options existed, so a client could not tell a choice from a hint and had to guess.

Properties

allowOther?

readonly optional allowOther?: boolean

Defined in: backend/src/hitl/service.ts:55

An answer not on the list is accepted. Defaults to true when there are no options, false when there are.


key

readonly key: string

Defined in: backend/src/hitl/service.ts:48


multiple?

readonly optional multiple?: boolean

Defined in: backend/src/hitl/service.ts:53

More than one may be chosen. A multi-select answer is an array.


options?

readonly optional options?: readonly string[]

Defined in: backend/src/hitl/service.ts:51

Suggested answers. Absent means free text only.


prompt

readonly prompt: string

Defined in: backend/src/hitl/service.ts:49