UIP IXP のドキュメントとラベル付け

「uip ixp documents」および「uip ixp labellings」の構文とオプション。トレーニング ドキュメントを管理し、それらに対するモデルの予測を確認/確認します。

uip ixp documents プロジェクトの未加工のトレーニング ドキュメントを管理します (アップロード/ダウンロード/削除/リストを取得)。uip ixp labellings は、これらのドキュメントに対するモデルの予測をレビューして確認します。これは、再トレーニング用のグラウンド トゥルースを生成する人間参加型のステップです。これがトレーニング ループにどのように適合するかについては、親ページの「 概念 」をご覧ください。

概要

uip ixp documents list <project-name> [-l, --limit <n>] [--offset <n>]
uip ixp documents download <project-name> <document-id> [-o, --output <path>]
uip ixp documents upload <project-name> <file>
uip ixp documents delete <project-name> <document-id> -y

uip ixp labellings confirm <project-name> [document-id] [-f, --fields <ids>] [-c, --corrections <json>] [--group <name>] [--occurrence <n>] [--updates <json>] [-m, --model-version <n>]
uip ixp labellings unconfirm <project-name> <document-id> [-f, --fields <ids>] [--group <name>] [--occurrence <n>] [--updates <json>]
uip ixp labellings mark-missing <project-name> <document-id> -f, --fields <ids>
uip ixp labellings get-predictions <project-name> [document-id]

UIP IXP ドキュメント

IXP ドキュメントの内容を読み取ります。

UIP IXP ドキュメントのリスト

プロジェクト内のすべてのドキュメントのリストを表示します。

引数

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

オプション

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

例

uip ixp documents list my-invoices

uip ixp documents list my-invoices --limit 100 --offset 100

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

{
  "Code": "IxpDocumentsList",
  "Data": {
    "Documents": [
      { "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21", "AttachmentRef": "c1a7e9d3-8b2f-4e60-9a15-7d3c6f0b4e28", "Filename": "invoice-001.pdf" }
    ],
    "Total": 120,
    "Offset": 0,
    "Limit": 50
  }
}

UIP IXP ドキュメントのダウンロード

元のドキュメントファイル(PDF/PNG/JPG/など)をダウンロードします。表示用。ファイルの拡張子は、サーバーが報告する実際のコンテンツタイプと一致するように自動修正されます — サーバーは --outputの拡張子を信頼しません。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。
<document-id>	○	ドキュメント ID

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-o	--output <path>	パス	生成された TMPDIR パス	出力ファイル パス。拡張子は自動修正されます (例:.jpeg/.tiff は .jpg/.tifと同等のものとして受け入れられます。それ以外の場合は、不一致または欠落している拡張子が置換または追加されます)。

例

uip ixp documents download my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 -o ./doc

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

{
  "Code": "IxpDocumentsDownload",
  "Data": { "Path": "./doc.pdf", "ContentType": "application/pdf", "SizeBytes": 102400 }
}

UIP IXP ドキュメントのアップロード

既存のプロジェクトにドキュメント ファイルをアップロードします。ネットワーク呼び出しの前に、サポートされていないファイル拡張子をクライアント側で拒否します。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。
<file>	○	アップロードするドキュメント ファイルへのパスです。

例

uip ixp documents upload my-invoices ./invoice.pdf

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

{
  "Code": "IxpDocumentsUpload",
  "Data": {
    "ProjectName": "my-invoices",
    "Filename": "invoice.pdf",
    "AttachmentRef": "c1a7e9d3-8b2f-4e60-9a15-7d3c6f0b4e28",
    "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21"
  }
}

UIP IXP ドキュメントの削除

プロジェクトからドキュメントを削除する

引数

名前	Required	目的
<project-name>	○	プロジェクト名。
<document-id>	○	ドキュメント ID

オプション

Short	長押し	Required	説明
-y	--yes	○	この元に戻せない操作を確認します。

例

