{"id":15524340,"url":"https://github.com/codeforequity-at/botium-connector-sapcai","last_synced_at":"2025-03-28T20:48:19.298Z","repository":{"id":57190204,"uuid":"193384851","full_name":"codeforequity-at/botium-connector-sapcai","owner":"codeforequity-at","description":"Botium Connector for SAP Conversational AI","archived":false,"fork":false,"pushed_at":"2020-09-11T21:50:52.000Z","size":24,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-18T13:34:26.183Z","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}},"created_at":"2019-06-23T18:58:08.000Z","updated_at":"2020-09-11T21:49:36.000Z","dependencies_parsed_at":"2022-08-27T12:11:07.522Z","dependency_job_id":null,"html_url":"https://github.com/codeforequity-at/botium-connector-sapcai","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-sapcai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-sapcai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-sapcai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-sapcai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-sapcai/tar.gz/refs/heads/master","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:01.676Z","updated_at":"2025-03-28T20:48:19.260Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for for SAP Conversational AI\n\n[![NPM](https://nodei.co/npm/botium-connector-sapcai.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-sapcai/)\n\n[![Codeship Status for codeforequity-at/botium-connector-sapcai](https://app.codeship.com/projects/22e46100-911b-0137-ae8a-4e8cea91d933/status?branch=master)](https://app.codeship.com/projects/356365)\n[![npm version](https://badge.fury.io/js/botium-connector-sapcai.svg)](https://badge.fury.io/js/botium-connector-sapcai)\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 SAP Conversational AI 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 connects to your SAP Conversational AI chatbot using its [Dialog endpoint](https://cai.tools.sap/docs/api-reference/?javascript#dialog-text). \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## Features\n* [x] Text conversation\n* [x] Extracting media from Chatbot API response\n* [x] Extracting buttons from Chatbot API response (All [rich message](https://cai.tools.sap/docs/concepts/structured-messages) containing button are supported)\n* [x] Extracting NLP information (intent, entities) from API response\n* [X] Sending button clicks to Chatbot API\n* [X] Supporting conversation contexts\n\n## Requirements\n* **Node.js and NPM**\n* a **SAP Conversational AI bot**\n* a **project directory** on your workstation to hold test cases and Botium configuration\n\n## Install Botium and SAP Conversational AI Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-sapcai\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-sapcai\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 SAP Conversational AI chatbot to Botium\n\nProcess is very simple, you need just a token for your Chatbot. To acquire it choose your chatbot, and go in the settings in the tokens section. Using request token is preferred. \n\nYou can read about SAP Conversational AI tokens [here](https://cai.tools.sap/docs/api-reference/?shell#authentication).\n\nCreate a botium.json with this URL in your project directory: \n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"sapcai\",\n      \"SAPCAI_TOKEN\": \"...\"\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://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting) files.\n\n## How to start sample\n\nThere is a small demo in [samples](./samples) with Botium Bindings. \n\nIf you dont have installed Botium Core global, intstall it local:\n```\n\u003e cd ./samples/\n\u003e npm install botium-core\n```\n\nInstall the packages, and run the test:\n```\n\u003e cd ./samples/\n\u003e npm install botium-core \u0026\u0026 npm install \u0026\u0026 npm test\n```\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __sapcai__ to activate this connector.\n\n### SAPCAI_TOKEN\nTo acquire it \n- open [SAP Conversational AI Console Dashboard],(https://cai.tools.sap/) \n- choose your chatbot, \n- go in the settings in the tokens section.\n \nUsing request token is preferred. \n\nYou can read about tokens [here](https://cai.tools.sap/docs/api-reference/?shell#authentication).\n\n### SAPCAI_LANGUAGE\n\nA valid language isocode like \"en\". If not provided a language detection will be performed. See [SAP Conversational AI, /Dialog endpoint](https://cai.tools.sap/docs/api-reference/?javascript#dialog-text).\n\n### SAPCAI_MEMORY\n\nInitial conversation memory, see [help](https://help.sap.com/viewer/a4522a393d2b4643812b7caadfe90c18/latest/en-US/e99f8ad649a94f4a9c3c628567bede7f.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-sapcai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-sapcai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-sapcai/lists"}