Partilhar via

Zuva DocAI

Incorpore a IA de contratos em seus fluxos de trabalho de produtos usando o Zuva DocAI. Não há necessidade de desenvolvimento de IA desde o início, aproveite as APIs do DocAI para extrair informações de seus contratos.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte Zuva
URL https://zuva.ai/support/
Email support@zuva.ai
Metadados do conector
Editora Zuva Inc.
Sítio Web https://zuva.ai/
Política de privacidade https://zuva.ai/privacy/
Categorias IA

Este conector permite que os usuários encontrem e extraiam entidades, frases e parágrafos de contratos (e documentos relacionados), aproveitando a melhor IA de contratos do Zuva. Projetado e treinado para identificar cláusulas legais em vários setores e casos de uso, esse conector fornece um conjunto plug-and-play de módulos para incorporar IA de contratos em seus fluxos de trabalho. Este conector vem com OCR para ler seus documentos, bem como recursos de classificação e normalização de documentos.

Pré-requisitos

Você precisará de uma conta Zuva e um token DocAI. Comece inscrevendo-se para uma conta gratuita.

Como obter credenciais

Zuva DocAI tem vários servidores regionais. Você precisará criar um token de API para a região específica que deseja usar.

  1. Crie e/ou inicie sessão na sua conta em zuva.ai.
  2. Navegue até o console do DocAI
  3. Selecione a região que deseja usar.
  4. Copie o URL base da região para a sua ligação.
  5. Crie um token e copie-o para usar em sua conexão.

Consulte o guia de início rápido do DocAI para obter mais informações sobre contas e tokens Zuva.

Introdução ao conector

Para usar o conector Zuva DocAI, você precisará definir um fluxo semelhante ao seguinte:

Etapa 1: Obter um arquivo

Para fins de teste, você pode criar um "Fluxo instantâneo de nuvem" no Power Automate. Escolha "Acionar manualmente um fluxo" e crie o fluxo. Adicione uma entrada e escolha o tipo "Arquivo".

Etapa 2: enviar um arquivo

Adicione a Submit a file ação e escolha o "Conteúdo do arquivo" da etapa anterior como entrada.

Nota: o arquivo não deve ser transformado de forma alguma (ou seja, sem codificação base64). DocAI só aceita dados binários brutos.

Etapa 3: Iniciar o processamento do arquivo

Escolha qual serviço você gostaria de usar adicionando uma das seguintes ações:

  • Create Language Classification Request
  • Create Document Classification Request
  • Create Multi-Level Classification Request
  • Create Field Extraction Request
  • Create OCR Request

Cada um deles aceita o ID do arquivo (retornado da Submit a file ação) como entrada.

A extração de campo também requer IDs de campo como entradas. Os IDs de campo podem ser encontrados na Biblioteca de Campos (login necessário), do instrutor de IA , se você tiver treinado campos personalizados, ou programaticamente usando a Get Field List ação.

Passo 4: Sondagem para conclusão do pedido

Use um Do Until bloco (encontrado na seção "Controle") e adicione a ação de verificação de status correta ao interior do bloco:

  • Get Field Extraction Request Status
  • Get Language Classification Request Status
  • Get Document Classification Request Status
  • Get MLC request Status
  • Get OCR Request Status

A Get ____ status ação toma como entrada o ID da solicitação de sua ação correspondente Create ____ Request .

Você também deve adicionar um bloco de 10 segundos Delay dentro do Do until bloco, para garantir que o arquivo tenha tempo suficiente para processar.

Defina a condição para que o Do Until bloco seja Is Finished? igual a true.

Passo 4: Obter resultados

Por fim, use uma das ações Obter resultados correspondente à sua solicitação, usando a ID da solicitação da operação Create original como entrada:

  • Get Field Extraction Request Text Results
  • Get Language Classification Request Status
  • Get Document Classification Request Status
  • Get MLC request Status
  • Get OCR Results Text
  • Get OCR Results Images

Observe que, para Idioma, Classificação de Documentos e MLC, os resultados são incluídos na resposta Status.

Você pode querer verificar a documentação do DocAI para obter mais informações sobre a estrutura dos resultados da extração de campo.

Problemas conhecidos e limitações

Campos por pedido

Uma única Create Field Extraction Request ação pode incluir um máximo de 100 campos.

Campos personalizados

O conector não suporta nenhum dos pontos de extremidade do DocAI relacionados ao treinamento de campos personalizados ou à obtenção de metadados de um campo individual.

