Zuva DocAI
Insira a IA de Contratos nos fluxos de trabalho do produto 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.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do Zuva |
| URL | https://zuva.ai/support/ |
| support@zuva.ai |
| Metadados do conector | |
|---|---|
| Publicador | Zuva Inc. |
| Site | https://zuva.ai/ |
| Política de privacidade | https://zuva.ai/privacy/ |
| Categorias | IA |
Esse Conector permite que os usuários encontrem e extraam entidades, frases e parágrafos de contratos (e documentos relacionados), aproveitando a melhor IA de Contratos da Zuva. Projetado e treinado para identificar cláusulas legais em vários setores e casos de uso, esse conector fornece um conjunto de módulos plug-and-play para inserir a IA de Contratos em seus fluxos de trabalho. Esse Conector vem com o 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 em uma conta gratuita.
Como obter credenciais
O Zuva DocAI tem vários servidores regionais. Você precisará criar um token de API para a região específica que deseja usar.
- Crie e/ou entre em sua conta em zuva.ai.
- Navegue até o console do DocAI
- Selecione a região que você deseja usar.
- Copie a URL base da região para sua conexão.
- Crie um token e copie-o para usá-lo 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 do Zuva DocAI, você precisará definir um fluxo semelhante ao seguinte:
Etapa 1: Obter um arquivo
Para fins de teste, você pode criar um "fluxo de nuvem instantânea" no Power Automate. Escolha "Disparar manualmente um fluxo" e criar o fluxo. Adicione uma entrada e escolha o tipo "Arquivo".
Etapa 2: Enviar um arquivo
Adicione a ação Submit a file e escolha o "Conteúdo do Arquivo" na etapa anterior como a entrada.
Observação: o arquivo não deve ser transformado de forma alguma (ou seja, nenhuma codificação base64). O DocAI aceita apenas 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 RequestCreate Document Classification RequestCreate Multi-Level Classification RequestCreate Field Extraction RequestCreate OCR Request
Cada um deles aceita a ID do arquivo (retornada da ação Submit a file ) como entrada.
Além disso, a extração de campo requer IDs de campo como entradas. As IDs de campo podem ser encontradas na Biblioteca de Campos (entrada necessária), no treinador de IA se você tiver treinado campos personalizados ou programaticamente usando a ação.Get Field List
Etapa 4: Sondagem para conclusão da solicitação
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 StatusGet Language Classification Request StatusGet Document Classification Request StatusGet MLC request StatusGet OCR Request Status
A Get ____ status ação usa como entrada a 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 Is Finished? seja igual a true.
Etapa 4: Obter resultados
Por fim, use uma das ações Obter resultados correspondentes à sua solicitação, usando a ID da solicitação da operação Create original como entrada:
Get Field Extraction Request Text ResultsGet Language Classification Request StatusGet Document Classification Request StatusGet MLC request StatusGet OCR Results TextGet OCR Results Images
Observe que, para Linguagem, Classificação de Documentos e MLC, os resultados são incluídos na resposta status.
Talvez você queira verificar a documentação do DocAI para obter mais informações sobre a estrutura dos resultados de extração de campo.
Problemas e limitações conhecidos
Campos por solicitação
Um máximo de 100 campos pode ser incluído em uma única Create Field Extraction Request ação.
Campos Personalizados
O conector não dá suporte a 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:
- Expõe um booliano extra
is_finished, que pode ser usado para informar se a solicitação foi concluída ou falhou - 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.
perguntas frequentes
Onde posso encontrar informações adicionais sobre o Zuva DocAI?
Onde posso encontrar documentação adicional sobre o Zuva DocAI?
https://zuva.ai/documentation/
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia 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 |
| URL base | cadeia | Por exemplo: https://us.app.zuva.ai/api/v2 | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Criar solicitação de classificação de documento |
Crie uma solicitação de classificação do documento especificado. |
| Criar solicitação de classificação de idioma |
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 para extrações do arquivo especificado. |
| Criar uma solicitação do OCR |
Crie uma nova solicitação para que o OCR seja aplicado ao arquivo especificado. |
| Enviar um arquivo |
Envie um arquivo para o Zuva DocAI. |
| Excluir um arquivo |
Exclua um arquivo existente do Zuva. |
| Normalizar datas |
Normalize uma cadeia de caracteres que contém uma ou mais datas. Para cada data encontrada, o ponto de extremidade retorna um conjunto de inteiros que representam o ano, o mês e o dia. |
| Obter imagens de solicitação do OCR |
Obtenha as imagens de uma solicitação OCR concluída. |
| Obter Lista de Campos |
Obtenha uma lista de todos os campos disponíveis para você. |
| Obter o status da solicitação do OCR |
Verifique o status de uma solicitação OCR existente. |
| Obter resultados da solicitação de extração de campo |
Obter resultados de texto de uma solicitação de extração de campo concluída. |
| Obter status da solicitação de classificação de documento |
Obtenha o status e os resultados disponíveis para uma solicitação de classificação de documento existente. |
| Obter status da 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 da solicitação de extração de campo |
Verifique o status de uma solicitação de extração de campo existente. |
| Obter status da solicitação MLC |
Obtenha o status e os resultados disponíveis para uma solicitação MLC existente. |
| Obter texto da solicitação do OCR |
Obtenha o texto de uma solicitação OCR concluída. |
Criar solicitação de classificação de documento
Crie uma solicitação de classificação do documento especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
file_id | string |
O identificador exclusivo do arquivo, conforme retornado pela operação SubmitFile. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da solicitação de classificação
|
request_id | string |
ID a ser usada para obter o status e os resultados dessa solicitação. |
Criar solicitação de classificação de idioma
Crie uma solicitação para o idioma do arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
file_id | string |
O identificador exclusivo do arquivo, conforme retornado pela operação SubmitFile. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da solicitação de idioma
|
request_id | string |
ID a ser usada para obter o status e os resultados dessa solicitação. |
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.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
file_id | string |
O identificador exclusivo do arquivo, conforme retornado pela operação SubmitFile. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da solicitação MLC
|
request_id | string |
ID a ser usada para obter o status e os resultados dessa solicitação. |
Criar solicitação de extração de campo
Crie uma nova solicitação para extrações do arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
file_id | string |
O arquivo do qual extrair texto. |
|
|
IDs de campo
|
field_ids | array of string |
As IDs dos campos a serem extraídos. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da solicitação de extração
|
request_id | string |
ID a ser usada para obter o status e os resultados dessa solicitação. |
Criar uma solicitação do OCR
Crie uma nova solicitação para que o OCR seja aplicado ao arquivo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
file_id | string |
O identificador exclusivo do arquivo, conforme retornado pela operação SubmitFile. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da solicitação do OCR
|
request_id | string |
ID usada para obter o status e os resultados da solicitação do OCR. |
Enviar um arquivo
Envie um arquivo para o Zuva DocAI.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
File
|
File | binary |
Conteúdo de arquivo binário ou cadeia de caracteres de texto sem formatação a ser carregado. O conteúdo binário NÃO deve ser codificado em Base64. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de Arquivo
|
file_id | string |
O identificador exclusivo atribuído pelo Zuva para o arquivo. |
|
Tipo de conteúdo
|
attributes.content-type | string |
Tipo de conteúdo MIME detectado do arquivo |
|
Vencimento
|
expiration | string |
A hora em que o arquivo está agendado para ser excluído do DocAI. |
Excluir um arquivo
Exclua um arquivo existente do Zuva.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de Arquivo
|
file_id | True | string |
ID do arquivo a ser excluído. |
Retornos
- response
- string
Normalizar datas
Normalize uma cadeia de caracteres que contém uma ou mais datas. Para cada data encontrada, o ponto de extremidade retorna um conjunto de inteiros que representam o ano, o mês e o dia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Texto
|
text | string |
A cadeia de caracteres de texto a ser normalizada. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da Solicitação
|
request_id | string |
ID da solicitação |
|
enviar SMS
|
text | string |
O texto original que foi fornecido. |
|
sha-256
|
sha-256 | string |
Hash SHA-256 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 inteiro entre 1 e 12. |
|
Ano
|
date.year | integer |
O ano representado como um inteiro. |
Obter imagens de solicitação do OCR
Obtenha as imagens de uma solicitação OCR concluída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da solicitação do OCR
|
request_id | True | string |
Identifer exclusivo de uma solicitação OCR existente, conforme retornado por CreateOcrRequest. |
Retornos
Um arquivo zip que contém cada página do documento como uma imagem.
- Imagens
- binary
Obter Lista de Campos
Obtenha uma lista de todos os campos disponíveis para você.
Retornos
| Nome | 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. |
|
Desvio
|
bias | double |
O viés usado pelo modelo de ML subjacente. |
|
Classificação F
|
f_score | double |
A pontuação F do campo, uma medida estatística de sua precisão. |
|
Precisão
|
precision | double |
A precisão do campo. |
|
Recall
|
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 |
Booliano indicando se o campo é personalizado. |
|
É treinado?
|
is_trained | boolean |
Booliano indicando se um campo personalizado foi treinado. |
Obter o status da solicitação do OCR
Verifique o status de uma solicitação OCR existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da solicitação do OCR
|
request_id | True | string |
Identifer exclusivo de uma solicitação OCR existente, conforme retornado por CreateOcrRequest. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status da solicitação do OCR
|
status | string |
Status da solicitação (uma de 'enfileirada', 'processando', 'complete' ou 'failed'). |
|
Está concluído?
|
is_finished | boolean |
Booliano indicando se a solicitação atingiu um estado terminal (concluída ou com falha). |
Obter resultados da solicitação de extração de campo
Obter resultados de texto de uma solicitação de extração de campo concluída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da solicitação de extração
|
request_id | True | string |
Identifer exclusivo de uma solicitação de extração existente, conforme retornado por CreateExtractionRequest. |
Retornos
| Nome | 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 do campo extraído. |
|
Extrações
|
results.extractions | array of object |
Uma matriz de resultados extraídos para esse campo específico. |
|
Texto
|
results.extractions.text | string |
O texto que foi extraído para o campo. |
|
Intervalos
|
results.extractions.spans | array of object |
Informações sobre o local do texto no documento. |
|
Start
|
results.extractions.spans.start | integer |
O índice do primeiro caractere da extração dentro do texto do documento. |
|
participante
|
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 no qual a extração é iniciada. |
|
participante
|
results.extractions.spans.pages.end | integer |
O número da página no qual a extração termina. |
Obter status da solicitação de classificação de documento
Obtenha o status e os resultados disponíveis para uma solicitação de classificação de documento existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
request_id | True | string |
ID de solicitação da solicitação de classificação de documento, conforme retornado por CreateDocumentClasssificationRequest. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status da solicitação de classificação
|
status | string |
Status da solicitação (uma de 'enfileirada', 'processando', 'complete' ou 'failed'). |
|
Está concluído?
|
is_finished | boolean |
Booliano indicando se a solicitação atingiu um estado terminal (concluída ou com falha). |
|
Classification
|
classification | string |
O tipo de documento detectado. |
|
O contrato é?
|
is_contract | boolean |
Se o documento foi reconhecido como um contrato ou não. |
Obter status da 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.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
request_id | True | string |
ID da solicitação de classificação de idioma, conforme retornado por CreateLanguageRequest. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status da Solicitação de Idioma
|
status | string |
Status da solicitação (uma de 'enfileirada', 'processando', 'complete' ou 'failed'). |
|
Está concluído?
|
is_finished | boolean |
Booliano indicando se a solicitação atingiu um estado terminal (concluída ou com falha). |
|
Linguagem
|
language | string |
O idioma principal detectado do documento. |
Obter status da solicitação de extração de campo
Verifique o status de uma solicitação de extração de campo existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da solicitação de extração
|
request_id | True | string |
Identifer exclusivo de uma solicitação de extração existente, conforme retornado por CreateExtractionRequest. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status da solicitação de extração de campo
|
status | string |
Status da solicitação (uma de 'enfileirada', 'processando', 'complete' ou 'failed'). |
|
Está concluído?
|
is_finished | boolean |
Booliano indicando se a solicitação atingiu um estado terminal (concluída ou com falha). |
Obter status da solicitação MLC
Obtenha o status e os resultados disponíveis para uma solicitação MLC existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da Solicitação
|
request_id | True | string |
ID de solicitação da solicitação MLC, conforme retornado por CreateMlcRequest. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status da solicitação MLC
|
status | string |
Status da solicitação (uma de 'enfileirada', 'processando', 'complete' ou 'failed'). |
|
Está concluído?
|
is_finished | boolean |
Booliano indicando se a solicitação atingiu um estado terminal (concluída ou com falha). |
|
Classifications
|
classifications | array of string |
As classificações hierárquicas do documento. |
Obter texto da solicitação do OCR
Obtenha o texto de uma solicitação OCR concluída.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da solicitação do OCR
|
request_id | True | string |
Identifer exclusivo de uma solicitação OCR existente, conforme retornado por CreateOcrRequest. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Texto
|
text | string |
Texto OCR do documento. |
Definições
cadeia
Esse é o tipo de dados básico 'string'.
binário
Esse é o tipo de dados básico 'binary'.