ai/dist/test/index.d.mts

AI SDK by Vercel - The AI Toolkit for TypeScript and JavaScript

export { convertArrayToAsyncIterable, convertArrayToReadableStream, convertReadableStreamToArray, mockId } from '@ai-sdk/provider-utils/test';
import { EmbeddingModelV3, ImageModelV3, LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, ProviderV3, TranscriptionModelV3, SpeechModelV3, RerankingModelV3 } from '@ai-sdk/provider';

declare class MockEmbeddingModelV3 implements EmbeddingModelV3 {
    readonly specificationVersion = "v3";
    readonly provider: EmbeddingModelV3['provider'];
    readonly modelId: EmbeddingModelV3['modelId'];
    readonly maxEmbeddingsPerCall: EmbeddingModelV3['maxEmbeddingsPerCall'];
    readonly supportsParallelCalls: EmbeddingModelV3['supportsParallelCalls'];
    doEmbed: EmbeddingModelV3['doEmbed'];
    doEmbedCalls: Parameters<EmbeddingModelV3['doEmbed']>[0][];
    constructor({ provider, modelId, maxEmbeddingsPerCall, supportsParallelCalls, doEmbed, }?: {
        provider?: EmbeddingModelV3['provider'];
        modelId?: EmbeddingModelV3['modelId'];
        maxEmbeddingsPerCall?: EmbeddingModelV3['maxEmbeddingsPerCall'] | null;
        supportsParallelCalls?: EmbeddingModelV3['supportsParallelCalls'];
        doEmbed?: EmbeddingModelV3['doEmbed'] | Awaited<ReturnType<EmbeddingModelV3['doEmbed']>> | Awaited<ReturnType<EmbeddingModelV3['doEmbed']>>[];
    });
}

declare class MockImageModelV3 implements ImageModelV3 {
    readonly specificationVersion = "v3";
    readonly provider: ImageModelV3['provider'];
    readonly modelId: ImageModelV3['modelId'];
    readonly maxImagesPerCall: ImageModelV3['maxImagesPerCall'];
    doGenerate: ImageModelV3['doGenerate'];
    constructor({ provider, modelId, maxImagesPerCall, doGenerate, }?: {
        provider?: ImageModelV3['provider'];
        modelId?: ImageModelV3['modelId'];
        maxImagesPerCall?: ImageModelV3['maxImagesPerCall'];
        doGenerate?: ImageModelV3['doGenerate'];
    });
}

declare class MockLanguageModelV3 implements LanguageModelV3 {
    readonly specificationVersion = "v3";
    private _supportedUrls;
    readonly provider: LanguageModelV3['provider'];
    readonly modelId: LanguageModelV3['modelId'];
    doGenerate: LanguageModelV3['doGenerate'];
    doStream: LanguageModelV3['doStream'];
    doGenerateCalls: LanguageModelV3CallOptions[];
    doStreamCalls: LanguageModelV3CallOptions[];
    constructor({ provider, modelId, supportedUrls, doGenerate, doStream, }?: {
        provider?: LanguageModelV3['provider'];
        modelId?: LanguageModelV3['modelId'];
        supportedUrls?: LanguageModelV3['supportedUrls'] | (() => LanguageModelV3['supportedUrls']);
        doGenerate?: LanguageModelV3['doGenerate'] | LanguageModelV3GenerateResult | LanguageModelV3GenerateResult[];
        doStream?: LanguageModelV3['doStream'] | LanguageModelV3StreamResult | LanguageModelV3StreamResult[];
    });
    get supportedUrls(): Record<string, RegExp[]> | PromiseLike<Record<string, RegExp[]>>;
}

