AIForged (Pré-visualização)

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 intellegent com AIForged

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	AIForged
URL	https://www.aiforged.com
Email	support@aiforged.com

Metadados do conector
Editora	Larc AI (PTY) Ltd
Sítio Web	https://www.aiforged.com
Política de privacidade	https://portal.aiforged.com/privacypolicy.html
Categorias	IA; Conteúdo e Ficheiros

AIForged é uma solução de Processamento Inteligente de Documentos baseada na 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, oferecendo a capacidade de usar esses serviços em conjunto para obter os melhores resultados. O Processamento Inteligente de Documentos AIForged permite que as empresas aumentem a sua produção, com maior precisão, maior velocidade a um custo mais baixo.

Pré-requisitos

Você precisa do seguinte:

Um plano Microsoft Power Apps ou Power Automate

Você precisa de uma conta Microsoft 365, um plano Power Automate e conta / serviço AIForged.

Uma conta e um serviço AIForged

Para usar esse conector, você precisará de uma conta 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 AIForged seguindo as etapas definidas em Criar um projeto.

Aqui está um exemplo prático sobre como extrair informações de cartões de segurança social Exemplo prático - Segurança Social.

Veja também o nosso exemplo prático para extrair informações de pedidos de crédito Exemplo prático - pedido 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.

Uma vez que o aplicativo está instalado, você pode se registrar usando as etapas de registro simples Registrar.

Para ativar a conta, você deve receber um e-mail com o link de ativação. Depois de clicar no link de ativação, o AIForged será aberto com informações de ativação. Assim que a sua conta estiver ativada, pode iniciar sessão com as suas credenciais e, em seguida, utilizar as suas credenciais no seu conector.

Como criar e treinar um serviço AIForged

Primeiro, você precisa criar um contêiner de projeto para fins de faturamento. Uma vez que seu projeto é criado, você pode adicionar um serviço inteligente seguindo as etapas do assistente no aplicativo AIForged.

Aqui está uma lista de exemplos práticos para extrair informações de documentos

Exemplo prático - Cartões da Segurança Social.

Exemplo Prático - Extratos bancários.

Exemplo Prático - Aplicação de Crédito.

Introdução ao conector

Para obter mais informações sobre como começar, consulte o seguinte guia para Power Automate - Introdução

Authentication

Este conector usa OAuth2 autenticação (veja as etapas acima sobre como obter uma). Ao criar um novo conector (em Power Apps/Logic Apps), ser-lhe-á pedido que forneça uma informação de autenticação a partir do registo.

Problemas conhecidos e limitações

Não é possível habilitar MFA/2FA para as credenciais usadas no conector.

Erros e soluções comuns

Para qualquer suporte ou assistência, crie um ticket de suporte no Suporte da AIForged ou envie um e-mail para support@aiforged.com

FAQ

Para obter mais informações e perguntas frequentes, consulte a documentação do AIForged.

Limites de Limitação

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

Ações

Carregar e classificar um documento

ID da Operação:: Document_Classify

Carregar e classificar um documento

Parâmetros

Name	Chave	Necessá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 ficheiro	file		file	Os dados do ficheiro
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Informações sobre metadados do documento

Body: AIForged.ViewModels.DocumentViewModel

Carregar obter uma classificação de documento

ID da Operação:: Document_GetClassification

Carregar obter uma classificação de documento

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do serviço	stpdId		integer	A ID do serviço
O id do projeto	projectId		integer	O id do projeto
O ID do documento	docId		integer	O ID do documento
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Categorias/Classes para formação e classificação

Body: AIForged.ViewModels.ClassesViewModel

Carregue e extraia informações para verificação

ID da Operação:: Document_ExtractAndVerify

Carregue e extraia informações para verificação

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do serviço	stpdId		integer	A ID do serviço
O id do projeto	projectId		integer	O id do projeto
O ficheiro	file		file	O ficheiro
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Informações sobre metadados do documento

