AIForged (Preview)

Reference

AIForged is an Intelligent Document Processing solution to complex problems. AIForged can automate the processing and extraction of structured data from unstructured images. The connector provides integration and automation of intellegent document extraction with AIForged

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	AIForged
URL	https://www.aiforged.com
Email	support@aiforged.com

Connector Metadata
Publisher	Larc AI (PTY) Ltd
Website	https://www.aiforged.com
Privacy policy	https://portal.aiforged.com/privacypolicy.html
Categories	AI;Content and Files

AIForged is a cloud based Intelligent Document Processing solution for solving complex document extraction problems. The AIForged platform seamlessly integrates multiple services into a single model from industry-leading AI services like Microsoft, Google, Amazon, ABBYY, giving you the ability to use these services in tandem for optimum results. AIForged Intelligent Document Processing enable businesses to increase their output, with greater accuracy, greater speed at a lower cost.

Prerequisites

You need the following:

A Microsoft Power Apps or Power Automate plan

You need a Microsoft 365 account, a Power Automate plan and AIForged account / service.

An AIForged account and service

To use this connector, you will need an AIForged account. You also need to configure and train the AIForged service for accurate results. For more instructions Register on AIForged and set up an AIForged project and service by following the steps defined in Create a Project.

Here is a practicle example on how to extract information from social security cards Practicle Example - Social Security.

Also see our practical example to extract information from credit applications Practical Example - credit application.

How to get credentials

An AIForged account is needed to use AIForged. You can register by installing the AIForged app from the Microsoft Store or Microsoft Store Website.

Once the app is installed, you can register by using the simple registration steps Register.

To activate the account, you should receive an email with the activation link. Once you click on the activation link, AIForged will open with activation info. Once your account is activated you can login with your credentials and then use your credentials in your connector.

How to create and train an AIForged service

First you need to create a project container for billing purposes. Once your project is created you can add an intelligent service by following the wizard steps in the AIForged application.

Here is a list of practicle examples to extract information from documents

Practicle Example - Social Security Cards.

Practical Example - Bank statements.

Practical Example - Credit Application.

Get started with your connector

For more info on the gettings started see the following guide to Power Automate - Get Started

Authentication

This connector uses OAuth2 authentication (see steps above on how to obtain one). When creating a new connector (in Power Apps/Logic Apps), you'll be required to provide an authentication information from registration.

Known issues and limitations

You cannot enable MFA/2FA for the credentials you use in the connector.

Common errors and remedies

For any support or assistance create a support ticket at AIForged Support or send an email to support@aiforged.com

FAQ

For more info and FAQ see AIForged Documentation.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Delete a document blob	Delete a document blob
Delete a document by id	Delete a document by id
Delete a parameter	Delete a parameter
Extract document parameters	Extract document parameters
Find a project by name	Find a project by name
Find documnets by using structured search criteria. The results can be paged	Find documnets by using structured search criteria. The results can be paged
Get a document and its related documents	Get a document and its related documents
Get a document by Id	Get a document by Id
Get a parameter by verification id	Get a parameter by verification id
Get a service by id	Get a service by id
Get a specific project	Get a specific project
Get a summary of verifications	Get a summary of verifications
Get a summary of verifications	Get a summary of verifications
Get a verification by id	Get a verification by id
Get a verification image shred	Get a verification image shred
Get all categories by project	Get all categories by project
Get api key for a user	Get api key for a user
Get blob by blob key	Get blob by blob key
Get by user and project	Get by user and project
Get classification information	Get classification information
Get current logged in user	Get current logged in user
Get data types	Get data types
Get definition by Id	Get definition by Id
Get document images	Get document images
Get document images	Get document images
Get hierarchy of fields for a service	Get hierarchy of fields for a service
Get hierarchy of fields for all services in a project	Get hierarchy of fields for all services in a project
Get latest verification on a parameter	Get latest verification on a parameter
Get parameter hierarchy	Get parameter hierarchy
Get parameter value	Get parameter value
Get parent service for a parameter def by Id	Get parent service for a parameter def by Id
Get preview documents and images for a service	Get preview documents and images for a service
Get projects and services linked to a user	Get projects and services linked to a user
Get services related to a project	Get services related to a project
Get system and application information	Get system and application information
Get system enum values	Get system enum values
Get the current service Data and Time	Get the current service Data and Time
Get the data blob for a document id by image type	Get the data blob for a document id by image type
Get verification analytics	Get verification analytics
Get verifications on a parameter	Get verifications on a parameter
Upload and classify a document	Upload and classify a document
Upload and extract information for verification	Upload and extract information for verification
Upload get a document classification	Upload get a document classification