declare class MockProviderV3 implements ProviderV3 {
    readonly specificationVersion: "v3";
    languageModel: ProviderV3['languageModel'];
    embeddingModel: ProviderV3['embeddingModel'];
    imageModel: ProviderV3['imageModel'];
    transcriptionModel: ProviderV3['transcriptionModel'];
    speechModel: ProviderV3['speechModel'];
    rerankingModel: ProviderV3['rerankingModel'];
    constructor({ languageModels, embeddingModels, imageModels, transcriptionModels, speechModels, rerankingModels, }?: {
        languageModels?: Record<string, LanguageModelV3>;
        embeddingModels?: Record<string, EmbeddingModelV3>;
        imageModels?: Record<string, ImageModelV3>;
        transcriptionModels?: Record<string, TranscriptionModelV3>;
        speechModels?: Record<string, SpeechModelV3>;
        rerankingModels?: Record<string, RerankingModelV3>;
    });
}

declare class MockSpeechModelV3 implements SpeechModelV3 {
    readonly specificationVersion = "v3";
    readonly provider: SpeechModelV3['provider'];
    readonly modelId: SpeechModelV3['modelId'];
    doGenerate: SpeechModelV3['doGenerate'];
    constructor({ provider, modelId, doGenerate, }?: {
        provider?: SpeechModelV3['provider'];
        modelId?: SpeechModelV3['modelId'];
        doGenerate?: SpeechModelV3['doGenerate'];
    });
}

declare class MockTranscriptionModelV3 implements TranscriptionModelV3 {
    readonly specificationVersion = "v3";
    readonly provider: TranscriptionModelV3['provider'];
    readonly modelId: TranscriptionModelV3['modelId'];
    doGenerate: TranscriptionModelV3['doGenerate'];
    constructor({ provider, modelId, doGenerate, }?: {
        provider?: TranscriptionModelV3['provider'];
        modelId?: TranscriptionModelV3['modelId'];
        doGenerate?: TranscriptionModelV3['doGenerate'];
    });
}

declare class MockRerankingModelV3 implements RerankingModelV3 {
    readonly specificationVersion = "v3";
    readonly provider: RerankingModelV3['provider'];
    readonly modelId: RerankingModelV3['modelId'];
    doRerank: RerankingModelV3['doRerank'];
    constructor({ provider, modelId, doRerank, }?: {
        provider?: RerankingModelV3['provider'];
        modelId?: RerankingModelV3['modelId'];
        doRerank?: RerankingModelV3['doRerank'];
    });
}

declare function mockValues<T>(...values: T[]): () => T;

/**
 * Creates a ReadableStream that emits the provided values with an optional delay between each value.
 *
 * @param options - The configuration options
 * @param options.chunks - Array of values to be emitted by the stream
 * @param options.initialDelayInMs - Optional initial delay in milliseconds before emitting the first value (default: 0). Can be set to `null` to skip the initial delay. The difference between `initialDelayInMs: null` and `initialDelayInMs: 0` is that `initialDelayInMs: null` will emit the values without any delay, while `initialDelayInMs: 0` will emit the values with a delay of 0 milliseconds.
 * @param options.chunkDelayInMs - Optional delay in milliseconds between emitting each value (default: 0). Can be set to `null` to skip the delay. The difference between `chunkDelayInMs: null` and `chunkDelayInMs: 0` is that `chunkDelayInMs: null` will emit the values without any delay, while `chunkDelayInMs: 0` will emit the values with a delay of 0 milliseconds.
 * @returns A ReadableStream that emits the provided values
 */
declare function simulateReadableStream$1<T>({ chunks, initialDelayInMs, chunkDelayInMs, _internal, }: {
    chunks: T[];
    initialDelayInMs?: number | null;
    chunkDelayInMs?: number | null;
    _internal?: {
        delay?: (ms: number | null) => Promise<void>;
    };
}): ReadableStream<T>;

/**
 * @deprecated Use `simulateReadableStream` from `ai` instead.
 */
declare const simulateReadableStream: typeof simulateReadableStream$1;

export { MockEmbeddingModelV3, MockImageModelV3, MockLanguageModelV3, MockProviderV3, MockRerankingModelV3, MockSpeechModelV3, MockTranscriptionModelV3, mockValues, simulateReadableStream };