@uipath/ixp-tool 1.205.0-preview.276 → 1.206.0-preview.279

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/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # @uipath/ixp-tool
2
+
3
+ Adds `uip ixp` to the `uip` CLI: the lifecycle of an IXP (Document Understanding) extraction model. Create a training project from a folder of sample documents, shape its taxonomy (field groups, fields, data types) and prompts, review and confirm predictions, publish a trained model version, and deploy it to an Orchestrator folder for runtime use.
4
+
5
+ The tool calls the IXP Design-Time API through `@uipath/ixp-sdk`. Full guide with worked examples: [docs/tools/ixp.md](../../docs/tools/ixp.md).
6
+
7
+ ## Commands
8
+
9
+ | Group | Commands | Purpose |
10
+ | --- | --- | --- |
11
+ | `projects` | `list`, `get`, `create`, `delete`, `update-title`, `update-prompt`, `get-taxonomy`, `import-taxonomy`, `configure-model`, `get-metrics`, `publish`, `unpublish`, `untag`, `list-models` | Training projects, their overall prompt and model versions. |
12
+ | `documents` | `list`, `upload`, `download`, `delete` | Sample documents in a project (PDF, PNG, JPG, GIF, TIFF, BMP). |
13
+ | `groups` | `add`, `delete`, `rename`, `update-prompts` | Field groups and their instructions. |
14
+ | `fields` | `add`, `delete`, `rename`, `change-type`, `update-prompts` | Fields inside a group. |
15
+ | `data-types` | `add`, `update-instructions`, `rename`, `delete` | Data types fields can reference. |
16
+ | `labellings` | `confirm`, `unconfirm`, `mark-missing`, `get-predictions` | Turn predictions into ground truth, or roll that back. |
17
+ | `deployments` | `create`, `upgrade`, `list`, `get-taxonomy` | Deploy a trained version to an Orchestrator folder. |
18
+
19
+ Projects are addressed by name.
20
+
21
+ ## Examples
22
+
23
+ ```bash
24
+ uip ixp projects create "My Invoices" ./training-set --description "extract invoice header fields"
25
+ uip ixp projects list --output json
26
+ uip ixp projects get-taxonomy "My Invoices" --output json
27
+ uip ixp labellings get-predictions "My Invoices" <document-id> --output json
28
+ uip ixp labellings confirm "My Invoices" <document-id>
29
+ uip ixp projects publish "My Invoices" --model-version <version> --tag live
30
+ uip ixp deployments create "My Invoices" --version <version> --folder-key <folder-key>
31
+ uip ixp projects delete "My Invoices" --yes
32
+ ```
33
+
34
+ ## Notes
35
+
36
+ - Destructive commands (`projects delete`, `documents delete`, `groups delete`, `fields delete`, `fields change-type`, `data-types delete`) need `--yes`. Deleting a group, or changing a field's type, deletes its annotations.
37
+ - The IXP API is internal and may change without notice.
38
+
39
+ ## Authentication
40
+
41
+ Run `uip login` first. `deployments create` / `upgrade` take the target Orchestrator folder by `--folder-key`.
@@ -1,5 +1,3 @@
1
- import"./tool-1de529jm.js";
2
-
3
1
  // ../../node_modules/open/index.js
4
2
  import process7 from "node:process";
5
3
  import path from "node:path";
@@ -548,22 +546,6 @@ var open = (target, options) => {
548
546
  target
549
547
  });
550
548
  };
551
- var openApp = (name, options) => {
552
- if (typeof name !== "string" && !Array.isArray(name)) {
553
- throw new TypeError("Expected a valid `name`");
554
- }
555
- const { arguments: appArguments = [] } = options ?? {};
556
- if (appArguments !== undefined && appArguments !== null && !Array.isArray(appArguments)) {
557
- throw new TypeError("Expected `appArguments` as Array type");
558
- }
559
- return baseOpen({
560
- ...options,
561
- app: {
562
- name,
563
- arguments: appArguments
564
- }
565
- });
566
- };
567
549
  function detectArchBinary(binary) {
568
550
  if (typeof binary === "string" || Array.isArray(binary)) {
569
551
  return binary;
@@ -626,9 +608,7 @@ defineLazyProperty(apps, "safari", () => detectPlatformBinary({
626
608
  }));
627
609
  var open_default = open;
628
610
  export {
629
- apps,
630
- open_default as default,
631
- openApp
611
+ open_default as default
632
612
  };
633
613
 
634
- //# debugId=42C9AEC59ECC644E64756E2164756E21
614
+ //# debugId=6F288C058A3A412164756E2164756E21
package/dist/index.js CHANGED
@@ -1,15 +1,14 @@
1
1
  #!/usr/bin/env bun
2
2
  import {
3
- Command,
4
3
  package_default,
5
- registerCommands
6
- } from "./tool-j64xf8nq.js";
7
- import"./tool-1de529jm.js";
4
+ Command,
5
+ registerCommands2
6
+ } from "./tool-cywzz9dm.js";
8
7
 
9
8
  // src/index.ts
10
9
  var program = new Command;
11
10
  program.name("ixp-tool").description("UiPath IXP Tool - Standalone CLI").version(package_default.version);
12
- await registerCommands(program);
11
+ await registerCommands2(program);
13
12
  program.parse(process.argv);
14
13
 
15
- //# debugId=38BF31F62C561C0364756E2164756E21
14
+ //# debugId=A3F0ABBD513E968A64756E2164756E21
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  __commonJS
3
- } from "./tool-1de529jm.js";
3
+ } from "./tool-epsr41wx.js";
4
4
 
5
5
  // ../../node_modules/jmespath/jmespath.js
6
6
  var require_jmespath = __commonJS(function(exports) {
@@ -1,5 +1,3 @@
1
- import"./tool-1de529jm.js";
2
-
3
1
  // ../../node_modules/js-yaml/dist/js-yaml.mjs
4
2
  function getDefaultExportFromCjs(x) {
5
3
  return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, "default") ? x["default"] : x;
@@ -3150,4 +3148,4 @@ export {
3150
3148
  types
3151
3149
  };
3152
3150
 
3153
- //# debugId=9FA8E718B2F80BEA64756E2164756E21
3151
+ //# debugId=41DC6971B94BC54964756E2164756E21