Delete a document blob

Operation ID:: Document_DeleteBlob

Delete a document blob

Parameters

Name	Key	Required	Type	Description
The blob id	id		integer	The blob id
API version header	X-Api-Version	True	string	API version header

Returns

response: file

Delete a document by id

Operation ID:: Document_Delete

Delete a document by id

Parameters

Name	Key	Required	Type	Description
Document id to delete	id		integer	Document id to delete
API version header	X-Api-Version	True	string	API version header

Returns

Document metadata info

Body: AIForged.ViewModels.DocumentViewModel

Delete a parameter

Operation ID:: Parameters_Delete

Delete a parameter

Parameters

Name	Key	Required	Type	Description
The parameter id	paramid		integer	The parameter id
API version header	X-Api-Version	True	string	API version header

Returns

Fields values linked ot extracted from documents

Body: AIForged.ViewModels.DocumentParameterViewModel

Extract document parameters

Operation ID:: Parameters_Extract

Extract document parameters

Parameters

Name	Key	Required	Type	Description
The document id	docid		integer	The document id
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.DocumentExtraction

Find a project by name

Operation ID:: Project_GetByName

Find a project by name

Parameters

Name	Key	Required	Type	Description
The user id	userId		string	The user id
Project name	projectName		string	Project name
API version header	X-Api-Version	True	string	API version header

Returns

Projects is a container for billing and services

Body: AIForged.ViewModels.ProjectViewModel

Find documnets by using structured search criteria. The results can be paged

Operation ID:: Document_GetExtendedV0_9

Find documnets by using structured search criteria. The results can be paged

Parameters

Name	Key	Required	Type	Description
Owner of the document	userId		string	Owner of the document
The project id	projectId		integer	The project id
The service id	stpdId		integer	The service id
The folder or usage	usage		integer	The folder or usage
The status	status		integer	The status
A class name filter	classname		string	A class name filter
Filename filter	filename		string	Filename filter
File type filter	filetype		string	File type filter
Start date range for documents	start		date-time	Start date range for documents
End date range for documents	end		date-time	End date range for documents
Master or parent of the document	masterid		integer	Master or parent of the document
Page number	pageNo		integer	Page number
Size of a page	pageSize		integer	Size of a page
Sort by field	sortField		integer	Sort by field
Sort direction based on the sortfield	sortDirection		integer	Sort direction based on the sortfield
Filter for comments	comment		string	Filter for comments
Filter for results	result		string	Filter for results
Filter for a result id	resultId		string	Filter for a result id
Filter for result index	resultIndex		integer	Filter for result index
Filter for external ids	externalId		string	Filter for external ids
Filter for doc guids	docGuid		string	Filter for doc guids
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.DocumentViewModel

Operation ID:: Document_GetHierarchy

Get a document and its related documents

Parameters

Name	Key	Required	Type	Description
Document id	id		integer	Document id
API version header	X-Api-Version	True	string	API version header

Returns

Document metadata info

Body: AIForged.ViewModels.DocumentViewModel

Get a document by Id

Operation ID:: Document_GetDocument

Get a document by Id

Parameters

Name	Key	Required	Type	Description
The document id	id		integer	The document id
API version header	X-Api-Version	True	string	API version header

Returns

Document metadata info

Body: AIForged.ViewModels.DocumentViewModel

Get a parameter by verification id

Operation ID:: Parameters_GetByVerification

Get a parameter by verification id

Parameters

Name	Key	Required	Type	Description
The verification id	verificationId		integer	The verification id
API version header	X-Api-Version	True	string	API version header

Returns

Fields values linked ot extracted from documents

