UIP IXP プロジェクト

「uip ixp projects」の構文とオプション - IXP トレーニング プロジェクト (モデルのパブリッシュ、メトリック、タクソノミーのインポート/エクスポート) を作成および管理します。

uip ixp projects は、IXP トレーニング プロジェクト (タクソノミー、トレーニング ドキュメント、トレーニング済みのモデル バージョンの最上位のコンテナー) を作成および管理します。タクソノミー モデルとトレーニング ループの概要については、親ページの 「概念 」をご覧ください。

概要

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 プロジェクトのリスト

テナント内のすべての IXP トレーニング プロジェクトのリストを表示します。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-l	--limit <number>	1-10000	50	返すアイテムの数です。
—	--offset <number>	0-1000000	0	スキップするアイテムの数です。

例

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
  }
}

Dataを含む応答全体は IXP API からそのまま転送されます。キーはここではネイティブのパスカル大文字と小文字を保持しますが、大文字と小文字はエンドポイントによって異なるため、大文字と小文字については互いの動詞の注を参照してください。

UIP IXP プロジェクトの Get

IXP トレーニング プロジェクトを名前で取得します。

引数

名前	Required	目的
<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 プロジェクト 削除

プロジェクト (そのドキュメント、タクソノミー、トレーニング済みのモデル) を完全に削除する。不可逆的; --yesが必要です。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。

オプション

Short	長押し	説明
-y	--yes	この元に戻せない操作を確認します。必須 — CLI はプロンプトを表示しません。

例

uip ixp projects delete my-invoices --yes

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

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

uip ixp プロジェクト update-title

プロジェクトの表示タイトルを更新する。プロキシにより、データセットとプロジェクトのタイトルをサーバー側で同期します。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。
<new-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 プロジェクト update-prompt

プロジェクトの全体的な抽出指示を更新します。これは、タクソノミー全体のプロンプトで、すべてのフィールド グループにわたって関連するモデルのコンテキストを提供します。これは、IXP UI の [タクソノミーを管理] ページの [抽出に関する全体的な指示] フィールドと一致します。フィールド グループ独自のプロンプト (taxonomy groups update-prompts) やフィールドごとのプロンプト (taxonomy fields update-promptsとは異なります。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。

オプション

長押し	値 (Value)	Required	説明
--prompt <text>	string	○	新しい抽出に関する全体的な指示既存の値を置換します。

例

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 プロジェクト get-taxonomy

プロジェクトの生の IXP タクソノミー成果物 (データ型 + フィールド グループ) をエクスポートします。これは、別のプロジェクト (import-taxonomy) に再インポートするための IXP 内部形式であり、選定された人間が判読できるビューではありません。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。

例

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

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

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

Data は、パスカルケースではなく、上流のデータセット独自のsnake_caseで逐語的に転送されます。

UIP IXP プロジェクトのインポート - タクソノミー

ローカルの JSON ファイルから既存のプロジェクトにタクソノミーをインポートします。{ field_types, label_group } (/taxonomy-suggestion 生成get-taxonomy形状) または { entity_defs, label_groups } (タクソノミー エンドポイント自体が返す形状) の 2 種類のファイル形式を使用できます。2 つ目の形式を指定すると、entity_defs/最初のlabel_groups エントリは 2 つ目の形式を指定するとそのまま渡され、API で必要なinherits_fromのようなプロパティが保持されます。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。
<file>	○	タクソノミーの JSON ファイルへのパスです。

例

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

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

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

ファイルに認識された形状が両方ともない場合 (正規化後に field_types と label_group の両方が欠落している場合)、明示的なエラーで失敗します。

UIP IXP プロジェクト configure-model

プロジェクトの抽出モデルの設定を構成します。プロキシは現在の構成を読み取り、指定されたモデル/前処理でマージして、それを書き戻し、マージされた構成を返します。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。

オプション

長押し	値 (Value)	説明
--model <version>	string	抽出モデル名、検証済みのサーバー側 (例:gemini_2_5_flash、 gemini_2_5_pro、 gpt_4o_2024_05_13)。
--preprocessing <type>	none|table_mini|table	インテリジェントな前処理モード。

少なくとも --model/--preprocessing の 1 つが必要です — どちらの呼び出しも前にクライアント側で失敗しません ("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 プロジェクト get-metrics

IXP プロジェクトの検証メトリックを取得します。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-m	--model-version <version>	integer または latest	latest	メトリックを取得するモデルのバージョンです。

例

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" }
    ]
  }
}

