UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip ixp taxonomy — fields, groups, data-types

Syntax and options for `uip ixp fields`, `uip ixp groups`, and `uip ixp data-types`, which edit a project's extraction taxonomy one piece at a time.

Three command groups edit a project's taxonomy incrementally: uip ixp data-types (entity_defs — reusable type definitions), uip ixp groups (label_defs — field-group containers), and uip ixp fields (the individual named values inside a group). See Concepts on the parent page for how these three relate, and projects get-taxonomy/import-taxonomy for moving the whole taxonomy as one artifact instead.

Every verb's Data is the IXP API response forwarded verbatim, preserving its native key casing.

Names (data type, field group, and field names, and the type references to data types) accept at most 64 characters. Instructions accept at most 4,096 characters.

Synopsis​

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 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 data-types​

Manage data types (entity_defs) — the reusable type definitions fields reference by name.

uip ixp data-types add​

Create a new data type in the project.

Arguments​
NameRequiredPurpose
<project-name>yesProject name.
Options​
LongValueRequiredDescription
--name <name>stringyesData type name.
--kind <kind>text|date|money|number|boolean|choiceyesUnderlying data type kind.
--instructions <text>stringyesWhat this type represents and where its values appear.
--input-value <mode>exact-match|inferredconditionallyRequired when --kind is text or choice; forbidden for date/money/number/boolean (those kinds have no such property, matching the IXP UI's radio visibility). Whether the value appears verbatim in the document, or is inferred/computed.
--choices <json>JSON arrayconditionallyRequired when --kind choice: [{"value":"<canonical>","alternates":["<alt1>",...]}]. value is the canonical display name (model output); alternates (optional) are other spellings the model maps to value.
Examples​
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
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."
# 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"}]'
# 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"}]'
Data shape (--output json)​
{
  "Code": "IxpDataTypesAdd",
  "Data": { "ProjectName": "my-invoices", "Name": "Email Address", "Kind": "text", "InputValue": "exact-match" }
}
{
  "Code": "IxpDataTypesAdd",
  "Data": { "ProjectName": "my-invoices", "Name": "Email Address", "Kind": "text", "InputValue": "exact-match" }
}

uip ixp data-types update-instructions​

Replace the instructions on an existing data type.

Arguments​
NameRequiredPurpose
<project-name>yesProject name.
Options​
LongValueRequiredDescription
--name <name>stringyesData type name.
--instructions <text>stringyesNew instructions (replaces the existing value).
Example​
uip ixp data-types update-instructions my-invoices --name "Email Address" \
  --instructions "A valid email address in the form local@domain. Reject malformed addresses."
uip ixp data-types update-instructions my-invoices --name "Email Address" \
  --instructions "A valid email address in the form local@domain. Reject malformed addresses."
Data shape (--output json)​
{ "Code": "IxpDataTypesUpdateInstructions", "Data": { "ProjectName": "my-invoices", "Name": "Email Address" } }
{ "Code": "IxpDataTypesUpdateInstructions", "Data": { "ProjectName": "my-invoices", "Name": "Email Address" } }

uip ixp data-types rename​

Rename a data type. Existing field references stay intact.

Options​
LongValueRequiredDescription
--name <name>stringyesCurrent data type name.
--new-name <name>stringyesNew data type name.
Example​
uip ixp data-types rename my-invoices --name "Email Address" --new-name "Email"
uip ixp data-types rename my-invoices --name "Email Address" --new-name "Email"
Data shape (--output json)​
{ "Code": "IxpDataTypesRename", "Data": { "ProjectName": "my-invoices", "OldName": "Email Address", "NewName": "Email" } }
{ "Code": "IxpDataTypesRename", "Data": { "ProjectName": "my-invoices", "OldName": "Email Address", "NewName": "Email" } }

uip ixp data-types delete​

Delete a data type. Irreversible: any field referencing it via field_type_id will break.

Options​
ShortLongValueRequiredDescription
—--name <name>stringyesData type name to delete.
-y--yesflagyesConfirm this irreversible operation.
Example​
uip ixp data-types delete my-invoices --name "Email Address" --yes
uip ixp data-types delete my-invoices --name "Email Address" --yes
Data shape (--output json)​
{ "Code": "IxpDataTypesDelete", "Data": { "ProjectName": "my-invoices", "Name": "Email Address" } }
{ "Code": "IxpDataTypesDelete", "Data": { "ProjectName": "my-invoices", "Name": "Email Address" } }

uip ixp groups​

Manage field groups (label_defs) — the document-type containers for fields.

uip ixp groups add​

Create a new field group with instructions and at least one field.

Options​
LongValueRequiredDescription
--name <name>stringyesNew field group name.
--instructions <text>stringyesWhat kind of document/section the group covers.
--fields <json>JSON arrayyesAt least one field: [{"name":"...","type":"<data-type-name>","instructions":"..."}]. type is the name of a data type (entity_def) in the project's taxonomy — resolved and validated server-side.
Example​
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."}]'
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."}]'
Data shape (--output json)​
{ "Code": "IxpGroupsAdd", "Data": { "ProjectName": "my-invoices", "Group": "Invoice", "FieldsCreated": 3 } }
{ "Code": "IxpGroupsAdd", "Data": { "ProjectName": "my-invoices", "Group": "Invoice", "FieldsCreated": 3 } }

uip ixp groups delete​

Delete a field group. Irreversible: all annotations on all fields in the group are deleted.

Options​
ShortLongValueRequiredDescription
—--name <name>stringyesField group name to delete.
-y--yesflagyesConfirm this irreversible operation.
Example​
uip ixp groups delete my-invoices --name Invoice --yes
uip ixp groups delete my-invoices --name Invoice --yes
Data shape (--output json)​
{ "Code": "IxpGroupsDelete", "Data": { "ProjectName": "my-invoices", "Group": "Invoice" } }
{ "Code": "IxpGroupsDelete", "Data": { "ProjectName": "my-invoices", "Group": "Invoice" } }

uip ixp groups rename​

Rename a field group. Preserves all fields and annotations.

Options​
LongValueRequiredDescription
--name <name>stringyesCurrent field group name.
--new-name <name>stringyesNew field group name.
Example​
uip ixp groups rename my-invoices --name Invoice --new-name InvoiceHeader
uip ixp groups rename my-invoices --name Invoice --new-name InvoiceHeader
Data shape (--output json)​
{ "Code": "IxpGroupsRename", "Data": { "ProjectName": "my-invoices", "OldName": "Invoice", "NewName": "InvoiceHeader" } }
{ "Code": "IxpGroupsRename", "Data": { "ProjectName": "my-invoices", "OldName": "Invoice", "NewName": "InvoiceHeader" } }

uip ixp groups update-prompts​

Bulk-update field group extraction instructions, matched by group name. Existing fields are preserved.

Options​
LongValueRequiredDescription
--updates <json>JSON arrayyes[{"name":"<group>","instructions":"..."}]. Matched by label_def name — unmatched names are reported, not errored.
Example​
uip ixp groups update-prompts my-invoices --updates '[{"name":"Invoice","instructions":"Header fields at the top of the document"}]'
uip ixp groups update-prompts my-invoices --updates '[{"name":"Invoice","instructions":"Header fields at the top of the document"}]'
Data shape (--output json)​
{
  "Code": "IxpGroupsUpdatePrompts",
  "Data": { "ProjectName": "my-invoices", "GroupsUpdated": 1, "Unmatched": [] }
}
{
  "Code": "IxpGroupsUpdatePrompts",
  "Data": { "ProjectName": "my-invoices", "GroupsUpdated": 1, "Unmatched": [] }
}

uip ixp fields​

Edit fields within a project's field groups (label_defs).

uip ixp fields add​

Add a new field to a field group.

Options​
LongValueRequiredDescription
--group <name>stringyesField group (label_def) name.
--field <name>stringyesNew field name.
--type <type-name>stringyesField type — name of a data type (entity_def) in the project's taxonomy.
--instructions <text>stringyesWhat to extract and where to find it.
Example​
uip ixp fields add my-invoices --group Invoice --field "Due Date" --type Date \
  --instructions "Date payment is due."
uip ixp fields add my-invoices --group Invoice --field "Due Date" --type Date \
  --instructions "Date payment is due."
Data shape (--output json)​
{
  "Code": "IxpFieldsAdd",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Due Date", "FieldTypeId": "c3f08a1b6d2e4f97" }
}
{
  "Code": "IxpFieldsAdd",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Due Date", "FieldTypeId": "c3f08a1b6d2e4f97" }
}

uip ixp fields delete​

Delete a field from a field group.

Options​
ShortLongValueRequiredDescription
—--group <name>stringyesField group name.
—--field <name>stringyesField name to delete.
-y--yesflagyesConfirm this irreversible operation.
Example​
uip ixp fields delete my-invoices --group Invoice --field 'Due Date' --yes
uip ixp fields delete my-invoices --group Invoice --field 'Due Date' --yes
Data shape (--output json)​
{ "Code": "IxpFieldsDelete", "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Due Date" } }
{ "Code": "IxpFieldsDelete", "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Due Date" } }