Diferenças com a API subjacente

Além disso, observe que a funcionalidade do conector não corresponde um a um com a documentação da API subjacente. Em particular, o conector:

  1. Expõe um booleano extra is_finished , que pode ser usado para dizer se a solicitação está completa ou falhou
  2. Todas as solicitações operam em arquivos únicos, em vez de lotes de vários arquivos.

Erros e soluções comuns

Certifique-se de carregar binário bruto, em vez de cadeias de caracteres codificadas em base64. Você pode usar o serviço OCR e verificar se ele retorna o texto esperado.

FAQ

Onde posso encontrar informações adicionais sobre o Zuva DocAI?

https://zuva.ai/docai/

Onde posso encontrar documentação adicional sobre o Zuva DocAI?

https://zuva.ai/documentation/

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Símbolo securestring Seu token DocAI Verdade
Base URL cadeia (de caracteres) por exemplo, https://us.app.zuva.ai/api/v2 Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Criar Pedido de Classificação de Documentos

Crie uma solicitação de classificação do documento especificado.
Criar Pedido de Classificação Linguística

Crie uma solicitação para o idioma do arquivo especificado.
Criar solicitação de classificação de vários níveis

Crie uma solicitação para classificação de vários níveis do arquivo especificado.
Criar solicitação de extração de campo

Crie uma nova solicitação de extrações do arquivo especificado.
Criar uma solicitação de OCR

Crie uma nova solicitação para que o OCR seja aplicado ao arquivo especificado.
Enviar um ficheiro

Envie um arquivo para Zuva DocAI.
Excluir um arquivo

Exclua um arquivo existente do Zuva.
Normalizar datas

Normalize uma cadeia de caracteres contendo uma ou mais datas. Para cada data encontrada, o ponto de extremidade retorna um conjunto de inteiros que representam o ano, mês e dia.
Obter imagens de solicitação de OCR

Obtenha as imagens de uma solicitação de OCR concluída.
Obter lista de campos

Obtenha uma lista de todos os campos disponíveis para você.
Obter resultados de solicitação de extração de campo

Obtenha resultados de texto de uma solicitação de extração de campo concluída.
Obter Status da Solicitação de Classificação de Documentos

Obtenha o status e os resultados disponíveis para uma solicitação de classificação de documento existente.
Obter status de solicitação de classificação de idioma

Obtenha o status e os resultados disponíveis para uma solicitação de classificação de documento existente.
Obter status de solicitação de extração de campo

Verifique o status de uma solicitação de extração de campo existente.
Obter status de solicitação de OCR

Verifique o status de uma solicitação de OCR existente.
Obter status de solicitação MLC

Obtenha status e resultados disponíveis para uma solicitação de MLC existente.
Obter texto de solicitação de OCR

Obtenha o texto de uma solicitação de OCR concluída.

Criar Pedido de Classificação de Documentos

ID da Operação:
CreateDocumentClassificationRequest

Crie uma solicitação de classificação do documento especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 file_id string

O identificador exclusivo do arquivo, conforme retornado pela operação SubmitFile.

Devoluções

Name Caminho Tipo Description
ID do Pedido de Classificação
 request_id string

ID a utilizar para obter o estado e os resultados deste pedido.

Criar Pedido de Classificação Linguística

ID da Operação:
CreateLanguageClassificationRequest

Crie uma solicitação para o idioma do arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 file_id string

O identificador exclusivo do arquivo, conforme retornado pela operação SubmitFile.

Devoluções

Name Caminho Tipo Description
ID da solicitação de idioma
 request_id string

ID a utilizar para obter o estado e os resultados deste pedido.

Criar solicitação de classificação de vários níveis

ID da Operação:
CreateMlcRequest

Crie uma solicitação para classificação de vários níveis do arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 file_id string

O identificador exclusivo do arquivo, conforme retornado pela operação SubmitFile.

Devoluções

Name Caminho Tipo Description
ID da solicitação MLC
 request_id string

ID a utilizar para obter o estado e os resultados deste pedido.

Criar solicitação de extração de campo

ID da Operação:
CreateFieldExtractionRequest

Crie uma nova solicitação de extrações do arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 file_id string

O arquivo do qual extrair texto.
IDs de campo
 field_ids array of string

Os IDs dos campos a serem extraídos.

Devoluções

Name Caminho Tipo Description
ID da solicitação de extração
 request_id string

ID a utilizar para obter o estado e os resultados deste pedido.

