> ## Documentation Index
> Fetch the complete documentation index at: https://koreai-ai-for-process-dev.mintlify.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuring the Azure OpenAI Action

<Badge icon="arrow-left" color="gray">[Back to Actions Integrations](/ai-for-service/integrations/overview#actions)</Badge>

Connect the XO Platform to Azure OpenAI to resolve general queries using GPT models. See [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service) for details.

***

## Supported Authorization Types

The platform supports Basic Auth for Azure OpenAI integration. See [App Authorization Overview](../../../dev-tools/bot-authorization/bot-authentication.md) for details.

| Authorization Type                       | Supported |
| ---------------------------------------- | --------- |
| Pre-Authorize the Integration            | Yes       |
| Allow Users to Authorize the Integration | Yes       |

***

## Step 1: Create an Azure OpenAI App

**Prerequisites:**

* Create an [Azure OpenAI](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/overview) developer account.
* Copy the **API Key**, **User Sub Domain**, and **Deployment ID** values for later use.

**Steps:**

1. Log in to the [Azure portal](https://portal.azure.com) and search for **Azure OpenAI**.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img1-azure-openai-app.png" alt="Azure portal" />

2. On the Cognitive Services Azure OpenAI page, click **Create**.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img2-azure-create.png" alt="Create" />

3. Fill in the required fields:

   * **Resource Group** - Select or create a resource group.
   * **Region** - e.g., South Central US.
   * **Name** - e.g., PlatformIntegration.
   * **Pricing Tier** - e.g., Standard.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img3-create-azure-app.png" alt="Create app" />

4. Click **Next** > **Review + Submit**, then click **Create** after validation passes.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img4-create-app.png" alt="Create app" />

5. Click **Go to Resource** to view app details.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img5-go-to-resource.png" alt="Go to resource" />

6. On the Overview page, copy the **User Domain Name**.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img6-azure-user-domain.png" alt="User Domain Name" />

7. Under **Keys and Endpoints**, click **Show Keys** and copy the **API Key**.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img7-azure-api-key.png" alt="API Key" />

8. Under **Model Deployments**, create a new deployment (e.g., name: *PlatformDeploy*, model: *text-davinci-001*) and click **Save**.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img8-azure-deploy-model.png" alt="Deploy model" />

9. Copy the **Model Name** of the new deployment.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img9-azure-deploy-model1.png" alt="Copy model name" />

10. Alternatively, copy credentials from **Azure OpenAI Studio > Playground > GPT-3 > View Code**.

    <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img10-azure-chatgpt-playground.png" alt="Playground" />

***

## Step 2: Enable the Azure OpenAI Action

Go to **App Settings > Integrations > Actions** and select **Azure OpenAI**.

### Pre-authorize the Integration (Basic Auth)

1. In the **Configurations** dialog, select the **Authorization** tab.

2. Set **Authorization Type** to **Pre-authorize the Integration** > **Basic Auth**.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img12-azure-openai-config-change.png" alt="Auth type" />

3. Enter the following fields:

   | Field           | Description                          |
   | --------------- | ------------------------------------ |
   | API Key         | Secret API key from Step 1           |
   | User Sub Domain | Domain name from Step 1              |
   | Deployment ID   | Deployment ID/model name from Step 1 |

   <Note>You can enter the deployment ID for ChatGPT-3 or ChatGPT-3.5 to configure the GPT model.</Note>

4. Click **Enable**. The Integration Successful pop-up appears on first configuration.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img13-azure-action6.png" alt="Enable" />

<Note>The Azure OpenAI action moves from Available to Configured.</Note>

### Allow End Users to Authorize (Basic Auth)

1. In the **Configurations** dialog, select the **Authorization** tab.

2. Set **Authorization Type** to **Allow Users to Authorize the Integration** > **Basic Auth**.

3. Click **Select Authorization** > **Create New**.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img14-azure-action2.png" alt="Create new" />

4. Select the authorization mechanism (e.g., **API Key**).

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img15-open-ai-api-key1-1.png" alt="API Key" />

   See [App Authorization Overview](../../../dev-tools/bot-authorization/bot-authentication.md) for creating Basic Auth profiles.

5. Enter the following credentials:

   | Field                   | Description                                   |
   | ----------------------- | --------------------------------------------- |
   | Name                    | Name for the Basic Auth profile               |
   | Tenancy URLs            | Select Yes if tasks require tenancy URLs      |
   | Base URL                | Base tenant URL for the Azure OpenAI instance |
   | Authorization Check URL | Auth check URL                                |
   | Description             | Description of the auth profile               |

6. Click **Save Auth**, then select the new profile.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img16-azure-action3.png" alt="Save auth" />

7. Click **Enable**. The Integration Successful pop-up appears.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img17-azure-action5.png" alt="Enable" />

***

## Step 3: Install Azure OpenAI Action Templates

1. On the Integration Successful dialog, click **Explore Templates**.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img18-azure-action6.png" alt="Explore templates" />

2. Click **Install** for the desired template.

   <img src="https://mintlify.s3.us-west-1.amazonaws.com/koreai-ai-for-process-dev/ai-for-service/integrations/actions/images/configure-azure-img19-azure-action7.png" alt="Install" />

3. The associated dialog task is auto-created. Click **Go to Dialog** or navigate to **Automation AI > Use Cases > Dialogs**.

4. To use the templates, see [Using Azure OpenAI Action Templates](using-the-azure-openai-action-templates.md).


Built with [Mintlify](https://mintlify.com).