Taxonomía de uip ixp: campos, grupos, tipos de datos

Sintaxis y opciones para `campos de UIP ixp`, `grupos de uip ixp` y `tipos de datos de uip ixp`, que editan la taxonomía de extracción de un proyecto pieza por pieza.

Tres grupos de comandos editan la taxonomía de un proyecto de forma incremental: uip ixp data-types (entity_defs — definiciones de tipo reutilizables), uip ixp groups (label_defs — contenedores de grupos de campos) y uip ixp fields (los valores individuales con nombre dentro de un grupo). Consulta Conceptos en la página principal para ver cómo se relacionan estos tres, y projects get-taxonomy/import-taxonomy para mover toda la taxonomía como un solo artefacto.

El Data de cada verbo es la respuesta de la API de Extracción y Procesamiento Inteligentes (IXP) reenviada palabra por palabra, conservando su carcasa de clave nativa.

Sinopsis

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>

tipos-de-datos-ixp-uip

Gestionar tipos de datos (entity_defs): los campos de definiciones de tipo reutilizables referenciados por su nombre.

añadir tipos de datos ixp de uip

Crea un nuevo tipo de datos en el proyecto.

Argumentos

Nombre	Obligatorio	Propósito
<project-name>	Sí	Nombre del proyecto.

Opciones

Largo	Valor	Obligatorio	Descripción
--name <name>	String	Sí	Nombre del tipo de datos.
--kind <kind>	text|date|money|number|boolean|choice	Sí	Clase de tipo de datos subyacente.
--instructions <text>	String	Sí	Qué representa este tipo y dónde aparecen sus valores.
--input-value <mode>	exact-match|inferred	condicionalmente	Obligatorio cuando --kind es text o choice; prohibido para date/money/number/boolean (esos tipos no tienen tal propiedad, coincidiendo con la visibilidad de radio de la IU de Extracción y Procesamiento Inteligentes (IXP)). Si el valor aparece textualmente en el documento o se infiere/calcula.
--choices <json>	MatrizJson	condicionalmente	Obligatorio cuando --kind choice: [{"value":"<canonical>","alternates":["<alt1>",...]}]. value es el nombre para mostrar canónico (salida del modelo); alternates (opcional) son otras grafías a las que el modelo asigna value.

Ejemplos

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

Forma de datos (--json de salida)

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

UIP ixp instrucciones-actualización de tipos de datos

Reemplaza las instrucciones en un tipo de datos existente.

Argumentos

Nombre	Obligatorio	Propósito
<project-name>	Sí	Nombre del proyecto.

Opciones

Largo	Valor	Obligatorio	Descripción
--name <name>	String	Sí	Nombre del tipo de datos.
--instructions <text>	String	Sí	Nuevas instrucciones (reemplaza el valor existente).

Ejemplo

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

Forma de datos (--json de salida)

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

Cambio de nombre de tipos de datos de UIP ixp

Cambiar el nombre de un tipo de datos. Las referencias de campo existentes permanecen intactas.

Opciones

Largo	Valor	Obligatorio	Descripción
--name <name>	String	Sí	Nombre del tipo de datos actual.
--new-name <name>	String	Sí	Nuevo nombre del tipo de datos.

Ejemplo

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

Forma de datos (--json de salida)

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

Eliminar tipos de datos de UIP ixp

Eliminar un tipo de datos. Irreversible: cualquier campo que haga referencia a él a través de field_type_id se interrumpirá.

Opciones

Corto	Largo	Valor	Obligatorio	Descripción
—	--name <name>	String	Sí	Nombre del tipo de datos que se eliminará.
-y	--yes	Marca	Sí	Confirme esta operación irreversible.

Ejemplo

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

Forma de datos (--json de salida)

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

grupos ixp de uip

Gestionar grupos de campos (label_defs): los contenedores de tipo de documento para los campos.

agregar grupos ixp de uip

Cree un nuevo grupo de campos con instrucciones y al menos un campo.

Opciones

Largo	Valor	Obligatorio	Descripción
--name <name>	String	Sí	Nuevo nombre del grupo de campos.
--instructions <text>	String	Sí	Qué tipo de documento/sección cubre el grupo.
--fields <json>	MatrizJson	Sí	Al menos un campo: [{"name":"...","type":"<data-type-name>","instructions":"..."}]. type es el nombre de un tipo de datos (entity_def) en la taxonomía del proyecto: resuelto y validado del lado del servidor.

