uip ixp projects

Syntax and options for `uip ixp projects`, which creates and manages IXP training projects — model publishing, metrics, and taxonomy import/export.

uip ixp projects creates and manages IXP training projects: the top-level container for a taxonomy, training documents, and trained model versions. See Concepts on the parent page for the taxonomy model and training-loop overview.

概要

uip ixp projects list [-l, --limit <n>] [--offset <n>]
uip ixp projects get <project-name>
uip ixp projects delete <project-name> -y
uip ixp projects update-title <project-name> <new-title>
uip ixp projects update-prompt <project-name> --prompt <text>
uip ixp projects get-taxonomy <project-name>
uip ixp projects import-taxonomy <project-name> <file>
uip ixp projects configure-model <project-name> [--model <version>] [--preprocessing <type>]
uip ixp projects get-metrics <project-name> [-m, --model-version <version>]
uip ixp projects publish <project-name> [-m, --model-version <version>] [--tag live|staging] [-d, --description <text>]
uip ixp projects unpublish <project-name> -m, --model-version <version>
uip ixp projects untag <project-name> --tag live|staging
uip ixp projects list-models <project-name>
uip ixp projects create <name> [folder-path] [-d, --description <text>] [--skip-taxonomy]

uip ixp projects list

List all IXP training projects in the tenant.

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-l	--limit <number>	1-10000	50	Number of items to return.
—	--offset <number>	0-1000000	0	Number of items to skip.

例

uip ixp projects list

データシェイプ(--output json)

{
  "Code": "IxpProjectsList",
  "Data": {
    "Projects": [
      {
        "Id": "3d8f1b67-2c5e-4a09-bf3d-9e1a4c7b820f",
        "Name": "my-invoices",
        "Title": "My Invoices",
        "CreatedAt": "2026-04-01T10:00:00Z",
        "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my-invoices/my-invoices"
      }
    ],
    "Total": 1,
    "Offset": 0,
    "Limit": 1
  }
}

The whole response, including Data, is forwarded from the IXP API verbatim — keys keep their native PascalCase here, but see each other verb's note on casing since it varies by endpoint.

uip ixp projects get

Get an IXP training project by name.

引数

名前	Required	目的
<project-name>	○	Project name.

例

uip ixp projects get my-invoices

データシェイプ(--output json)

{
  "Code": "IxpProjectsGet",
  "Data": {
    "Id": "3d8f1b67-2c5e-4a09-bf3d-9e1a4c7b820f",
    "Name": "my-invoices",
    "Title": "My Invoices",
    "CreatedAt": "2026-04-01T10:00:00Z",
    "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my-invoices/my-invoices"
  }
}

uip ixp projects delete

Permanently delete a project — its documents, taxonomy, and trained models. Irreversible; requires --yes.

引数

名前	Required	目的
<project-name>	○	Project name.

オプション

Short	長押し	説明
-y	--yes	Confirm this irreversible operation. Required — the CLI never prompts.

例

uip ixp projects delete my-invoices --yes

データシェイプ(--output json)

{ "Code": "IxpProjectsDelete", "Data": { "Status": "ok" } }

uip ixp projects update-title

Update the display title of a project. The proxy keeps the dataset and project titles in sync server-side.

引数

名前	Required	目的
<project-name>	○	Project name.
<new-title>	○	New display title.

例

uip ixp projects update-title my-invoices "My Invoices"

データシェイプ(--output json)

{
  "Code": "IxpProjectsUpdateTitle",
  "Data": {
    "Id": "3d8f1b67-2c5e-4a09-bf3d-9e1a4c7b820f",
    "Name": "my-invoices",
    "Title": "My Invoices",
    "CreatedAt": "2026-04-01T10:00:00Z",
    "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my-invoices/my-invoices"
  }
}

uip ixp projects update-prompt

Update the project's overall extraction instructions — the taxonomy-wide prompt giving the model context relevant across every field group. Matches the IXP UI's "Overall extraction instructions" field on the Manage Taxonomy page. Distinct from a field group's own prompt (taxonomy groups update-prompts) and per-field prompts (taxonomy fields update-prompts).

引数

名前	Required	目的
<project-name>	○	Project name.

オプション

長押し	値 (Value)	Required	説明
--prompt <text>	string	○	New overall extraction instructions. Replaces the existing value.

例

uip ixp projects update-prompt my-invoices --prompt "Extract key information from US vendor invoices, including header fields and line items."

