documentos uipath IXP e amp; rotulagem

Sintaxe e opções para "documentos UIP IXP" e "rotulagem UIP IXP", que gerenciam documentos de treinamento e revisam/confirmam as previsões do modelo sobre eles.

uip ixp documents gerencia os documentos de treinamento brutos de um projeto (upload/download/delete/list). uip ixp labellings revisa e confirma as previsões do modelo nesses documentos — a etapa de intervenção humana que produz a verdade para o retreinamento. Consulte Conceitos na página principal para saber como isso se encaixa no loop de treinamento.

Resumo

uip ixp documents list <project-name> [-l, --limit <n>] [--offset <n>]
uip ixp documents download <project-name> <document-id> [-o, --output <path>]
uip ixp documents upload <project-name> <file>
uip ixp documents delete <project-name> <document-id> -y

uip ixp labellings confirm <project-name> [document-id] [-f, --fields <ids>] [-c, --corrections <json>] [--group <name>] [--occurrence <n>] [--updates <json>] [-m, --model-version <n>]
uip ixp labellings unconfirm <project-name> <document-id> [-f, --fields <ids>] [--group <name>] [--occurrence <n>] [--updates <json>]
uip ixp labellings mark-missing <project-name> <document-id> -f, --fields <ids>
uip ixp labellings get-predictions <project-name> [document-id]

documentos do uipath iXp

Leia o conteúdo do documento IXP.

lista de documentos uipath iXp

Lista todos os documentos em um projeto.

Argumentos

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

Opções

Short	Long	Valor	Padrão	Description
-l	--limit <number>	1-10000	50	Número de itens a serem retornados.
—	--offset <number>	0 a 1000000	0	Número de itens a serem ignorados.

Exemplos

uip ixp documents list my-invoices

uip ixp documents list my-invoices --limit 100 --offset 100

Formato dos dados (--output json)

{
  "Code": "IxpDocumentsList",
  "Data": {
    "Documents": [
      { "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21", "AttachmentRef": "c1a7e9d3-8b2f-4e60-9a15-7d3c6f0b4e28", "Filename": "invoice-001.pdf" }
    ],
    "Total": 120,
    "Offset": 0,
    "Limit": 50
  }
}

Download de documentos do UIIP IXP

Baixe o arquivo do documento original (PDF/PNG/JPG/ etc.) para visualização. A extensão do arquivo é corrigida automaticamente para corresponder ao tipo de conteúdo real que o servidor relata — ele não confia na extensão de --output.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.
<document-id>	sim	ID do documento.

Opções

Short	Long	Valor	Padrão	Description
-o	--output <path>	Path	um caminho tmpdir gerado	Caminho do arquivo de saída. A extensão é corrigida automaticamente (por exemplo .jpeg/.tiff são aceitos como equivalentes a .jpg/.tif, caso contrário, uma extensão incompatível ou ausente será substituída/acrescentada).

Exemplo

uip ixp documents download my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 -o ./doc

Formato dos dados (--output json)

{
  "Code": "IxpDocumentsDownload",
  "Data": { "Path": "./doc.pdf", "ContentType": "application/pdf", "SizeBytes": 102400 }
}

upload de documentos UIP IXP

Carregue um arquivo de documento para um projeto existente. Rejeitar extensões de arquivo incompatíveis no lado do cliente antes de qualquer chamada de rede.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.
<file>	sim	Caminho para o arquivo de documento a ser carregado.

Exemplo

uip ixp documents upload my-invoices ./invoice.pdf

Formato dos dados (--output json)

{
  "Code": "IxpDocumentsUpload",
  "Data": {
    "ProjectName": "my-invoices",
    "Filename": "invoice.pdf",
    "AttachmentRef": "c1a7e9d3-8b2f-4e60-9a15-7d3c6f0b4e28",
    "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21"
  }
}

exclusão de documentos UIP IXP

Excluir um documento de um projeto.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.
<document-id>	sim	ID do documento.

Opções

Short	Long	Required	Description
-y	--yes	sim	Confirme esta operação irreversível.