uip ixp documents delete my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21

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

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

UIP IXP のラベル付け

IXP のラベル付けと予測を管理する — モデルの予測を確認済みのグラウンド トゥルースに変換する、人間によるレビュー手順です。

注:

confirm と get-predictions は、任意の[document-id]を受け入れます。省略すると、プロジェクト内のすべてのドキュメントに操作が適用されます。このプロジェクト全体のフォームは非推奨であり、今後のリリースで削除される予定です。省略すると、 [WARN] 行が stderr に書き込まれます (stdout は --output json スクリプトのために解析可能なままです)。uip ixp documents listで取得したドキュメント ID を渡します。

反復可能なフィールド グループ: 発生を対象にする

反復可能なフィールド グループ (例:請求書明細につき 1 回出現する「明細項目」)confirmとunconfirmは、 を介して共通のターゲット モデルを共有します--group

フラグ	効果
--group <name> 一人で	グループのすべての出現を対象とします。
--group <name> --occurrence <n>	1 つの出現 (0 から始まるインデックス) (人間工学に基づいた単一行の形式) のみを対象とします。--groupとドキュメント ID が必要です。
--group <name> --updates <json>	1 回のアトミック呼び出し内の複数の特定の出現を対象とします。[{"occurrence":<n>,"fields"?:[...],"corrections"?:{...}}] (確認) または [{"occurrence":<n>,"fields"?:[...]}] (未確認) です。--updates は上位セットです。 --occurrence <n> は単一入力の --updatesに相当します。--occurrence、--fields、および (confirmの場合) --correctionsと相互に排他的です。

--group、出力の [Name] フィールドに表示されているとおりget-predictions完全なラベル パスである必要があります (例:"Invoice > Line Items")、リーフ名だけでなく。

UIP IXP のラベル付けの確認

IXP によって生成された予測を 1 つのドキュメントのグラウンド トゥルースとして確認します。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。
[document-id]	×	ドキュメント ID省略すると、プロジェクト内のすべてのドキュメントが確定されます — 非推奨です。

オプション

Short	長押し	値 (Value)	説明
-f	--fields <field-ids>	コンマ区切り	確認するフィールド ID です。省略すると、予測されたすべてのフィールドが確認されます。を --groupしない場合、各フィールド ID は出現するすべての箇所で確認されます。 --group --occurrenceの場合、その発生回数内でのみ確認します。
-c	--corrections <json>	JSON 配列	参照を保持しながら予測値を上書きする: [{"field_id":"...","value":"corrected"}]。フィールドが出現するすべての出現 (または対象の出現) に適用されます。--updatesと相互に排他的です。
—	--group <name>	string	ターゲット フィールド グループ — 上のターゲットの表をご覧ください。
—	--occurrence <index>	integer	--group以内の単一出現インデックス。上記のターゲットの表をご覧ください。
—	--updates <json>	JSON 配列	バッチ処理された複数出現フォーム。上記のターゲットの表をご覧ください。
-m	--model-version <version>	非負の整数	Optimistic-concurrency guard: 予測がレビューされたモデル バージョン ( get-predictions ModelVersionから) です。それ以降に再トレーニングで新しいバージョンが生成された場合は、ドリフトされた値がグラウンド トゥルースとしてスタンプされるのではなく、確認が 拒否されます 。チェックをスキップする場合は省略します。

例

# Confirm a single document with a field filter and a correction
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  -f a7c3e9105f2b4d86,b2f8a01c7d3e6940 -c '[{"field_id":"a7c3e9105f2b4d86","value":"INV-7654321"}]'

# Confirm all predicted fields on a document as-is
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21

# Confirm every occurrence of a repeatable group
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 --group "Line Items"

# Single occurrence
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  --group "Line Items" --occurrence 2

# Batched: confirm one field in two specific occurrences, in one atomic call
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  --group "Loan and Property" --updates '[{"occurrence":0,"fields":["e9b1746c0a2f5d83"]},{"occurrence":2,"fields":["e9b1746c0a2f5d83"]}]'

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

