UIP IXP のタクソノミー — フィールド、グループ、データ型

「uip ixp フィールド」、「uip ixp グループ」、「uip ixp データ型」の構文とオプション。プロジェクトの抽出タクソノミーを一度に 1 つずつ編集します。

プロジェクトのタクソノミーを段階的に編集する場合は、 uip ixp data-types (entity_defs — 再利用可能な型の定義)、 uip ixp groups (label_defs — フィールド グループ コンテナー)、 uip ixp fields (グループ内の個々の名前付き値) の 3 つのコマンド グループがあります。これら 3 つがどのように関連しているかについては親ページの「 概念 」を、代わりにタクソノミー全体を 1 つの成果物として移動するには「 projects get-taxonomy/import-taxonomy 」をご覧ください。

すべての動詞の Data は、ネイティブ キーの大文字と小文字を保持して、そのまま転送される IXP API 応答です。

概要

uip ixp data-types add <project-name> --name <name> --kind <kind> --instructions <text> [--input-value <mode>] [--choices <json>]
uip ixp data-types update-instructions <project-name> --name <name> --instructions <text>
uip ixp data-types rename <project-name> --name <name> --new-name <name>
uip ixp data-types delete <project-name> --name <name> -y

uip ixp groups add <project-name> --name <name> --instructions <text> --fields <json>
uip ixp groups delete <project-name> --name <name> -y
uip ixp groups rename <project-name> --name <name> --new-name <name>
uip ixp groups update-prompts <project-name> --updates <json>

uip ixp fields add <project-name> --group <name> --field <name> --type <type> --instructions <text>
uip ixp fields delete <project-name> --group <name> --field <name> -y
uip ixp fields rename <project-name> --group <name> --field <name> --new-name <name>
uip ixp fields change-type <project-name> --group <name> --field <name> --type <type> -y
uip ixp fields update-prompts <project-name> --updates <json>

uip ixp のデータ型

データ型を管理 (entity_defs) — 再利用可能な型の定義フィールドの名前で参照します。

uip ixp のデータ型 add

プロジェクト内に新しいデータ型を作成します。

引数

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

オプション

長押し	値 (Value)	Required	説明
--name <name>	string	○	データ型名。
--kind <kind>	text|date|money|number|boolean|choice	○	基になるデータ型 kind。
--instructions <text>	string	○	この型が表す内容とその値が表示される場所
--input-value <mode>	exact-match|inferred	条件付き	--kindがtextまたはchoiceの場合は必須です。date/money/number/booleanでは禁止されています (これらの種類にはそのようなプロパティはなく、IXP UI のラジオの可視性と一致します)。値がドキュメント内に逐語的に表示されるか、それとも推論/計算されるか。
--choices <json>	JSON 配列	条件付き	--kind choiceの場合は必須です: [{"value":"<canonical>","alternates":["<alt1>",...]}]。value は、正規の表示名 (モデルの出力) です。 alternates (任意) は、モデルがマップ先とする他のスペルです valueです。

例

uip ixp data-types add my-invoices --name "Email Address" --kind text \
  --instructions "An email address in the form local@domain." --input-value exact-match

# boolean kinds don't take --input-value
uip ixp data-types add my-invoices --name "Has Signature" --kind boolean \
  --instructions "True if the document has a handwritten signature."

# choice kind — alternates are optional per entry
uip ixp data-types add my-invoices --name "Citizenship" --kind choice \
  --instructions "Borrower citizenship status." --input-value exact-match \
  --choices '[{"value":"us","alternates":["U.S. Citizen","United States","USA"]},{"value":"permanent alien","alternates":["lawful permanent resident"]},{"value":"non-permanent alien"}]'

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

{
  "Code": "IxpDataTypesAdd",
  "Data": { "ProjectName": "my-invoices", "Name": "Email Address", "Kind": "text", "InputValue": "exact-match" }
}

uip ixp データ型 update-instructions

既存のデータ型に対する指示を置き換えます。

引数

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

オプション

長押し	値 (Value)	Required	説明
--name <name>	string	○	データ型名。
--instructions <text>	string	○	新しい指示 (既存の値を置換します)。