存在するものの検証されていないモデルは、上記のフラットな形状ではなく { "Metrics": null } を返します。

UIP IXP プロジェクトのパブリッシュ

モデル バージョンをパブリッシュします。任意で live または stagingにタグを付けます。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。

オプション

Short	長押し	値 (Value)	説明
-m	--model-version <version>	integer	パブリッシュするモデルのバージョンです。既定では、トレーニングされた最新 (最高) バージョンが使用されます。
—	--tag <live|staging>	live|staging	必要に応じて、パブリッシュ済みのバージョンにタグを付けます。
-d	--description <text>	string	パブリッシュ済みバージョンの説明。空の文字列を指定すると、既存の文字列がクリアされます。

例

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を省略するとTagnullされます。

UIP IXP プロジェクトのパブリッシュを取り下げ

モデル バージョンのパブリッシュを取り下げます。バージョンはトレーニング済みで一覧表示可能な状態のままです。パブリッシュされたセットからのみ削除されます。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。

オプション

Short	長押し	値 (Value)	Required	説明
-m	--model-version <version>	非負の整数	○	パブリッシュを取り下げるモデルのバージョンです。

例

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

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

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

UIP IXP プロジェクトのタグ付けを解除

モデル バージョンから名前でタグを削除する。タグ名はプロジェクト内で一意であるため、1 つのバージョンに複数のタグが保持されていても明確です。バージョンはトレーニングおよびパブリッシュされたままになります。タグ ポインターのみがクリアされます。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。

オプション

長押し	値 (Value)	Required	説明
--tag <live|staging>	live|staging	○	削除するタグ (名前順)

例

uip ixp projects untag my-invoices --tag live

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

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

uip IXP プロジェクト list-models

プロジェクトのすべてのモデル バージョンとタグを一覧表示します。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。

例

uip ixp projects list-models my-invoices

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

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

UIP IXP プロジェクト 作成

IXP プロジェクトを作成します。ドキュメントのフォルダーを渡すと、それらをアップロードし、均等にサンプリングされた最大 8 つのドキュメントからタクソノミーを提案します。フォルダーがないと、空のプロジェクトが作成されます。

引数

名前	Required	目的
<name>	○	プロジェクト名。
[folder-path]	×	ドキュメントのフォルダーへのパスです。空のプロジェクトの作成を省略します。ドキュメントがなければ、アップロードもタクソノミーの提案もできません。

オプション

Short	長押し	説明
-d	--description <text>	ドキュメントから抽出する内容の説明 — タクソノミーの提案のコンテキストとして使用されます。
—	--skip-taxonomy	プロジェクトを作成し、タクソノミーを提案せずにドキュメントをアップロードします。

アップロードは個々のファイル失敗時に続行されます (各失敗が収集され、致命的ではありません)。このコマンドは、フォルダー内のすべてのアップロードが失敗した場合にのみ完全に失敗します。タクソノミーの提案は、5 秒の遅延で最大 3 回リトライされます (バックエンドで PDF 用の OCR の準備ができていない場合は、断続的に 500 回リトライされる可能性があります)。3 回の試行すべてに失敗しても、プロジェクトとそのドキュメントは作成され続けます。このエラーにより、後で実行するコマンドの正確な import-taxonomy が指定されます。

例

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 ( {file, error}の配列) は、少なくとも 1 つのアップロードが失敗した場合にのみ存在します。タクソノミーの提案に成功すると、FieldTypes (名前/タイトルのペア) と LabelGroup (名前とLabelDefs) でSuggestedTaxonomyが追加されます。--skip-taxonomyが渡されると、代わりに TaxonomySkipped: trueが追加されます。<name> は、ランダムな ID と -ixp でスラッグ化され、サフィックスが付けられて返されます — 渡したリテラル文字列ではありません。

関連

• UIP IXP — 概念と完全なリソース ディレクトリです。
• UIP IXP のタクソノミー — データ型、グループ、フィールドを一度に 1 つずつ編集します (vs.このページのタクソノミー全体 get-taxonomy/import-taxonomy)。
• UIP、IXP のドキュメントとラベル付け — ドキュメントをアップロードし、予測を確認します。
• uip IXP のデプロイ — パブリッシュ済みのモデル バージョンを Orchestrator にデプロイします。

参照

• IXP ツールの概要
• グローバル オプション
• 終了コード