AIForged (versão prévia)
AIForged é uma solução de processamento inteligente de documentos para problemas complexos. O AIForged pode automatizar o processamento e a extração de dados estruturados de imagens não estruturadas. O conector fornece integração e automação da extração de documentos intellegentes com a AIForged
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 | AIForged |
| URL | https://www.aiforged.com |
| support@aiforged.com |
| Metadados do conector | |
|---|---|
| Publicador | Larc AI (PTY) Ltd |
| Site | https://www.aiforged.com |
| Política de privacidade | https://portal.aiforged.com/privacypolicy.html |
| Categorias | IA; Conteúdo e arquivos |
O AIForged é uma solução de processamento inteligente de documentos baseado em nuvem para resolver problemas complexos de extração de documentos. A plataforma AIForged integra perfeitamente vários serviços em um único modelo de serviços de IA líderes do setor, como Microsoft, Google, Amazon, ABBYY, dando a você a capacidade de usar esses serviços em conjunto para resultados ideais. O Processamento Inteligente de Documentos AIForged permite que as empresas aumentem sua saída, com maior precisão, maior velocidade a um custo menor.
Pré-requisitos
Você precisa do seguinte:
Um plano do Microsoft Power Apps ou do Power Automate
Você precisa de uma conta do Microsoft 365, um plano do Power Automate e uma conta/serviço do AIForged.
Uma conta e um serviço AIForged
Para usar esse conector, você precisará de uma conta do AIForged. Você também precisa configurar e treinar o serviço AIForged para obter resultados precisos. Para obter mais instruções, registre-se no AIForged e configure um projeto e serviço do AIForged seguindo as etapas definidas em Criar um Projeto.
Aqui está um exemplo de prática sobre como extrair informações de cartões de previdência social Exemplo de Prática – Previdência Social.
Veja também nosso exemplo prático para extrair informações de aplicativos de crédito Exemplo prático – aplicativo de crédito.
Como obter credenciais
Uma conta AIForged é necessária para usar AIForged. Você pode se registrar instalando o aplicativo AIForged na Microsoft Store ou no Site da Microsoft Store.
Depois que o aplicativo estiver instalado, você poderá se registrar usando as etapas de registro simples Registrar.
Para ativar a conta, você deve receber um email com o link de ativação. Depois de clicar no link de ativação, o AIForged será aberto com informações de ativação. Depois que sua conta for ativada, você poderá fazer logon com suas credenciais e, em seguida, usar suas credenciais no conector.
Como criar e treinar um serviço AIForged
Primeiro, você precisa criar um contêiner de projeto para fins de cobrança. Depois que o projeto for criado, você poderá adicionar um serviço inteligente seguindo as etapas do assistente no aplicativo AIForged.
Aqui está uma lista de exemplos de prática para extrair informações de documentos
Exemplo de praticidade – Cartões de Segurança Social.
Exemplo prático – extratos bancários.
Exemplo prático – Aplicativo de Crédito.
Introdução ao conector
Para obter mais informações sobre as obtenções iniciadas, consulte o guia a seguir para o Power Automate – Introdução
Authentication
Esse conector usa a autenticação (consulte as etapas OAuth2 acima sobre como obter uma). Ao criar um novo conector (no Power Apps/Aplicativos Lógicos), você precisará fornecer informações de autenticação do registro.
Problemas e limitações conhecidos
Não é possível habilitar a MFA/2FA para as credenciais que você usa no conector.
Erros e soluções comuns
Para qualquer suporte ou assistência, crie um tíquete de suporte no Suporte AIForged ou envie um email para support@aiforged.com
perguntas frequentes
Para obter mais informações e perguntas frequentes, consulte a Documentação do AIForged.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Carregar e classificar um documento |
Carregar e classificar um documento |
| Carregar e extrair informações para verificação |
Carregar e extrair informações para verificação |
| Carregar obter uma classificação de documento |
Carregar obter uma classificação de documento |
| Encontre documentos usando critérios de pesquisa estruturados. Os resultados podem ser paginado |
Encontre documentos usando critérios de pesquisa estruturados. Os resultados podem ser paginado |
| Excluir um blob de documentos |
Excluir um blob de documentos |
| Excluir um documento por ID |
Excluir um documento por ID |
| Excluir um parâmetro |
Excluir um parâmetro |
| Extrair parâmetros de documento |
Extrair parâmetros de documento |
| Localizar um projeto por nome |
Localizar um projeto por nome |
| Obter a chave de api para um usuário |
Obter a chave de api para um usuário |
| Obter a verificação mais recente em um parâmetro |
Obter a verificação mais recente em um parâmetro |
| Obter análise de verificação |
Obter análise de verificação |
| Obter blob por chave de blob |
Obter blob por chave de blob |
| Obter definição por Id |
Obter definição por Id |
| Obter documentos e imagens de visualização para um serviço |
Obter documentos e imagens de visualização para um serviço |
| Obter hierarquia de campos para todos os serviços em um projeto |
Obter hierarquia de campos para todos os serviços em um projeto |
| Obter hierarquia de campos para um serviço |
Obter hierarquia de campos para um serviço |
| Obter hierarquia de parâmetros |
Obter hierarquia de parâmetros |
| Obter imagens de documento |
Obter imagens de documento |
| Obter imagens de documento |
Obter imagens de documento |
| Obter informações de classificação |
Obter informações de classificação |
| Obter informações do sistema e do aplicativo |
Obter informações do sistema e do aplicativo |
| Obter o blob de dados de uma ID de documento por tipo de imagem |
Obter o blob de dados de uma ID de documento por tipo de imagem |
| Obter o serviço pai para um parâmetro def por Id |
Obter o serviço pai para um parâmetro def por Id |
| Obter o usuário conectado atualmente |
Obter o usuário conectado atualmente |
| Obter o valor do parâmetro |
Obter o valor do parâmetro |
| Obter os dados e a hora do serviço atual |
Obter os dados e a hora do serviço atual |
| Obter por usuário e projeto |
Obter por usuário e projeto |
| Obter projetos e serviços vinculados a um usuário |
Obter projetos e serviços vinculados a um usuário |
| Obter serviços relacionados a um projeto |
Obter serviços relacionados a um projeto |
| Obter tipos de dados |
Obter tipos de dados |
| Obter todas as categorias por projeto |
Obter todas as categorias por projeto |
| Obter um documento e seus documentos relacionados |
Obter um documento e seus documentos relacionados |
| Obter um documento por ID |
Obter um documento por ID |
| Obter um fragmento de imagem de verificação |
Obter um fragmento de imagem de verificação |
| Obter um parâmetro por ID de verificação |
Obter um parâmetro por ID de verificação |
| Obter um projeto específico |
Obter um projeto específico |
| Obter um resumo das verificações |
Obter um resumo das verificações |
| Obter um resumo das verificações |
Obter um resumo das verificações |
| Obter um serviço por ID |
Obter um serviço por ID |
| Obter uma verificação por ID |
Obter uma verificação por ID |
| Obter valores de enumeração do sistema |
Obter valores de enumeração do sistema |
| Obter verificações em um parâmetro |
Obter verificações em um parâmetro |
Carregar e classificar um documento
Carregar e classificar um documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do serviço
|
stpdId | integer |
A ID do serviço |
|
|
ID do projeto
|
projectId | integer |
ID do projeto |
|
|
Os dados do arquivo
|
file | file |
Os dados do arquivo |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Informações de metadados do documento
Carregar e extrair informações para verificação
Carregar e extrair informações para verificação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do serviço
|
stpdId | integer |
A ID do serviço |
|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
O arquivo
|
file | file |
O arquivo |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Informações de metadados do documento
Carregar obter uma classificação de documento
Carregar obter uma classificação de documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do serviço
|
stpdId | integer |
A ID do serviço |
|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
A ID do documento
|
docId | integer |
A ID do documento |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Categorias/classes para treinamento e classificação
Encontre documentos usando critérios de pesquisa estruturados. Os resultados podem ser paginado
Encontre documentos usando critérios de pesquisa estruturados. Os resultados podem ser paginado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Proprietário do documento
|
userId | string |
Proprietário do documento |
|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
A ID do serviço
|
stpdId | integer |
A ID do serviço |
|
|
A pasta ou o uso
|
usage | integer |
A pasta ou o uso |
|
|
O status
|
status | integer |
O status |
|
|
Um filtro de nome de classe
|
classname | string |
Um filtro de nome de classe |
|
|
Filtro de nome de arquivo
|
filename | string |
Filtro de nome de arquivo |
|
|
Filtro de tipo de arquivo
|
filetype | string |
Filtro de tipo de arquivo |
|
|
Intervalo de datas de início para documentos
|
start | date-time |
Intervalo de datas de início para documentos |
|
|
Intervalo de datas de término para documentos
|
end | date-time |
Intervalo de datas de término para documentos |
|
|
Mestre ou pai do documento
|
masterid | integer |
Mestre ou pai do documento |
|
|
Número da página
|
pageNo | integer |
Número da página |
|
|
Tamanho de uma página
|
pageSize | integer |
Tamanho de uma página |
|
|
Classificar por campo
|
sortField | integer |
Classificar por campo |
|
|
Direção de classificação com base no campo de classificação
|
sortDirection | integer |
Direção de classificação com base no campo de classificação |
|
|
Filtrar comentários
|
comment | string |
Filtrar comentários |
|
|
Filtrar os resultados
|
result | string |
Filtrar os resultados |
|
|
Filtrar uma ID de resultado
|
resultId | string |
Filtrar uma ID de resultado |
|
|
Filtrar o índice de resultados
|
resultIndex | integer |
Filtrar o índice de resultados |
|
|
Filtrar para IDs externas
|
externalId | string |
Filtrar para IDs externas |
|
|
Filtrar para guias de documentos
|
docGuid | string |
Filtrar para guias de documentos |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Excluir um blob de documentos
Excluir um blob de documentos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do blob
|
id | integer |
A ID do blob |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
- response
- file
Excluir um documento por ID
Excluir um documento por ID
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento a ser excluída
|
id | integer |
ID do documento a ser excluída |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Informações de metadados do documento
Excluir um parâmetro
Excluir um parâmetro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do parâmetro
|
paramid | integer |
A ID do parâmetro |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Valores de campos vinculados ot extraídos de documentos
Extrair parâmetros de documento
Extrair parâmetros de documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do documento
|
docid | integer |
A ID do documento |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Localizar um projeto por nome
Localizar um projeto por nome
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do usuário
|
userId | string |
A ID do usuário |
|
|
Nome do projeto
|
projectName | string |
Nome do projeto |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Projetos é um contêiner para cobrança e serviços
Obter a chave de api para um usuário
Obter a chave de api para um usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do usuário
|
userId | string |
A ID do usuário |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
- response
- string
Obter a verificação mais recente em um parâmetro
Obter a verificação mais recente em um parâmetro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
docId | integer |
ID do documento |
|
|
ID do parâmetro
|
parameterId | integer |
ID do parâmetro |
|
|
ID de definição
|
pdId | integer |
ID de definição |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Informações de verificação do sistema e do usuário para campos em documentos
Obter análise de verificação
Obter análise de verificação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
ID do serviço
|
stpdId | integer |
ID do serviço |
|
|
Somente as últimas
|
latestOnly | boolean |
Somente as últimas |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter blob por chave de blob
Obter blob por chave de blob
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do blob
|
id | integer |
A ID do blob |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
- response
- file
Obter definição por Id
Obter definição por Id
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID da definição
|
id | integer |
A ID da definição |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Serviço, definições de regras abd
Obter documentos e imagens de visualização para um serviço
Obter documentos e imagens de visualização para um serviço
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
O usuário que possui o serviço
|
userId | string |
O usuário que possui o serviço |
|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
A ID do serviço
|
stpdId | integer |
A ID do serviço |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter hierarquia de campos para todos os serviços em um projeto
Obter hierarquia de campos para todos os serviços em um projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do usuário
|
userId | string |
A ID do usuário |
|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
A ID do serviço
|
stpdId | integer |
A ID do serviço |
|
|
O ID do grupo
|
groupId | integer |
O ID do grupo |
|
|
Incluir estatísticas de contador
|
includeCount | boolean |
Incluir estatísticas de contador |
|
|
Incluir apenas serviços
|
onlyServices | boolean |
Incluir apenas serviços |
|
|
Incluir configurações
|
includeSettings | boolean |
Incluir configurações |
|
|
Incluir filhos
|
includeChildren | boolean |
Incluir filhos |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter hierarquia de campos para um serviço
Obter hierarquia de campos para um serviço
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
A ID do serviço
|
stpdId | integer |
A ID do serviço |
|
|
Incluir estatísticas de contador
|
includeCount | boolean |
Incluir estatísticas de contador |
|
|
Incluir configurações
|
includeSettings | boolean |
Incluir configurações |
|
|
Incluir definições filho
|
includeChildren | boolean |
Incluir definições filho |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Serviço, definições de regras abd
Obter hierarquia de parâmetros
Obter hierarquia de parâmetros
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do documento
|
docId | integer |
A ID do documento |
|
|
A ID do serviço
|
stpdId | integer |
A ID do serviço |
|
|
Incluir dados de verificação
|
includeverification | boolean |
Incluir dados de verificação |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter imagens de documento
Obter imagens de documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do documento
|
id | integer |
A ID do documento |
|
|
ID do serviço
|
stpdId | integer |
ID do serviço |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter imagens de documento
Obter imagens de documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | integer |
ID do documento |
|
|
Tipo de imagem
|
type | integer |
Tipo de imagem |
|
|
Tipo de conteúdo de imagem
|
contentType | string |
Tipo de conteúdo de imagem |
|
|
Um filtro de teste
|
text | string |
Um filtro de teste |
|
|
A ID de blob relacionada
|
blobid | integer |
A ID de blob relacionada |
|
|
O índice de página
|
pageindex | integer |
O índice de página |
|
|
Número de imagens a serem retornadas
|
imagesCount | integer |
Número de imagens a serem retornadas |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter informações de classificação
Obter informações de classificação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID da classificação
|
Id | integer |
A ID da classificação |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Categorias/classes para treinamento e classificação
Obter informações do sistema e do aplicativo
Obter informações do sistema e do aplicativo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
- response
- object
Obter o blob de dados de uma ID de documento por tipo de imagem
Obter o blob de dados de uma ID de documento por tipo de imagem
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do usuário que possui o documento
|
userId | string |
ID do usuário que possui o documento |
|
|
ID do blob
|
id | integer |
ID do blob |
|
|
O tipo de blob
|
type | integer |
O tipo de blob |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
- response
- file
Obter o serviço pai para um parâmetro def por Id
Obter o serviço pai para um parâmetro def por Id
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID de definição de parâmetro
|
id | integer |
A ID de definição de parâmetro |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Serviço, definições de regras abd
Obter o usuário conectado atualmente
Obter o usuário conectado atualmente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Informações do usuário
Obter o valor do parâmetro
Obter o valor do parâmetro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do documento
|
docId | integer |
A ID do documento |
|
|
A ID do serviço
|
stpdId | integer |
A ID do serviço |
|
|
Categoria de parâmetro
|
category | integer |
Categoria de parâmetro |
|
|
Agrupamento de parâmetros
|
grouping | integer |
Agrupamento de parâmetros |
|
|
Incluir dados de verificação
|
includeverification | boolean |
Incluir dados de verificação |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter os dados e a hora do serviço atual
Obter os dados e a hora do serviço atual
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
- response
- date-time
Obter por usuário e projeto
Obter por usuário e projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do usuário
|
userId | string |
A ID do usuário |
|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter projetos e serviços vinculados a um usuário
Obter projetos e serviços vinculados a um usuário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do usuário
|
userId | string |
A ID do usuário |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter serviços relacionados a um projeto
Obter serviços relacionados a um projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do usuário
|
userId | string |
A ID do usuário |
|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
Filtro de tipo de serviço
|
stlfilter | integer |
Filtro de tipo de serviço |
|
|
Filtrar por mecanismo
|
enginefilter | string |
Filtrar por mecanismo |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter tipos de dados
Obter tipos de dados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter todas as categorias por projeto
Obter todas as categorias por projeto
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do ptoject
|
projectId | integer |
A ID do ptoject |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter um documento e seus documentos relacionados
Obter um documento e seus documentos relacionados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | integer |
ID do documento |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Informações de metadados do documento
Obter um documento por ID
Obter um documento por ID
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do documento
|
id | integer |
A ID do documento |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Informações de metadados do documento
Obter um fragmento de imagem de verificação
Obter um fragmento de imagem de verificação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Usuário para o fragmento
|
userId | string |
Usuário para o fragmento |
|
|
ID do documento
|
docId | integer |
ID do documento |
|
|
ID do parâmetro
|
parId | integer |
ID do parâmetro |
|
|
ID de verificação
|
verificationId | integer |
ID de verificação |
|
|
Se a imagem for embutida
|
inline | boolean |
Se a imagem for embutida |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
- response
- file
Obter um parâmetro por ID de verificação
Obter um parâmetro por ID de verificação
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID de verificação
|
verificationId | integer |
A ID de verificação |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Valores de campos vinculados ot extraídos de documentos
Obter um projeto específico
Obter um projeto específico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do usuário
|
userId | string |
A ID do usuário |
|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Projetos é um contêiner para cobrança e serviços
Obter um resumo das verificações
Obter um resumo das verificações
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do projeto
|
projectId | integer |
A ID do projeto |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter um resumo das verificações
Obter um resumo das verificações
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do projeto
|
projectId | integer |
ID do projeto |
|
|
ID do serviço
|
stpdId | integer |
ID do serviço |
|
|
ID de definição
|
pdId | integer |
ID de definição |
|
|
Somente o mais recente ou histórico
|
latestOnly | boolean |
Somente o mais recente ou histórico |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter um serviço por ID
Obter um serviço por ID
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
A ID do serviço
|
stpdId | integer |
A ID do serviço |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Serviço, definições de regras abd
Obter uma verificação por ID
Obter uma verificação por ID
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de verificação
|
verificationId | integer |
ID de verificação |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Informações de verificação do sistema e do usuário para campos em documentos
Obter valores de enumeração do sistema
Obter valores de enumeração do sistema
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Obter verificações em um parâmetro
Obter verificações em um parâmetro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
docId | integer |
ID do documento |
|
|
ID do parâmetro
|
parameterId | integer |
ID do parâmetro |
|
|
Cabeçalho de versão da API
|
X-Api-Version | True | string |
Cabeçalho de versão da API |
Retornos
Definições
AIForged.ViewModels.UserViewModel
Informações do usuário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
userName
|
userName | string | |
|
fullName
|
fullName | string | |
|
email
|
|||
|
título do cargo
|
jobTitle | string | |
|
número de telefone
|
phoneNumber | phone | |
|
configuração
|
configuration | string | |
|
está ativado
|
isEnabled | boolean | |
|
isLockedOut
|
isLockedOut | boolean | |
|
friendlyName
|
friendlyName | string | |
|
createdBy
|
createdBy | string | |
|
atualizadoPor
|
updatedBy | string | |
|
createdDate
|
createdDate | date-time | |
|
updatedDate
|
updatedDate | date-time | |
|
funções
|
roles | array of string |
AIForged.ViewModels.ClassesViewModel
Categorias/classes para treinamento e classificação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
userId
|
userId | string | |
|
projectId
|
projectId | integer | |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
comentário
|
comment | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
tipo
|
type | AIForged.DAL.ClassType |
Tipo de categoria do sistema |
|
relacionado
|
related | integer |
AIForged.DAL.ClassType
AIForged.ViewModels.DocumentViewModel
Informações de metadados do documento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
userId
|
userId | string | |
|
projectId
|
projectId | integer | |
|
ID do serviço
|
serviceId | integer | |
|
status
|
status | AIForged.DAL.DocumentStatus |
Indicar o status de um documento no sistema |
|
uso
|
usage | AIForged.DAL.UsageType |
Por que armazenamos este documento |
|
classId
|
classId | integer | |
|
tipo de conteúdo
|
contentType | string | |
|
filename
|
filename | string | |
|
fileType
|
fileType | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
documentId
|
documentId | guid | |
|
ID externo
|
externalId | string | |
|
masterId
|
masterId | integer | |
|
resultado
|
result | string | |
|
resultId
|
resultId | string | |
|
resultIndex
|
resultIndex | integer | |
|
comentário
|
comment | string | |
|
availability
|
availability | AIForged.DAL.Availability |
Avalabilidade de um registro |
|
resultParameters
|
resultParameters | array of AIForged.ViewModels.DocumentParameterViewModel | |
|
dados
|
data | array of AIForged.ViewModels.DocumentDataViewModel | |
|
Documentos
|
documents | array of AIForged.ViewModels.DocumentViewModel | |
|
origemId
|
originId | integer | |
|
canVerify
|
canVerify | boolean | |
|
canClassify
|
canClassify | boolean | |
|
canTrain
|
canTrain | boolean | |
|
Treinados
|
trained | boolean | |
|
linkedDocsCount
|
linkedDocsCount | integer | |
|
trainingFieldCount
|
trainingFieldCount | integer | |
|
trainedParametersCount
|
trainedParametersCount | integer |
AIForged.DAL.DocumentStatus
AIForged.DAL.UsageType
AIForged.DAL.Availability
AIForged.ViewModels.DocumentParameterViewModel
Valores de campos vinculados ot extraídos de documentos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
documentId
|
documentId | integer | |
|
paramDefId
|
paramDefId | integer | |
|
ID do pai
|
parentId | integer | |
|
código-fonte
|
sourceId | integer | |
|
value
|
value | string | |
|
dados
|
data | byte | |
|
indexar
|
index | integer | |
|
colIndex
|
colIndex | integer | |
|
colSpan
|
colSpan | integer | |
|
rowIndex
|
rowIndex | integer | |
|
rowSpan
|
rowSpan | integer | |
|
availability
|
availability | AIForged.DAL.Availability |
Avalabilidade de um registro |
|
paramDef
|
paramDef |
Serviço, definições de regras abd |
|
|
children
|
children | array of AIForged.ViewModels.DocumentParameterViewModel | |
|
Verificações
|
verifications | array of AIForged.ViewModels.VerificationViewModel |
AIForged.ViewModels.ParameterDefViewModel
Serviço, definições de regras abd
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
projectId
|
projectId | integer | |
|
serviceTypeId
|
serviceTypeId | integer | |
|
ID do serviço
|
serviceId | integer | |
|
classId
|
classId | integer | |
|
ID do pai
|
parentId | integer | |
|
nome
|
name | string | |
|
etiqueta
|
label | string | |
|
tags
|
tags | string | |
|
descrição
|
description | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
status
|
status | AIForged.DAL.ParameterDefinitionStatus |
Status da definição |
|
categoria
|
category | AIForged.DAL.ParameterDefinitionCategory |
Categoria de definição |
|
agrupamento
|
grouping | AIForged.DAL.GroupingType |
Tipo de agrupamento de campos |
|
valueType
|
valueType | AIForged.DAL.ValueType |
O tipo de valores usados para regras e configurações |
|
valueTypeName
|
valueTypeName | string | |
|
defaultValue
|
defaultValue | string | |
|
required
|
required | AIForged.DAL.RequiredOption |
Indique se uma opção é necessária |
|
indexar
|
index | integer | |
|
informação
|
info | string | |
|
referência
|
reference | string | |
|
classificação
|
rating | float | |
|
availability
|
availability | AIForged.DAL.Availability |
Avalabilidade de um registro |
|
children
|
children | array of AIForged.ViewModels.ParameterDefViewModel | |
|
configurações
|
settings | array of AIForged.DAL.Models.ParameterDefSettingViewModel | |
|
totalCharge
|
totalCharge | double | |
|
contagemDeUsuários
|
userCount | integer | |
|
parameterCount
|
parameterCount | integer | |
|
documentCount
|
documentCount | integer | |
|
validação
|
validation | string |
AIForged.DAL.ParameterDefinitionStatus
AIForged.DAL.ParameterDefinitionCategory
AIForged.DAL.GroupingType
AIForged.DAL.ValueType
O tipo de valores usados para regras e configurações
O tipo de valores usados para regras e configurações
AIForged.DAL.RequiredOption
AIForged.DAL.Models.ParameterDefSettingViewModel
Configurações detalhadas para regras e configurações
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
parameterDefId
|
parameterDefId | integer | |
|
tipo
|
type | AIForged.DAL.SettingType |
O tipo de configuração relacionado a um parâmetro |
|
status
|
status | AIForged.DAL.SettingStatus |
O status de uma configuração relacionada a um parâmetro |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
comentário
|
comment | string | |
|
informação
|
info | string | |
|
dados
|
data | string | |
|
valor mínimo
|
minValue | string | |
|
valorMáximo
|
maxValue | string | |
|
confiança
|
confidence | float | |
|
minConfidence
|
minConfidence | float | |
|
maxConfidence
|
maxConfidence | float | |
|
isCaseSensative
|
isCaseSensative | boolean | |
|
inverter
|
invert | boolean | |
|
oneLine
|
oneLine | boolean | |
|
oneWord
|
oneWord | boolean | |
|
isHandwriting
|
isHandwriting | boolean | |
|
orientação
|
orientation | AIForged.DAL.Orientation |
Orientação de texto de um campo |
|
marcação
|
marking | AIForged.DAL.MarkingType |
Marcando o tipo de texto |
|
Células
|
cells | integer | |
|
clearBefore
|
clearBefore | AIForged.DAL.OptionStatusFlags |
Sinalizador de status de opções |
|
clearAfter
|
clearAfter | AIForged.DAL.OptionStatusFlags |
Sinalizador de status de opções |
|
cleanupValuesBefore
|
cleanupValuesBefore | boolean | |
|
cleanupValuesAfter
|
cleanupValuesAfter | boolean | |
|
validateValuesBefore
|
validateValuesBefore | boolean | |
|
validateValuesAfter
|
validateValuesAfter | boolean | |
|
abortOnValidationError
|
abortOnValidationError | boolean | |
|
isReplacementCaseSensative
|
isReplacementCaseSensative | boolean | |
|
compileResults
|
compileResults | string | |
|
maxRetry
|
maxRetry | integer | |
|
tempo limite
|
timeout | string | |
|
userId
|
userId | string |
AIForged.DAL.SettingType
O tipo de configuração relacionado a um parâmetro
O tipo de configuração relacionado a um parâmetro
AIForged.DAL.SettingStatus
O status de uma configuração relacionada a um parâmetro
O status de uma configuração relacionada a um parâmetro
AIForged.DAL.Orientation
AIForged.DAL.MarkingType
AIForged.DAL.OptionStatusFlags
AIForged.ViewModels.VerificationViewModel
Informações de verificação do sistema e do usuário para campos em documentos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
parameterId
|
parameterId | integer | |
|
userId
|
userId | string | |
|
value
|
value | string | |
|
Dt
|
dt | date-time | |
|
confiança
|
confidence | float | |
|
symbolsConfidence
|
symbolsConfidence | string | |
|
tipo
|
type | AIForged.DAL.VerificationType |
Tipo de verificação |
|
status
|
status | AIForged.DAL.VerificationStatus |
Sinalizadores de status de verificação |
|
resultado
|
result | string | |
|
box
|
box | string | |
|
informação
|
info | string | |
|
dados
|
data | byte | |
|
userName
|
userName | string | |
|
ID do serviço
|
serviceId | integer | |
|
serviceDocId
|
serviceDocId | integer | |
|
fornecedor
|
provider | string | |
|
settingId
|
settingId | integer | |
|
workItem
|
workItem | integer | |
|
ID da transação
|
transactionId | integer | |
|
preço
|
charge | double |
AIForged.DAL.VerificationType
AIForged.DAL.VerificationStatus
AIForged.ViewModels.DocumentDataViewModel
Dados de blob de documentos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
documentId
|
documentId | integer | |
|
blobId
|
blobId | integer | |
|
tipo
|
type | AIForged.DAL.DocumentDataType |
Indicar o tipo de dados relacionados a um documento |
|
dados
|
data | byte | |
|
prévia
|
preview | byte | |
|
enviar SMS
|
text | string | |
|
informação
|
info | string | |
|
tipo de conteúdo
|
contentType | string | |
|
resultId
|
resultId | string | |
|
indexar
|
index | integer | |
|
largura
|
width | double | |
|
height
|
height | double | |
|
resolução
|
resolution | double | |
|
availability
|
availability | AIForged.DAL.Availability |
Avalabilidade de um registro |
AIForged.DAL.DocumentDataType
Indicar o tipo de dados relacionados a um documento
Indicar o tipo de dados relacionados a um documento
AIForged.ViewModels.DocParamSummary
Resumo do documento para estatísticas com informações de parâmetros
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
projectId
|
projectId | integer | |
|
serviceType
|
serviceType | integer | |
|
ID do serviço
|
serviceId | integer | |
|
uso
|
usage | AIForged.DAL.UsageType |
Por que armazenamos este documento |
|
status
|
status | AIForged.DAL.DocumentStatus |
Indicar o status de um documento no sistema |
|
nome
|
name | string | |
|
classId
|
classId | integer | |
|
className
|
className | string | |
|
serviceName
|
serviceName | string | |
|
fileType
|
fileType | string | |
|
Dt
|
dt | date-time | |
|
count
|
count | integer | |
|
labeledCount
|
labelledCount | integer | |
|
pdId
|
pdId | integer | |
|
paramDefName
|
paramDefName | string | |
|
categoria
|
category | AIForged.DAL.ParameterDefinitionCategory |
Categoria de definição |
|
agrupamento
|
grouping | AIForged.DAL.GroupingType |
Tipo de agrupamento de campos |
|
valueType
|
valueType | AIForged.DAL.ValueType |
O tipo de valores usados para regras e configurações |
|
value
|
value | string | |
|
indexar
|
index | integer |
AIForged.ViewModels.DocumentExtraction
Extração transposta de resultados estruturados do documento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
ID do pai
|
parentId | integer | |
|
nome
|
name | string | |
|
etiqueta
|
label | string | |
|
categoria
|
category | AIForged.DAL.ParameterDefinitionCategory |
Categoria de definição |
|
agrupamento
|
grouping | AIForged.DAL.GroupingType |
Tipo de agrupamento de campos |
|
valueType
|
valueType | AIForged.DAL.ValueType |
O tipo de valores usados para regras e configurações |
|
indexar
|
index | integer | |
|
paramId
|
paramId | integer | |
|
parentParamId
|
parentParamId | integer | |
|
paramIndex
|
paramIndex | integer | |
|
paramValue
|
paramValue | string | |
|
verificationId
|
verificationId | integer | |
|
userId
|
userId | string | |
|
userName
|
userName | string | |
|
value
|
value | string | |
|
Dt
|
dt | date-time | |
|
confiança
|
confidence | float | |
|
tipo
|
type | AIForged.DAL.VerificationType |
Tipo de verificação |
|
status
|
status | AIForged.DAL.VerificationStatus |
Sinalizadores de status de verificação |
|
preço
|
charge | double | |
|
fornecedor
|
provider | string | |
|
resultado
|
result | string |
AIForged.ViewModels.ProjectViewModel
Projetos é um contêiner para cobrança e serviços
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
userId
|
userId | string | |
|
status
|
status | AIForged.DAL.ProjectStatus |
Usado para indicar o status de um projeto |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
comentário
|
comment | string | |
|
dtc
|
dtc | date-time | |
|
dtm
|
dtm | date-time | |
|
saldo
|
balance |
Informações de contabilidade para projetos e serviços |
|
|
totalDocsCount
|
totalDocsCount | integer | |
|
services
|
services | array of AIForged.ViewModels.ParameterDefViewModel |
AIForged.DAL.ProjectStatus
AIForged.ViewModels.DataTypeViewModel
Tipos de dados usados para regras e processamento interno
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | AIForged.DAL.ValueType |
O tipo de valores usados para regras e configurações |
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
categoria
|
category | AIForged.DAL.DataTypeCategory |
A categoria de tipos de dados |
|
valueTypeName
|
valueTypeName | string | |
|
defaultValue
|
defaultValue | string | |
|
dados
|
data | string |
AIForged.DAL.DataTypeCategory
AIForged.ViewModels.EnumDataViewModel
Lista de enumerações do sistema e informações básicas da interface do usuário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
tipo
|
type | AIForged.DAL.EnumType |
Enumeração de todas as enumerações no sistema |
|
typeName
|
typeName | string | |
|
nome
|
name | string | |
|
value
|
value | integer | |
|
descrição
|
description | string | |
|
informação
|
info | string | |
|
icon
|
icon | string | |
|
color
|
color | string |
AIForged.DAL.EnumType
AIForged.ViewModels.VerificationSummary
Informações de verificação do sistema e do usuário para campos em documentos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
parameterId
|
parameterId | integer | |
|
userId
|
userId | string | |
|
value
|
value | string | |
|
Dt
|
dt | date-time | |
|
confiança
|
confidence | float | |
|
symbolsConfidence
|
symbolsConfidence | string | |
|
tipo
|
type | AIForged.DAL.VerificationType |
Tipo de verificação |
|
status
|
status | AIForged.DAL.VerificationStatus |
Sinalizadores de status de verificação |
|
resultado
|
result | string | |
|
box
|
box | string | |
|
informação
|
info | string | |
|
dados
|
data | byte | |
|
userName
|
userName | string | |
|
ID do serviço
|
serviceId | integer | |
|
serviceDocId
|
serviceDocId | integer | |
|
fornecedor
|
provider | string | |
|
settingId
|
settingId | integer | |
|
workItem
|
workItem | integer | |
|
ID da transação
|
transactionId | integer | |
|
preço
|
charge | double | |
|
paramDefId
|
paramDefId | integer | |
|
paramDefName
|
paramDefName | string | |
|
projectId
|
projectId | integer | |
|
projectName
|
projectName | string | |
|
docId
|
docId | integer | |
|
docFileName
|
docFileName | string | |
|
docContentType
|
docContentType | string | |
|
docUsage
|
docUsage | AIForged.DAL.UsageType |
Por que armazenamos este documento |
|
docStatus
|
docStatus | AIForged.DAL.DocumentStatus |
Indicar o status de um documento no sistema |
|
classId
|
classId | integer | |
|
className
|
className | string | |
|
ano
|
year | integer | |
|
month
|
month | integer | |
|
dia
|
day | integer | |
|
dayOfWeek
|
dayOfWeek | System.DayOfWeek |
O dia do calendário da semana |
|
count
|
count | integer | |
|
média
|
average | float | |
|
min
|
min | float | |
|
max
|
max | float |
System.DayOfWeek
arquivo
Esse é o tipo de dados básico 'file'.
cadeia
Esse é o tipo de dados básico 'string'.
objeto
Esse é o tipo 'object'.