例

uip ixp data-types update-instructions my-invoices --name "Email Address" \
  --instructions "A valid email address in the form local@domain. Reject malformed addresses."

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

{ "Code": "IxpDataTypesUpdateInstructions", "Data": { "ProjectName": "my-invoices", "Name": "Email Address" } }

UIP IXP のデータ型による名前の変更

データ型の名前を変更します。既存のフィールド参照は変更されません。

オプション

長押し	値 (Value)	Required	説明
--name <name>	string	○	現在のデータ型の名前です。
--new-name <name>	string	○	新しいデータ型名。

例

uip ixp data-types rename my-invoices --name "Email Address" --new-name "Email"

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

{ "Code": "IxpDataTypesRename", "Data": { "ProjectName": "my-invoices", "OldName": "Email Address", "NewName": "Email" } }

UIP IXP のデータ型 削除

データ型を削除します。元に戻せない: field_type_id 経由で参照しているフィールドはすべて壊れます。

オプション

Short	長押し	値 (Value)	Required	説明
—	--name <name>	string	○	削除するデータ型の名前です。
-y	--yes	フラグ	○	この元に戻せない操作を確認します。

例

uip ixp data-types delete my-invoices --name "Email Address" --yes

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

{ "Code": "IxpDataTypesDelete", "Data": { "ProjectName": "my-invoices", "Name": "Email Address" } }

UIP IXP グループ

フィールド グループを管理する (label_defs) — フィールドのドキュメントの種類のコンテナーです。

UIP IXP グループ 追加

指示と少なくとも 1 つのフィールドを含む新しいフィールド グループを作成します。

オプション

長押し	値 (Value)	Required	説明
--name <name>	string	○	新しいフィールド グループ名。
--instructions <text>	string	○	グループがカバーするドキュメント/セクションの種類
--fields <json>	JSON 配列	○	少なくとも 1 つのフィールド: [{"name":"...","type":"<data-type-name>","instructions":"..."}]。type は、プロジェクトのタクソノミー内のデータ型の名前 (entity_def) です。サーバー側で解決および検証済みです。

例

uip ixp groups add my-invoices --name Invoice --instructions "Header fields" \
  --fields '[{"name":"Invoice Number","type":"Text","instructions":"Unique invoice identifier near the top-right."},{"name":"Date","type":"Date","instructions":"Date the invoice was issued."},{"name":"Total","type":"Money","instructions":"Grand total at the bottom."}]'

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

{ "Code": "IxpGroupsAdd", "Data": { "ProjectName": "my-invoices", "Group": "Invoice", "FieldsCreated": 3 } }

UIP IXP グループの削除

フィールド グループを削除します。元に戻せない: グループ内のすべてのフィールドのアノテーションがすべて削除されます。

オプション

Short	長押し	値 (Value)	Required	説明
—	--name <name>	string	○	削除するフィールド グループ名。
-y	--yes	フラグ	○	この元に戻せない操作を確認します。

例

uip ixp groups delete my-invoices --name Invoice --yes

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

{ "Code": "IxpGroupsDelete", "Data": { "ProjectName": "my-invoices", "Group": "Invoice" } }

UIP IXP グループの名前変更

フィールド グループの名前を変更します。すべてのフィールドとアノテーションを保持します。

オプション

長押し	値 (Value)	Required	説明
--name <name>	string	○	現在のフィールド グループ名。
--new-name <name>	string	○	新しいフィールド グループ名。

例

uip ixp groups rename my-invoices --name Invoice --new-name InvoiceHeader

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

{ "Code": "IxpGroupsRename", "Data": { "ProjectName": "my-invoices", "OldName": "Invoice", "NewName": "InvoiceHeader" } }

uip ixp グループ update-prompts

グループ名で照合されたフィールド グループの抽出指示を一括更新する。既存のフィールドは保持されます。

オプション

長押し	値 (Value)	Required	説明
--updates <json>	JSON 配列	○	[{"name":"<group>","instructions":"..."}]. label_def の名前が一致 — 一致しない名前はエラーではなく報告されます。

