taxonomia uiip IXP — campos, grupos, tipos de dados

Sintaxe e opções para "campos ixp uip", "grupos ixp uip" e "tipos de dados uip IXP", que editam a taxonomia de extração de um projeto, uma parte de cada vez.

Três grupos de comando editam a taxonomia de um projeto de forma incremental: uip ixp data-types (entity_defs — definições de tipos reutilizáveis), uip ixp groups (label_defs — contêineres de grupo de campos) e uip ixp fields (os valores individuais nomeados dentro de um grupo). Consulte Conceitos na página pai para saber como esses três se relacionam e projects get-taxonomy/import-taxonomy para mover toda a taxonomia como um artefato.

O Data de cada verbo é o texto encaminhado da resposta da API do IXP, preservando suas maiúsculas e minúsculas nativas.

Resumo

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 dados do UIP IXP

Gerenciar tipos de dados (entity_defs) — os campos de definições de tipos reutilizáveis referenciam por nome.

adicionar de tipos de dados de IXP do uip

Crie um novo tipo de dados no projeto.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Opções

Long	Valor	Required	Description
--name <name>	String	sim	Nome do tipo de dados.
--kind <kind>	text|date|money|number|boolean|choice	sim	Tipo de tipo de dados subjacente.
--instructions <text>	String	sim	O que esse tipo representa e onde seus valores aparecem.
--input-value <mode>	exact-match|inferred	condicionalmente	Obrigatório quando --kind é text ou choice; proibido para date/money/number/boolean (esses tipos não têm essa propriedade, correspondendo à visibilidade do rádio da interface gráfica do IXP). Se o valor aparece literalmente no documento ou é inferido/calculado.
--choices <json>	Matriz JSON	condicionalmente	Obrigatório quando --kind choice: [{"value":"<canonical>","alternates":["<alt1>",...]}]. value é o nome de exibição canônico (saída do modelo); alternates (opcional) são outras grafias que o modelo mapeia para value.

Exemplos

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

Formato dos dados (--output json)

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

instruções de atualização de tipos de dados do uip IXP

Substitua as instruções em um tipo de dados existente.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.

Opções

Long	Valor	Required	Description
--name <name>	String	sim	Nome do tipo de dados.
--instructions <text>	String	sim	Novas instruções (substitui o valor existente).

Exemplo

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

Formato dos dados (--output json)

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

Renomeação de tipos de dados IXP

Renomear um tipo de dados. As referências de campo existentes permanecem intactas.

Opções

Long	Valor	Required	Description
--name <name>	String	sim	Nome do tipo de dados atual.
--new-name <name>	String	sim	Novo nome do tipo de dados.

Exemplo

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

Formato dos dados (--output json)

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

exclusão de tipos de dados do uipath IXP

Exclua um tipo de dados. Irreversível: qualquer campo que faça referência a ele por meio de field_type_id será interrompido.

Opções

Short	Long	Valor	Required	Description
—	--name <name>	String	sim	Nome do tipo de dados a ser excluído.
-y	--yes	Bandeira	sim	Confirme esta operação irreversível.

Exemplo

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

Formato dos dados (--output json)

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

Grupos UIP IXP

Gerenciar grupos de campos (label_defs) — os contêineres do tipo documento para campos.

adicionar grupos de IXP do UIP

Crie um novo grupo de campos com instruções e pelo menos um campo.

Opções

Long	Valor	Required	Description
--name <name>	String	sim	Novo nome do grupo de campos.
--instructions <text>	String	sim	O tipo de documento/seção que o grupo abrange.
--fields <json>	Matriz JSON	sim	Pelo menos um campo: [{"name":"...","type":"<data-type-name>","instructions":"..."}]. type é o nome de um tipo de dados (entity_def) na taxonomia do projeto — resolvido e validado no lado do servidor.

Exemplo

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

Formato dos dados (--output json)

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

exclusão de grupos UIP IXP

