Struktura obiektu Azure OpenAI

Integracja usługi Azure OpenAI Service z Twoją aplikacją pozwala na płynne korzystanie z wielu wdrożeń i modeli regionalnych hostowanych przez Azure OpenAI. Ta sekcja szczegółowo opisuje, jak skonfigurować endpoint Azure OpenAI zgodnie z Twoimi potrzebami.

Aby uzyskać szczegółowy przewodnik dotyczący konfiguracji Azure OpenAI, kliknij tutaj

Przykładowa konfiguracja

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

Uwaga: Punkt końcowy Azure OpenAI obsługuje wszystkie Shared Endpoint Settings, w tym streamRate, titleModel, titleMethod, titlePrompt, titlePromptTemplate oraz titleEndpoint.

assistants

Klucz:

Key	Type	Description	Example
assistants	Boolean	Włącza lub wyłącza asystentów dla endpointu Azure OpenAI. Ustawienie wartości `true` aktywuje asystentów powiązanych z tym endpointem.	Choose one, either the official OpenAI API or Azure OpenAI API for assistants, not both.

Domyślnie: Nie określono

Przykład:

assistants: true

groups

Klucz:

Key	Type	Description	Example
groups	Array	Konfiguracja grup modeli według lokalizacji geograficznej lub przeznaczenia. Każdy element w tablicy `groups` konfiguruje zestaw modeli w ramach określonego grupowania, często według regionu geograficznego lub odrębnej konfiguracji.

Domyślnie: Nie określono

Uwaga: Zobacz przykład powyżej.

Struktura obiektu grupy

Każdy element w groups jest częścią listy rekordów, z których każdy posiada następujące pola:

group

Klucz:

Key	Type	Description	Example
group	String	Identyfikator grupy modeli.

Wymagane: tak

Przykład:

"group": "my-westus"

apiKey

Klucz:

Key	Type	Description	Example
apiKey	String	Klucz API do uzyskania dostępu do Azure OpenAI Service.	It's highly recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

Wymagane: tak

Przykład:

apiKey: "${WESTUS_API_KEY}"

instanceName

Klucz:

Key	Type	Description	Example
instanceName	String	Nazwa instancji Azure. Obsługuje oba formaty domen: `.openai.azure.com` (starszy) oraz `.cognitiveservices.azure.com` (nowy). Możesz podać pełną domenę (np. `my-instance.cognitiveservices.azure.com`) lub tylko nazwę instancji (np. `my-instance`) w celu zachowania kompatybilności wstecznej ze starszym formatem `.openai.azure.com`.	It's recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

Wymagane: tak

Przykład:

# 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

Klucz:

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

Domyślnie: Nie określono

Przykład:

version: "2023-12-01-preview"

baseURL

Klucz:

Key	Type	Description	Example
baseURL	String	Podstawowy adres URL dla usługi Azure OpenAI Service.	It's recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

Domyślnie: Nie określono

Przykład:

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

additionalHeaders

Klucz:

Key	Type	Description	Example
additionalHeaders	Dictionary	Dodatkowe nagłówki dla żądań API. Wszystkie wartości nagłówków muszą być ciągami znaków.	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.

Domyślnie: Nie określono

Przykład:

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

serverless

Klucz:

Key	Type	Description	Example
serverless	Boolean	Wskazuje na użycie bezserwerowego punktu końcowego wnioskowania dla czatów Azure OpenAI. Ustawienie wartości `true` oznacza, że grupa jest skonfigurowana do korzystania z bezserwerowych punktów końcowych wnioskowania jako modelu Azure „Models as a Service”.	More info [here](../ai_endpoints/azure.mdx#serverless-inference-endpoints)

Domyślnie: Nie określono

Przykład:

serverless: true

addParams

Klucz:

Key	Type	Description	Example
addParams	Object/Dictionary	Dodaje dodatkowe parametry do żądań. Przydatne do określania opcji specyficznych dla API.

Domyślnie: Nie określono

Przykład:

addParams:
  safe_prompt: true

dropParams

Klucz:

Key	Type	Description	Example
dropParams	Array/List of Strings	Usuwa domyślne parametry z żądań. Wyklucza określone parametry domyślne.	Default parameters are the standard request parameters LibreChat sends to the Azure OpenAI API.

Domyślnie: Nie określono

Przykład:

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

models

Klucz:

Key	Type	Description	Example
models		Konfiguracja poszczególnych modeli w ramach grupy. Konfiguruje ustawienia dla każdego modelu, w tym nazwę wdrożenia i wersję.	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.

Domyślnie: Nie określono

Przykład:

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

Struktura obiektu Azure OpenAI

Na tej stronie