https://github.com/codeforequity-at/botium-connector-inbenta
Botium Connector for Inbenta
https://github.com/codeforequity-at/botium-connector-inbenta
Last synced: about 1 year ago
JSON representation
Botium Connector for Inbenta
- Host: GitHub
- URL: https://github.com/codeforequity-at/botium-connector-inbenta
- Owner: codeforequity-at
- License: mit
- Created: 2021-05-21T13:13:13.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-28T08:58:03.000Z (over 1 year ago)
- Last Synced: 2025-03-25T00:42:37.285Z (about 1 year ago)
- Language: JavaScript
- Size: 178 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Botium Connector for Inbenta
[](https://nodei.co/npm/botium-connector-inbenta/)
[](https://badge.fury.io/js/botium-connector-inbenta)
[]()
This is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your Inbenta chatbot.
__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!__
## How it works?
It can be used as any other Botium connector with all Botium Stack components:
* [Botium CLI](https://github.com/codeforequity-at/botium-cli/)
* [Botium Bindings](https://github.com/codeforequity-at/botium-bindings/)
* [Botium Box](https://www.botium.at)
## Requirements
* __Node.js and NPM__
* a __Inbenta chatbot__
* a __project directory__ on your workstation to hold test cases and Botium configuration
## Install Botium and Inbenta Webhook Connector
When using __Botium CLI__:
```
> npm install -g botium-cli
> npm install -g botium-connector-inbenta
> botium-cli init
> botium-cli run
```
When using __Botium Bindings__:
```
> npm install -g botium-bindings
> npm install -g botium-connector-inbenta
> botium-bindings init mocha
> npm install && npm run mocha
```
When using __Botium Box__:
_Already integrated into Botium Box, no setup required_
## Connecting your Inbenta chatbot to Botium
Open the file _botium.json_ in your working directory and add the Webhook settings.
```
{
"botium": {
"Capabilities": {
"PROJECTNAME": "",
"CONTAINERMODE": "inbenta",
"INBENTA_API_KEY": "...",
"INBENTA_SECRET": "..."
}
}
}
```
## Supported Capabilities
Set the capability __CONTAINERMODE__ to __inbenta__ to activate this connector.
### INBENTA_API_KEY
The API KEY from Inbenta App ([Inbenta API Credentials ](https://help.inbenta.com/en/general/inbenta-app/administration/managing-credentials-for-developers/finding-your-instance-s-api-credentials/))
### INBENTA_SECRET
The SECRET from Inbenta App ([Inbenta API Credentials ](https://help.inbenta.com/en/general/inbenta-app/administration/managing-credentials-for-developers/finding-your-instance-s-api-credentials/))
### INBENTA_SOURCE
Source identifier (e.g. facebook, mobile, etc.) used to filter the logs in the Dashboards. You can use any value.
### INBENTA_USER_TYPE
Profile identifier from the Inbenta Backstage knowledge base. Minimum:0. Default:0
### INBENTA_ENV
Resource environment from the Inbenta knowledge base to which the request is applied. Each environment logs the data for the reports displayed in Inbenta dashboards separately. Possible values:
- production: This environment retrieves the contents/categories published in live.
- preproduction: This environment retrieves the contents/categories published in live.
- development (default): This environment retrieves the contents/categories published in edit.
### INBENTA_LANG
Language of the bot, represented by its ISO 639-1 code.
Default: "en"
### INBENTA_TIMEZONE
User timezone with a valid TZ database name value. If this attribute is set, user's local time will be added in the conversation history.
Example: "America/New_York"
### INBENTA_SKIP_WELCOME_MESSAGE
Skip welcome message request on conversation start.
### INBENTA_USE_VOTING
Activate voting support. Voting is an experimental feature of the connector, it might not work always as expected.
Known issues: Supports just english, and it is not possible to automate it (voting ID is generated for every conversation)
### INBENTA_EDITOR_API_KEY
Inbenta Editor API is required for download/upload Test Set. You can read about it [here](https://developers.inbenta.io/chatbot/editor-api/editor-api-setup)
### INBENTA_EDITOR_SECRET
Inbenta Editor API is required for download/upload Test Set. You can read about it [here](https://developers.inbenta.io/chatbot/editor-api/editor-api-setup)
### INBENTA_EDITOR_PERSONAL_SECRET
Inbenta Personal Secret is required for download/upload Test Set. You can read about it [here](https://help.inbenta.com/en/general/platform-overview/administration/managing-credentials-for-developers/managing-your-ups-tokens/)