unified-llm-client
    Preparing search index...

    Interface MockLLMClientOptions

    Configuration for LLMClient.mock() test instances.

    interface MockLLMClientOptions {
        budgetExceededAction?: BudgetExceededAction;
        defaultEmbeddingModel?: string;
        defaultEmbeddingProvider?: EmbeddingProvider;
        defaultModel?: string;
        defaultProvider?: CanonicalProvider;
        fetchImplementation?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        modelRegistry?: ModelRegistry;
        modelRegistryOptions?: ModelRegistryOptions;
        modelRouter?: ModelRouter;
        onWarning?: (message: string) => void;
        openaiOrganization?: string;
        openaiProject?: string;
        retryOptions?: RetryOptions;
        sessionStore?: SessionStore<ConversationSnapshot>;
        usageLogger?: UsageLogger;
        embeddings?: (
            | EmbeddingResponse
            | (
                (
                    options: EmbeddingRequestOptions & {
                        model: string;
                        provider: EmbeddingProvider;
                    },
                ) => EmbeddingResponse
                | Promise<EmbeddingResponse>
            )
        )[];
        responses?: (
            | CanonicalResponse
            | (
                (
                    options: LLMRequestOptions & {
                        maxTokens: number;
                        model: string;
                        provider: CanonicalProvider;
                    },
                ) => CanonicalResponse
                | Promise<CanonicalResponse>
            )
        )[];
        streams?: (
            | AsyncIterable<StreamChunk, any, any>
            | StreamChunk[]
            | (
                (
                    options: LLMRequestOptions & {
                        maxTokens: number;
                        model: string;
                        provider: CanonicalProvider;
                    },
                ) => | AsyncIterable<StreamChunk, any, any>
                | StreamChunk[]
                | Promise<AsyncIterable<StreamChunk, any, any> | StreamChunk[]>
            )
        )[];
        speeches?: (
            | SpeechResponse
            | (
                (
                    options: SpeechRequestOptions & {
                        model: string;
                        provider: SpeechProvider;
                    },
                ) => SpeechResponse
                | Promise<SpeechResponse>
            )
        )[];
        transcriptions?: (
            | TranscriptionResponse
            | (
                (
                    options: TranscriptionRequestOptions & {
                        model: string;
                        provider: SpeechProvider;
                    },
                ) => TranscriptionResponse
                | Promise<TranscriptionResponse>
            )
        )[];
    }

    Hierarchy

    • Omit<LLMClientOptions, "anthropicApiKey" | "geminiApiKey" | "openaiApiKey">
      • MockLLMClientOptions
    Index

    Properties

    budgetExceededAction?: BudgetExceededAction
    defaultEmbeddingModel?: string
    defaultEmbeddingProvider?: EmbeddingProvider
    defaultModel?: string
    defaultProvider?: CanonicalProvider
    fetchImplementation?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
      • Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>
      • Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    modelRegistry?: ModelRegistry
    modelRegistryOptions?: ModelRegistryOptions
    modelRouter?: ModelRouter
    onWarning?: (message: string) => void
    openaiOrganization?: string
    openaiProject?: string
    retryOptions?: RetryOptions
    usageLogger?: UsageLogger
    embeddings?: (
        | EmbeddingResponse
        | (
            (
                options: EmbeddingRequestOptions & {
                    model: string;
                    provider: EmbeddingProvider;
                },
            ) => EmbeddingResponse
            | Promise<EmbeddingResponse>
        )
    )[]
    responses?: (
        | CanonicalResponse
        | (
            (
                options: LLMRequestOptions & {
                    maxTokens: number;
                    model: string;
                    provider: CanonicalProvider;
                },
            ) => CanonicalResponse
            | Promise<CanonicalResponse>
        )
    )[]
    streams?: (
        | AsyncIterable<StreamChunk, any, any>
        | StreamChunk[]
        | (
            (
                options: LLMRequestOptions & {
                    maxTokens: number;
                    model: string;
                    provider: CanonicalProvider;
                },
            ) => | AsyncIterable<StreamChunk, any, any>
            | StreamChunk[]
            | Promise<AsyncIterable<StreamChunk, any, any> | StreamChunk[]>
        )
    )[]
    speeches?: (
        | SpeechResponse
        | (
            (
                options: SpeechRequestOptions & {
                    model: string;
                    provider: SpeechProvider;
                },
            ) => SpeechResponse
            | Promise<SpeechResponse>
        )
    )[]
    transcriptions?: (
        | TranscriptionResponse
        | (
            (
                options: TranscriptionRequestOptions & {
                    model: string;
                    provider: SpeechProvider;
                },
            ) => TranscriptionResponse
            | Promise<TranscriptionResponse>
        )
    )[]