{
  "Code": "IxpLabellingsConfirm",
  "Data": { "ProjectName": "my-invoices", "TotalDocuments": 1, "PredictionsConfirmed": 1 }
}

TotalDocuments/PredictionsConfirmed フィールド ではなくドキュメントをカウントします (PredictionsConfirmed はドキュメントあたり 0 または 1 です — これにより、基になるフィールド数が多くても、レガシ CLI のドキュメント単位のコントラクトが保持されます)。

UIP IXP のラベル付けの未確認

ドキュメントから確認メッセージを削除する — 対象のフィールドはアノテーションなしの状態に戻ります。間違った confirm/mark-missingをロールバックするには、 を使用します。ドキュメントの他のすべてのアノテーションは繰り越されます。confirmの --group/--occurrence/--updates ターゲット モデル (上の表を参照) から --corrections/--model-versionを引いた値を共有します。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。
<document-id>	○	ドキュメント ID

オプション

Short	長押し	値 (Value)	説明
-f	--fields <field-ids>	コンマ区切り	確認を解除するフィールド ID です。
—	--group <name>	string	ターゲット フィールド グループ。
—	--occurrence <index>	integer	単一出現インデックス。
—	--updates <json>	JSON 配列	バッチ処理された複数出現フォーム: [{"occurrence":<n>,"fields"?:[...]}]。

--fields/--group のうち少なくとも 1 つが必要です。ドキュメント全体を暗黙的に確認解除することはできません。

例

uip ixp labellings unconfirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  -f a7c3e9105f2b4d86,b2f8a01c7d3e6940

uip ixp labellings unconfirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 --group "Line Items"

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

{
  "Code": "IxpLabellingsUnconfirm",
  "Data": {
    "ProjectName": "my-invoices",
    "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21",
    "FieldsUnconfirmed": 2,
    "Unmatched": []
  }
}

UIP IXP のラベル付けのマークが欠落している

フィールドをドキュメント内に存在しないものとしてマークします。つまり、値も場所もないとアノテーションが付けられます。フィールドが実際に存在しない場合に使用します。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。
<document-id>	○	ドキュメント ID

オプション

Short	長押し	値 (Value)	Required	説明
-f	--fields <field-ids>	コンマ区切り	○	存在しないとしてマークするフィールド ID です。

例

uip ixp labellings mark-missing my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  -f a7c3e9105f2b4d86,b2f8a01c7d3e6940

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

{
  "Code": "IxpLabellingsMarkMissing",
  "Data": {
    "ProjectName": "my-invoices",
    "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21",
    "FieldsMarked": 2,
    "Unmatched": []
  }
}

UIP IXP のラベル付け get-predictions

プロジェクト内のドキュメントの IXP モデルの予測を取得します。予測されたラベルとフィールド値、およびそれらを生成した ModelVersion (ドキュメントにまだ予測がない場合はnull )。

引数

名前	Required	目的
<project-name>	○	プロジェクト名。
[document-id]	×	ドキュメント ID省略すると、プロジェクト内のすべてのドキュメントに展開されます — 非推奨です。

例

uip ixp labellings get-predictions my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21

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

{
  "Code": "IxpLabellingsGetPredictions",
  "Data": { "ProjectName": "my-invoices", "TotalDocuments": 1, "DocumentsWithPredictions": 1, "Predictions": [] }
}

Predictions エントリでは、反復可能なグループのラベルごとの Occurrence インデックスを含む、API のネイティブ PascalCase が保持されます。

関連

• UIP IXP — 概念と完全なリソース ディレクトリです。
• UIP IXP プロジェクト — ラベル付けの品質を確認するための get-metrics 。再トレーニングされたモデルを出荷する publish 。
• UIP IXP のタクソノミー — ここでのフィールド/グループの予測は、 に対してスコアリングされます。

参照

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