Body: AIForged.ViewModels.DocumentViewModel

Encontrar um projeto por nome

ID da Operação:: Project_GetByName

Encontrar um projeto por nome

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do usuário	userId		string	O ID do usuário
Nome do projeto	projectName		string	Nome do projeto
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Projetos é um contêiner para faturamento e serviços

Body: AIForged.ViewModels.ProjectViewModel

Encontre documentos usando critérios de pesquisa estruturados. Os resultados podem ser paginados

ID da Operação:: Document_GetExtendedV0_9

Encontre documentos usando critérios de pesquisa estruturados. Os resultados podem ser paginados

Parâmetros

Name	Chave	Necessário	Tipo	Description
Proprietário do documento	userId		string	Proprietário do documento
O id do projeto	projectId		integer	O id do projeto
A ID do serviço	stpdId		integer	A ID do serviço
A pasta ou uso	usage		integer	A pasta ou uso
O estatuto	status		integer	O estatuto
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 ficheiro	filetype		string	Filtro de tipo de ficheiro
Intervalo de datas de início dos documentos	start		date-time	Intervalo de datas de início dos documentos
Intervalo de datas finais para documentos	end		date-time	Intervalo de datas finais 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
Ordenar por campo	sortField		integer	Ordenar 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 por resultados	result		string	Filtrar por resultados
Filtrar para um id de resultado	resultId		string	Filtrar para um id de resultado
Filtrar para índice de resultados	resultIndex		integer	Filtrar para índice de resultados
Filtro para ids externos	externalId		string	Filtro para ids externos
Filtrar para doc guids	docGuid		string	Filtrar para doc guids
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.DocumentViewModel

Excluir um blob de documento

ID da Operação:: Document_DeleteBlob

Excluir um blob de documento

Parâmetros

Name	Chave	Necessário	Tipo	Description
O id do blob	id		integer	O id do blob
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: file

Excluir um documento por id

ID da Operação:: Document_Delete

Excluir um documento por id

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do documento a eliminar	id		integer	ID do documento a eliminar
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Informações sobre metadados do documento

Body: AIForged.ViewModels.DocumentViewModel

Excluir um parâmetro

ID da Operação:: Parameters_Delete

Excluir um parâmetro

Parâmetros

Name	Chave	Necessário	Tipo	Description
O id do parâmetro	paramid		integer	O id do parâmetro
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Campos valores vinculados ou extraídos de documentos

Body: AIForged.ViewModels.DocumentParameterViewModel

Extrair parâmetros do documento

ID da Operação:: Parameters_Extract

Extrair parâmetros do documento

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do documento	docid		integer	O ID do documento
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.DocumentExtraction

Obtenha análises de verificação

ID da Operação:: Verification_GetHeatmap

Obtenha análises de verificação

Parâmetros

Name	Chave	Necessário	Tipo	Description
O id do projeto	projectId		integer	O id do projeto
ID do serviço	stpdId		integer	ID do serviço
Apenas o mais recente	latestOnly		boolean	Apenas o mais recente
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.VerificationSummary

Obtenha um resumo das verificações

ID da Operação:: Parameters_GetSummary

Obtenha um resumo das verificações

Parâmetros

Name	Chave	Necessário	Tipo	Description
O id do projeto	projectId		integer	O id do projeto
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.DocParamSummary

Obtenha um resumo das verificações

ID da Operação:: Verification_GetSummary

Obtenha um resumo das verificações

Parâmetros

Name	Chave	Necessário	Tipo	Description
Id do projeto	projectId		integer	Id do projeto
ID do serviço	stpdId		integer	ID do serviço
ID da definição	pdId		integer	ID da definição
Apenas o mais recente ou histórico	latestOnly		boolean	Apenas o mais recente ou histórico
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.VerificationSummary

Obter a verificação mais recente sobre um parâmetro

ID da Operação:: Verification_GetLatest

