Azure AI Foundry

Azure AI Foundry is a cloud-based service that provides access to models from OpenAI, Mistral AI, and others, integrated with the security and enterprise features of the Microsoft Azure platform. To get started, create an Azure AI Foundry resource in the Azure portal.

info

For details on OpenAI model setup, see Azure OpenAI Service configuration.

Chat model

We recommend configuring GPT-4o as your chat model.

YAML

config.yaml

models:
  - name: GPT-4o
    provider: azure
    model: gpt-4o
    apiBase: <YOUR_DEPLOYMENT_BASE>
    deployment: <YOUR_DEPLOYMENT_NAME>
    apiKey: <YOUR_AZURE_API_KEY> # If you use subscription key, try using Azure gateway to rename it apiKey
  env:
     apiType: azure-foundry # Or "azure-openai" if using OpenAI models

JSON

config.json

{
  "models": [{
      "title": "GPT-4o",
      "provider": "azure",
      "model": "gpt-4o",
      "apiBase": "<YOUR_DEPLOYMENT_BASE>",
      "deployment": "<YOUR_DEPLOYMENT_NAME>",
      "apiKey": "<YOUR_AZURE_API_KEY>", // If you use subscription key, try using Azure gateway to rename it apiKey
      "apiType": "azure-foundry" // Or "azure-openai" if using OpenAI models
  }]
}

Autocomplete model

We recommend configuring Codestral as your autocomplete model.

YAML

Package or config.yaml

models:
- name: Codestral
  provider: mistral
  model: codestral-latest
  roles:
    - autocomplete

JSON

config.json

{
"tabAutocompleteModel": {
  "title": "Codestral",
  "provider": "mistral",
  "model": "codestral-latest"
}
}

Embeddings model

We recommend configuring text-embedding-3-large as your embeddings model.

YAML

Package or config.yaml

models:
  - name: Text Embedding-3 Large
    provider: azure
    model: text-embedding-3-large
    apiBase: <YOUR_DEPLOYMENT_BASE>
    deployment: <YOUR_DEPLOYMENT_NAME>
    apiKey: <YOUR_AZURE_API_KEY>
    env:
      apiType: azure

JSON

config.json

{
  "embeddingsProvider": {
    "provider": "azure",
    "model": "text-embedding-3-large",
    "apiBase": "<YOUR_DEPLOYMENT_BASE>",
    "deployment": "<YOUR_DEPLOYMENT_NAME>",
    "apiKey": "<YOUR_AZURE_API_KEY>",
    "apiType": "azure-foundry" // Or "azure-openai" if using OpenAI models
  }
}

Reranking model

Azure OpenAI currently does not offer any reranking models.

Click here to see a list of reranking models.

Privacy

If you'd like to use OpenAI models but are concerned about privacy, you can use the Azure OpenAI service, which is GDPR and HIPAA compliant.

Getting access

Click here to apply for access to the Azure OpenAI service. Response times are typically within a few days.

Azure OpenAI Service configuration

Azure OpenAI Service requires a handful of additional parameters to be configured, such as a deployment name and API base URL.

To find this information in Azure AI Foundry, first select the model that you would like to connect. Then visit Endpoint > Target URI.

For example, a Target URI of https://just-an-example.openai.azure.com/openai/deployments/gpt-4o-july/chat/completions?api-version=2023-03-15-preview would map to the following:

YAML

Package or config.yaml

models:
  - name: GPT-4o Azure
    model: gpt-4o
    provider: openai
    apiBase: https://just-an-example.openai.azure.com
    deployment: gpt-4o-july
    apiVersion: 2023-03-15-preview
    apiKey: <YOUR_AZURE_API_KEY>
    env:
       apiType: azure-openai

JSON

config.json

{
  "title": "GPT-4o Azure",
  "model": "gpt-4o",
  "provider": "openai",
  "apiBase": "https://just-an-example.openai.azure.com",
  "deployment": "gpt-4o-july",
  "apiVersion": "2023-03-15-preview",
  "apiKey": "<YOUR_AZURE_API_KEY>",
  "apiType": "azure-openai"
}