Interface ConversationOptions

Configuration for a new or restored Conversation.

interface ConversationOptions {
    budgetExceededAction?: BudgetExceededAction;
    budgetUsd?: number;
    contextManager?: ContextManager;
    maxToolRounds?: number;
    maxContextTokens?: number;
    maxTokens?: number;
    messages?: CanonicalMessage[];
    model?: string;
    provider?: CanonicalProvider;
    providerOptions?: ProviderOptions;
    sessionId?: string;
    store?: SessionStore<ConversationSnapshot>;
    system?: string;
    tenantId?: string;
    toolExecutionTimeoutMs?: number;
    toolChoice?: CanonicalToolChoice;
    tools?: CanonicalTool<JsonObject>[];
    onWarning?: (message: string) => void;
}

Index

Properties

budgetExceededAction? budgetUsd? contextManager? maxToolRounds? maxContextTokens? maxTokens? messages? model? provider? providerOptions? sessionId? store? system? tenantId? toolExecutionTimeoutMs? toolChoice? tools? onWarning?

Properties

`Optional`budgetExceededAction

budgetExceededAction?: BudgetExceededAction

`Optional`budgetUsd

budgetUsd?: number

`Optional`contextManager

contextManager?: ContextManager

`Optional`maxToolRounds

maxToolRounds?: number

`Optional`maxContextTokens

maxContextTokens?: number

`Optional`maxTokens

maxTokens?: number

`Optional`messages

messages?: CanonicalMessage[]

`Optional`model

model?: string

`Optional`provider

provider?: CanonicalProvider

`Optional`providerOptions

providerOptions?: ProviderOptions

`Optional`sessionId

sessionId?: string

`Optional`store

store?: SessionStore<ConversationSnapshot>

`Optional`system

system?: string

`Optional`tenantId

tenantId?: string

`Optional`toolExecutionTimeoutMs

toolExecutionTimeoutMs?: number

`Optional`toolChoice

toolChoice?: CanonicalToolChoice

`Optional`tools

tools?: CanonicalTool<JsonObject>[]

`Optional`onWarning

onWarning?: (message: string) => void