Obter a verificação mais recente sobre um parâmetro

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do documento	docId		integer	ID do documento
Id do parâmetro	parameterId		integer	Id do parâmetro
ID da definição	pdId		integer	ID da definição
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Informações de verificação do sistema e do utilizador para campos em documentos

Body: AIForged.ViewModels.VerificationViewModel

Obter blob por chave de blob

ID da Operação:: Document_GetBlobById

Obter blob por chave de blob

Parâmetros

Name	Chave	Necessário	Tipo	Description
O id do blob	id		integer	O id do blob
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: file

Obter chave de api para um usuário

ID da Operação:: Account_GetApiKey

Obter chave de api para um usuário

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do usuário	userId		string	O ID do usuário
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: string

Obter definição por Id

ID da Operação:: ParamDef_Get

Obter definição por Id

Parâmetros

Name	Chave	Necessário	Tipo	Description
A definição id	id		integer	A definição id
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Serviço, configurações e definições de regras

Body: AIForged.ViewModels.ParameterDefViewModel

Obter hierarquia de campos para todos os serviços em um projeto

ID da Operação:: Project_GetHierachies

Obter hierarquia de campos para todos os serviços em um projeto

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do usuário	userId		string	O ID do usuário
O id do projeto	projectId		integer	O 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 do contador	includeCount		boolean	Incluir estatísticas do contador
Incluir apenas serviços	onlyServices		boolean	Incluir apenas serviços
Incluir configurações	includeSettings		boolean	Incluir configurações
Incluir crianças	includeChildren		boolean	Incluir crianças
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.ParameterDefViewModel

Obter hierarquia de campos para um serviço

ID da Operação:: ParamDef_GetHierachy

Obter hierarquia de campos para um serviço

Parâmetros

Name	Chave	Necessário	Tipo	Description
O id do projeto	projectId		integer	O id do projeto
A ID do serviço	stpdId		integer	A ID do serviço
Incluir estatísticas do contador	includeCount		boolean	Incluir estatísticas do contador
Incluir configurações	includeSettings		boolean	Incluir configurações
Incluir definições de filhos	includeChildren		boolean	Incluir definições de filhos
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Serviço, configurações e definições de regras

Body: AIForged.ViewModels.ParameterDefViewModel

Obter hierarquia de parâmetros

ID da Operação:: Parameters_GetHierarchy

Obter hierarquia de parâmetros

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do documento	docId		integer	O 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 da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.DocumentParameterViewModel

Obter imagens de documentos

ID da Operação:: Document_GetImages

Obter imagens de documentos

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do documento	id		integer	O ID do documento
ID do serviço	stpdId		integer	ID do serviço
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.DocumentDataViewModel

Obter imagens de documentos

ID da Operação:: Document_GetDataV09

Obter imagens de documentos

Parâmetros

Name	Chave	Necessá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
O ID de blob relacionado	blobid		integer	O ID de blob relacionado
O índice da página	pageindex		integer	O índice da página
Número de imagens a devolver	imagesCount		integer	Número de imagens a devolver
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.DocumentDataViewModel

Obter informações de classificação

ID da Operação:: Classes_Get

Obter informações de classificação

Parâmetros

Name	Chave	Necessário	Tipo	Description
O id da classificação	Id		integer	O id da classificação
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Categorias/Classes para formação e classificação

Body: AIForged.ViewModels.ClassesViewModel

Obter informações sobre o sistema e a aplicação

ID da Operação:: System_GetSystemInfo

Obter informações sobre o sistema e a aplicação

Parâmetros

Name	Chave	Necessário	Tipo	Description
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: object

Obter o blob de dados para uma ID de documento por tipo de imagem

ID da Operação:: Document_GetBlobV09

Obter o blob de dados para uma ID de documento por tipo de imagem

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de utilizador proprietário do documento	userId		string	ID de utilizador proprietário do documento
ID do blob	id		integer	ID do blob
O tipo de blob	type		integer	O tipo de blob
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: file

Obter os dados e a hora do serviço atual

