Skip to content
AIForged Documentation
Typescript
Initializing search
AIForged Documentation
đĄ Home
đ Getting Started
đŖ Release Notes
đŦ How to access AIForged
âī¸ Register
â Activate my account
đ Login
â Forgot Password
đ Multi-Factor Authentication
đ¤ĩ User Profile
đĄ Agents
đĄ Agents
đ§ Understanding Agents
đ Documents
đ Documents
âšī¸ Document Types
â Document Categories
⊠Understanding Document Flows
đī¸ Document Retention
â Document Attributes
đ§ Understanding the Documents Section
âī¸ Processing documents
âī¸ Processing documents
Processing Paramaters
đ AI Services
đ AI Services
đī¸ Scrapers
đī¸ Scrapers
đ§ Email Scraper
âī¸ OneDrive Scraping
đ Classification
đ Classification
AIForged Classifier
AIForged Clustering
ChatGPT Classifier
Microsoft Custom Text Classification
đ Extract And Verify
đ Extract And Verify
Amazon Identity Documents Extraction
Amazon Invoice Extraction
Amazon Receipt Extraction
Google Forms Parser
Google Invoice Parser
Document Intelligence
Document Intelligence â Custom Invoices
Document Intelligence â Prebuilt Models
LLM Extractor
đ OCR
đ OCR
Amazon OCR
Google OCR
Google Handwriting
Microsoft OCR
Microsoft Handwriting
Tesseract OCR
đŖī¸ Speech
đŖī¸ Speech
Microsoft Speech to Text
đ ī¸ Utilities
đ ī¸ Utilities
AIForged Digitizer
AIForged Image Splitter
AIForged Pdf Converter
Copy Documents
Image Pre-Processing
Move Documents
Webhooks
Custom Code
Workflow Code
đī¸ Vision
đī¸ Vision
Google Object Detection
Microsoft Object Detection
đ Service Flow Configurator
đĨ Organisations and User Groups
đĨ Organisations and User Groups
đ Maintaining Groups
đ Managing Roles within Usergroups
đ¤ Role Member Management
đŠ Notification History
đ° Wallets and Billing
đī¸ Cloning
⨠Custom Code
⨠Custom Code
âī¸ BaseModule
âī¸ BaseModule
General Methods
Module Data Types
Document Related Methods
Parameter Definitions Related Methods
Parameters Related Methods
Custom Dataset Related Methods
Verification Related Methods
Work Item Related Methods
Enums
Enums
DictionaryLookupMethod
DocumentDataType
DocumentStatus
GroupingType
ParameterDefinitionCategory
SortDirection
UsageType
ValueType
VerificationStatus
VerificationType
WorkItemAction
WorkItemMethod
WorkItemStatus
WorkItemType
Custom Code Example - Duplicate Document Check
đ Field Rules (Rules Engine)
đ Field Rules (Rules Engine)
đ Address
đ Boolean
đ Country
đ˛ Currency
đ Date / Time
âī¸ Email
đ¯ GPS Coordinate
đ ID Number
đĸ Number
đŧī¸ Picture
đ¤ String
đ¤ String
Sentiment Analysis
Spell Checking
đ Telephone Number
âŗ Timespan
đ ī¸ Field Enhancements and Configuration
đ ī¸ Field Enhancements and Configuration
đ Lookup
đ Mapping
đģ Script
đĄī¸ Verification Services
đ Workflow Script
âī¸ Advanced
đ§ SDK
đ§ SDK
đģ .NET
đģ .NET
đ Quickstart
đ§ How-To
đ§ How-To
Authentication
Documents
Retrieve Extraction Results
Work Items (HITL)
Custom Datasets
Errors & Retries
đ Client Reference
đ Client Reference
Audit Client
Account Client
Classes Client
Cloning Client
Contacts Client
DataSet Client
Documents Client
Group Client
Log Client
Marketplace Client (user group membership management)
Notification Client
ParamDef Client (parameter definitions)
ParamDef Client (parameter definitions)
Settings Data (BaseOption and Supporting Types)
Parameters Client (extracted document field)
Projects Client (Agents)
Roles Client
Services Client
Service Types Client
System Client
Verification Client
Wizard Client
Work Item Client
𧊠Models and Enums
Python
Typescript
UIPath Activities
UIPath Activities
Comprehensive Networking Tutorial for UIPath Developers
Comprehensive Networking Tutorial for UIPath Developers
Determining the Source of Network Issues in UIPath
Understanding Headers in HTTP Communication
Initialize Connection Context
Audit
Audit
Get Audit Trail
Convert Audit Trail to JSON
Balance
Balance
Get Balance
Dataset
Dataset
Create Dataset
Create Dataset Record
Delete Dataset
Delete Dataset Record
Delete Dataset Record By Key Value
Delete Dataset Records
Get Dataset
Get Dataset by Parameter Definition Id
Get Dataset by Id
Get Dataset Record
Get Dataset Record By Key Value
Get Datasets
Save Dataset
Synchronise Dataset
Update Dataset Record
Documents
Documents
Copy Document
Create Document Parameter
Create Verification
Delete Document
Delete Document Parameter
Export To CSV
Export To CSV Combined
Export To CSV File
Export To CSV Combined File
Export To DataTable
Export To Combined DataTable
Export To JSON
Export To JSON Combined File
Get Extraction Results
Get Document
Get Document Data
Get Document Images
Get Documents
Get Document Count
Get Latest Parameter Verification
Get Parameter Definition
Get Document Parameter Hierarchy
Get Document Parameters
Get Parameter Verifications
Get Verification Shred
Move Document
Save Document Image
Update Document Information
Update Document Status
Upload Document
Upload File
Upload Folder
Rerun Verification
Rerun All Verifications
Process Documents by Id
Process Document Objects
Logging
Logging
Add Log Message
Get Log Messages
Notifications
Notifications
Get Notifications
Flag As Read
Get Unread Notification
Platform
Platform
Get Data Types
Get Enum Data
Get System Date
Project
Project
Get Parameter Definition Hierarchy
Get Project By Name
Get Project By Id
Get Projects By User (Obsolete)
Get Project Category
Get Project Category By Name
Get Project Categories
Get Projects
Get Project Services
Service
Service
Get Service Audit
Get Service Charges
Get Service Events
User Groups
User Groups
Get Group
Get Group Roles
Get User Groups
Get Users by Role
WorkItem
WorkItem
Create QA Work Items
Create Work Item
Escalate Work Item
Get Work Item Count
Get Work Items
Get Work Queue
Transfer Work Item
Update Work Item
Typescript
¶
The Typescript SDK can be downloaded from:
https://github.com/aiforged/typescript
