Skip to content

LibreChat Configuration Guide

Intro

Welcome to the guide for configuring the librechat.yaml file in LibreChat.

This file enables the integration of custom AI endpoints, enabling you to connect with any AI provider compliant with OpenAI API standards.

This includes providers like Mistral AI , as well as reverse proxies that facilitate access to OpenAI servers, adding them alongside existing endpoints like Anthropic.

image

Future updates will streamline configuration further by migrating some settings from your .env file to librechat.yaml .

Stay tuned for ongoing enhancements to customize your LibreChat instance!

Note: To verify your YAML config, you can use online tools like yamlchecker.com

Note: To verify your YAML config, you can use online tools like yamlchecker.com

Compatible Endpoints

Any API designed to be compatible with OpenAI's should be supported, but here is a list of known compatible endpoints including example setups.

Setup

The librechat.yaml file should be placed in the root of the project where the .env file is located.

You can copy the example config file as a good starting point while reading the rest of the guide.

The example config file has some options ready to go for Mistral AI and Openrouter.

Note: You can set an alternate filepath for the librechat.yaml file through an environment variable: 

CONFIG_PATH="/alternative/path/to/librechat.yaml"

Docker Setup

For Docker, you need to make use of an override file , named docker-compose.override.yml , to ensure the config file works for you.

  • First, make sure your containers stop running with docker compose down
  • Create or edit existing docker-compose.override.yml at the root of the project: 
# For more details on the override file, see the Docker Override Guide:
# https://docs.librechat.ai/install/configuration/docker_override.html

version: '3.4'

services:
  api:
    volumes:
      - ./librechat.yaml:/app/librechat.yaml # local/filepath:container/filepath

  • Note: If you are using CONFIG_PATH for an alternative filepath for this file, make sure to specify it accordingly.

  • Start docker again, and you should see your config file settings apply 

    docker compose up # no need to rebuild

Example Config 

version: 1.0.5
cache: true
# fileStrategy: "firebase"  # If using Firebase CDN
fileConfig:
  endpoints:
    assistants:
      fileLimit: 5
      # Maximum size for an individual file in MB
      fileSizeLimit: 10
      # Maximum total size for all files in a single request in MB
      totalSizeLimit: 50 
      # In case you wish to limit certain filetypes
      # supportedMimeTypes: 
      #   - "image/.*"
      #   - "application/pdf"
    openAI:
    # Disables file uploading to the OpenAI endpoint
      disabled: true
    default:
      totalSizeLimit: 20
    # Example for custom endpoints
    # YourCustomEndpointName:
    #   fileLimit: 2
    #   fileSizeLimit: 5
  # Global server file size limit in MB
  serverFileSizeLimit: 100  
  # Limit for user avatar image size in MB, default: 2 MB
  avatarSizeLimit: 4 
rateLimits:
  fileUploads:
    ipMax: 100
    # Rate limit window for file uploads per IP
    ipWindowInMinutes: 60 
    userMax: 50
    # Rate limit window for file uploads per user
    userWindowInMinutes: 60  
registration:
  socialLogins: ["google", "facebook", "github", "discord", "openid"]
  allowedDomains:
    - "example.com"
    - "anotherdomain.com"
endpoints:
  assistants:
    # Disable Assistants Builder Interface by setting to `true`
    disableBuilder: false 
    # Polling interval for checking assistant updates
    pollIntervalMs: 750  
    # Timeout for assistant operations
    timeoutMs: 180000  
    # Should only be one or the other, either `supportedIds` or `excludedIds`
    supportedIds: ["asst_supportedAssistantId1", "asst_supportedAssistantId2"]
    # excludedIds: ["asst_excludedAssistantId"]
    # (optional) Models that support retrieval, will default to latest known OpenAI models that support the feature
    # retrievalModels: ["gpt-4-turbo-preview"]
    # (optional) Assistant Capabilities available to all users. Omit the ones you wish to exclude. Defaults to list below.
    # capabilities: ["code_interpreter", "retrieval", "actions", "tools", "image_vision"]
  custom:
    - name: "Mistral"
      apiKey: "${MISTRAL_API_KEY}"
      baseURL: "https://api.mistral.ai/v1"
      models:
        default: ["mistral-tiny", "mistral-small", "mistral-medium", "mistral-large-latest"]
        # Attempt to dynamically fetch available models
        fetch: true  
        userIdQuery: false
      iconURL: "https://example.com/mistral-icon.png"
      titleConvo: true
      titleModel: "mistral-tiny"
      modelDisplayLabel: "Mistral AI"
      # addParams:
      # Mistral API specific value for moderating messages
      #   safe_prompt: true 
      dropParams:
        - "stop"
        - "user"
        - "presence_penalty"
        - "frequency_penalty"
      # headers:
      #    x-custom-header: "${CUSTOM_HEADER_VALUE}"
    - name: "OpenRouter"
      apiKey: "${OPENROUTER_API_KEY}"
      baseURL: "https://openrouter.ai/api/v1"
      models:
        default: ["gpt-3.5-turbo"]
        fetch: false
      titleConvo: true
      titleModel: "gpt-3.5-turbo"
      modelDisplayLabel: "OpenRouter"
      dropParams:
        - "stop"
        - "frequency_penalty"

