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

package/dist/internal/index.d.mts

@@ -40,6 +40,12 @@ declare const openaiProviderOptions: z.ZodObject<{
      * Parameters for prediction mode.
      */
     prediction: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    /**
+     * Whether to use structured outputs.
+     *
+     * @default true
+     */
+    structuredOutputs: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
@@ -49,6 +55,7 @@ declare const openaiProviderOptions: z.ZodObject<{
     store?: boolean | undefined;
     metadata?: Record<string, string> | undefined;
     prediction?: Record<string, any> | undefined;
+    structuredOutputs?: boolean | undefined;
 }, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
@@ -58,16 +65,9 @@ declare const openaiProviderOptions: z.ZodObject<{
     store?: boolean | undefined;
     metadata?: Record<string, string> | undefined;
     prediction?: Record<string, any> | undefined;
+    structuredOutputs?: boolean | 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;
@@ -82,11 +82,12 @@ type OpenAIChatConfig = {
 declare class OpenAIChatLanguageModel implements LanguageModelV2 {
     readonly specificationVersion = "v2";
     readonly modelId: OpenAIChatModelId;
-    readonly settings: OpenAIChatSettings;
+    readonly supportedUrls: {
+        'image/*': RegExp[];
+    };
     private readonly config;
-    constructor(modelId: OpenAIChatModelId, settings: OpenAIChatSettings, config: OpenAIChatConfig);
+    constructor(modelId: OpenAIChatModelId, 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']>>>;
@@ -152,7 +153,7 @@ declare class OpenAICompletionLanguageModel implements LanguageModelV2 {
     private get providerOptionsName();
     constructor(modelId: OpenAICompletionModelId, config: OpenAICompletionConfig);
     get provider(): string;
-    getSupportedUrls(): Promise<Record<string, RegExp[]>>;
+    readonly supportedUrls: 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']>>>;
@@ -170,16 +171,6 @@ type OpenAIConfig = {
 };
 
 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.
@@ -203,16 +194,15 @@ type OpenAIEmbeddingProviderOptions = z.infer<typeof openaiEmbeddingProviderOpti
 declare class OpenAIEmbeddingModel implements EmbeddingModelV2<string> {
     readonly specificationVersion = "v2";
     readonly modelId: OpenAIEmbeddingModelId;
+    readonly maxEmbeddingsPerCall = 2048;
+    readonly supportsParallelCalls = true;
     private readonly config;
-    private readonly settings;
     get provider(): string;
-    get maxEmbeddingsPerCall(): number;
-    get supportsParallelCalls(): boolean;
-    constructor(modelId: OpenAIEmbeddingModelId, settings: OpenAIEmbeddingSettings, config: OpenAIConfig);
+    constructor(modelId: OpenAIEmbeddingModelId, 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 & {});
+type OpenAIImageModelId = 'gpt-image-1' | 'dall-e-3' | 'dall-e-2' | (string & {});
 declare const modelMaxImagesPerCall: Record<OpenAIImageModelId, number>;
 declare const hasDefaultResponseFormat: Set<string>;
 interface OpenAIImageSettings {
@@ -232,7 +222,7 @@ declare class OpenAIImageModel implements ImageModelV2 {
     readonly modelId: OpenAIImageModelId;
     private readonly settings;
     private readonly config;
-    readonly specificationVersion = "v1";
+    readonly specificationVersion = "v2";
     get maxImagesPerCall(): number;
     get provider(): string;
     constructor(modelId: OpenAIImageModelId, settings: OpenAIImageSettings, config: OpenAIImageModelConfig);
@@ -240,43 +230,35 @@ declare class OpenAIImageModel implements ImageModelV2 {
 }
 
 type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-4o-transcribe' | (string & {});
-type OpenAITranscriptionModelOptions = {
+declare const openAITranscriptionProviderOptions: z.ZodObject<{
     /**
      * Additional information to include in the transcription response.
      */
-    include?: string[];
+    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
     /**
      * The language of the input audio in ISO-639-1 format.
      */
-    language?: string;
+    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     /**
      * An optional text to guide the model's style or continue a previous audio segment.
      */
-    prompt?: string;
+    prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     /**
      * The sampling temperature, between 0 and 1.
      * @default 0
      */
-    temperature?: number;
+    temperature: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     /**
      * 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">>>>;
+    timestampGranularities: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodArray<z.ZodEnum<["word", "segment"]>, "many">>>>;
 }, "strip", z.ZodTypeAny, {
-    temperature: number | null;
-    timestampGranularities: ("word" | "segment")[] | null;
     prompt?: string | null | undefined;
+    temperature?: number | null | undefined;
     include?: string[] | null | undefined;
     language?: string | null | undefined;
+    timestampGranularities?: ("word" | "segment")[] | null | undefined;
 }, {
     prompt?: string | null | undefined;
     temperature?: number | null | undefined;
@@ -284,9 +266,11 @@ declare const openAIProviderOptionsSchema: z.ZodObject<{
     language?: string | null | undefined;
     timestampGranularities?: ("word" | "segment")[] | null | undefined;
 }>;
+type OpenAITranscriptionProviderOptions = z.infer<typeof openAITranscriptionProviderOptions>;
+
 type OpenAITranscriptionCallOptions = Omit<TranscriptionModelV1CallOptions, 'providerOptions'> & {
     providerOptions?: {
-        openai?: z.infer<typeof openAIProviderOptionsSchema>;
+        openai?: OpenAITranscriptionProviderOptions;
     };
 };
 interface OpenAITranscriptionModelConfig extends OpenAIConfig {
@@ -339,7 +323,7 @@ declare class OpenAIResponsesLanguageModel implements LanguageModelV2 {
     readonly modelId: OpenAIResponsesModelId;
     private readonly config;
     constructor(modelId: OpenAIResponsesModelId, config: OpenAIConfig);
-    getSupportedUrls(): Promise<Record<string, RegExp[]>>;
+    readonly supportedUrls: Record<string, RegExp[]>;
     get provider(): string;
     private getArgs;
     doGenerate(options: Parameters<LanguageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
@@ -378,4 +362,4 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
 }>;
 type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
 
-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 };
+export { OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelId, type OpenAIImageSettings, type OpenAIProviderOptions, OpenAIResponsesLanguageModel, type OpenAIResponsesProviderOptions, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, hasDefaultResponseFormat, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiProviderOptions };

package/dist/internal/index.d.ts

@@ -40,6 +40,12 @@ declare const openaiProviderOptions: z.ZodObject<{
      * Parameters for prediction mode.
      */
     prediction: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    /**
+     * Whether to use structured outputs.
+     *
+     * @default true
+     */
+    structuredOutputs: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
@@ -49,6 +55,7 @@ declare const openaiProviderOptions: z.ZodObject<{
     store?: boolean | undefined;
     metadata?: Record<string, string> | undefined;
     prediction?: Record<string, any> | undefined;
+    structuredOutputs?: boolean | undefined;
 }, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
@@ -58,16 +65,9 @@ declare const openaiProviderOptions: z.ZodObject<{
     store?: boolean | undefined;
     metadata?: Record<string, string> | undefined;
     prediction?: Record<string, any> | undefined;
+    structuredOutputs?: boolean | 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;
@@ -82,11 +82,12 @@ type OpenAIChatConfig = {
 declare class OpenAIChatLanguageModel implements LanguageModelV2 {
     readonly specificationVersion = "v2";
     readonly modelId: OpenAIChatModelId;
-    readonly settings: OpenAIChatSettings;
+    readonly supportedUrls: {
+        'image/*': RegExp[];
+    };
     private readonly config;
-    constructor(modelId: OpenAIChatModelId, settings: OpenAIChatSettings, config: OpenAIChatConfig);
+    constructor(modelId: OpenAIChatModelId, 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']>>>;
@@ -152,7 +153,7 @@ declare class OpenAICompletionLanguageModel implements LanguageModelV2 {
     private get providerOptionsName();
     constructor(modelId: OpenAICompletionModelId, config: OpenAICompletionConfig);
     get provider(): string;
-    getSupportedUrls(): Promise<Record<string, RegExp[]>>;
+    readonly supportedUrls: 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']>>>;
@@ -170,16 +171,6 @@ type OpenAIConfig = {
 };
 
 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.
@@ -203,16 +194,15 @@ type OpenAIEmbeddingProviderOptions = z.infer<typeof openaiEmbeddingProviderOpti
 declare class OpenAIEmbeddingModel implements EmbeddingModelV2<string> {
     readonly specificationVersion = "v2";
     readonly modelId: OpenAIEmbeddingModelId;
+    readonly maxEmbeddingsPerCall = 2048;
+    readonly supportsParallelCalls = true;
     private readonly config;
-    private readonly settings;
     get provider(): string;
-    get maxEmbeddingsPerCall(): number;
-    get supportsParallelCalls(): boolean;
-    constructor(modelId: OpenAIEmbeddingModelId, settings: OpenAIEmbeddingSettings, config: OpenAIConfig);
+    constructor(modelId: OpenAIEmbeddingModelId, 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 & {});
+type OpenAIImageModelId = 'gpt-image-1' | 'dall-e-3' | 'dall-e-2' | (string & {});
 declare const modelMaxImagesPerCall: Record<OpenAIImageModelId, number>;
 declare const hasDefaultResponseFormat: Set<string>;
 interface OpenAIImageSettings {
@@ -232,7 +222,7 @@ declare class OpenAIImageModel implements ImageModelV2 {
     readonly modelId: OpenAIImageModelId;
     private readonly settings;
     private readonly config;
-    readonly specificationVersion = "v1";
+    readonly specificationVersion = "v2";
     get maxImagesPerCall(): number;
     get provider(): string;
     constructor(modelId: OpenAIImageModelId, settings: OpenAIImageSettings, config: OpenAIImageModelConfig);
@@ -240,43 +230,35 @@ declare class OpenAIImageModel implements ImageModelV2 {
 }
 
 type OpenAITranscriptionModelId = 'whisper-1' | 'gpt-4o-mini-transcribe' | 'gpt-4o-transcribe' | (string & {});
-type OpenAITranscriptionModelOptions = {
+declare const openAITranscriptionProviderOptions: z.ZodObject<{
     /**
      * Additional information to include in the transcription response.
      */
-    include?: string[];
+    include: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
     /**
      * The language of the input audio in ISO-639-1 format.
      */
-    language?: string;
+    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     /**
      * An optional text to guide the model's style or continue a previous audio segment.
      */
-    prompt?: string;
+    prompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     /**
      * The sampling temperature, between 0 and 1.
      * @default 0
      */
-    temperature?: number;
+    temperature: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodNumber>>>;
     /**
      * 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">>>>;
+    timestampGranularities: z.ZodOptional<z.ZodNullable<z.ZodDefault<z.ZodArray<z.ZodEnum<["word", "segment"]>, "many">>>>;
 }, "strip", z.ZodTypeAny, {
-    temperature: number | null;
-    timestampGranularities: ("word" | "segment")[] | null;
     prompt?: string | null | undefined;
+    temperature?: number | null | undefined;
     include?: string[] | null | undefined;
     language?: string | null | undefined;
+    timestampGranularities?: ("word" | "segment")[] | null | undefined;
 }, {
     prompt?: string | null | undefined;
     temperature?: number | null | undefined;
@@ -284,9 +266,11 @@ declare const openAIProviderOptionsSchema: z.ZodObject<{
     language?: string | null | undefined;
     timestampGranularities?: ("word" | "segment")[] | null | undefined;
 }>;
+type OpenAITranscriptionProviderOptions = z.infer<typeof openAITranscriptionProviderOptions>;
+
 type OpenAITranscriptionCallOptions = Omit<TranscriptionModelV1CallOptions, 'providerOptions'> & {
     providerOptions?: {
-        openai?: z.infer<typeof openAIProviderOptionsSchema>;
+        openai?: OpenAITranscriptionProviderOptions;
     };
 };
 interface OpenAITranscriptionModelConfig extends OpenAIConfig {
@@ -339,7 +323,7 @@ declare class OpenAIResponsesLanguageModel implements LanguageModelV2 {
     readonly modelId: OpenAIResponsesModelId;
     private readonly config;
     constructor(modelId: OpenAIResponsesModelId, config: OpenAIConfig);
-    getSupportedUrls(): Promise<Record<string, RegExp[]>>;
+    readonly supportedUrls: Record<string, RegExp[]>;
     get provider(): string;
     private getArgs;
     doGenerate(options: Parameters<LanguageModelV2['doGenerate']>[0]): Promise<Awaited<ReturnType<LanguageModelV2['doGenerate']>>>;
@@ -378,4 +362,4 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
 }>;
 type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
 
-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 };
+export { OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, type OpenAICompletionProviderOptions, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingProviderOptions, OpenAIImageModel, type OpenAIImageModelId, type OpenAIImageSettings, type OpenAIProviderOptions, OpenAIResponsesLanguageModel, type OpenAIResponsesProviderOptions, type OpenAISpeechCallOptions, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionProviderOptions, hasDefaultResponseFormat, modelMaxImagesPerCall, openAITranscriptionProviderOptions, openaiCompletionProviderOptions, openaiEmbeddingProviderOptions, openaiProviderOptions };