HITLSpec

interface HITLSpec<TSubjectArgs extends object | void = void, TBodyArgs extends object | void = TSubjectArgs> extends HITLBaseSpec<TSubjectArgs, TBodyArgs> { assignedUsers?: readonly HITLUser[]; body?: HITLText<TBodyArgs, string | null>; defaults?: readonly string[]; multiple?: boolean; options: readonly string[]; params?: Readonly<Record<string, HITLParam>>; responseTimeout?: number; subject: HITLText<TSubjectArgs>; }

Source: spec.ts:79

The HITLOperator options, named as TypeScript spells them.

Type Parameters

  • TSubjectArgs extends object | void = void
  • TBodyArgs extends object | void = TSubjectArgs

Hierarchy

  • HITLBaseSpec<TSubjectArgs, TBodyArgs>
  • HITLSpec

Properties

assignedUsers: readonly HITLUser[]

readonly
spec.ts:68

Inherited from assignedUsers

Users allowed to respond. Anyone who can act on the task may respond when unset.

body: HITLText<TBodyArgs, string | null>

readonly
spec.ts:66

Inherited from body

Markdown shown below the headline.

defaults: readonly string[]

readonly
spec.ts:86

Options chosen for the responder when responseTimeout passes without a response.

multiple: boolean

readonly
spec.ts:88

Whether more than one option may be chosen.

options: readonly string[]

readonly
spec.ts:84

What the responder chooses from.

params: Readonly<Record<string, HITLParam>>

readonly
spec.ts:70

Inherited from params

Form fields the responder fills in, by name. Their answers are the result's paramsInput.

responseTimeout: number

readonly
spec.ts:75

Inherited from responseTimeout

Whole seconds to wait for a response, since TypeScript has no timedelta. Waits indefinitely when unset. Use this rather than executionTimeout, which a HITL task does not enforce.

subject: HITLText<TSubjectArgs>

readonly
spec.ts:64

Inherited from subject

Headline of the request.