@roarkanalytics/sdk 2.34.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +31 -0
- package/client.d.mts +2 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +2 -2
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/agent-endpoint.d.mts +26 -0
- package/resources/agent-endpoint.d.mts.map +1 -1
- package/resources/agent-endpoint.d.ts +26 -0
- package/resources/agent-endpoint.d.ts.map +1 -1
- package/resources/agent-endpoint.js +26 -0
- package/resources/agent-endpoint.js.map +1 -1
- package/resources/agent-endpoint.mjs +26 -0
- package/resources/agent-endpoint.mjs.map +1 -1
- package/resources/agent.d.mts +20 -0
- package/resources/agent.d.mts.map +1 -1
- package/resources/agent.d.ts +20 -0
- package/resources/agent.d.ts.map +1 -1
- package/resources/agent.js +20 -0
- package/resources/agent.js.map +1 -1
- package/resources/agent.mjs +20 -0
- package/resources/agent.mjs.map +1 -1
- package/resources/call.d.mts +39 -170
- package/resources/call.d.mts.map +1 -1
- package/resources/call.d.ts +39 -170
- package/resources/call.d.ts.map +1 -1
- package/resources/call.js +39 -0
- package/resources/call.js.map +1 -1
- package/resources/call.mjs +39 -0
- package/resources/call.mjs.map +1 -1
- package/resources/config.d.mts +90 -99
- package/resources/config.d.mts.map +1 -1
- package/resources/config.d.ts +90 -99
- package/resources/config.d.ts.map +1 -1
- package/resources/config.js +18 -5
- package/resources/config.js.map +1 -1
- package/resources/config.mjs +18 -5
- package/resources/config.mjs.map +1 -1
- package/resources/customer-flow-edge-case.d.mts +79 -0
- package/resources/customer-flow-edge-case.d.mts.map +1 -1
- package/resources/customer-flow-edge-case.d.ts +79 -0
- package/resources/customer-flow-edge-case.d.ts.map +1 -1
- package/resources/customer-flow-edge-case.js +34 -0
- package/resources/customer-flow-edge-case.js.map +1 -1
- package/resources/customer-flow-edge-case.mjs +34 -0
- package/resources/customer-flow-edge-case.mjs.map +1 -1
- package/resources/customer-flow.d.mts +271 -615
- package/resources/customer-flow.d.mts.map +1 -1
- package/resources/customer-flow.d.ts +271 -615
- package/resources/customer-flow.d.ts.map +1 -1
- package/resources/customer-flow.js +42 -1
- package/resources/customer-flow.js.map +1 -1
- package/resources/customer-flow.mjs +42 -1
- package/resources/customer-flow.mjs.map +1 -1
- package/resources/health.d.mts +5 -0
- package/resources/health.d.mts.map +1 -1
- package/resources/health.d.ts +5 -0
- package/resources/health.d.ts.map +1 -1
- package/resources/health.js +5 -0
- package/resources/health.js.map +1 -1
- package/resources/health.mjs +5 -0
- package/resources/health.mjs.map +1 -1
- package/resources/http-request-definition.d.mts +29 -0
- package/resources/http-request-definition.d.mts.map +1 -1
- package/resources/http-request-definition.d.ts +29 -0
- package/resources/http-request-definition.d.ts.map +1 -1
- package/resources/http-request-definition.js +29 -0
- package/resources/http-request-definition.js.map +1 -1
- package/resources/http-request-definition.mjs +29 -0
- package/resources/http-request-definition.mjs.map +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/metric-collection-job.d.mts +23 -0
- package/resources/metric-collection-job.d.mts.map +1 -1
- package/resources/metric-collection-job.d.ts +23 -0
- package/resources/metric-collection-job.d.ts.map +1 -1
- package/resources/metric-collection-job.js +23 -0
- package/resources/metric-collection-job.js.map +1 -1
- package/resources/metric-collection-job.mjs +23 -0
- package/resources/metric-collection-job.mjs.map +1 -1
- package/resources/metric.d.mts +5 -7
- package/resources/metric.d.mts.map +1 -1
- package/resources/metric.d.ts +5 -7
- package/resources/metric.d.ts.map +1 -1
- package/resources/metric.js +5 -0
- package/resources/metric.js.map +1 -1
- package/resources/metric.mjs +5 -0
- package/resources/metric.mjs.map +1 -1
- package/resources/simulation-environment.d.mts +13 -0
- package/resources/simulation-environment.d.mts.map +1 -1
- package/resources/simulation-environment.d.ts +13 -0
- package/resources/simulation-environment.d.ts.map +1 -1
- package/resources/simulation-environment.js +13 -0
- package/resources/simulation-environment.js.map +1 -1
- package/resources/simulation-environment.mjs +13 -0
- package/resources/simulation-environment.mjs.map +1 -1
- package/resources/simulation-job.d.mts +14 -4
- package/resources/simulation-job.d.mts.map +1 -1
- package/resources/simulation-job.d.ts +14 -4
- package/resources/simulation-job.d.ts.map +1 -1
- package/resources/simulation-job.js +1 -1
- package/resources/simulation-job.js.map +1 -1
- package/resources/simulation-job.mjs +1 -1
- package/resources/simulation-job.mjs.map +1 -1
- package/resources/simulation-persona.d.mts +32 -3
- package/resources/simulation-persona.d.mts.map +1 -1
- package/resources/simulation-persona.d.ts +32 -3
- package/resources/simulation-persona.d.ts.map +1 -1
- package/resources/simulation-persona.js +2 -3
- package/resources/simulation-persona.js.map +1 -1
- package/resources/simulation-persona.mjs +2 -3
- package/resources/simulation-persona.mjs.map +1 -1
- package/resources/simulation-run-plan-job.d.mts +14 -2
- package/resources/simulation-run-plan-job.d.mts.map +1 -1
- package/resources/simulation-run-plan-job.d.ts +14 -2
- package/resources/simulation-run-plan-job.d.ts.map +1 -1
- package/resources/simulation-run-plan-job.js +7 -0
- package/resources/simulation-run-plan-job.js.map +1 -1
- package/resources/simulation-run-plan-job.mjs +7 -0
- package/resources/simulation-run-plan-job.mjs.map +1 -1
- package/resources/simulation.d.mts +2 -2
- package/resources/simulation.d.ts +2 -2
- package/resources/simulation.js +2 -2
- package/resources/simulation.mjs +2 -2
- package/resources/webhook.d.mts +23 -0
- package/resources/webhook.d.mts.map +1 -1
- package/resources/webhook.d.ts +23 -0
- package/resources/webhook.d.ts.map +1 -1
- package/resources/webhook.js +23 -0
- package/resources/webhook.js.map +1 -1
- package/resources/webhook.mjs +23 -0
- package/resources/webhook.mjs.map +1 -1
- package/src/client.ts +2 -0
- package/src/resources/agent-endpoint.ts +26 -0
- package/src/resources/agent.ts +20 -0
- package/src/resources/call.ts +39 -202
- package/src/resources/config.ts +123 -158
- package/src/resources/customer-flow-edge-case.ts +88 -0
- package/src/resources/customer-flow.ts +318 -1009
- package/src/resources/health.ts +5 -0
- package/src/resources/http-request-definition.ts +29 -0
- package/src/resources/index.ts +1 -0
- package/src/resources/metric-collection-job.ts +23 -0
- package/src/resources/metric.ts +5 -18
- package/src/resources/simulation-environment.ts +13 -0
- package/src/resources/simulation-job.ts +16 -4
- package/src/resources/simulation-persona.ts +38 -3
- package/src/resources/simulation-run-plan-job.ts +15 -2
- package/src/resources/simulation.ts +2 -2
- package/src/resources/webhook.ts +23 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -12,7 +12,7 @@ export declare class CustomerFlow extends APIResource {
|
|
|
12
12
|
* @example
|
|
13
13
|
* ```ts
|
|
14
14
|
* const customerFlow = await client.customerFlow.create({
|
|
15
|
-
* graph: [{ type: '
|
|
15
|
+
* graph: [{ type: 'AGENT_TURN' }],
|
|
16
16
|
* title: 'Reschedule an appointment',
|
|
17
17
|
* type: 'SCRIPTED',
|
|
18
18
|
* });
|
|
@@ -22,6 +22,13 @@ export declare class CustomerFlow extends APIResource {
|
|
|
22
22
|
/**
|
|
23
23
|
* Updates a flow's title, description, branching mode, linked agents or flow-level
|
|
24
24
|
* expectations. The step graph is replaced through PUT /graph.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const customerFlow = await client.customerFlow.update(
|
|
29
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
30
|
+
* );
|
|
31
|
+
* ```
|
|
25
32
|
*/
|
|
26
33
|
update(flowID: string, body?: CustomerFlowUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomerFlowUpdateResponse>;
|
|
27
34
|
/**
|
|
@@ -30,17 +37,36 @@ export declare class CustomerFlow extends APIResource {
|
|
|
30
37
|
* walks the project's whole step graph, so it comes back from the single-flow
|
|
31
38
|
* endpoint instead. Customer flows are how a project describes what to test; they
|
|
32
39
|
* replace the older simulation scenarios.
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```ts
|
|
43
|
+
* const customerFlows = await client.customerFlow.list();
|
|
44
|
+
* ```
|
|
33
45
|
*/
|
|
34
46
|
list(query?: CustomerFlowListParams | null | undefined, options?: RequestOptions): APIPromise<CustomerFlowListResponse>;
|
|
35
47
|
/**
|
|
36
48
|
* Soft-deletes a customer flow along with its edge cases, expectations and (for
|
|
37
49
|
* scripted flows) its step graph. Run plans that linked it drop it from their test
|
|
38
50
|
* cases.
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* const customerFlow = await client.customerFlow.delete(
|
|
55
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
56
|
+
* );
|
|
57
|
+
* ```
|
|
39
58
|
*/
|
|
40
59
|
delete(flowID: string, options?: RequestOptions): APIPromise<CustomerFlowDeleteResponse>;
|
|
41
60
|
/**
|
|
42
61
|
* Returns a customer flow with its happy path, edge cases, expectations and linked
|
|
43
62
|
* agents. Scripted flows also carry their step graph.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* const response = await client.customerFlow.getByID(
|
|
67
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
68
|
+
* );
|
|
69
|
+
* ```
|
|
44
70
|
*/
|
|
45
71
|
getByID(flowID: string, options?: RequestOptions): APIPromise<CustomerFlowGetByIDResponse>;
|
|
46
72
|
/**
|
|
@@ -55,6 +81,14 @@ export declare class CustomerFlow extends APIResource {
|
|
|
55
81
|
* A change to the set of paths re-seeds how the flow runs, which the response
|
|
56
82
|
* reports as `variantsReshaped` along with the resulting happy path and edge
|
|
57
83
|
* cases.
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const response = await client.customerFlow.replaceGraph(
|
|
88
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
89
|
+
* { graph: [{ type: 'AGENT_TURN' }] },
|
|
90
|
+
* );
|
|
91
|
+
* ```
|
|
58
92
|
*/
|
|
59
93
|
replaceGraph(flowID: string, body: CustomerFlowReplaceGraphParams, options?: RequestOptions): APIPromise<CustomerFlowReplaceGraphResponse>;
|
|
60
94
|
/**
|
|
@@ -64,6 +98,13 @@ export declare class CustomerFlow extends APIResource {
|
|
|
64
98
|
*
|
|
65
99
|
* Its persona and environment are what the edge cases inherit, so changing them
|
|
66
100
|
* here changes every edge case that does not name its own.
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```ts
|
|
104
|
+
* const response = await client.customerFlow.updateHappyPath(
|
|
105
|
+
* '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
|
|
106
|
+
* );
|
|
107
|
+
* ```
|
|
67
108
|
*/
|
|
68
109
|
updateHappyPath(flowID: string, body?: CustomerFlowUpdateHappyPathParams | null | undefined, options?: RequestOptions): APIPromise<CustomerFlowUpdateHappyPathResponse>;
|
|
69
110
|
}
|
|
@@ -312,6 +353,11 @@ export declare namespace CustomerFlowCreateResponse {
|
|
|
312
353
|
* optional variants
|
|
313
354
|
*/
|
|
314
355
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
356
|
+
/**
|
|
357
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
358
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
359
|
+
*/
|
|
360
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
315
361
|
/**
|
|
316
362
|
* Background noise setting
|
|
317
363
|
*/
|
|
@@ -493,6 +539,11 @@ export declare namespace CustomerFlowCreateResponse {
|
|
|
493
539
|
* optional variants
|
|
494
540
|
*/
|
|
495
541
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
542
|
+
/**
|
|
543
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
544
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
545
|
+
*/
|
|
546
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
496
547
|
/**
|
|
497
548
|
* Background noise setting
|
|
498
549
|
*/
|
|
@@ -742,6 +793,11 @@ export declare namespace CustomerFlowCreateResponse {
|
|
|
742
793
|
* optional variants
|
|
743
794
|
*/
|
|
744
795
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
796
|
+
/**
|
|
797
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
798
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
799
|
+
*/
|
|
800
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
745
801
|
/**
|
|
746
802
|
* Background noise setting
|
|
747
803
|
*/
|
|
@@ -921,6 +977,11 @@ export declare namespace CustomerFlowCreateResponse {
|
|
|
921
977
|
* optional variants
|
|
922
978
|
*/
|
|
923
979
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
980
|
+
/**
|
|
981
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
982
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
983
|
+
*/
|
|
984
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
924
985
|
/**
|
|
925
986
|
* Background noise setting
|
|
926
987
|
*/
|
|
@@ -1165,6 +1226,11 @@ export declare namespace CustomerFlowCreateResponse {
|
|
|
1165
1226
|
* optional variants
|
|
1166
1227
|
*/
|
|
1167
1228
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
1229
|
+
/**
|
|
1230
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
1231
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
1232
|
+
*/
|
|
1233
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
1168
1234
|
/**
|
|
1169
1235
|
* Background noise setting
|
|
1170
1236
|
*/
|
|
@@ -1340,6 +1406,11 @@ export declare namespace CustomerFlowCreateResponse {
|
|
|
1340
1406
|
* optional variants
|
|
1341
1407
|
*/
|
|
1342
1408
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
1409
|
+
/**
|
|
1410
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
1411
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
1412
|
+
*/
|
|
1413
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
1343
1414
|
/**
|
|
1344
1415
|
* Background noise setting
|
|
1345
1416
|
*/
|
|
@@ -1610,6 +1681,11 @@ export declare namespace CustomerFlowUpdateResponse {
|
|
|
1610
1681
|
* optional variants
|
|
1611
1682
|
*/
|
|
1612
1683
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
1684
|
+
/**
|
|
1685
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
1686
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
1687
|
+
*/
|
|
1688
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
1613
1689
|
/**
|
|
1614
1690
|
* Background noise setting
|
|
1615
1691
|
*/
|
|
@@ -1791,6 +1867,11 @@ export declare namespace CustomerFlowUpdateResponse {
|
|
|
1791
1867
|
* optional variants
|
|
1792
1868
|
*/
|
|
1793
1869
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
1870
|
+
/**
|
|
1871
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
1872
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
1873
|
+
*/
|
|
1874
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
1794
1875
|
/**
|
|
1795
1876
|
* Background noise setting
|
|
1796
1877
|
*/
|
|
@@ -2040,6 +2121,11 @@ export declare namespace CustomerFlowUpdateResponse {
|
|
|
2040
2121
|
* optional variants
|
|
2041
2122
|
*/
|
|
2042
2123
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
2124
|
+
/**
|
|
2125
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
2126
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
2127
|
+
*/
|
|
2128
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
2043
2129
|
/**
|
|
2044
2130
|
* Background noise setting
|
|
2045
2131
|
*/
|
|
@@ -2219,6 +2305,11 @@ export declare namespace CustomerFlowUpdateResponse {
|
|
|
2219
2305
|
* optional variants
|
|
2220
2306
|
*/
|
|
2221
2307
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
2308
|
+
/**
|
|
2309
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
2310
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
2311
|
+
*/
|
|
2312
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
2222
2313
|
/**
|
|
2223
2314
|
* Background noise setting
|
|
2224
2315
|
*/
|
|
@@ -2463,6 +2554,11 @@ export declare namespace CustomerFlowUpdateResponse {
|
|
|
2463
2554
|
* optional variants
|
|
2464
2555
|
*/
|
|
2465
2556
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
2557
|
+
/**
|
|
2558
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
2559
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
2560
|
+
*/
|
|
2561
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
2466
2562
|
/**
|
|
2467
2563
|
* Background noise setting
|
|
2468
2564
|
*/
|
|
@@ -2638,6 +2734,11 @@ export declare namespace CustomerFlowUpdateResponse {
|
|
|
2638
2734
|
* optional variants
|
|
2639
2735
|
*/
|
|
2640
2736
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
2737
|
+
/**
|
|
2738
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
2739
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
2740
|
+
*/
|
|
2741
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
2641
2742
|
/**
|
|
2642
2743
|
* Background noise setting
|
|
2643
2744
|
*/
|
|
@@ -2909,6 +3010,11 @@ export declare namespace CustomerFlowListResponse {
|
|
|
2909
3010
|
* optional variants
|
|
2910
3011
|
*/
|
|
2911
3012
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
3013
|
+
/**
|
|
3014
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
3015
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
3016
|
+
*/
|
|
3017
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
2912
3018
|
/**
|
|
2913
3019
|
* Background noise setting
|
|
2914
3020
|
*/
|
|
@@ -3090,6 +3196,11 @@ export declare namespace CustomerFlowListResponse {
|
|
|
3090
3196
|
* optional variants
|
|
3091
3197
|
*/
|
|
3092
3198
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
3199
|
+
/**
|
|
3200
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
3201
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
3202
|
+
*/
|
|
3203
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
3093
3204
|
/**
|
|
3094
3205
|
* Background noise setting
|
|
3095
3206
|
*/
|
|
@@ -3339,6 +3450,11 @@ export declare namespace CustomerFlowListResponse {
|
|
|
3339
3450
|
* optional variants
|
|
3340
3451
|
*/
|
|
3341
3452
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
3453
|
+
/**
|
|
3454
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
3455
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
3456
|
+
*/
|
|
3457
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
3342
3458
|
/**
|
|
3343
3459
|
* Background noise setting
|
|
3344
3460
|
*/
|
|
@@ -3518,6 +3634,11 @@ export declare namespace CustomerFlowListResponse {
|
|
|
3518
3634
|
* optional variants
|
|
3519
3635
|
*/
|
|
3520
3636
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
3637
|
+
/**
|
|
3638
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
3639
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
3640
|
+
*/
|
|
3641
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
3521
3642
|
/**
|
|
3522
3643
|
* Background noise setting
|
|
3523
3644
|
*/
|
|
@@ -3762,6 +3883,11 @@ export declare namespace CustomerFlowListResponse {
|
|
|
3762
3883
|
* optional variants
|
|
3763
3884
|
*/
|
|
3764
3885
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
3886
|
+
/**
|
|
3887
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
3888
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
3889
|
+
*/
|
|
3890
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
3765
3891
|
/**
|
|
3766
3892
|
* Background noise setting
|
|
3767
3893
|
*/
|
|
@@ -3937,6 +4063,11 @@ export declare namespace CustomerFlowListResponse {
|
|
|
3937
4063
|
* optional variants
|
|
3938
4064
|
*/
|
|
3939
4065
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
4066
|
+
/**
|
|
4067
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
4068
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
4069
|
+
*/
|
|
4070
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
3940
4071
|
/**
|
|
3941
4072
|
* Background noise setting
|
|
3942
4073
|
*/
|
|
@@ -4232,6 +4363,11 @@ export declare namespace CustomerFlowGetByIDResponse {
|
|
|
4232
4363
|
* optional variants
|
|
4233
4364
|
*/
|
|
4234
4365
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
4366
|
+
/**
|
|
4367
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
4368
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
4369
|
+
*/
|
|
4370
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
4235
4371
|
/**
|
|
4236
4372
|
* Background noise setting
|
|
4237
4373
|
*/
|
|
@@ -4413,6 +4549,11 @@ export declare namespace CustomerFlowGetByIDResponse {
|
|
|
4413
4549
|
* optional variants
|
|
4414
4550
|
*/
|
|
4415
4551
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
4552
|
+
/**
|
|
4553
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
4554
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
4555
|
+
*/
|
|
4556
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
4416
4557
|
/**
|
|
4417
4558
|
* Background noise setting
|
|
4418
4559
|
*/
|
|
@@ -4662,6 +4803,11 @@ export declare namespace CustomerFlowGetByIDResponse {
|
|
|
4662
4803
|
* optional variants
|
|
4663
4804
|
*/
|
|
4664
4805
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
4806
|
+
/**
|
|
4807
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
4808
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
4809
|
+
*/
|
|
4810
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
4665
4811
|
/**
|
|
4666
4812
|
* Background noise setting
|
|
4667
4813
|
*/
|
|
@@ -4841,6 +4987,11 @@ export declare namespace CustomerFlowGetByIDResponse {
|
|
|
4841
4987
|
* optional variants
|
|
4842
4988
|
*/
|
|
4843
4989
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
4990
|
+
/**
|
|
4991
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
4992
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
4993
|
+
*/
|
|
4994
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
4844
4995
|
/**
|
|
4845
4996
|
* Background noise setting
|
|
4846
4997
|
*/
|
|
@@ -5085,6 +5236,11 @@ export declare namespace CustomerFlowGetByIDResponse {
|
|
|
5085
5236
|
* optional variants
|
|
5086
5237
|
*/
|
|
5087
5238
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
5239
|
+
/**
|
|
5240
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
5241
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
5242
|
+
*/
|
|
5243
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
5088
5244
|
/**
|
|
5089
5245
|
* Background noise setting
|
|
5090
5246
|
*/
|
|
@@ -5260,6 +5416,11 @@ export declare namespace CustomerFlowGetByIDResponse {
|
|
|
5260
5416
|
* optional variants
|
|
5261
5417
|
*/
|
|
5262
5418
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
5419
|
+
/**
|
|
5420
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
5421
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
5422
|
+
*/
|
|
5423
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
5263
5424
|
/**
|
|
5264
5425
|
* Background noise setting
|
|
5265
5426
|
*/
|
|
@@ -5465,6 +5626,11 @@ export declare namespace CustomerFlowReplaceGraphResponse {
|
|
|
5465
5626
|
* optional variants
|
|
5466
5627
|
*/
|
|
5467
5628
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
5629
|
+
/**
|
|
5630
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
5631
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
5632
|
+
*/
|
|
5633
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
5468
5634
|
/**
|
|
5469
5635
|
* Background noise setting
|
|
5470
5636
|
*/
|
|
@@ -5644,6 +5810,11 @@ export declare namespace CustomerFlowReplaceGraphResponse {
|
|
|
5644
5810
|
* optional variants
|
|
5645
5811
|
*/
|
|
5646
5812
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
5813
|
+
/**
|
|
5814
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
5815
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
5816
|
+
*/
|
|
5817
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
5647
5818
|
/**
|
|
5648
5819
|
* Background noise setting
|
|
5649
5820
|
*/
|
|
@@ -5819,6 +5990,11 @@ export declare namespace CustomerFlowReplaceGraphResponse {
|
|
|
5819
5990
|
* optional variants
|
|
5820
5991
|
*/
|
|
5821
5992
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
5993
|
+
/**
|
|
5994
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
5995
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
5996
|
+
*/
|
|
5997
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
5822
5998
|
/**
|
|
5823
5999
|
* Background noise setting
|
|
5824
6000
|
*/
|
|
@@ -5918,642 +6094,112 @@ export declare namespace CustomerFlowReplaceGraphResponse {
|
|
|
5918
6094
|
secondaryLanguage?: 'EN' | null;
|
|
5919
6095
|
}
|
|
5920
6096
|
}
|
|
6097
|
+
}
|
|
6098
|
+
}
|
|
6099
|
+
export interface CustomerFlowUpdateHappyPathResponse {
|
|
6100
|
+
/**
|
|
6101
|
+
* One way of running a customer flow.
|
|
6102
|
+
*/
|
|
6103
|
+
data: CustomerFlowUpdateHappyPathResponse.ScriptedFlowVariant | CustomerFlowUpdateHappyPathResponse.ImprovFlowVariant | CustomerFlowUpdateHappyPathResponse.VoicemailFlowVariant;
|
|
6104
|
+
}
|
|
6105
|
+
export declare namespace CustomerFlowUpdateHappyPathResponse {
|
|
6106
|
+
/**
|
|
6107
|
+
* One path through a scripted flow. The path engine owns which paths exist, so
|
|
6108
|
+
* editing the graph is what creates and removes these.
|
|
6109
|
+
*/
|
|
6110
|
+
interface ScriptedFlowVariant {
|
|
6111
|
+
id: string;
|
|
5921
6112
|
/**
|
|
5922
|
-
*
|
|
5923
|
-
* editing the graph is what creates and removes these.
|
|
6113
|
+
* Graded on top of the flow's own expectations, for this variant only.
|
|
5924
6114
|
*/
|
|
5925
|
-
|
|
6115
|
+
additionalExpectations: Array<ScriptedFlowVariant.AdditionalExpectation>;
|
|
6116
|
+
/**
|
|
6117
|
+
* Creation timestamp in ISO 8601 format
|
|
6118
|
+
*/
|
|
6119
|
+
createdAt: string;
|
|
6120
|
+
/**
|
|
6121
|
+
* A simulation environment: the ambient conditions a customer flow variant runs
|
|
6122
|
+
* under. The list includes both your own and the ones Roark curates for every
|
|
6123
|
+
* project.
|
|
6124
|
+
*/
|
|
6125
|
+
environment: ScriptedFlowVariant.Environment | null;
|
|
6126
|
+
isGenerated: boolean;
|
|
6127
|
+
/**
|
|
6128
|
+
* The persona this runs as instead of the happy path's. Null means it inherits.
|
|
6129
|
+
*/
|
|
6130
|
+
personaOverride: ScriptedFlowVariant.PersonaOverride | null;
|
|
6131
|
+
precededByCustomerFlowId: string | null;
|
|
6132
|
+
precededByCustomerFlowVariantId: string | null;
|
|
6133
|
+
/**
|
|
6134
|
+
* The one path through the graph this variant runs, in order. Linear by
|
|
6135
|
+
* construction, so these steps never nest.
|
|
6136
|
+
*/
|
|
6137
|
+
steps: Array<CustomerFlowAPI.FlowStep>;
|
|
6138
|
+
title: string;
|
|
6139
|
+
type: 'SCRIPTED';
|
|
6140
|
+
/**
|
|
6141
|
+
* Last update timestamp in ISO 8601 format
|
|
6142
|
+
*/
|
|
6143
|
+
updatedAt: string;
|
|
6144
|
+
}
|
|
6145
|
+
namespace ScriptedFlowVariant {
|
|
6146
|
+
/**
|
|
6147
|
+
* One thing the agent under test is graded against.
|
|
6148
|
+
*/
|
|
6149
|
+
interface AdditionalExpectation {
|
|
5926
6150
|
id: string;
|
|
5927
6151
|
/**
|
|
5928
|
-
*
|
|
6152
|
+
* What the agent under test is graded against.
|
|
5929
6153
|
*/
|
|
5930
|
-
|
|
6154
|
+
prompt: string;
|
|
6155
|
+
}
|
|
6156
|
+
/**
|
|
6157
|
+
* A simulation environment: the ambient conditions a customer flow variant runs
|
|
6158
|
+
* under. The list includes both your own and the ones Roark curates for every
|
|
6159
|
+
* project.
|
|
6160
|
+
*/
|
|
6161
|
+
interface Environment {
|
|
6162
|
+
id: string;
|
|
6163
|
+
backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
|
|
5931
6164
|
/**
|
|
5932
6165
|
* Creation timestamp in ISO 8601 format
|
|
5933
6166
|
*/
|
|
5934
6167
|
createdAt: string;
|
|
6168
|
+
name: string;
|
|
5935
6169
|
/**
|
|
5936
|
-
*
|
|
5937
|
-
* under. The list includes both your own and the ones Roark curates for every
|
|
5938
|
-
* project.
|
|
6170
|
+
* Last update timestamp in ISO 8601 format
|
|
5939
6171
|
*/
|
|
5940
|
-
|
|
5941
|
-
|
|
6172
|
+
updatedAt: string;
|
|
6173
|
+
description?: string | null;
|
|
6174
|
+
}
|
|
6175
|
+
/**
|
|
6176
|
+
* The persona this runs as instead of the happy path's. Null means it inherits.
|
|
6177
|
+
*/
|
|
6178
|
+
interface PersonaOverride {
|
|
5942
6179
|
/**
|
|
5943
|
-
*
|
|
6180
|
+
* Unique identifier of the persona
|
|
5944
6181
|
*/
|
|
5945
|
-
|
|
5946
|
-
precededByCustomerFlowId: string | null;
|
|
5947
|
-
precededByCustomerFlowVariantId: string | null;
|
|
6182
|
+
id: string;
|
|
5948
6183
|
/**
|
|
5949
|
-
*
|
|
5950
|
-
*
|
|
6184
|
+
* Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
|
|
6185
|
+
* optional variants
|
|
5951
6186
|
*/
|
|
5952
|
-
|
|
5953
|
-
title: string;
|
|
5954
|
-
type: 'SCRIPTED';
|
|
6187
|
+
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
5955
6188
|
/**
|
|
5956
|
-
*
|
|
6189
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
6190
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
5957
6191
|
*/
|
|
5958
|
-
|
|
5959
|
-
}
|
|
5960
|
-
namespace ScriptedFlowVariant {
|
|
6192
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
5961
6193
|
/**
|
|
5962
|
-
*
|
|
6194
|
+
* Background noise setting
|
|
5963
6195
|
*/
|
|
5964
|
-
|
|
5965
|
-
id: string;
|
|
5966
|
-
/**
|
|
5967
|
-
* What the agent under test is graded against.
|
|
5968
|
-
*/
|
|
5969
|
-
prompt: string;
|
|
5970
|
-
}
|
|
6196
|
+
backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
|
|
5971
6197
|
/**
|
|
5972
|
-
*
|
|
5973
|
-
* under. The list includes both your own and the ones Roark curates for every
|
|
5974
|
-
* project.
|
|
6198
|
+
* Base emotional state of the persona
|
|
5975
6199
|
*/
|
|
5976
|
-
|
|
5977
|
-
id: string;
|
|
5978
|
-
backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
|
|
5979
|
-
/**
|
|
5980
|
-
* Creation timestamp in ISO 8601 format
|
|
5981
|
-
*/
|
|
5982
|
-
createdAt: string;
|
|
5983
|
-
name: string;
|
|
5984
|
-
/**
|
|
5985
|
-
* Last update timestamp in ISO 8601 format
|
|
5986
|
-
*/
|
|
5987
|
-
updatedAt: string;
|
|
5988
|
-
description?: string | null;
|
|
5989
|
-
}
|
|
6200
|
+
baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
|
|
5990
6201
|
/**
|
|
5991
|
-
*
|
|
5992
|
-
*/
|
|
5993
|
-
interface PersonaOverride {
|
|
5994
|
-
/**
|
|
5995
|
-
* Unique identifier of the persona
|
|
5996
|
-
*/
|
|
5997
|
-
id: string;
|
|
5998
|
-
/**
|
|
5999
|
-
* Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
|
|
6000
|
-
* optional variants
|
|
6001
|
-
*/
|
|
6002
|
-
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
6003
|
-
/**
|
|
6004
|
-
* Background noise setting
|
|
6005
|
-
*/
|
|
6006
|
-
backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
|
|
6007
|
-
/**
|
|
6008
|
-
* Base emotional state of the persona
|
|
6009
|
-
*/
|
|
6010
|
-
baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
|
|
6011
|
-
/**
|
|
6012
|
-
* How the persona confirms information
|
|
6013
|
-
*/
|
|
6014
|
-
confirmationStyle: 'EXPLICIT' | 'VAGUE';
|
|
6015
|
-
/**
|
|
6016
|
-
* Creation timestamp
|
|
6017
|
-
*/
|
|
6018
|
-
createdAt: string;
|
|
6019
|
-
/**
|
|
6020
|
-
* Gender of the persona
|
|
6021
|
-
*/
|
|
6022
|
-
gender: 'MALE' | 'FEMALE';
|
|
6023
|
-
/**
|
|
6024
|
-
* Whether the persona uses filler words like "um" and "uh"
|
|
6025
|
-
*/
|
|
6026
|
-
hasDisfluencies: boolean;
|
|
6027
|
-
/**
|
|
6028
|
-
* Maximum number of idle messages the persona will send before giving up
|
|
6029
|
-
*/
|
|
6030
|
-
idleMessageMaxSpokenCount: number;
|
|
6031
|
-
/**
|
|
6032
|
-
* Whether the idle message counter resets when the agent speaks
|
|
6033
|
-
*/
|
|
6034
|
-
idleMessageResetCountOnUserSpeechEnabled: boolean;
|
|
6035
|
-
/**
|
|
6036
|
-
* Messages the persona will say when the agent goes silent during a call. null =
|
|
6037
|
-
* "Automatic": language-appropriate defaults are used at call time.
|
|
6038
|
-
*/
|
|
6039
|
-
idleMessages: Array<string> | null;
|
|
6040
|
-
/**
|
|
6041
|
-
* Seconds of silence before the persona sends an idle message
|
|
6042
|
-
*/
|
|
6043
|
-
idleTimeoutSeconds: number;
|
|
6044
|
-
/**
|
|
6045
|
-
* How clearly the persona expresses their intentions
|
|
6046
|
-
*/
|
|
6047
|
-
intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
|
|
6048
|
-
/**
|
|
6049
|
-
* Primary language ISO 639-1 code for the persona
|
|
6050
|
-
*/
|
|
6051
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA' | 'TL' | 'MS' | 'ZH' | 'TR' | 'PT' | 'HE';
|
|
6052
|
-
/**
|
|
6053
|
-
* How reliable the persona's memory is
|
|
6054
|
-
*/
|
|
6055
|
-
memoryReliability: 'HIGH' | 'LOW';
|
|
6056
|
-
/**
|
|
6057
|
-
* The name the agent will identify as during conversations
|
|
6058
|
-
*/
|
|
6059
|
-
name: string;
|
|
6060
|
-
/**
|
|
6061
|
-
* Additional custom properties about the persona
|
|
6062
|
-
*/
|
|
6063
|
-
properties: {
|
|
6064
|
-
[key: string]: unknown;
|
|
6065
|
-
};
|
|
6066
|
-
/**
|
|
6067
|
-
* Controls how quickly the persona responds to pauses in conversation (QUICK,
|
|
6068
|
-
* NORMAL, RELAXED)
|
|
6069
|
-
*/
|
|
6070
|
-
responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
|
|
6071
|
-
/**
|
|
6072
|
-
* Speech clarity of the persona
|
|
6073
|
-
*/
|
|
6074
|
-
speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
|
|
6075
|
-
/**
|
|
6076
|
-
* Speech pace of the persona
|
|
6077
|
-
*/
|
|
6078
|
-
speechPace: 'SUPER_SLOW' | 'SLOW' | 'NORMAL' | 'FAST' | 'SUPER_FAST';
|
|
6079
|
-
/**
|
|
6080
|
-
* Languages the persona can understand. Multilingual combinations are limited by
|
|
6081
|
-
* multilingual speech recognition support.
|
|
6082
|
-
*/
|
|
6083
|
-
understoodLanguages: Array<'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA' | 'TL' | 'MS' | 'ZH' | 'TR' | 'PT' | 'HE'>;
|
|
6084
|
-
/**
|
|
6085
|
-
* Last update timestamp
|
|
6086
|
-
*/
|
|
6087
|
-
updatedAt: string;
|
|
6088
|
-
/**
|
|
6089
|
-
* Background story and behavioral patterns for the persona
|
|
6090
|
-
*/
|
|
6091
|
-
backstoryPrompt?: string | null;
|
|
6092
|
-
/**
|
|
6093
|
-
* Human-readable description of the persona
|
|
6094
|
-
*/
|
|
6095
|
-
description?: string | null;
|
|
6096
|
-
/**
|
|
6097
|
-
* Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
|
|
6098
|
-
*/
|
|
6099
|
-
secondaryLanguage?: 'EN' | null;
|
|
6100
|
-
}
|
|
6101
|
-
}
|
|
6102
|
-
/**
|
|
6103
|
-
* One brief to run an improv flow with.
|
|
6104
|
-
*/
|
|
6105
|
-
interface ImprovFlowVariant {
|
|
6106
|
-
id: string;
|
|
6107
|
-
/**
|
|
6108
|
-
* Graded on top of the flow's own expectations, for this variant only.
|
|
6109
|
-
*/
|
|
6110
|
-
additionalExpectations: Array<ImprovFlowVariant.AdditionalExpectation>;
|
|
6111
|
-
/**
|
|
6112
|
-
* Creation timestamp in ISO 8601 format
|
|
6113
|
-
*/
|
|
6114
|
-
createdAt: string;
|
|
6115
|
-
/**
|
|
6116
|
-
* A simulation environment: the ambient conditions a customer flow variant runs
|
|
6117
|
-
* under. The list includes both your own and the ones Roark curates for every
|
|
6118
|
-
* project.
|
|
6119
|
-
*/
|
|
6120
|
-
environment: ImprovFlowVariant.Environment | null;
|
|
6121
|
-
isGenerated: boolean;
|
|
6122
|
-
/**
|
|
6123
|
-
* The persona this runs as instead of the happy path's. Null means it inherits.
|
|
6124
|
-
*/
|
|
6125
|
-
personaOverride: ImprovFlowVariant.PersonaOverride | null;
|
|
6126
|
-
precededByCustomerFlowId: string | null;
|
|
6127
|
-
precededByCustomerFlowVariantId: string | null;
|
|
6128
|
-
title: string;
|
|
6129
|
-
type: 'IMPROV';
|
|
6130
|
-
/**
|
|
6131
|
-
* Last update timestamp in ISO 8601 format
|
|
6132
|
-
*/
|
|
6133
|
-
updatedAt: string;
|
|
6134
|
-
/**
|
|
6135
|
-
* The brief the simulated customer improvises from.
|
|
6136
|
-
*/
|
|
6137
|
-
prompt?: string | null;
|
|
6138
|
-
}
|
|
6139
|
-
namespace ImprovFlowVariant {
|
|
6140
|
-
/**
|
|
6141
|
-
* One thing the agent under test is graded against.
|
|
6142
|
-
*/
|
|
6143
|
-
interface AdditionalExpectation {
|
|
6144
|
-
id: string;
|
|
6145
|
-
/**
|
|
6146
|
-
* What the agent under test is graded against.
|
|
6147
|
-
*/
|
|
6148
|
-
prompt: string;
|
|
6149
|
-
}
|
|
6150
|
-
/**
|
|
6151
|
-
* A simulation environment: the ambient conditions a customer flow variant runs
|
|
6152
|
-
* under. The list includes both your own and the ones Roark curates for every
|
|
6153
|
-
* project.
|
|
6154
|
-
*/
|
|
6155
|
-
interface Environment {
|
|
6156
|
-
id: string;
|
|
6157
|
-
backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
|
|
6158
|
-
/**
|
|
6159
|
-
* Creation timestamp in ISO 8601 format
|
|
6160
|
-
*/
|
|
6161
|
-
createdAt: string;
|
|
6162
|
-
name: string;
|
|
6163
|
-
/**
|
|
6164
|
-
* Last update timestamp in ISO 8601 format
|
|
6165
|
-
*/
|
|
6166
|
-
updatedAt: string;
|
|
6167
|
-
description?: string | null;
|
|
6168
|
-
}
|
|
6169
|
-
/**
|
|
6170
|
-
* The persona this runs as instead of the happy path's. Null means it inherits.
|
|
6171
|
-
*/
|
|
6172
|
-
interface PersonaOverride {
|
|
6173
|
-
/**
|
|
6174
|
-
* Unique identifier of the persona
|
|
6175
|
-
*/
|
|
6176
|
-
id: string;
|
|
6177
|
-
/**
|
|
6178
|
-
* Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
|
|
6179
|
-
* optional variants
|
|
6180
|
-
*/
|
|
6181
|
-
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
6182
|
-
/**
|
|
6183
|
-
* Background noise setting
|
|
6184
|
-
*/
|
|
6185
|
-
backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
|
|
6186
|
-
/**
|
|
6187
|
-
* Base emotional state of the persona
|
|
6188
|
-
*/
|
|
6189
|
-
baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
|
|
6190
|
-
/**
|
|
6191
|
-
* How the persona confirms information
|
|
6192
|
-
*/
|
|
6193
|
-
confirmationStyle: 'EXPLICIT' | 'VAGUE';
|
|
6194
|
-
/**
|
|
6195
|
-
* Creation timestamp
|
|
6196
|
-
*/
|
|
6197
|
-
createdAt: string;
|
|
6198
|
-
/**
|
|
6199
|
-
* Gender of the persona
|
|
6200
|
-
*/
|
|
6201
|
-
gender: 'MALE' | 'FEMALE';
|
|
6202
|
-
/**
|
|
6203
|
-
* Whether the persona uses filler words like "um" and "uh"
|
|
6204
|
-
*/
|
|
6205
|
-
hasDisfluencies: boolean;
|
|
6206
|
-
/**
|
|
6207
|
-
* Maximum number of idle messages the persona will send before giving up
|
|
6208
|
-
*/
|
|
6209
|
-
idleMessageMaxSpokenCount: number;
|
|
6210
|
-
/**
|
|
6211
|
-
* Whether the idle message counter resets when the agent speaks
|
|
6212
|
-
*/
|
|
6213
|
-
idleMessageResetCountOnUserSpeechEnabled: boolean;
|
|
6214
|
-
/**
|
|
6215
|
-
* Messages the persona will say when the agent goes silent during a call. null =
|
|
6216
|
-
* "Automatic": language-appropriate defaults are used at call time.
|
|
6217
|
-
*/
|
|
6218
|
-
idleMessages: Array<string> | null;
|
|
6219
|
-
/**
|
|
6220
|
-
* Seconds of silence before the persona sends an idle message
|
|
6221
|
-
*/
|
|
6222
|
-
idleTimeoutSeconds: number;
|
|
6223
|
-
/**
|
|
6224
|
-
* How clearly the persona expresses their intentions
|
|
6225
|
-
*/
|
|
6226
|
-
intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
|
|
6227
|
-
/**
|
|
6228
|
-
* Primary language ISO 639-1 code for the persona
|
|
6229
|
-
*/
|
|
6230
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA' | 'TL' | 'MS' | 'ZH' | 'TR' | 'PT' | 'HE';
|
|
6231
|
-
/**
|
|
6232
|
-
* How reliable the persona's memory is
|
|
6233
|
-
*/
|
|
6234
|
-
memoryReliability: 'HIGH' | 'LOW';
|
|
6235
|
-
/**
|
|
6236
|
-
* The name the agent will identify as during conversations
|
|
6237
|
-
*/
|
|
6238
|
-
name: string;
|
|
6239
|
-
/**
|
|
6240
|
-
* Additional custom properties about the persona
|
|
6241
|
-
*/
|
|
6242
|
-
properties: {
|
|
6243
|
-
[key: string]: unknown;
|
|
6244
|
-
};
|
|
6245
|
-
/**
|
|
6246
|
-
* Controls how quickly the persona responds to pauses in conversation (QUICK,
|
|
6247
|
-
* NORMAL, RELAXED)
|
|
6248
|
-
*/
|
|
6249
|
-
responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
|
|
6250
|
-
/**
|
|
6251
|
-
* Speech clarity of the persona
|
|
6252
|
-
*/
|
|
6253
|
-
speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
|
|
6254
|
-
/**
|
|
6255
|
-
* Speech pace of the persona
|
|
6256
|
-
*/
|
|
6257
|
-
speechPace: 'SUPER_SLOW' | 'SLOW' | 'NORMAL' | 'FAST' | 'SUPER_FAST';
|
|
6258
|
-
/**
|
|
6259
|
-
* Languages the persona can understand. Multilingual combinations are limited by
|
|
6260
|
-
* multilingual speech recognition support.
|
|
6261
|
-
*/
|
|
6262
|
-
understoodLanguages: Array<'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA' | 'TL' | 'MS' | 'ZH' | 'TR' | 'PT' | 'HE'>;
|
|
6263
|
-
/**
|
|
6264
|
-
* Last update timestamp
|
|
6265
|
-
*/
|
|
6266
|
-
updatedAt: string;
|
|
6267
|
-
/**
|
|
6268
|
-
* Background story and behavioral patterns for the persona
|
|
6269
|
-
*/
|
|
6270
|
-
backstoryPrompt?: string | null;
|
|
6271
|
-
/**
|
|
6272
|
-
* Human-readable description of the persona
|
|
6273
|
-
*/
|
|
6274
|
-
description?: string | null;
|
|
6275
|
-
/**
|
|
6276
|
-
* Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
|
|
6277
|
-
*/
|
|
6278
|
-
secondaryLanguage?: 'EN' | null;
|
|
6279
|
-
}
|
|
6280
|
-
}
|
|
6281
|
-
/**
|
|
6282
|
-
* One voicemail greeting.
|
|
6283
|
-
*/
|
|
6284
|
-
interface VoicemailFlowVariant {
|
|
6285
|
-
id: string;
|
|
6286
|
-
/**
|
|
6287
|
-
* Graded on top of the flow's own expectations, for this variant only.
|
|
6288
|
-
*/
|
|
6289
|
-
additionalExpectations: Array<VoicemailFlowVariant.AdditionalExpectation>;
|
|
6290
|
-
/**
|
|
6291
|
-
* Creation timestamp in ISO 8601 format
|
|
6292
|
-
*/
|
|
6293
|
-
createdAt: string;
|
|
6294
|
-
/**
|
|
6295
|
-
* A simulation environment: the ambient conditions a customer flow variant runs
|
|
6296
|
-
* under. The list includes both your own and the ones Roark curates for every
|
|
6297
|
-
* project.
|
|
6298
|
-
*/
|
|
6299
|
-
environment: VoicemailFlowVariant.Environment | null;
|
|
6300
|
-
isGenerated: boolean;
|
|
6301
|
-
/**
|
|
6302
|
-
* The persona this runs as instead of the happy path's. Null means it inherits.
|
|
6303
|
-
*/
|
|
6304
|
-
personaOverride: VoicemailFlowVariant.PersonaOverride | null;
|
|
6305
|
-
precededByCustomerFlowId: string | null;
|
|
6306
|
-
precededByCustomerFlowVariantId: string | null;
|
|
6307
|
-
title: string;
|
|
6308
|
-
type: 'VOICEMAIL';
|
|
6309
|
-
/**
|
|
6310
|
-
* Last update timestamp in ISO 8601 format
|
|
6311
|
-
*/
|
|
6312
|
-
updatedAt: string;
|
|
6313
|
-
}
|
|
6314
|
-
namespace VoicemailFlowVariant {
|
|
6315
|
-
/**
|
|
6316
|
-
* One thing the agent under test is graded against.
|
|
6317
|
-
*/
|
|
6318
|
-
interface AdditionalExpectation {
|
|
6319
|
-
id: string;
|
|
6320
|
-
/**
|
|
6321
|
-
* What the agent under test is graded against.
|
|
6322
|
-
*/
|
|
6323
|
-
prompt: string;
|
|
6324
|
-
}
|
|
6325
|
-
/**
|
|
6326
|
-
* A simulation environment: the ambient conditions a customer flow variant runs
|
|
6327
|
-
* under. The list includes both your own and the ones Roark curates for every
|
|
6328
|
-
* project.
|
|
6329
|
-
*/
|
|
6330
|
-
interface Environment {
|
|
6331
|
-
id: string;
|
|
6332
|
-
backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
|
|
6333
|
-
/**
|
|
6334
|
-
* Creation timestamp in ISO 8601 format
|
|
6335
|
-
*/
|
|
6336
|
-
createdAt: string;
|
|
6337
|
-
name: string;
|
|
6338
|
-
/**
|
|
6339
|
-
* Last update timestamp in ISO 8601 format
|
|
6340
|
-
*/
|
|
6341
|
-
updatedAt: string;
|
|
6342
|
-
description?: string | null;
|
|
6343
|
-
}
|
|
6344
|
-
/**
|
|
6345
|
-
* The persona this runs as instead of the happy path's. Null means it inherits.
|
|
6346
|
-
*/
|
|
6347
|
-
interface PersonaOverride {
|
|
6348
|
-
/**
|
|
6349
|
-
* Unique identifier of the persona
|
|
6350
|
-
*/
|
|
6351
|
-
id: string;
|
|
6352
|
-
/**
|
|
6353
|
-
* Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
|
|
6354
|
-
* optional variants
|
|
6355
|
-
*/
|
|
6356
|
-
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
6357
|
-
/**
|
|
6358
|
-
* Background noise setting
|
|
6359
|
-
*/
|
|
6360
|
-
backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
|
|
6361
|
-
/**
|
|
6362
|
-
* Base emotional state of the persona
|
|
6363
|
-
*/
|
|
6364
|
-
baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
|
|
6365
|
-
/**
|
|
6366
|
-
* How the persona confirms information
|
|
6367
|
-
*/
|
|
6368
|
-
confirmationStyle: 'EXPLICIT' | 'VAGUE';
|
|
6369
|
-
/**
|
|
6370
|
-
* Creation timestamp
|
|
6371
|
-
*/
|
|
6372
|
-
createdAt: string;
|
|
6373
|
-
/**
|
|
6374
|
-
* Gender of the persona
|
|
6375
|
-
*/
|
|
6376
|
-
gender: 'MALE' | 'FEMALE';
|
|
6377
|
-
/**
|
|
6378
|
-
* Whether the persona uses filler words like "um" and "uh"
|
|
6379
|
-
*/
|
|
6380
|
-
hasDisfluencies: boolean;
|
|
6381
|
-
/**
|
|
6382
|
-
* Maximum number of idle messages the persona will send before giving up
|
|
6383
|
-
*/
|
|
6384
|
-
idleMessageMaxSpokenCount: number;
|
|
6385
|
-
/**
|
|
6386
|
-
* Whether the idle message counter resets when the agent speaks
|
|
6387
|
-
*/
|
|
6388
|
-
idleMessageResetCountOnUserSpeechEnabled: boolean;
|
|
6389
|
-
/**
|
|
6390
|
-
* Messages the persona will say when the agent goes silent during a call. null =
|
|
6391
|
-
* "Automatic": language-appropriate defaults are used at call time.
|
|
6392
|
-
*/
|
|
6393
|
-
idleMessages: Array<string> | null;
|
|
6394
|
-
/**
|
|
6395
|
-
* Seconds of silence before the persona sends an idle message
|
|
6396
|
-
*/
|
|
6397
|
-
idleTimeoutSeconds: number;
|
|
6398
|
-
/**
|
|
6399
|
-
* How clearly the persona expresses their intentions
|
|
6400
|
-
*/
|
|
6401
|
-
intentClarity: 'CLEAR' | 'INDIRECT' | 'VAGUE';
|
|
6402
|
-
/**
|
|
6403
|
-
* Primary language ISO 639-1 code for the persona
|
|
6404
|
-
*/
|
|
6405
|
-
language: 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA' | 'TL' | 'MS' | 'ZH' | 'TR' | 'PT' | 'HE';
|
|
6406
|
-
/**
|
|
6407
|
-
* How reliable the persona's memory is
|
|
6408
|
-
*/
|
|
6409
|
-
memoryReliability: 'HIGH' | 'LOW';
|
|
6410
|
-
/**
|
|
6411
|
-
* The name the agent will identify as during conversations
|
|
6412
|
-
*/
|
|
6413
|
-
name: string;
|
|
6414
|
-
/**
|
|
6415
|
-
* Additional custom properties about the persona
|
|
6416
|
-
*/
|
|
6417
|
-
properties: {
|
|
6418
|
-
[key: string]: unknown;
|
|
6419
|
-
};
|
|
6420
|
-
/**
|
|
6421
|
-
* Controls how quickly the persona responds to pauses in conversation (QUICK,
|
|
6422
|
-
* NORMAL, RELAXED)
|
|
6423
|
-
*/
|
|
6424
|
-
responseTiming: 'RELAXED' | 'NORMAL' | 'QUICK';
|
|
6425
|
-
/**
|
|
6426
|
-
* Speech clarity of the persona
|
|
6427
|
-
*/
|
|
6428
|
-
speechClarity: 'CLEAR' | 'VAGUE' | 'RAMBLING';
|
|
6429
|
-
/**
|
|
6430
|
-
* Speech pace of the persona
|
|
6431
|
-
*/
|
|
6432
|
-
speechPace: 'SUPER_SLOW' | 'SLOW' | 'NORMAL' | 'FAST' | 'SUPER_FAST';
|
|
6433
|
-
/**
|
|
6434
|
-
* Languages the persona can understand. Multilingual combinations are limited by
|
|
6435
|
-
* multilingual speech recognition support.
|
|
6436
|
-
*/
|
|
6437
|
-
understoodLanguages: Array<'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA' | 'TL' | 'MS' | 'ZH' | 'TR' | 'PT' | 'HE'>;
|
|
6438
|
-
/**
|
|
6439
|
-
* Last update timestamp
|
|
6440
|
-
*/
|
|
6441
|
-
updatedAt: string;
|
|
6442
|
-
/**
|
|
6443
|
-
* Background story and behavioral patterns for the persona
|
|
6444
|
-
*/
|
|
6445
|
-
backstoryPrompt?: string | null;
|
|
6446
|
-
/**
|
|
6447
|
-
* Human-readable description of the persona
|
|
6448
|
-
*/
|
|
6449
|
-
description?: string | null;
|
|
6450
|
-
/**
|
|
6451
|
-
* Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
|
|
6452
|
-
*/
|
|
6453
|
-
secondaryLanguage?: 'EN' | null;
|
|
6454
|
-
}
|
|
6455
|
-
}
|
|
6456
|
-
}
|
|
6457
|
-
}
|
|
6458
|
-
export interface CustomerFlowUpdateHappyPathResponse {
|
|
6459
|
-
/**
|
|
6460
|
-
* One way of running a customer flow.
|
|
6461
|
-
*/
|
|
6462
|
-
data: CustomerFlowUpdateHappyPathResponse.ScriptedFlowVariant | CustomerFlowUpdateHappyPathResponse.ImprovFlowVariant | CustomerFlowUpdateHappyPathResponse.VoicemailFlowVariant;
|
|
6463
|
-
}
|
|
6464
|
-
export declare namespace CustomerFlowUpdateHappyPathResponse {
|
|
6465
|
-
/**
|
|
6466
|
-
* One path through a scripted flow. The path engine owns which paths exist, so
|
|
6467
|
-
* editing the graph is what creates and removes these.
|
|
6468
|
-
*/
|
|
6469
|
-
interface ScriptedFlowVariant {
|
|
6470
|
-
id: string;
|
|
6471
|
-
/**
|
|
6472
|
-
* Graded on top of the flow's own expectations, for this variant only.
|
|
6473
|
-
*/
|
|
6474
|
-
additionalExpectations: Array<ScriptedFlowVariant.AdditionalExpectation>;
|
|
6475
|
-
/**
|
|
6476
|
-
* Creation timestamp in ISO 8601 format
|
|
6477
|
-
*/
|
|
6478
|
-
createdAt: string;
|
|
6479
|
-
/**
|
|
6480
|
-
* A simulation environment: the ambient conditions a customer flow variant runs
|
|
6481
|
-
* under. The list includes both your own and the ones Roark curates for every
|
|
6482
|
-
* project.
|
|
6483
|
-
*/
|
|
6484
|
-
environment: ScriptedFlowVariant.Environment | null;
|
|
6485
|
-
isGenerated: boolean;
|
|
6486
|
-
/**
|
|
6487
|
-
* The persona this runs as instead of the happy path's. Null means it inherits.
|
|
6488
|
-
*/
|
|
6489
|
-
personaOverride: ScriptedFlowVariant.PersonaOverride | null;
|
|
6490
|
-
precededByCustomerFlowId: string | null;
|
|
6491
|
-
precededByCustomerFlowVariantId: string | null;
|
|
6492
|
-
/**
|
|
6493
|
-
* The one path through the graph this variant runs, in order. Linear by
|
|
6494
|
-
* construction, so these steps never nest.
|
|
6495
|
-
*/
|
|
6496
|
-
steps: Array<CustomerFlowAPI.FlowStep>;
|
|
6497
|
-
title: string;
|
|
6498
|
-
type: 'SCRIPTED';
|
|
6499
|
-
/**
|
|
6500
|
-
* Last update timestamp in ISO 8601 format
|
|
6501
|
-
*/
|
|
6502
|
-
updatedAt: string;
|
|
6503
|
-
}
|
|
6504
|
-
namespace ScriptedFlowVariant {
|
|
6505
|
-
/**
|
|
6506
|
-
* One thing the agent under test is graded against.
|
|
6507
|
-
*/
|
|
6508
|
-
interface AdditionalExpectation {
|
|
6509
|
-
id: string;
|
|
6510
|
-
/**
|
|
6511
|
-
* What the agent under test is graded against.
|
|
6512
|
-
*/
|
|
6513
|
-
prompt: string;
|
|
6514
|
-
}
|
|
6515
|
-
/**
|
|
6516
|
-
* A simulation environment: the ambient conditions a customer flow variant runs
|
|
6517
|
-
* under. The list includes both your own and the ones Roark curates for every
|
|
6518
|
-
* project.
|
|
6519
|
-
*/
|
|
6520
|
-
interface Environment {
|
|
6521
|
-
id: string;
|
|
6522
|
-
backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
|
|
6523
|
-
/**
|
|
6524
|
-
* Creation timestamp in ISO 8601 format
|
|
6525
|
-
*/
|
|
6526
|
-
createdAt: string;
|
|
6527
|
-
name: string;
|
|
6528
|
-
/**
|
|
6529
|
-
* Last update timestamp in ISO 8601 format
|
|
6530
|
-
*/
|
|
6531
|
-
updatedAt: string;
|
|
6532
|
-
description?: string | null;
|
|
6533
|
-
}
|
|
6534
|
-
/**
|
|
6535
|
-
* The persona this runs as instead of the happy path's. Null means it inherits.
|
|
6536
|
-
*/
|
|
6537
|
-
interface PersonaOverride {
|
|
6538
|
-
/**
|
|
6539
|
-
* Unique identifier of the persona
|
|
6540
|
-
*/
|
|
6541
|
-
id: string;
|
|
6542
|
-
/**
|
|
6543
|
-
* Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with
|
|
6544
|
-
* optional variants
|
|
6545
|
-
*/
|
|
6546
|
-
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
6547
|
-
/**
|
|
6548
|
-
* Background noise setting
|
|
6549
|
-
*/
|
|
6550
|
-
backgroundNoise: 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM';
|
|
6551
|
-
/**
|
|
6552
|
-
* Base emotional state of the persona
|
|
6553
|
-
*/
|
|
6554
|
-
baseEmotion: 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED';
|
|
6555
|
-
/**
|
|
6556
|
-
* How the persona confirms information
|
|
6202
|
+
* How the persona confirms information
|
|
6557
6203
|
*/
|
|
6558
6204
|
confirmationStyle: 'EXPLICIT' | 'VAGUE';
|
|
6559
6205
|
/**
|
|
@@ -6723,6 +6369,11 @@ export declare namespace CustomerFlowUpdateHappyPathResponse {
|
|
|
6723
6369
|
* optional variants
|
|
6724
6370
|
*/
|
|
6725
6371
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
6372
|
+
/**
|
|
6373
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
6374
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
6375
|
+
*/
|
|
6376
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
6726
6377
|
/**
|
|
6727
6378
|
* Background noise setting
|
|
6728
6379
|
*/
|
|
@@ -6898,6 +6549,11 @@ export declare namespace CustomerFlowUpdateHappyPathResponse {
|
|
|
6898
6549
|
* optional variants
|
|
6899
6550
|
*/
|
|
6900
6551
|
accent: 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT' | 'IL';
|
|
6552
|
+
/**
|
|
6553
|
+
* How old the caller sounds and behaves. Only ages the persona's accent has a
|
|
6554
|
+
* voice for are accepted; defaults to ADULT, which every accent supports.
|
|
6555
|
+
*/
|
|
6556
|
+
age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
|
|
6901
6557
|
/**
|
|
6902
6558
|
* Background noise setting
|
|
6903
6559
|
*/
|