AIChatUserMessageData

Additional parameters for the message. This data is stored together with the message and can influence how the message is processed or displayed.

You can pass following properties to alter how the message behaves:

• displayedPrompt: string - If set, will be displayed instead of the actual message. You can use it to display a shorter, or a friendlier user message. This is also respected in the conversation history. Original message will still be used to query the AI model.

Besides supported properties, attributes can be used to save any additional metadata with the message, which can be used by your integration in any way. Data passed in attributes will be saved in the conversation history. If your integration connects external custom AI tools, attributes are passed to the tool calls and can be used by these tools.

Additionally, other official features that interact with the AI chat feature may introduce their own attributes.

The query that the user provided for the message. Displayed in the chat feed as the user's message.