createChatOptions

function createChatOptions<TAdapter, TSchema, TStream, TTools, TInterrupts, TContext, TMiddleware>(options): Omit<TextActivityOptions<TAdapter, TSchema, TStream, InferredContext<TTools, TMiddleware>, readonly DefinedAgent<string, readonly SubagentTool[], SchemaInput | undefined, readonly InterruptDefinition<any, any, any, any, any>[], any, unknown, AgentProduces | undefined>[]>, "middleware" | "tools" | "threadId" | "interrupts" | "context"> & object & RuntimeContextOption<TTools, TMiddleware, TContext>;

Defined in: packages/ai/src/activities/chat/index.ts:834

Create typed options for the chat() function without executing. This is useful for pre-defining configurations with full type inference. threadId is optional here. chat() still needs it, so pass it on the call.

Type Parameters#

TAdapter#

TAdapter extends AnyTextAdapter

TSchema#

TSchema extends SchemaInput | undefined = undefined

TStream#

TStream extends boolean = true

TTools#

TTools extends | readonly ( | Omit<Tool<any, any, any, any>, "execute"> & object & object | ProviderTool<string, TAdapter["~types"]["toolCapabilities"][number]>)[] | undefined = | readonly ( | Omit<Tool<any, any, any, any>, "execute"> & object & object | ProviderTool<string, TAdapter["~types"]["toolCapabilities"][number]>)[] | undefined

TInterrupts#

TInterrupts extends readonly InterruptDefinition<any, any, any, any, any>[] = []

TContext#

TContext = unknown

TMiddleware#

TMiddleware extends unknown[] | undefined = undefined

Parameters#

options#

Omit<TextActivityOptions<TAdapter, TSchema, TStream, any, readonly DefinedAgent<string, readonly SubagentTool[], SchemaInput | undefined, readonly InterruptDefinition<any, any, any, any, any>[], any, unknown, AgentProduces | undefined>[]>, | "middleware" | "tools" | "threadId" | "toolChoice" | "interrupts" | "context"> & object & object & RuntimeContextOption<TTools, TMiddleware, TContext>

Returns#

Omit<TextActivityOptions<TAdapter, TSchema, TStream, InferredContext<TTools, TMiddleware>, readonly DefinedAgent<string, readonly SubagentTool[], SchemaInput | undefined, readonly InterruptDefinition<any, any, any, any, any>[], any, unknown, AgentProduces | undefined>[]>, "middleware" | "tools" | "threadId" | "interrupts" | "context"> & object & RuntimeContextOption<TTools, TMiddleware, TContext>

Example#

const chatOptions = createChatOptions({
  adapter: anthropicText('claude-sonnet-5-5'),
})

const stream = chat({ ...chatOptions, messages, threadId })