Body: AIForged.ViewModels.DocumentParameterViewModel

Get a service by id

Operation ID:: Services_Get

Get a service by id

Parameters

Name	Key	Required	Type	Description
The service id	stpdId		integer	The service id
API version header	X-Api-Version	True	string	API version header

Returns

Service, settings abd rules definitions

Body: AIForged.ViewModels.ParameterDefViewModel

Get a specific project

Operation ID:: Project_GetUserProject

Get a specific project

Parameters

Name	Key	Required	Type	Description
The user id	userId		string	The user id
The project id	projectId		integer	The project id
API version header	X-Api-Version	True	string	API version header

Returns

Projects is a container for billing and services

Body: AIForged.ViewModels.ProjectViewModel

Get a summary of verifications

Operation ID:: Parameters_GetSummary

Get a summary of verifications

Parameters

Name	Key	Required	Type	Description
The project id	projectId		integer	The project id
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.DocParamSummary

Get a summary of verifications

Operation ID:: Verification_GetSummary

Get a summary of verifications

Parameters

Name	Key	Required	Type	Description
Project id	projectId		integer	Project id
Service id	stpdId		integer	Service id
Definition id	pdId		integer	Definition id
Only latest or history	latestOnly		boolean	Only latest or history
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.VerificationSummary

Get a verification by id

Operation ID:: Verification_Get

Get a verification by id

Parameters

Name	Key	Required	Type	Description
Verification id	verificationId		integer	Verification id
API version header	X-Api-Version	True	string	API version header

Returns

System and user verification info for fields on documents

Body: AIForged.ViewModels.VerificationViewModel

Get a verification image shred

Operation ID:: Verification_GetShred

Get a verification image shred

Parameters

Name	Key	Required	Type	Description
User for the shred	userId		string	User for the shred
Document id	docId		integer	Document id
Parameter id	parId		integer	Parameter id
Verification id	verificationId		integer	Verification id
Should the image be inline	inline		boolean	Should the image be inline
API version header	X-Api-Version	True	string	API version header

Returns

response: file

Get all categories by project

Operation ID:: Classes_GetByProject

Get all categories by project

Parameters

Name	Key	Required	Type	Description
The ptoject id	projectId		integer	The ptoject id
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.ClassesViewModel

Get api key for a user

Operation ID:: Account_GetApiKey

Get api key for a user

Parameters

Name	Key	Required	Type	Description
The user id	userId		string	The user id
API version header	X-Api-Version	True	string	API version header

Returns

response: string

Get blob by blob key

Operation ID:: Document_GetBlobById

Get blob by blob key

Parameters

Name	Key	Required	Type	Description
The blob id	id		integer	The blob id
API version header	X-Api-Version	True	string	API version header

Returns

response: file

Get by user and project

Operation ID:: Classes_GetByUser

Get by user and project

Parameters

Name	Key	Required	Type	Description
The user id	userId		string	The user id
The project id	projectId		integer	The project id
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.ClassesViewModel

Get classification information

Operation ID:: Classes_Get

Get classification information

Parameters

Name	Key	Required	Type	Description
The id of the classification	Id		integer	The id of the classification
API version header	X-Api-Version	True	string	API version header

Returns

Categories/Classes for training and classification

Body: AIForged.ViewModels.ClassesViewModel

Get current logged in user

Operation ID:: Account_GetCurrentUser

Get current logged in user

Parameters

Name	Key	Required	Type	Description
API version header	X-Api-Version	True	string	API version header

Returns

User information

Body: AIForged.ViewModels.UserViewModel

Get data types

Operation ID:: System_GetDataTypes

Get data types

Parameters

Name	Key	Required	Type	Description
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.DataTypeViewModel

Get definition by Id

Operation ID:: ParamDef_Get

Get definition by Id

Parameters

Name	Key	Required	Type	Description
The definition id	id		integer	The definition id
API version header	X-Api-Version	True	string	API version header

Returns

Service, settings abd rules definitions

Body: AIForged.ViewModels.ParameterDefViewModel

Get document images

Operation ID:: Document_GetImages

Get document images

Parameters

