Skip to main content

Interface: InterruptRequest

Defined in: packages/core/src/interrupt/types.ts:145

Properties​

interruptId​

interruptId: string

Defined in: packages/core/src/interrupt/types.ts:146


spec​

spec: { cancelLabel?: string; confirmLabel?: string; id?: string; kind: "confirm"; metadata?: Record<string, unknown>; prompt: string; } | { id?: string; kind: "text"; maxLength?: number; metadata?: Record<string, unknown>; placeholder?: string; prompt: string; } | { id?: string; kind: "choice"; metadata?: Record<string, unknown>; multiple?: boolean; options: object[]; prompt: string; } | { id?: string; kind: "number"; max: number; metadata?: Record<string, unknown>; min: number; prompt: string; step?: number; } | { accept?: string[]; id?: string; kind: "file"; maxBytes?: number; metadata?: Record<string, unknown>; prompt: string; } | { id?: string; kind: "encrypted"; metadata?: Record<string, unknown>; prompt: string; purpose?: "password" | "secret" | "api_key"; }

Defined in: packages/core/src/interrupt/types.ts:149

Union Members​

Type Literal​

{ cancelLabel?: string; confirmLabel?: string; id?: string; kind: "confirm"; metadata?: Record<string, unknown>; prompt: string; }

cancelLabel?​

optional cancelLabel?: string

confirmLabel?​

optional confirmLabel?: string

id?​

optional id?: string

kind​

kind: "confirm"

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

prompt​

prompt: string


Type Literal​

{ id?: string; kind: "text"; maxLength?: number; metadata?: Record<string, unknown>; placeholder?: string; prompt: string; }

id?​

optional id?: string

kind​

kind: "text"

maxLength?​

optional maxLength?: number

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

placeholder?​

optional placeholder?: string

prompt​

prompt: string


Type Literal​

{ id?: string; kind: "choice"; metadata?: Record<string, unknown>; multiple?: boolean; options: object[]; prompt: string; }

id?​

optional id?: string

kind​

kind: "choice"

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

multiple?​

optional multiple?: boolean

options​

options: object[]

prompt​

prompt: string


Type Literal​

{ id?: string; kind: "number"; max: number; metadata?: Record<string, unknown>; min: number; prompt: string; step?: number; }

id?​

optional id?: string

kind​

kind: "number"

max​

max: number

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

min​

min: number

prompt​

prompt: string

step?​

optional step?: number


Type Literal​

{ accept?: string[]; id?: string; kind: "file"; maxBytes?: number; metadata?: Record<string, unknown>; prompt: string; }

accept?​

optional accept?: string[]

id?​

optional id?: string

kind​

kind: "file"

maxBytes?​

optional maxBytes?: number

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

prompt​

prompt: string


Type Literal​

{ id?: string; kind: "encrypted"; metadata?: Record<string, unknown>; prompt: string; purpose?: "password" | "secret" | "api_key"; }

id?​

optional id?: string

kind​

kind: "encrypted"

metadata?​

optional metadata?: Record<string, unknown>

Opaque host correlation/presentation hints, persisted with the interrupt.

prompt​

prompt: string

purpose?​

optional purpose?: "password" | "secret" | "api_key"


toolCallId​

toolCallId: string

Defined in: packages/core/src/interrupt/types.ts:147


toolName​

toolName: string

Defined in: packages/core/src/interrupt/types.ts:148