ID da Operação:: System_GetSystemDate

Obter os dados e a hora do serviço atual

Parâmetros

Name	Chave	Necessário	Tipo	Description
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: date-time

Obter por usuário e projeto

ID da Operação:: Classes_GetByUser

Obter por usuário e projeto

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do usuário	userId		string	O ID do usuário
O id do projeto	projectId		integer	O id do projeto
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.ClassesViewModel

Obter projetos e serviços vinculados a um usuário

ID da Operação:: Project_GetByUser

Obter projetos e serviços vinculados a um usuário

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do usuário	userId		string	O ID do usuário
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.ProjectViewModel

Obter pré-visualização de documentos e imagens para um serviço

ID da Operação:: Document_GetPreviews

Obter pré-visualização de documentos e imagens para um serviço

Parâmetros

Name	Chave	Necessário	Tipo	Description
O usuário proprietário do serviço	userId		string	O usuário proprietário do serviço
O id do projeto	projectId		integer	O id do projeto
A ID do serviço	stpdId		integer	A ID do serviço
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.DocumentViewModel

Obter serviço pai para um parâmetro def por Id

ID da Operação:: ParamDef_GetParentService

Obter serviço pai para um parâmetro def por Id

Parâmetros

Name	Chave	Necessário	Tipo	Description
O id de definição de parâmetro	id		integer	O id de definição de parâmetro
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Serviço, configurações e definições de regras

Body: AIForged.ViewModels.ParameterDefViewModel

Obter serviços relacionados com um projeto

ID da Operação:: Project_GetServices

Obter serviços relacionados com um projeto

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do usuário	userId		string	O ID do usuário
O id do projeto	projectId		integer	O id do projeto
Filtro de tipo de serviço	stlfilter		integer	Filtro de tipo de serviço
Filtrar por motor	enginefilter		string	Filtrar por motor
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.ParameterDefViewModel

Obter tipos de dados

ID da Operação:: System_GetDataTypes

Obter tipos de dados

Parâmetros

Name	Chave	Necessário	Tipo	Description
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.DataTypeViewModel

Obter todas as categorias por projeto

ID da Operação:: Classes_GetByProject

Obter todas as categorias por projeto

Parâmetros

Name	Chave	Necessário	Tipo	Description
O id do ptoject	projectId		integer	O id do ptoject
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.ClassesViewModel

Obter um documento e seus documentos relacionados

ID da Operação:: Document_GetHierarchy

Obter um documento e seus documentos relacionados

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do documento	id		integer	ID do documento
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Informações sobre metadados do documento

Body: AIForged.ViewModels.DocumentViewModel

Obter um documento por Id

ID da Operação:: Document_GetDocument

Obter um documento por Id

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do documento	id		integer	O ID do documento
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Informações sobre metadados do documento

Body: AIForged.ViewModels.DocumentViewModel

Obter um parâmetro por ID de verificação

ID da Operação:: Parameters_GetByVerification

Obter um parâmetro por ID de verificação

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID de verificação	verificationId		integer	O ID de verificação
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Campos valores vinculados ou extraídos de documentos

Body: AIForged.ViewModels.DocumentParameterViewModel

Obter um projeto específico

ID da Operação:: Project_GetUserProject

Obter um projeto específico

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do usuário	userId		string	O ID do usuário
O id do projeto	projectId		integer	O id do projeto
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Projetos é um contêiner para faturamento e serviços

Body: AIForged.ViewModels.ProjectViewModel

Obter um serviço por id

ID da Operação:: Services_Get

Obter um serviço por id

Parâmetros

Name	Chave	Necessário	Tipo	Description
A ID do serviço	stpdId		integer	A ID do serviço
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Serviço, configurações e definições de regras

Body: AIForged.ViewModels.ParameterDefViewModel

Obter uma imagem de verificação destruída

ID da Operação:: Verification_GetShred

Obter uma imagem de verificação destruída

Parâmetros

