@ai-sdk/openai 2.0.0-canary.0 → 2.0.0-canary.10

package/dist/internal/index.d.ts

@@ -0,0 +1,390 @@
+import { LanguageModelV2, EmbeddingModelV2, ImageModelV1, TranscriptionModelV1CallOptions, TranscriptionModelV1, SpeechModelV1 } from '@ai-sdk/provider';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+import { z } from 'zod';
+
+type OpenAIChatModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'o4-mini' | 'o4-mini-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview' | 'gpt-4o-mini-search-preview-2025-03-11' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
+declare const openaiProviderOptions: z.ZodObject<{
+    /**
+     * Modify the likelihood of specified tokens appearing in the completion.
+     *
+     * Accepts a JSON object that maps tokens (specified by their token ID in
+     * the GPT tokenizer) to an associated bias value from -100 to 100.
+     */
+    logitBias: z.ZodOptional<z.ZodRecord<z.ZodNumber, z.ZodNumber>>;
+    /**
+     * Return the log probabilities of the tokens.
+     *
+     * Setting to true will return the log probabilities of the tokens that
+     * were generated.
+     *
+     * Setting to a number will return the log probabilities of the top n
+     * tokens that were generated.
+     */
+    logprobs: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodNumber]>>;
+    /**
+     * Whether to enable parallel function calling during tool use. Default to true.
+     */
+    parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
+    /**
+     * A unique identifier representing your end-user, which can help OpenAI to
+     * monitor and detect abuse.
+     */
+    user: z.ZodOptional<z.ZodString>;
+    /**
+     * Reasoning effort for reasoning models. Defaults to `medium`.
+     */
+    reasoningEffort: z.ZodOptional<z.ZodEnum<["low", "medium", "high"]>>;
+    /**
+     * Maximum number of completion tokens to generate. Useful for reasoning models.
+     */
+    maxCompletionTokens: z.ZodOptional<z.ZodNumber>;
+    /**
+     * Whether to enable persistence in responses API.
+     */
+    store: z.ZodOptional<z.ZodBoolean>;
+    /**
+     * Metadata to associate with the request.
+     */
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    /**
+     * Parameters for prediction mode.
+     */
+    prediction: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    user?: string | undefined;
+    logitBias?: Record<number, number> | undefined;
+    logprobs?: number | boolean | undefined;
+    parallelToolCalls?: boolean | undefined;
+    reasoningEffort?: "low" | "medium" | "high" | undefined;
+    maxCompletionTokens?: number | undefined;
+    store?: boolean | undefined;
+    metadata?: Record<string, string> | undefined;
+    prediction?: Record<string, any> | undefined;
+}, {
+    user?: string | undefined;
+    logitBias?: Record<number, number> | undefined;
+    logprobs?: number | boolean | undefined;
+    parallelToolCalls?: boolean | undefined;
+    reasoningEffort?: "low" | "medium" | "high" | undefined;
+    maxCompletionTokens?: number | undefined;
+    store?: boolean | undefined;
+    metadata?: Record<string, string> | undefined;
+    prediction?: Record<string, any> | undefined;
+}>;
+type OpenAIProviderOptions = z.infer<typeof openaiProviderOptions>;
+interface OpenAIChatSettings {
+    /**
+  Whether to use structured outputs. Defaults to false.
+  
+  When enabled, tool calls and object generation will be strict and follow the provided schema.
+  */
+    structuredOutputs?: boolean;
+}
+
+type OpenAIChatConfig = {
+    provider: string;
+    compatibility: 'strict' | 'compatible';
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: FetchFunction;
+};
+declare class OpenAIChatLanguageModel implements LanguageModelV2 {
+    readonly specificationVersion = "v2";
+    readonly modelId: OpenAIChatModelId;
+    readonly settings: OpenAIChatSettings;
+    private readonly config;
+    constructor(modelId: OpenAIChatModelId, settings: OpenAIChatSettings, config: OpenAIChatConfig);
+    get provider(): string;
+    getSupportedUrls(): Promise<Record<string, RegExp[]>>;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
+    doStream(options: Parameters<LanguageModelV2['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
+}
+
+type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
+interface OpenAICompletionSettings {
+    /**
+  Echo back the prompt in addition to the completion.
+     */
+    echo?: boolean;
+    /**
+  Modify the likelihood of specified tokens appearing in the completion.
+  
+  Accepts a JSON object that maps tokens (specified by their token ID in
+  the GPT tokenizer) to an associated bias value from -100 to 100. You
+  can use this tokenizer tool to convert text to token IDs. Mathematically,
+  the bias is added to the logits generated by the model prior to sampling.
+  The exact effect will vary per model, but values between -1 and 1 should
+  decrease or increase likelihood of selection; values like -100 or 100
+  should result in a ban or exclusive selection of the relevant token.
+  
+  As an example, you can pass {"50256": -100} to prevent the <|endoftext|>
+  token from being generated.
+     */
+    logitBias?: Record<number, number>;
+    /**
+  Return the log probabilities of the tokens. Including logprobs will increase
+  the response size and can slow down response times. However, it can
+  be useful to better understand how the model is behaving.
+  
+  Setting to true will return the log probabilities of the tokens that
+  were generated.
+  
+  Setting to a number will return the log probabilities of the top n
+  tokens that were generated.
+     */
+    logprobs?: boolean | number;
+    /**
+  The suffix that comes after a completion of inserted text.
+     */
+    suffix?: string;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+     */
+    user?: string;
+}
+
+type OpenAICompletionConfig = {
+    provider: string;
+    compatibility: 'strict' | 'compatible';
+    headers: () => Record<string, string | undefined>;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    fetch?: FetchFunction;
+};
+declare class OpenAICompletionLanguageModel implements LanguageModelV2 {
+    readonly specificationVersion = "v2";
+    readonly modelId: OpenAICompletionModelId;
+    readonly settings: OpenAICompletionSettings;
+    private readonly config;
+    constructor(modelId: OpenAICompletionModelId, settings: OpenAICompletionSettings, config: OpenAICompletionConfig);
+    get provider(): string;
+    getSupportedUrls(): Promise<Record<string, RegExp[]>>;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
+    doStream(options: Parameters<LanguageModelV2['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
+}
+
+type OpenAIConfig = {
+    provider: string;
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    headers: () => Record<string, string | undefined>;
+    fetch?: FetchFunction;
+    generateId?: () => string;
+};
+
+type OpenAIEmbeddingModelId = 'text-embedding-3-small' | 'text-embedding-3-large' | 'text-embedding-ada-002' | (string & {});
+interface OpenAIEmbeddingSettings {
+    /**
+  Override the maximum number of embeddings per call.
+     */
+    maxEmbeddingsPerCall?: number;
+    /**
+  Override the parallelism of embedding calls.
+      */
+    supportsParallelCalls?: boolean;
+}
+declare const openaiEmbeddingProviderOptions: z.ZodObject<{
+    /**
+  The number of dimensions the resulting output embeddings should have.
+  Only supported in text-embedding-3 and later models.
+     */
+    dimensions: z.ZodOptional<z.ZodNumber>;
+    /**
+  A unique identifier representing your end-user, which can help OpenAI to
+  monitor and detect abuse. Learn more.
+  */
+    user: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    user?: string | undefined;
+    dimensions?: number | undefined;
+}, {
+    user?: string | undefined;
+    dimensions?: number | undefined;
+}>;
+type OpenAIEmbeddingProviderOptions = z.infer<typeof openaiEmbeddingProviderOptions>;
+
+declare class OpenAIEmbeddingModel implements EmbeddingModelV2<string> {
+    readonly specificationVersion = "v2";
+    readonly modelId: OpenAIEmbeddingModelId;
+    private readonly config;
+    private readonly settings;
+    get provider(): string;
+    get maxEmbeddingsPerCall(): number;
+    get supportsParallelCalls(): boolean;
+    constructor(modelId: OpenAIEmbeddingModelId, settings: OpenAIEmbeddingSettings, config: OpenAIConfig);
+    doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV2<string>['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV2<string>['doEmbed']>>>;
+}
+
+type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | (string & {});
+declare const modelMaxImagesPerCall: Record<OpenAIImageModelId, number>;
+interface OpenAIImageSettings {
+    /**
+  Override the maximum number of images per call (default is dependent on the
+  model, or 1 for an unknown model).
+     */
+    maxImagesPerCall?: number;
+}
+
+interface OpenAIImageModelConfig extends OpenAIConfig {
+    _internal?: {
+        currentDate?: () => Date;
+    };
+}
+declare class OpenAIImageModel implements ImageModelV1 {
+    readonly modelId: OpenAIImageModelId;
+    private readonly settings;
+    private readonly config;
+    readonly specificationVersion = "v1";
+    get maxImagesPerCall(): number;
+    get provider(): string;
+    constructor(modelId: OpenAIImageModelId, settings: OpenAIImageSettings, config: OpenAIImageModelConfig);
+    doGenerate({ prompt, n, size, aspectRatio, seed, providerOptions, headers, abortSignal, }: Parameters<ImageModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<ImageModelV1['doGenerate']>>>;
+}
+
+type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-4o-transcribe' | (string & {});
+type OpenAITranscriptionModelOptions = {
+    /**
+     * Additional information to include in the transcription response.
+     */
+    include?: string[];
+    /**
+     * The language of the input audio in ISO-639-1 format.
+     */
+    language?: string;
+    /**
+     * An optional text to guide the model's style or continue a previous audio segment.
+     */
+    prompt?: string;
+    /**
+     * The sampling temperature, between 0 and 1.
+     * @default 0
+     */
+    temperature?: number;
+    /**
+     * The timestamp granularities to populate for this transcription.
+     * @default ['segment']
+     */
+    timestamp_granularities?: Array<'word' | 'segment'>;
+};
+
+declare const openAIProviderOptionsSchema: z.ZodObject<{
+    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
+    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    temperature: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodNumber>>>;
+    timestampGranularities: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEnum<["word", "segment"]>, "many">>>>;
+}, "strip", z.ZodTypeAny, {
+    temperature: number | null;
+    timestampGranularities: ("word" | "segment")[] | null;
+    prompt?: string | null | undefined;
+    include?: string[] | null | undefined;
+    language?: string | null | undefined;
+}, {
+    prompt?: string | null | undefined;
+    temperature?: number | null | undefined;
+    include?: string[] | null | undefined;
+    language?: string | null | undefined;
+    timestampGranularities?: ("word" | "segment")[] | null | undefined;
+}>;
+type OpenAITranscriptionCallOptions = Omit<TranscriptionModelV1CallOptions, 'providerOptions'> & {
+    providerOptions?: {
+        openai?: z.infer<typeof openAIProviderOptionsSchema>;
+    };
+};
+interface OpenAITranscriptionModelConfig extends OpenAIConfig {
+    _internal?: {
+        currentDate?: () => Date;
+    };
+}
+declare class OpenAITranscriptionModel implements TranscriptionModelV1 {
+    readonly modelId: OpenAITranscriptionModelId;
+    private readonly config;
+    readonly specificationVersion = "v1";
+    get provider(): string;
+    constructor(modelId: OpenAITranscriptionModelId, config: OpenAITranscriptionModelConfig);
+    private getArgs;
+    doGenerate(options: OpenAITranscriptionCallOptions): Promise<Awaited<ReturnType<TranscriptionModelV1['doGenerate']>>>;
+}
+
+type OpenAISpeechModelId = 'tts-1' | 'tts-1-hd' | 'gpt-4o-mini-tts' | (string & {});
+
+declare const OpenAIProviderOptionsSchema: z.ZodObject<{
+    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    speed: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
+}, "strip", z.ZodTypeAny, {
+    instructions?: string | null | undefined;
+    speed?: number | null | undefined;
+}, {
+    instructions?: string | null | undefined;
+    speed?: number | null | undefined;
+}>;
+type OpenAISpeechCallOptions = z.infer<typeof OpenAIProviderOptionsSchema>;
+interface OpenAISpeechModelConfig extends OpenAIConfig {
+    _internal?: {
+        currentDate?: () => Date;
+    };
+}
+declare class OpenAISpeechModel implements SpeechModelV1 {
+    readonly modelId: OpenAISpeechModelId;
+    private readonly config;
+    readonly specificationVersion = "v1";
+    get provider(): string;
+    constructor(modelId: OpenAISpeechModelId, config: OpenAISpeechModelConfig);
+    private getArgs;
+    doGenerate(options: Parameters<SpeechModelV1['doGenerate']>[0]): Promise<Awaited<ReturnType<SpeechModelV1['doGenerate']>>>;
+}
+
+type OpenAIResponsesModelId = 'o1' | 'o1-2024-12-17' | 'o1-mini' | 'o1-mini-2024-09-12' | 'o1-preview' | 'o1-preview-2024-09-12' | 'o3-mini' | 'o3-mini-2025-01-31' | 'o3' | 'o3-2025-04-16' | 'o4-mini' | 'o4-mini-2025-04-16' | 'gpt-4.1' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-audio-preview' | 'gpt-4o-audio-preview-2024-10-01' | 'gpt-4o-audio-preview-2024-12-17' | 'gpt-4o-search-preview' | 'gpt-4o-search-preview-2025-03-11' | 'gpt-4o-mini-search-preview' | 'gpt-4o-mini-search-preview-2025-03-11' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4.5-preview' | 'gpt-4.5-preview-2025-02-27' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'chatgpt-4o-latest' | (string & {});
+
+declare class OpenAIResponsesLanguageModel implements LanguageModelV2 {
+    readonly specificationVersion = "v2";
+    readonly modelId: OpenAIResponsesModelId;
+    private readonly config;
+    constructor(modelId: OpenAIResponsesModelId, config: OpenAIConfig);
+    getSupportedUrls(): Promise<Record<string, RegExp[]>>;
+    get provider(): string;
+    private getArgs;
+    doGenerate(options: Parameters<LanguageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
+    doStream(options: Parameters<LanguageModelV2['doStream']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doStream']>>>;
+}
+declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
+    metadata: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+    parallelToolCalls: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    previousResponseId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    store: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    user: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    strictSchemas: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    user?: string | null | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    reasoningEffort?: string | null | undefined;
+    store?: boolean | null | undefined;
+    metadata?: any;
+    instructions?: string | null | undefined;
+    previousResponseId?: string | null | undefined;
+    strictSchemas?: boolean | null | undefined;
+}, {
+    user?: string | null | undefined;
+    parallelToolCalls?: boolean | null | undefined;
+    reasoningEffort?: string | null | undefined;
+    store?: boolean | null | undefined;
+    metadata?: any;
+    instructions?: string | null | undefined;
+    previousResponseId?: string | null | undefined;
+    strictSchemas?: boolean | null | undefined;
+}>;
+type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
+
+export { OpenAIChatLanguageModel, type OpenAIChatModelId, type OpenAIChatSettings, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionSettings, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, type OpenAIEmbeddingSettings, OpenAIImageModel, type OpenAIImageModelId, type OpenAIImageSettings, type OpenAIProviderOptions, OpenAIResponsesLanguageModel, type OpenAIResponsesProviderOptions, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, modelMaxImagesPerCall, openaiEmbeddingProviderOptions, openaiProviderOptions };