Skip to content

docs: add model mappings to BYOK provider options#14310

Draft
R-Taneja wants to merge 1 commit intomainfrom
rohan/byok-model-mappings-docs
Draft

docs: add model mappings to BYOK provider options#14310
R-Taneja wants to merge 1 commit intomainfrom
rohan/byok-model-mappings-docs

Conversation

@R-Taneja
Copy link
Copy Markdown
Contributor

Summary

Add modelMappings documentation to the byok JSDoc in gateway-provider-options.ts.

Model mappings allow BYOK credentials to include custom deployment name mappings (e.g., for Azure deployments with non-default names). Each credential in the byok record can optionally include a modelMappings array.

Example

byok: {
  azure: [{
    apiKey: '...',
    resourceName: '...',
    modelMappings: [
      { gatewayModelSlug: 'openai/gpt-5.4-nano', customModelId: 'my-deployment' }
    ]
  }]
}

@tigent tigent bot added ai/provider related to a provider package. Must be assigned together with at least one `provider/*` label documentation Improvements or additions to documentation provider/gateway Issues related to the @ai-sdk/gateway provider labels Apr 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai/provider related to a provider package. Must be assigned together with at least one `provider/*` label documentation Improvements or additions to documentation provider/gateway Issues related to the @ai-sdk/gateway provider

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant