@roarkanalytics/cli 0.36.0 → 0.38.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 +21 -0
- package/README.md +38 -30
- package/commands.js +128 -239
- package/completions.js +4 -4
- package/man/roark-credential-create.1 +105 -0
- package/man/roark-credential-list.1 +93 -0
- package/man/roark-credential-revoke.1 +93 -0
- package/man/roark-simulation-plan-create.1 +8 -73
- package/man/roark-simulation-plan-update.1 +2 -2
- package/man/roark.1 +9 -0
- package/npm-shrinkwrap.json +6 -6
- package/package.json +5 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CREDENTIAL\-CREATE" "1" "" "roark-credential-create" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-credential\-create \- Create a personal credential
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark credential create
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Mints a credential that acts as you, for a CLI or an automation. The key value is returned exactly once, in the `key` field: capture it now, it is unreadable afterwards. Requires a personal credential (a project API key is refused) and admin on the project the credential defaults to. The new credential can never exceed the one that created it: not in scope, not in permissions, and not in lifetime. Omit a field to copy it from the calling credential.
|
|
10
|
+
.SH "API"
|
|
11
|
+
POST /v1/me/api\-keys
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-name\fR \fI<value>\fR
|
|
15
|
+
A label you will recognise later. It is the only thing that tells two credentials apart in the list you revoke from. Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-project\-id\fR \fI<value>\fR
|
|
18
|
+
Project the credential assumes when a request sends no X\-Roark\-Project\-Id header. Defaults to the calling credential's own default project. You must be an admin of whichever project is used. Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-scopes\fR \fI<value>\fR
|
|
21
|
+
Coarse tier. Defaults to the calling credential's own tier, and can never exceed it: a READ credential cannot mint a WRITE one. One of: READ, WRITE. Repeatable. Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-permissions\fR \fI<value>\fR
|
|
24
|
+
Granular 'resource:action' permissions. Defaults to the calling credential's own set, and can never exceed it. A ceiling, not an entitlement: the holder still only reaches what their project membership allows. Repeatable. Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-expires\-at\fR \fI<value>\fR
|
|
27
|
+
ISO 8601 expiry. Defaults to the calling credential's own expiry (no expiry, for a `roark auth login` credential) and may not outlive it, so a short\-lived connector credential cannot mint a permanent one. Optional.
|
|
28
|
+
.SH "GLOBAL OPTIONS"
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
31
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
34
|
+
Skip confirmation prompts.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-no\-input\fR
|
|
37
|
+
Never prompt; fail instead.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
40
|
+
API base URL.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
43
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
46
|
+
Request timeout in milliseconds.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
49
|
+
Retries for retryable failures.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
52
|
+
Output format: auto, json, jsonl, plain.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-json\fR
|
|
55
|
+
Shorthand for \-\-format json.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-no\-color\fR
|
|
58
|
+
Disable colour.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
61
|
+
Suppress non\-essential output.
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
64
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
65
|
+
.SH "EXAMPLES"
|
|
66
|
+
.PP
|
|
67
|
+
.RS 4
|
|
68
|
+
.nf
|
|
69
|
+
roark credential create \-\-name <value>
|
|
70
|
+
.fi
|
|
71
|
+
.RE
|
|
72
|
+
.SH "ENVIRONMENT"
|
|
73
|
+
.TP
|
|
74
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
75
|
+
Bearer token used when \-\-token is not given.
|
|
76
|
+
.TP
|
|
77
|
+
\fBROARK_BASE_URL\fR
|
|
78
|
+
API base URL.
|
|
79
|
+
.TP
|
|
80
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
81
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
82
|
+
.TP
|
|
83
|
+
\fBNO_COLOR\fR
|
|
84
|
+
Disables colour when set to any value.
|
|
85
|
+
.SH "EXIT STATUS"
|
|
86
|
+
.TP
|
|
87
|
+
\fB0\fR
|
|
88
|
+
The command succeeded.
|
|
89
|
+
.TP
|
|
90
|
+
\fB1\fR
|
|
91
|
+
The API rejected the request.
|
|
92
|
+
.TP
|
|
93
|
+
\fB2\fR
|
|
94
|
+
The command line was wrong.
|
|
95
|
+
.TP
|
|
96
|
+
\fB3\fR
|
|
97
|
+
No credential, or the credential was refused.
|
|
98
|
+
.TP
|
|
99
|
+
\fB4\fR
|
|
100
|
+
The addressed resource does not exist.
|
|
101
|
+
.TP
|
|
102
|
+
\fB5\fR
|
|
103
|
+
The request never completed: connection, timeout, or abort.
|
|
104
|
+
.SH "SEE ALSO"
|
|
105
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CREDENTIAL\-LIST" "1" "" "roark-credential-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-credential\-list \- List your personal credentials
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark credential list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns the credentials that act as you: the ones created in the dashboard, from `roark auth login`, and MCP connectors. Requires a personal credential; a project API key is refused. Defaults to ACTIVE, pass ?status=REVOKED to see revoked ones. The key value itself is never returned.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/me/api\-keys
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-status\fR \fI<value>\fR
|
|
15
|
+
Filter by status. Defaults to ACTIVE. One of: ACTIVE, REVOKED. Optional.
|
|
16
|
+
.SH "GLOBAL OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
19
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
22
|
+
Skip confirmation prompts.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-no\-input\fR
|
|
25
|
+
Never prompt; fail instead.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
28
|
+
API base URL.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
31
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
34
|
+
Request timeout in milliseconds.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
37
|
+
Retries for retryable failures.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
40
|
+
Output format: auto, json, jsonl, plain.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-json\fR
|
|
43
|
+
Shorthand for \-\-format json.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-color\fR
|
|
46
|
+
Disable colour.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
49
|
+
Suppress non\-essential output.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
52
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
53
|
+
.SH "EXAMPLES"
|
|
54
|
+
.PP
|
|
55
|
+
.RS 4
|
|
56
|
+
.nf
|
|
57
|
+
roark credential list
|
|
58
|
+
.fi
|
|
59
|
+
.RE
|
|
60
|
+
.SH "ENVIRONMENT"
|
|
61
|
+
.TP
|
|
62
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
63
|
+
Bearer token used when \-\-token is not given.
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_BASE_URL\fR
|
|
66
|
+
API base URL.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
69
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
70
|
+
.TP
|
|
71
|
+
\fBNO_COLOR\fR
|
|
72
|
+
Disables colour when set to any value.
|
|
73
|
+
.SH "EXIT STATUS"
|
|
74
|
+
.TP
|
|
75
|
+
\fB0\fR
|
|
76
|
+
The command succeeded.
|
|
77
|
+
.TP
|
|
78
|
+
\fB1\fR
|
|
79
|
+
The API rejected the request.
|
|
80
|
+
.TP
|
|
81
|
+
\fB2\fR
|
|
82
|
+
The command line was wrong.
|
|
83
|
+
.TP
|
|
84
|
+
\fB3\fR
|
|
85
|
+
No credential, or the credential was refused.
|
|
86
|
+
.TP
|
|
87
|
+
\fB4\fR
|
|
88
|
+
The addressed resource does not exist.
|
|
89
|
+
.TP
|
|
90
|
+
\fB5\fR
|
|
91
|
+
The request never completed: connection, timeout, or abort.
|
|
92
|
+
.SH "SEE ALSO"
|
|
93
|
+
.BR roark (1)
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-CREDENTIAL\-REVOKE" "1" "" "roark-credential-revoke" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-credential\-revoke \- Revoke one of your personal credentials
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark credential revoke
|
|
7
|
+
\fIcredential\-id\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Revokes a credential that acts as you. It stops working immediately. A credential may revoke itself, which is what `roark auth logout` does. Repeating the call is safe; an unknown id, or one belonging to someone else, answers 404.
|
|
10
|
+
.SH "API"
|
|
11
|
+
DELETE /v1/me/api\-keys/{id}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fIcredential\-id\fR
|
|
15
|
+
The credential\-id.
|
|
16
|
+
.SH "GLOBAL OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
19
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
22
|
+
Skip confirmation prompts.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-no\-input\fR
|
|
25
|
+
Never prompt; fail instead.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
28
|
+
API base URL.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
31
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
34
|
+
Request timeout in milliseconds.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
37
|
+
Retries for retryable failures.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
40
|
+
Output format: auto, json, jsonl, plain.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-json\fR
|
|
43
|
+
Shorthand for \-\-format json.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-color\fR
|
|
46
|
+
Disable colour.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
49
|
+
Suppress non\-essential output.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
52
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
53
|
+
.SH "EXAMPLES"
|
|
54
|
+
.PP
|
|
55
|
+
.RS 4
|
|
56
|
+
.nf
|
|
57
|
+
roark credential revoke <credential\-id>
|
|
58
|
+
.fi
|
|
59
|
+
.RE
|
|
60
|
+
.SH "ENVIRONMENT"
|
|
61
|
+
.TP
|
|
62
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
63
|
+
Bearer token used when \-\-token is not given.
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_BASE_URL\fR
|
|
66
|
+
API base URL.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
69
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
70
|
+
.TP
|
|
71
|
+
\fBNO_COLOR\fR
|
|
72
|
+
Disables colour when set to any value.
|
|
73
|
+
.SH "EXIT STATUS"
|
|
74
|
+
.TP
|
|
75
|
+
\fB0\fR
|
|
76
|
+
The command succeeded.
|
|
77
|
+
.TP
|
|
78
|
+
\fB1\fR
|
|
79
|
+
The API rejected the request.
|
|
80
|
+
.TP
|
|
81
|
+
\fB2\fR
|
|
82
|
+
The command line was wrong.
|
|
83
|
+
.TP
|
|
84
|
+
\fB3\fR
|
|
85
|
+
No credential, or the credential was refused.
|
|
86
|
+
.TP
|
|
87
|
+
\fB4\fR
|
|
88
|
+
The addressed resource does not exist.
|
|
89
|
+
.TP
|
|
90
|
+
\fB5\fR
|
|
91
|
+
The request never completed: connection, timeout, or abort.
|
|
92
|
+
.SH "SEE ALSO"
|
|
93
|
+
.BR roark (1)
|
|
@@ -6,82 +6,17 @@ roark\-simulation\-plan\-create \- Create a run plan
|
|
|
6
6
|
.B roark simulation plan create
|
|
7
7
|
[\fIoptions\fR]
|
|
8
8
|
.SH "DESCRIPTION"
|
|
9
|
-
Creates a new simulation run plan. To run a simulation, use POST /v1/simulation/run instead: it starts a run from a plan or from an inline configuration, and takes runtime variables. Create a plan here when you want a reusable, named one to run later.
|
|
9
|
+
Creates a new simulation run plan. To run a simulation, use POST /v1/simulation/run instead: it starts a run from a plan or from an inline configuration, and takes runtime variables. Create a plan here when you want a reusable, named one to run later. Send `template` instead of a full configuration to save one of the built\-in templates as a plan. It takes the same fields as the template variant of POST /v1/simulation/run, builds the same plan, and never starts it. To compare one property, attach the flow once and send `comparisonProperty` with the `comparisonValues` to run: the plan attaches the flow once per value.
|
|
10
10
|
.SH "API"
|
|
11
11
|
POST /v1/simulation/plan
|
|
12
|
-
.SH "
|
|
12
|
+
.SH "REQUEST BODY"
|
|
13
|
+
This endpoint accepts one of several request shapes, so the body is supplied as JSON through \e\-\e\-data or on standard input rather than as individual flags.
|
|
13
14
|
.TP
|
|
14
|
-
\
|
|
15
|
-
|
|
15
|
+
\fBCreateRunPlanFromConfig\fR
|
|
16
|
+
Requires name, direction, maxSimulationDurationSeconds, agentEndpoints.
|
|
16
17
|
.TP
|
|
17
|
-
\
|
|
18
|
-
|
|
19
|
-
.TP
|
|
20
|
-
\fB\-\-direction\fR \fI<value>\fR
|
|
21
|
-
Direction of the simulation (INBOUND or OUTBOUND) One of: INBOUND, OUTBOUND. Required.
|
|
22
|
-
.TP
|
|
23
|
-
\fB\-\-iteration\-count\fR \fI<value>\fR
|
|
24
|
-
Number of iterations to run for each test case (1\-10000) Optional.
|
|
25
|
-
.TP
|
|
26
|
-
\fB\-\-max\-concurrent\-jobs\fR \fI<value>\fR
|
|
27
|
-
Maximum number of concurrent simulation jobs Optional.
|
|
28
|
-
.TP
|
|
29
|
-
\fB\-\-max\-simulation\-duration\-seconds\fR \fI<value>\fR
|
|
30
|
-
Maximum duration in seconds for each simulation Required.
|
|
31
|
-
.TP
|
|
32
|
-
\fB\-\-silence\-timeout\-seconds\fR \fI<value>\fR
|
|
33
|
-
Timeout in seconds for silence detection Optional.
|
|
34
|
-
.TP
|
|
35
|
-
\fB\-\-max\-no\-response\-retries\fR \fI<value>\fR
|
|
36
|
-
How many more times to run a test case when the agent under test never responds: it never speaks on a call or never replies in a chat (0\-10). 0 turns retries off. Failed checks and failures on Roark’s side are never retried. Each retry is a separate attempt, billed like any other, so a plan retrying N times can place up to N + 1 calls per test case. Every silent attempt stays on the run with its own call; the run settles once each test case has a final attempt, and the agent never spoke verdict is judged on each test case’s last attempt. Optional.
|
|
37
|
-
.TP
|
|
38
|
-
\fB\-\-no\-response\-retry\-backoff\-seconds\fR \fI<value>\fR
|
|
39
|
-
Seconds a retry waits before it dials (30\-600). Only used when `maxNoResponseRetries` is above 0. Optional.
|
|
40
|
-
.TP
|
|
41
|
-
\fB\-\-end\-call\-phrases\fR \fI<value>\fR
|
|
42
|
-
Phrases that trigger end of call. Empty array disables the feature. Repeatable. Optional.
|
|
43
|
-
.TP
|
|
44
|
-
\fB\-\-end\-call\-reasons\fR \fI<value>\fR
|
|
45
|
-
Semantic conditions that trigger end of call. The LLM evaluates the conversation against these conditions. Empty array disables the feature. Repeatable. Optional.
|
|
46
|
-
.TP
|
|
47
|
-
\fB\-\-execution\-mode\fR \fI<value>\fR
|
|
48
|
-
Execution mode (PARALLEL or SEQUENTIAL) One of: PARALLEL, SEQUENTIAL_SAME_RUN_PLAN, SEQUENTIAL_PROJECT. Optional.
|
|
49
|
-
.TP
|
|
50
|
-
\fB\-\-scenarios\fR \fI<value>\fR
|
|
51
|
-
Deprecated: use `flows` instead. Scenarios to include in this run plan. The same scenario ID can appear multiple times with different variables. Optional.
|
|
52
|
-
.TP
|
|
53
|
-
\fB\-\-flows\fR \fI<value>\fR
|
|
54
|
-
Customer flows to include in this run plan. The same flow can appear more than once with a different persona override, different variables, or different `overrides`: attaching it once per value of one property is how you compare that property without a template. Optional.
|
|
55
|
-
.TP
|
|
56
|
-
\fB\-\-personas\fR \fI<value>\fR
|
|
57
|
-
Personas to include in this run plan. Required with `scenarios`; ignored with `flows`, where each variant carries its own persona. Optional.
|
|
58
|
-
.TP
|
|
59
|
-
\fB\-\-agent\-endpoints\fR \fI<value>\fR
|
|
60
|
-
Agent endpoints to include in this run plan Required.
|
|
61
|
-
.TP
|
|
62
|
-
\fB\-\-metrics\fR \fI<value>\fR
|
|
63
|
-
Metric definitions to include in this run plan. Reference each by `id` (UUID) or `slug`. Optional when the attached `flows` carry the grading: metrics a flow declares itself (with `includeFlowMetrics`), or the Agent Expectations and Keypad Entry metrics a run adds for flows with expectations or expected keypad entries (with `includeAutomaticMetrics`). A plan with nothing to grade is rejected with a 400. Optional.
|
|
64
|
-
.TP
|
|
65
|
-
\fB\-\-include\-flow\-metrics\fR
|
|
66
|
-
Also collect each attached flow's own metrics, on top of the `metrics` named here. Default true, which is what you want when you brought your own flows and their graders. Set false for a run whose metric list is meant to be exhaustive: a template like Load Testing or Voicemail deliberately grades a narrow set, and inheriting every flow metric on top multiplies analysis cost across the volume without adding signal. GET /v1/simulation/template returns the value each template expects. Optional.
|
|
67
|
-
.TP
|
|
68
|
-
\fB\-\-include\-automatic\-metrics\fR
|
|
69
|
-
Let the run add metrics by itself off the attached flows, on top of the `metrics` named here. Two attach this way today: Agent Expectations wherever an attached flow has agent expectations written on it, and Keypad Entry wherever one has steps where the agent is expected to press keys. Both grade something authored on the flow that nothing else measures, which is why it is on by default. Set false when the `metrics` list is meant to be exhaustive: a plan testing only whether the caller can complete the flow may not want the agent graded on its expectations as well. False also pins the plan against any automatic metric Roark adds later. Optional.
|
|
70
|
-
.TP
|
|
71
|
-
\fB\-\-comparison\-property\fR \fI<value>\fR
|
|
72
|
-
The property this run plan investigates: the one thing its arms differ by. Set it and the run report compares the arms on that property, so a run answers "what did background noise cost" rather than just "what did each arm score". Every value is a field already recorded on each call, so the report can label an arm `CRYING_BABY` rather than repeating a flow variant's title. Omit it and the report still compares when it can: it detects which property varies across the arms. Setting it is what tells the written summary what you were trying to find out, which detection cannot infer. One of: ACCENT, AGE, BACKGROUND_NOISE, BACKGROUND_NOISE_VOLUME, BASE_EMOTION, CONFIRMATION_STYLE, GENDER, INTENT_CLARITY, LANGUAGE, INTERRUPTION, MEMORY_RELIABILITY, RESPONSE_TIMING, SPEECH_CLARITY, SPEECH_PACE. Optional.
|
|
73
|
-
.TP
|
|
74
|
-
\fB\-\-comparison\-baseline\fR \fI<value>\fR
|
|
75
|
-
The reference value of `comparisonProperty`, for example `NONE` for `BACKGROUND_NOISE` or `NORMAL` for `SPEECH_PACE`: shown first in the results. Must be a value that property can take. Whether a value did significantly worse does not depend on it: that is decided against every other value combined (see `sweepAttribution`). Stored rather than assumed, so the report can say "compared against US accent" instead of implying Roark decided which value is normal. Most properties have an obvious baseline and the dashboard prefills it; `GENDER` has none, so choose the one you are testing against. Optional.
|
|
76
|
-
.TP
|
|
77
|
-
\fB\-\-comparison\-values\fR \fI<value>\fR
|
|
78
|
-
Which values of `comparisonProperty` to run. This is what the plan costs: the flow is attached once per value, so ten values is ten times the calls of one. Omit it to run every value the property has, which for `ACCENT` is more than twenty. Send a subset to narrow the sweep, for example three accents you actually serve. A `comparisonBaseline` outside this set is rejected, because it would anchor every difference to an arm the run never made. Not stored as a field: the arms are the values. Reading the plan back returns them as its flow attachments. Repeatable. Optional.
|
|
79
|
-
.TP
|
|
80
|
-
\fB\-\-enrich\-with\-live\-conversation\fR
|
|
81
|
-
Merge the customer's own recording of the real call into each simulation, so metrics can be scored against the live leg as well as the simulated one. This is the API equivalent of the dashboard's live\-enrichment toggle. With this on, the run provisions a phone number and holds each call open for up to 15 minutes waiting for a matching call to be posted to POST /v1/call. A call matches on the provisioned number (`roarkPhoneNumber` on the job) with a start time inside the simulation window. If nothing arrives, the simulation still completes and any `LIVE`\-sourced metric produces no value. Required by any metric whose `requiresLiveConversation` is true: without it that metric is silently skipped. Optional.
|
|
82
|
-
.TP
|
|
83
|
-
\fB\-\-auto\-run\fR
|
|
84
|
-
Deprecated: use POST /v1/simulation/run, which starts a run and accepts runtime `variables` as well. This flag runs the plan with only the values pinned on it. Optional.
|
|
18
|
+
\fBCreateRunPlanFromTemplate\fR
|
|
19
|
+
Requires template, agentEndpoints, direction.
|
|
85
20
|
.SH "GLOBAL OPTIONS"
|
|
86
21
|
.TP
|
|
87
22
|
\fB\-\-data\fR \fI<json>\fR
|
|
@@ -123,7 +58,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
|
|
|
123
58
|
.PP
|
|
124
59
|
.RS 4
|
|
125
60
|
.nf
|
|
126
|
-
roark simulation plan create \-\-
|
|
61
|
+
roark simulation plan create \-\-data '{ ... }'
|
|
127
62
|
.fi
|
|
128
63
|
.RE
|
|
129
64
|
.SH "ENVIRONMENT"
|
|
@@ -79,13 +79,13 @@ Whether to also collect each attached flow's own metrics, on top of this plan's
|
|
|
79
79
|
Whether to let the run add metrics by itself off the attached flows. See `POST /v1/simulation/plan`. Optional.
|
|
80
80
|
.TP
|
|
81
81
|
\fB\-\-comparison\-property\fR \fI<value>\fR
|
|
82
|
-
The property this plan investigates. Send `null` to clear the comparison; omit the field to leave it unchanged. See `POST /v1/simulation/plan`. The pair moves together. Sending `comparisonProperty`
|
|
82
|
+
The property this plan investigates. Send `null` to clear the comparison; omit the field to leave it unchanged. See `POST /v1/simulation/plan`. The pair moves together. Sending `comparisonProperty` without `comparisonBaseline` keeps the stored baseline when the property is unchanged and the baseline is still one of the values being run. Otherwise it becomes the new property's norm, or `null` when that norm is not being run either, because a baseline is a value of one specific property. One of: ACCENT, AGE, BACKGROUND_NOISE, BACKGROUND_NOISE_VOLUME, BASE_EMOTION, CONFIRMATION_STYLE, GENDER, INTENT_CLARITY, LANGUAGE, INTERRUPTION, MEMORY_RELIABILITY, RESPONSE_TIMING, SPEECH_CLARITY, SPEECH_PACE. Optional.
|
|
83
83
|
.TP
|
|
84
84
|
\fB\-\-comparison\-baseline\fR \fI<value>\fR
|
|
85
85
|
The reference value, shown first in the results. See `POST /v1/simulation/plan`. A real value cannot be sent on its own: the property it belongs to decides which values are legal, and an omitted property means "leave unchanged", which this endpoint cannot check a baseline against. Send `comparisonProperty` with it, or get a `400`. `null` on its own IS allowed, and clears just the baseline while leaving the property set. Nothing needs validating when clearing, and a property with no baseline is a real state: the report falls back to that property's own norm, and `GENDER` has no norm to fall back to. Optional.
|
|
86
86
|
.TP
|
|
87
87
|
\fB\-\-comparison\-values\fR \fI<value>\fR
|
|
88
|
-
|
|
88
|
+
The arms to run. See `POST /v1/simulation/plan`. Omitting it keeps the arms the plan already has, pins included, so an edit that only renames the plan never widens a sweep you deliberately narrowed, and never multiplies what it costs. Send it with `comparisonProperty` and `flows`, which the arms are rebuilt from. Optional.
|
|
89
89
|
.SH "GLOBAL OPTIONS"
|
|
90
90
|
.TP
|
|
91
91
|
\fB\-\-data\fR \fI<json>\fR
|
package/man/roark.1
CHANGED
|
@@ -183,6 +183,15 @@ Reconcile the project to a config directory (or bundle). Previews and confirms f
|
|
|
183
183
|
\fBroark config diff\fR
|
|
184
184
|
Preview the changes a config directory (or bundle) would make. No writes. See roark\-config\-diff(1).
|
|
185
185
|
.TP
|
|
186
|
+
\fBroark credential create\fR
|
|
187
|
+
Create a personal credential See roark\-credential\-create(1).
|
|
188
|
+
.TP
|
|
189
|
+
\fBroark credential list\fR
|
|
190
|
+
List your personal credentials See roark\-credential\-list(1).
|
|
191
|
+
.TP
|
|
192
|
+
\fBroark credential revoke\fR
|
|
193
|
+
Revoke one of your personal credentials See roark\-credential\-revoke(1).
|
|
194
|
+
.TP
|
|
186
195
|
\fBroark customer\-flow create\fR
|
|
187
196
|
Create a customer flow See roark\-customer\-flow\-create(1).
|
|
188
197
|
.TP
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.38.0",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@roarkanalytics/cli",
|
|
9
|
-
"version": "0.
|
|
9
|
+
"version": "0.38.0",
|
|
10
10
|
"license": "Apache-2.0",
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@roarkanalytics/sdk": "^4.
|
|
12
|
+
"@roarkanalytics/sdk": "^4.23.0",
|
|
13
13
|
"commander": "^14.0.3",
|
|
14
14
|
"yaml": "^2.9.0"
|
|
15
15
|
},
|
|
@@ -21,9 +21,9 @@
|
|
|
21
21
|
}
|
|
22
22
|
},
|
|
23
23
|
"node_modules/@roarkanalytics/sdk": {
|
|
24
|
-
"version": "4.
|
|
25
|
-
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.
|
|
26
|
-
"integrity": "sha512-
|
|
24
|
+
"version": "4.23.0",
|
|
25
|
+
"resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-4.23.0.tgz",
|
|
26
|
+
"integrity": "sha512-2UFFMYoUvIp44e1NG8Jk8DiJIa06gqMwygp1nMn3fhegQqSRUE9tsLkQC74SdfDSKtvvpykWX1bsrHf3DGlo6Q==",
|
|
27
27
|
"license": "Apache-2.0"
|
|
28
28
|
},
|
|
29
29
|
"node_modules/commander": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@roarkanalytics/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.38.0",
|
|
4
4
|
"description": "The official command line interface for the Roark API",
|
|
5
5
|
"author": "Roark <james@roark.ai>",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"fix": "eslint --fix . && prettier --write ."
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@roarkanalytics/sdk": "^4.
|
|
32
|
+
"@roarkanalytics/sdk": "^4.23.0",
|
|
33
33
|
"commander": "^14.0.3",
|
|
34
34
|
"yaml": "^2.9.0"
|
|
35
35
|
},
|
|
@@ -76,6 +76,9 @@
|
|
|
76
76
|
"./man/roark-call-transcript-get.1",
|
|
77
77
|
"./man/roark-config-apply.1",
|
|
78
78
|
"./man/roark-config-diff.1",
|
|
79
|
+
"./man/roark-credential-create.1",
|
|
80
|
+
"./man/roark-credential-list.1",
|
|
81
|
+
"./man/roark-credential-revoke.1",
|
|
79
82
|
"./man/roark-customer-flow-create.1",
|
|
80
83
|
"./man/roark-customer-flow-delete.1",
|
|
81
84
|
"./man/roark-customer-flow-duplicate.1",
|
package/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.38.0";
|
package/version.js
CHANGED