Criar uma solicitação de OCR

ID da Operação:
CreateOcrRequest

Crie uma nova solicitação para que o OCR seja aplicado ao arquivo especificado.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 file_id string

O identificador exclusivo do arquivo, conforme retornado pela operação SubmitFile.

Devoluções

Name Caminho Tipo Description
ID de solicitação OCR
 request_id string

ID usado para obter o status e os resultados da solicitação de OCR.

Enviar um ficheiro

ID da Operação:
SubmitFile

Envie um arquivo para Zuva DocAI.

Parâmetros

Name Chave Necessário Tipo Description
Ficheiro
 File binary

Conteúdo do arquivo binário ou cadeia de caracteres de texto sem formatação para carregar. O conteúdo binário NÃO deve ser codificado em Base64.

Devoluções

Name Caminho Tipo Description
ID do ficheiro
 file_id string

O identificador exclusivo atribuído ao Zuva para o arquivo.
Tipo de conteúdo
 attributes.content-type string

Tipo de conteúdo MIME detetado do arquivo
Expiração
 expiration string

O momento em que o arquivo está agendado para ser excluído do DocAI.

Excluir um arquivo

ID da Operação:
DeleteFile

Exclua um arquivo existente do Zuva.

Parâmetros

Name Chave Necessário Tipo Description
ID do ficheiro
 file_id True string

ID do ficheiro a eliminar.

Devoluções

response
string

Normalizar datas

ID da Operação:
NormalizeDates

Normalize uma cadeia de caracteres contendo uma ou mais datas. Para cada data encontrada, o ponto de extremidade retorna um conjunto de inteiros que representam o ano, mês e dia.

Parâmetros

Name Chave Necessário Tipo Description
Texto
 text string

A cadeia de caracteres de texto a ser normalizada.

Devoluções

Name Caminho Tipo Description
ID de solicitação
 request_id string

ID do pedido
enviar SMS
 text string

O texto original que foi fornecido.
SHA-256
 sha-256 string

SHA-256 hash do texto original.
date
 date array of object

date
Day
 date.day integer

O dia do mês como um inteiro.
Mês
 date.month integer

O mês representado como um número inteiro entre 1 e 12.
Ano
 date.year integer

O ano representado como um inteiro.

Obter imagens de solicitação de OCR

ID da Operação:
GetOcrRequestImages

Obtenha as imagens de uma solicitação de OCR concluída.

Parâmetros

Name Chave Necessário Tipo Description
ID da solicitação OCR
 request_id True string

Identificador exclusivo de uma solicitação OCR existente, conforme retornado por CreateOcrRequest.

Devoluções

Um arquivo zip contendo cada página do documento como uma imagem.

Imagens
binary

Obter lista de campos

ID da Operação:
GetFieldList

Obtenha uma lista de todos os campos disponíveis para você.

Devoluções

Name Caminho Tipo Description
array of object
ID do campo
 field_id string

O identificador exclusivo do campo.
Nome
 name string

O nome do campo
Description
 description string

Uma descrição do campo.
Enviesamento
 bias double

O viés usado pelo modelo de ML subjacente.
Pontuação-F
 f_score double

O escore F do campo, uma medida estatística de sua precisão.
Precisão
 precision double

A precisão do campo.
Lembrar
 recall double

O recall do campo.
Contagem de documentos
 document_count integer

O número de documentos em que o campo foi treinado.
É personalizado?
 is_custom boolean

Booleano indicando se o campo é personalizado.
É treinado?
 is_trained boolean

Booleano indicando se um campo personalizado foi treinado.

Obter resultados de solicitação de extração de campo

ID da Operação:
GetFieldExtractionRequestResults

Obtenha resultados de texto de uma solicitação de extração de campo concluída.

Parâmetros

Name Chave Necessário Tipo Description
ID da solicitação de extração
 request_id True string

Identificador exclusivo de uma solicitação de extração existente, conforme retornado por CreateExtractionRequest.

Devoluções

Name Caminho Tipo Description
Results
 results array of object

Uma matriz dos resultados da extração de campo.
ID do campo
 results.field_id string

O identificador exclusivo para o campo extraído.
Extrações
 results.extractions array of object

Uma matriz de resultados extraídos para este campo específico.
Texto
 results.extractions.text string

O texto que foi extraído para o campo.
Abrangências
 results.extractions.spans array of object

Informações sobre a localização do texto no documento.
Start
 results.extractions.spans.start integer