Name	Chave	Necessário	Tipo	Description
Usuário para o shred	userId		string	Usuário para o shred
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
A imagem deve estar embutida	inline		boolean	A imagem deve estar embutida
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: file

Obter uma verificação por id

ID da Operação:: Verification_Get

Obter uma verificação por id

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de verificação	verificationId		integer	ID de verificação
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Informações de verificação do sistema e do utilizador para campos em documentos

Body: AIForged.ViewModels.VerificationViewModel

Obter usuário conectado atual

ID da Operação:: Account_GetCurrentUser

Obter usuário conectado atual

Parâmetros

Name	Chave	Necessário	Tipo	Description
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

Informação do utilizador

Body: AIForged.ViewModels.UserViewModel

Obter valor do parâmetro

ID da Operação:: Parameters_Get

Obter valor do parâmetro

Parâmetros

Name	Chave	Necessário	Tipo	Description
O ID do documento	docId		integer	O ID do documento
A ID do serviço	stpdId		integer	A ID do serviço
Categoria do parâmetro	category		integer	Categoria do 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 da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.DocumentParameterViewModel

Obter valores de enum do sistema

ID da Operação:: System_GetEnumData

Obter valores de enum do sistema

Parâmetros

Name	Chave	Necessário	Tipo	Description
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.EnumDataViewModel

Obter verificações em um parâmetro

ID da Operação:: Verification_GetAll

Obter verificações em um parâmetro

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do documento	docId		integer	ID do documento
Id do parâmetro	parameterId		integer	Id do parâmetro
Cabeçalho da versão da API	X-Api-Version	True	string	Cabeçalho da versão da API

Devoluções

response: array of AIForged.ViewModels.VerificationViewModel

Definições

AIForged.ViewModels.UserViewModel

Informação do utilizador

Name	Caminho	Tipo
id	id	string
nome de utilizador	userName	string
Nome completo	fullName	string
e-mail	email	email
título do trabalho	jobTitle	string
Número de telefone	phoneNumber	phone
configuração	configuration	string
isEnabled	isEnabled	boolean
isLockedOut	isLockedOut	boolean
friendlyName	friendlyName	string
criado por	createdBy	string
atualizadoPor	updatedBy	string
createdDate (Data de criação)	createdDate	date-time
atualizadoData de atualização	updatedDate	date-time
roles	roles	array of string

AIForged.ViewModels.ClassesViewModel

Categorias/Classes para formação e classificação

Name	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
relacionados	related	integer

AIForged.DAL.ClassType

Tipo de categoria do sistema

: integer

AIForged.ViewModels.DocumentViewModel

Informações sobre metadados do documento

Name	Caminho	Tipo	Description
id	id	integer
userId	userId	string
projectId	projectId	integer
serviceId	serviceId	integer
estado	status	AIForged.DAL.DocumentStatus	Indicar o estado de um documento no sistema
utilização	usage	AIForged.DAL.UsageType	Porque armazenamos este documento
classId	classId	integer
TipoDeConteú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
índice de resultados	resultIndex	integer
comentário	comment	string
disponibilidade	availability	AIForged.DAL.Availability	Disponibilidade de um registo
resultParâmetros	resultParameters	array of AIForged.ViewModels.DocumentParameterViewModel
dados	data	array of AIForged.ViewModels.DocumentDataViewModel
Documentação	documents	array of AIForged.ViewModels.DocumentViewModel
originId	originId	integer
canVerify	canVerify	boolean
canClassify	canClassify	boolean
canTrain	canTrain	boolean
treinado	trained	boolean
linkedDocsCount	linkedDocsCount	integer
formaçãoFieldCount	trainingFieldCount	integer
trainedParametersCount	trainedParametersCount	integer

AIForged.DAL.DocumentStatus

Indicar o estado de um documento no sistema

: integer

AIForged.DAL.UsageType

Porque armazenamos este documento

: integer

AIForged.DAL.Disponibilidade

Disponibilidade de um registo

: integer