例

uip ixp groups update-prompts my-invoices --updates '[{"name":"Invoice","instructions":"Header fields at the top of the document"}]'

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

{
  "Code": "IxpGroupsUpdatePrompts",
  "Data": { "ProjectName": "my-invoices", "GroupsUpdated": 1, "Unmatched": [] }
}

UIP IXP のフィールド

プロジェクトのフィールド グループ内のフィールドを編集する (label_defs)。

UIP IXP のフィールド 追加

新しいフィールドをフィールド グループに追加します。

オプション

長押し	値 (Value)	Required	説明
--group <name>	string	○	フィールド グループ (label_def) 名。
--field <name>	string	○	新しいフィールド名。
--type <type-name>	string	○	フィールドの種類 — プロジェクトのタクソノミー内のデータ型 (entity_def) の名前です。
--instructions <text>	string	○	何を抽出し、どこで見つけるか

例

uip ixp fields add my-invoices --group Invoice --field "Due Date" --type Date \
  --instructions "Date payment is due."

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

{
  "Code": "IxpFieldsAdd",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Due Date", "FieldTypeId": "c3f08a1b6d2e4f97" }
}

UIP IXP のフィールド 削除

フィールド グループからフィールドを削除する

オプション

Short	長押し	値 (Value)	Required	説明
—	--group <name>	string	○	フィールド グループ名。
—	--field <name>	string	○	削除するフィールド名です。
-y	--yes	フラグ	○	この元に戻せない操作を確認します。

例

uip ixp fields delete my-invoices --group Invoice --field 'Due Date' --yes

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

{ "Code": "IxpFieldsDelete", "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Due Date" } }

UIP IXP フィールドの名前変更

フィールド グループ内のフィールドの名前を変更します。

オプション

長押し	値 (Value)	Required	説明
--group <name>	string	○	フィールド グループ名。
--field <name>	string	○	現在のフィールド名。
--new-name <name>	string	○	新しいフィールド名。

例

uip ixp fields rename my-invoices --group Invoice --field 'Due Date' --new-name 'Payment Due'

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

{
  "Code": "IxpFieldsRename",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "OldName": "Due Date", "NewName": "Payment Due" }
}

uip IXP のフィールド change-type

フィールドの型を変更する元に戻せない: このフィールドの既存のアノテーションは削除されます。

オプション

Short	長押し	値 (Value)	Required	説明
—	--group <name>	string	○	フィールド グループ名。
—	--field <name>	string	○	フィールド名。
—	--type <type-name>	string	○	新しいフィールドの種類 — プロジェクトのタクソノミー内のデータ型の名前です。
-y	--yes	フラグ	○	この元に戻せない操作を確定します (フィールドのアノテーションを削除します)。

例

uip ixp fields change-type my-invoices --group Invoice --field 'Total' --type Money --yes

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

{
  "Code": "IxpFieldsChangeType",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Total", "NewFieldTypeId": "d9b1740e3a6c2f85" }
}

uip IXP のフィールド update-prompts

すべてのフィールド グループでフィールド名で照合された、フィールドごとの抽出指示を一括更新する。既存のフィールド定義は保持されます。

オプション

長押し	値 (Value)	Required	説明
--updates <json>	JSON 配列	○	[{"name":"<field>","instructions":"..."}].フィールド名で照合されます。

例

uip ixp fields update-prompts my-invoices --updates '[{"name":"Invoice Number","instructions":"7-digit numeric ID at top-right"},{"name":"Total","instructions":"Grand total at the bottom"}]'

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

{
  "Code": "IxpFieldsUpdatePrompts",
  "Data": { "ProjectName": "my-invoices", "FieldsUpdated": 2, "Unmatched": [] }
}

関連

• UIP IXP — 概念と完全なリソース ディレクトリです。
• UIP IXP プロジェクト — タクソノミー全体を 1 つの成果物として移動するための get-taxonomy/import-taxonomy です。
• UIP、IXP のドキュメントとラベル付け — ここで定義したフィールド/グループが予測され、そこで確定されます。

参照

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