O índice do primeiro caractere da extração dentro do texto do documento.
Fim
 results.extractions.spans.end integer

O índice do último caractere da extração dentro do texto do documento.
Start
 results.extractions.spans.pages.start integer

O número da página em que a extração começa.
Fim
 results.extractions.spans.pages.end integer

O número da página em que termina a extração.

Obter Status da Solicitação de Classificação de Documentos

ID da Operação:
GetDocumentClassificationRequestStatus

Obtenha o status e os resultados disponíveis para uma solicitação de classificação de documento existente.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 request_id True string

ID da solicitação de classificação de documento, conforme retornado por CreateDocumentClasssificationRequest.

Devoluções

Name Caminho Tipo Description
Status da solicitação de classificação
 status string

Status da solicitação (uma de 'enfileirado', 'processamento', 'concluído' ou 'reprovado').
Terminou?
 is_finished boolean

Booleano indicando se a solicitação atingiu um estado terminal (concluída ou falhada).
Classification
 classification string

O tipo de documento que foi detetado.
É contrato?
 is_contract boolean

Se o documento foi reconhecido como contrato ou não.

Obter status de solicitação de classificação de idioma

ID da Operação:
GetLanguageClassificationRequestStatus

Obtenha o status e os resultados disponíveis para uma solicitação de classificação de documento existente.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 request_id True string

ID da solicitação da solicitação de classificação de idioma, conforme retornado por CreateLanguageRequest.

Devoluções

Name Caminho Tipo Description
Status da solicitação de idioma
 status string

Status da solicitação (uma de 'enfileirado', 'processamento', 'concluído' ou 'reprovado').
Terminou?
 is_finished boolean

Booleano indicando se a solicitação atingiu um estado terminal (concluída ou falhada).
Linguagem
 language string

O idioma principal detetado do documento.

Obter status de solicitação de extração de campo

ID da Operação:
GetFieldExtractionRequestStatus

Verifique o status de uma solicitação de extração de campo existente.

Parâmetros

Name Chave Necessário Tipo Description
ID da solicitação de extração
 request_id True string

Identificador exclusivo de uma solicitação de extração existente, conforme retornado por CreateExtractionRequest.

Devoluções

Name Caminho Tipo Description
Status da solicitação de extração de campo
 status string

Status da solicitação (uma de 'enfileirado', 'processamento', 'concluído' ou 'reprovado').
Terminou?
 is_finished boolean

Booleano indicando se a solicitação atingiu um estado terminal (concluída ou falhada).

Obter status de solicitação de OCR

ID da Operação:
GetOcrRequestStatus

Verifique o status de uma solicitação de OCR existente.

Parâmetros

Name Chave Necessário Tipo Description
ID da solicitação OCR
 request_id True string

Identificador exclusivo de uma solicitação OCR existente, conforme retornado por CreateOcrRequest.

Devoluções

Name Caminho Tipo Description
Status da solicitação de OCR
 status string

Status da solicitação (uma de 'enfileirado', 'processamento', 'concluído' ou 'reprovado').
Terminou?
 is_finished boolean

Booleano indicando se a solicitação atingiu um estado terminal (concluída ou falhada).

Obter status de solicitação MLC

ID da Operação:
GetMlcRequestStatus

Obtenha status e resultados disponíveis para uma solicitação de MLC existente.

Parâmetros

Name Chave Necessário Tipo Description
ID de solicitação
 request_id True string

ID da solicitação MLC, conforme retornado por CreateMlcRequest.

Devoluções

Name Caminho Tipo Description
Status da solicitação MLC
 status string

Status da solicitação (uma de 'enfileirado', 'processamento', 'concluído' ou 'reprovado').
Terminou?
 is_finished boolean

Booleano indicando se a solicitação atingiu um estado terminal (concluída ou falhada).
Classifications
 classifications array of string

As classificações hierárquicas do documento.

Obter texto de solicitação de OCR

ID da Operação:
GetOcrRequestText

Obtenha o texto de uma solicitação de OCR concluída.

Parâmetros

Name Chave Necessário Tipo Description
ID da solicitação OCR
 request_id True string

Identificador exclusivo de uma solicitação OCR existente, conforme retornado por CreateOcrRequest.

Devoluções

Name Caminho Tipo Description
Texto
 text string

OCR texto do documento.

Definições

cadeia (de caracteres)

Este é o tipo de dados básico 'string'.

binário

Este é o tipo de dados básico 'binário'.