> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onyx.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Azure OpenAI

> Configure Azure OpenAI for enterprise-grade GPT models

## Guide

<Steps>
  <Step title="Navigate to Azure Portal Resources">
    Go to the [Azure Portal](https://portal.azure.com/) and navigate to the Azure OpenAI Service.

    <img className="rounded-image" src="https://mintcdn.com/danswer/sZSCgOqeRdUK59k_/assets/admins/ai_models/azure_oai_service.png?fit=max&auto=format&n=sZSCgOqeRdUK59k_&q=85&s=af3dc9e64d8272bca4ef09d2558e2e9f" alt="Azure OpenAI Service" width="2594" height="454" data-path="assets/admins/ai_models/azure_oai_service.png" />
  </Step>

  <Step title="Create an Azure OpenAI Deployment">
    Click **Create** and fill out the required fields in each section. Default values are usually sufficient.

    The deployment may take a few minutes to complete.

    <img className="rounded-image" src="https://mintcdn.com/danswer/sZSCgOqeRdUK59k_/assets/admins/ai_models/azure_oai_deployment.png?fit=max&auto=format&n=sZSCgOqeRdUK59k_&q=85&s=4a08ac1d2f096b5060c7c0da4b4d6b30" alt="Azure OpenAI Deployment" width="1492" height="712" data-path="assets/admins/ai_models/azure_oai_deployment.png" />
  </Step>

  <Step title="Create a Model Deployment">
    Go to the [Azure OpenAI Service](https://oai.azure.com/) and select your new AI resource.

    Navigate to the **Model Catalog** tab and select the model you want to use with Onyx.
    Click **Use this model** → **Deploy to selected resource**.

    <img className="rounded-image" src="https://mintcdn.com/danswer/sZSCgOqeRdUK59k_/assets/admins/ai_models/azure_oai_deployed_home.png?fit=max&auto=format&n=sZSCgOqeRdUK59k_&q=85&s=71b67e92a79953b43c7f23ed7ad3e791" alt="Azure OpenAI Service Landing Page" width="3278" height="1098" data-path="assets/admins/ai_models/azure_oai_deployed_home.png" />

    <img className="rounded-image" src="https://mintcdn.com/danswer/sZSCgOqeRdUK59k_/assets/admins/ai_models/azure_oai_deploy_model.png?fit=max&auto=format&n=sZSCgOqeRdUK59k_&q=85&s=fe07f32feb8a682aa9e7bf968594eb1f" alt="Azure OpenAI Model Deployment" width="1264" height="1072" data-path="assets/admins/ai_models/azure_oai_deploy_model.png" />
  </Step>

  <Step title="Save Your Deployment Details and Credentials">
    In your deployed model page, save the **Target URI** and **API Key**. Your **Target URI** has the **API Base**,
    **API Version**, and **Deployment Name** necessary to configure the provider in Onyx.

    <img className="rounded-image" src="https://mintcdn.com/danswer/sZSCgOqeRdUK59k_/assets/admins/ai_models/azure_oai_deployed_model_details.png?fit=max&auto=format&n=sZSCgOqeRdUK59k_&q=85&s=231c4bb4773c34cb197d34fee67b5e28" alt="Azure OpenAI Deployed Model Details" width="1856" height="812" data-path="assets/admins/ai_models/azure_oai_deployed_model_details.png" />

    <Warning>
      If you see `I'm sorry, but I cannot assist with that request` in Onyx chat responses,
      update the model deployment **Content filter** to **Default** instead of **DefaultV2**.

      <img className="rounded-image" src="https://mintcdn.com/danswer/GZyHxsTmXt3PTUba/assets/admins/ai_models/azure_oai_content_filter.png?fit=max&auto=format&n=GZyHxsTmXt3PTUba&q=85&s=2dbd270349b6fbd334d1ce97a9f1443f" alt="Azure OpenAI configuration page" width="895" height="379" data-path="assets/admins/ai_models/azure_oai_content_filter.png" />
    </Warning>
  </Step>

  <Step title="Navigate to Language Models">
    Access the Admin Panel from your user profile icon, then navigate to **Configuration → Language Models**.
  </Step>

  <Step title="Configure Azure OpenAI Provider">
    Select **Azure OpenAI** from the available providers.

    Give this configuration a **Display Name**.

    Paste your **API Key** into the **API Key** field.

    From your **Target URI**, extract the **API Base**, **API Version**, and **Deployment Name**

    Example:
    `https://onyxazureai.openai.azure.com/openai/deployments/gpt-4.1/chat/completions?api-version=2025-01-01-preview`

    <img className="rounded-image" src="https://mintcdn.com/danswer/sZSCgOqeRdUK59k_/assets/admins/ai_models/azure_oai_provider_config.png?fit=max&auto=format&n=sZSCgOqeRdUK59k_&q=85&s=3af2e9f91e87c1fc10feff599297fe33" alt="Azure OpenAI Provider Configuration" width="1778" height="1834" data-path="assets/admins/ai_models/azure_oai_provider_config.png" />
  </Step>

  <Step title="Designate Provider Access">
    In the **Advanced Options**, you may select whether or not the provider is public to all users in Onyx.

    If set to private,
    the provider's models will be available to Admins and User Groups you explicitly assign the provider to.
  </Step>
</Steps>
