@ensembleapp/client-sdk 0.0.4 → 0.0.7

package/dist/index.d.ts

@@ -8,6 +8,10 @@ import { ClassValue } from 'clsx';
 import 'json-schema';
 import 'zod';
 
+type DeprecatedChatConfig = {
+    /** @deprecated use agentId instead */
+    agentExecutionId?: string;
+};
 interface ApiConfig {
     /** The base URL where /chat and /chat/messages are hosted */
     baseUrl: string;
@@ -15,15 +19,13 @@ interface ApiConfig {
     token: string;
     headers?: Record<string, string>;
 }
-interface UseChatConfig {
+type UseChatConfig = DeprecatedChatConfig & {
     /** The server API configuration */
     api: ApiConfig;
     /** Thread ID for keeping conversation history */
     threadId: string;
-    /** The Agent ID that this chat connects to. Either agentId or agentExecutionId must be provided */
+    /** Ensemble agent ID to connect to */
     agentId?: string;
-    /** The Agent Orchestration ID that this chat connects to. Either agentId or agentExecutionId must be provided */
-    agentExecutionId?: string;
     /** additional context (anything) that needs to be passed to the LLM */
     dataContext?: unknown;
     onError?: (error: Error) => void;
@@ -32,7 +34,7 @@ interface UseChatConfig {
     onFinish?: (message: any) => void;
     onData?: (data: any) => void;
     onMessage?: (message: UIMessage) => void;
-}
+};
 interface ChatMessage {
     id: string;
     role: 'user' | 'assistant';
@@ -67,6 +69,37 @@ declare function useChat({ api, threadId, agentId, agentExecutionId, dataContext
     setMessages: (messages: UIMessage<unknown, ai.UIDataTypes, ai.UITools>[] | ((messages: UIMessage<unknown, ai.UIDataTypes, ai.UITools>[]) => UIMessage<unknown, ai.UIDataTypes, ai.UITools>[])) => void;
 };
 
+type FeedbackRating = 'positive' | 'negative';
+interface MessageFeedback {
+    id: string;
+    messageId: string;
+    rating: FeedbackRating;
+    improvementText?: string;
+    createdAt: Date;
+}
+interface FeedbackState {
+    rating: FeedbackRating;
+    comment?: string;
+}
+interface UseFeedbackConfig {
+    api: ApiConfig;
+    threadId: string;
+    agentId?: string;
+    agentExecutionId?: string;
+}
+interface SubmitFeedbackParams {
+    messageId: string;
+    rating: FeedbackRating;
+    improvementText?: string;
+}
+declare function useFeedback({ api, threadId, agentId, agentExecutionId, }: UseFeedbackConfig): {
+    submitFeedback: ({ messageId, rating, improvementText }: SubmitFeedbackParams) => Promise<MessageFeedback | null>;
+    getFeedbackForMessage: (messageId: string) => FeedbackState | undefined;
+    hasFeedback: (messageId: string) => boolean;
+    isSubmitting: string | null;
+    error: Error | null;
+};
+
 interface ChatWidgetStyles {
     primaryColor?: string;
     primaryTextColor?: string;
@@ -98,6 +131,12 @@ interface ChatWidgetSpeechToTextOptions {
     onError?: (message: string) => void;
     finalDelay?: number;
 }
+interface ChatWidgetFeedbackOptions {
+    /** Enable feedback buttons on assistant messages. Default: true */
+    enabled?: boolean;
+    /** Require comment when giving negative feedback. Default: false */
+    requireCommentForNegative?: boolean;
+}
 interface ChatWidgetConfig extends UseChatConfig {
     /** Title for the Chat window */
     title?: string;
@@ -110,8 +149,10 @@ interface ChatWidgetConfig extends UseChatConfig {
     voice?: ChatWidgetVoiceOptions;
     speechToText?: ChatWidgetSpeechToTextOptions;
     widgets?: UIWidgetDefinition[];
+    /** Feedback options for assistant messages. Enabled by default. */
+    feedback?: ChatWidgetFeedbackOptions;
 }
-declare function ChatWidget({ api, threadId, agentId, agentExecutionId, dataContext, onError, onAuthError, onFinish, onMessage, title, introMessage, inputPlaceholder, className, styles: styleProps, voice, speechToText, widgets, }: ChatWidgetConfig): react_jsx_runtime.JSX.Element;
+declare function ChatWidget({ api, threadId, agentId, agentExecutionId, dataContext, onError, onAuthError, onFinish, onMessage, title, introMessage, inputPlaceholder, className, styles: styleProps, voice, speechToText, widgets, feedback, }: ChatWidgetConfig): react_jsx_runtime.JSX.Element;
 
 interface PopupAnchorConfig {
     enabled?: boolean;
@@ -190,4 +231,4 @@ declare const defaultChatWidgets: UIWidgetDefinition[];
 
 declare function cn(...inputs: ClassValue[]): string;
 
-export { type ApiConfig, type ChatMessage, ChatWidget, type ChatWidgetInstance, type ChatWidgetConfig as ChatWidgetProps, type ChatWidgetSpeechToTextOptions, type ChatWidgetStyles, type ChatWidgetVoiceOptions, type EmbeddableChatWidgetConfig, type PopupAnchorConfig, PopupChatWidget, type PopupChatWidgetProps, UIWidget, UIWidgetDefinition, type UseChatConfig, cn, createChatWidget, defaultChatWidgets, registerChatWidgets, useChat };
+export { type ApiConfig, type ChatMessage, ChatWidget, type ChatWidgetFeedbackOptions, type ChatWidgetInstance, type ChatWidgetConfig as ChatWidgetProps, type ChatWidgetSpeechToTextOptions, type ChatWidgetStyles, type ChatWidgetVoiceOptions, type EmbeddableChatWidgetConfig, type FeedbackRating, type FeedbackState, type MessageFeedback, type PopupAnchorConfig, PopupChatWidget, type PopupChatWidgetProps, type SubmitFeedbackParams, UIWidget, UIWidgetDefinition, type UseChatConfig, type UseFeedbackConfig, cn, createChatWidget, defaultChatWidgets, registerChatWidgets, useChat, useFeedback };