{"id":15524350,"url":"https://github.com/codeforequity-at/botium-connector-qnamaker","last_synced_at":"2025-04-23T07:31:31.406Z","repository":{"id":57190203,"uuid":"210198544","full_name":"codeforequity-at/botium-connector-qnamaker","owner":"codeforequity-at","description":"Botium Connector for QnA Maker","archived":false,"fork":false,"pushed_at":"2025-01-28T11:21:37.000Z","size":91,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-13T10:07:42.639Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.botium.at","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codeforequity-at.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-22T18:55:45.000Z","updated_at":"2025-01-16T13:22:11.000Z","dependencies_parsed_at":"2025-03-05T10:33:28.885Z","dependency_job_id":"cb976d24-0fe3-490b-b80c-e28a3abbc003","html_url":"https://github.com/codeforequity-at/botium-connector-qnamaker","commit_stats":{"total_commits":17,"total_committers":5,"mean_commits":3.4,"dds":0.3529411764705882,"last_synced_commit":"baf42ec37c933740636e6fe36eeb377891cdd068"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-qnamaker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-qnamaker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-qnamaker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-qnamaker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-qnamaker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250391129,"owners_count":21422846,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T10:51:03.306Z","updated_at":"2025-04-23T07:31:31.388Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for QnA Maker\n\n[![NPM](https://nodei.co/npm/botium-connector-qnamaker.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-qnamaker/)\n\n[![Codeship Status for codeforequity-at/botium-connector-qnamaker](https://app.codeship.com/projects/b4066c40-c00f-0137-288f-269a2e1d9a5a/status?branch=master)](https://app.codeship.com/projects/365788)\n[![npm version](https://badge.fury.io/js/botium-connector-qnamaker.svg)](https://badge.fury.io/js/botium-connector-qnamaker)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()\n\nThis is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your [QnA Maker](https://www.qnamaker.ai) knowledge base.\n\n__Did you read the [Botium in a Nutshell](https://medium.com/@floriantreml/botium-in-a-nutshell-part-1-overview-f8d0ceaf8fb4) articles? Be warned, without prior knowledge of Botium you won't be able to properly use this library!__\n\n## How it works\nBotium connects to the [QnA Maker API](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/).\n\nIt can be used as any other Botium connector with all Botium Stack components:\n* [Botium CLI](https://github.com/codeforequity-at/botium-cli/)\n* [Botium Bindings](https://github.com/codeforequity-at/botium-bindings/)\n* [Botium Box](https://www.botium.at)\n\nThis connector processes info about NLP intent confidence. So the [intent confidence asserter](https://botium.atlassian.net/wiki/spaces/BOTIUM/pages/17334319/NLP+Asserter+Intents+Entities+Confidence) can be used.\n\n## Requirements\n* **Node.js and NPM**\n* a **published QnA maker knowledge base**\n* a **project directory** on your workstation to hold test cases and Botium configuration\n\n## Install Botium and QnA Maker Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-qnamaker\n\u003e botium-cli init\n\u003e botium-cli run\n```\n\nWhen using __Botium Bindings__:\n\n```\n\u003e npm install -g botium-bindings\n\u003e npm install -g botium-connector-qnamaker\n\u003e botium-bindings init mocha\n\u003e npm install \u0026\u0026 npm run mocha\n```\n\nWhen using __Botium Box__:\n\n_Already integrated into Botium Box, no setup required_\n\n## Connecting QnA Maker to Botium\n\nYou can find everything you need to connect Botium to your QnA Maker knowledge base on the [_My knowledge bases_](https://www.qnamaker.ai/Home/MyServices) screen. Click on _View Code_ to bring up a sample HTTP request to your knowledge base. It looks like this:\n\n```\nPOST /knowledgebases/xxxxxxxxxxxxx/generateAnswer\nHost: https://yyyyyyyyyyy.azurewebsites.net/qnamaker\nAuthorization: EndpointKey zzzzzzzzzzzzzzzzzzzzz\nContent-Type: application/json\n{\"question\":\"\u003cYour question\u003e\"}\n```\n\nThe botium.json file should look something like this:\n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"qnamaker\",\n      \"QNAMAKER_KNOWLEDGEBASE_ID\": \"xxxxxxxxxxxxx\",\n      \"QNAMAKER_RESOURCE_NAME\": \"yyyyyyyyyyy\",\n      \"QNAMAKER_ENDPOINT_KEY\": \"zzzzzzzzzzzzzzzzzzzzz\"\n    }\n  }\n}\n```\n\nTo check the configuration, run the emulator (Botium CLI required) to bring up a chat interface in your terminal window:\n\n```\n\u003e botium-cli emulator\n```\n\nBotium setup is ready, you can begin to write your [BotiumScript](https://botium.atlassian.net/wiki/spaces/BOTIUM/pages/491664/Botium+Scripting+-+BotiumScript) files.\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __qnamaker__ to activate this connector.\n\n### QNAMAKER_KNOWLEDGEBASE_ID\nQnA Maker Knowledgebase ID\n\n### QNAMAKER_RESOURCE_NAME\nQnA Maker Resource Name\n\n### QNAMAKER_RESOURCE_ENDPOINT\nQnA Maker Resource Endpoint\nTo specify a custom endpoint Url, like https://xxxxxxxxxxxx.azurewebsites.net\n\n### QNAMAKER_ENDPOINT_KEY\nQnA Maker Runtime Key\n\n### QNAMAKER_RESOURCE_KEY\nQnA Maker Authoring/Subscription Key\n\n### COGNITIVE_SERVICES_RESOURCE_NAME\nCognitive Services Resource Name (for Model Downloader)\n\n### COGNITIVE_SERVICES_RESOURCE_ENDPOINT\nCognitive Services Resource Endpoint\nTo specify a custom endpoint Url, like https://xxxxxxxxxxxx.cognitiveservices.azure.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-qnamaker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-qnamaker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-qnamaker/lists"}