AIForged.ViewModels.DocumentParameterViewModel

Campos valores vinculados ou extraídos de documentos

Name	Caminho	Tipo	Description
id	id	integer
documentId	documentId	integer
paramDefId	paramDefId	integer
parentId	parentId	integer
fonteId	sourceId	integer
valor	value	string
dados	data	byte
indexar	index	integer
Índice colIndex	colIndex	integer
colSpan	colSpan	integer
rowIndex [en]	rowIndex	integer
rowSpan	rowSpan	integer
disponibilidade	availability	AIForged.DAL.Availability	Disponibilidade de um registo
paramDef	paramDef		Serviço, configurações e definições de regras
Crianças	children	array of AIForged.ViewModels.DocumentParameterViewModel
Verificações	verifications	array of AIForged.ViewModels.VerificationViewModel

AIForged.ViewModels.ParameterDefViewModel

Serviço, configurações e definições de regras

Name	Caminho	Tipo	Description
id	id	integer
projectId	projectId	integer
serviceTypeId	serviceTypeId	integer
serviceId	serviceId	integer
classId	classId	integer
parentId	parentId	integer
nome	name	string
etiqueta	label	string
tags	tags	string
descrição	description	string
dtc	dtc	date-time
DTM	dtm	date-time
estado	status	AIForged.DAL.ParameterDefinitionStatus	Estatuto 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 é necessária uma opção
indexar	index	integer
info	info	string
referenciar	reference	string
classificação	rating	float
disponibilidade	availability	AIForged.DAL.Availability	Disponibilidade de um registo
Crianças	children	array of AIForged.ViewModels.ParameterDefViewModel
definições	settings	array of AIForged.DAL.Models.ParameterDefSettingViewModel
totalCharge	totalCharge	double
numeroDeUtilizadores	userCount	integer
parameterCount	parameterCount	integer
documentCount	documentCount	integer
validação	validation	string

AIForged.DAL.ParameterDefinitionStatus

Estatuto da definição

: integer

AIForged.DAL.ParameterDefinitionCategory

Categoria de definição

: integer

AIForged.DAL.GroupingType

Tipo de agrupamento de campos

: integer

AIForged.DAL.ValueType

O tipo de valores usados para regras e configurações

: integer

AIForged.DAL.RequiredOption

Indique se é necessária uma opção

: integer

AIForged.DAL.Models.ParameterDefSettingViewModel

Configurações detalhadas para regras e configurações

Name	Caminho	Tipo	Description
id	id	integer
parâmetroDefId	parameterDefId	integer
tipo	type	AIForged.DAL.SettingType	O tipo de configuração relacionada a um parâmetro
estado	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
info	info	string
dados	data	string
minValor	minValue	string
maxValor	maxValue	string
confiança	confidence	float
minConfiança	minConfidence	float
maxConfiança	maxConfidence	float
isCaseSensative	isCaseSensative	boolean
inverter	invert	boolean
oneLine	oneLine	boolean
oneWord	oneWord	boolean
isManuscrito	isHandwriting	boolean
orientação	orientation	AIForged.DAL.Orientation	Orientação do texto de um campo
marcação	marking	AIForged.DAL.MarkingType	Tipo de marcação de texto
células	cells	integer
limparAntes	clearBefore	AIForged.DAL.OptionStatusFlags	Sinalizador de status das opções
clearDepois	clearAfter	AIForged.DAL.OptionStatusFlags	Sinalizador de status das opções
cleanupValuesBefore	cleanupValuesBefore	boolean
cleanupValuesAfter	cleanupValuesAfter	boolean
validateValuesBefore	validateValuesBefore	boolean
validateValuesAfter	validateValuesAfter	boolean
abortOnValidationError	abortOnValidationError	boolean
isReplacementCaseSensative	isReplacementCaseSensative	boolean
compilarResultados	compileResults	string
maxRetry	maxRetry	integer
timeout	timeout	string
userId	userId	string

