Interface: ChatOptions<TModel, TProviderOptionsSuperset, TOutput, TProviderOptionsForModel>

Defined in: types.ts:469

Options passed into the SDK and further piped to the AI provider.

Type Parameters

TModel

TModel extends string = string

TProviderOptionsSuperset

TProviderOptionsSuperset extends Record<string, any> = Record<string, any>

TOutput

TOutput extends ResponseFormat<any> | undefined = undefined

TProviderOptionsForModel

TProviderOptionsForModel = TProviderOptionsSuperset

Properties

abortController?

optional abortController: AbortController;

optional abortController: AbortController;

Defined in: types.ts:502

AbortController for request cancellation.

Allows you to cancel an in-progress request using an AbortController. Useful for implementing timeouts or user-initiated cancellations.

Example

const abortController = new AbortController();
setTimeout(() => abortController.abort(), 5000); // Cancel after 5 seconds
await chat({ ..., abortController });

const abortController = new AbortController();
setTimeout(() => abortController.abort(), 5000); // Cancel after 5 seconds
await chat({ ..., abortController });

See

https://developer.mozilla.org/en-US/docs/Web/API/AbortController

agentLoopStrategy?

optional agentLoopStrategy: AgentLoopStrategy;

optional agentLoopStrategy: AgentLoopStrategy;

Defined in: types.ts:479

conversationId?

optional conversationId: string;

optional conversationId: string;

Defined in: types.ts:488

Conversation ID for correlating client and server-side devtools events. When provided, server-side events will be linked to the client conversation in devtools.

messages

messages: ModelMessage<
  | string
  | ContentPart<unknown, unknown, unknown, unknown>[]
  | null>[];

messages: ModelMessage<
  | string
  | ContentPart<unknown, unknown, unknown, unknown>[]
  | null>[];

Defined in: types.ts:476

model

model: TModel;

model: TModel;

Defined in: types.ts:475

options?

optional options: CommonOptions;

optional options: CommonOptions;

Defined in: types.ts:480

output?

optional output: TOutput;

optional output: TOutput;

Defined in: types.ts:483

providerOptions?

optional providerOptions: TProviderOptionsForModel;

optional providerOptions: TProviderOptionsForModel;

Defined in: types.ts:481

request?

optional request: Request | RequestInit;

optional request: Request | RequestInit;

Defined in: types.ts:482

systemPrompts?

optional systemPrompts: string[];

optional systemPrompts: string[];

Defined in: types.ts:478

tools?

optional tools: Tool<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, string>[];

optional tools: Tool<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>, string>[];

Defined in: types.ts:477