Skip to content

Commit 10d7ac2

Browse files
committed
Rename project
1 parent bf5ae78 commit 10d7ac2

File tree

110 files changed

+1379
-1761
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+1379
-1761
lines changed

.github/workflows/on-release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
with:
1212
node-version: '16.x'
1313
registry-url: 'https://registry.npmjs.org'
14-
scope: '@ovotech'
14+
scope: '@makingchatbots'
1515
- run: yarn
1616
- run: yarn build
1717
- run: yarn test

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Genesys Cloud Chatbot Tester CLI
22

3-
[![npm](https://img.shields.io/npm/v/@ovotech/genesys-web-messaging-tester-cli)](https://www.npmjs.com/package/@ovotech/genesys-web-messaging-tester-cli)
3+
[![npm](https://img.shields.io/npm/v/@makingchatbots/genesys-cloud-chatbot-tester-cli)](https://www.npmjs.com/package/@makingchatbots/genesys-cloud-chatbot-tester-cli)
44
[![Follow me on LinkedIn for updates](https://img.shields.io/badge/Follow%20for%20updates-LinkedIn-blue)](https://www.linkedin.com/in/lucas-woodward-the-dev/)
55

66

@@ -9,8 +9,8 @@ Automatically test your Web Messenger Deployments
99
</p>
1010

1111
Allows behaviour for Genesys Chatbots and Architect flows behind [Genesys' Web Messenger Deployments](https://help.mypurecloud.com/articles/web-messaging-overview/) to be automatically tested using:
12-
* **Scripted Dialogue** - I say "X" and expect "Y" in response ([example](https://github.com/ovotech/genesys-web-messaging-tester/tree/main/examples/cli-scripted-tests/example-pass.yml))
13-
* **Generative AI** - Converse with my chatbot and fail the test if it doesn't do "X" ([examples](https://github.com/ovotech/genesys-web-messaging-tester/tree/main/examples/cli-ai-tests/))
12+
* **Scripted Dialogue** - I say "X" and expect "Y" in response ([example](https://github.com/makingchatbots/genesys-cloud-chatbot-tester/tree/main/examples/cli-scripted-tests/example-pass.yml))
13+
* **Generative AI** - Converse with my chatbot and fail the test if it doesn't do "X" ([examples](https://github.com/makingchatbots/genesys-cloud-chatbot-tester/tree/main/examples/cli-ai-tests/))
1414

1515
Why? Well it makes testing:
1616

@@ -20,11 +20,11 @@ Why? Well it makes testing:
2020
* **Automatic** - being a CLI tool means it can be integrated into your CI/CD pipeline, or run on a scheduled basis e.g.
2121
to monitor production
2222

23-
![Demo of tool executing two scenarios that pass](https://github.com/ovotech/genesys-web-messaging-tester/blob/main/docs/assets/cli/demo.gif?raw=true)
23+
![Demo of tool executing two scenarios that pass](https://github.com/makingchatbots/genesys-cloud-chatbot-tester/blob/main/docs/assets/cli/demo.gif?raw=true)
2424

2525
The above test is using the test-script:
2626

27-
> [examples/cli-scripted-tests/example-pass.yml](https://github.com/ovotech/genesys-web-messaging-tester/tree/main/examples/cli-scripted-tests/example-pass.yml)
27+
> [examples/cli-scripted-tests/example-pass.yml](https://github.com/makingchatbots/genesys-cloud-chatbot-tester/tree/main/examples/cli-scripted-tests/example-pass.yml)
2828
2929
```yaml
3030
config:
@@ -55,24 +55,24 @@ simulate a customer talking to a Web Messenger Deployment. Once the tool starts
5555
defined in a file called a 'test-script', which tells it what to say and what it should expect in response. If the
5656
response deviates from the test-script then the tool flags the test as a failure, otherwise the test passes.
5757
58-
![Tool using test-script file to test Web Messenger Deployment](https://github.com/ovotech/genesys-web-messaging-tester/blob/main/docs/assets/cli/overview.png?raw=true)
58+
![Tool using test-script file to test Web Messenger Deployment](https://github.com/makingchatbots/genesys-cloud-chatbot-tester/blob/main/docs/assets/cli/overview.png?raw=true)
5959
6060
## Quick Start
6161
6262
Prepare your system by installing [node](https://nodejs.org/en/download/)
6363
64-
Install the CLI tool using [`npm`](https://www.npmjs.com/package/@ovotech/genesys-web-messaging-tester-cli):
64+
Install the CLI tool using [`npm`](https://www.npmjs.com/package/@makingchatbots/genesys-cloud-chatbot-tester-cli):
6565

6666
```bash
67-
npm install -g @ovotech/genesys-web-messaging-tester-cli
67+
npm install -g @makingchatbots/genesys-cloud-chatbot-tester-cli
6868
```
6969

7070
### Testing with scripted dialogues
7171

7272
Write a dialogue script containing all the scenarios you wish to run along with
7373
the [ID and region of your Web Messenger Deployment](https://help.mypurecloud.com/articles/deploy-messenger/).
7474

75-
> [examples/cli-scripted-tests/example-pass.yml](https://github.com/ovotech/genesys-web-messaging-tester/tree/main/examples/cli-scripted-tests/example-pass.yml)
75+
> [examples/cli-scripted-tests/example-pass.yml](https://github.com/makingchatbots/genesys-cloud-chatbot-tester/tree/main/examples/cli-scripted-tests/example-pass.yml)
7676

7777
```yaml
7878
config:
@@ -120,7 +120,7 @@ the [ID and region of your Web Messenger Deployment](https://help.mypurecloud.co
120120
The scenarios are written as prompts, these can take some fine-tuning to get right ([see examples here](https://genesys-messenger-tester.makingchatbots.com/writing-tests/ai/example-prompts.html)).
121121
The `terminatingPhrases` section defines the phrases you instruct ChatGPT to say to pass or fail a test.
122122

123-
> [examples/cli-ai-tests/chatgpt-example.yml](https://github.com/ovotech/genesys-web-messaging-tester/tree/main/examples/cli-ai-tests/chatgpt-example.yml)
123+
> [examples/cli-ai-tests/chatgpt-example.yml](https://github.com/makingchatbots/genesys-cloud-chatbot-tester/tree/main/examples/cli-ai-tests/chatgpt-example.yml)
124124

125125
```yaml
126126
config:
@@ -175,7 +175,7 @@ For a slightly more detailed guide see: [Let's test a Genesys chatbot with AI](h
175175

176176
The `terminatingPhrases` section defines the phrases you instruct PaLM 2 to say to pass or fail a test.
177177

178-
> [examples/cli-ai-tests/google-vertex-ai-example.yml](https://github.com/ovotech/genesys-web-messaging-tester/tree/main/examples/cli-ai-tests/google-vertex-ai-example.yml)
178+
> [examples/cli-ai-tests/google-vertex-ai-example.yml](https://github.com/makingchatbots/genesys-cloud-chatbot-tester/tree/main/examples/cli-ai-tests/google-vertex-ai-example.yml)
179179

180180
```yaml
181181
config:
@@ -184,8 +184,6 @@ config:
184184
ai:
185185
provider: google-vertex-ai
186186
config:
187-
location: example-location
188-
project: example-gcp-project
189187
modelVersion: "002"
190188
examples:
191189
- input: "What would you like to do today?"
@@ -261,9 +259,9 @@ web-messaging-tester scripted test-script.yaml --parallel 10
261259

262260
If you have any questions then please feel free to:
263261

264-
* Raise an issue on this [project's GitHub repository](https://github.com/ovotech/genesys-web-messaging-tester)
262+
* Raise an issue on this [project's GitHub repository](https://github.com/makingchatbots/genesys-cloud-chatbot-tester)
265263
* [Drop me a message](https://www.linkedin.com/in/lucas-woodward-the-dev/)
266264

267265
## Development
268266

269-
* [Release Strategy](https://github.com/ovotech/genesys-web-messaging-tester/tree/main/docs/release-strategy.md)
267+
* [Release Strategy](https://github.com/makingchatbots/genesys-cloud-chatbot-tester/tree/main/docs/release-strategy.md)

docs/api/.nojekyll

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/api/README.md

Lines changed: 7 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
Genesys Web Messaging Tester
1+
**Genesys Web Messaging Tester****Docs**
22

3-
# Genesys Web Messaging Tester
3+
***
44

5-
## Table of contents
5+
# Genesys Web Messaging Tester
66

7-
### Classes
7+
## Classes
88

99
- [BotDisconnectedWaitingForResponseError](classes/BotDisconnectedWaitingForResponseError.md)
1010
- [Conversation](classes/Conversation.md)
@@ -16,7 +16,7 @@ Genesys Web Messaging Tester
1616
- [WebMessageServerFixture](classes/WebMessageServerFixture.md)
1717
- [WebMessengerGuestSession](classes/WebMessengerGuestSession.md)
1818

19-
### Interfaces
19+
## Interfaces
2020

2121
- [MessageDelayer](interfaces/MessageDelayer.md)
2222
- [SessionConfig](interfaces/SessionConfig.md)
@@ -25,47 +25,10 @@ Genesys Web Messaging Tester
2525
- [TranscribedMessage](interfaces/TranscribedMessage.md)
2626
- [WebMessengerSession](interfaces/WebMessengerSession.md)
2727

28-
### Type Aliases
29-
30-
- [Response](README.md#response)
31-
32-
### Variables
33-
34-
- [webMessagePayloads](README.md#webmessagepayloads)
35-
3628
## Type Aliases
3729

38-
### Response
39-
40-
Ƭ **Response**\<`T`\>: `SuccessResponse`\<`T`\> \| `FailureResponse`
41-
42-
#### Type parameters
43-
44-
| Name |
45-
| :------ |
46-
| `T` |
47-
48-
#### Defined in
49-
50-
[packages/genesys-web-messaging-tester/src/genesys/Response.ts:19](https://github.com/ovotech/genesys-web-messaging-tester/blob/main/packages/genesys-web-messaging-tester/src/genesys/Response.ts#L19)
30+
- [Response](type-aliases/Response.md)
5131

5232
## Variables
5333

54-
### webMessagePayloads
55-
56-
`Const` **webMessagePayloads**: `Object`
57-
58-
Payloads taken from real interactions
59-
60-
#### Type declaration
61-
62-
| Name | Type |
63-
| :------ | :------ |
64-
| `inboundStructuredMessage` | (`text`: `string`, `date`: `Date`) => [`StructuredMessage`](interfaces/StructuredMessage.md) |
65-
| `outboundDisconnectEventStructuredMessage` | (`date`: `Date`) => [`StructuredMessage`](interfaces/StructuredMessage.md) |
66-
| `outboundTextStructuredMessage` | (`text`: `string`, `date`: `Date`) => [`StructuredMessage`](interfaces/StructuredMessage.md) |
67-
| `sessionResponse` | () => [`SessionResponse`](interfaces/SessionResponse.md) |
68-
69-
#### Defined in
70-
71-
[packages/genesys-web-messaging-tester/src/testFixtures/webMessagePayloads.ts:6](https://github.com/ovotech/genesys-web-messaging-tester/blob/main/packages/genesys-web-messaging-tester/src/testFixtures/webMessagePayloads.ts#L6)
34+
- [webMessagePayloads](variables/webMessagePayloads.md)

0 commit comments

Comments
 (0)