Interface LLMRequestOptions

Canonical request options shared by complete() and stream().

interface LLMRequestOptions {
    botId?: string;
    budgetExceededAction?: BudgetExceededAction;
    budgetUsd?: number;
    metadata?: Record<string, JsonValue>;
    maxTokens?: number;
    messages: CanonicalMessage[];
    model?: string;
    provider?: CanonicalProvider;
    providerOptions?: ProviderOptions;
    responseFormat?: ResponseFormat;
    requestId?: string;
    sessionId?: string;
    signal?: AbortSignal;
    system?: string;
    temperature?: number;
    tenantId?: string;
    toolChoice?: CanonicalToolChoice;
    tools?: CanonicalTool<JsonObject>[];
}

Index

Properties

botId? budgetExceededAction? budgetUsd? metadata? maxTokens? messages model? provider? providerOptions? responseFormat? requestId? sessionId? signal? system? temperature? tenantId? toolChoice? tools?

Properties

`Optional`botId

botId?: string

`Optional`budgetExceededAction

budgetExceededAction?: BudgetExceededAction

`Optional`budgetUsd

budgetUsd?: number

`Optional`metadata

metadata?: Record<string, JsonValue>

`Optional`maxTokens

maxTokens?: number

messages

messages: CanonicalMessage[]

`Optional`model

model?: string

`Optional`provider

provider?: CanonicalProvider

`Optional`providerOptions

providerOptions?: ProviderOptions

`Optional`responseFormat

responseFormat?: ResponseFormat

`Optional`requestId

requestId?: string

`Optional`sessionId

sessionId?: string

`Optional`signal

signal?: AbortSignal

`Optional`system

system?: string

`Optional`temperature

temperature?: number

`Optional`tenantId

tenantId?: string

`Optional`toolChoice

toolChoice?: CanonicalToolChoice

`Optional`tools

tools?: CanonicalTool<JsonObject>[]