{"id":15524376,"url":"https://github.com/codeforequity-at/botium-connector-azure-cqa","last_synced_at":"2025-03-28T20:48:26.234Z","repository":{"id":91176334,"uuid":"605600599","full_name":"codeforequity-at/botium-connector-azure-cqa","owner":"codeforequity-at","description":null,"archived":false,"fork":false,"pushed_at":"2023-07-05T08:09:10.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-03T06:35:25.399Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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":"2023-02-23T14:02:14.000Z","updated_at":"2023-02-27T18:26:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"bdda76d1-afe0-4aa8-9a41-f44162445938","html_url":"https://github.com/codeforequity-at/botium-connector-azure-cqa","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-azure-cqa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-azure-cqa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-azure-cqa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-azure-cqa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-azure-cqa/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246100489,"owners_count":20723469,"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:06.551Z","updated_at":"2025-03-28T20:48:26.213Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for Azure Custom Question Answering\n\n[![NPM](https://nodei.co/npm/botium-connector-azure-cqa.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-azure-cqa/)\n\n[![Codeship Status for codeforequity-at/botium-connector-azure-cqa](https://app.codeship.com/projects/2aef0d9b-bcf3-4d91-a05f-a18502f96104/status?branch=main)](https://app.codeship.com/projects/462873)\n[![npm version](https://badge.fury.io/js/botium-connector-azure-cqa.svg)](https://badge.fury.io/js/botium-connector-azure-cqa)\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 Azure Custom Question Answering intent resolution logic.\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\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\n## Prerequisites\n\n* __Node.js and NPM__\n* [AZURE subsription](https://azure.microsoft.com/free/cognitive-services)\n* Azure CQA project\n* [Resource key, and endpoint of the Azure CQA project](https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/conversational-language-understanding/quickstart#get-your-resource-keys-and-endpoint)\n* The name of the Azure CQA project\n* The deployment name\n* A __project directory__ on your workstation to hold test cases and Botium configuration\n\nSee also [Create, test, and deploy a custom question answering project](https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/question-answering/how-to/create-test-deploy)\n\n## Install Botium and Azure Custom Question Answering Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-azure-cqa\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-azure-cqa\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 Azure Custom Question Answering\n\nCreate a botium.json with Azure resource key, and endpoint:\n\n```javascript\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"Botium Project Azure CQA\",\n      \"CONTAINERMODE\": \"azure-cqa\",\n      \"AZURE_CQA_ENDPOINT_URL\": \"xxx\",\n      \"AZURE_CQA_ENDPOINT_KEY\": \"xxx\",\n      \"AZURE_CQA_PROJECT_NAME\": \"xxx\"\n    }\n  }\n}\n```\n\nBotium setup is ready, you can begin to write your [BotiumScript](https://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting) files.\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __azure-cqa__ to activate this connector.\n\n### AZURE_CQA_ENDPOINT_URL\nSee [Resource key, and endpoint of the Azure CQA project](https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/conversational-language-understanding/quickstart#get-your-resource-keys-and-endpoint)\n\n### AZURE_CQA_ENDPOINT_KEY\nSee [Resource key, and endpoint of the Azure CQA project](https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/conversational-language-understanding/quickstart#get-your-resource-keys-and-endpoint)\n\n### AZURE_CQA_PROJECT_NAME\nThe name of the Azure CQA project\n\n### AZURE_CQA_USER_ID\nThe user ID.\n_Default: random (uuid)_\n\n### AZURE_CQA_DEPLOYMENT_NAME\nThe name of the specific deployment of the project to use.\n_Default: 'production'_\n\n### AZURE_CQA_API_VERSION\nAPI version.\n_Default: 2021-10-01_\n\n### AZURE_CQA_RANKER_TYPE\nType of ranker to be used.\n_Default: 'Default'_\nPossible values:\n* Default\n* QuestionOnly\n\n### AZURE_CQA_INCLUDE_UNSTRUCTURED_SOURCES\nFlag to enable Query over Unstructured Sources.\n_Default: true_\n\n### AZURE_CQA_API_VERSION\nEnable or disable Answer Span prediction. See also [Precise answering](https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/question-answering/concepts/precise-answering)\n_Default: false_\n\n\nSee also [Question Answering - Get Answers](https://learn.microsoft.com/en-us/rest/api/cognitiveservices/questionanswering/question-answering/get-answers)\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-azure-cqa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-azure-cqa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-azure-cqa/lists"}