Botium Connector for Inbenta
This is a Botium connector for testing your Inbenta chatbot.
Did you read the Botium in a Nutshell 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:
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": "<whatever>",
"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 )
INBENTA_SECRET
The SECRET from Inbenta App (Inbenta 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
INBENTA_EDITOR_SECRET
Inbenta Editor API is required for download/upload Test Set. You can read about it here
INBENTA_EDITOR_PERSONAL_SECRET
Inbenta Personal Secret is required for download/upload Test Set. You can read about it here