Name	Key	Required	Type	Description
The document id	id		integer	The document id
Service id	stpdId		integer	Service id
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.DocumentDataViewModel

Get document images

Operation ID:: Document_GetDataV09

Get document images

Parameters

Name	Key	Required	Type	Description
Document id	id		integer	Document id
Image type	type		integer	Image type
Image content type	contentType		string	Image content type
A test filter	text		string	A test filter
The related blob id	blobid		integer	The related blob id
The page index	pageindex		integer	The page index
Number of images to return	imagesCount		integer	Number of images to return
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.DocumentDataViewModel

Get hierarchy of fields for a service

Operation ID:: ParamDef_GetHierachy

Get hierarchy of fields for a service

Parameters

Name	Key	Required	Type	Description
The project id	projectId		integer	The project id
The service id	stpdId		integer	The service id
Include counter stats	includeCount		boolean	Include counter stats
Include settings	includeSettings		boolean	Include settings
Include child definiitions	includeChildren		boolean	Include child definiitions
API version header	X-Api-Version	True	string	API version header

Returns

Service, settings abd rules definitions

Body: AIForged.ViewModels.ParameterDefViewModel

Get hierarchy of fields for all services in a project

Operation ID:: Project_GetHierachies

Get hierarchy of fields for all services in a project

Parameters

Name	Key	Required	Type	Description
The user id	userId		string	The user id
The project id	projectId		integer	The project id
The service id	stpdId		integer	The service id
The group id	groupId		integer	The group id
Include counter stats	includeCount		boolean	Include counter stats
Only include services	onlyServices		boolean	Only include services
Include settings	includeSettings		boolean	Include settings
Include children	includeChildren		boolean	Include children
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.ParameterDefViewModel

Get latest verification on a parameter

Operation ID:: Verification_GetLatest

Get latest verification on a parameter

Parameters

Name	Key	Required	Type	Description
Document id	docId		integer	Document id
Parameter id	parameterId		integer	Parameter id
Definition id	pdId		integer	Definition id
API version header	X-Api-Version	True	string	API version header

Returns

System and user verification info for fields on documents

Body: AIForged.ViewModels.VerificationViewModel

Get parameter hierarchy

Operation ID:: Parameters_GetHierarchy

Get parameter hierarchy

Parameters

Name	Key	Required	Type	Description
The document id	docId		integer	The document id
The service id	stpdId		integer	The service id
Include verification data	includeverification		boolean	Include verification data
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.DocumentParameterViewModel

Get parameter value

Operation ID:: Parameters_Get

Get parameter value

Parameters

Name	Key	Required	Type	Description
The document id	docId		integer	The document id
The service id	stpdId		integer	The service id
Parameter category	category		integer	Parameter category
Parameter grouping	grouping		integer	Parameter grouping
Include verification data	includeverification		boolean	Include verification data
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.DocumentParameterViewModel

Get parent service for a parameter def by Id

Operation ID:: ParamDef_GetParentService

Get parent service for a parameter def by Id

Parameters

Name	Key	Required	Type	Description
The parameter definition id	id		integer	The parameter definition id
API version header	X-Api-Version	True	string	API version header

Returns

Service, settings abd rules definitions

Body: AIForged.ViewModels.ParameterDefViewModel

Get preview documents and images for a service

Operation ID:: Document_GetPreviews

Get preview documents and images for a service

Parameters

Name	Key	Required	Type	Description
The user that owns the service	userId		string	The user that owns the service
The project id	projectId		integer	The project id
The service id	stpdId		integer	The service id
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.DocumentViewModel

Get projects and services linked to a user

Operation ID:: Project_GetByUser

Get projects and services linked to a user

Parameters

Name	Key	Required	Type	Description
The user id	userId		string	The user id
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.ProjectViewModel

Operation ID:: Project_GetServices

Get services related to a project

Parameters

Name	Key	Required	Type	Description
The user id	userId		string	The user id
The project id	projectId		integer	The project id
Service type filter	stlfilter		integer	Service type filter
Filter by engine	enginefilter		string	Filter by engine
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.ParameterDefViewModel

Get system and application information

