@roarkanalytics/cli 0.44.1 → 0.46.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.
@@ -6,7 +6,7 @@ roark\-metric\-collection\-job\-create \- Create and run a metric collection job
6
6
  .B roark metric collection\-job create
7
7
  [\fIoptions\fR]
8
8
  .SH "DESCRIPTION"
9
- Creates a metric collection job for the specified calls or chats and metrics, then triggers processing. Provide exactly one of callIds or chatIds.
9
+ Creates a metric collection job for the specified calls or chats and metrics, then triggers processing. Provide exactly one of callIds or chatIds. Pass policyId to score with a metric policy’s settings (for example to re\-score past calls after changing which properties Property Verification checks); metrics then defaults to every metric that policy collects.
10
10
  .SH "API"
11
11
  POST /v1/metric/collection\-jobs
12
12
  .SH "OPTIONS"
@@ -18,7 +18,10 @@ Call IDs to collect metrics for. Mutually exclusive with chatIds. Max 500 per re
18
18
  Chat IDs to collect metrics for. Mutually exclusive with callIds. Max 500 per request. Repeatable. Optional.
19
19
  .TP
20
20
  \fB\-\-metrics\fR \fI<value>\fR
21
- Metric definitions to collect. Max 20 per request. Required.
21
+ Metric definitions to collect. Max 20 per request. Required unless policyId is given; with policyId, defaults to every metric that policy collects, and each one listed must be in it. Optional.
22
+ .TP
23
+ \fB\-\-policy\-id\fR \fI<value>\fR
24
+ Optional. A metric policy (collector) whose settings to score with: each metric runs at the version that policy runs it at, with its per\-collector setting (such as the properties Property Verification checks), instead of the metric's default. A metric the policy runs at its default runs at its default here too. The policy's conditions are not applied: the listed conversations are scored as given. Use it to re\-score past conversations after changing a policy's settings. Optional.
22
25
  .SH "GLOBAL OPTIONS"
23
26
  .TP
24
27
  \fB\-\-data\fR \fI<json>\fR
@@ -60,7 +63,7 @@ Send the stored credential to a base URL set by a project .roark.json. Refused b
60
63
  .PP
61
64
  .RS 4
62
65
  .nf
63
- roark metric collection\-job create \-\-metrics <value>
66
+ roark metric collection\-job create
64
67
  .fi
65
68
  .RE
66
69
  .SH "ENVIRONMENT"
@@ -24,7 +24,7 @@ Modality this policy targets. A policy fires for exactly one modality and can on
24
24
  Condition groups. Omit to match all calls. Optional.
25
25
  .TP
26
26
  \fB\-\-metrics\fR \fI<value>\fR
27
- Metric definitions to collect when this policy matches Required.
27
+ Metric definitions to collect when this policy matches, each with an optional setting Required.
28
28
  .SH "GLOBAL OPTIONS"
29
29
  .TP
30
30
  \fB\-\-data\fR \fI<json>\fR
@@ -25,7 +25,7 @@ Status of the policy One of: ACTIVE, INACTIVE. Optional.
25
25
  Condition groups. Omit to keep existing, provide empty array to remove all conditions. Optional.
26
26
  .TP
27
27
  \fB\-\-metrics\fR \fI<value>\fR
28
- Metric definitions to collect when this policy matches Optional.
28
+ Metric definitions to collect when this policy matches. Replaces the policy's whole metric list: a metric sent without settings goes back to its default, so resend a metric's settings to keep them. Omit to keep the current metrics. Optional.
29
29
  .SH "GLOBAL OPTIONS"
30
30
  .TP
31
31
  \fB\-\-data\fR \fI<json>\fR
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@roarkanalytics/cli",
3
- "version": "0.44.1",
3
+ "version": "0.46.0",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@roarkanalytics/cli",
9
- "version": "0.44.1",
9
+ "version": "0.46.0",
10
10
  "license": "Apache-2.0",
11
11
  "dependencies": {
12
12
  "@roarkanalytics/sdk": "^5.6.0",
@@ -21,9 +21,9 @@
21
21
  }
22
22
  },
23
23
  "node_modules/@roarkanalytics/sdk": {
24
- "version": "5.6.0",
25
- "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.6.0.tgz",
26
- "integrity": "sha512-+RwPaOCmFKNzhVgUbu90kzZJMFSNLPqwnXmfYeP5KkZd12pWNMM549WIEaeZ5vIZeyfhw+Y2lZpX4obib+UWBQ==",
24
+ "version": "5.7.0",
25
+ "resolved": "https://registry.npmjs.org/@roarkanalytics/sdk/-/sdk-5.7.0.tgz",
26
+ "integrity": "sha512-+zQOs48LcMOfJwqMerBKW+Tmxw6IugzgASWsDW27rHCNz0If4aD0c9/ZvG+qpZOX8itRz12nCk1U3njfLAZbMg==",
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.44.1",
3
+ "version": "0.46.0",
4
4
  "description": "The official command line interface for the Roark API",
5
5
  "author": "Roark <james@roark.ai>",
6
6
  "type": "commonjs",
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const version = "0.44.1";
1
+ export declare const version = "0.46.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.44.1'; // x-release-please-version
13
+ exports.version = '0.46.0'; // x-release-please-version