botium-connector-azure-clu

Botium Connector for Azure Conversational Language Understanding

This is a Botium connector for testing your Azure Conversational Language Understanding 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

Azure Conversational Language Understanding is just a stateless NLP recognition engine, extracting intent, and entities. You can use corresponding Botium NLP Asserters

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 CLU project
• Resource key, and endpoint of the Azure CLU project
• The name of the Azure CLU project
• The deployment name
• A project directory on your workstation to hold test cases and Botium configuration

See also Quickstart: Conversational language understanding)

Install Botium and Azure Conversational Language Understanding Connector

When using Botium CLI:

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

When using Botium Bindings:

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

When using Botium Box:

Already integrated into Botium Box, no setup required

Connecting Azure Conversational Language Understanding

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

{
  "botium": {
    "Capabilities": {
      "PROJECTNAME": "Botium Project Azure CLU",
      "CONTAINERMODE": "azure-clu",
      "AZURE_CLU_ENDPOINT_URL": "xxx",
      "AZURE_CLU_ENDPOINT_KEY": "xxx",
      "AZURE_CLU_PROJECT_NAME": "xxx",
      "AZURE_CLU_DEPLOYMENT_NAME": "xxx"
    }
  }
}

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

Supported Capabilities

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

AZURE_CLU_ENDPOINT_URL

See Resource key, and endpoint of the Azure CLU project

AZURE_CLU_ENDPOINT_KEY

See Resource key, and endpoint of the Azure CLU project

AZURE_CLU_PROJECT_NAME

The name of the Azure CLU project

AZURE_CLU_DEPLOYMENT_NAME

The Azure CLU deployment to test.

AZURE_CLU_API_VERSION

API version. Default: 2022-05-01

AZURE_CLU_PARTICIPANT_ID

The participiant ID. See Azure API doc

AZURE_CLU_LANGUAGE

The language of the conversation.

AZURE_CLU_DIRECT_TARGET

The direct target. See Azure API doc

AZURE_CLU_TARGET_PROJECT_PARAMETERS

The target project parameters. See Azure API doc

Possible values:

• staging
• production