Exemplo

uip ixp documents delete my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21

Formato dos dados (--output json)

{ "Code": "IxpDocumentsDelete", "Data": { "Status": "ok" } }

rotulagem uipath iXP

Gerenciar rotulagem e previsões do IXP — a etapa de revisão humana que transforma as previsões do modelo em verdade fundamental confirmada.

Observação:

confirm e get-predictions aceitam um [document-id] opcional — omitir que ele aplica a operação em todos os documentos no projeto. Este formulário para todo o projeto está obsoleto e será removido em uma versão futura; uma linha [WARN] é gravada no stderr quando você o omite (stdout permanece analisável para o script --output json ). Transmita um ID de documento, encontrado por uip ixp documents list.

Grupos de campos repetíveis: segmentação de ocorrências

Para um grupo de campos repetível (por exemplo "Itens de linha" com uma ocorrência por linha de fatura), confirm e unconfirm compartilham um modelo de segmentação comum por meio de --group:

Bandeiras	Efeito
--group <name> sozinho	Segmenta cada ocorrência do grupo.
--group <name> --occurrence <n>	Segmenta exatamente uma ocorrência (índice baseado em 0) — o formulário errata de linha única. Requer --group e um ID do documento.
--group <name> --updates <json>	Tem como alvo várias ocorrências específicas em uma chamada anônima: [{"occurrence":<n>,"fields"?:[...],"corrections"?:{...}}] (confirmação) ou [{"occurrence":<n>,"fields"?:[...]}] (não confirmação). --updates é o superconjunto — --occurrence <n> é equivalente a uma única entrada --updates. mutuamente exclusivo com --occurrence, --fields e (para confirm) --corrections.

--group deve ser o caminho completo do rótulo, exatamente como mostrado no campo Name da saída de get-predictions (por exemplo "Invoice > Line Items"), não apenas o nome da folha.

confirmação de rotulagem uipath IXP

Confirme previsões geradas por IXP como verdade fundamental para um documento.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.
[document-id]	não	ID do documento. Omitir isso confirma todos os documentos no projeto — obsoleto.

Opções

Short	Long	Valor	Description
-f	--fields <field-ids>	separados por vírgula	IDs de campo a serem confirmados. Omita para confirmar todos os campos previstos. Sem --group, confirma cada ID de campo em cada ocorrência em que aparece; com --group --occurrence, confirma apenas dentro dessa ocorrência.
-c	--corrections <json>	Matriz JSON	Substitui valores previstos, mantendo as referências: [{"field_id":"...","value":"corrected"}]. Aplica-se a todas as ocorrências em que o campo aparece (ou a ocorrência de destino). Mutualmente exclusivo com --updates.
—	--group <name>	String	Grupo de campos de destino — consulte a tabela de segmentação acima.
—	--occurrence <index>	Número inteiro	Índice de ocorrência única dentro de --group. Consulte a tabela de segmentação acima.
—	--updates <json>	Matriz JSON	Formulário de várias ocorrências em lote. Consulte a tabela de segmentação acima.
-m	--model-version <version>	número inteiro não negativo	Protetor de simultaneidade otimizada: a versão do modelo (de) em get-predictions ModelVersionque as previsões foram revisadas. Se um retreinamento produziu uma versão mais recente desde então, a confirmação será rejeitada em vez de carimbos valores derivados como verdade fundamental. Omita para ignorar a verificação.

Exemplos

# Confirm a single document with a field filter and a correction
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  -f a7c3e9105f2b4d86,b2f8a01c7d3e6940 -c '[{"field_id":"a7c3e9105f2b4d86","value":"INV-7654321"}]'

# Confirm all predicted fields on a document as-is
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21

# Confirm every occurrence of a repeatable group
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 --group "Line Items"

# Single occurrence
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  --group "Line Items" --occurrence 2

# Batched: confirm one field in two specific occurrences, in one atomic call
uip ixp labellings confirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  --group "Loan and Property" --updates '[{"occurrence":0,"fields":["e9b1746c0a2f5d83"]},{"occurrence":2,"fields":["e9b1746c0a2f5d83"]}]'

