Normalize *ProviderOptions type names and export from all packages #12269
Description
Metadata
Metadata
Assignees
Labels
related to a provider package. Must be assigned together with at least one `provider/*` labelCI, internal documentation, automations, etcIssues related to the @ai-sdk/amazon-bedrock providerIssues related to the @ai-sdk/anthropic providerIssues related to the @ai-sdk/assemblyai providerIssues related to the @ai-sdk/azure providerIssues related to the @ai-sdk/cohere providerAdmins only: assign to issues with sub tasks
Type
Fields
Give feedbackNo fields configured for issues without a type.
This will touch a lot of files so we want to get it done before starting the v7 beta release
*ModelOptionstypesexamples/ai-functions, READMEs, and docs to use the types via} satisfies *ModelOptionswhere providerOptions are usedWe don't want a
*ProviderOptionssuffix in preparation of renamingproviderOptionsto just options. For*LanguageModelOptionswe need to distinguish between*ChatLanguageModelOptionsand*ResponsesLanguageModelOptions. The list below is based of #8208 (future work section) so it's a bit outdated, but we can use it as a starting point.Language Model Provider Options
High Priority (Already have providerOptions schemas)
@ai-sdk/openai- Export OpenAILanguageModelOptions (from openaiProviderOptions schema) - feat(provider/openai):OpenAILanguageModelOptionstype #8212@ai-sdk/openai- Export OpenAIResponsesLanguageModelOptions (from openaiResponsesProviderOptionsSchema schema)@ai-sdk/google- Export GoogleLanguageModelOptions (from googleGenerativeAIProviderOptions schema)@ai-sdk/anthropic- Export AnthropicLanguageModelOptions (from anthropicProviderOptions schema)@ai-sdk/openai-compatible- Export OpenAICompatibleLanguageModelOptions (provider options schema exists)@ai-sdk/amazon-bedrock- Export BedrockLanguageModelOptions (provider options schema exists)@ai-sdk/groq- Export GroqLanguageModelOptions (provider options schema exists)@ai-sdk/xai- Export XaiLanguageModelOptions (provider options schema exists)Medium Priority (Need investigation for language model support)
@ai-sdk/cohere- Export CohereLanguageModelOptions (investigate if language models support providerOptions)@ai-sdk/perplexity- Export PerplexityLanguageModelOptions@ai-sdk/fireworks- Export FireworksLanguageModelOptions@ai-sdk/deepinfra- Export DeepInfraLanguageModelOptions@ai-sdk/togetherai- Export TogetherAILanguageModelOptions@ai-sdk/cerebras- Export CerebrasLanguageModelOptions@ai-sdk/deepseek- Export DeepSeekLanguageModelOptions@ai-sdk/google-vertex- Export GoogleVertexLanguageModelOptions@ai-sdk/replicate- Export ReplicateLanguageModelOptions@ai-sdk/azure- Export AzureLanguageModelOptions@ai-sdk/luma- Export LumaLanguageModelOptionsEmbedding Model Provider Options
High Priority (Already have providerOptions schemas)
@ai-sdk/openai- Export OpenAIEmbeddingModelOptions (has dimensions, user options)@ai-sdk/amazon-bedrock- Export BedrockEmbeddingModelOptions (has dimensions, normalize options)@ai-sdk/google- Export GoogleEmbeddingModelOptions (investigate embedding model providerOptions)@ai-sdk/google-vertex- Export GoogleVertexEmbeddingModelOptionsMedium Priority (Need investigation)
@ai-sdk/cohere- Export CohereEmbeddingModelOptions@ai-sdk/mistral- Export MistralEmbeddingModelOptions@ai-sdk/openai-compatible- Export OpenAICompatibleEmbeddingModelOptions@ai-sdk/togetherai- Export TogetherAIEmbeddingModelOptions@ai-sdk/deepinfra- Export DeepInfraEmbeddingModelOptionsSpeech Model Provider Options
High Priority (Already have providerOptions schemas)
@ai-sdk/elevenlabs- Export ElevenLabsSpeechModelOptions (from ElevenLabsProviderOptionsSchema)@ai-sdk/openai- Export OpenAISpeechModelOptions (has instructions, response_format options)@ai-sdk/fal- Export FalSpeechModelOptions (from falSpeechProviderOptionsSchema)@ai-sdk/lmnt- Export LMNTSpeechModelOptions (from lmntSpeechCallOptionsSchema)@ai-sdk/hume- Export HumeSpeechModelOptionsTranscription Model Provider Options
High Priority (Already have providerOptions schemas)
@ai-sdk/openai- Export OpenAITranscriptionModelOptions (has language, temperature, include options)@ai-sdk/groq- Export GroqTranscriptionModelOptions (from provider options schema)@ai-sdk/fal- Export FalTranscriptionModelOptions (from falProviderOptionsSchema)@ai-sdk/revai- Export RevaiTranscriptionModelOptions (from revaiProviderOptionsSchema)@ai-sdk/assemblyai- Export AssemblyAITranscriptionModelOptions (from assemblyaiProviderOptionsSchema)@ai-sdk/elevenlabs- Export ElevenLabsTranscriptionModelOptionsMedium Priority (Need investigation)
@ai-sdk/deepgram- Export DeepgramTranscriptionModelOptions@ai-sdk/gladia- Export GladiaTranscriptionModelOptions@ai-sdk/azure- Export AzureTranscriptionModelOptionsImage Model Provider Options
High Priority (Already have providerOptions schemas)
@ai-sdk/google- Export GoogleImageModelOptions (from googleImageProviderOptionsSchema)@ai-sdk/google-vertex- Export GoogleVertexImageModelOptionsMedium Priority (Need investigation)
@ai-sdk/openai- Export OpenAIImageModelOptions@ai-sdk/deepinfra- Export DeepInfraImageModelOptions (mentioned in docs)@ai-sdk/luma- Export LumaImageModelOptions@ai-sdk/replicate- Export ReplicateImageModelOptions@ai-sdk/fal- Export FalImageModelOptions@ai-sdk/togetherai- Export TogetherAIImageModelOptions@ai-sdk/xai- Export XaiImageModelOptions