Exclua um grupo de campos. Irreversível: todas as anotações em todos os campos no grupo são excluídas.

Opções

Short	Long	Valor	Required	Description
—	--name <name>	String	sim	Nome do grupo de campos a ser excluído.
-y	--yes	Bandeira	sim	Confirme esta operação irreversível.

Exemplo

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

Formato dos dados (--output json)

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

Renomeação de grupos IXP do uip

Renomear um grupo de campos. Preserva todos os campos e anotações.

Opções

Long	Valor	Required	Description
--name <name>	String	sim	Nome do grupo de campos atual.
--new-name <name>	String	sim	Novo nome do grupo de campos.

Exemplo

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

Formato dos dados (--output json)

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

atualizações-prompts de atualização de grupos UIP IXP

Atualizar em massa as instruções de extração do grupo de campos, correspondidas pelo nome do grupo. Os campos existentes são preservados.

Opções

Long	Valor	Required	Description
--updates <json>	Matriz JSON	sim	[{"name":"<group>","instructions":"..."}]. Correspondente pelo nome de label_def — nomes não correspondentes são relatados, não com erros.

Exemplo

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

Formato dos dados (--output json)

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

campos IXP da UIP

Edite os campos dentro dos grupos de campos de um projeto (label_defs).

adicionar de campos IXP do uip

Adicione um novo campo a um grupo de campos.

Opções

Long	Valor	Required	Description
--group <name>	String	sim	Nome do grupo de campos (label_def).
--field <name>	String	sim	Novo nome do campo.
--type <type-name>	String	sim	Tipo de campo — nome de um tipo de dados (entity_def) na taxonomia do projeto.
--instructions <text>	String	sim	O que extrair e onde encontrá-lo.

Exemplo

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

Formato dos dados (--output json)

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

exclusão de campos IXP do uip

Exclua um campo de um grupo de campos.

Opções

Short	Long	Valor	Required	Description
—	--group <name>	String	sim	Nome do grupo de campos.
—	--field <name>	String	sim	Nome do campo a ser excluído.
-y	--yes	Bandeira	sim	Confirme esta operação irreversível.

Exemplo

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

Formato dos dados (--output json)

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

Renomeação de campos IXP do uip

Renomeie um campo dentro de um grupo de campos.

Opções

Long	Valor	Required	Description
--group <name>	String	sim	Nome do grupo de campos.
--field <name>	String	sim	Nome do campo atual.
--new-name <name>	String	sim	Novo nome do campo.

Exemplo

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

Formato dos dados (--output json)

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

alteração-tipo de campos IXP do uip

Alterar o tipo de um campo. Irreversível: as anotações existentes para este campo são excluídas.

Opções

Short	Long	Valor	Required	Description
—	--group <name>	String	sim	Nome do grupo de campos.
—	--field <name>	String	sim	Nome do campo.
—	--type <type-name>	String	sim	Novo tipo de campo — nome de um tipo de dados na taxonomia do projeto.
-y	--yes	Bandeira	sim	Confirme esta operação irreversível (exclui as anotações do campo).

Exemplo

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

Formato dos dados (--output json)

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

Atualização-prompts de atualização de campos IXP

Instruções de extração de atualização em massa por campo, correspondidas por nome de campo em todos os grupos de campos. As definições de campo existentes são preservadas.

Opções

Long	Valor	Required	Description
--updates <json>	Matriz JSON	sim	[{"name":"<field>","instructions":"..."}]. Correspondente pelo nome do campo.

Exemplo

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

Formato dos dados (--output json)

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

Relacionado

• uip ixp — conceitos e o diretório completo de recursos.
• Projetos UIP IXP — get-taxonomy/import-taxonomy para mover toda a taxonomia como um artefato.
• Documentos e rotulagem uip IXP — os campos/grupos definidos aqui são previstos e confirmados lá.

Veja também

• Visão geral da ferramenta de Extração e Processamento Inteligente (IXP)
• Opções globais
• Códigos de saída