You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Google Vertex AI ([PaLM 2 Chat Bison model](https://console.cloud.google.com/vertex-ai/publishers/google/model-garden/chat-bison))
108
+
* ChatGPT (`gpt-3.5-turbo` by default)
109
+
* Google Gemini (`gemini-2.0-flash` by default)
110
110
111
111
#### Using ChatGPT
112
112
Start by setting up an API key for ChatGPT:
@@ -160,34 +160,27 @@ scenarios:
160
160
Then run the AI test by pointing to the scenario file in the terminal:
161
161
162
162
```shell
163
-
web-messaging-tester ai tests/example.yml
163
+
genesys-cloud-chatbot-tester ai tests/example.yml
164
164
```
165
165
166
-
For a slightly more detailed guide see: [Let's test a Genesys chatbot with AI](https://www.linkedin.com/pulse/lets-test-genesys-chatbot-ai-lucas-woodward-dvrpc).
166
+
For a slightly more detailed guide see: [Let's test a Genesys chatbot with AI](https://makingchatbots.com/p/lets-test-a-genesys-chatbot-with-aihtml).
167
167
168
-
#### Using Google Vertex AI
168
+
#### Using Google Gemini
169
169
170
-
1. Create a Google Cloud Platform (GCP) account and enabled AI access to Vertex AI
171
-
2. Authenticate the machine running this testing tool, with GCP
172
-
* The easiest way is [setting up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev)
173
-
3. Define a prompt to provide the model with context on how to behave during testing
174
-
* Learn more in [Google's Introduction to prompt design](https://cloud.google.com/vertex-ai/docs/generative-ai/learn/introduction-prompt-design)
170
+
1. Set environment variables for [Gemini API key, or Gemini API on Vertex AI](https://github.com/googleapis/js-genai/tree/main?tab=readme-ov-file#optional-nodejs-only-using-environment-variables)
171
+
2. Define a prompt to provide the model with context on how to behave during testing
172
+
* Learn more in [Google's Introduction to prompt design](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/introduction-prompt-design)
175
173
176
-
The `terminatingPhrases` section defines the phrases you instruct PaLM 2 to say to pass or fail a test.
174
+
The `terminatingPhrases` section defines the phrases you instruct the model to return to pass or fail a test.
Copy file name to clipboardExpand all lines: docs/api/classes/BotDisconnectedWaitingForResponseError.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Class: BotDisconnectedWaitingForResponseError
8
8
9
-
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:58](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L58)
9
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:66](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L66)
10
10
11
11
## Extends
12
12
@@ -18,7 +18,7 @@ Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:58](https
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:59](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L59)
21
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:67](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L67)
22
22
23
23
#### Parameters
24
24
@@ -104,7 +104,7 @@ not capture any frames.
104
104
105
105
> **get****expectedResponse**(): `string`
106
106
107
-
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:89](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L89)
107
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:97](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L97)
108
108
109
109
##### Returns
110
110
@@ -118,7 +118,7 @@ Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:89](https
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:93](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L93)
121
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:101](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L101)
Copy file name to clipboardExpand all lines: docs/api/classes/Conversation.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Class: Conversation
8
8
9
-
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:130](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L130)
9
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:138](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L138)
10
10
11
11
Provides an API to simplify sending and receiving messages in a Web Messenger
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:142](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L142)
39
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:150](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L150)
40
40
41
41
#### Parameters
42
42
@@ -64,7 +64,7 @@ Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:142](http
64
64
65
65
> **get****isDisconnected**(): `boolean`
66
66
67
-
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:203](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L203)
67
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:211](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L211)
68
68
69
69
Returns whether the conversation has been disconnected
70
70
@@ -78,7 +78,7 @@ Returns whether the conversation has been disconnected
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:234](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L234)
81
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:242](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L242)
82
82
83
83
Sends text to the conversation
84
84
@@ -109,7 +109,7 @@ Delay in milliseconds between calling this method and the text being sent.
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:168](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L168)
112
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:176](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L176)
113
113
114
114
#### Parameters
115
115
@@ -127,7 +127,7 @@ Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:168](http
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:213](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L213)
130
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:221](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L221)
131
131
132
132
Resolves when the conversation has started.
133
133
@@ -144,7 +144,7 @@ background. This method allows you to wait for this process to finish.
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:276](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L276)
147
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:286](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L286)
148
148
149
149
Wait for all responses until there is a predefined amount of 'silence'.
150
150
@@ -164,7 +164,7 @@ Wait for all responses until there is a predefined amount of 'silence'.
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:260](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L260)
167
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:270](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L270)
168
168
169
169
Resolves on the next response from the other participant in the conversation that contains text.
170
170
@@ -180,7 +180,7 @@ If you want to wait for a specific message use [waitForResponseWithTextContainin
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:318](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L318)
183
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:328](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L328)
184
184
185
185
Resolves when a response is received that contains a specific piece of text.
186
186
If no response is received that contains the text within the timeout period
@@ -217,7 +217,7 @@ use [waitForResponseText](#waitforresponsetext).
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:349](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L349)
220
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:359](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L359)
221
221
222
222
Resolves when a response is received that matches a regular expression.
223
223
If no response is received that matches the pattern within the timeout period
Copy file name to clipboardExpand all lines: docs/api/classes/TimeoutWaitingForDisconnectionError.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Class: TimeoutWaitingForDisconnectionError
8
8
9
-
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:100](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L100)
9
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:108](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L108)
10
10
11
11
## Extends
12
12
@@ -18,7 +18,7 @@ Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:100](http
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:101](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L101)
21
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:109](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L109)
Copy file name to clipboardExpand all lines: docs/api/classes/TimeoutWaitingForResponseError.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
# Class: TimeoutWaitingForResponseError
8
8
9
-
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:9](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L9)
9
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:17](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L17)
10
10
11
11
## Extends
12
12
@@ -18,7 +18,7 @@ Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:9](https:
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:10](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L10)
21
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:18](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L18)
22
22
23
23
#### Parameters
24
24
@@ -108,7 +108,7 @@ not capture any frames.
108
108
109
109
> **get****expectedResponse**(): `string`
110
110
111
-
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:43](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L43)
111
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:51](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L51)
112
112
113
113
##### Returns
114
114
@@ -122,7 +122,7 @@ Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:43](https
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:47](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L47)
125
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:55](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L55)
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:53](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L53)
139
+
Defined in: [packages/genesys-cloud-chatbot-tester/src/Conversation.ts:61](https://github.com/MakingChatbots/genesys-cloud-chatbot-tester-cli/blob/main/packages/genesys-cloud-chatbot-tester/src/Conversation.ts#L61)
You can find the environment vars supported by Google's GenAI library this tool uses [in their docs](https://github.com/googleapis/js-genai/tree/main?tab=readme-ov-file#optional-nodejs-only-using-environment-variables).
0 commit comments