Ejemplo

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

Forma de datos (--json de salida)

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

eliminar grupos ixp de uip

Eliminar un grupo de campos. Irreversible: se eliminan todas las anotaciones de todos los campos del grupo.

Opciones

Corto	Largo	Valor	Obligatorio	Descripción
—	--name <name>	String	Sí	Nombre del grupo de campos que se va a eliminar.
-y	--yes	Marca	Sí	Confirme esta operación irreversible.

Ejemplo

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

Forma de datos (--json de salida)

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

cambio de nombre de grupos ixp de uip

Cambiar el nombre de un grupo de campos. Conserva todos los campos y anotaciones.

Opciones

Largo	Valor	Obligatorio	Descripción
--name <name>	String	Sí	Nombre del grupo de campos actual.
--new-name <name>	String	Sí	Nuevo nombre del grupo de campos.

Ejemplo

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

Forma de datos (--json de salida)

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

grupos ixp de uip: solicitudes de actualización

Instrucciones de extracción de grupos de campos de actualización masiva, emparejadas por nombre de grupo. Los campos existentes se conservan.

Opciones

Largo	Valor	Obligatorio	Descripción
--updates <json>	MatrizJson	Sí	[{"name":"<group>","instructions":"..."}]. Coincidencias por nombre label_def: se informan los nombres no coincidentes, no con errores.

Ejemplo

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

Forma de datos (--json de salida)

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

campos ixp de uip

Editar campos dentro de los grupos de campos de un proyecto (label_defs).

añadir campos ixp de uip

Añadir un nuevo campo a un grupo de campos.

Opciones

Largo	Valor	Obligatorio	Descripción
--group <name>	String	Sí	Nombre del grupo de campos (label_def).
--field <name>	String	Sí	Nuevo nombre de campo.
--type <type-name>	String	Sí	Tipo de campo: nombre de un tipo de datos (entity_def) en la taxonomía del proyecto.
--instructions <text>	String	Sí	Qué extraer y dónde encontrarlo.

Ejemplo

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

Forma de datos (--json de salida)

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

eliminar campos ixp de uip

Eliminar un campo de un grupo de campos.

Opciones

Corto	Largo	Valor	Obligatorio	Descripción
—	--group <name>	String	Sí	Nombre del grupo de campos.
—	--field <name>	String	Sí	Nombre del campo a eliminar.
-y	--yes	Marca	Sí	Confirme esta operación irreversible.

Ejemplo

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

Forma de datos (--json de salida)

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

cambio de nombre de los campos ixp de uip

Cambiar el nombre de un campo dentro de un grupo de campos.

Opciones

Largo	Valor	Obligatorio	Descripción
--group <name>	String	Sí	Nombre del grupo de campos.
--field <name>	String	Sí	Nombre del campo actual.
--new-name <name>	String	Sí	Nuevo nombre de campo.

Ejemplo

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

Forma de datos (--json de salida)

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

Tipo de cambio de campos ixp de uip

Cambiar el tipo de un campo. Irreversible: se eliminan las anotaciones existentes para este campo.

Opciones

Corto	Largo	Valor	Obligatorio	Descripción
—	--group <name>	String	Sí	Nombre del grupo de campos.
—	--field <name>	String	Sí	Nombre del campo.
—	--type <type-name>	String	Sí	Nuevo tipo de campo: nombre de un tipo de datos en la taxonomía del proyecto.
-y	--yes	Marca	Sí	Confirme esta operación irreversible (elimina las anotaciones del campo).

Ejemplo

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

Forma de datos (--json de salida)

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

solicitudes de actualización de campos ixp de uip

Instrucciones de extracción por campo de actualización masiva, emparejadas por nombre de campo en todos los grupos de campos. Se conservan las definiciones de campo existentes.

Opciones

Largo	Valor	Obligatorio	Descripción
--updates <json>	MatrizJson	Sí	[{"name":"<field>","instructions":"..."}]. Coincidencia por nombre de campo.

Ejemplo

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

Forma de datos (--json de salida)

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

Relacionado

• uip ixp : conceptos y el directorio de recursos completo.
• proyectos ixp de uip : get-taxonomy/import-taxonomy para mover toda la taxonomía como un solo artefacto.
• Documentos y etiquetados de ixp de uip : los campos/grupos definidos aquí se predicen y confirman allí.

Ver también

• Descripción general de la herramienta IXP
• Opciones globales
• Códigos de salida