@roarkanalytics/cli 0.20.0 → 0.22.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.
@@ -0,0 +1,93 @@
1
+ .\" File generated from our OpenAPI spec by app-agent-codegen. Do not edit.
2
+ .TH "ROARK\-AUTOIMPROVE\-FIX\-PROMOTE" "1" "" "roark-autoimprove-fix-promote" "Roark Analytics API Manual"
3
+ .SH "NAME"
4
+ roark\-autoimprove\-fix\-promote \- Promote a verified fix to production
5
+ .SH "SYNOPSIS"
6
+ .B roark autoimprove fix promote
7
+ \fIfix\-id\fR [\fIoptions\fR]
8
+ .SH "DESCRIPTION"
9
+ Apply the verified staging changes to the PRODUCTION agent. Only a fix in AWAITING_PROMOTE can be promoted. A snapshot of the production configuration is taken immediately before the write, so the promote is fully rollbackable. After the promote the staging shadow and its phone number are cleaned up.
10
+ .SH "API"
11
+ POST /v1/autoimprove/fix/{fixId}/promote
12
+ .SH "ARGUMENTS"
13
+ .TP
14
+ \fIfix\-id\fR
15
+ The fix\-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 autoimprove fix promote <fix\-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)
@@ -63,7 +63,10 @@ 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). BARGE_IN also talks over the agent once it has held the floor for several seconds. One of: RELAXED, NORMAL, QUICK, BARGE_IN. Optional.
66
+ Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice\-activity profile. Use `interruption` for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as `responseTiming: QUICK` with `interruption: OCCASIONAL`. One of: RELAXED, NORMAL, QUICK, BARGE_IN. Optional.
67
+ .TP
68
+ \fB\-\-interruption\fR \fI<value>\fR
69
+ How much the persona talks over the agent. Defaults to OFF, a caller that waits its turn. One of: OFF, BACKCHANNEL, OCCASIONAL, HEAVY. Optional.
67
70
  .TP
68
71
  \fB\-\-backstory\-prompt\fR \fI<value>\fR
69
72
  Background story and behavioral patterns for the persona Optional.
@@ -67,7 +67,10 @@ 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). BARGE_IN also talks over the agent once it has held the floor for several seconds. One of: RELAXED, NORMAL, QUICK, BARGE_IN. Optional.
70
+ Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice\-activity profile. Use `interruption` for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as `responseTiming: QUICK` with `interruption: OCCASIONAL`. One of: RELAXED, NORMAL, QUICK, BARGE_IN. Optional.
71
+ .TP
72
+ \fB\-\-interruption\fR \fI<value>\fR
73
+ How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises ("mm\-hm") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them. Timing is randomised per turn, so two runs of the same persona do not interrupt at identical moments. One of: OFF, BACKCHANNEL, OCCASIONAL, HEAVY. Optional.
71
74
  .TP
72
75
  \fB\-\-backstory\-prompt\fR \fI<value>\fR
73
76
  Background story and behavioral patterns for the persona Optional.
@@ -45,7 +45,7 @@ Execution mode (PARALLEL or SEQUENTIAL) One of: PARALLEL, SEQUENTIAL_SAME_RUN_PL
45
45
  Deprecated: use `flows` instead. Scenarios to include in this run plan. The same scenario ID can appear multiple times with different variables. Optional.
46
46
  .TP
47
47
  \fB\-\-flows\fR \fI<value>\fR
48
- Customer flows to include in this run plan. The same flow can appear more than once with a different persona override or different variables. Optional.
48
+ 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.
49
49
  .TP
50
50
  \fB\-\-personas\fR \fI<value>\fR
51
51
  Personas to include in this run plan. Required with `scenarios`; ignored with `flows`, where each variant carries its own persona. Optional.
@@ -63,7 +63,7 @@ Also collect each attached flow's own metrics, on top of the `metrics` named her
63
63
  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.
64
64
  .TP
65
65
  \fB\-\-comparison\-property\fR \fI<value>\fR
66
- 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, MEMORY_RELIABILITY, RESPONSE_TIMING, SPEECH_CLARITY, SPEECH_PACE. Optional.
66
+ 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.
67
67
  .TP
68
68
  \fB\-\-comparison\-baseline\fR \fI<value>\fR
69
69
  The value of `comparisonProperty` every other value is measured against, for example `NONE` for `BACKGROUND_NOISE` or `NORMAL` for `SPEECH_PACE`. Must be a value that property can take. 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.
@@ -73,7 +73,7 @@ Whether to also collect each attached flow's own metrics, on top of this plan's
73
73
  Whether to let the run add metrics by itself off the attached flows. See `POST /v1/simulation/plan`. Optional.
74
74
  .TP
75
75
  \fB\-\-comparison\-property\fR \fI<value>\fR
