Interface: InterruptDefinition<TId, TPayloadSchema, TResponseSchema, TPayload, TPayloadInput>#

Defined in: packages/ai/src/interrupt-definition.ts:202

Type Parameters#

TId#

TId extends string

TPayloadSchema#

TPayloadSchema extends PortableSchema | undefined

TResponseSchema#

TResponseSchema extends PortableSchema | undefined

TPayload#

TPayload = unknown

TPayloadInput#

TPayloadInput = TPayload

Properties#

id#

readonly id: TId;

Defined in: packages/ai/src/interrupt-definition.ts:209

interrupt#

interrupt: <TInput>(input) => GenericInterruptRequestFor<InterruptDefinition<TId, TPayloadSchema, TResponseSchema, TPayload, TPayloadInput>, TPayloadSchema, TPayload>;

Defined in: packages/ai/src/interrupt-definition.ts:212

Type Parameters#

TInput#

TInput

Parameters#

input#

TInput & ValidInterruptInput<TInput, TPayloadSchema, TPayloadInput>

Returns#

GenericInterruptRequestFor<InterruptDefinition<TId, TPayloadSchema, TResponseSchema, TPayload, TPayloadInput>, TPayloadSchema, TPayload>

payloadSchema#

readonly payloadSchema: TPayloadSchema;

Defined in: packages/ai/src/interrupt-definition.ts:210

responseSchema#

readonly responseSchema: TResponseSchema;

Defined in: packages/ai/src/interrupt-definition.ts:211