uip IXP 分类 — 字段、组、数据类型

“uip 智能提取处理 (IXP) 字段”、“uip 智能提取处理 (IXP) 组”和“uip 智能提取处理 (IXP) 数据类型”的语法和选项，一次可编辑项目的提取分类。

三个命令组用于逐步编辑项目分类：uip ixp data-types（entity_defs — 可重用的类型定义）、uip ixp groups（label_defs — 字段组容器）和 uip ixp fields（组中的单个命名值）。请参阅父页面上的“概念” ，以了解这三者的关系，请参阅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 数据类型添加

在项目中创建新的数据类型。

参数

名称	必填	用途
<project-name>	是	项目名称。

选项

长	值	必填	描述
--name <name>	字符串	是	数据类型名称。
--kind <kind>	text|date|money|number|boolean|choice	是	基础数据类型种类。
--instructions <text>	字符串	是	此类型代表什么以及其值出现的位置。
--input-value <mode>	exact-match|inferred	有条件地	--kind为text或choice时为必填项；禁止date / money / number / boolean （这些种类没有此类属性，与 IXP 用户界面的单选按钮可见性一致）。该值是在文档中逐字显示，还是推断/计算得出的。
--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"}]'

数据形状（--输出 json）

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

uip IXP 数据类型更新说明

替换现有数据类型的指令。

参数

名称	必填	用途
<project-name>	是	项目名称。

选项

长	值	必填	描述
--name <name>	字符串	是	数据类型名称。
--instructions <text>	字符串	是	新说明（替换现有值）。

示例

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

数据形状（--输出 json）

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

uip IXP 数据类型重命名

重命名数据类型。现有字段引用保持不变。

选项

长	值	必填	描述
--name <name>	字符串	是	当前数据类型名称。
--new-name <name>	字符串	是	新数据类型名称。

示例

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

数据形状（--输出 json）

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

UIP IXP 数据类型删除

删除数据类型。不可撤销：通过field_type_id引用它的任何字段都将中断。

选项

短	长	值	必填	描述
—	--name <name>	字符串	是	要删除的数据类型名称。
-y	--yes	标记	是	确认此不可逆操作。

示例

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

数据形状（--输出 json）

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

UIP IXP 组

管理字段组 (label_defs) — 字段的文档类型容器。

uip IXP 组添加

包含说明和至少一个字段创建新的字段组。

选项

长	值	必填	描述
--name <name>	字符串	是	新字段组名称。
--instructions <text>	字符串	是	组涵盖的文档/部分类型。
--fields <json>	JSON 数组	是	至少一个字段：[{"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."}]'

数据形状（--输出 json）

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

UIP IXP 组删除

删除字段组。不可撤销：将删除组中所有字段上的所有注释。

选项

短	长	值	必填	描述
—	--name <name>	字符串	是	要删除的字段组名称。
-y	--yes	标记	是	确认此不可逆操作。

示例

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

数据形状（--输出 json）

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

uip IXP组重命名

重命名字段组。保留所有字段和注释。

选项

长	值	必填	描述
--name <name>	字符串	是	当前字段组名称。
--new-name <name>	字符串	是	新字段组名称。

示例

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

数据形状（--输出 json）

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

uip IXP 组更新提示词

批量更新字段组提取说明，由组名称匹配。现有字段会保留。

选项

长	值	必填	描述
--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"}]'

数据形状（--输出 json）

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

UIP IXP 字段

编辑项目字段组 (label_defs) 中的字段。

UIP IXP 字段添加

向字段组添加新字段。

选项

长	值	必填	描述
--group <name>	字符串	是	字段组 (label_def) 名称:
--field <name>	字符串	是	新字段名称。
--type <type-name>	字符串	是	字段类型 — 项目分类中数据类型 (entity_def) 的名称。
--instructions <text>	字符串	是	提取内容以及提取位置。

示例

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

数据形状（--输出 json）

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

UIP IXP 字段删除

从字段组中删除字段。

选项

短	长	值	必填	描述
—	--group <name>	字符串	是	字段组名称。
—	--field <name>	字符串	是	要删除的字段名称。
-y	--yes	标记	是	确认此不可逆操作。

示例

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

数据形状（--输出 json）

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

uip IXP 字段重命名

重命名字段组中的字段。

选项

长	值	必填	描述
--group <name>	字符串	是	字段组名称。
--field <name>	字符串	是	当前字段名称。
--new-name <name>	字符串	是	新字段名称。

示例

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

数据形状（--输出 json）

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

UIP IXP 字段更改类型

更改字段的类型。不可逆：将删除此字段的现有注释。

选项

短	长	值	必填	描述
—	--group <name>	字符串	是	字段组名称。
—	--field <name>	字符串	是	字段名称。
—	--type <type-name>	字符串	是	新字段类型 — 项目分类中数据类型的名称。
-y	--yes	标记	是	确认此不可撤销的操作（删除字段的注释）。

示例

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

数据形状（--输出 json）

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

uip IXP 字段更新提示词

按字段批量更新提取说明，按所有字段组中的字段名称进行匹配。现有字段定义将保留。

选项

长	值	必填	描述
--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"}]'

数据形状（--输出 json）

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

相关内容

• uip IXP — 概念和完整资源目录。
• UIP IXP 项目— get-taxonomy / import-taxonomy ，用于将整个分类作为一个工件移动。
• UIP IXP 文档和标签— 此处定义的字段/组在此处进行预测和确认。

另请参阅

• IXP 工具概述
• 全局选项
• 退出代码