{"id":15524378,"url":"https://github.com/codeforequity-at/botium-connector-nuance","last_synced_at":"2025-03-28T20:48:22.441Z","repository":{"id":163371106,"uuid":"621781895","full_name":"codeforequity-at/botium-connector-nuance","owner":"codeforequity-at","description":"Botium Connector for Nuance","archived":false,"fork":false,"pushed_at":"2023-05-15T08:39:55.000Z","size":154,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-05T11:48:11.277Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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-03-31T11:26:52.000Z","updated_at":"2023-05-15T08:34:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"c4430a02-6af3-48e9-bb40-c48049a3b450","html_url":"https://github.com/codeforequity-at/botium-connector-nuance","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-nuance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-nuance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-nuance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-nuance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-nuance/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.790Z","updated_at":"2025-03-28T20:48:22.398Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for Nuance\n\n[![NPM](https://nodei.co/npm/botium-connector-nuance.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-nuance/)\n\n[![npm version](https://badge.fury.io/js/botium-connector-nuance.svg)](https://badge.fury.io/js/botium-connector-nuance)\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 Nuance chatbot.\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 uses the [Nuance API](https://docs.nuance.com/mix/apis/) to connect to your chatbot.\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## Requirements\n\n* __Node.js and NPM__\n* a deployed __Nuance chatbot__\n* a __project directory__ on your workstation to hold test cases and Botium configuration\n## Install Botium and Nuance Webhook Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-nuance\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-nuance\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 your Nuance chatbot to Botium\n\n1. Fill the mandatory capabilities of _botium.json_ file:\n   1. NUANCE_CLIENT_ID\n   2. NUANCE_CLIENT_SECRET\n   3. NUANCE_CONTEXT_TAG\n   4. NUANCE_CHANNEL\n2. Nlp analytics (It slows down the communication, so it is not enabled as default):\n   1. Enable it with NUANCE_NLP_ANALYTICS_ENABLE capability\n3. In order to use downloader/uploader:\n   1. [Generate service account](https://docs.nuance.com/mix/apis/mix-api/authorization/authorization_client_credentials/#generate-service-credentials-for-mixapi)\n   2. If it is not visible to you, then please [ask nuance for permissions](https://docs.nuance.com/mix/apis/mix-api/authorization/authorization_client_credentials/#obtain-a-service-account)\n   3. Setup the following capabilities:\n      1. NUANCE_API_URL\n      2. NUANCE_ADMIN_CLIENT_ID\n      3. NUANCE_ADMIN_CLIENT_SECRET\n      4. NUANCE_PROJECT_ID\n\nSample _botium.json_ in your working directory:\n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"nuance\",\n      \"NUANCE_CLIENT_ID\": \"...\",\n      \"NUANCE_OAUTH_URL\": \"...\",\n      \"NUANCE_CLIENT_SECRET\": \"...\",\n      \"NUANCE_CONTEXT_TAG\": \"...\",\n      \"NUANCE_CHANNEL\": \"...\",\n      \"NUANCE_NLP_ANALYTICS_ENABLE\": true,\n      \"NUANCE_API_URL\": \"...\",\n      \"NUANCE_ADMIN_CLIENT_ID\": \"...\",\n      \"NUANCE_ADMIN_CLIENT_SECRET\": \"...\",\n      \"NUANCE_PROJECT_ID\": \"...\"\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 __nuance__ to activate this connector.\n\n### NUANCE_CLIENT_ID, NUANCE_CLIENT_SECRET\n[Nuance client id, and client secret](https://docs.nuance.com/mix/tasks/authorize/authentication_overview/#client-credentials)\n\n### NUANCE_CONTEXT_TAG\n[Nuance context tag](https://docs.nuance.com/mix/tasks/deploy/applications/#set-up-a-new-configuration)\n\n### NUANCE_CHANNEL\n[Nuance channel](https://docs.nuance.com/mix/tasks/projects/manage/targets/#channel-settings)\n\n### NUANCE_LANGUAGE\nLanguage of the chatbot. A chatbot can be multi lingual, but the communication is bound to one dedicated one.\n\nOptional.\n\nDefault: en-US\n\n### NUANCE_NLP_ANALYTICS_ENABLE\nCapability to enable nlp analytics.\n\nOptional.\n\nDefault: false\n\n### NUANCE_API_URL\n[Nuance API url](https://docs.nuance.com/mix/overview/mix-geographies/)\n\nOptional. Only required for downloader/uploader.\nDefault: https://mix.api.nuance.com/\n\n### NUANCE_ADMIN_CLIENT_ID, NUANCE_ADMIN_CLIENT_SECRET\nCredentials for [Nuance Service Account](https://docs.nuance.com/mix/apis/mix-api/authorization/authorization_client_credentials/#generate-service-credentials-for-mixapi)\n\nOptional. Only required for downloader/uploader.\n\n### NUANCE_PROJECT_ID\nThe Nuance Project ID.\n\nOptional. Only required for downloader/uploader.\n\n### NUANCE_OAUTH_URL\n[Nuance Oauth url](https://docs.nuance.com/mix/overview/mix-geographies/)\n\nDefault: https://auth.crt.nuance.com/oauth2/token\n\n### NUANCE_DLG_ENDPOINT\n[Nuance NLU gRPC endpoint](https://docs.nuance.com/mix/overview/mix-geographies/)\n\nDefault: nlu.api.nuance.com:443\n\n### NUANCE_NLU_ENDPOINT\n[Nuance NLU gRPC endpoint](https://docs.nuance.com/mix/overview/mix-geographies/)\n\nDefault: dlg.api.nuance.com:443\n\n### NUANCE_OAUTH_MAX_RETRIES\nOauth max retries. It is to deal with for Nuance Authorization rate limit: 50 requests/minute per IP address\n\nDefault: 6\n\n### NUANCE_OAUTH_RETRY_DELAY_SEC\nOauth retry delay in sec. It is to deal with for Nuance Authorization rate limit: 50 requests/minute per IP address\n\nDefault: 10\n\n### NUANCE_LIBRARY\n[Nuance Library]((https://docs.nuance.com/mix/apis/dialog-grpc/v1/nuance-dlg-service/#selector)).\n\nDefault: default\n\n### NUANCE_SESSION_ID\n[Nuance session timeout](https://docs.nuance.com/mix/apis/dialog-grpc/v1/client-app-dlg/#start-a-new-session) in sec.\n\nDefault: not set (generated by Nuance)\n\n### NUANCE_SESSION_TIMEOUT_SEC\n[Nuance session timeout](https://docs.nuance.com/mix/apis/dialog-grpc/v1/client-app-dlg/#start-a-new-session) in sec.\n\nDefault: 900\n\n### NUANCE_USER_ID\n\n[Nuance user id](https://docs.nuance.com/mix/apis/dialog-grpc/v1/client-app-dlg/#start-a-new-session) in sec.\n\nDefault: not set\n\n### NUANCE_CLIENT_DATA\n\n[Client data to inject into the Nuance Event Logs](https://docs.nuance.com/mix/apis/event_logs/inject-content/#client-data)\n\n### NUANCE_SUPPRESS_LOG_USER_DATA\nCapability to turn off Nuance Event Logs\n\n### NUANCE_INITIAL_CONTEXT\n[Initial context (session data)](https://docs.nuance.com/mix/apis/dialog-grpc/v1/ref-topics/data-exchange-resources/reference_exchanging_session_data/\n) in JSON format\n\n### NUANCE_SKIP_WELCOME_MESSAGE\nTurning off welcome message check can speed up the time of the conversation.\n\nDefault: false\n\n### NUANCE_NLU_ENTITY_VALUE_MODE\nConfigure how Nuance entities are mapped to Botium entities\n\nPossible values:\n* __FORCE_LITERAL__ Nuance entities are mapped as string\n* __FORCE_STRUCT__ Nuance entities are mapped as string\n* __LITERAL_FOR_COMPLEX__ Flat Nuance entities are mapped as string, complex as JSON\n\n## Open Issues and Restrictions\n* Voice, and IVR chatbots are not supported (just text based)\n* On premise installation of a Nuance chatbot might not work.\n* [Transfer action](https://docs.nuance.com/mix/apis/dialog-grpc/v1/ref-topics/response-actions/reference_transfer_actions/) is not supported: \n* [Dialog events](https://docs.nuance.com/mix/apis/dialog-grpc/v1/nuance-dlg-service/#dialogevent) are not supported\n* [Continue actions](https://docs.nuance.com/mix/apis/dialog-grpc/v1/ref-topics/response-actions/reference_continue_actions/) are not supported","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-nuance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-nuance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-nuance/lists"}