Operation ID:: System_GetSystemInfo

Get system and application information

Parameters

Name	Key	Required	Type	Description
API version header	X-Api-Version	True	string	API version header

Returns

response: object

Get system enum values

Operation ID:: System_GetEnumData

Get system enum values

Parameters

Name	Key	Required	Type	Description
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.EnumDataViewModel

Get the current service Data and Time

Operation ID:: System_GetSystemDate

Get the current service Data and Time

Parameters

Name	Key	Required	Type	Description
API version header	X-Api-Version	True	string	API version header

Returns

response: date-time

Get the data blob for a document id by image type

Operation ID:: Document_GetBlobV09

Get the data blob for a document id by image type

Parameters

Name	Key	Required	Type	Description
User id that owns the document	userId		string	User id that owns the document
Blob id	id		integer	Blob id
The blob type	type		integer	The blob type
API version header	X-Api-Version	True	string	API version header

Returns

response: file

Get verification analytics

Operation ID:: Verification_GetHeatmap

Get verification analytics

Parameters

Name	Key	Required	Type	Description
The project id	projectId		integer	The project id
Service id	stpdId		integer	Service id
Only the latest	latestOnly		boolean	Only the latest
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.VerificationSummary

Get verifications on a parameter

Operation ID:: Verification_GetAll

Get verifications on a parameter

Parameters

Name	Key	Required	Type	Description
Document id	docId		integer	Document id
Parameter id	parameterId		integer	Parameter id
API version header	X-Api-Version	True	string	API version header

Returns

response: array of AIForged.ViewModels.VerificationViewModel

Upload and classify a document

Operation ID:: Document_Classify

Upload and classify a document

Parameters

Name	Key	Required	Type	Description
The service id	stpdId		integer	The service id
Project id	projectId		integer	Project id
The file data	file		file	The file data
API version header	X-Api-Version	True	string	API version header

Returns

Document metadata info

Body: AIForged.ViewModels.DocumentViewModel

Upload and extract information for verification

Operation ID:: Document_ExtractAndVerify

Upload and extract information for verification

Parameters

Name	Key	Required	Type	Description
The service id	stpdId		integer	The service id
The project id	projectId		integer	The project id
The file	file		file	The file
API version header	X-Api-Version	True	string	API version header

Returns

Document metadata info

Body: AIForged.ViewModels.DocumentViewModel

Upload get a document classification

Operation ID:: Document_GetClassification

Upload get a document classification

Parameters

Name	Key	Required	Type	Description
The service id	stpdId		integer	The service id
The project id	projectId		integer	The project id
The document id	docId		integer	The document id
API version header	X-Api-Version	True	string	API version header

Returns

Categories/Classes for training and classification

Body: AIForged.ViewModels.ClassesViewModel

Definitions

AIForged.ViewModels.UserViewModel

User information

Name	Path	Type
id	id	string
userName	userName	string
fullName	fullName	string
email	email	email
jobTitle	jobTitle	string
phoneNumber	phoneNumber	phone
configuration	configuration	string
isEnabled	isEnabled	boolean
isLockedOut	isLockedOut	boolean
friendlyName	friendlyName	string
createdBy	createdBy	string
updatedBy	updatedBy	string
createdDate	createdDate	date-time
updatedDate	updatedDate	date-time
roles	roles	array of string

AIForged.ViewModels.ClassesViewModel

Categories/Classes for training and classification

Name	Path	Type	Description
id	id	integer
userId	userId	string
projectId	projectId	integer
name	name	string
description	description	string
comment	comment	string
dtc	dtc	date-time
dtm	dtm	date-time
type	type	AIForged.DAL.ClassType	System category type
related	related	integer

AIForged.DAL.ClassType

System category type

: integer

AIForged.ViewModels.DocumentViewModel

Document metadata info

