Skip to main content

Using AI Assistants in Component Pages

After using AI Assistant in component pages, an AI dialog box will be displayed on the right side of the page. The page can also subscribe to AI Assistant events to enable interaction between the page and AI, as well as collaboration between users and AI.

Enabling AI Assistant​

Follow these steps:

Component Page - Bind AI Assistant

Turn on the AI Assistant switch at the top of the page editor and select an AI assistant.

AI Assistant Configuration​

After enabling the AI Assistant, an AI Assistant configuration panel will be displayed on the right side of the page editor with the following configuration options:

  • AI Assistant: Switch the AI assistant used in the page
  • Welcome Message and Opening: Set personalized welcome message and opening
  • Input Parameters: If the assistant being used has custom input parameters configured, these parameters need to be assigned values.
  • Output Runtime Logs: Customize the runtime log content output by the assistant during runtime.

Component Page - Bind AI Assistant

AI Assistant Event Subscription​

Subscribe to Node Running Events​

After enabling triggerable workspace events for nodes in the assistant, there will be two events: When Node is Reached and After Node Completion. The page subscription method is as follows:

AI Assistant - Workspace Event Subscription

In the event handling logic, you can use the parameters output by the event:

AI Assistant - Workspace Event Subscription

Subscribe to Tool Call Events​

After enabling tool call events for AI Agent nodes in the assistant, there will be two events: Before Tool Call and After Tool Call. The page subscription method is as follows:

AI Assistant - Tool Call Event Subscription

Currently, output parameters of tool call events cannot be used in visual tools and need to be used by developers through code writing in source code mode. The usage method is as follows:

this.subscribeEvent("AI:aiagents.ClientManagementagent.callTool.preEvent", async ({ data}) => {
    // AI: Fixed prefix for AI assistant events; aiagents.ClientManagementagent: Node ID in the assistant; callTool.preEvent: Before tool call event, callTool.postEvent: After tool call event
    // data: Parameters carried by this tool event
    if(data.toolName.value === "services.ASvc.func1"){
        //TODO: If tool name is xxxx, do something 
    }
});

Subscribe to Chat Area Human-Machine Interaction Node Events​

Pages can subscribe to chat area human-machine interaction node events. The subscription method is as follows:

AI Assistant - Chat Area Human-Machine Interaction Event Subscription

Subscribe to Workspace Human-Machine Interaction Node Events​

Pages can subscribe to workspace human-machine interaction node events. The subscription method is as follows:

AI Assistant - Workspace Human-Machine Interaction Event Subscription

Send AI Messages in Pages​

After using AI Assistant in a page, there will be a Send AI Message function on the page. The calling method is as follows:

AI Assistant - Send AI Message

For function parameters, see Send AI Message Function

Direct Call to AI Assistant​

Additionally, pages support directly calling AI Assistant without enabling it. The AI Assistant provides a Run method that can be called directly. The calling method is as follows:

AI Assistant - Send AI Message

This method can also be called in service/model function logic.