https://github.com/codeforequity-at/botium-connector-genesys-agent-assist
https://github.com/codeforequity-at/botium-connector-genesys-agent-assist
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codeforequity-at/botium-connector-genesys-agent-assist
- Owner: codeforequity-at
- License: mit
- Created: 2025-01-03T15:24:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-28T12:06:39.000Z (about 1 year ago)
- Last Synced: 2025-10-19T21:45:03.709Z (8 months ago)
- Language: JavaScript
- Size: 158 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Botium Connector for Genesys Agent Assist
This is a Botium connector for testing your Genesys Agent Assist query resolution logic.
__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)
## Prerequisites
* __Node.js and NPM__
* [Genesys PureCloud ClientId and ClientSecret](https://help.mypurecloud.com/articles/create-an-oauth-client/)
* KnowledgeId
* The deployment name
* A __project directory__ on your workstation to hold test cases and Botium configuration
See also [Understand knowledge base V2 questions and answer articles](https://help.mypurecloud.com/articles/understand-knowledge-base-v2-questions-and-answer-articles/)
## Install Botium and Genesys Agent Assist Connector
When using __Botium CLI__:
```
> npm install -g botium-cli
> npm install -g botium-connector-genesys-agent-assist
> botium-cli init
> botium-cli run
```
When using __Botium Bindings__:
```
> npm install -g botium-bindings
> npm install -g botium-connector-genesys-agent-assist
> botium-bindings init mocha
> npm install && npm run mocha
```
When using __Botium Box__:
_Already integrated into Botium Box, no setup required_
## Connecting Genesys Knowledge Base
Create a botium.json with Genesys ClientId, ClientSecret and KnowledgeId:
```javascript
{
"botium": {
"Capabilities": {
"PROJECTNAME": "genesys-kb-connector",
"CONTAINERMODE": "genesys-agent-assist",
"GENESYS_AGENT_ASSIST_API_DOMAIN": "mypurecloud.com",
"GENESYS_AGENT_ASSIST_CLIENTID": "xxx",
"GENESYS_AGENT_ASSIST_CLIENTSECRET": "xxx",
"GENESYS_AGENT_ASSIST_KNOWLEDGE_ID": "xxx",
"GENESYS_AGENT_ASSIST_INCLUDE_DRAFTDOCS": true,
"GENESYS_AGENT_ASSIST_TIMEOUT": 60000
}
}
}
```
Botium setup is ready, you can begin to write your [BotiumScript](https://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting) files.
## Using the botium-connector-genesys-agent-assist-cli
This connector provides a CLI interface for importing convos and utterances from your Genesys Knowledge base and convert it to BotiumScript.
* Intents(document title) and Utterances(phrases) are converted to BotiumScript utterances and convo files (using the --buildconvos option)
You can either run the CLI with *[botium-cli](https://github.com/codeforequity-at/botium-cli) (recommended - it is integrated there)*, or directly from this connector (see samples/Connector-Test/package.json for some examples):
> botium-connector-genesys-agent-assist-cli import --buildconvos
_Please note that a botium-core installation is required_
For getting help on the available CLI options and switches, run:
> botium-connector-genesys-agent-assist-cli import --help
## Supported Capabilities
Set the capability __CONTAINERMODE__ to __genesys-agent-assist__ to activate this connector.
### GENESYS_AGENT_ASSIST_API_DOMAIN
See [Genesys Cloud environment region] (https://developer.genesys.cloud/platform/api/)
example values: mypurecloud.com (us-east-1), usw2.pure.cloud (us-west-2), api.mypurecloud.ie (eu-west-1) etc.
default: mypurecloud.com
### GENESYS_AGENT_ASSIST_CLIENTID
See [Genesys PureCloud ClientId and ClientSecret](https://help.mypurecloud.com/articles/create-an-oauth-client/)
### GENESYS_AGENT_ASSIST_CLIENTSECRET
See [Genesys PureCloud ClientId and ClientSecret](https://help.mypurecloud.com/articles/create-an-oauth-client/)
### GENESYS_AGENT_ASSIST_KNOWLEDGE_ID
The Id of Knowlege Base to which Agent assist is conected to (https://help.mypurecloud.com/articles/create-genesys-agent-assist-as-an-assistant/)
### GENESYS_AGENT_ASSIST_INCLUDE_DRAFTDOCS
Indicates whether the search results would also include draft documents.
default: true
### GENESYS_AGENT_ASSIST_MAX_ANSWERS
Maxium number of answers expected for a query by Agent Assist
default: 5
### GENESYS_AGENT_ASSIST_TIMEOUT
API Timeout
default: 10000 ms
See also [About the knowledge workbench V2](https://help.mypurecloud.com/articles/about-the-knowledge-workbench-v2/)