Name	Path	Type	Description
id	id	integer
userId	userId	string
projectId	projectId	integer
serviceId	serviceId	integer
status	status	AIForged.DAL.DocumentStatus	Indicate the status of a document in the system
usage	usage	AIForged.DAL.UsageType	Why do we store this document
classId	classId	integer
contentType	contentType	string
filename	filename	string
fileType	fileType	string
dtc	dtc	date-time
dtm	dtm	date-time
documentId	documentId	guid
externalId	externalId	string
masterId	masterId	integer
result	result	string
resultId	resultId	string
resultIndex	resultIndex	integer
comment	comment	string
availability	availability	AIForged.DAL.Availability	Avalability of a record
resultParameters	resultParameters	array of AIForged.ViewModels.DocumentParameterViewModel
data	data	array of AIForged.ViewModels.DocumentDataViewModel
documents	documents	array of AIForged.ViewModels.DocumentViewModel
originId	originId	integer
canVerify	canVerify	boolean
canClassify	canClassify	boolean
canTrain	canTrain	boolean
trained	trained	boolean
linkedDocsCount	linkedDocsCount	integer
trainingFieldCount	trainingFieldCount	integer
trainedParametersCount	trainedParametersCount	integer

AIForged.DAL.DocumentStatus

Indicate the status of a document in the system

: integer

AIForged.DAL.UsageType

Why do we store this document

: integer

AIForged.DAL.Availability

Avalability of a record

: integer

AIForged.ViewModels.DocumentParameterViewModel

Fields values linked ot extracted from documents

Name	Path	Type	Description
id	id	integer
documentId	documentId	integer
paramDefId	paramDefId	integer
parentId	parentId	integer
sourceId	sourceId	integer
value	value	string
data	data	byte
index	index	integer
colIndex	colIndex	integer
colSpan	colSpan	integer
rowIndex	rowIndex	integer
rowSpan	rowSpan	integer
availability	availability	AIForged.DAL.Availability	Avalability of a record
paramDef	paramDef		Service, settings abd rules definitions
children	children	array of AIForged.ViewModels.DocumentParameterViewModel
verifications	verifications	array of AIForged.ViewModels.VerificationViewModel

AIForged.ViewModels.ParameterDefViewModel

Service, settings abd rules definitions

Name	Path	Type	Description
id	id	integer
projectId	projectId	integer
serviceTypeId	serviceTypeId	integer
serviceId	serviceId	integer
classId	classId	integer
parentId	parentId	integer
name	name	string
label	label	string
tags	tags	string
description	description	string
dtc	dtc	date-time
dtm	dtm	date-time
status	status	AIForged.DAL.ParameterDefinitionStatus	Status of definition
category	category	AIForged.DAL.ParameterDefinitionCategory	Category of definition
grouping	grouping	AIForged.DAL.GroupingType	Type of field grouping
valueType	valueType	AIForged.DAL.ValueType	The type of values used for rules and settings
valueTypeName	valueTypeName	string
defaultValue	defaultValue	string
required	required	AIForged.DAL.RequiredOption	Indicate the if an option is required
index	index	integer
info	info	string
reference	reference	string
rating	rating	float
availability	availability	AIForged.DAL.Availability	Avalability of a record
children	children	array of AIForged.ViewModels.ParameterDefViewModel
settings	settings	array of AIForged.DAL.Models.ParameterDefSettingViewModel
totalCharge	totalCharge	double
userCount	userCount	integer
parameterCount	parameterCount	integer
documentCount	documentCount	integer
validation	validation	string

AIForged.DAL.ParameterDefinitionStatus

Status of definition

: integer

AIForged.DAL.ParameterDefinitionCategory

Category of definition

: integer

AIForged.DAL.GroupingType

Type of field grouping

: integer

AIForged.DAL.ValueType

The type of values used for rules and settings

: integer

AIForged.DAL.RequiredOption

Indicate the if an option is required

: integer

AIForged.DAL.Models.ParameterDefSettingViewModel

Detailed settings for rules and settings

