AIFilter
AI-powered filter feature for Grid. Allows users to type natural language queries to filter grid data.
Setup requires:
- A promptUrl to which to send the prompt (typically your own backend service, which in turn forwards to an AI service)
- An AIFilterField to input the prompt
- A configured apiPlugin to modify the prompt and process the response according to the API you are using (currently available: OpenAIPlugin, GooglePlugin and AnthropicPlugin)
- Describe your model fields with the description property on data fields.
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
Configs
39Other
The text to show in the toast when the text input did not result in any filter being applied
apiPluginAIBase
availableApisAIBase
chatButtonAIBase
debugModeAIBase
delayStatusTextsAIBase
feedbackUrlAIBase
fetchOptionsAIBase
highlightRelatedItemsAIBase
manageChatHistoryAIBase
max_tokensAIBase
modelAIBase
modelsAIBase
promptUrlAIBase
redoAIBase
showNoConnectionIconAIBase
temperatureAIBase
textToSpeechUrlAIBase
timeoutAIBase
toolsAIBase
trainingDataAIBase
transcribeUrlAIBase
undoAIBase
userSettingsAIBase
verbosityLevelAIBase
voiceActivationAIBase
voiceOnlyAIBase
Misc
bubbleEventsEvents
callOnFunctionsEvents
clientInstancePlugin
localeClassLocalizable
localizableLocalizable
localizablePropertiesLocalizable
Properties
16
Properties
16Common
disabledInstancePlugin
Class hierarchy
Identifies an object as an instance of AIFilter class, or subclass thereof.
Identifies an object as an instance of AIFilter class, or subclass thereof.
isAIBaseAIBase
isEventsEvents
isInstancePluginInstancePlugin
isLocalizableLocalizable
Other
Functions
28
Functions
28Configuration
Events
detachListenersBase
Misc
animatePropertyBase
callbackBase
doDisableInstancePlugin
downloadTestCaseBase
resolveCallbackBase
updateLocalizationLocalizable
Other
addListenerEvents
hasListenerEvents
onEvents
relayAllEvents
removeAllListenersEvents
removeListenerEvents
resumeEventsEvents
suspendEventsEvents
triggerEvents
unEvents
Events
6
Events
6beforeDestroyEvents
catchAllEvents
destroyEvents
disableInstancePlugin
enableInstancePlugin
userSettingsUpdateAIBase
Event handlers
6
Event handlers
6onBeforeDestroyEvents
onCatchAllEvents
onDestroyEvents
onDisableInstancePlugin
onEnableInstancePlugin
onUserSettingsUpdateAIBase
Typedefs
7
Typedefs
7AIModelConfigurationAIBase
AIModelSelectorAIBase
AIToolConfigAIBase
AIToolPropertyAIBase
AIVoiceActivationConfigAIBase
BryntumListenerConfigEvents