AIFilter

AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.

Setup requires:

Example usage:

new Grid({
   features : {
     aiFilter : {
         promptUrl : '/ai/prompt',
         apiPlugin : OpenAIPlugin,
         model : 'gpt-4-1',
     }
   },
   tbar : [{
         type        : 'aifilterfield',
         width       : 400,
         placeholder : 'Ask AI to filter…'
   }],
   store : {
     fields : [
         { name : 'name', type : 'string', description : 'The name of the person' },
         { name : 'age', type : 'number', description : 'The age of the person' },
         { name : 'country', type : 'string', description : 'The country the person lives in' }
     ]
   }
})

This feature is disabled by default

Configs

39

Common

disabledInstancePlugin
listenersEvents

Other

unsuccessfulFilterMessage: String= L{unsuccessfulFilterMessage}

The text to show in the toast when the text input did not result in any filter being applied

apiPluginAIBase
debugModeAIBase
modelAIBase
modelsAIBase
promptUrlAIBase
redoAIBase
timeoutAIBase
toolsAIBase
undoAIBase
voiceOnlyAIBase

Misc

clientInstancePlugin
localeClassLocalizable
localizableLocalizable

Properties

16

Common

disabledInstancePlugin

Class hierarchy

isAIFilter: Boolean= truereadonly
Identifies an object as an instance of AIFilter class, or subclass thereof.
isAIFilter: Boolean= truereadonlystatic
Identifies an object as an instance of AIFilter class, or subclass thereof.
isAIBaseAIBase
isEventsEvents
isInstancePluginInstancePlugin
isLocalizableLocalizable

Lifecycle

configBase

Misc

clientInstancePlugin
localeHelperLocalizable
localeManagerLocalizable

Other

Functions

28

Configuration

applyDefaultsstaticBase

Events

Lifecycle

destroystaticBase

Misc

doDisableInstancePlugin
initClassstaticBase
isOfTypeNamestaticBase
mixinstaticBase
optionalLstaticLocalizable

Other

LstaticLocalizable
onEvents
relayAllEvents
triggerEvents
unEvents

Events

6
catchAllEvents
destroyEvents
disableInstancePlugin
enableInstancePlugin

Event handlers

6
onDestroyEvents
onDisableInstancePlugin
onEnableInstancePlugin

Typedefs

7