This example configuration file sets up LibreChat with detailed options across several key areas:

  • Caching : Enabled to improve performance.
  • File Handling :
    • File Strategy : Commented out but hints at possible integration with Firebase for file storage.
    • File Configurations : Customizes file upload limits and allowed MIME types for different endpoints, including a global server file size limit and a specific limit for user avatar images.
  • Rate Limiting : Defines thresholds for the maximum number of file uploads allowed per IP and user within a specified time window, aiming to prevent abuse.
  • Registration :
    • Allows registration from specified social login providers and email domains, enhancing security and user management.
  • Endpoints :
    • Assistants : Configures the assistants' endpoint with a polling interval and a timeout for operations, and provides an option to disable the builder interface.
    • Custom Endpoints :
      • Configures two external AI service endpoints, Mistral and OpenRouter, including API keys, base URLs, model handling, and specific feature toggles like conversation titles, summarization, and parameter adjustments.
      • For Mistral, it enables dynamic model fetching, applies additional parameters for safe prompts, and explicitly drops unsupported parameters.
      • For OpenRouter, it sets up a basic configuration without dynamic model fetching and specifies a model for conversation titles.

Config Structure

Note: Fields not specifically mentioned as required are optional.

Version

  • Key : version
  • Type : String
  • Description : Specifies the version of the configuration file.
  • Example : version: 1.0.5
  • Required

Cache Settings

  • Key : cache
  • Type : Boolean
  • Description : Toggles caching on or off. Set to true to enable caching.
  • Example : cache: true

File Strategy

  • Key : fileStrategy
  • Type : String = "local" | "firebase"
  • Description : Determines where to save user uploaded/generated files. Defaults to "local" if omitted.
  • Example : fileStrategy: "firebase"

File Configuration

  • Key : fileConfig
  • Type : Object

  • Description : Configures file handling settings for the application, including size limits and MIME type restrictions.

  • Sub-Key : endpoints

  • Sub-Key : serverFileSizeLimit

    • Type : Number
    • Description : The maximum file size (in MB) that the server will accept. Applies globally across all endpoints unless overridden by endpoint-specific settings.

  • Sub-Key : avatarSizeLimit

    • Type : Number
    • Description : Maximum size (in MB) for user avatar images.

Rate Limiting

  • Key : rateLimits
  • Type : Object
  • Description : Defines rate limiting policies to prevent abuse by limiting the number of requests.
  • Sub-Key : fileUploads
  • Type : Object

  • Description : Configures rate limits specifically for file upload operations.

    • Sub-Key : ipMax
    • Type : Number
    • Description : Maximum number of uploads allowed per IP address per window.
    • Sub-Key : ipWindowInMinutes
    • Type : Number
    • Description : Time window in minutes for the IP-based upload limit.
    • Sub-Key : userMax
    • Type : Number
    • Description : Maximum number of uploads allowed per user per window.
    • Sub-Key : userWindowInMinutes
    • Type : Number
    • Description : Time window in minutes for the user-based upload limit.

  • Example : 

    rateLimits:
  fileUploads:
    ipMax: 100
    ipWindowInMinutes: 60
    userMax: 50
    userWindowInMinutes: 60

Registration

Endpoints

Endpoint File Config Object Structure

Overview

  • disabled : Whether file handling is disabled for the endpoint.
  • fileLimit : The maximum number of files allowed per upload request.
  • fileSizeLimit : The maximum size for a single file. In units of MB (e.g. use 20 for 20 megabytes)
  • totalSizeLimit : The total maximum size for all files in a single request. In units of MB (e.g. use 20 for 20 megabytes)
  • supportedMimeTypes : A list of Regular Expressions specifying what MIME types are allowed for upload. This can be customized to restrict file types.