Formato dos dados (--output json)

{
  "Code": "IxpLabellingsConfirm",
  "Data": { "ProjectName": "my-invoices", "TotalDocuments": 1, "PredictionsConfirmed": 1 }
}

TotalDocuments/PredictionsConfirmed documentos de contagem, não campos (PredictionsConfirmed é 0 ou 1 por documento — isso preserva o contrato por documento da CLI legada mesmo que a contagem de campos subjacente possa ser maior).

rotulagem uipath IXP não confirmada

Remover confirmações de um documento — os campos direcionados voltam a não anotados. Use para reverter um confirm/mark-missing incorreto. Todas as outras anotações no documento são carregadas. Compartilha o modelo de segmentação --group/--occurrence/--updates de confirm (consulte a tabela acima), menos --corrections/--model-version.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.
<document-id>	sim	ID do documento.

Opções

Short	Long	Valor	Description
-f	--fields <field-ids>	separados por vírgula	IDs de campo a não confirmar.
—	--group <name>	String	Grupo de campos de destino.
—	--occurrence <index>	Número inteiro	Índice de ocorrência única.
—	--updates <json>	Matriz JSON	Formulário de várias ocorrências em lote: [{"occurrence":<n>,"fields"?:[...]}].

Pelo menos um dos --fields/--group é necessário — não confirmar um documento inteiro implicitamente não é permitido.

Exemplos

uip ixp labellings unconfirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  -f a7c3e9105f2b4d86,b2f8a01c7d3e6940

uip ixp labellings unconfirm my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 --group "Line Items"

Formato dos dados (--output json)

{
  "Code": "IxpLabellingsUnconfirm",
  "Data": {
    "ProjectName": "my-invoices",
    "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21",
    "FieldsUnconfirmed": 2,
    "Unmatched": []
  }
}

rotulagem de IXP da uip marca-falta

Marcar campos como ausentes em um documento — anotado como sem valor e sem localização. Use quando o campo estiver realmente ausente.

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.
<document-id>	sim	ID do documento.

Opções

Short	Long	Valor	Required	Description
-f	--fields <field-ids>	separados por vírgula	sim	IDs de campo a serem marcados como ausentes.

Exemplo

uip ixp labellings mark-missing my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21 \
  -f a7c3e9105f2b4d86,b2f8a01c7d3e6940

Formato dos dados (--output json)

{
  "Code": "IxpLabellingsMarkMissing",
  "Data": {
    "ProjectName": "my-invoices",
    "DocumentId": "5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21",
    "FieldsMarked": 2,
    "Unmatched": []
  }
}

obter-previsões de rotulagem de Extração e Processamento Inteligente (IXP) do uip

Obtenha previsões do modelo de IXP para documentos em um projeto — rótulos e valores de campo previstos, além do ModelVersion que os produziu (null quando um documento ainda não tem previsões).

Argumentos

Name	Required	Finalidade
<project-name>	sim	Nome do projeto.
[document-id]	não	ID do documento. Omitir que seja distribuído em todos os documentos no projeto — obsoleto.

Exemplos

uip ixp labellings get-predictions my-invoices 5f3a9c21-7e4b-4d8a-9f12-6c0b8e3d2a14.7f3c8a21

Formato dos dados (--output json)

{
  "Code": "IxpLabellingsGetPredictions",
  "Data": { "ProjectName": "my-invoices", "TotalDocuments": 1, "DocumentsWithPredictions": 1, "Predictions": [] }
}

As entradas Predictions preservam o PascalCase nativo da API, incluindo um índice Occurrence por rótulo para grupos repetíveis.

Relacionado

• uip ixp — conceitos e o diretório completo de recursos.
• Projetos uip IXP — get-metrics para verificar a qualidade da rotulagem; publish para enviar um modelo retreinado.
• taxonomia uiip ixp — as previsões de campos/grupos aqui são pontuadas.

Veja também

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