データシェイプ(--output json)

{ "Code": "IxpProjectsUpdatePrompt", "Data": { "Status": "ok" } }

uip ixp projects get-taxonomy

Export the project's raw IXP taxonomy artifact (data types + field groups). This is an IXP-internal format intended for re-import into another project (import-taxonomy), not a curated, human-readable view.

引数

名前	Required	目的
<project-name>	○	Project name.

例

uip ixp projects get-taxonomy my-invoices --output json

データシェイプ(--output json)

{
  "Code": "IxpProjectsGetTaxonomy",
  "Data": {
    "status": "ok",
    "dataset": { "entity_defs": [], "label_groups": [] }
  }
}

Data is forwarded verbatim in the upstream dataset's own snake_case, not PascalCased.

uip ixp projects import-taxonomy

Import a taxonomy from a local JSON file into an existing project. Accepts two file formats: { field_types, label_group } (the shape get-taxonomy/taxonomy-suggestion produce) or { entity_defs, label_groups } (the shape the taxonomy endpoint itself returns) — entity_defs/the first label_groups entry are passed through as-is when given the second format, to preserve properties like inherits_from the API requires.

引数

名前	Required	目的
<project-name>	○	Project name.
<file>	○	Path to taxonomy JSON file.

例

uip ixp projects import-taxonomy my-invoices ./taxonomy.json

データシェイプ(--output json)

{
  "Code": "IxpProjectsImportTaxonomy",
  "Data": {
    "ProjectName": "my-invoices",
    "FieldTypes": 4,
    "LabelDefs": 1,
    "Labels": ["Invoice"]
  }
}

Fails with an explicit error if the file has neither recognized shape (missing both field_types and label_group after normalization).

uip ixp projects configure-model

Configure the extraction model settings for a project. The proxy reads the current config, merges in the supplied model/preprocessing, writes it back, and returns the merged config.

引数

名前	Required	目的
<project-name>	○	Project name.

オプション

長押し	値 (Value)	説明
--model <version>	string	Extraction model name, validated server-side (e.g. gemini_2_5_flash, gemini_2_5_pro, gpt_4o_2024_05_13).
--preprocessing <type>	none|table_mini|table	Intelligent pre-processing mode.

At least one of --model/--preprocessing is required — passing neither fails client-side before any call ("Nothing to configure").

例

uip ixp projects configure-model my-invoices --model gemini_2_5_pro --preprocessing table

データシェイプ(--output json)

{
  "Code": "IxpProjectsConfigureModel",
  "Data": { "ProjectName": "my-invoices", "Config": {} }
}

uip ixp projects get-metrics

Get validation metrics for an IXP project.

引数

名前	Required	目的
<project-name>	○	Project name.

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-m	--model-version <version>	integer or latest	latest	Model version to get metrics for.

例

uip ixp projects get-metrics my-invoices --output json

uip ixp projects get-metrics my-invoices --model-version 32 --output json

データシェイプ(--output json)

{
  "Code": "IxpProjectsGetMetrics",
  "Data": {
    "ModelVersion": 35,
    "ValidatedDocuments": 8,
    "ProjectScore": 0.8662574291229248,
    "ProjectScoreQuality": "excellent",
    "FieldGroups": [
      { "FieldGroup": "Invoice", "F1": 0.8939051628112793, "Precision": 0.824999988079071, "Recall": 0.9753694534301758, "ErrorRate": 0.1621621549129486, "Documents": 8 }
    ],
    "Fields": [
      { "FieldGroup": "Invoice", "FieldId": "1e8eadeac608df18", "Name": "Invoice Number", "F1": 0.875, "Precision": 0.875, "Recall": 0.875, "ErrorRate": 0.125, "Documents": 8, "Annotations": 8, "Quality": "good" }
    ]
  }
}

A model that exists but hasn't been validated yet returns { "Metrics": null } instead of the flat shape above.

uip ixp projects publish

Publish a model version, optionally tagging it live or staging.

引数

名前	Required	目的
<project-name>	○	Project name.

オプション

Short	長押し	値 (Value)	説明
-m	--model-version <version>	integer	Model version to publish. Defaults to the latest (highest) trained version.
—	--tag <live|staging>	live|staging	Optionally tag the published version.
-d	--description <text>	string	Description for the published version. An empty string clears an existing one.

例