Notes:

  • At the time of writing, the Assistants endpoint supports filetypes from this list .
  • The OpenAI, Azure OpenAI, Google, and Custom endpoints only suppport images.
  • Any other endpoints not mentioned, like Plugins, do not support file uploads (yet).
  • The Assistants endpoint has a defined endpoint value of assistants . All other endpoints use the defined value default
  • For non-assistants endpoints, you can adjust file settings for all of them under default
  • If you'd like to adjust settings for a specific endpoint, you can list their corresponding endpoint names:
    • assistants (does not use default as it has defined defaults separate from the others.)
    • openAI
    • azureOpenAI
    • google
    • YourCustomEndpointName
  • You can omit values, in which case, the app will use the default values as defined per endpoint type listed below.
  • LibreChat counts 1 megabyte as follows: 1 x 1024 x 1024

Example 

fileConfig:
  endpoints:
    assistants:
      fileLimit: 5
      fileSizeLimit: 10
      totalSizeLimit: 50
      supportedMimeTypes:
        - "image/.*"
        - "application/pdf"
    openAI:
      disabled: true
    default:
      totalSizeLimit: 20
    YourCustomEndpointName:
      fileLimit: 5
      fileSizeLimit: 1000
      supportedMimeTypes:
        - "image/.*"
  serverFileSizeLimit: 1000
  avatarSizeLimit: 2

disabled :

Indicates whether file uploading is disabled for a specific endpoint.

  • Type: Boolean
  • Default: false (i.e., uploading is enabled by default)
  • Example: 
    openAI:
  disabled: true
  • Note : Setting this to true prevents any file uploads to the specified endpoint, overriding any other file-related settings.

fileLimit :

The maximum number of files allowed in a single upload request.

  • Type: Integer
  • Default: Varies by endpoint
  • Example: 
    assistants:
  fileLimit: 5
  • Note : Helps control the volume of uploads and manage server load.

fileSizeLimit :

The maximum size allowed for each individual file, specified in megabytes (MB).

  • Type: Integer
  • Default: Varies by endpoint
  • Example: 
    YourCustomEndpointName:
  fileSizeLimit: 1000
  • Note : This limit ensures that no single file exceeds the specified size, allowing for better resource allocation and management.

totalSizeLimit :

The total maximum size allowed for all files in a single request, specified in megabytes (MB).

  • Type: Integer
  • Default: Varies by endpoint
  • Example: 
    assistants:
  totalSizeLimit: 50
  • Note : This setting is crucial for preventing excessive bandwidth and storage usage by any single upload request.

supportedMimeTypes :

A list of regular expressions defining the MIME types permitted for upload.

  • Type: Array of Strings
  • Default: Varies by endpoint
  • Example: 
    assistants:
  supportedMimeTypes:
    - "image/.*"
    - "application/pdf"
  • Note : This allows for precise control over the types of files that can be uploaded. Invalid regex is ignored.

serverFileSizeLimit :

The global maximum size for any file uploaded to the server, specified in megabytes (MB).

  • Type: Integer
  • Example: 
    fileConfig:
  serverFileSizeLimit: 1000
  • Note : Acts as an overarching limit for file uploads across all endpoints, ensuring that no file exceeds this size server-wide.

avatarSizeLimit :

The maximum size allowed for avatar images, specified in megabytes (MB).

  • Type: Integer
  • Example: 
    fileConfig:
  avatarSizeLimit: 2
  • Note : Specifically tailored for user avatar uploads, allowing for control over image sizes to maintain consistent quality and loading times.

Registration Object Structure 

# Example Registration Object Structure
registration:
  socialLogins: ["google", "facebook", "github", "discord", "openid"]
  allowedDomains:
    - "gmail.com"
    - "protonmail.com"

socialLogins :

Defines the available social login providers and their display order.

  • Type: Array of Strings
  • Example: 
    socialLogins: ["google", "facebook", "github", "discord", "openid"]
  • Note : The order of the providers in the list determines their appearance order on the login/registration page. Each provider listed must be properly configured within the system to be active and available for users. This configuration allows for a tailored authentication experience, emphasizing the most relevant or preferred social login options for your user base.

allowedDomains :

