@ai-sdk/openai 3.0.136 → 3.0.138

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/dist/index.d.mts +23 -2
  3. package/dist/index.d.ts +23 -2
  4. package/dist/index.js +290 -85
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +276 -69
  7. package/dist/index.mjs.map +1 -1
  8. package/dist/internal/index.d.mts +23 -2
  9. package/dist/internal/index.d.ts +23 -2
  10. package/dist/internal/index.js +289 -84
  11. package/dist/internal/index.js.map +1 -1
  12. package/dist/internal/index.mjs +275 -68
  13. package/dist/internal/index.mjs.map +1 -1
  14. package/docs/03-openai.mdx +92 -0
  15. package/package.json +3 -3
  16. package/src/chat/map-openai-finish-reason.ts +11 -4
  17. package/src/chat/openai-chat-api.ts +36 -0
  18. package/src/chat/openai-chat-language-model.ts +101 -12
  19. package/src/image/openai-image-model-options.ts +44 -0
  20. package/src/image/openai-image-model.ts +44 -4
  21. package/src/responses/map-openai-responses-finish-reason.ts +7 -1
  22. package/src/responses/openai-responses-api.ts +71 -48
  23. package/src/responses/openai-responses-language-model.ts +47 -0
package/dist/internal/index.d.mts CHANGED
@@ -127,7 +127,7 @@ declare class OpenAIEmbeddingModel implements EmbeddingModelV3 {
127
127
  doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV3['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV3['doEmbed']>>>;
128
128
  }
129
129
 
130
- type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-1.5' | 'gpt-image-2' | 'gpt-image-2.5-flare' | 'gpt-image-2.5-flare-2026-09-08' | 'gpt-image-2.5-sunburst' | 'gpt-image-2.5-sunburst-2026-09-08' | 'chatgpt-image-latest' | (string & {});
130
+ type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-1.5' | 'gpt-image-2' | 'gpt-image-2.6-flare' | 'gpt-image-2.6-sunburst' | 'gpt-image-2.5-flare' | 'gpt-image-2.5-flare-2026-09-08' | 'gpt-image-2.5-sunburst' | 'gpt-image-2.5-sunburst-2026-09-08' | 'chatgpt-image-latest' | (string & {});
131
131
  declare const modelMaxImagesPerCall: Record<OpenAIImageModelId, number>;
132
132
  declare function hasDefaultResponseFormat(modelId: string): boolean;
133
133
  declare function getMaxImagesPerCall(modelId: OpenAIImageModelId): number;
@@ -135,17 +135,23 @@ declare const openaiImageModelOptions: _ai_sdk_provider_utils.LazySchema<{
135
135
  quality?: "low" | "medium" | "high" | "xhigh" | "max" | "auto" | "standard" | "hd" | undefined;
136
136
  background?: "auto" | "transparent" | "opaque" | undefined;
137
137
  outputFormat?: "png" | "jpeg" | "webp" | undefined;
138
+ complexity?: "low" | "medium" | "high" | undefined;
138
139
  outputCompression?: number | undefined;
139
140
  user?: string | undefined;
141
+ safetyIdentifier?: string | undefined;
140
142
  }>;
141
143
  type OpenAIImageModelOptions = InferSchema<typeof openaiImageModelOptions>;
142
144
  declare const openaiImageModelGenerationOptions: _ai_sdk_provider_utils.LazySchema<{
143
145
  quality?: "low" | "medium" | "high" | "xhigh" | "max" | "auto" | "standard" | "hd" | undefined;
144
146
  background?: "auto" | "transparent" | "opaque" | undefined;
145
- outputFormat?: "png" | "jpeg" | "webp" | undefined;
147
+ complexity?: "low" | "medium" | "high" | undefined;
146
148
  outputCompression?: number | undefined;
147
149
  user?: string | undefined;
150
+ safetyIdentifier?: string | undefined;
148
151
  style?: "vivid" | "natural" | undefined;
152
+ outputFormat?: "png" | "jpeg" | "webp" | "gif" | undefined;
153
+ frameCount?: number | undefined;
154
+ frameDurationMs?: number | undefined;
149
155
  moderation?: "low" | "auto" | undefined;
150
156
  }>;
151
157
  type OpenAIImageModelGenerationOptions = InferSchema<typeof openaiImageModelGenerationOptions>;
@@ -153,9 +159,12 @@ declare const openaiImageModelEditOptions: _ai_sdk_provider_utils.LazySchema<{
153
159
  quality?: "low" | "medium" | "high" | "xhigh" | "max" | "auto" | "standard" | "hd" | undefined;
154
160
  background?: "auto" | "transparent" | "opaque" | undefined;
155
161
  outputFormat?: "png" | "jpeg" | "webp" | undefined;
162
+ complexity?: "low" | "medium" | "high" | undefined;
156
163
  outputCompression?: number | undefined;
157
164
  user?: string | undefined;
165
+ safetyIdentifier?: string | undefined;
158
166
  inputFidelity?: "low" | "high" | undefined;
167
+ markup?: string | undefined;
159
168
  }>;
160
169
  type OpenAIImageModelEditOptions = InferSchema<typeof openaiImageModelEditOptions>;
161
170
 
@@ -475,6 +484,18 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
475
484
  logprob: number;
476
485
  }[];
