Botium Connector for Azure Custom Question Answering

This is a Botium connector for testing your Azure Custom Question Answering intent resolution logic.

Did you read the Botium in a Nutshell articles? Be warned, without prior knowledge of Botium you won't be able to properly use this library!

How it works

It can be used as any other Botium connector with all Botium Stack components:

• Botium CLI
• Botium Bindings
• Botium Box

Prerequisites

• Node.js and NPM
• AZURE subsription
• Azure CQA project
• Resource key, and endpoint of the Azure CQA project
• The name of the Azure CQA project
• The deployment name
• A project directory on your workstation to hold test cases and Botium configuration

See also Create, test, and deploy a custom question answering project

Install Botium and Azure Custom Question Answering Connector

When using Botium CLI:

> npm install -g botium-cli
> npm install -g botium-connector-azure-cqa
> botium-cli init
> botium-cli run

When using Botium Bindings:

> npm install -g botium-bindings
> npm install -g botium-connector-azure-cqa
> botium-bindings init mocha
> npm install && npm run mocha

When using Botium Box:

Already integrated into Botium Box, no setup required

Connecting Azure Custom Question Answering

Create a botium.json with Azure resource key, and endpoint:

{
  "botium": {
    "Capabilities": {
      "PROJECTNAME": "Botium Project Azure CQA",
      "CONTAINERMODE": "azure-cqa",
      "AZURE_CQA_ENDPOINT_URL": "xxx",
      "AZURE_CQA_ENDPOINT_KEY": "xxx",
      "AZURE_CQA_PROJECT_NAME": "xxx"
    }
  }
}

Botium setup is ready, you can begin to write your BotiumScript files.

Supported Capabilities

Set the capability CONTAINERMODE to azure-cqa to activate this connector.

AZURE_CQA_ENDPOINT_URL

See Resource key, and endpoint of the Azure CQA project

AZURE_CQA_ENDPOINT_KEY

See Resource key, and endpoint of the Azure CQA project

AZURE_CQA_PROJECT_NAME

The name of the Azure CQA project

AZURE_CQA_USER_ID

The user ID. Default: random (uuid)

AZURE_CQA_DEPLOYMENT_NAME

The name of the specific deployment of the project to use. Default: 'production'

AZURE_CQA_API_VERSION

API version. Default: 2021-10-01

AZURE_CQA_RANKER_TYPE

Type of ranker to be used. Default: 'Default' Possible values:

• Default
• QuestionOnly

AZURE_CQA_INCLUDE_UNSTRUCTURED_SOURCES

Flag to enable Query over Unstructured Sources. Default: true

AZURE_CQA_API_VERSION

Enable or disable Answer Span prediction. See also Precise answering Default: false

See also Question Answering - Get Answers