@luzmo/analytics-components-kit 1.0.9-beta.11 → 1.0.9-beta.12

package/types/ai-chat.types.d.ts

@@ -8,9 +8,12 @@ export type AssistantMessageActionConfirmVariant = 'primary' | 'secondary' | 'ne
 export interface AssistantMessageAction {
     /** Unique action identifier handled by the host application. */
     id: string;
-    /** Button label shown in the assistant message actions footer. */
+    /** Button label shown in the assistant message actions footer, or the accessible name and tooltip of an icon-only action. */
     label: string;
-    /** Optional Lucero icon shown before the label. */
+    /**
+     * Optional Lucero icon. With an icon the action renders as a quiet icon-only button whose accessible name and tooltip
+     * are `label`. When omitted, `undo` falls back to a rotate-left icon and any other action shows its `label` as text.
+     */
     icon?: IconDefinition;
     /** When true, the action button is not clickable. */
     disabled?: boolean;
@@ -28,8 +31,23 @@ export interface ChatMessageElicitation {
     /** The chosen option, once answered. */
     answer?: string;
 }
+/** Thumbs rating on an assistant message: `1` up, `-1` down, `0` no rating. */
+export type AssistantMessageFeedbackRating = -1 | 0 | 1;
 export interface ChatMessage {
+    /** Local message id generated by the chat. Not a backend identifier. */
     id?: string;
+    /**
+     * Backend message id, when the stream supplied one.
+     *
+     * For assistant replies from the modern `/aiprompt` stream this is the explicit `assistant_message_id`, set from
+     * the first chunk that carries it. Streams without that field (legacy or custom) keep the previous behaviour: chart
+     * replies take the chunk's camelCase `messageId`, which the deprecated backend uses for the persisted *user*
+     * message, so it is not an assistant id and must not be used as a feedback target. A legacy `messageId` never
+     * overwrites a modern id, and the local `id` is never used as a fallback.
+     *
+     * The id arrives before the reply completes, so it does not prove the reply was persisted; check the
+     * error/cancel state before relying on it.
+     */
     apiMessageId?: string;
     type: 'user' | 'ai';
     message: string;
@@ -46,12 +64,31 @@ export interface ChatMessage {
     actions?: AssistantMessageAction[];
     /** Clarifying question on an assistant message, rendered as a question box. */
     elicitation?: ChatMessageElicitation;
+    /**
+     * Selected thumbs rating on an assistant message. Omitted behaves as `0`.
+     * Seed it to restore a saved rating; update it with `AiChatSession.setMessageFeedback`.
+     */
+    feedback?: AssistantMessageFeedbackRating;
+    /**
+     * Hides this assistant message's feedback controls while `show-assistant-message-feedback` is on.
+     * Omitted or `false` follows the global flag. Hiding keeps the selected rating.
+     */
+    hideFeedback?: boolean;
 }
 export interface AssistantMessageActionEventDetail {
     messageId: string;
     actionId: string;
     message: ChatMessage;
 }
+/** Detail of `luzmo-assistant-message-feedback`, fired when the user selects, switches or clears a rating. */
+export interface AssistantMessageFeedbackEventDetail {
+    /** Local message id (`ChatMessage.id`). Use `message.apiMessageId` for a backend id. */
+    messageId: string;
+    /** Rating after the click; `0` when the user cleared it. */
+    rating: AssistantMessageFeedbackRating;
+    /** The message with the updated rating. */
+    message: ChatMessage;
+}
 export interface AiChatMessageSentEventDetail {
     message: ChatMessage;
     selectedDatasets: Dataset[];