The XO Platform lets you easily connect with the Azure OpenAI instance to find answers to your general queries. The Platform supports all common actions on Azure with ready-to-use pre-built dialog templates.
This article explains how to authorize and enable the Azure OpenAI action and install the pre-built templates.
Authorizations Supported
The Kore.ai XO Platform supports basic authentication, allowing Azure OpenAI integration to exchange data. For more information, read the Bot Authorization Overview article.
The Kore.ai XO Platform supports the following authorization types for the Azure OpenAI integration:
- Pre-Authorize the Integration – To make the integration process smoother for developers and customers, you can pre-authorize it by providing the necessary authorization credentials to obtain the access token.
- Allow Users to Authorize the Integration – This method requires the end user to provide credentials during the conversation for authorization. This authorization process involves requesting permission for Kore.ai’s Azure OpenAI app to access an access token at runtime. To learn more about Azure OpenAI account types, see Azure OpenAI Service.
Step 1: Create an Azure OpenAI App
Prerequisites:
Before enabling the Azure OpenAI action, complete the following prerequisites:
- If you don’t have Azure OpenAI account credentials, create a developer account in Azure OpenAI and note down login credentials. Use the Azure OpenAI Service Documentation for more information.
- Copy the API Key, User Sub Domain, and Deployment ID values and keep them for future use to enable the integration.
Create an Azure OpenAI Service app and configure it on the Kore.ai XO Platform to establish a communication channel between Azure OpenAI and the Kore.ai XO Platform.
Steps to create an Azure OpenAI service:
- Log in to the Azure portal, and search for Azure OpenAI from the portal menu.
- On the Cognitive Services Azure OpenAI page, click Create.
- Fill in the following required details:
- Select an existing Resource Group or create a new one.
- Select the Region. For example, select the South Central US region.
- Enter the Name of the Azure OpenAI service. For example, enter PlatformInegration.
- Select the Pricing Tier option. For example, select the Standard option.
- Click Next and then click Review + Submit.
- Once the Validation Passed message appears, click Create.
- The Azure OpenAI service is now initialized and deployed in the portal with an endpoint URL and API Keys. Click Go to Resource to view the app details.
- In the Overview page, copy the User Sub Domain from the endpoint. For example, in the following screenshot, the endpoint is “https://platformintegration.openai.azure.com/” and the user sub domain is “platformintegration”.
- In the Left Navigation Pane, select the Keys and Endpoints menu and click Show Keys, and then copy the API Key as shown below.
- In the Left Navigation Pane, select Model Deployments and create a new deployment. For example, enter the model name as PlatformDeploy and select the Model as text-davinci-001. Click Save.
- Copy the Model Name of the newly created deployment as shown below.
- You can also copy the Azure OpenAI service credentials from the Azure OpenAI Studio > Playground > GPT- 3 > View Code, as shown below.
Step 2: Enable the Azure OpenAI Action
Once you have created an Azure OpenAI service and copied the required credentials, you can enable the integration.
Steps to enable the Azure OpenAI action:
- Go to Build > Integrations > Actions.
- Once you click the Actions menu, all integrations are shown in the Available region. Select the Azure OpenAI action.
Pre-authorize the Integration
Basic Auth
You can authorize the integration using your credentials. The developer authorization lets you authorize the integration with preconfigured Kore.ai app with the Basic Auth option.
Steps to authorize the Azure OpenAI action using developer credentials:
- Go to Build > Integrations > Actions and select the Azure OpenAI action.
- In the Configurations dialog, select the Authorization tab.
- Enter the following details:
- Authorization Type – Select the Pre-authorize the Integration option, and then select the Basic Auth option.
- API Key – The secret API key of your Azure OpenAI service, which you copied in Step 1.
- User Sub Domain – The user sub domain name of the Azure OpenAI service, which you copied in Step 1.
- Deployment ID – The deployment ID/model name of the Azure OpenAI service, which you copied in Step 1.
- Authorization Type – Select the Pre-authorize the Integration option, and then select the Basic Auth option.
- Click Enable. When you configure the action for the first time, the Integration Successful pop-up is displayed.
Note: The Azure OpenAI action is moved from Available to Configured region.
Allow the End User to Authorize
You can authorize the integration at a user level with their login credentials. The user authorization process involves requesting permission for Kore.ai’s Azure OpenAI app to access an access token at runtime. You can also use the basic auth profile to let a user configure the integration at runtime.
Steps to authorize an Azure OpenAI action at a user level:
- Go to Build > Integrations > Actions and select the Azure OpenAI action in the Available Actions region.
- In the Configurations dialog, select the Authorization tab.
- Enter the following details:
- Authorization Type – Select the Allow Users to Authorize the Integration option, and then select the Basic Auth option.
- Create your authorization profile to obtain an access token and use it to complete integration without using Kore.ai’s Azure OpenAI app for authorization.
- Click the Select Authorization drop-down and select the Create New option.
- Select the type of authorization mechanism. For example, select the API Key option.
To create Basic Auth profiles, see Bot Authorization Overview. - Enter the following authentication credentials for the Basic Auth mechanism:
- Name – Enter the name for the Basic Auth profile.
- Select Yes; some tasks will have tenancy URLs, and the user must provide the URLs to authenticate successfully.
- Base URL – Enter the base tenant URL for the Azure OpenAI instance.
- Authorization Check URL – Enter the authorization check URL for your Azure OpenAI instance.
- Description – Enter the description of the basic authentication profile.
- Click Save Auth to save the authorization profile.
- Select the new Authorization Profile you created to complete integration.
- Click Enable. When you configure the action for the first time, the Integration Successful pop-up is displayed.
Step 3: Install the Azure OpenAI Action Templates
Once you have configured an Azure OpenAI integration, you can explore and install action templates.
Steps to install action templates:
- On the Integration Successful dialog, click the Explore Templates button to view the templates.
- In the Integration Templates dialog, click the Install button to begin the installation.
- Once the templates are installed, a dialog task is auto-created.
- When you create a dialog task, you can also select the task from the Azure OpenAI action templates and click Proceed. For example, select the General Query task.
- Once you click Proceed, the dialog task is auto-created, and the canvas opens with all required entity nodes, service nodes, and message scripts.
