@eigenpal/cli 0.23.3 → 0.23.5
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 +10 -0
- package/dist/cli.js +195 -34
- package/dist/docs-bundle.json +24 -10
- package/dist/skill/reference/cli/surface.md +1 -0
- package/dist/skill/reference/cli/workflow.md +24 -3
- package/dist/skill/reference/evaluators.md +4 -0
- package/dist/skill/reference/step-types.md +16 -2
- package/package.json +1 -1
|
@@ -18,6 +18,7 @@ Manage workflows: push, pull, and evaluate.
|
|
|
18
18
|
- [Step](#step)
|
|
19
19
|
- [Details](#details)
|
|
20
20
|
- [`eigenpal workflow list|ls [options]`](#eigenpal-workflow-listls-options)
|
|
21
|
+
- [`eigenpal workflow get [options] <workflow-id>`](#eigenpal-workflow-get-options-workflow-id)
|
|
21
22
|
- [`eigenpal workflow pull [options] <workflow-id>`](#eigenpal-workflow-pull-options-workflow-id)
|
|
22
23
|
- [`eigenpal workflow schema [options] <workflow-id>`](#eigenpal-workflow-schema-options-workflow-id)
|
|
23
24
|
- [`eigenpal workflow push [options]`](#eigenpal-workflow-push-options)
|
|
@@ -78,6 +79,7 @@ Manage workflows: push, pull, and evaluate.
|
|
|
78
79
|
```
|
|
79
80
|
workflow
|
|
80
81
|
├── list|ls
|
|
82
|
+
├── get <workflow-id>
|
|
81
83
|
├── pull <workflow-id>
|
|
82
84
|
├── schema <workflow-id>
|
|
83
85
|
├── push
|
|
@@ -152,6 +154,7 @@ workflow
|
|
|
152
154
|
| Command | Description |
|
|
153
155
|
| ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
154
156
|
| `eigenpal workflow list\|ls [options]` | List workflows the caller can read. |
|
|
157
|
+
| `eigenpal workflow get [options] <workflow-id>` | Show one workflow: name, current version, folder and your access level. |
|
|
155
158
|
| `eigenpal workflow pull [options] <workflow-id>` | Download the YAML definition of the workflow at its current version. |
|
|
156
159
|
| `eigenpal workflow schema [options] <workflow-id>` | Show the inferred output schema for a workflow (what it returns). |
|
|
157
160
|
| `eigenpal workflow push [options]` | Create or update a workflow from a YAML file. |
|
|
@@ -268,6 +271,23 @@ List workflows the caller can read.
|
|
|
268
271
|
| `--base-url <url>` | no | | Server base URL |
|
|
269
272
|
| `--json` | no | | Emit machine-readable JSON on stdout |
|
|
270
273
|
|
|
274
|
+
### `eigenpal workflow get [options] <workflow-id>`
|
|
275
|
+
|
|
276
|
+
Show one workflow: name, current version, folder and your access level.
|
|
277
|
+
|
|
278
|
+
### Arguments
|
|
279
|
+
|
|
280
|
+
| Name | Required | Variadic | Description |
|
|
281
|
+
| ------------- | -------- | -------- | ----------- |
|
|
282
|
+
| `workflow-id` | yes | no | |
|
|
283
|
+
|
|
284
|
+
### Options
|
|
285
|
+
|
|
286
|
+
| Flag | Required | Default | Description |
|
|
287
|
+
| ------------------ | -------- | ------- | ------------------------------------ |
|
|
288
|
+
| `--base-url <url>` | no | | Server base URL |
|
|
289
|
+
| `--json` | no | | Emit machine-readable JSON on stdout |
|
|
290
|
+
|
|
271
291
|
### `eigenpal workflow pull [options] <workflow-id>`
|
|
272
292
|
|
|
273
293
|
Download the YAML definition of the workflow at its current version.
|
|
@@ -1222,9 +1242,10 @@ Return the full schema and behavioral docs for one step type.
|
|
|
1222
1242
|
|
|
1223
1243
|
### Options
|
|
1224
1244
|
|
|
1225
|
-
| Flag | Required | Default | Description
|
|
1226
|
-
| -------------- | -------- | ------- |
|
|
1227
|
-
| `--out <path>` | no | | Write to file
|
|
1245
|
+
| Flag | Required | Default | Description |
|
|
1246
|
+
| -------------- | -------- | ------- | ------------------------------------ |
|
|
1247
|
+
| `--out <path>` | no | | Write to file |
|
|
1248
|
+
| `--json` | no | | Emit machine-readable JSON on stdout |
|
|
1228
1249
|
|
|
1229
1250
|
### `eigenpal workflow evaluator-type list|ls [options]`
|
|
1230
1251
|
|
|
@@ -120,6 +120,10 @@ inherited settings. `{}` selects a path with inherited platform defaults.
|
|
|
120
120
|
actual output. This is useful for volatile evidence, citations, and timestamps
|
|
121
121
|
under an otherwise selected parent. It cannot share a rule with other
|
|
122
122
|
settings. An ignore-only rules map means full output minus those paths.
|
|
123
|
+
- Expected `null` and `""` are real expectations, not blanks: `null` passes
|
|
124
|
+
only when the output is `null` or leaves the field out, and `""` only when
|
|
125
|
+
the output is `""`. To skip a field, use `ignore: true` or the `__any__`
|
|
126
|
+
wildcard instead.
|
|
123
127
|
|
|
124
128
|
Path syntax: `lineItems` targets the array; `lineItems[]` targets each element;
|
|
125
129
|
`lineItems[].unitPrice` targets a field inside every element. Nested unordered
|
|
@@ -792,6 +792,10 @@ Output schema:
|
|
|
792
792
|
"storageRef": {
|
|
793
793
|
"description": "Storage reference for the original file",
|
|
794
794
|
"type": "string"
|
|
795
|
+
},
|
|
796
|
+
"renderedPdfRef": {
|
|
797
|
+
"description": "Storage key of the PDF an office input was rendered to. Page word boxes are measured on this PDF.",
|
|
798
|
+
"type": "string"
|
|
795
799
|
}
|
|
796
800
|
},
|
|
797
801
|
"required": [
|
|
@@ -1927,6 +1931,10 @@ Output schema:
|
|
|
1927
1931
|
"storageRef": {
|
|
1928
1932
|
"description": "Storage reference for the original file",
|
|
1929
1933
|
"type": "string"
|
|
1934
|
+
},
|
|
1935
|
+
"renderedPdfRef": {
|
|
1936
|
+
"description": "Storage key of the PDF an office input was rendered to. Page word boxes are measured on this PDF.",
|
|
1937
|
+
"type": "string"
|
|
1930
1938
|
}
|
|
1931
1939
|
},
|
|
1932
1940
|
"required": [
|
|
@@ -2804,7 +2812,7 @@ Extract structured data from text using AI with a JSON schema
|
|
|
2804
2812
|
|
|
2805
2813
|
**Output:** `record<string, unknown>`
|
|
2806
2814
|
|
|
2807
|
-
> Extracted structured data matching the provided schema. Unless grounding is disabled (grounded: false), the output also carries a reserved `_grounding` map keyed by dotted field path: `_grounding["line_items.0.amount"] = { confidence: high|medium|low, score?, needsReview, reason?, quote?, citations?, source_span }
|
|
2815
|
+
> Extracted structured data matching the provided schema. Unless grounding is disabled (grounded: false), the output also carries a reserved `_grounding` map keyed by dotted field path: `_grounding["line_items.0.amount"] = { confidence: high|medium|low, score?, recognitionScore?, needsReview, reason?, quote?, citations?, source_span }`. When the parsed document carries per-word OCR confidence, `recognitionScore` is the recognition of the cited words and caps the field: `score` never exceeds it, below 0.8 the field is low, below 0.9 at most medium. The map also holds reserved `_degraded: true` / `_reason` markers when grounding could not run the shared algorithm or the Eigenpal text pass. Lineage is never included in this JSON.
|
|
2808
2816
|
|
|
2809
2817
|
##### Complete machine-readable schemas
|
|
2810
2818
|
|
|
@@ -2963,7 +2971,7 @@ Output schema:
|
|
|
2963
2971
|
"type": "string"
|
|
2964
2972
|
},
|
|
2965
2973
|
"additionalProperties": {},
|
|
2966
|
-
"description": "Extracted structured data matching the provided schema. Unless grounding is disabled (grounded: false), the output also carries a reserved `_grounding` map keyed by dotted field path: `_grounding[\"line_items.0.amount\"] = { confidence: high|medium|low, score?, needsReview, reason?, quote?, citations?, source_span }
|
|
2974
|
+
"description": "Extracted structured data matching the provided schema. Unless grounding is disabled (grounded: false), the output also carries a reserved `_grounding` map keyed by dotted field path: `_grounding[\"line_items.0.amount\"] = { confidence: high|medium|low, score?, recognitionScore?, needsReview, reason?, quote?, citations?, source_span }`. When the parsed document carries per-word OCR confidence, `recognitionScore` is the recognition of the cited words and caps the field: `score` never exceeds it, below 0.8 the field is low, below 0.9 at most medium. The map also holds reserved `_degraded: true` / `_reason` markers when grounding could not run the shared algorithm or the Eigenpal text pass. Lineage is never included in this JSON."
|
|
2967
2975
|
}
|
|
2968
2976
|
```
|
|
2969
2977
|
|
|
@@ -8256,6 +8264,7 @@ Pause the run for selective field confirmation or correction, then continue with
|
|
|
8256
8264
|
| `data` | string \| record<string, unknown> \| array<unknown> | yes | | Structured data or a template expression resolving to an object or array |
|
|
8257
8265
|
| `schema` | record<string, unknown> | no | | Optional JSON Schema for validating edits and exposing downstream autocomplete. When omitted with metadataFrom: ai.extract and a direct whole-output data expression, the extract step schema is reused. |
|
|
8258
8266
|
| `metadataFrom` | `"ai.extract"` | no | | Producer adapter. `ai.extract` derives categorical field confidence from `_grounding`, copies valid numeric grounding scores into fieldMetadata.display.score, and strips that reserved key from review data. Grounding is not stripped unless this is set. |
|
|
8267
|
+
| `lineageFrom` | string | no | | Name of the ai.extract step whose source lineage draws field boxes in the review. Needed only when data passes through a step that changes field paths. Without it, boxes come from the step in a direct `{{ steps.<name>.output }}` data reference, or, when that step is a transform.script, from the one whole step output it received whose field paths it kept. |
|
|
8259
8268
|
| `fieldMetadata` | record<string, object> | no | `{}` | RFC 6901 pointer map of producer facts (labels, confidence, display). Selection policy belongs under selection.fields; fieldMetadata.review is a legacy alias. |
|
|
8260
8269
|
| `selection` | object | yes | | Field selection policy resolved once when the task is created |
|
|
8261
8270
|
| `files` | object | no | `{"includeRunInputs":true,"attachments":[]}` | Run input files and optional current-run attachments for reviewers |
|
|
@@ -8309,6 +8318,11 @@ Config schema:
|
|
|
8309
8318
|
],
|
|
8310
8319
|
"description": "Producer adapter. `ai.extract` derives categorical field confidence from `_grounding`, copies valid numeric grounding scores into fieldMetadata.display.score, and strips that reserved key from review data. Grounding is not stripped unless this is set."
|
|
8311
8320
|
},
|
|
8321
|
+
"lineageFrom": {
|
|
8322
|
+
"description": "Name of the ai.extract step whose source lineage draws field boxes in the review. Needed only when data passes through a step that changes field paths. Without it, boxes come from the step in a direct `{{ steps.<name>.output }}` data reference, or, when that step is a transform.script, from the one whole step output it received whose field paths it kept.",
|
|
8323
|
+
"type": "string",
|
|
8324
|
+
"pattern": "^[A-Za-z0-9_-]+$"
|
|
8325
|
+
},
|
|
8312
8326
|
"fieldMetadata": {
|
|
8313
8327
|
"description": "RFC 6901 pointer map of producer facts (labels, confidence, display). Selection policy belongs under selection.fields; fieldMetadata.review is a legacy alias.",
|
|
8314
8328
|
"default": {},
|