uip ixp projects publish my-invoices --model-version 4 --tag live --description "Q2 release"

uip ixp projects publish my-invoices --model-version 4

# --model-version defaults to the latest trained version
uip ixp projects publish my-invoices

データシェイプ(--output json)

{
  "Code": "IxpProjectsPublish",
  "Data": {
    "ProjectName": "my-invoices",
    "ModelVersion": 4,
    "Pinned": true,
    "Tag": { "Name": "live", "Version": 4, "UpdatedAt": "2026-04-29T00:00:00Z" },
    "Description": "Q2 release"
  }
}

Tag is null when --tag was omitted.

uip ixp projects unpublish

Unpublish a model version. The version stays trained and listable; it is only removed from the published set.

引数

名前	Required	目的
<project-name>	○	Project name.

オプション

Short	長押し	値 (Value)	Required	説明
-m	--model-version <version>	non-negative integer	○	Model version to unpublish.

例

uip ixp projects unpublish my-invoices --model-version 4

データシェイプ(--output json)

{
  "Code": "IxpProjectsUnpublish",
  "Data": { "ProjectName": "my-invoices", "ModelVersion": 4, "Pinned": false }
}

uip ixp projects untag

Remove a tag from a model version by name. Tag names are unique within a project, so this is unambiguous even if a version holds several tags. The version stays trained and published; only its tag pointer is cleared.

引数

名前	Required	目的
<project-name>	○	Project name.

オプション

長押し	値 (Value)	Required	説明
--tag <live|staging>	live|staging	○	Tag to remove, by name.

例

uip ixp projects untag my-invoices --tag live

データシェイプ(--output json)

{
  "Code": "IxpProjectsUntag",
  "Data": { "ProjectName": "my-invoices", "ModelVersion": 4, "RemovedTags": ["live"] }
}

uip ixp projects list-models

List all model versions and tags for a project.

引数

名前	Required	目的
<project-name>	○	Project name.

例

uip ixp projects list-models my-invoices

データシェイプ(--output json)

{
  "Code": "IxpProjectsListModels",
  "Data": { "Models": [], "Tags": [], "MaxPublished": 5 }
}

uip ixp projects create

Create an IXP project. Given a folder of documents, uploads them and suggests a taxonomy from up to 8 evenly-sampled documents; without a folder, creates an empty project.

引数

名前	Required	目的
<name>	○	Project name.
[folder-path]	×	Path to a folder of documents. Omit to create an empty project — no upload, no taxonomy suggestion is possible without documents.

オプション

Short	長押し	説明
-d	--description <text>	Description of what to extract from the documents — used as context for taxonomy suggestion.
—	--skip-taxonomy	Create the project and upload documents without suggesting a taxonomy.

Uploads continue on individual file failures (each failure is collected, not fatal) — the command only fails outright if every upload in the folder fails. Taxonomy suggestion retries up to 3 times with a 5-second delay (the backend can intermittently 500 while OCR isn't ready yet for a PDF); if all 3 attempts fail, the project and its documents are still created — the error names the exact import-taxonomy command to run afterward.

例

uip ixp projects create "My Invoices" ./training-set --description "extract invoice header fields"

uip ixp projects create "My Invoices" ./training-set --skip-taxonomy

uip ixp projects create "My Invoices"

データシェイプ(--output json)

{
  "Code": "IxpProjectsCreate",
  "Data": {
    "ProjectName": "my_invoices-a1b2c3d4-ixp",
    "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my_invoices-a1b2c3d4-ixp/my_invoices-a1b2c3d4",
    "DocumentsUploaded": 12,
    "DocumentsFailed": 0
  }
}

FailedFiles (an array of {file, error}) is present only when at least one upload failed. When taxonomy suggestion succeeded, SuggestedTaxonomy is added with FieldTypes (name/title pairs) and LabelGroup (name plus LabelDefs). When --skip-taxonomy was passed, TaxonomySkipped: true is added instead. <name> is returned slugified and suffixed with a random id and -ixp — it is not the literal string you passed.

関連

• uip ixp — concepts and the full resource directory.
• uip ixp taxonomy — edit data types, groups, and fields one at a time (vs. this page's whole-taxonomy get-taxonomy/import-taxonomy).
• uip ixp documents & labellings — upload documents and review predictions.
• uip ixp deployments — deploy a published model version to Orchestrator.

参照

• IXP tool overview
• グローバル オプション
• 終了コード