A list specifying allowed email domains for registration.

  • Type: Array of Strings
  • Example: 
    allowedDomains:
  - "gmail.com"
  - "protonmail.com"
  • Required
  • Note : Users with email domains not listed will be restricted from registering.

Given the additional details and correction regarding supportedMimeTypes being a list of regex strings and the omission of the assistantEndpoint configuration, let's revise and add the necessary documentation sections.

Assistants Endpoint Object Structure

Example 

endpoints:
  assistants:
    disableBuilder: false
    pollIntervalMs: 500
    timeoutMs: 10000
    # Use either `supportedIds` or `excludedIds` but not both
    supportedIds: ["asst_supportedAssistantId1", "asst_supportedAssistantId2"]
    # excludedIds: ["asst_excludedAssistantId"]
    # (optional) Models that support retrieval, will default to latest known OpenAI models that support the feature
    # retrievalModels: ["gpt-4-turbo-preview"]
    # (optional) Assistant Capabilities available to all users. Omit the ones you wish to exclude. Defaults to list below.
    # capabilities: ["code_interpreter", "retrieval", "actions", "tools", "image_vision"]

This configuration enables the builder interface for assistants, sets a polling interval of 500ms to check for run updates, and establishes a timeout of 10 seconds for assistant run operations.

In addition to custom endpoints, you can configure settings specific to the assistants endpoint.

disableBuilder :

Controls the visibility and use of the builder interface for assistants.

  • Type : Boolean
  • Example : disableBuilder: false
  • Description : When set to true , disables the builder interface for the assistant, limiting direct manual interaction.
  • Note : Defaults to false if omitted.

pollIntervalMs :

Specifies the polling interval in milliseconds for checking run updates or changes in assistant run states.

  • Type : Integer
  • Example : pollIntervalMs: 500
  • Description : Specifies the polling interval in milliseconds for checking assistant run updates.
  • Note : Defaults to 750 if omitted.

timeoutMs :

Defines the maximum time in milliseconds that an assistant can run before the request is cancelled.

  • Type : Integer
  • Example : timeoutMs: 10000
  • Description : Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time.
  • Note : Defaults to 3 minutes (180,000 ms). Run operation times can range between 50 seconds to 2 minutes but also exceed this. If the timeoutMs value is exceeded, the run will be cancelled.

supportedIds :

List of supported assistant Ids

  • Type: Array/List of Strings
  • Description : List of supported assistant Ids. Use this or excludedIds but not both (the excludedIds field will be ignored if so).
  • Example : supportedIds: ["asst_supportedAssistantId1", "asst_supportedAssistantId2"]

excludedIds :

List of excluded assistant Ids

  • Type: Array/List of Strings
  • Description : List of excluded assistant Ids. Use this or supportedIds but not both (the excludedIds field will be ignored if so).
  • Example : excludedIds: ["asst_excludedAssistantId1", "asst_excludedAssistantId2"]

retrievalModels :

Specifies the models that support retrieval for the assistants endpoint.

  • Type : Array/List of Strings
  • Example : retrievalModels: ["gpt-4-turbo-preview"]
  • Description : Defines the models that support retrieval capabilities for the assistants endpoint. By default, it uses the latest known OpenAI models that support the official Retrieval feature.
  • Note : This field is optional. If omitted, the default behavior is to use the latest known OpenAI models that support retrieval.

capabilities :

Specifies the assistant capabilities available to all users for the assistants endpoint.

  • Type : Array/List of Strings
  • Example : capabilities: ["code_interpreter", "retrieval", "actions", "tools", "image_vision"]
  • Description : Defines the assistant capabilities that are available to all users for the assistants endpoint. You can omit the capabilities you wish to exclude from the list. The available capabilities are:
  • code_interpreter : Enables code interpretation capabilities for the assistant.
  • image_vision : Enables unofficial vision support for uploaded images.
  • retrieval : Enables retrieval capabilities for the assistant.
  • actions : Enables action capabilities for the assistant.
  • tools : Enables tool capabilities for the assistant.
  • Note : This field is optional. If omitted, the default behavior is to include all the capabilities listed in the example.

Custom Endpoint Object Structure

Each endpoint in the custom array should have the following structure:

Example 

