Structure de l'objet Azure OpenAI

L'intégration d'Azure OpenAI Service à votre application vous permet d'utiliser de manière transparente plusieurs déploiements et modèles de régions hébergés par Azure OpenAI. Cette section détaille comment configurer l'endpoint Azure OpenAI pour répondre à vos besoins.

Pour un guide détaillé sur la configuration des paramètres Azure OpenAI, cliquez ici

Exemple de configuration

endpoints:
  azureOpenAI:
    titleModel: "gpt-4-turbo"
    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

Remarque : L'endpoint Azure OpenAI prend en charge tous les Shared Endpoint Settings, y compris streamRate, titleModel, titleMethod, titlePrompt, titlePromptTemplate et titleEndpoint.

assistants

Clé :

Key	Type	Description	Example
assistants	Boolean	Active ou désactive les assistants pour l'endpoint Azure OpenAI. Lorsqu'il est défini sur `true`, active les assistants associés à cet endpoint.	Choose one, either the official OpenAI API or Azure OpenAI API for assistants, not both.

Par défaut : Non spécifié

Exemple :

assistants: true

groups

Clé :

Key	Type	Description	Example
groups	Array	Configuration pour des groupes de modèles par emplacement géographique ou par objectif. Chaque élément du tableau `groups` configure un ensemble de modèles sous un regroupement spécifique, souvent par région géographique ou par configuration distincte.

Par défaut : Non spécifié

Remarque : Voir l'exemple ci-dessus.

Structure de l'objet Group

Chaque élément sous groups fait partie d'une liste d'enregistrements, chacun comportant les champs suivants :

group

Clé :

Key	Type	Description	Example
group	String	Identifiant pour un groupe de modèles.

Requis : oui

Exemple :

"group": "my-westus"

apiKey

Clé :

Key	Type	Description	Example
apiKey	String	La clé API pour accéder au service Azure OpenAI.	It's highly recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

Requis : oui

Exemple :

apiKey: "${WESTUS_API_KEY}"

instanceName

Clé :

Key	Type	Description	Example
instanceName	String	Nom de l'instance Azure. Prend en charge les deux formats de domaine : `.openai.azure.com` (hérité) et `.cognitiveservices.azure.com` (nouveau). Vous pouvez spécifier soit le domaine complet (par ex. `my-instance.cognitiveservices.azure.com`), soit uniquement le nom de l'instance (par ex. `my-instance`) pour la rétrocompatibilité avec l'ancien format `.openai.azure.com`.	It's recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

Requis : oui

Exemple :

# Using just the instance name (legacy format applied)
instanceName: "my-westus"
# OR using the full domain (new format)
instanceName: "my-westus.cognitiveservices.azure.com"

version

Clé :

Key	Type	Description	Example
version	String	Version de l'API.	It's recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

Par défaut : Non spécifié

Exemple :

version: "2023-12-01-preview"

baseURL

Clé :

Key	Type	Description	Example
baseURL	String	L'URL de base pour le service Azure OpenAI.	It's recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

Par défaut : Non spécifié

Exemple :

baseURL: "https://prod.example.com"

additionalHeaders

Clé :

Key	Type	Description	Example
additionalHeaders	Dictionary	En-têtes supplémentaires pour les requêtes API. Toutes les valeurs d'en-tête doivent être des chaînes de caractères.	It's recommended to use a custom env. variable reference for the values of field, as shown in the example. `api-key` header value is sent on every request.

Par défaut : Non spécifié

Exemple :

additionalHeaders:
  X-Custom-Header: ${YOUR_SECRET_CUSTOM_VARIABLE}

serverless

Clé :

Key	Type	Description	Example
serverless	Boolean	Indique l'utilisation d'un endpoint d'inférence serverless pour les complétions de chat Azure OpenAI. Lorsqu'il est défini sur `true`, spécifie que le groupe est configuré pour utiliser des endpoints d'inférence serverless en tant que modèle Azure « Models as a Service ».	More info [here](../ai_endpoints/azure.mdx#serverless-inference-endpoints)

Par défaut : Non spécifié

Exemple :

serverless: true

addParams

Clé :

Key	Type	Description	Example
addParams	Object/Dictionary	Ajoute des paramètres supplémentaires aux requêtes. Utile pour spécifier des options propres à l'API.

Par défaut : Non spécifié

Exemple :

addParams:
  safe_prompt: true

dropParams

Clé :

Key	Type	Description	Example
dropParams	Array/List of Strings	Supprime les paramètres par défaut des requêtes. Exclut les paramètres par défaut spécifiés.	Default parameters are the standard request parameters LibreChat sends to the Azure OpenAI API.

Par défaut : Non spécifié

Exemple :

dropParams: ["stop", "user", "frequency_penalty", "presence_penalty"]

models

Clé :

Key	Type	Description	Example
models		Configuration pour des modèles individuels au sein d'un groupe. Configure les paramètres pour chaque modèle, y compris le nom du déploiement et la 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.

Par défaut : Non spécifié

Exemple :

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

Structure de l'objet Azure OpenAI

Sur cette page