@threadplane/ag-uiInterfacev0.3.7

ResumeOptions

What resume takes beside the responses.

import type { ResumeOptions } from '@threadplane/ag-ui';

Declaration

export interface ResumeOptions<TState = unknown>  {
  readonly blocks?: readonly ContentBlock[];
  readonly message?: string;
  readonly pause?: string;
  readonly signal?: AbortSignal;
  readonly state?: SubmitState<TState>;
}

Type parameters

TState
Default: unknown

Members

blocks

That message as structured content; see submit.

readonly blocks?: readonly ContentBlock[];

message

A user message sent in the same request as the answers, as the core contract's resume options and the Angular adapter's submit({ resume, message }). It is appended to the conversation.

readonly message?: string;

pause

The id of the pause a control was rendered for, from decisionState(snapshot) or interruptSession(snapshot). When given, resume rejects without sending unless that pause is the one pending, so a control left over from an earlier pause cannot answer a later one whose interrupts reuse the same identifiers.

readonly pause?: string;

signal

readonly signal?: AbortSignal;

state

A patch merged into the state document before the answering request.

readonly state?: SubmitState<TState>;