# Example Endpoint Object Structure
endpoints:
  custom:
      # Example using Mistral AI API
    - name: "Mistral"
      apiKey: "${YOUR_ENV_VAR_KEY}"
      baseURL: "https://api.mistral.ai/v1"
      models: 
        default: ["mistral-tiny", "mistral-small", "mistral-medium", "mistral-large-latest"]
      titleConvo: true
      titleModel: "mistral-tiny" 
      modelDisplayLabel: "Mistral"
      # addParams:
      #   safe_prompt: true # Mistral specific value for moderating messages
      # NOTE: For Mistral, it is necessary to drop the following parameters or you will encounter a 422 Error:
      dropParams: ["stop", "user", "frequency_penalty", "presence_penalty"]

name :

A unique name for the endpoint.

  • Type: String
  • Example: name: "Mistral"
  • Required
  • Note : Will be used as the "title" in the Endpoints Selector

apiKey :

Your API key for the service. Can reference an environment variable, or allow user to provide the value.

  • Type: String (apiKey | "user_provided" )
  • Example: apiKey: "${MISTRAL_API_KEY}" | apiKey: "your_api_key" | apiKey: "user_provided"
  • Required
  • Note : It's highly recommended to use the env. variable reference for this field, i.e. ${YOUR_VARIABLE}

baseURL :

Base URL for the API. Can reference an environment variable, or allow user to provide the value.

  • Type: String (baseURL | "user_provided" )
  • Example: baseURL: "https://api.mistral.ai/v1" | baseURL: "${MISTRAL_BASE_URL}" | baseURL: "user_provided"
  • Required
  • Note : It's highly recommended to use the env. variable reference for this field, i.e. ${YOUR_VARIABLE}

iconURL :

The URL to use as the Endpoint Icon.

  • Type: Boolean
  • Example: iconURL: https://github.com/danny-avila/LibreChat/raw/main/docs/assets/LibreChat.svg
  • Note : The following are "known endpoints" (case-insensitive), which have icons provided for them. If your endpoint name matches the following names, you should omit this field:
    • "Mistral"
    • "OpenRouter"
    • "Groq"
    • "Anyscale"
    • "Fireworks"
    • "Perplexity"
    • "together.ai"
    • "Ollama"

models :

Configuration for models.

  • Required
  • default : An array of strings indicating the default models to use. At least one value is required.
    • Type: Array of Strings
    • Example: default: ["mistral-tiny", "mistral-small", "mistral-medium"]
    • Note : If fetching models fails, these defaults are used as a fallback.
  • fetch : When set to true , attempts to fetch a list of models from the API.
    • Type: Boolean
    • Example: fetch: true
    • Note : May cause slowdowns during initial use of the app if the response is delayed. Defaults to false .
  • userIdQuery : When set to true , adds the LibreChat user ID as a query parameter to the API models request.
    • Type: Boolean
    • Example: userIdQuery: true

titleConvo :

Enables title conversation when set to true .

  • Type: Boolean
  • Example: titleConvo: true

titleMethod :

Chooses between "completion" or "functions" for title method.

  • Type: String ( "completion" | "functions" )
  • Example: titleMethod: "completion"
  • Note : Defaults to "completion" if omitted.

titleModel :

Specifies the model to use for titles.

  • Type: String
  • Example: titleModel: "mistral-tiny"
  • Note : Defaults to "gpt-3.5-turbo" if omitted. May cause issues if "gpt-3.5-turbo" is not available.

summarize :

Enables summarization when set to true .

  • Type: Boolean
  • Example: summarize: false
  • Note : This feature requires an OpenAI Functions compatible API

summaryModel :

Specifies the model to use if summarization is enabled.

  • Type: String
  • Example: summaryModel: "mistral-tiny"
  • Note : Defaults to "gpt-3.5-turbo" if omitted. May cause issues if "gpt-3.5-turbo" is not available.

forcePrompt :

If true , sends a prompt parameter instead of messages .

  • Type: Boolean
  • Example: forcePrompt: false
  • Note : This combines all messages into a single text payload, following OpenAI format , and

uses the /completions endpoint of your baseURL rather than /chat/completions .

modelDisplayLabel :

The label displayed in messages next to the Icon for the current AI model.

  • Type: String
  • Example: modelDisplayLabel: "Mistral"
  • Note : The display order is:
      1. Custom name set via preset (if available)
      1. Label derived from the model name (if applicable)
      1. This value, modelDisplayLabel , is used if the above are not specified. Defaults to "AI".

addParams :

Adds additional parameters to requests.

  • Type: Object/Dictionary
  • Description : Adds/Overrides parameters. Useful for specifying API-specific options.
  • Example : 
        addParams:
      safe_prompt: true