477
486
  }[] | null | undefined;
487
+ } | {
488
+ type: "response.refusal.delta";
489
+ item_id: string;
490
+ delta: string;
491
+ output_index?: number | null | undefined;
492
+ content_index?: number | null | undefined;
493
+ } | {
494
+ type: "response.refusal.done";
495
+ item_id: string;
496
+ refusal: string;
497
+ output_index?: number | null | undefined;
498
+ content_index?: number | null | undefined;
478
499
  } | {
479
500
  type: "response.completed" | "response.incomplete";
480
501
  response: {
package/dist/internal/index.d.ts CHANGED
@@ -127,7 +127,7 @@ declare class OpenAIEmbeddingModel implements EmbeddingModelV3 {
127
127
  doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV3['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV3['doEmbed']>>>;
128
128
  }
129
129
 
130
- type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-1.5' | 'gpt-image-2' | 'gpt-image-2.5-flare' | 'gpt-image-2.5-flare-2026-09-08' | 'gpt-image-2.5-sunburst' | 'gpt-image-2.5-sunburst-2026-09-08' | 'chatgpt-image-latest' | (string & {});
130
+ type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-1.5' | 'gpt-image-2' | 'gpt-image-2.6-flare' | 'gpt-image-2.6-sunburst' | 'gpt-image-2.5-flare' | 'gpt-image-2.5-flare-2026-09-08' | 'gpt-image-2.5-sunburst' | 'gpt-image-2.5-sunburst-2026-09-08' | 'chatgpt-image-latest' | (string & {});
131
131
  declare const modelMaxImagesPerCall: Record<OpenAIImageModelId, number>;
132
132
  declare function hasDefaultResponseFormat(modelId: string): boolean;
133
133
  declare function getMaxImagesPerCall(modelId: OpenAIImageModelId): number;
@@ -135,17 +135,23 @@ declare const openaiImageModelOptions: _ai_sdk_provider_utils.LazySchema<{
135
135
  quality?: "low" | "medium" | "high" | "xhigh" | "max" | "auto" | "standard" | "hd" | undefined;
136
136
  background?: "auto" | "transparent" | "opaque" | undefined;
137
137
  outputFormat?: "png" | "jpeg" | "webp" | undefined;
138
+ complexity?: "low" | "medium" | "high" | undefined;
138
139
  outputCompression?: number | undefined;
139
140
  user?: string | undefined;
141
+ safetyIdentifier?: string | undefined;
140
142
  }>;
141
143
  type OpenAIImageModelOptions = InferSchema<typeof openaiImageModelOptions>;
142
144
  declare const openaiImageModelGenerationOptions: _ai_sdk_provider_utils.LazySchema<{
143
145
  quality?: "low" | "medium" | "high" | "xhigh" | "max" | "auto" | "standard" | "hd" | undefined;
144
146
  background?: "auto" | "transparent" | "opaque" | undefined;
145
- outputFormat?: "png" | "jpeg" | "webp" | undefined;
147
+ complexity?: "low" | "medium" | "high" | undefined;
146
148
  outputCompression?: number | undefined;
147
149
  user?: string | undefined;
150
+ safetyIdentifier?: string | undefined;
148
151
  style?: "vivid" | "natural" | undefined;
152
+ outputFormat?: "png" | "jpeg" | "webp" | "gif" | undefined;
153
+ frameCount?: number | undefined;
154
+ frameDurationMs?: number | undefined;
149
155
  moderation?: "low" | "auto" | undefined;
150
156
  }>;
151
157
  type OpenAIImageModelGenerationOptions = InferSchema<typeof openaiImageModelGenerationOptions>;
@@ -153,9 +159,12 @@ declare const openaiImageModelEditOptions: _ai_sdk_provider_utils.LazySchema<{
153
159
  quality?: "low" | "medium" | "high" | "xhigh" | "max" | "auto" | "standard" | "hd" | undefined;
154
160
  background?: "auto" | "transparent" | "opaque" | undefined;
155
161
  outputFormat?: "png" | "jpeg" | "webp" | undefined;
162
+ complexity?: "low" | "medium" | "high" | undefined;
156
163
  outputCompression?: number | undefined;
157
164
  user?: string | undefined;
165
+ safetyIdentifier?: string | undefined;
158
166
  inputFidelity?: "low" | "high" | undefined;
167
+ markup?: string | undefined;
159
168
  }>;
160
169
  type OpenAIImageModelEditOptions = InferSchema<typeof openaiImageModelEditOptions>;
161
170
 
@@ -475,6 +484,18 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
475
484
  logprob: number;
476
485
  }[];
477
486
  }[] | null | undefined;
487
+ } | {
488
+ type: "response.refusal.delta";
489
+ item_id: string;
490
+ delta: string;
491
+ output_index?: number | null | undefined;
492
+ content_index?: number | null | undefined;
493
+ } | {
494
+ type: "response.refusal.done";
495
+ item_id: string;
496
+ refusal: string;
497
+ output_index?: number | null | undefined;
498
+ content_index?: number | null | undefined;
478
499
  } | {
479
500
  type: "response.completed" | "response.incomplete";
480
501
  response: {