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

package/dist/internal/index.d.mts

@@ -1,4 +1,4 @@
-import { LanguageModelV2, EmbeddingModelV2, ImageModelV1, TranscriptionModelV1CallOptions, TranscriptionModelV1, SpeechModelV1 } from '@ai-sdk/provider';
+import { LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV1CallOptions, TranscriptionModelV1, SpeechModelV1 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z } from 'zod';
 
@@ -11,16 +11,6 @@ declare const openaiProviderOptions: z.ZodObject<{
      * 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.
      */
@@ -53,7 +43,6 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, "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;
@@ -63,7 +52,6 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
-    logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     reasoningEffort?: "low" | "medium" | "high" | undefined;
     maxCompletionTokens?: number | undefined;
@@ -105,11 +93,11 @@ declare class OpenAIChatLanguageModel implements LanguageModelV2 {
 }
 
 type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
-interface OpenAICompletionSettings {
+declare const openaiCompletionProviderOptions: z.ZodObject<{
     /**
   Echo back the prompt in addition to the completion.
      */
-    echo?: boolean;
+    echo: z.ZodOptional<z.ZodBoolean>;
     /**
   Modify the likelihood of specified tokens appearing in the completion.
   
@@ -123,30 +111,29 @@ interface OpenAICompletionSettings {
   
   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;
+   */
+    logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
     /**
   The suffix that comes after a completion of inserted text.
-     */
-    suffix?: string;
+   */
+    suffix: z.ZodOptional<z.ZodString>;
     /**
   A unique identifier representing your end-user, which can help OpenAI to
   monitor and detect abuse. Learn more.
-     */
-    user?: string;
-}
+   */
+    user: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    user?: string | undefined;
+    logitBias?: Record<string, number> | undefined;
+    echo?: boolean | undefined;
+    suffix?: string | undefined;
+}, {
+    user?: string | undefined;
+    logitBias?: Record<string, number> | undefined;
+    echo?: boolean | undefined;
+    suffix?: string | undefined;
+}>;
+type OpenAICompletionProviderOptions = z.infer<typeof openaiCompletionProviderOptions>;
 
 type OpenAICompletionConfig = {
     provider: string;
@@ -161,9 +148,9 @@ type OpenAICompletionConfig = {
 declare class OpenAICompletionLanguageModel implements LanguageModelV2 {
     readonly specificationVersion = "v2";
     readonly modelId: OpenAICompletionModelId;
-    readonly settings: OpenAICompletionSettings;
     private readonly config;
-    constructor(modelId: OpenAICompletionModelId, settings: OpenAICompletionSettings, config: OpenAICompletionConfig);
+    private get providerOptionsName();
+    constructor(modelId: OpenAICompletionModelId, config: OpenAICompletionConfig);
     get provider(): string;
     getSupportedUrls(): Promise<Record<string, RegExp[]>>;
     private getArgs;
@@ -227,6 +214,7 @@ declare class OpenAIEmbeddingModel implements EmbeddingModelV2<string> {
 
 type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | (string & {});
 declare const modelMaxImagesPerCall: Record<OpenAIImageModelId, number>;
+declare const hasDefaultResponseFormat: Set<string>;
 interface OpenAIImageSettings {
     /**
   Override the maximum number of images per call (default is dependent on the
@@ -240,7 +228,7 @@ interface OpenAIImageModelConfig extends OpenAIConfig {
         currentDate?: () => Date;
     };
 }
-declare class OpenAIImageModel implements ImageModelV1 {
+declare class OpenAIImageModel implements ImageModelV2 {
     readonly modelId: OpenAIImageModelId;
     private readonly settings;
     private readonly config;
@@ -248,7 +236,7 @@ declare class OpenAIImageModel implements ImageModelV1 {
     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']>>>;
+    doGenerate({ prompt, n, size, aspectRatio, seed, providerOptions, headers, abortSignal, }: Parameters<ImageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<ImageModelV2['doGenerate']>>>;
 }
 
 type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-4o-transcribe' | (string & {});
@@ -366,6 +354,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     strictSchemas: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    reasoningSummary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     user?: string | null | undefined;
     parallelToolCalls?: boolean | null | undefined;
@@ -375,6 +364,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     instructions?: string | null | undefined;
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
+    reasoningSummary?: string | null | undefined;
 }, {
     user?: string | null | undefined;
     parallelToolCalls?: boolean | null | undefined;
@@ -384,7 +374,8 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     instructions?: string | null | undefined;
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
+    reasoningSummary?: string | 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 };
+export { OpenAIChatLanguageModel, type OpenAIChatModelId, type OpenAIChatSettings, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, 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, hasDefaultResponseFormat, modelMaxImagesPerCall, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiProviderOptions };

package/dist/internal/index.d.ts

@@ -1,4 +1,4 @@
-import { LanguageModelV2, EmbeddingModelV2, ImageModelV1, TranscriptionModelV1CallOptions, TranscriptionModelV1, SpeechModelV1 } from '@ai-sdk/provider';
+import { LanguageModelV2, EmbeddingModelV2, ImageModelV2, TranscriptionModelV1CallOptions, TranscriptionModelV1, SpeechModelV1 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z } from 'zod';
 
@@ -11,16 +11,6 @@ declare const openaiProviderOptions: z.ZodObject<{
      * 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.
      */
@@ -53,7 +43,6 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, "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;
@@ -63,7 +52,6 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
-    logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     reasoningEffort?: "low" | "medium" | "high" | undefined;
     maxCompletionTokens?: number | undefined;
@@ -105,11 +93,11 @@ declare class OpenAIChatLanguageModel implements LanguageModelV2 {
 }
 
 type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
-interface OpenAICompletionSettings {
+declare const openaiCompletionProviderOptions: z.ZodObject<{
     /**
   Echo back the prompt in addition to the completion.
      */
-    echo?: boolean;
+    echo: z.ZodOptional<z.ZodBoolean>;
     /**
   Modify the likelihood of specified tokens appearing in the completion.
   
@@ -123,30 +111,29 @@ interface OpenAICompletionSettings {
   
   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;
+   */
+    logitBias: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
     /**
   The suffix that comes after a completion of inserted text.
-     */
-    suffix?: string;
+   */
+    suffix: z.ZodOptional<z.ZodString>;
     /**
   A unique identifier representing your end-user, which can help OpenAI to
   monitor and detect abuse. Learn more.
-     */
-    user?: string;
-}
+   */
+    user: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    user?: string | undefined;
+    logitBias?: Record<string, number> | undefined;
+    echo?: boolean | undefined;
+    suffix?: string | undefined;
+}, {
+    user?: string | undefined;
+    logitBias?: Record<string, number> | undefined;
+    echo?: boolean | undefined;
+    suffix?: string | undefined;
+}>;
+type OpenAICompletionProviderOptions = z.infer<typeof openaiCompletionProviderOptions>;
 
 type OpenAICompletionConfig = {
     provider: string;
@@ -161,9 +148,9 @@ type OpenAICompletionConfig = {
 declare class OpenAICompletionLanguageModel implements LanguageModelV2 {
     readonly specificationVersion = "v2";
     readonly modelId: OpenAICompletionModelId;
-    readonly settings: OpenAICompletionSettings;
     private readonly config;
-    constructor(modelId: OpenAICompletionModelId, settings: OpenAICompletionSettings, config: OpenAICompletionConfig);
+    private get providerOptionsName();
+    constructor(modelId: OpenAICompletionModelId, config: OpenAICompletionConfig);
     get provider(): string;
     getSupportedUrls(): Promise<Record<string, RegExp[]>>;
     private getArgs;
@@ -227,6 +214,7 @@ declare class OpenAIEmbeddingModel implements EmbeddingModelV2<string> {
 
 type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | (string & {});
 declare const modelMaxImagesPerCall: Record<OpenAIImageModelId, number>;
+declare const hasDefaultResponseFormat: Set<string>;
 interface OpenAIImageSettings {
     /**
   Override the maximum number of images per call (default is dependent on the
@@ -240,7 +228,7 @@ interface OpenAIImageModelConfig extends OpenAIConfig {
         currentDate?: () => Date;
     };
 }
-declare class OpenAIImageModel implements ImageModelV1 {
+declare class OpenAIImageModel implements ImageModelV2 {
     readonly modelId: OpenAIImageModelId;
     private readonly settings;
     private readonly config;
@@ -248,7 +236,7 @@ declare class OpenAIImageModel implements ImageModelV1 {
     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']>>>;
+    doGenerate({ prompt, n, size, aspectRatio, seed, providerOptions, headers, abortSignal, }: Parameters<ImageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<ImageModelV2['doGenerate']>>>;
 }
 
 type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-4o-transcribe' | (string & {});
@@ -366,6 +354,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     strictSchemas: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    reasoningSummary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     user?: string | null | undefined;
     parallelToolCalls?: boolean | null | undefined;
@@ -375,6 +364,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     instructions?: string | null | undefined;
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
+    reasoningSummary?: string | null | undefined;
 }, {
     user?: string | null | undefined;
     parallelToolCalls?: boolean | null | undefined;
@@ -384,7 +374,8 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     instructions?: string | null | undefined;
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
+    reasoningSummary?: string | 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 };
+export { OpenAIChatLanguageModel, type OpenAIChatModelId, type OpenAIChatSettings, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, 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, hasDefaultResponseFormat, modelMaxImagesPerCall, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiProviderOptions };