@ai-sdk/openai 3.0.54 → 3.0.57

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 (52) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/dist/index.d.mts +28 -1
  3. package/dist/index.d.ts +28 -1
  4. package/dist/index.js +1204 -1122
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +1176 -1063
  7. package/dist/index.mjs.map +1 -1
  8. package/dist/internal/index.d.mts +28 -1
  9. package/dist/internal/index.d.ts +28 -1
  10. package/dist/internal/index.js +1203 -1115
  11. package/dist/internal/index.js.map +1 -1
  12. package/dist/internal/index.mjs +1177 -1061
  13. package/dist/internal/index.mjs.map +1 -1
  14. package/docs/03-openai.mdx +12 -3
  15. package/package.json +4 -4
  16. package/src/chat/convert-openai-chat-usage.ts +1 -1
  17. package/src/chat/convert-to-openai-chat-messages.ts +3 -3
  18. package/src/chat/map-openai-finish-reason.ts +1 -1
  19. package/src/chat/openai-chat-api.ts +6 -2
  20. package/src/chat/openai-chat-language-model.ts +14 -14
  21. package/src/chat/openai-chat-options.ts +5 -1
  22. package/src/chat/openai-chat-prepare-tools.ts +3 -3
  23. package/src/completion/convert-openai-completion-usage.ts +1 -1
  24. package/src/completion/convert-to-openai-completion-prompt.ts +1 -1
  25. package/src/completion/map-openai-finish-reason.ts +1 -1
  26. package/src/completion/openai-completion-api.ts +5 -1
  27. package/src/completion/openai-completion-language-model.ts +6 -6
  28. package/src/completion/openai-completion-options.ts +5 -1
  29. package/src/embedding/openai-embedding-model.ts +3 -3
  30. package/src/embedding/openai-embedding-options.ts +5 -1
  31. package/src/image/openai-image-model-options.ts +123 -0
  32. package/src/image/openai-image-model.ts +43 -80
  33. package/src/index.ts +5 -0
  34. package/src/internal/index.ts +1 -1
  35. package/src/openai-config.ts +1 -1
  36. package/src/openai-provider.ts +9 -9
  37. package/src/responses/convert-openai-responses-usage.ts +1 -1
  38. package/src/responses/convert-to-openai-responses-input.ts +5 -5
  39. package/src/responses/map-openai-responses-finish-reason.ts +1 -1
  40. package/src/responses/openai-responses-api.ts +6 -2
  41. package/src/responses/openai-responses-language-model.ts +35 -35
  42. package/src/responses/openai-responses-options.ts +5 -1
  43. package/src/responses/openai-responses-prepare-tools.ts +4 -4
  44. package/src/responses/openai-responses-provider-metadata.ts +2 -2
  45. package/src/speech/openai-speech-model.ts +4 -4
  46. package/src/speech/openai-speech-options.ts +5 -1
  47. package/src/tool/file-search.ts +1 -1
  48. package/src/tool/mcp.ts +1 -1
  49. package/src/tool/tool-search.ts +2 -2
  50. package/src/transcription/openai-transcription-model.ts +4 -4
  51. package/src/transcription/openai-transcription-options.ts +5 -1
  52. package/src/image/openai-image-options.ts +0 -34
@@ -120,6 +120,33 @@ declare class OpenAIEmbeddingModel implements EmbeddingModelV3 {
120
120
  type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-1.5' | 'gpt-image-2' | 'chatgpt-image-latest' | (string & {});
121
121
  declare const modelMaxImagesPerCall: Record<OpenAIImageModelId, number>;
122
122
  declare function hasDefaultResponseFormat(modelId: string): boolean;
123
+ declare const openaiImageModelOptions: _ai_sdk_provider_utils.LazySchema<{
124
+ quality?: "auto" | "low" | "medium" | "high" | "standard" | "hd" | undefined;
125
+ background?: "auto" | "transparent" | "opaque" | undefined;
126
+ outputFormat?: "png" | "jpeg" | "webp" | undefined;
127
+ outputCompression?: number | undefined;
128
+ user?: string | undefined;
129
+ }>;
130
+ type OpenAIImageModelOptions = InferSchema<typeof openaiImageModelOptions>;
131
+ declare const openaiImageModelGenerationOptions: _ai_sdk_provider_utils.LazySchema<{
132
+ quality?: "auto" | "low" | "medium" | "high" | "standard" | "hd" | undefined;
133
+ background?: "auto" | "transparent" | "opaque" | undefined;
134
+ outputFormat?: "png" | "jpeg" | "webp" | undefined;
135
+ outputCompression?: number | undefined;
136
+ user?: string | undefined;
137
+ style?: "vivid" | "natural" | undefined;
138
+ moderation?: "auto" | "low" | undefined;
139
+ }>;
140
+ type OpenAIImageModelGenerationOptions = InferSchema<typeof openaiImageModelGenerationOptions>;
141
+ declare const openaiImageModelEditOptions: _ai_sdk_provider_utils.LazySchema<{
142
+ quality?: "auto" | "low" | "medium" | "high" | "standard" | "hd" | undefined;
143
+ background?: "auto" | "transparent" | "opaque" | undefined;
144
+ outputFormat?: "png" | "jpeg" | "webp" | undefined;
145
+ outputCompression?: number | undefined;
146
+ user?: string | undefined;
147
+ inputFidelity?: "low" | "high" | undefined;
148
+ }>;
149
+ type OpenAIImageModelEditOptions = InferSchema<typeof openaiImageModelEditOptions>;
123
150
 
124
151
  interface OpenAIImageModelConfig extends OpenAIConfig {
125
152
  _internal?: {
@@ -1184,4 +1211,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderToolFactoryWithOu
1184
1211
  };
1185
1212
  }>;
1186
1213
 
1187
- export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelId, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };
1214
+ export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiImageModelEditOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };
@@ -120,6 +120,33 @@ declare class OpenAIEmbeddingModel implements EmbeddingModelV3 {
120
120
  type OpenAIImageModelId = 'dall-e-3' | 'dall-e-2' | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-1.5' | 'gpt-image-2' | 'chatgpt-image-latest' | (string & {});
121
121
  declare const modelMaxImagesPerCall: Record<OpenAIImageModelId, number>;
122
122
  declare function hasDefaultResponseFormat(modelId: string): boolean;
123
+ declare const openaiImageModelOptions: _ai_sdk_provider_utils.LazySchema<{
124
+ quality?: "auto" | "low" | "medium" | "high" | "standard" | "hd" | undefined;
125
+ background?: "auto" | "transparent" | "opaque" | undefined;
126
+ outputFormat?: "png" | "jpeg" | "webp" | undefined;
127
+ outputCompression?: number | undefined;
128
+ user?: string | undefined;
129
+ }>;
130
+ type OpenAIImageModelOptions = InferSchema<typeof openaiImageModelOptions>;
131
+ declare const openaiImageModelGenerationOptions: _ai_sdk_provider_utils.LazySchema<{
132
+ quality?: "auto" | "low" | "medium" | "high" | "standard" | "hd" | undefined;
133
+ background?: "auto" | "transparent" | "opaque" | undefined;
134
+ outputFormat?: "png" | "jpeg" | "webp" | undefined;
135
+ outputCompression?: number | undefined;
136
+ user?: string | undefined;
137
+ style?: "vivid" | "natural" | undefined;
138
+ moderation?: "auto" | "low" | undefined;
139
+ }>;
140
+ type OpenAIImageModelGenerationOptions = InferSchema<typeof openaiImageModelGenerationOptions>;
141
+ declare const openaiImageModelEditOptions: _ai_sdk_provider_utils.LazySchema<{
142
+ quality?: "auto" | "low" | "medium" | "high" | "standard" | "hd" | undefined;
143
+ background?: "auto" | "transparent" | "opaque" | undefined;
144
+ outputFormat?: "png" | "jpeg" | "webp" | undefined;
145
+ outputCompression?: number | undefined;
146
+ user?: string | undefined;
147
+ inputFidelity?: "low" | "high" | undefined;
148
+ }>;
149
+ type OpenAIImageModelEditOptions = InferSchema<typeof openaiImageModelEditOptions>;
123
150
 
124
151
  interface OpenAIImageModelConfig extends OpenAIConfig {
125
152
  _internal?: {
@@ -1184,4 +1211,4 @@ declare const webSearchPreview: _ai_sdk_provider_utils.ProviderToolFactoryWithOu
1184
1211
  };
1185
1212
  }>;
1186
1213
 
1187
- export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelId, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };
1214
+ export { type ApplyPatchOperation, OpenAIChatLanguageModel, type OpenAIChatModelId, OpenAICompletionLanguageModel, type OpenAICompletionModelId, OpenAIEmbeddingModel, type OpenAIEmbeddingModelId, type OpenAIEmbeddingModelOptions, OpenAIImageModel, type OpenAIImageModelEditOptions, type OpenAIImageModelGenerationOptions, type OpenAIImageModelId, type OpenAIImageModelOptions, type OpenAILanguageModelChatOptions, type OpenAILanguageModelCompletionOptions, OpenAIResponsesLanguageModel, OpenAISpeechModel, type OpenAISpeechModelId, type OpenAISpeechModelOptions, type OpenAITranscriptionCallOptions, OpenAITranscriptionModel, type OpenAITranscriptionModelId, type OpenAITranscriptionModelOptions, type OpenaiResponsesProviderMetadata, type OpenaiResponsesReasoningProviderMetadata, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, type ResponsesProviderMetadata, type ResponsesReasoningProviderMetadata, type ResponsesSourceDocumentProviderMetadata, type ResponsesTextProviderMetadata, applyPatch, applyPatchArgsSchema, applyPatchInputSchema, applyPatchOutputSchema, applyPatchToolFactory, codeInterpreter, codeInterpreterArgsSchema, codeInterpreterInputSchema, codeInterpreterOutputSchema, codeInterpreterToolFactory, fileSearch, fileSearchArgsSchema, fileSearchOutputSchema, hasDefaultResponseFormat, imageGeneration, imageGenerationArgsSchema, imageGenerationOutputSchema, modelMaxImagesPerCall, openAITranscriptionModelOptions, openaiEmbeddingModelOptions, openaiImageModelEditOptions, openaiImageModelGenerationOptions, openaiImageModelOptions, openaiLanguageModelChatOptions, openaiLanguageModelCompletionOptions, openaiSpeechModelOptionsSchema, webSearchPreview, webSearchPreviewArgsSchema, webSearchPreviewInputSchema };