uip ixp fields rename​

Rename a field within a field group.

Options​
LongValueRequiredDescription
--group <name>stringyesField group name.
--field <name>stringyesCurrent field name.
--new-name <name>stringyesNew field name.
Example​
uip ixp fields rename my-invoices --group Invoice --field 'Due Date' --new-name 'Payment Due'
uip ixp fields rename my-invoices --group Invoice --field 'Due Date' --new-name 'Payment Due'
Data shape (--output json)​
{
  "Code": "IxpFieldsRename",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "OldName": "Due Date", "NewName": "Payment Due" }
}
{
  "Code": "IxpFieldsRename",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "OldName": "Due Date", "NewName": "Payment Due" }
}

uip ixp fields change-type​

Change a field's type. Irreversible: existing annotations for this field are deleted.

Options​
ShortLongValueRequiredDescription
—--group <name>stringyesField group name.
—--field <name>stringyesField name.
—--type <type-name>stringyesNew field type — name of a data type in the project's taxonomy.
-y--yesflagyesConfirm this irreversible operation (deletes the field's annotations).
Example​
uip ixp fields change-type my-invoices --group Invoice --field 'Total' --type Money --yes
uip ixp fields change-type my-invoices --group Invoice --field 'Total' --type Money --yes
Data shape (--output json)​
{
  "Code": "IxpFieldsChangeType",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Total", "NewFieldTypeId": "d9b1740e3a6c2f85" }
}
{
  "Code": "IxpFieldsChangeType",
  "Data": { "ProjectName": "my-invoices", "FieldGroup": "Invoice", "Field": "Total", "NewFieldTypeId": "d9b1740e3a6c2f85" }
}

uip ixp fields update-prompts​

Bulk-update per-field extraction instructions. Each update names its field group, and the field is matched by name within that group. Existing field definitions are preserved.

Options​
LongValueRequiredDescription
--updates <json>JSON arrayyes[{"group":"<group>","name":"<field>","instructions":"..."}]. group is the field group (label_def) name, and name is the field name within that group. A field that does not match is reported in Unmatched as "<group> > <field>".
Example​
uip ixp fields update-prompts my-invoices --updates '[{"group":"Invoice","name":"Invoice Number","instructions":"7-digit numeric ID at top-right"},{"group":"Invoice","name":"Total","instructions":"Grand total at the bottom"}]'
uip ixp fields update-prompts my-invoices --updates '[{"group":"Invoice","name":"Invoice Number","instructions":"7-digit numeric ID at top-right"},{"group":"Invoice","name":"Total","instructions":"Grand total at the bottom"}]'
Data shape (--output json)​
{
  "Code": "IxpFieldsUpdatePrompts",
  "Data": { "ProjectName": "my-invoices", "FieldsUpdated": 2, "Unmatched": [] }
}
{
  "Code": "IxpFieldsUpdatePrompts",
  "Data": { "ProjectName": "my-invoices", "FieldsUpdated": 2, "Unmatched": [] }
}

The response can also carry Failed, a list of { "FieldGroup": "<group>", "Error": "<message>" } entries, one per field group that returned an error.

See also​

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated