- Overview
- Help Status
-
Activity
- Attended Activity
-
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
-
Article
- AI Assistants
- AI Powered Features
- Batch Processing Workflows
- Document Scanning
- PDF Processing
- Search Overview
- Attachment Type
- Behavior
- Capture Device
- Classify Method
- CMIS Binding
- CMISQL Element
- Collation Provider
-
Command
- Action List - Create Copy Actions
- AI Chat
- Attachment Type
- Batch
-
Batch Folder
- Batch Folder - Add To Index
- Batch Folder - Assign Document Type
- Batch Folder - Classify Command
- 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 Page
- Batch Process
- CMIS Connection
- CMIS Document Link
- CMIS Export Map - Auto Map
- CMIS Folder Link
- 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
- Convert Data - Create Convert Actions
- Copy Base
- Data Connection
- Data Element - Remove Overrides
- Data Field Container
- Data Type - Convert To Value Reader
- EDI File
- Excel Document - Convert to CSV
- Exchange - Rebuild Search Folder
- Field Class - Purge Training
- File Store
- File System Link
- Folder - Remove Empty Subfolders
- FTP Link
- HTML Document
- HTTP Link
- JSON File
- Lexicon
- Machine - Tune File System
- Mail Link
- Mail Message
- Node
- OAuth Client Credentials - Test
- Object Library
- PDF Document
- Project - Remove Empty Subfolders
- PST File - Burst
- PST Link - Load Content
- Resource File
- Root
- Saved Query
- Search Index - Generate Subsets
- SFTP Link
- Text Document
- Value Reader - Convert To Data Type
- vCard - Expand Photo
- Word Document - Convert to PDF
- XML File
- ZIP Archive
- ZIP Link - Load Content
- Content Link
- Data Action
- Data Instance
- Export Definition
- Export Format
- Grooper Command Console (GCC)
- Import Definition
- Import Provider
-
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
- Blank Page Detection
- Border Detect
- Box Detection
- 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
- Filter
- Gamma Adjust
- Histogram
- Hough Lines
- Invert
- Line Detection
- 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
- Measurement
-
Node
- AI Assistant
- Batch Object
- Batch Process
- Batch Process Step
- CMIS Connection
- CMIS Repository
- Content Type
- Control Sheet
- Data Connection
- Data Element
- Data Rule
- Extractor Node
- File Store
- Folder
- IP Element
- Lexicon
- Machine
- Object Library
- OCR Profile
- Project
- Resource File
- Root
- Scanner Profile
- Separation Profile
- Training Page
- Work Queue
- OCR Engine
-
Property Converter
- Auto Deskew - Precision Converter
- Base Multi Culture Converter
- Blank Zero Converter
- Check List Converter
- CMIS Export Map - Column Converter
- CMIS Folder Reference - Converter
- CMIS Import Map - Field Converter
- CMIS Object - Choice Converter
- Code Expression - Converter
- Collection Converter
- Column Map - Column Converter
- Content Type - Unlimited Converter
- Degrees Converter
- Execute Command - Link Name Converter
-
Expandable Converter
- Base 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 - Extended Property Name 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 Size - Logical Size Converter
- 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
- JPEG 2000 - Ratio Converter
- Logical Value - Simple Value Converter
- Logical Value - Universal Value Converter
- Node Information - Value Converter
- Page Filter Converter
- Path Expression - Converter
- Percent Converter
- Pg Dictionary Converter
- Pg Flags Converter
- Pg Ref Collection Converter
- Pg String Collection Converter
- Pg Type Display Name 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
-
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
- Rebuild Indexes - Table Names Editor
- Reset - Step Checklist Editor
- Stats Query - Name List 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
-
Code Property Editor
- AI Chat Filter - Filter Editor
- AI Schema Extractor - Schema Editor
- Ask AI - Schema 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 Rule - Trigger Editor
- Data Section - Caption Editor
- Expression Set - Default Value Editor
- Expression Set - Field Expression 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
- Json Property Editor
- KVP Editor
- Lexicon - Lexicon Link Code Editor
- List Match - Local Entries Editor
- Mail Import - IMAP Query Editor
- Pattern Match - Output Format Editor
- Regex Property 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
- 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
- LDAP - ACL Editor
- OAuth Authentication - Login Editor
- Object Collection Editor
- Object Properties Editor
- Open File Editor
-
Reference Editor Base
-
Node Reference Editor
- Archive - Folder Editor
- Batch Process Step Editor
- Content Type Editor
- Custom Statement - Scope Editor
- Data Action - Action Element Editor
- Data Action - Source Editor
- Data Action - Target Editor
- Data Field Container - Rule Editor
- Data Rule - Scope Editor
- Database Cleanup - Folder 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
- 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
-
Reference List Editor
- All Nodes Reference Editor
- Behavior - Field List Editor
- Bookmark Options - Data Element Editor
- Build Fine Tuning File - Batch Editor
- Content Types Editor
- Correct - Fields Editor
- Data Fill Method - Included Descendants Editor
- Data Model - Style Sheets Editor
- Data Rule - Required Elements Editor
- Data Values - Included Elements Editor
- Extract - Data Element Filter Editor
- Indexing Behavior - Included Elements Editor
- JSON Data Mapping - 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
- Section Extract Method - Included Descendants 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
- Section Extract Method
- Separation Provider
- Service Instance
- Storage Type
- Table Extract Method
- Task View
-
UI Element
-
Control
- Active Task List
- AI Helper
- Batch Info Tab
- 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
- Context Menu
- Conversation Viewer
- Data Element Tester
- Data Grid
- Data Grid Document
- Data Grid Element
- Data Inspector
- Data Tree
-
Design Tab
- AI Assistant - Chat History
- Batch
- Batch Folder - General
- Batch Page - General
- Batch Process
- Batch Process Step
- CMIS Connection - General
- CMIS Repository
- Content Type
- Control Sheet - General
- Data Connection - General
- Data Element
- Data Rule - Tester
- Extractor Node - Tester
- Field Class - Weightings
- Folder - Batches
- IP Element Container - Tester
- IP Step - Tester
- Lexicon - General
- Machines
- Node
- OCR Profile - Tester
- Processing Queue - Workers
- Project - Usage
- Resource File - General
- Root
- 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
- Object 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
- Search Result Cards
- Separation List
- Service Collection
- Splitter
- Stats Report
- Stats Result Set
- Stats Viewer
- Tab List
- Task List
- Test Source
- Tree Viewer
- Upload Dialog
- Weightings List
- Web Page
-
Control
- Value Extractor
- Variable Provider
-
Other Configuration Types
- API Key
- Archive Info
- Border
- Capture Settings
- Character Class Filter
- Chat Parameters
- CMIS Object
- CMIS Property Definition
- Code39Settings
-
Connected Object
- Batch Filter
- Chat Filter
- Database Row
-
Embedded Object
- AI Chat Filter
- AI Chat Settings
- AI Generator
- Anchor Definition
- Attachment Rule
- Auto Complete Settings
- Barcode Reader
- Batch Creation Settings
- Batch Name Settings
- Bookmark Options
- Bot Connector
- Boundary Detector
- Chunk Settings
- Cluster Parameters
- CMIS Export Map
- CMIS Folder Reference
- CMIS Import Map
- CMIS Type Definition
- CMIS Type Reference
- Code Expression
- Column Map
- Command Options
- Computed Field
- Content Mapping
- Custom Statement
- Data Element Extension
- Data Element Profile
- Data Fill Method
- Data Generator
- Edge Adjustment
- Embedded Lexicon
- Environment Options
- Execute Step
- Expression Set
- Field Annotation
- Field Mapping
- File Reference
- Folder Level Info
- FRX Options
- FTP Repository Configuration
- Fuzzy Lookup Options
- Horizontal Tab Marker
- HTTP Auth Method
- HTTP Resource
- Hyperlink Selector
- Image Segmentation Options
- Import Schedule
- Index Stats
- Label Info
- Label Set
- Label Version
- Layout Provider
- Line Periodicity Detector
- LLM Provider
- Lucene Query
- Metadata Options
- Multiline Row Settings
- OCR Layer
- OCR Repair Options
- OMR Box
- Page Attachment Rule
- Paragraph Marker
- Path Expression
- PDF Expand Method
- Permission Set
- Piece Info Options
- Quoting Method
- Region Definition
- Repository Configuration
- Repository Option
- Resource Reference
- Result Filter
- Result Processor
- Result Set Options
- Return Value
- Route Definition
- Sample Image Collection
- Schema Mapping
- Search Filter
- Separate Action
- Service Deployment
- Service Stats
- Stats Query
- Subset Filter
- Table Header Detector
- Table Mapping
- Table Row Detector
- Text Preprocessor
- Transaction Extractor
- Type Permissions
- Value Lookup
- 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
- Constrained Wrap Options
- Culture Data
- Dash Detector
- Database Connection Settings
- Defect Generator
- Double Range
- Dropout Method
- Event Filter
- Fiche Card Layout
- Folder Level Options
- Horizontal Alignment Settings
- HTTP Authentication Method
- Image Compression
- Image Info
- Integer Range
- Line 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
- 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
-
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
- RouteMethod
- 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
- MergeModes
- MissDispositions
- MissDispositions
- NumberFormats
- OxiElement
- PaginationType
- ParagraphOptions
- PdfBuildOptions
- PopulationMethod
- ProcessingLevel
- PropagationMode
- SegmentType
- SortColumns
- SortDirection
- SortDirections
- SortDirections
- SortOption
- SortOrder
- StandardWeightings
- 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
- LayoutComponentTypes
- OperationType
- QueryTypes
- ReasoningEffortLevels
- ResultOrder
- RetrievalOptions
- RowAlignMode
- SearchModes
- SectionAlignMode
- ServiceTiers
- VerbosityLevels
-
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
nextStepproperty 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.