dropParams :

Removes default parameters from requests.

  • Type: Array/List of Strings
  • Description : Excludes specified default parameters . Useful for APIs that do not accept or recognize certain parameters.
  • Example : dropParams: ["stop", "user", "frequency_penalty", "presence_penalty"]
  • Note : For a list of default parameters sent with every request, see the "Default Parameters" Section below.

headers :

Adds additional headers to requests. Can reference an environment variable

  • Type: Object/Dictionary
  • Description : The headers object specifies custom headers for requests. Useful for authentication and setting content types.
  • Example :
  • Note : Supports dynamic environment variable values, which use the format: "${VARIABLE_NAME}" 
        headers:
      x-api-key: "${ENVIRONMENT_VARIABLE}"
      Content-Type: "application/json"

Additional Notes

  • Ensure that all URLs and keys are correctly specified to avoid connectivity issues.

Default Parameters

Custom endpoints share logic with the OpenAI endpoint, and thus have default parameters tailored to the OpenAI API. 

{
  "model": "your-selected-model",
  "temperature": 1,
  "top_p": 1,
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "stop": [
    "||>",
    "\nUser:",
    "<|diff_marker|>",
  ],
  "user": "LibreChat_User_ID",
  "stream": true,
  "messages": [
    {
      "role": "user",
      "content": "hi how are you",
    },
  ],
}

Breakdown of Default Params

  • model : The selected model from list of models.
  • temperature : Defaults to 1 if not provided via preset,
  • top_p : Defaults to 1 if not provided via preset,
  • presence_penalty : Defaults to 0 if not provided via preset,
  • frequency_penalty : Defaults to 0 if not provided via preset,
  • stop : Sequences where the AI will stop generating further tokens. By default, uses the start token ( ||> ), the user label ( \nUser: ), and end token ( <|diff_marker|> ). Up to 4 sequences can be provided to the OpenAI API
  • user : A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse .
  • stream : If set, partial message deltas will be sent, like in ChatGPT. Otherwise, generation will only be available when completed.
  • messages : OpenAI format for messages ; the name field is added to messages with system and assistant roles when a custom name is specified via preset.

Note: The max_tokens field is not sent to use the maximum amount of tokens available, which is default OpenAI API behavior. Some alternate APIs require this field, or it may default to a very low value and your responses may appear cut off; in this case, you should add it to addParams field as shown in the Endpoint Object Structure .

Azure OpenAI Object Structure

Integrating Azure OpenAI Service with your application allows you to seamlessly utilize multiple deployments and region models hosted by Azure OpenAI. This section details how to configure the Azure OpenAI endpoint for your needs.

For a detailed guide on setting up Azure OpenAI configurations, click here

Example Configuration 

# Example Azure OpenAI Object Structure
endpoints:
  azureOpenAI:
    titleModel: "gpt-4-turbo"
    plugins: true
    groups:
      - group: "my-westus" # arbitrary name
        apiKey: "${WESTUS_API_KEY}"
        instanceName: "actual-instance-name" # name of the resource group or instance
        version: "2023-12-01-preview"
        # baseURL: https://prod.example.com
        # additionalHeaders:
        #   X-Custom-Header: value
        models:
          gpt-4-vision-preview:
            deploymentName: gpt-4-vision-preview
            version: "2024-02-15-preview"
          gpt-3.5-turbo:
            deploymentName: gpt-35-turbo
          gpt-3.5-turbo-1106:
            deploymentName: gpt-35-turbo-1106
          gpt-4:
            deploymentName: gpt-4
          gpt-4-1106-preview:
            deploymentName: gpt-4-1106-preview
      - group: "my-eastus"
        apiKey: "${EASTUS_API_KEY}"
        instanceName: "actual-eastus-instance-name"
        deploymentName: gpt-4-turbo
        version: "2024-02-15-preview"
        baseURL: "https://gateway.ai.cloudflare.com/v1/cloudflareId/azure/azure-openai/${INSTANCE_NAME}/${DEPLOYMENT_NAME}" # uses env variables
        additionalHeaders:
          X-Custom-Header: value
        models:
          gpt-4-turbo: true

groups :

Configuration for groups of models by geographic location or purpose.

  • Type: Array
  • Description : Each item in the groups array configures a set of models under a certain grouping, often by geographic region or distinct configuration.
  • Example : See above.

plugins :

