@roarkanalytics/cli 0.14.0 → 0.16.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 +14 -0
- package/README.md +35 -23
- package/commands.js +392 -7
- package/completions.js +4 -4
- package/man/roark-benchmark-leaderboard-get.1 +114 -0
- package/man/roark-benchmark-metric-list.1 +96 -0
- package/man/roark-benchmark-suite-list.1 +89 -0
- package/man/roark-benchmark-target-get.1 +103 -0
- package/man/roark-benchmark-target-history-list.1 +106 -0
- package/man/roark-benchmark-target-score-sample-list.1 +112 -0
- package/man/roark-customer-flow-duplicate.1 +7 -0
- package/man/roark-simulation-persona-create.1 +2 -2
- package/man/roark-simulation-persona-update.1 +2 -2
- package/man/roark-simulation-plan-job-cancel.1 +93 -0
- package/man/roark.1 +21 -0
- package/npm-shrinkwrap.json +8 -8
- package/package.json +8 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-BENCHMARK\-LEADERBOARD\-GET" "1" "" "roark-benchmark-leaderboard-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-benchmark\-leaderboard\-get \- Get the benchmark leaderboard
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark benchmark leaderboard get
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns one ranked page of a suite version’s published targets, each with the metric cells it is judged on. Ranking happens in the database, so paging through the board is consistent. Every default the server applies (suite version, condition, sort metric, sort direction) is echoed on the response, so a page can be cited without guessing how it was ordered.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/benchmark/leaderboard
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-suite\fR \fI<value>\fR
|
|
15
|
+
Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-suite\-version\fR \fI<value>\fR
|
|
18
|
+
Optional.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-condition\-key\fR \fI<value>\fR
|
|
21
|
+
Optional.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-sort\-by\fR \fI<value>\fR
|
|
24
|
+
Optional.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-order\fR \fI<value>\fR
|
|
27
|
+
One of: asc, desc. Optional.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-metrics\fR \fI<value>\fR
|
|
30
|
+
Comma\-separated metric keys to project per row. Defaults to the headline set. Optional.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-limit\fR \fI<value>\fR
|
|
33
|
+
Maximum number of records to return (default: 20, max: 100) Optional.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-offset\fR \fI<value>\fR
|
|
36
|
+
Pagination offset Optional.
|
|
37
|
+
.SH "GLOBAL OPTIONS"
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
40
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
43
|
+
Skip confirmation prompts.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-no\-input\fR
|
|
46
|
+
Never prompt; fail instead.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
49
|
+
API base URL.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
52
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
55
|
+
Request timeout in milliseconds.
|
|
56
|
+
.TP
|
|
57
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
58
|
+
Retries for retryable failures.
|
|
59
|
+
.TP
|
|
60
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
61
|
+
Output format: auto, json, jsonl, plain.
|
|
62
|
+
.TP
|
|
63
|
+
\fB\-\-json\fR
|
|
64
|
+
Shorthand for \-\-format json.
|
|
65
|
+
.TP
|
|
66
|
+
\fB\-\-no\-color\fR
|
|
67
|
+
Disable colour.
|
|
68
|
+
.TP
|
|
69
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
70
|
+
Suppress non\-essential output.
|
|
71
|
+
.TP
|
|
72
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
73
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
74
|
+
.SH "EXAMPLES"
|
|
75
|
+
.PP
|
|
76
|
+
.RS 4
|
|
77
|
+
.nf
|
|
78
|
+
roark benchmark leaderboard get \-\-suite <value>
|
|
79
|
+
.fi
|
|
80
|
+
.RE
|
|
81
|
+
.SH "ENVIRONMENT"
|
|
82
|
+
.TP
|
|
83
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
84
|
+
Bearer token used when \-\-token is not given.
|
|
85
|
+
.TP
|
|
86
|
+
\fBROARK_BASE_URL\fR
|
|
87
|
+
API base URL.
|
|
88
|
+
.TP
|
|
89
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
90
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
91
|
+
.TP
|
|
92
|
+
\fBNO_COLOR\fR
|
|
93
|
+
Disables colour when set to any value.
|
|
94
|
+
.SH "EXIT STATUS"
|
|
95
|
+
.TP
|
|
96
|
+
\fB0\fR
|
|
97
|
+
The command succeeded.
|
|
98
|
+
.TP
|
|
99
|
+
\fB1\fR
|
|
100
|
+
The API rejected the request.
|
|
101
|
+
.TP
|
|
102
|
+
\fB2\fR
|
|
103
|
+
The command line was wrong.
|
|
104
|
+
.TP
|
|
105
|
+
\fB3\fR
|
|
106
|
+
No credential, or the credential was refused.
|
|
107
|
+
.TP
|
|
108
|
+
\fB4\fR
|
|
109
|
+
The addressed resource does not exist.
|
|
110
|
+
.TP
|
|
111
|
+
\fB5\fR
|
|
112
|
+
The request never completed: connection, timeout, or abort.
|
|
113
|
+
.SH "SEE ALSO"
|
|
114
|
+
.BR roark (1)
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-BENCHMARK\-METRIC\-LIST" "1" "" "roark-benchmark-metric-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-benchmark\-metric\-list \- List benchmark metrics
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark benchmark metric list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns the metrics a suite version published, each with the direction that counts as better. Use it to pick a valid `sortBy` for the leaderboard: a metric key outside this list is rejected rather than silently ranking every target null.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/benchmark/metric
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-suite\fR \fI<value>\fR
|
|
15
|
+
Required.
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-\-suite\-version\fR \fI<value>\fR
|
|
18
|
+
Optional.
|
|
19
|
+
.SH "GLOBAL OPTIONS"
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
22
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
25
|
+
Skip confirmation prompts.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-no\-input\fR
|
|
28
|
+
Never prompt; fail instead.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
31
|
+
API base URL.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
34
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
35
|
+
.TP
|
|
36
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
37
|
+
Request timeout in milliseconds.
|
|
38
|
+
.TP
|
|
39
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
40
|
+
Retries for retryable failures.
|
|
41
|
+
.TP
|
|
42
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
43
|
+
Output format: auto, json, jsonl, plain.
|
|
44
|
+
.TP
|
|
45
|
+
\fB\-\-json\fR
|
|
46
|
+
Shorthand for \-\-format json.
|
|
47
|
+
.TP
|
|
48
|
+
\fB\-\-no\-color\fR
|
|
49
|
+
Disable colour.
|
|
50
|
+
.TP
|
|
51
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
52
|
+
Suppress non\-essential output.
|
|
53
|
+
.TP
|
|
54
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
55
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
56
|
+
.SH "EXAMPLES"
|
|
57
|
+
.PP
|
|
58
|
+
.RS 4
|
|
59
|
+
.nf
|
|
60
|
+
roark benchmark metric list \-\-suite <value>
|
|
61
|
+
.fi
|
|
62
|
+
.RE
|
|
63
|
+
.SH "ENVIRONMENT"
|
|
64
|
+
.TP
|
|
65
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
66
|
+
Bearer token used when \-\-token is not given.
|
|
67
|
+
.TP
|
|
68
|
+
\fBROARK_BASE_URL\fR
|
|
69
|
+
API base URL.
|
|
70
|
+
.TP
|
|
71
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
72
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
73
|
+
.TP
|
|
74
|
+
\fBNO_COLOR\fR
|
|
75
|
+
Disables colour when set to any value.
|
|
76
|
+
.SH "EXIT STATUS"
|
|
77
|
+
.TP
|
|
78
|
+
\fB0\fR
|
|
79
|
+
The command succeeded.
|
|
80
|
+
.TP
|
|
81
|
+
\fB1\fR
|
|
82
|
+
The API rejected the request.
|
|
83
|
+
.TP
|
|
84
|
+
\fB2\fR
|
|
85
|
+
The command line was wrong.
|
|
86
|
+
.TP
|
|
87
|
+
\fB3\fR
|
|
88
|
+
No credential, or the credential was refused.
|
|
89
|
+
.TP
|
|
90
|
+
\fB4\fR
|
|
91
|
+
The addressed resource does not exist.
|
|
92
|
+
.TP
|
|
93
|
+
\fB5\fR
|
|
94
|
+
The request never completed: connection, timeout, or abort.
|
|
95
|
+
.SH "SEE ALSO"
|
|
96
|
+
.BR roark (1)
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-BENCHMARK\-SUITE\-LIST" "1" "" "roark-benchmark-suite-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-benchmark\-suite\-list \- List benchmark suites
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark benchmark suite list
|
|
7
|
+
[\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns every benchmark suite with published results, along with the suite version the other endpoints default to. Start here: the suite name is a required parameter everywhere else and there is no other way to discover it.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/benchmark/suite
|
|
12
|
+
.SH "GLOBAL OPTIONS"
|
|
13
|
+
.TP
|
|
14
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
15
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
16
|
+
.TP
|
|
17
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
18
|
+
Skip confirmation prompts.
|
|
19
|
+
.TP
|
|
20
|
+
\fB\-\-no\-input\fR
|
|
21
|
+
Never prompt; fail instead.
|
|
22
|
+
.TP
|
|
23
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
24
|
+
API base URL.
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
27
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
30
|
+
Request timeout in milliseconds.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
33
|
+
Retries for retryable failures.
|
|
34
|
+
.TP
|
|
35
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
36
|
+
Output format: auto, json, jsonl, plain.
|
|
37
|
+
.TP
|
|
38
|
+
\fB\-\-json\fR
|
|
39
|
+
Shorthand for \-\-format json.
|
|
40
|
+
.TP
|
|
41
|
+
\fB\-\-no\-color\fR
|
|
42
|
+
Disable colour.
|
|
43
|
+
.TP
|
|
44
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
45
|
+
Suppress non\-essential output.
|
|
46
|
+
.TP
|
|
47
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
48
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
49
|
+
.SH "EXAMPLES"
|
|
50
|
+
.PP
|
|
51
|
+
.RS 4
|
|
52
|
+
.nf
|
|
53
|
+
roark benchmark suite list
|
|
54
|
+
.fi
|
|
55
|
+
.RE
|
|
56
|
+
.SH "ENVIRONMENT"
|
|
57
|
+
.TP
|
|
58
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
59
|
+
Bearer token used when \-\-token is not given.
|
|
60
|
+
.TP
|
|
61
|
+
\fBROARK_BASE_URL\fR
|
|
62
|
+
API base URL.
|
|
63
|
+
.TP
|
|
64
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
65
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
66
|
+
.TP
|
|
67
|
+
\fBNO_COLOR\fR
|
|
68
|
+
Disables colour when set to any value.
|
|
69
|
+
.SH "EXIT STATUS"
|
|
70
|
+
.TP
|
|
71
|
+
\fB0\fR
|
|
72
|
+
The command succeeded.
|
|
73
|
+
.TP
|
|
74
|
+
\fB1\fR
|
|
75
|
+
The API rejected the request.
|
|
76
|
+
.TP
|
|
77
|
+
\fB2\fR
|
|
78
|
+
The command line was wrong.
|
|
79
|
+
.TP
|
|
80
|
+
\fB3\fR
|
|
81
|
+
No credential, or the credential was refused.
|
|
82
|
+
.TP
|
|
83
|
+
\fB4\fR
|
|
84
|
+
The addressed resource does not exist.
|
|
85
|
+
.TP
|
|
86
|
+
\fB5\fR
|
|
87
|
+
The request never completed: connection, timeout, or abort.
|
|
88
|
+
.SH "SEE ALSO"
|
|
89
|
+
.BR roark (1)
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-BENCHMARK\-TARGET\-GET" "1" "" "roark-benchmark-target-get" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-benchmark\-target\-get \- Get a benchmark target
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark benchmark target get
|
|
7
|
+
\fItarget\-key\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns a target’s published sweep and every one of its aggregate cells: the overall rollup plus a set per condition. Defaults to the current sweep; pass `publicationId` from the history endpoint to read a superseded one, which is how a regression is compared generation to generation. Numbers only — no transcript and no audio.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/benchmark/target/{targetKey}
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fItarget\-key\fR
|
|
15
|
+
The target\-key.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-suite\fR \fI<value>\fR
|
|
19
|
+
Required.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-suite\-version\fR \fI<value>\fR
|
|
22
|
+
Optional.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-publication\-id\fR \fI<value>\fR
|
|
25
|
+
Optional.
|
|
26
|
+
.SH "GLOBAL OPTIONS"
|
|
27
|
+
.TP
|
|
28
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
29
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
32
|
+
Skip confirmation prompts.
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-no\-input\fR
|
|
35
|
+
Never prompt; fail instead.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
38
|
+
API base URL.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
41
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
44
|
+
Request timeout in milliseconds.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
47
|
+
Retries for retryable failures.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
50
|
+
Output format: auto, json, jsonl, plain.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-json\fR
|
|
53
|
+
Shorthand for \-\-format json.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-no\-color\fR
|
|
56
|
+
Disable colour.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
59
|
+
Suppress non\-essential output.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
62
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
63
|
+
.SH "EXAMPLES"
|
|
64
|
+
.PP
|
|
65
|
+
.RS 4
|
|
66
|
+
.nf
|
|
67
|
+
roark benchmark target get <target\-key> \-\-suite <value>
|
|
68
|
+
.fi
|
|
69
|
+
.RE
|
|
70
|
+
.SH "ENVIRONMENT"
|
|
71
|
+
.TP
|
|
72
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
73
|
+
Bearer token used when \-\-token is not given.
|
|
74
|
+
.TP
|
|
75
|
+
\fBROARK_BASE_URL\fR
|
|
76
|
+
API base URL.
|
|
77
|
+
.TP
|
|
78
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
79
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
80
|
+
.TP
|
|
81
|
+
\fBNO_COLOR\fR
|
|
82
|
+
Disables colour when set to any value.
|
|
83
|
+
.SH "EXIT STATUS"
|
|
84
|
+
.TP
|
|
85
|
+
\fB0\fR
|
|
86
|
+
The command succeeded.
|
|
87
|
+
.TP
|
|
88
|
+
\fB1\fR
|
|
89
|
+
The API rejected the request.
|
|
90
|
+
.TP
|
|
91
|
+
\fB2\fR
|
|
92
|
+
The command line was wrong.
|
|
93
|
+
.TP
|
|
94
|
+
\fB3\fR
|
|
95
|
+
No credential, or the credential was refused.
|
|
96
|
+
.TP
|
|
97
|
+
\fB4\fR
|
|
98
|
+
The addressed resource does not exist.
|
|
99
|
+
.TP
|
|
100
|
+
\fB5\fR
|
|
101
|
+
The request never completed: connection, timeout, or abort.
|
|
102
|
+
.SH "SEE ALSO"
|
|
103
|
+
.BR roark (1)
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-BENCHMARK\-TARGET\-HISTORY\-LIST" "1" "" "roark-benchmark-target-history-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-benchmark\-target\-history\-list \- List a target’s published generations
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark benchmark target history list
|
|
7
|
+
\fItarget\-key\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns every sweep published for a target, newest first, including superseded ones. This is the trend read: it answers "did this model regress?" from Roark’s own published record. Metadata only — pass a row’s `publicationId` to GET /v1/benchmark/target/{targetKey} for that generation’s numbers.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/benchmark/target/{targetKey}/history
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fItarget\-key\fR
|
|
15
|
+
The target\-key.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-suite\fR \fI<value>\fR
|
|
19
|
+
Required.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-suite\-version\fR \fI<value>\fR
|
|
22
|
+
Optional.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-limit\fR \fI<value>\fR
|
|
25
|
+
Maximum number of records to return (default: 20, max: 100) Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-offset\fR \fI<value>\fR
|
|
28
|
+
Pagination offset Optional.
|
|
29
|
+
.SH "GLOBAL OPTIONS"
|
|
30
|
+
.TP
|
|
31
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
32
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
35
|
+
Skip confirmation prompts.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-no\-input\fR
|
|
38
|
+
Never prompt; fail instead.
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
41
|
+
API base URL.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
44
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
47
|
+
Request timeout in milliseconds.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
50
|
+
Retries for retryable failures.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
53
|
+
Output format: auto, json, jsonl, plain.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-json\fR
|
|
56
|
+
Shorthand for \-\-format json.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-no\-color\fR
|
|
59
|
+
Disable colour.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
62
|
+
Suppress non\-essential output.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
65
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
66
|
+
.SH "EXAMPLES"
|
|
67
|
+
.PP
|
|
68
|
+
.RS 4
|
|
69
|
+
.nf
|
|
70
|
+
roark benchmark target history list <target\-key> \-\-suite <value>
|
|
71
|
+
.fi
|
|
72
|
+
.RE
|
|
73
|
+
.SH "ENVIRONMENT"
|
|
74
|
+
.TP
|
|
75
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
76
|
+
Bearer token used when \-\-token is not given.
|
|
77
|
+
.TP
|
|
78
|
+
\fBROARK_BASE_URL\fR
|
|
79
|
+
API base URL.
|
|
80
|
+
.TP
|
|
81
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
82
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
83
|
+
.TP
|
|
84
|
+
\fBNO_COLOR\fR
|
|
85
|
+
Disables colour when set to any value.
|
|
86
|
+
.SH "EXIT STATUS"
|
|
87
|
+
.TP
|
|
88
|
+
\fB0\fR
|
|
89
|
+
The command succeeded.
|
|
90
|
+
.TP
|
|
91
|
+
\fB1\fR
|
|
92
|
+
The API rejected the request.
|
|
93
|
+
.TP
|
|
94
|
+
\fB2\fR
|
|
95
|
+
The command line was wrong.
|
|
96
|
+
.TP
|
|
97
|
+
\fB3\fR
|
|
98
|
+
No credential, or the credential was refused.
|
|
99
|
+
.TP
|
|
100
|
+
\fB4\fR
|
|
101
|
+
The addressed resource does not exist.
|
|
102
|
+
.TP
|
|
103
|
+
\fB5\fR
|
|
104
|
+
The request never completed: connection, timeout, or abort.
|
|
105
|
+
.SH "SEE ALSO"
|
|
106
|
+
.BR roark (1)
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
.\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
|
|
2
|
+
.TH "ROARK\-BENCHMARK\-TARGET\-SCORE\-SAMPLE\-LIST" "1" "" "roark-benchmark-target-score-sample-list" "Roark Analytics API Manual"
|
|
3
|
+
.SH "NAME"
|
|
4
|
+
roark\-benchmark\-target\-score\-sample\-list \- List score samples for a target
|
|
5
|
+
.SH "SYNOPSIS"
|
|
6
|
+
.B roark benchmark target score\-sample list
|
|
7
|
+
\fItarget\-key\fR [\fIoptions\fR]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Returns the individual scored calls behind a target’s aggregate cells, each with the scorer’s rationale — the "why is this number what it is" read. Filter to one cell with `conditionKey` and `metricKey`. Metrics computed without a rationale (latencies, counts) contribute no samples. Returns reasoning only: no transcript and no audio.
|
|
10
|
+
.SH "API"
|
|
11
|
+
GET /v1/benchmark/target/{targetKey}/score\-sample
|
|
12
|
+
.SH "ARGUMENTS"
|
|
13
|
+
.TP
|
|
14
|
+
\fItarget\-key\fR
|
|
15
|
+
The target\-key.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-suite\fR \fI<value>\fR
|
|
19
|
+
Required.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-suite\-version\fR \fI<value>\fR
|
|
22
|
+
Optional.
|
|
23
|
+
.TP
|
|
24
|
+
\fB\-\-condition\-key\fR \fI<value>\fR
|
|
25
|
+
Optional.
|
|
26
|
+
.TP
|
|
27
|
+
\fB\-\-metric\-key\fR \fI<value>\fR
|
|
28
|
+
Optional.
|
|
29
|
+
.TP
|
|
30
|
+
\fB\-\-limit\fR \fI<value>\fR
|
|
31
|
+
Maximum number of records to return (default: 20, max: 100) Optional.
|
|
32
|
+
.TP
|
|
33
|
+
\fB\-\-offset\fR \fI<value>\fR
|
|
34
|
+
Pagination offset Optional.
|
|
35
|
+
.SH "GLOBAL OPTIONS"
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-data\fR \fI<json>\fR
|
|
38
|
+
Request body as JSON, or @file to read one (@\- for stdin).
|
|
39
|
+
.TP
|
|
40
|
+
\fB\-y\fR, \fB\-\-yes\fR
|
|
41
|
+
Skip confirmation prompts.
|
|
42
|
+
.TP
|
|
43
|
+
\fB\-\-no\-input\fR
|
|
44
|
+
Never prompt; fail instead.
|
|
45
|
+
.TP
|
|
46
|
+
\fB\-\-base\-url\fR \fI<url>\fR
|
|
47
|
+
API base URL.
|
|
48
|
+
.TP
|
|
49
|
+
\fB\-\-token\fR \fI<token>\fR
|
|
50
|
+
Bearer token. Prefer ROARK_API_BEARER_TOKEN or the stored credential.
|
|
51
|
+
.TP
|
|
52
|
+
\fB\-\-timeout\fR \fI<ms>\fR
|
|
53
|
+
Request timeout in milliseconds.
|
|
54
|
+
.TP
|
|
55
|
+
\fB\-\-max\-retries\fR \fI<count>\fR
|
|
56
|
+
Retries for retryable failures.
|
|
57
|
+
.TP
|
|
58
|
+
\fB\-\-format\fR \fI<format>\fR
|
|
59
|
+
Output format: auto, json, jsonl, plain.
|
|
60
|
+
.TP
|
|
61
|
+
\fB\-\-json\fR
|
|
62
|
+
Shorthand for \-\-format json.
|
|
63
|
+
.TP
|
|
64
|
+
\fB\-\-no\-color\fR
|
|
65
|
+
Disable colour.
|
|
66
|
+
.TP
|
|
67
|
+
\fB\-q\fR, \fB\-\-quiet\fR
|
|
68
|
+
Suppress non\-essential output.
|
|
69
|
+
.TP
|
|
70
|
+
\fB\-\-allow\-project\-base\-url\fR
|
|
71
|
+
Send the stored credential to a base URL set by a project .roark.json. Refused by default.
|
|
72
|
+
.SH "EXAMPLES"
|
|
73
|
+
.PP
|
|
74
|
+
.RS 4
|
|
75
|
+
.nf
|
|
76
|
+
roark benchmark target score\-sample list <target\-key> \-\-suite <value>
|
|
77
|
+
.fi
|
|
78
|
+
.RE
|
|
79
|
+
.SH "ENVIRONMENT"
|
|
80
|
+
.TP
|
|
81
|
+
\fBROARK_API_BEARER_TOKEN\fR
|
|
82
|
+
Bearer token used when \-\-token is not given.
|
|
83
|
+
.TP
|
|
84
|
+
\fBROARK_BASE_URL\fR
|
|
85
|
+
API base URL.
|
|
86
|
+
.TP
|
|
87
|
+
\fBROARK_ALLOW_PROJECT_BASE_URL\fR
|
|
88
|
+
Trusts a base URL set by a project .roark.json, like \-\-allow\-project\-base\-url.
|
|
89
|
+
.TP
|
|
90
|
+
\fBNO_COLOR\fR
|
|
91
|
+
Disables colour when set to any value.
|
|
92
|
+
.SH "EXIT STATUS"
|
|
93
|
+
.TP
|
|
94
|
+
\fB0\fR
|
|
95
|
+
The command succeeded.
|
|
96
|
+
.TP
|
|
97
|
+
\fB1\fR
|
|
98
|
+
The API rejected the request.
|
|
99
|
+
.TP
|
|
100
|
+
\fB2\fR
|
|
101
|
+
The command line was wrong.
|
|
102
|
+
.TP
|
|
103
|
+
\fB3\fR
|
|
104
|
+
No credential, or the credential was refused.
|
|
105
|
+
.TP
|
|
106
|
+
\fB4\fR
|
|
107
|
+
The addressed resource does not exist.
|
|
108
|
+
.TP
|
|
109
|
+
\fB5\fR
|
|
110
|
+
The request never completed: connection, timeout, or abort.
|
|
111
|
+
.SH "SEE ALSO"
|
|
112
|
+
.BR roark (1)
|
|
@@ -13,6 +13,13 @@ POST /v1/customer\-flow/{flowId}/duplicate
|
|
|
13
13
|
.TP
|
|
14
14
|
\fIflow\-id\fR
|
|
15
15
|
The flow\-id.
|
|
16
|
+
.SH "OPTIONS"
|
|
17
|
+
.TP
|
|
18
|
+
\fB\-\-title\fR \fI<value>\fR
|
|
19
|
+
Title for the copy. Defaults to "Copy of" the source flow. Optional.
|
|
20
|
+
.TP
|
|
21
|
+
\fB\-\-agent\-ids\fR \fI<value>\fR
|
|
22
|
+
Agents to link on the copy. Omit to carry the source flow's agents over. Required when the source is a Roark\-managed flow with no agents of its own. Repeatable. Optional.
|
|
16
23
|
.SH "GLOBAL OPTIONS"
|
|
17
24
|
.TP
|
|
18
25
|
\fB\-\-data\fR \fI<json>\fR
|
|
@@ -51,7 +51,7 @@ Speech clarity of the persona One of: CLEAR, VAGUE, RAMBLING. Optional.
|
|
|
51
51
|
Whether the persona uses filler words like "um" and "uh" Optional.
|
|
52
52
|
.TP
|
|
53
53
|
\fB\-\-base\-emotion\fR \fI<value>\fR
|
|
54
|
-
Base emotional state of the persona One of: NEUTRAL, CHEERFUL, CONFUSED, FRUSTRATED, SKEPTICAL, RUSHED, DISTRACTED. Optional.
|
|
54
|
+
Base emotional state of the persona One of: NEUTRAL, CHEERFUL, CONFUSED, FRUSTRATED, SKEPTICAL, RUSHED, DISTRACTED, ANGRY, ANXIOUS, SAD. Optional.
|
|
55
55
|
.TP
|
|
56
56
|
\fB\-\-intent\-clarity\fR \fI<value>\fR
|
|
57
57
|
How clearly the persona expresses their intentions One of: CLEAR, INDIRECT, VAGUE. Optional.
|
|
@@ -63,7 +63,7 @@ How the persona confirms information One of: EXPLICIT, VAGUE. Optional.
|
|
|
63
63
|
How reliable the persona's memory is One of: HIGH, LOW. Optional.
|
|
64
64
|
.TP
|
|
65
65
|
\fB\-\-response\-timing\fR \fI<value>\fR
|
|
66
|
-
Controls how quickly the persona responds to pauses in conversation (QUICK, NORMAL, RELAXED) One of: RELAXED, NORMAL, QUICK. Optional.
|
|
66
|
+
Controls how quickly the persona responds to pauses in conversation (QUICK, NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor for several seconds. One of: RELAXED, NORMAL, QUICK, BARGE_IN. Optional.
|
|
67
67
|
.TP
|
|
68
68
|
\fB\-\-backstory\-prompt\fR \fI<value>\fR
|
|
69
69
|
Background story and behavioral patterns for the persona Optional.
|
|
@@ -55,7 +55,7 @@ Speech clarity of the persona One of: CLEAR, VAGUE, RAMBLING. Optional.
|
|
|
55
55
|
Whether the persona uses filler words like "um" and "uh" Optional.
|
|
56
56
|
.TP
|
|
57
57
|
\fB\-\-base\-emotion\fR \fI<value>\fR
|
|
58
|
-
Base emotional state of the persona One of: NEUTRAL, CHEERFUL, CONFUSED, FRUSTRATED, SKEPTICAL, RUSHED, DISTRACTED. Optional.
|
|
58
|
+
Base emotional state of the persona One of: NEUTRAL, CHEERFUL, CONFUSED, FRUSTRATED, SKEPTICAL, RUSHED, DISTRACTED, ANGRY, ANXIOUS, SAD. Optional.
|
|
59
59
|
.TP
|
|
60
60
|
\fB\-\-intent\-clarity\fR \fI<value>\fR
|
|
61
61
|
How clearly the persona expresses their intentions One of: CLEAR, INDIRECT, VAGUE. Optional.
|
|
@@ -67,7 +67,7 @@ How the persona confirms information One of: EXPLICIT, VAGUE. Optional.
|
|
|
67
67
|
How reliable the persona's memory is One of: HIGH, LOW. Optional.
|
|
68
68
|
.TP
|
|
69
69
|
\fB\-\-response\-timing\fR \fI<value>\fR
|
|
70
|
-
Controls how quickly the persona responds to pauses in conversation (QUICK, NORMAL, RELAXED) One of: RELAXED, NORMAL, QUICK. Optional.
|
|
70
|
+
Controls how quickly the persona responds to pauses in conversation (QUICK, NORMAL, RELAXED). BARGE_IN also talks over the agent once it has held the floor for several seconds. One of: RELAXED, NORMAL, QUICK, BARGE_IN. Optional.
|
|
71
71
|
.TP
|
|
72
72
|
\fB\-\-backstory\-prompt\fR \fI<value>\fR
|
|
73
73
|
Background story and behavioral patterns for the persona Optional.
|