AIForged.DAL.SettingType

O tipo de configuração relacionada a um parâmetro

: integer

AIForged.DAL.SettingStatus

O status de uma configuração relacionada a um parâmetro

: integer

AIForged.DAL.Orientação

Orientação do texto de um campo

: integer

AIForged.DAL.MarkingType

Tipo de marcação de texto

: integer

AIForged.DAL.OptionStatusFlags

Sinalizador de status das opções

: integer

AIForged.ViewModels.VerificationViewModel

Informações de verificação do sistema e do utilizador para campos em documentos

Name	Caminho	Tipo	Description
id	id	integer
parameterId	parameterId	integer
userId	userId	string
valor	value	string
DT	dt	date-time
confiança	confidence	float
símbolosConfiança	symbolsConfidence	string
tipo	type	AIForged.DAL.VerificationType	Tipo de verificação
estado	status	AIForged.DAL.VerificationStatus	Sinalizadores de status de verificação
Resultado	result	string
caixa	box	string
info	info	string
dados	data	byte
nome de utilizador	userName	string
serviceId	serviceId	integer
serviceDocId	serviceDocId	integer
fornecedor	provider	string
configuraçãoId	settingId	integer
item de trabalho	workItem	integer
transactionId	transactionId	integer
custo	charge	double

AIForged.DAL.VerificationType

Tipo de verificação

: integer

AIForged.DAL.VerificationStatus

Sinalizadores de status de verificação

: integer

AIForged.ViewModels.DocumentDataViewModel

Dados de blob do documento

Name	Caminho	Tipo	Description
id	id	integer
documentId	documentId	integer
blobId	blobId	integer
tipo	type	AIForged.DAL.DocumentDataType	Indicar o tipo de dados relacionados com um documento
dados	data	byte
pré-visualização	preview	byte
enviar SMS	text	string
info	info	string
TipoDeConteúdo	contentType	string
resultId	resultId	string
indexar	index	integer
Largura	width	double
altura	height	double
resolução	resolution	double
disponibilidade	availability	AIForged.DAL.Availability	Disponibilidade de um registo

AIForged.DAL.DocumentDataType

Indicar o tipo de dados relacionados com um documento

: integer

AIForged.ViewModels.DocParamSummary

Resumo do documento para estatísticas com informações sobre parâmetros

Name	Caminho	Tipo	Description
projectId	projectId	integer
Tipo de serviço	serviceType	integer
serviceId	serviceId	integer
utilização	usage	AIForged.DAL.UsageType	Porque armazenamos este documento
estado	status	AIForged.DAL.DocumentStatus	Indicar o estado 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
labelledCount	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
valor	value	string
indexar	index	integer

AIForged.ViewModels.DocumentExtraction

Extração transposta de resultados de documentos estruturados

Name	Caminho	Tipo	Description
id	id	integer
parentId	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
nome de utilizador	userName	string
valor	value	string
DT	dt	date-time
confiança	confidence	float
tipo	type	AIForged.DAL.VerificationType	Tipo de verificação
estado	status	AIForged.DAL.VerificationStatus	Sinalizadores de status de verificação
custo	charge	double
fornecedor	provider	string
Resultado	result	string

AIForged.ViewModels.ProjectViewModel

Projetos é um contêiner para faturamento e serviços

Name	Caminho	Tipo	Description
id	id	integer
userId	userId	string
estado	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 contabilísticas para projetos e serviços
totalDocsCount	totalDocsCount	integer
services	services	array of AIForged.ViewModels.ParameterDefViewModel

AIForged.DAL.ProjectStatus

Usado para indicar o status de um projeto

: integer

AIForged.ViewModels.DataTypeViewModel

Tipos de dados utilizados para regras e processamento interno

Name	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

A categoria de tipos de dados

: integer

AIForged.ViewModels.EnumDataViewModel

Lista de Enums do sistema e informações básicas da interface do usuário

