AI

Feature

Experimental

This feature provides an AI agent for the Scheduler and SchedulerPro. It provides a chat panel that allows the user to send messages to the agent and see the responses. Which allows the user to use natural language to interact with the Scheduler in different ways. For example, the user can ask the agent to filter the data, sort it, or select specific records. The agent can also perform data manipulation operations such as adding, updating, deleting records.

To use this feature, you need to provide a promptUrl to which the agent will send the prompts. On the other end of this URL, there should be a service that adds credentials to the request and forwards the prompt to the LLM API of your choice.

You also need to configure a apiPlugin which ensures the prompt format matches the API you are using.

new Scheduler({
  features : {
     ai : {
        promptUrl : '/ai/prompt',
        apiPlugin : OpenAIPlugin,
     }
  }
})

This is the minimum configuration required to get started, but you may also want to configure the following:

• model - Adds a model property to the prompt sent to the LLM API which is often required
• chatButton - Change the appearance of the chat button and the chat panel
• tools - Add custom tools to the agent's tool list, or remove existing unwanted tools
• userSettings - Provide the current user's settings
• userSettingsUpdate - To listen for changes to the user's settings and save them

And for voice input/output, check out:

• textToSpeechUrl - To enable read aloud responses
• transcribeUrl - To enable voice input
• voiceActivation - Listens for voice commands which start a voice conversation with the agent

But these are not all configurations available. Check out the demo linked in the right panel for a full configuration example. And make sure to read this documentation to learn more about all available configurations.

This feature is disabled by default.

See also

• AI - Base AI feature
• Scheduler - Scheduler widget