ballerinax/azure.qnamaker Ballerina library

Overview

The Azure QnA Maker API v4 connector(https://docs.microsoft.com/en-us/rest/api/cognitiveservices-qnamaker/QnAMaker4.0/) OpenAPI specification. The Azure QnA Maker API is a cloud-based Natural Language Processing (NLP) service that allows you to create a natural conversational layer over your data. It is used to find the most appropriate answer for any input from your custom knowledge base (KB) of information. QnA Maker is commonly used to build conversational client applications, which include social media applications, chat bots, and speech-enabled desktop applications.

This module supports Azure QnA Maker API v4.

Key Features

• Programmatic access to create and manage resources via REST API
• Manage user accounts and profiles
• Secure authentication with API key or OAuth support

Prerequisites

Before using this connector in your Ballerina application, complete the following:

• Create an Azure account

• Create a resource

• Obtain tokens by following this guide

Quickstart

To use this connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

Import the ballerinax/azure.qnamaker module into the Ballerina project.

import ballerinax/azure.qnamaker;

Step 2: Create a new connector instance

You can now make the connection configuration using Ocp-Apim-Subscription-Key.

You can do this step in two ways. You can use any one of this.

• Option 1 : Configure API Keys in ballerina file directly.

  qnamaker:ApiKeysConfig apiKeyConfig = {
      ocpApimSubscriptionKey:"<AZURE_API_KEY>"
      subscriptionKey: "<Subscription Key>"
  };
  
  qnamaker:Client myClient = check new Client(apiKeyConfig, serviceUrl = "https://<REGION>.api.cognitive.microsoft.com/qnamaker/v4.0");

• Option 2 : Configure API Keys in Config.toml file and configure it in ballerina file, using configurables.

  1. Set up API Keys in Config.toml as shown below.

  [apiKeyConfig]
  ocpApimSubscriptionKey = "<AZURE_API_KEY>"
  subscriptionKey = "<Subscription Key>"
  

  2. Configure the client in ballerina file as shown below.

  configurable ApiKeysConfig & readonly apiKeyConfig = ?;
  
  qnamaker:Client myClient = check new Client(apiKeyConfig, serviceUrl = "https://<REGION>.api.cognitive.microsoft.com/qnamaker/v4.0");

Step 3: Invoke connector operation

1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

   Following is an example on how to get Knowledgebase Details from API.

   Get Knowledgebase Details

   public function main() returns error? {
   
       qnamaker:KnowledgebaseDTO res = check baseClient->getKnowledgebaseDetail(kID);
   
   }

2. Use bal run command to compile and run the Ballerina program.