Name	Caminho	Tipo	Description
id	id	integer
tipo	type	AIForged.DAL.EnumType	Enum de todos os enums no sistema
typeName	typeName	string
nome	name	string
valor	value	integer
descrição	description	string
info	info	string
icon	icon	string
color	color	string

AIForged.DAL.EnumType

Enum de todos os enums no sistema

: integer

AIForged.ViewModels.VerificationSummary

Informações de verificação do sistema e do utilizador para campos em documentos

Name	Caminho	Tipo	Description
id	id	integer
parameterId	parameterId	integer
userId	userId	string
valor	value	string
DT	dt	date-time
confiança	confidence	float
símbolosConfiança	symbolsConfidence	string
tipo	type	AIForged.DAL.VerificationType	Tipo de verificação
estado	status	AIForged.DAL.VerificationStatus	Sinalizadores de status de verificação
Resultado	result	string
caixa	box	string
info	info	string
dados	data	byte
nome de utilizador	userName	string
serviceId	serviceId	integer
serviceDocId	serviceDocId	integer
fornecedor	provider	string
configuraçãoId	settingId	integer
item de trabalho	workItem	integer
transactionId	transactionId	integer
custo	charge	double
paramDefId	paramDefId	integer
paramDefName	paramDefName	string
projectId	projectId	integer
nome_do_projeto	projectName	string
docId	docId	integer
docFileName	docFileName	string
docContentType	docContentType	string
docUtilização	docUsage	AIForged.DAL.UsageType	Porque armazenamos este documento
docStatus	docStatus	AIForged.DAL.DocumentStatus	Indicar o estado de um documento no sistema
classId	classId	integer
className	className	string
ano	year	integer
mês	month	integer
day	day	integer
dia da semana	dayOfWeek	System.DayOfWeek	O dia da semana
count	count	integer
média	average	float
min	min	float
max	max	float

System.DayOfWeek

O dia da semana

: integer

ficheiro

Este é o tipo de dados básicos 'arquivo'.

cadeia (de caracteres)

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

objecto

Este é o tipo 'objeto'.

date-time

: date-time

Partilhar via

AIForged (Pré-visualização)

Pré-requisitos

Um plano Microsoft Power Apps ou Power Automate

Uma conta e um serviço AIForged

Como obter credenciais

Como criar e treinar um serviço AIForged

Introdução ao conector

Authentication

Problemas conhecidos e limitações

Erros e soluções comuns

FAQ

Limites de Limitação

Ações

Carregar e classificar um documento

Parâmetros

Devoluções

Carregar obter uma classificação de documento

Parâmetros

Devoluções

Carregue e extraia informações para verificação

Parâmetros

Devoluções

Encontrar um projeto por nome

Parâmetros

Devoluções

Encontre documentos usando critérios de pesquisa estruturados. Os resultados podem ser paginados

Parâmetros

Devoluções

Excluir um blob de documento

Parâmetros

Devoluções

Excluir um documento por id

Parâmetros

Devoluções

Excluir um parâmetro

Parâmetros

Devoluções

Extrair parâmetros do documento

Parâmetros

Devoluções

Obtenha análises de verificação

Parâmetros

Devoluções

Obtenha um resumo das verificações

Parâmetros

Devoluções

Obtenha um resumo das verificações

Parâmetros

Devoluções

Obter a verificação mais recente sobre um parâmetro

Parâmetros

Devoluções

Obter blob por chave de blob

Parâmetros

Devoluções

Obter chave de api para um usuário

Parâmetros

Devoluções

Obter definição por Id

Parâmetros

Devoluções

Obter hierarquia de campos para todos os serviços em um projeto

Parâmetros

Devoluções

Obter hierarquia de campos para um serviço

Parâmetros

Devoluções

Obter hierarquia de parâmetros

Parâmetros

Devoluções

Obter imagens de documentos

Parâmetros

Devoluções

Obter imagens de documentos

Parâmetros

Devoluções

Obter informações de classificação

Parâmetros

Devoluções