Name	Path	Type	Description
id	id	integer
parameterDefId	parameterDefId	integer
type	type	AIForged.DAL.SettingType	The type of setting related to a parameter
status	status	AIForged.DAL.SettingStatus	The status of a setting related to a parameter
dtc	dtc	date-time
dtm	dtm	date-time
comment	comment	string
info	info	string
data	data	string
minValue	minValue	string
maxValue	maxValue	string
confidence	confidence	float
minConfidence	minConfidence	float
maxConfidence	maxConfidence	float
isCaseSensative	isCaseSensative	boolean
invert	invert	boolean
oneLine	oneLine	boolean
oneWord	oneWord	boolean
isHandwriting	isHandwriting	boolean
orientation	orientation	AIForged.DAL.Orientation	Text orientation of a field
marking	marking	AIForged.DAL.MarkingType	Marking type of text
cells	cells	integer
clearBefore	clearBefore	AIForged.DAL.OptionStatusFlags	Status flag of options
clearAfter	clearAfter	AIForged.DAL.OptionStatusFlags	Status flag of options
cleanupValuesBefore	cleanupValuesBefore	boolean
cleanupValuesAfter	cleanupValuesAfter	boolean
validateValuesBefore	validateValuesBefore	boolean
validateValuesAfter	validateValuesAfter	boolean
abortOnValidationError	abortOnValidationError	boolean
isReplacementCaseSensative	isReplacementCaseSensative	boolean
compileResults	compileResults	string
maxRetry	maxRetry	integer
timeout	timeout	string
userId	userId	string

AIForged.DAL.SettingType

The type of setting related to a parameter

: integer

AIForged.DAL.SettingStatus

The status of a setting related to a parameter

: integer

AIForged.DAL.Orientation

Text orientation of a field

: integer

AIForged.DAL.MarkingType

Marking type of text

: integer

AIForged.DAL.OptionStatusFlags

Status flag of options

: integer

AIForged.ViewModels.VerificationViewModel

System and user verification info for fields on documents

Name	Path	Type	Description
id	id	integer
parameterId	parameterId	integer
userId	userId	string
value	value	string
dt	dt	date-time
confidence	confidence	float
symbolsConfidence	symbolsConfidence	string
type	type	AIForged.DAL.VerificationType	Type of verification
status	status	AIForged.DAL.VerificationStatus	Verification status flags
result	result	string
box	box	string
info	info	string
data	data	byte
userName	userName	string
serviceId	serviceId	integer
serviceDocId	serviceDocId	integer
provider	provider	string
settingId	settingId	integer
workItem	workItem	integer
transactionId	transactionId	integer
charge	charge	double

AIForged.DAL.VerificationType

Type of verification

: integer

AIForged.DAL.VerificationStatus

Verification status flags

: integer

AIForged.ViewModels.DocumentDataViewModel

Document blob data

Name	Path	Type	Description
id	id	integer
documentId	documentId	integer
blobId	blobId	integer
type	type	AIForged.DAL.DocumentDataType	Indicate the type of data related to a document
data	data	byte
preview	preview	byte
text	text	string
info	info	string
contentType	contentType	string
resultId	resultId	string
index	index	integer
width	width	double
height	height	double
resolution	resolution	double
availability	availability	AIForged.DAL.Availability	Avalability of a record

AIForged.DAL.DocumentDataType

Indicate the type of data related to a document

: integer

AIForged.ViewModels.DocParamSummary

Document summary for statistics with parameters info

Name	Path	Type	Description
projectId	projectId	integer
serviceType	serviceType	integer
serviceId	serviceId	integer
usage	usage	AIForged.DAL.UsageType	Why do we store this document
status	status	AIForged.DAL.DocumentStatus	Indicate the status of a document in the system
name	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
category	category	AIForged.DAL.ParameterDefinitionCategory	Category of definition
grouping	grouping	AIForged.DAL.GroupingType	Type of field grouping
valueType	valueType	AIForged.DAL.ValueType	The type of values used for rules and settings
value	value	string
index	index	integer

AIForged.ViewModels.DocumentExtraction

Transposed extraction of structured document results

Name	Path	Type	Description
id	id	integer
parentId	parentId	integer
name	name	string
label	label	string
category	category	AIForged.DAL.ParameterDefinitionCategory	Category of definition
grouping	grouping	AIForged.DAL.GroupingType	Type of field grouping
valueType	valueType	AIForged.DAL.ValueType	The type of values used for rules and settings
index	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
confidence	confidence	float
type	type	AIForged.DAL.VerificationType	Type of verification
status	status	AIForged.DAL.VerificationStatus	Verification status flags
charge	charge	double
provider	provider	string
result	result	string

AIForged.ViewModels.ProjectViewModel

Projects is a container for billing and services

Name	Path	Type	Description
id	id	integer
userId	userId	string
status	status	AIForged.DAL.ProjectStatus	Used to indicate the status of a project
name	name	string
description	description	string
comment	comment	string
dtc	dtc	date-time
dtm	dtm	date-time
balance	balance		Accounting info for projects and services
totalDocsCount	totalDocsCount	integer
services	services	array of AIForged.ViewModels.ParameterDefViewModel

AIForged.DAL.ProjectStatus

Used to indicate the status of a project

: integer

AIForged.ViewModels.DataTypeViewModel

Data types used for rules and internal processing

Name	Path	Type	Description
id	id	AIForged.DAL.ValueType	The type of values used for rules and settings
name	name	string
description	description	string
category	category	AIForged.DAL.DataTypeCategory	The category of data types
valueTypeName	valueTypeName	string
defaultValue	defaultValue	string
data	data	string

AIForged.DAL.DataTypeCategory

The category of data types

: integer

AIForged.ViewModels.EnumDataViewModel

List of system Enums and basic UI info

Name	Path	Type	Description
id	id	integer
type	type	AIForged.DAL.EnumType	Enum of all enums in the system
typeName	typeName	string
name	name	string
value	value	integer
description	description	string
info	info	string
icon	icon	string
color	color	string

AIForged.DAL.EnumType

Enum of all enums in the system

: integer

AIForged.ViewModels.VerificationSummary

System and user verification info for fields on documents

Name	Path	Type	Description
id	id	integer
parameterId	parameterId	integer
userId	userId	string
value	value	string
dt	dt	date-time
confidence	confidence	float
symbolsConfidence	symbolsConfidence	string
type	type	AIForged.DAL.VerificationType	Type of verification
status	status	AIForged.DAL.VerificationStatus	Verification status flags
result	result	string
box	box	string
info	info	string
data	data	byte
userName	userName	string
serviceId	serviceId	integer
serviceDocId	serviceDocId	integer
provider	provider	string
settingId	settingId	integer
workItem	workItem	integer
transactionId	transactionId	integer
charge	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	Why do we store this document
docStatus	docStatus	AIForged.DAL.DocumentStatus	Indicate the status of a document in the system
classId	classId	integer
className	className	string
year	year	integer
month	month	integer
day	day	integer
dayOfWeek	dayOfWeek	System.DayOfWeek	The calendar day of the week
count	count	integer
average	average	float
min	min	float
max	max	float

System.DayOfWeek

The calendar day of the week

: integer

file

This is the basic data type 'file'.

string

This is the basic data type 'string'.

object

This is the type 'object'.

date-time

: date-time

共用方式為

AIForged (Preview)

Prerequisites

A Microsoft Power Apps or Power Automate plan

An AIForged account and service

How to get credentials

How to create and train an AIForged service

Get started with your connector

Authentication

Known issues and limitations

Common errors and remedies

FAQ

Throttling Limits

Actions

Delete a document blob

Parameters

Returns

Delete a document by id

Parameters

Returns

Delete a parameter

Parameters

Returns

Extract document parameters

Parameters

Returns

Find a project by name

Parameters

Returns

Find documnets by using structured search criteria. The results can be paged

Parameters

Returns

Get a document and its related documents

Parameters

Returns

Get a document by Id

Parameters

Returns

Get a parameter by verification id

Parameters

Returns

Get a service by id

Parameters

Returns

Get a specific project

Parameters

Returns

Get a summary of verifications

Parameters

Returns

Get a summary of verifications

Parameters

Returns

Get a verification by id

Parameters

Returns

Get a verification image shred

Parameters

Returns

Get all categories by project

Parameters

Returns

Get api key for a user

Parameters

Returns

Get blob by blob key

Parameters

Returns

Get by user and project

Parameters

Returns

Get classification information

Parameters

Returns

Get current logged in user

Parameters

Returns

Get data types

Parameters

Returns