76
- 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` also sets `comparisonBaseline` to whatever this request carries, or to `null` if it carries none, because a baseline is a value of one specific property and keeping the old one would store a pair that is not valid. One of: ACCENT, AGE, BACKGROUND_NOISE, BACKGROUND_NOISE_VOLUME, BASE_EMOTION, CONFIRMATION_STYLE, GENDER, INTENT_CLARITY, LANGUAGE, MEMORY_RELIABILITY, RESPONSE_TIMING, SPEECH_CLARITY, SPEECH_PACE. Optional.
76
+ 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` also sets `comparisonBaseline` to whatever this request carries, or to `null` if it carries none, because a baseline is a value of one specific property and keeping the old one would store a pair that is not valid. 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.
77
77
  .TP
78
78
  \fB\-\-comparison\-baseline\fR \fI<value>\fR
79
79
  The value every other value is measured against. 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.
package/man/roark.1 CHANGED
@@ -93,6 +93,30 @@ List a prompt's versions See roark\-agent\-prompt\-version\-list(1).
93
93
  \fBroark agent update\fR
94
94
  Update an agent See roark\-agent\-update(1).
95
95
  .TP
96
+ \fBroark autoimprove fix answer\fR
97
+ Answer Roark's question See roark\-autoimprove\-fix\-answer(1).
98
+ .TP
99
+ \fBroark autoimprove fix cancel\fR
100
+ Cancel a fix See roark\-autoimprove\-fix\-cancel(1).
101
+ .TP
102
+ \fBroark autoimprove fix create\fR
103
+ Start an Autoimprove fix See roark\-autoimprove\-fix\-create(1).
104
+ .TP
105
+ \fBroark autoimprove fix dismiss\fR
106
+ Dismiss a verified fix See roark\-autoimprove\-fix\-dismiss(1).
107
+ .TP
108
+ \fBroark autoimprove fix get\fR
109
+ Get an Autoimprove fix See roark\-autoimprove\-fix\-get(1).
110
+ .TP
111
+ \fBroark autoimprove fix guidance send\fR
112
+ Send guidance to a running fix See roark\-autoimprove\-fix\-guidance\-send(1).
113
+ .TP
114
+ \fBroark autoimprove fix list\fR
115
+ List Autoimprove fixes See roark\-autoimprove\-fix\-list(1).
116
+ .TP
117
+ \fBroark autoimprove fix promote\fR
118
+ Promote a verified fix to production See roark\-autoimprove\-fix\-promote(1).
119
+ .TP
96
120
  \fBroark benchmark leaderboard get\fR
97
121
  Get the benchmark leaderboard See roark\-benchmark\-leaderboard\-get(1).
98
122
  .TP
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.20.0",
3
+ "version": "0.22.0",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@roarkanalytics/cli",
9
- "version": "0.20.0",
9
+ "version": "0.22.0",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
12
  "@roarkanalytics/sdk": "^3.2.1",
@@ -21,9 +21,9 @@
21
21
  }
22
22
  },
23
23
  "node_modules/@roarkanalytics/sdk": {
24
- "version": "3.17.0",
25
- "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-3.17.0.tgz",
26
- "integrity": "sha512-TdaPwvqqFDwe2JqPvEn27Vu3beysLAb967aFWQetHrbOQHJcPOa3SN7RxvYe0N0w9xG1Eg0EX8wxAaeISuicDQ==",
24
+ "version": "3.20.0",
25
+ "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-3.20.0.tgz",
26
+ "integrity": "sha512-TzNHwWsEbxYWA3zdgeO+/dzSEF5XYI0HnRRuZTKru0q52VLNoRSqvD9a8L6YLd2F11bedNlHn+HN9N2hpA+alA==",
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.20.0",
3
+ "version": "0.22.0",
4
4
  "description": "The official command line interface for the Roark API",
5
5
  "author": "Roark <james@roark.ai>",
6
6
  "type": "commonjs",
@@ -46,6 +46,14 @@
46
46
  "./man/roark-agent-prompt-update.1",
47
47
  "./man/roark-agent-prompt-version-list.1",
48
48
  "./man/roark-agent-update.1",
49
+ "./man/roark-autoimprove-fix-answer.1",
50
+ "./man/roark-autoimprove-fix-cancel.1",
51
+ "./man/roark-autoimprove-fix-create.1",
52
+ "./man/roark-autoimprove-fix-dismiss.1",
53
+ "./man/roark-autoimprove-fix-get.1",
54
+ "./man/roark-autoimprove-fix-guidance-send.1",
55
+ "./man/roark-autoimprove-fix-list.1",
56
+ "./man/roark-autoimprove-fix-promote.1",
49
57
  "./man/roark-benchmark-leaderboard-get.1",
50
58
  "./man/roark-benchmark-metric-list.1",
51
59
  "./man/roark-benchmark-suite-list.1",
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const version = "0.20.0";
1
+ export declare const version = "0.22.0";
package/version.js CHANGED
@@ -10,4 +10,4 @@ exports.version = void 0;
10
10
  //
11
11
  // Do not edit: an edit here is overwritten, and the published number is whatever
12
12
  // package.json says.
13
- exports.version = '0.20.0'; // x-release-please-version
13
+ exports.version = '0.22.0'; // x-release-please-version