- Overview
- Help Status
-
Activity
-
Attended Activity
- Review
-
Code Activity
- Apply Rules
- Attach
- Batch Transfer
- Burst Book
- Classify
- Clip Frames
- Convert Data
- Correct
- Deduplicate
- Detect Frames
- Detect Language
- Detect Language (Legacy)
- Dispose Batch
- Execute
- Export
- Extract
- Fill Data
- GPT Embed
- Image Processing
- Initialize Card
- Launch Process
- Mark Attachments
- Merge
- Recognize
- Redact
- Remove Level
- Render
- Route
- Send Mail
- Separate
- Spawn Batch
- Split Pages
- Split Text
- Text Transform
- Train Lexicon
- Translate
- XML Transform
-
Attended Activity
-
Article
- AI Assistants
- AI Powered Features
- Batch Processing Workflows
- Document Scanning
- PDF Processing
- Search Overview
-
Attachment Type
- EDI File
-
HTML Document Base
- HTML Document
- Mail Message
- JPEG Image
-
Office Document
- Excel Document
- Power Point Document
- Word Document
- PDF Document
- PST File
- Text Document
- TIFF Document
- vCard
- XML File
- ZIP Archive
-
Behavior
- Export Behavior
- Import Behavior
- Indexing Behavior
- Labeling Behavior
- PDF Data Mapping
- Separation Behavior
- Text Rendering
-
Capture Device
- ColorTrac Scanner
- Import Device
- ISIS Device
- TWAIN Device
-
Classify Method
-
ESP Classify Method
- Lexical
- Rules-Based
- Search Classifier
- Labelset-Based
- LLM Classifier
- Visual
-
ESP Classify Method
-
CMIS Binding
- CMIS
-
Custom Binding
- AppXtender
-
Base FTP Binding
- FTP
- SFTP
- Box
- Exchange
- FileBound
- IBM FileNet Connector
- IMAP
- NTFS
- OneDrive
- SharePoint
-
CMISQL Element
- CMISQL Query
- Join Clause
- ORDER BY Element
- Select Element
-
Where Predicate
- AT_LEVEL Predicate
- Comparison Predicate
- CONTAINS Predicate
- IN Predicate
- MATCHES Predicate
- Predicate List
- Scope Predicate
-
Collation Provider
-
Base Combining Provider
- AND
-
Base Array Provider
- Array
-
Ordered Array
- Key-Value List
- Key-Value Pair
- Combine
- Individual
- Multi-Column
- Pattern-Based
- Split
-
Base Combining Provider
-
Command
-
AI Chat
- AI Chat - Delete
- AI Chat - Rename
-
Attachment Type
- Attachment Type - Change Extension
- Attachment Type - Remove Attachment
- Attachment Type - Remove PDF Version
- Attachment Type - Rename Attachment
-
Batch
- Batch - Archive
- Batch - Change Priority
- Batch - Combine
- Batch - Pause
- Batch - Remove Job History
- Batch - Reset
- Batch - Resume
- Batch - Send To Production
- Batch - Send To Test
- Batch - Update Process
-
Batch Folder
- Batch Folder - Add To Index
- Batch Folder - Assign Document Type
-
Batch Folder - Classify Command
- Batch Folder - Classify
- Batch Folder - Train As
- Batch Folder - Train From
- Batch Folder - Collapse
- Batch Folder - Edit Type Assignment
- Batch Folder - Extract
- Batch Folder - Group Children
- Batch Folder - Insert Control Sheets
- Batch Folder - New Text Document
- Batch Folder - Remove From Index
- Batch Folder - Remove Level
- Batch Folder - Revert To Loose Pages
- Batch Folder - Set Field Value
- Batch Folder - Sort Children
-
Batch Object
- Batch Object - Append To Previous
- Batch Object - Clear Flag
-
Batch Object - Create New Folder
- Batch Object - Add Folder
- Batch Object - Insert Folder
- Batch Object - Flag Item
- Batch Object - Merge Selected
- Batch Object - Prepend to Next
- Batch Object - Rename
- Batch Object - Run Step
-
Batch Object - Send To Test Batch
- Batch Object - Copy To Test Batch
- Batch Object - Move To Test Batch
- Batch Object - Split Folder
-
Batch Page
- Batch Page - Generate Thumbnail
-
Batch Page - Image Command
- Batch Page - Display As Binary
- Batch Page - Display As Color
- Batch Page - Display As Grayscale
-
Batch Page - Image Editing Command
- Batch Page - Invert
- Batch Page - Reset
- Batch Page - Rotate Left
- Batch Page - Rotate Right
- Batch Page - Undo Image Cleanup
-
Batch Page - Image Review Command
- Batch Page - Apply Image Cleanup
- Batch Page - Rasterize
-
Batch Process
- Batch Process - Create Project
- Batch Process - Publish
- Batch Process - Unpublish
-
CMIS Connection
- CMIS Connection - Import Repository
- CMIS Connection - Reset
-
CMIS Document Link
- CMIS Document Link - Delete CMIS Document
- CMIS Document Link - Load
- CMIS Document Link - Move CMIS Document
- CMIS Document Link - Save Version
- CMIS Document Link - Update
- CMIS Export Map - Auto Map
-
CMIS Folder Link
- CMIS Folder Link - Delete
- CMIS Folder Link - Load Children
- CMIS Folder Link - Load Pages
- CMIS Folder Link - Load Properties
- CMIS Folder Link - Save Properties
- CMIS Import Map - Auto Map
- CMIS Repository - Reset
- CMIS Type Definition - Generate Local Type
- Column Map - Auto Map
- Content Link - Remove Link
-
Content Type
- Content Type - Clean Overrides
- Content Type - Create Data Model
- Content Type - Create Local Resources Folder
- Content Type - Create Search Index
- Content Type - Delete Search Index
- Content Type - Generate Control Sheets
- Content Type - Purge Training
- Content Type - Rebuild Training
- Content Type - Submit Indexing Job
- Copy Base - Auto Map
-
Data Connection
-
Data Connection - Connection Command
- Data Connection - Create Database
- Data Connection - Create Table
- Data Connection - Drop Table
- Data Connection - Test Connection
-
Data Connection - Connection Command
- Data Element - Remove Overrides
-
Data Field Container
- Data Field Container - Build Fine Tuning File
- Data Field Container - Import Schema
- Data Type - Convert To Value Reader
-
EDI File
- EDI File - Bundle
- EDI File - Load Data
- EDI File - Split Envelopes
- Excel Document - Convert to CSV
- Exchange - Rebuild Search Folder
- Field Class - Purge Training
-
File Store
- File Store - Move Objects Here
- File Store - Test Connection
-
File System Link
- File System Link - Change File Attributes
- File System Link - Copy File
- File System Link - Delete File
- File System Link - Load Content
- File System Link - Move File
- File System Link - Save Content
- Folder - Remove Empty Subfolders
-
FTP Link
- FTP Link - Delete File
- FTP Link - Load Content
- FTP Link - Save Content
-
HTML Document
- HTML Document - Condition HTML
- HTML Document - Convert to PDF
- HTML Document - Convert To Text
-
HTTP Link
- HTTP Link - Load Content
- HTTP Link - Rename Attachment
-
Lexicon
- Lexicon - Intersect
- Lexicon - Merge Training
- Lexicon - Normalize
- Lexicon - Subtract
- Lexicon - Truncate
- Machine - Tune File System
-
Mail Link
- Mail Link - Delete Message
- Mail Link - Expand Attachments
- Mail Link - Load Content
-
Mail Message
- Mail Message - Convert To RFC822
- Mail Message - Expand Attachments
-
Node
- Node - Add Multiple Items
- Node - Clear Children
- Node - Clone
- Node - Delete
- Node - Move Down
- Node - Move Up
- Node - Publish To Repository
- Node - Rename
- OAuth Client Credentials - Test
-
Object Library
- Object Library - Create Backup
- Object Library - Rename Script
-
PDF Document
- PDF Document - Burst
- PDF Document - Compact
- PDF Document - Repair
- Project - Remove Empty Subfolders
- PST File - Burst
- PST Link - Load Content
-
Resource File
- Resource File - Delete Fine Tuned Model
- Resource File - Rename
- Resource File - Start Fine Tuning Job
-
Root
- Root - Run Import
- Root - System Maintenance
-
Saved Query
- Saved Query - Delete
- Saved Query - Rename
- Search Index - Generate Subsets
-
SFTP Link
- SFTP Link - Delete File
- SFTP Link - Load Content
- SFTP Link - Save Content
-
Text Document
- Text Document - Insert Page Breaks
- Text Document - Normalize
- Text Document - Split
- Value Reader - Convert To Data Type
- vCard - Expand Photo
- Word Document - Convert to PDF
-
XML File
- XML File - Condition XML
- XML File - Format
- XML File - Load Data
- XML File - Split
- XML File - Validate Schema
-
ZIP Archive
- ZIP Archive - Unpackage
- ZIP Archive - Unzip
- ZIP Archive - Update
- ZIP Link - Load Content
-
AI Chat
-
Content Link
-
Document Link
- CMIS Document Link
- File System Link
- FTP Link
- HTTP Link
- Mail Link
- PST Link
- SFTP Link
- Subfile Link
- ZIP Link
-
Folder Link
- CMIS Folder Link
-
Document Link
-
Data Action
- Action List
- Calculate Value
- Clear Item
- Concat
-
Copy Base
- Append
- Copy
- Data Lookup
- Execute Rule
- Extract From
- Fill
- Parse Value
- Raise Issue
- Remove
- Require Value
-
Data Instance
- Checkbox Instance
-
Data Element Instance
-
Field Container Instance
-
Element Container Instance
- Document Instance
- Section Instance
- Section Instance Collection
- Table Instance
- Table Row Instance
-
Element Container Instance
-
Field Instance
- Table Cell Instance
-
Field Container Instance
- Labeled Instance
- Table Header Instance
-
Export Definition
- CMIS Export
- Data Export
-
File Export
- File Export
- FTP Export
- SFTP Export
- Mail Export
-
Export Format
- Attached File
-
Merge Format
- PDF Format
- TIF Format
- XML Format
- ZIP Format
-
Metadata Format
- JSON Metadata
-
KVP Metadata
- Delimited Metadata
- Simple Metadata
- XML Metadata
- Text Format
-
Grooper Command Console (GCC)
- connections
- databases
- help
- license
- scripts
- services
- utils
-
Import Definition
- CMIS Import
-
Import Provider
-
Cmis Import Base
- Import Descendants
- Import Query Results
-
File Import
- File System Import
- FTP Import
- SFTP Import
- HTTP Import
- Mail Import
- OPEX Import
- Search Import
- Test Batch
-
Cmis Import Base
-
IP Command
- Adjust Saturation
- Adjust Tint
- Analyze Photo
- Auto Adjust Levels
- Auto Color Balance
- Auto Convert
- Auto Deskew
- Auto Orient
- Auto QA
- Auto White Balance
- Barcode Detection
-
Binarize
- Threshold
- Blank Page Detection
-
Border Detect
- Auto Border Crop
- Auto Border Invert
-
Box Detection
- Box Removal
- Brightness Contrast
- Classify Image
- Color Detection
- Color Dropout
- Color Stamp Detection
- Colorize
- Compute Moments
- Contrast Stretch
- Convert
- Corner Detection
- Crop
- Dilate Erode
- Edge Detection
- Execute Profile
- Extract Channel
- Extract Features
- Extract Page
-
Feature Dropout
-
Binary Dropout
- Barcode Removal
- Blob Removal
- Border Fill
- Halftone Removal
- Hole Punch Removal
- Speck Removal
- Scratch Removal
- Shape Removal
-
Binary Dropout
- Filter
- Gamma Adjust
- Histogram
- Hough Lines
- Invert
-
Line Detection
- Line Removal
- Measure Entropy
- Mirror
- Negative Region Removal
- OCR Cleanup
- Patch Code Detection
- Posterize
- Projection Profile
- Randomize Defects
- Resize
- Rotate
- Shade Removal
- Shape Detection
- Solarize
- Sticky Note Detection
- Swap Channels
- Undistort
- Warp
-
Lookup Specification
- CMIS Lookup
- Database Lookup
- Lexicon Lookup
- Web Service Lookup
- XML Lookup
-
Measurement
-
Logical Measurement
- Logical Border
- Logical Point
- Logical Range
- Logical Rectangle
- Logical Size
-
Unit Measurement
- Unit Border
- Unit Line Length
- Unit Point
- Unit Range
- Unit Rectangle
- Unit Size
-
Logical Measurement
-
Node
- AI Assistant
-
Batch Object
-
Batch Folder
- Batch
- Batch Page
-
Batch Folder
- Batch Process
- Batch Process Step
- CMIS Connection
- CMIS Repository
-
Content Type
- Content Category
- Content Model
- Document Type
- Form Type
- Page Type
- Control Sheet
- Data Connection
-
Data Element
-
Data Field
- Data Column
-
Data Field Container
-
Data Element Container
- Data Model
- Data Section
- Data Table
-
Data Element Container
-
Data Field
- Data Rule
-
Extractor Node
- Data Type
- Field Class
- Value Reader
- File Store
-
Folder
- Batches Folder
- Local Resources Folder
- Machines
- Projects Folder
-
IP Element
-
IP Element Container
- IP Group
- IP Profile
- IP Step
-
IP Element Container
- Lexicon
- Machine
- Object Library
- OCR Profile
- Project
- Resource File
- Root
- Scanner Profile
- Separation Profile
- Training Page
-
Work Queue
- Processing Queue
- Review Queue
-
OCR Engine
- Azure OCR
- Layered OCR
- Tesseract OCR
-
Transym OCR Engine
- Transym OCR 4
- Transym OCR 5
-
Property Converter
- Auto Deskew - Precision Converter
-
Base Multi Culture Converter
- Multi Culture Converter
-
Multi Language Converter
- Translate - Source Languages Converter
- Transym OCR 5 - Tansym Language Converter
- Blank Zero Converter
-
Check List Converter
- AppXtender - Extended Property Converter
- CMIS Type Reference - Secondary Types Converter
- CMISQL Query - Joins Converter
- CMISQL Query - Select Elements Converter
- Tesseract OCR - Special Fonts Converter
- CMIS Export Map - Column Converter
- CMIS Folder Reference - Converter
- CMIS Import Map - Field Converter
- CMIS Object - Choice Converter
- Code Expression - Converter
-
Collection Converter
- Behavior - All Fields Converter
- Content Type - Behaviors Converter
- Export Format - Collection Converter
- Field Class - Context Zones Converter
- LDAP - ACL Converter
- Review - Command Options Converter
- Column Map - Column Converter
- Content Type - Unlimited Converter
-
Degrees Converter
- Square Angle Converter
- Execute Command - Link Name Converter
-
Expandable Converter
-
Base Culture Converter
-
Culture Converter
- Azure Document Intelligence OCR - Language Converter
- Azure OCR - Language Converter
-
Language Converter
- Tesseract OCR - Tess Language Converter
- Translate - Target Language Converter
- Culture Converter All
-
Culture Converter
- Batch Name Settings - Converter
- Border - Converter
-
Choice Converter
- Activity Processing - Queue Converter
- AI Chat Filter - Index Converter
- AI Search - Api Version Converter
- Apply Image Cleanup - Ip Profile Converter
- Azure OCR - Api Version Converter
- Azure OCR - Model Version Converter
- Barcode Extractor - Output Group Converter
- Base Combining Provider - Group Name Converter
- Batch - Step Converter
- Batch Process - Queue Converter
- Batch Process Step - Processing Scope Converter
- Batch Process Step - Queue Converter
- Batch Transfer - Process Converter
- Batch Transfer - Repository Converter
- Batch Transfer - Step Converter
- Build Fine Tuning File - Fill Method Converter
- Chat Filter - User Id Converter
- Chat Filter - User Name Converter
- Classify - Classification Level Converter
- Classify - Output Level Converter
- CMIS Export - Creatable Child Type Converter
- CMIS Export - Creatable Folder Converter
- CMIS Type Reference - Cmis Type Converter
- CMISQL Element - Qrderable Property Converter
- CMISQL Element - Queryable Property Converter
- CMISQL Element - Selectable Property Converter
- CMISQL Query - Primary Type Converter
- ColorTrac Scanner - Resolution Converter
- Comparison Filter - Function Name Converter
- Comparison Filter - Operand Type Converter
- Comparison Filter - Value Type Converter
- Comparison Predicate - Comp Op Converter
- Comparison Predicate - Value Converter
- Data Element - Display Label Converter
- Data Field - Sub Element Converter
- Database Table - Table Name Converter
- EDI Schema Importer - X12Schema Converter
- Fill - Fill Method Converter
- Fill Data - Name Converter
- Fill Descendants - Name Converter
- Flag Item - Flag Reason Converter
- Generate Local Type - Doc Type Property Converter
- Import Provider - Disposition Converter
- Import Repository - Repository Converter
- ISIS Device - Device Name Converter
- Join Clause - Secondary Type Converter
- Label Info - Parent Label Converter
- Lexicon Lookup - Lookup Field Converter
- Lexicon Lookup - Target Field Converter
- Nested Table - Table Converter
- ODBC - Pg Odbc Dsn Converter
- Pattern-Based - Group Name Converter
- PDF Data Mapping - Font Name Converter
- Predicate List - Logical Operator Converter
- Read Metadata - Property Name Converter
- Reference - Group Name Converter
- Regular Expression - Group Converter
- Remove From Index - Index Name Converter
- Remove Overrides - Property Name Converter
- Reset - Step Converter
- Root - License Url Converter
- Route Definition - Process Converter
- Run Step - Step Converter
- Schema Mapping - Schema Name Converter
- Search Index - Index Name Converter
- Search Index Query - Index Name Converter
- Send To Test Batch - Flag Reason Converter
- Set Field Value - Value Converter
- String - Pdf Font Name Converter
- Task Filter - Activity Name Converter
- Task Filter - Process Name Converter
- Task Filter - Queue Converter
- Task Filter - Step Name Converter
- Text Document - Encoding Converter
- Text Document - Normalize Encoding Converter
- TWAIN Device - Compression Mode Converter
- TWAIN Device - Device Name Converter
- Update Process - Process Converter
- Update Process - Step Converter
- Value Selector - Target Field Converter
- XML Value Selector - Target Field Converter
- Double Range - Double Range Converter
- Expandable Info Converter
- Integer Range - Integer Range Converter
- Logical Border - Arrow Converter
- Logical Border - Logical Border Converter
- Logical Point - Logical Point Converter
-
Logical Rectangle - Logical Rectangle Converter
- Logical Rectangle - Simple Rectangle Converter
- Logical Size - Logical Size Converter
-
On Off Converter
- Override Converter
- Verbose On Off Converter
- Percent Range - Percent Range Converter
- Point ExF - Converter
- Rectangle - Converter
-
Type Selector
- CMISQL Query - Where Element Converter
- Data Connection - Connection Converter
- Exchange - Auth Method Converter
- Execute - Command Converter
- Execute Activity - Activity Converter
- Execute Command - Command Converter
- Run Activity - Activity Converter
- SharePoint - Auth Method Converter
- Storage Type - Converter
- Web Service Lookup - Auth Method Converter
- Unit Border - Unit Border Converter
- Unit Line Length - Unit Line Length Converter
- Unit Point - Unit Point Converter
- Unit Range - Unit Range Converter
- Unit Rectangle - Converter
- Unit Size - Unit Size Converter
- Value Extractor - Converter
-
Base Culture Converter
- JPEG 2000 - Ratio Converter
- Logical Value - Simple Value Converter
- Logical Value - Universal Value Converter
- Node Information - Value Converter
-
Page Filter Converter
- Line Filter Converter
- Path Expression - Converter
- Percent Converter
- Pg Dictionary Converter
-
Pg Flags Converter
- Storage Type Numeric - Input Styles Converter
- Pg Ref Collection Converter
-
Pg String Collection Converter
- Batch Filter - Filter Converter
-
Pg Type Display Name Converter
- Add Multiple Items - Item Type Converter
- Computed Field - Field Type Converter
- Node Query - Node Type Converter
- Read Metadata - Source Converter
- Variable Definition - Variable Type Converter
- Product License - Quantity Converter
- Read Only Converter
- Rectangle - Inches Converter
-
Simple Converter
- Click to Edit Converter
- Data Action - Source Element Converter
- Data Action - Target Element Converter
- IN Predicate - In Predicate Values Converter
- OAuth Authentication - Login Converter
- Pattern Match - Group Options Converter
- Pg Format Converter
- Product License - Quantity Used Converter
- Project - Projects Converter
- Publish To Repository - Repository Converter
- Result Set Options - Sort Order Converter
- Review - View List Converter
- Stats Query - Name List Converter
- String - Pg Text Lines Converter
- Type Permissions - Command Converter
- Word Match - Term Options Converter
- Text Rendering - Size Converter
- Time Range Converter
- Time Ranges Converter
- Time Span Converter HMS
- Timer Service - Time Converter
- Times Converter
- Unit Value - Unit Value Converter
- Word Match - Integer Range Converter
-
Property Editor
- Anchor Definition - Location Editor
- Barcode Detected - Preview Image Editor
-
Choice Property Editor
- Azure Document Intelligence OCR - Model Editor
-
Base Culture Editor
-
Culture Editor
- Multi Culture Editor
- Culture Editor All
-
Language Editor
-
Multi Language Editor
- Translate - Source Languages Editor
- Transym OCR 5 - Transym Language Editor
- Tesseract OCR - Tess Language Editor
- Translate - Target Language Editor
-
Multi Language Editor
-
Culture Editor
-
Check List Editor
- AI Assistant - Search Index Editor
- AI Table Reader - Included Columns Editor
- Batch Filter - Activity Editor
- Batch Filter - Process Editor
- Batch Filter - Status Editor
- Batch Filter - Step Editor
- CMIS Type Reference - Secondary Types Editor
- Data Fill Method - Included Children Editor
- Delete Fine Tuned Model - Models Editor
- Generate Local Type - Property Check List
- IMAP - folder Editor
- Publish To Repository - Repository Editor
- Reset - Step Checklist Editor
-
Stats Query - Name List Editor
- Stats Query - Activity Names Editor
- Stats Query - Machine Names Editor
- Stats Query - Process Names Editor
- Stats Query - Stat Names Editor
- Stats Query - Step Names Editor
- Stats Query - User Names Editor
- Table Mapping - Column Check List
- Text Analysis - Entity Type Editor
- Type Permissions - Command Editor
- Data Connection - Table Name Editor
- Delete Fine Tuned Model - Model Editor
- GPT Embed - Embeddings Model Editor
- LLM Connector - Chat Model Editor
- LLM Connector - Embeddings Model Editor
- Return Value - Column Editor
- SQL Server - Database Name Editor
- Start Fine Tuning Job - Model Editor
- CMIS Compound Type - Editor
-
CMISQL Query - Query Editor
- Import Descendants - Filter Editor
-
Code Property Editor
- AI Chat Filter - Filter Editor
- Ask AI - Schema Editor
- Box - App Settings Editor
-
Code Expression Editor
- Batch Process Step - Next Step Editor
- Batch Process Step - Should Submit Editor
- Calculate Value - Value Expression Editor
- CMIS Export Map - Expression Editor
- CMIS Import Map - Expression Editor
- Code Expression - Editor
- Column Map - Expression Editor
- Computed Field - Expression Editor
- Concat - Trigger Editor
- Content Type - Caption Editor
- Copy Base - Trigger Editor
- Custom Statement - Statement Editor
- Data Export - Alternate Database Editor
- Data Field - Default Value Editor
-
Data Field - Field Expression Editor
- Data Field - Calculate Editor
- Data Field - Required Editor
- Data Field - Validate Editor
- Data Field - Validate Message Editor
- Data Rule - Trigger Editor
- Data Section - Caption Editor
- Expression Set - Default Value Editor
-
Expression Set - Field Expression Editor
- Expression Set - Calculate Editor
- Expression Set - Required Editor
- Expression Set - Validate Editor
- Expression Set - Validate Message Editor
- IP Element - Next Step Editor
- IP Element - Should Execute Editor
- Lookup Specification - Trigger Editor
- Metadata Options - Value Editor
- Path Expression - Editor
- Raise Issue - Log Message Editor
- Remove - Trigger Editor
- Require Value - Log Message Editor
- Text Transform - Record Editor
- Variable Definition - Expression Editor
- Create Table - Statement Editor
- Data Field Container - Css Editor
- Database Lookup - SQL Query Editor
- Embedded Lexicon - Local Entries Editor
- KVP Editor
- Lexicon - Lexicon Link Code Editor
- List Match - Local Entries Editor
- Mail Import - IMAP Query Editor
- Node Information - Props Editor
- Pattern Match - Output Format Editor
-
Regex Property Editor
- Parse Value - Pattern Editor
- Pattern-Based - Pattern Editor
- Text Match - Reg Ex Editor
- Search Classifier - Filter Editor
- Search Index - Filter Editor
- Search Index Query - Filter Editor
- Search Index Query - Order By Editor
- Search Index Query - Search Editor
- Send Mail - Template Editor
- String List Editor
- Submit Indexing Job - Select Editor
- Subset Filter - Filter Editor
-
Text Property Editor
- Node Description Editor
- Web Service - Header Editor
- Web Service Lookup - Post Data Editor
- Web Service Lookup - Url Editor
- Word Match - Output Format Editor
- XML Lookup - Selector Editor
- XML Transform - Transform Editor
- XML Value Selector - Path Editor
-
Folder Browse Editor
- CMIS Folder Reference - Editor
- File Directory Editor
- FTP Export - Ftp Folder Editor
- Mail Export - Mail Folder Editor
- SFTP Export - Ssh Folder Editor
- LDAP - ACL Editor
- OAuth Authentication - Login Editor
-
Object Collection Editor
- Content Type - Behavior Collection Editor
- License Package - License Collection Editor
- Pattern Match - Group Options Editor
- Permission Set - Type Perms Editor
- Predicate List - Predicate Collection Editor
- Review - Command Options Editor
- Root - Options Editor
- Word Match - Term Options Editor
-
Object Properties Editor
- Data Type - Collation Editor
- IP Step - Command Editor
-
Open File Editor
- Import Device - Zip File Editor
-
Reference Editor Base
-
Node Reference Editor
- Archive - Folder Editor
- Batch Process Step Editor
-
Content Type Editor
- Child Type Editor
- Content Model - Child Content Type Editor
- Content Scope Editor
- Content Type - Parent Type Editor
- Custom Statement - Scope Editor
- Data Action - Action Element Editor
-
Data Action - Source Editor
- Data Action - Source Element Editor
- Data Action - Source Field Editor
-
Data Action - Target Editor
-
Data Action - Target Element Editor
- Concat - Target Collection Editor
- Remove - Target Collection Editor
- Data Action - Target Field Editor
-
Data Action - Target Element Editor
- Data Field Container - Rule Editor
- Data Rule - Scope Editor
- Dispose Batch - Target Folder Editor
- Execute Rule - Rule Editor
- Field Match - Field Editor
- Generate Subsets - Field Editor
- Grid Layout - Header Column Editor
- Piece Info Options - Key Column Editor
- Piece Info Options - Value Column Editor
- Return Value - Field Editor
- Set Field Value - Field Editor
- System Maintenance - Folder Editor
- Table Mapping - Scope Editor
- Task Filter - Batch Editor
- Test Batch Editor
- Text Transform - Scope Editor
- Train Lexicon - Scope Editor
- Virtual Table Definition - Collection Editor
- Web Service - Definition File Editor
-
Ordered Reference Editor
- Generate Control Sheets - Document Types Editor
- Virtual Table Definition - Columns Editor
-
Reference List Editor
- AI Section Reader - Included Descendants Editor
- All Nodes Reference Editor
-
Behavior - Field List Editor
- Field Annotation - Field Annotation Editor
- Bookmark Options - Data Element Editor
- Build Fine Tuning File - Batch Editor
-
Content Types Editor
- Child Types Editor
- Correct - Fields Editor
- Data Fill Method - Included Descendants Editor
- Data Model - Style Sheets Editor
- Data Rule - Required Elements Editor
- Extract - Data Element Filter Editor
- Indexing Behavior - Included Elements Editor
- Lexicon - Lexicons Editor
- Piece Info Options - Element Editor
- Project - Projects Editor
- Redact - Extractors Editor
- Redact - Fields Editor
- Require Value - Required Elements Editor
- Thumbnail View - IP Profiles Editor
- Transaction Detection - Field List Editor
-
Node Reference Editor
- Sample Image Collection - Editor
- Value Extractor - Editor
- Zone Editor
-
Schema Importer
- AI Generated
- CMIS Schema Importer
- Database Schema Importer
- EDI Schema Importer
- XML Schema Importer
-
Section Extract Method
-
AI Section Reader
- AI Collection Reader
- AI Transaction Detection
- Clause Detection
- Divider
- Fixed
- Full Page
- Geometric
- Nested Table
- Simple
- Transaction Detection
-
AI Section Reader
-
Separation Provider
- AI Separate
-
ESP Separator
- ESP Auto Separation
-
Extractor Based Provider
- Change In Value Separator
- EPI Separation
- Pattern-Based Separation
- Multi Separator
-
Real Time Provider
-
Control Sheet Separation
- Event-Based
-
Control Sheet Separation
- Undo Separation
-
Service Instance
- Activity Processing
- API Services
- Import Watcher
- Indexing Service
- System Maintenance Service
- Timer Service
-
Web Service
- Grooper Licensing
-
Storage Type
- Boolean
- Custom
- GUID
-
Storage Type Ranged
- DateTime
-
Storage Type Numeric
- Decimal
- Double
- Int16
- Int32
- Int64
- String
- URL
-
Table Extract Method
- AI Table Reader
- Delimited Extract
- Fixed Width
- Fluid Layout
- Grid Layout
- Row Match
- Tabular Layout
-
Task View
- Data View
- Fiche Strip View
-
Folder View
- Classification View
- Scan View
- Separation View
- Thumbnail View
-
UI Element
-
Control
- Active Task List
- AI Helper
-
Batch Info Tab
- Batch Details Viewer
- Batch Events Viewer
- Batch History Viewer
- Batch Stats Viewer
- Task Chart
- Batch Info Viewer
- Batch List
- Batch Manager
- Candidate List
- Card List
- Chat Console
- Class Help
- CMIS Repository Searcher
- CMIS Tree Browser
- CMIS Type Tree
- Code Editor
- Complete List
-
Content Viewer
- HTML Viewer
- Mail Viewer
- NDJSON Editor
- Null Viewer
- Page Viewer
- Text Editor
- ZIP Viewer
- Context Menu
- Conversation Viewer
- Data Element Tester
- Data Grid
- Data Grid Document
-
Data Grid Element
- Data Grid Collection
- Data Grid Container
- Data Grid Field
- Data Grid Table
- Virtual Table
- Data Inspector
- Data Tree
-
Design Tab
- AI Assistant - Chat History
-
Batch
- Batch - General
- Batch - Viewer
- Batch Folder - General
- Batch Page - General
-
Batch Process
- Batch Process - Batches
- Batch Process - General
-
Batch Process Step
- Batch Process Step - General
-
Batch Process Step - Testing Tab
- Batch Process Step - Activity Tester
- Batch Process Step - Classification Tester
- Batch Process Step - ESP Separation Tester
- Batch Process Step - Recognition Tester
- Batch Process Step - Redaction Tester
- Batch Process Step - XSLT Editor
- CMIS Connection - General
-
CMIS Repository
- CMIS Repository - Browse
- CMIS Repository - Search
- CMIS Repository - Types
-
Content Type
- Content Type - Documents
- Content Type - Labels
- Content Type - Overrides
- Content Type - Training Samples
- Content Type - Weightings
- Control Sheet - General
- Data Connection - General
-
Data Element
- Data Element - General
- Data Element - Tester
- Data Rule - Tester
- Extractor Node - Tester
- Field Class - Weightings
- Folder - Batches
- IP Element Container - Tester
- IP Step - Tester
- Lexicon - General
-
Machines
- Machines - General
- Machines - Services
-
Node
- Node - Advanced
- Node - General
- Node - Reports
- Node - Scripting
- OCR Profile - Tester
- Processing Queue - Workers
- Project - Usage
- Resource File - General
-
Root
- Root - Events
- Root - Licensing
- Root - Scripts
- Training Page - General
- Design Tab Host
- Diagnostics Viewer
- Document Searcher
- Document Viewer
- Expression Grid
- Extractor Builder
- FRX Grid
- FRX Visualizer
- Image Editor
- Image Print Preview
- Image Viewer
- Instance Searcher
- Label Set Editor
- List Searcher
- Lookup Fields
- Lookup Results
- Node Finder
-
Node Report
-
Content Type Report
- Circular Expressions
- Data Elements
- Derived Types
- Expressions
- Property Overrides
- Validation Rules
- Descendants
-
Content Type Report
-
Object List
- Candidate Type List
- CMIS Results List
- Data Row List
- Document List
- Instance Result Set
- Node List
-
Reflection List
- CMIS Object List
- Instance List
- Principal List
- Search Result List
- String List
- Table Info List
- OCR Viewer
- Page Navigator
- Profile Browser
- Property Grid
-
Property Grid Editor
- ACL Editor
- Anchor Editor
- Choice Editor
- CMIS Query Editor
- Code Property Editor
- Collation Editor
- Collection Editor
- Extractor Property Editor
- Folder Editor
- List Editor
- Multi Reference Editor
- OAuth Log-in Editor
- Object Editor
- Ordered Reference Editor
- Preview Image Editor
- Reference Editor
- Sample Image Editor
- Zone Editor
- Property Help
- Query Editor
- Query Helper
- Query List
- Recognition Tester
- Rep Info Panel
-
Review Tab
- Batch Viewer
- Classify Viewer
- Data Viewer
- Scan Viewer
- Separation Viewer
- Thumbnail Viewer
- Search Result Cards
- Separation List
- Service Collection
- Splitter
- Stats Report
- Stats Result Set
- Stats Viewer
- Tab List
- Task List
- Test Source
-
Tree Viewer
- Editor Tree
- Override Tree
- Upload Dialog
- Weightings List
-
Web Page
- Batches Page
- Chat Page
- Design Page
- Help Page
- Home Page
- Imports Page
- Jobs Page
- Review Page
- Search Page
- Stats Page
- Tasks Page
-
Control
-
Value Extractor
-
Ask AI
- AI Column Extractor
-
Barcode Extractor
- Find Barcode
- Read Barcode
- Detect Signature
- Highlight Zone
- Labeled Value
-
OMR Extractor
- Labeled OMR
- Ordered OMR
- Zonal OMR
- Query HTML
- Query XML
- Read Metadata
- Read Zone
- Reference
- Select Page
-
Text Analysis
- Entity Recognition
- Key Phrase Extraction
- Pii Entity Recognition
-
Text Match
- Field Match
-
List Match
- Label Match
- Pattern Match
- Word Match
-
Ask AI
-
Variable Provider
- Alpha Provider
-
Culture Info Provider
- Currency Decimal Digits
- Currency Decimal Separators
- Currency Group Digits
- Currency Group Separators
- Currency Labels
- Currency Symbols
- Day Names
- Day Names Abbreviated
- Day Names Shortest
- Digits
- Letters
- Letters Lower
- Letters Upper
- Month Names
- Month Names Abbreviated
- Month Names Genetive
- Expression Lexicon Provider
- Extractor Variable Provider
- Field Value List Provider
- Field Variable
- Group Vocabulary Provider
- Number Names Provider
- Number Provider
- Referenced Lexicon Provider
- Vocabulary
-
Other Configuration Types
- API Key
- Archive Info
- Border
- Capture Settings
- Character Class Filter
- Chat Parameters
-
CMIS Object
- CMIS Document
- CMIS Folder
-
CMIS Property Definition
- CMIS Boolean Property Definition
- CMIS DateTime Property Definition
- CMIS Decimal Property Definition
- CMIS HTML Property Definition
- CMIS ID Property Definition
- CMIS Integer Property Definition
- CMIS String Property Definition
- CMIS URI Property Definition
- Code39Settings
-
Connected Object
- Batch Filter
- Chat Filter
-
Database Row
- AI Chat
- AI Message
- Doc Index
- File Store Entry
- Import Job
- Index State
-
Index Table
- Batch State
- Log Event
- Processing Job
- Processing Task
- Saved Query
- Session Stats
-
Embedded Object
- AI Chat Filter
- AI Chat Settings
- AI Generator
- Anchor Definition
- Attachment Rule
- Auto Complete Settings
-
Barcode Reader
- 1D Reader
- 2D Reader
- Postcode Reader
- Standard Reader
- Batch Creation Settings
- Batch Name Settings
- Bookmark Options
- Bot Connector
- Chunk Settings
- Cluster Parameters
- CMIS Export Map
- CMIS Folder Reference
- CMIS Import Map
- CMIS Type Definition
-
CMIS Type Reference
- CMIS Compound Type
-
Code Expression
- Boolean Expression
- String Expression
- Column Map
- Command Options
- Computed Field
- Content Mapping
- Custom Statement
-
Data Element Extension
- AI Extract Field Options
- AI Extract Section Options
- AI Extract Table Options
- Grid Layout Options
- Tabular Layout Options
- Data Element Profile
-
Data Fill Method
- AI Extract
- Fill Descendants
- Run Child Extractors
-
Edge Adjustment
- Absolute
- Anchor
- Edge of Page
- Relative
-
Embedded Lexicon
- Field Value Lexicon
- Fuzzy Match Weightings
- List Match Entries
- Environment Options
-
Execute Step
- Execute Activity
- Execute Command
- Expression Set
-
Field Annotation
-
Field Widget Annotation
- Checkbox Widget
- Radio Group Widget
- Signature Widget
- Textbox Widget
- Highlight Annotation
- Text Annotation
-
Field Widget Annotation
- Field Mapping
-
File Reference
- Resource File Reference
- UNC File Reference
- URL File Reference
- Folder Level Info
- FRX Options
- FTP Repository Configuration
- Fuzzy Lookup Options
- Horizontal Tab Marker
-
HTTP Auth Method
- Basic
- OAuth Client Credentials
- HTTP Resource
- Hyperlink Selector
- Image Segmentation Options
-
Import Schedule
- Polling Loop
- Specific Times
- Index Stats
- Label Info
- Label Set
- Label Version
-
Layout Provider
- Flow
- Horizontal
- Vertical
- Line Periodicity Detector
-
LLM Provider
- Azure Provider
- GCS Provider
- Open AI Provider
-
Lucene Query
- Lucene Group
- Lucene Phrase
- Lucene Word
- Metadata Options
- Multiline Row Settings
- OCR Layer
-
OCR Repair Options
- Spell Corrector
- OMR Box
- Page Attachment Rule
- Paragraph Marker
- Path Expression
-
PDF Expand Method
- Bookmarks
- Fixed Page Count
- Page Piece
- Tag Based
- Permission Set
- Piece Info Options
-
Quoting Method
- Data Values
- Extracted
- Labeled Region
- Layout Objects
- Semantic
-
Region Definition
-
Dynamic Region
- Shape Region
- Text Region
-
Fixed Region
- Relative Region
-
Dynamic Region
- Repository Configuration
-
Repository Option
- AI Search
- LLM Connector
- Text Analysis Option
-
Resource Reference
- Bing Search
- Database Table
- Search Index
- Web Service
- Result Filter
-
Result Processor
- OCR Reader
- OMR Reader
- Place Zone
- Result Set Options
- Return Value
- Route Definition
- Sample Image Collection
- Schema Mapping
-
Search Filter
- Boolean Filter
-
Field Filter
- Comparison Filter
- In Filter
- Is Match Filter
- Lambda Filter
-
Separate Action
-
Separation Event
- Barcode Detected
- Blank Page Detected
- Content Type Detected
- Page Count
- Shape Detected
-
Separation Event
-
Service Deployment
- Chat Service
- Embeddings Service
- Fine Tuning Service
- Service Stats
- Stats Query
- Subset Filter
- Table Header Detector
- Table Mapping
- Table Row Detector
- Text Preprocessor
- Type Permissions
-
Value Lookup
- Group Options
- Value Selector
- Variable Definition
- Vector Search Options
- Vertical Tab Marker
- Virtual Table Definition
- XML Value Selector
- Node Query
- Purge Folder
- Search Index Query
-
Task Filter
- Attended Task Filter
- Unattended Task Filter
- Constrained Wrap Options
- Culture Data
- Dash Detector
-
Database Connection Settings
- ODBC
-
SQL Server
- Repository Connection
-
Defect Generator
- Border Generator
- Image Scaler
- Image Skewer
- Image Translator
- Noise Generator
- Double Range
-
Dropout Method
- Fill
- Inpaint
- Event Filter
- Fiche Card Layout
- Folder Level Options
- Horizontal Alignment Settings
-
HTTP Authentication Method
- Anonymous Authentication
- Auto Authentication
- Basic Authentication
- NTLM Authentication
-
OAuth Authentication
-
Azure OAuth
- Exchange OAuth
- OneDrive OAuth
- SharePoint OAuth
-
Azure OAuth
- OAuth Service Login
-
Image Compression
- JPEG
- JPEG 2000
- Image Info
- Integer Range
-
Line Snap Options
- Result Snap Options
- Margin Detector
- Multi Line Settings
- Node Information
- PDF Burst Settings
- PDF Page Generator
- PDF Render Settings
- Percent Range
- Rectangle
- Region Detector
-
Regular Expression
- Attribute Rule
- Wrap Rule
- Remote Repository
- Row Alignment Settings
- Scan Once Settings
- Semantic Quoting Query
- SFTP Repository Configuration
- Shell Execute Info
- Sort Specification
- System Config
- Text Wrap Options
- TIFF Page
- Transaction Layout Detection
- Vertical Wrap Detection
-
Advanced Topics
- CSS Builder
- Data Model Compiler
- Data Model Expression Builder
- Expression Builder
- Fuzzy Regular Expression
- Layout Data
- Real Time Image Processor
- Retrieval Plan
- Single - Fuzzy Match Cost Map
- Task Processor
-
Enumerations
-
Grooper
- CharacterCasing
- ConcurrencyMode
- DatabaseStatus
- DCTModes
- EventType
- NodeAttributes
- Pages
- PixelFormat
- ProcessingScope
- ProcessingStatus
- ResultOrder
- SimplePixelFormat
-
Grooper.Activities
- ActionType
- BatchDisposition
- BatchNameSuffixEnum
- BodyRenderingMethod
- ComparisonMode
- DuplicateDisposition
- ExecuteType
- ExecutionScope
- ExtractMode
- FilterType
- MatchActions
- OcrAssistMode
- PageExtractMode
- ProblemDisposition
- ReclassifyModes
- RepairScope
- SaveDisposition
- SharedBehaviorModes
- SpawnMethod
- StatsLoggingMode
- TextExtractMode
- TrainingScope
- XmlSource
- XmlTarget
-
Grooper.Capture
- FeedOrientation
- ImportType
- MissDispositionEnum
- PageDirection
- ScanningSpeed
- TwainCompressionModes
-
Grooper.Capture.ColorTrac
- ColorFormat
- PageSizeMode
- PaperEndCondition
- PaperJustification
- ScanSpeed
- StandardPageSize
-
Grooper.Cloud
- ApiRegionEnum
- ContentLayout
- HttpVerbs
- MessageFormats
- MetadataModes
- TranslateDisposition
-
Grooper.CMIS
- AuthenticationProvider
- CmisProtocol
- ImportModes
- LoadScope
- NamingMethods
- OrderByDirection
- TransferScopes
-
Grooper.Core
- ActivateModes
- ArrayActions
- AttachmentPosition
- BrowserSuggestMode
- CalculateModes
- CalculateModes
- CaptureScope
- ClassificationLevel
- CompareMode
- ConflictDispositions
- ConflictResolution
- ControlCharacters
- CreateModes
- DedupMode
- DispositionType
- DuplicateFilenameResolution
- FolderRelativePosition
- FolderRelativePosition
- FooterModes
- FormatOptions
- FuzzyMatchMode
- GroupingColumn
- IdfModes
- IssueDisposition
- JsonLayout
- LexiconType
- MissDispositions
- MissDispositions
- NumberFormats
- OxiElement
- PaginationType
- ParagraphOptions
- PdfBuildOptions
- PopulationMethod
- ProcessingLevel
- PropagationMode
- SegmentType
- SortColumns
- SortDirection
- SortDirections
- SortDirections
- SortOption
- SortOrder
- TabOptions
- TaskScope
- TfModes
- TimeFrames
- TimeGrouping
- TrainingScopes
- TriggerModes
- TypeKind
- TypeModes
- TypeOperation
- UserTrainingMode
- ValueInterpretations
- ZIPDispositions
-
Grooper.EDI
- AttachmentNamingMethods
- DataDisposition
- NamingMethods
- NamingMethods
-
Grooper.Extract
- AdjustmentMethod
- AlignmentMode
- CollationType
- CombineType
- CompassDirection
- ConfidenceModes
- ContextScopes
- CultureScopes
- ExecutionScope
- FlowDirection
- GroupingType
- HorizontalDataAlignment
- HorizontalDataAlignment
- LabelLayout
- LookupOption
- MappingType
- OmrBoxDirection
- OmrFlowDirection
- OmrMode
- OutputValueOptions
- ReadDirection
- ReadMethods
- ReferencePointPosition
- ROIModes
- RowDetectionMode
- RowMatchOptions
- SecondaryExtractMethod
- SecondaryExtractTrigger
- SplitPositionEnum
- TableRowAlignment
- TableStyles
- VerticalDataAlignment
- WordTransform
-
Grooper.GPT
- AuthorizationMethod
- BooleanOperator
- BuiltInFieldKinds
- DocumentLinkingOptions
- FieldAlignMode
- IndexOperations
- LambdaFunction
- OperationType
- QueryTypes
- ResultOrder
- RetrievalOptions
- RowAlignMode
- SearchModes
- SectionAlignMode
-
Grooper.IP
- AdaptiveKernelType
- AngleCategory
- Axis
- BinarizationMethod
- ChannelNumber
- Code39Options
- ColorSpaceType
- CombDetectionType
- CompressionMode
- Connectivity
- CropMethod
- CurveType
- DetectMethod
- FeatureType
- FillMethod
- FilteringLevel
- FilterTypeEnum
- HarrisFilterType
- HoughLevel
- ImageEdges
- InpaintMethod
- MaskShape
- MaskSize
- MeasurementType
- Method
- OneDimSymbology
- OperationType
- OperationType
- Pdf417Options
- PostSymbology
- ProcessingResolution
- ProgressionOrder
- ReadDirection
- ReadingQuality
- ResizeInterpolationMode
- SizeMethod
- Symbology
- TwoDimSymbology
- WarpInterpolationMode
-
Grooper.Messaging
- BodyHandling
- Orientation
- PaperKind
- SaveAction
- SelectorKind
-
Grooper.OCR
- AccuracyLevels
- BaseCharacterSetEnum
- DetectionMethod
- EngineModeEnum
- FontPitchMode
- LexMode
- PageOrientation
- PageOrientation
- SegmentationModeEnum
- SynthesisMethodEnum
-
Grooper.Office
- SaveMethod
-
Grooper.PDF
- CompressionMode
- ImageLayout
- PDFAComplianceLevels
- PdfBorderStyle
- PdfDisplayMode
- PdfPermissions
- PdfViewerOptions
- SearchableTextFormat
- TargetColorFormat
-
Grooper.Services
- DaysOfWeek
-
Grooper.Services.CMIS
- ConnectMethod
- ContentMode
- FileType
- FormOverlayType
- MergeAction
-
Miscellaneous
- BaseTypeId
- CharacterCasing
- CompressionLevel
- ContentAlignment
- DateTimeStyles
- FileAttributes
- FontStyle
- Formatting
- HorizontalAlignment
- Keys
- NumberStyles
- RegexOptions
- ThreadPriority
- UriKind
-
Grooper
Retrieval Plan
Defines a plan for retrieving external information before an AI Assistant generates a response to a user inquiry.
Remarks
A Retrieval Plan orchestrates how an AI Assistant gathers supporting information from external resources—such as Search Indexes, Database Tables, Web Services, or Bing Search—to enhance the accuracy, context, and reliability of its responses.
Retrieval-Augmented Generation (RAG) is a technique that empowers the assistant to supplement its generative capabilities with up-to-date, domain-specific, or authoritative data. The Retrieval Plan is the mechanism by which the assistant determines which retrieval tools to invoke, in what order, and with what criteria, before composing a final answer for the user.
How Retrieval Plans Work
When a user submits a question, the AI Assistant evaluates the conversation context and available Resource References (Search Index, Database Table, Web Service, Bing Search) to determine if additional information is needed. If so, it generates a Retrieval Plan that specifies:
- Which retrieval tools to use: Each tool corresponds to a specific resource type (e.g., semantic search, SQL query, web API call).
- What information to retrieve: The plan describes the data or documents needed to answer the user's question.
- How to retrieve it: Criteria such as search queries, filters, or parameters are included for each tool.
- Chained retrievals: If multiple steps are required (e.g., first retrieve a list, then fetch details), the plan can specify additional instructions for subsequent retrievals.
The plan is executed before the assistant generates its response, ensuring that answers are informed by the most relevant and current data available.
Retrieval Plans are generated automatically by the AI Assistant during chat sessions. End users do not configure plans directly; instead, they configure Resource References and retrieval options on the assistant. The plan is created in response to each user inquiry, based on the conversation context and available resources.
The plan is visible in diagnostic logs and may be surfaced in the user interface for transparency or troubleshooting.
Supported Resource Types
The AI Assistant can be configured with a variety of resource types, each enabling different retrieval capabilities. These resources are added to the assistant's 'Resources' property and are referenced in Retrieval Plans as needed:
- Search Index Reference: Enables semantic (vector) and keyword-based search over indexed document collections. Use for question answering, document lookup, and knowledge discovery.
- Table Reference: Exposes a database table for direct querying. Use for structured data retrieval, reporting, and analytics.
- Web Service Reference: Connects to external APIs described by RAML definitions. Use for dynamic data retrieval, integration, or automation via web services.
- Bing Search Reference: Provides real-time web search using Bing. Use for fact-checking, accessing current events, or augmenting knowledge with internet sources.
Each resource type is configured independently and can be combined to create a comprehensive retrieval strategy tailored to your business needs.
Multi-Hop Retrieval
Some user questions require synthesizing information from multiple sources or performing a sequence of dependent retrievals. This is known as multi-hop retrieval. In Grooper, multi-hop retrieval allows the AI Assistant to chain together several retrieval operations, where the output of one step informs the next.
The maximum number of retrieval steps (or "hops") is controlled by the 'Max Retrieval Depth' property on the AI Assistant.
For example, setting this value to 1
restricts the assistant to a single retrieval operation per inquiry, while higher values
(up to 8) enable more sophisticated, multi-step plans.
How Multi-Hop Retrieval Works:
- The Retrieval Plan may include a
nextStep
property with instructions for additional retrievals. - After each retrieval, the plan is re-evaluated to determine if further steps are needed.
- This process continues until the maximum depth is reached or no further retrievals are required.
Example Multi-Hop Scenario:
- User asks: "List all customers who purchased product X last quarter and show their most recent order status."
- The first retrieval step queries the Database Table for customers who purchased product X.
- The next step retrieves the latest order status for each customer found in the previous step.
- The assistant combines the results and generates a comprehensive response.
Multi-hop retrieval is essential for answering complex, multi-part questions and for scenarios where information must be correlated across different resources.
Diagnostic Artifacts
When a Retrieval Plan is generated, the following diagnostic artifacts may be logged:
- Retrieval Plan Schema: The JSON schema describing the structure of the plan.
- Retrieval Plan Conversation: The full conversation between the assistant and the planning model, including all instructions and responses.
These artifacts are useful for auditing, troubleshooting, and refining retrieval strategies.
Example Workflow
- User asks: "What is the latest status of order 12345?"
- The AI Assistant generates a Retrieval Plan that includes:
- A SQL query tool targeting the 'Orders' Database Table to retrieve the status.
- A brief description: "Query the Orders table for order 12345 and return the current status."
- The plan is executed, results are retrieved, and the assistant composes a response using the fresh data.
Configuring Custom Retrieval Instructions
The behavior of Retrieval Plans can be tailored by providing custom retrieval instructions on the AI Assistant. These instructions guide how the assistant selects, prioritizes, and interacts with knowledge resources when formulating a plan.
Custom instructions are set using the 'Retrieval Instructions' property on the AI Assistant. This property allows you to:
- Specify preferred search strategies (e.g., "Always check search indexes before querying database tables").
- Set thresholds and limits, such as the maximum number of results or retrieval depth.
- Indicate when to prompt the user for clarification.
- Define rules for combining or ranking results from multiple resources.
Example Custom Retrieval Instructions:
For policy-related questions, search the 'Policies' search index first. If no relevant results are found, check the 'Procedures' index.
Limit database queries to 10 results unless the user specifies a different amount.
If a user's question could apply to multiple resources, ask which resource they want to use before proceeding.
Best Practices:
- Keep instructions concise and focused on actionable guidance.
- Update instructions as your data sources or business needs evolve.
- Test the assistant's behavior with a variety of queries to ensure the retrieval plan aligns with your intent.
By configuring custom retrieval instructions, you can ensure that the AI Assistant generates Retrieval Plans that align with your business rules, compliance requirements, and user expectations, resulting in more accurate and context-aware responses.