customProvider()

With a custom provider, you can map ids to any model. This allows you to set up custom model configurations, alias names, and more. The custom provider also supports a fallback provider, which is useful for wrapping existing providers and adding additional functionality.

Example: custom model settings

You can create a custom provider using customProvider.

import { openai } from '@ai-sdk/openai';
import { customProvider } from 'ai';


// custom provider with different model settings:
export const myOpenAI = customProvider({
  languageModels: {
    // replacement model with custom settings:
    'gpt-4': openai('gpt-4', { structuredOutputs: true }),
    // alias model with custom settings:
    'gpt-4o-structured': openai('gpt-4o', { structuredOutputs: true }),
  },
  fallbackProvider: openai,
});

Import 

import {  customProvider } from "ai"

API Signature

Parameters

languageModels?:

Record<string, LanguageModel>

textEmbeddingModels?:

Record<string, EmbeddingModelV1<string>>

imageModels?:

Record<string, ImageModelV1>

fallbackProvider?:

Provider

Returns

The customProvider function returns a Provider instance. It has the following methods:

languageModel:

(id: string) => LanguageModel

textEmbeddingModel:

(id: string) => EmbeddingModel<string>

imageModel:

(id: string) => ImageModel