LibreChat is joining ClickHouse to power the open-source Agentic Data Stack šŸŽ‰ Learn more
LibreChat
ConfiguraĆ§Ć£oLibreChat YAMLEstrutura do ObjetoEstrutura de Objeto do Azure OpenAI

Estrutura de Objeto do Azure OpenAI

Integrar o Azure OpenAI Service com sua aplicaĆ§Ć£o permite que vocĆŖ utilize perfeitamente mĆŗltiplas implantaƧƵes e modelos de regiĆ£o hospedados pelo Azure OpenAI. Esta seĆ§Ć£o detalha como configurar o endpoint do Azure OpenAI para suas necessidades.

Para um guia detalhado sobre como configurar as definiƧƵes do Azure OpenAI, clique aqui

Exemplo de ConfiguraĆ§Ć£o

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

Nota: O endpoint do Azure OpenAI suporta todas as ConfiguraƧƵes de Endpoint Compartilhadas, incluindo streamRate, titleModel, titleMethod, titlePrompt, titlePromptTemplate e titleEndpoint.

assistants

Chave:

KeyTypeDescriptionExample
assistantsBooleanHabilita ou desabilita assistentes para o endpoint Azure OpenAI. Quando definido como `true`, ativa os assistentes associados a este endpoint.Choose one, either the official OpenAI API or Azure OpenAI API for assistants, not both.

PadrĆ£o: NĆ£o especificado

Exemplo:

assistants: true

groups

Chave:

KeyTypeDescriptionExample
groupsArrayConfiguraĆ§Ć£o para grupos de modelos por localizaĆ§Ć£o geogrĆ”fica ou finalidade. Cada item no array `groups` configura um conjunto de modelos sob um determinado agrupamento, geralmente por regiĆ£o geogrĆ”fica ou configuraĆ§Ć£o distinta.

PadrĆ£o: NĆ£o especificado

Nota: Veja o exemplo acima.

Estrutura do Objeto de Grupo

Cada item em groups faz parte de uma lista de registros, cada um com os seguintes campos:

group

Chave:

KeyTypeDescriptionExample
groupStringIdentificador para um grupo de modelos.

ObrigatĆ³rio: sim

Exemplo:

"group": "my-westus"

apiKey

Chave:

KeyTypeDescriptionExample
apiKeyStringA chave de API para acessar o Azure OpenAI Service.It's highly recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

ObrigatĆ³rio: sim

Exemplo:

apiKey: "${WESTUS_API_KEY}"

instanceName

Chave:

KeyTypeDescriptionExample
instanceNameStringNome da instĆ¢ncia do Azure. **Suporta ambos os formatos de domĆ­nio**: `.openai.azure.com` (legado) e `.cognitiveservices.azure.com` (novo). VocĆŖ pode especificar o domĆ­nio completo (por exemplo, `my-instance.cognitiveservices.azure.com`) ou apenas o nome da instĆ¢ncia (por exemplo, `my-instance`) para compatibilidade com versƵes anteriores com o formato legado `.openai.azure.com`.It's recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

ObrigatĆ³rio: sim

Exemplo:

# 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

Chave:

KeyTypeDescriptionExample
versionStringVersĆ£o da API.It's recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

PadrĆ£o: NĆ£o especificado

Exemplo:

version: "2023-12-01-preview"

baseURL

Chave:

KeyTypeDescriptionExample
baseURLStringA URL base para o Azure OpenAI Service.It's recommended to use a custom env. variable reference for this field, i.e. `${YOUR_VARIABLE}`

PadrĆ£o: NĆ£o especificado

Exemplo:

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

additionalHeaders

Chave:

KeyTypeDescriptionExample
additionalHeadersDictionaryCabeƧalhos adicionais para solicitaƧƵes de API. Todos os valores de cabeƧalho devem ser strings.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.

PadrĆ£o: NĆ£o especificado

Exemplo:

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

serverless

Chave:

KeyTypeDescriptionExample
serverlessBooleanIndica o uso de um endpoint de inferĆŖncia serverless para chat completions do Azure OpenAI. Quando definido como `true`, especifica que o grupo estĆ” configurado para usar endpoints de inferĆŖncia serverless como um modelo "Models as a Service" do Azure.More info [here](../ai_endpoints/azure.mdx#serverless-inference-endpoints)

PadrĆ£o: NĆ£o especificado

Exemplo:

serverless: true

addParams

Chave:

KeyTypeDescriptionExample
addParamsObject/DictionaryAdiciona parĆ¢metros adicionais Ć s solicitaƧƵes. ƚtil para especificar opƧƵes especĆ­ficas da API.

PadrĆ£o: NĆ£o especificado

Exemplo:

addParams:
  safe_prompt: true

dropParams

Chave:

KeyTypeDescriptionExample
dropParamsArray/List of StringsRemove parĆ¢metros padrĆ£o das requisiƧƵes. Exclui os parĆ¢metros padrĆ£o especificados.Default parameters are the standard request parameters LibreChat sends to the Azure OpenAI API.

PadrĆ£o: NĆ£o especificado

Exemplo:

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

models

Chave:

KeyTypeDescriptionExample
modelsConfiguraĆ§Ć£o para modelos individuais dentro de um grupo. Define as configuraƧƵes para cada modelo, incluindo o nome da implantaĆ§Ć£o e a versĆ£o.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.

PadrĆ£o: NĆ£o especificado

Exemplo:

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

Como estĆ” este guia?

Editar no GitHub

Estrutura do Objeto de endpoint Personalizado

PƔgina anterior

Estrutura de Objeto do AWS Bedrock

PrĆ³xima pĆ”gina

Nesta pƔgina

Exemplo de ConfiguraĆ§Ć£oassistantsgroupsEstrutura do Objeto de GrupogroupapiKeyinstanceNameversionbaseURLadditionalHeadersserverlessaddParamsdropParamsmodels