Enables or disables plugins for the Azure OpenAI endpoint.

  • Type: Boolean
  • Example : plugins: true
  • Description : When set to true , activates plugins associated with this endpoint.

Group Configuration Parameters

group :

Identifier for a group of models.

  • Type: String
  • Required
  • Example : "my-westus"

apiKey :

The API key for accessing the Azure OpenAI Service.

  • Type: String
  • Required
  • Example : "${WESTUS_API_KEY}"
  • Note : It's highly recommended to use a custom env. variable reference for this field, i.e. ${YOUR_VARIABLE}

instanceName :

Name of the Azure instance.

  • Type: String
  • Required
  • Example : "my-westus"
  • Note : It's recommended to use a custom env. variable reference for this field, i.e. ${YOUR_VARIABLE}

version :

API version.

  • Type: String
  • Optional
  • Example : "2023-12-01-preview"
  • Note : It's recommended to use a custom env. variable reference for this field, i.e. ${YOUR_VARIABLE}

baseURL :

The base URL for the Azure OpenAI Service.

  • Type: String
  • Optional
  • Example : "https://prod.example.com"
  • Note : It's recommended to use a custom env. variable reference for this field, i.e. ${YOUR_VARIABLE}

additionalHeaders :

Additional headers for API requests.

  • Type: Dictionary
  • Optional
  • Example : 
    additionalHeaders:
  X-Custom-Header: ${YOUR_SECRET_CUSTOM_VARIABLE}
  • Note : It's recommended to use a custom env. variable reference for the values of field, as shown in the example.
  • Note : api-key header value is sent on every request

serverless :

Indicates the use of a serverless inference endpoint for Azure OpenAI chat completions.

  • Type: Boolean
  • Optional
  • Description : When set to true , specifies that the group is configured to use serverless inference endpoints as an Azure "Models as a Service" model.
  • Example : serverless: true
  • Note : More info here

addParams :

Adds additional parameters to requests.

  • Type: Object/Dictionary
  • Description : Adds/Overrides parameters. Useful for specifying API-specific options.
  • Example : 
        addParams:
      safe_prompt: true

dropParams :

Removes default parameters from requests.

  • Type: Array/List of Strings
  • Description : Excludes specified default parameters . Useful for APIs that do not accept or recognize certain parameters.
  • Example : dropParams: ["stop", "user", "frequency_penalty", "presence_penalty"]
  • Note : For a list of default parameters sent with every request, see the "Default Parameters" Section below.

forcePrompt :

If true , sends a prompt parameter instead of messages .

  • Type: Boolean
  • Example: forcePrompt: false
  • Note : This combines all messages into a single text payload, following OpenAI format , and

uses the /completions endpoint of your baseURL rather than /chat/completions .

models :

Configuration for individual models within a group.

  • Description : Configures settings for each model, including deployment name and version. Model configurations can adopt the group's deployment name and/or version when configured as a boolean (set to true ) or an object for detailed settings of either of those fields.
  • Example : See above example configuration.

Within each group, models are records, either set to true, or set with a specific deploymentName and/or version where the key MUST be the matching OpenAI model name; for example, if you intend to use gpt-4-vision, it must be configured like so: 

models:
  gpt-4-vision-preview: # matching OpenAI Model name
    deploymentName: "arbitrary-deployment-name"
    version: "2024-02-15-preview" # version can be any that supports vision

Model Configuration Parameters

deploymentName :

The name of the deployment for the model.

  • Type: String
  • Required
  • Example : "gpt-4-vision-preview"
  • Description : Identifies the deployment of the model within Azure.
  • Note : This does not have to be the matching OpenAI model name as is convention, but must match the actual name of your deployment on Azure.

version :

Specifies the version of the model.

  • Type: String
  • Required
  • Example : "2024-02-15-preview"
  • Description : Defines the version of the model to be used.

When specifying a model as a boolean ( true ):

When a model is enabled ( true ) without using an object, it uses the group's configuration values for deployment name and version.

Example : 

models:
  gpt-4-turbo: true

When specifying a model as an object:

An object allows for detailed configuration of the model, including its deploymentName and/or version . This mode is used for more granular control over the models, especially when working with multiple versions or deployments under one instance or resource group.

Example : 

models:
  gpt-4-vision-preview:
    deploymentName: "gpt-4-vision-preview"
    version: "2024-02-15-preview"

Notes:

  • Deployment Names and Versions are critical for ensuring that the correct model is used. Double-check these values for accuracy to prevent unexpected behavior.