@deepdesk/deepdesk-sdk 17.0.0-rc.3 → 17.0.0-rc.5

package/dist/index.d.mts

@@ -1383,7 +1383,17 @@ type Transcript = Array<{
     source: string;
     text: string;
 }>;
-type TranscriptOption = 'in-memory-transcript' | 'stored-transcript' | Transcript;
+type TranscriptOption = 'in-memory-transcript' | Transcript;
+interface EvaluateInput {
+    assistantCode: string;
+    threadId?: number;
+    input?: any;
+    transcript?: TranscriptOption;
+    includeMetadata?: boolean;
+    skipState?: boolean;
+    expectFormat: Server.ResponseFormat;
+}
+type SummaryInput = Omit<EvaluateInput, 'assistantCode' | 'expectFormat'>;
 
 type State$1 = {
     data: Entity[] | null;
@@ -1990,12 +2000,12 @@ interface SDKEventMap {
         suggestion: TextSuggestion;
         eventMetrics: SuggestionEventMetrics;
     };
-    'reset': {
+    reset: {
         text: string;
         selectionAfter: SelectionRange;
     };
-    'cues': LegacyCue[];
-    'replace': {
+    cues: LegacyCue[];
+    replace: {
         text: string;
         replace: SelectionRange;
     };
@@ -2005,7 +2015,7 @@ interface SDKEventMap {
     'edit-suggestion': EditTextSuggestionPayload;
     'send-message': string;
     'send-message-event': SendMessageEventData$1;
-    'event': {
+    event: {
         name: string;
         data: unknown;
     };
@@ -2050,6 +2060,7 @@ interface WidgetOptions {
     showImages?: boolean;
     isEmbedded?: boolean;
     knowledgeAssist?: KnowledgeAssistOptions;
+    assistantOptions?: Omit<EvaluateInput, 'assistantCode'>;
 }
 interface KnowledgeAssistantWidgetOptions extends KnowledgeAssistOptions {
     customStyles?: WidgetCustomStyles;
@@ -2260,7 +2271,7 @@ declare class DeepdeskSDK {
     /**
      * Evaluate conversation lifecycle assistant
      * Convenient wrapper around `evaluateAssistant`.
-     * By default includes 'stored-transcript' and 'metadata'.
+     * By default includes the server transcript and 'metadata'.
      */
     evaluateConversationAssistant(event: 'accepted' | 'new-message' | 'ended', options?: {
         input?: Record<string, any>;
@@ -2271,7 +2282,7 @@ declare class DeepdeskSDK {
     /**
      * Get summary from conversation
      */
-    getSummary(): Promise<string | null>;
+    getSummary(args?: SummaryInput): Promise<string | null>;
     private handleKeyDown;
     private handleAfterSendMessage;
     handlingTimeStart(): void;
@@ -2467,4 +2478,4 @@ declare function waitForElementVisibilityChange(element: HTMLElement, callback:
 type CSSModule = Record<string, string>;
 declare function useStyles<TStyles extends CSSModule>(componentName: string, defaultStyles: TStyles): TStyles;
 
-export { AgentInfo, Card, ContentEditableInput, Conversation, ConversationMessage, DeepdeskAPI, DeepdeskSDK, HTTPClient, InputMediator, InputOverlayCustomStyles, InputType, KeyboardHint, Label, Locale, Logger, MountOptions, PinnedMessage, PlatformConfig, RootState, Section, SectionList, SelectionRange, Sources, Suggestion, SuggestionEventMetrics, SuggestionList, SuggestionMetrics, TextAreaInput, TextSuggestion, ToggleButton, UrlSuggestion, VisitorInfo, WidgetCustomStyles, WidgetOptions, attachFile, authenticateWithKey, createFullRange, createOverlayContainer, createRangeFromOffsets, escapeHTML, formatTextMarkup, getRangeOffsets, getRangeText, insertCKEditor, isHTML, isSupportedInputElement, updateContentEditable, updateTextArea, useClickOutsideRoot, useStyles, waitForElementVisibilityChange };
+export { type AgentInfo, Card, ContentEditableInput, type Conversation, type ConversationMessage, DeepdeskAPI, DeepdeskSDK, HTTPClient, InputMediator, type InputOverlayCustomStyles, InputType, KeyboardHint, Label, Locale, type Logger, type MountOptions, type PinnedMessage, type PlatformConfig, type RootState, Section, SectionList, type SelectionRange, Sources, Suggestion, type SuggestionEventMetrics, SuggestionList, type SuggestionMetrics, TextAreaInput, type TextSuggestion, ToggleButton, type UrlSuggestion, type VisitorInfo, type WidgetCustomStyles, type WidgetOptions, attachFile, authenticateWithKey, createFullRange, createOverlayContainer, createRangeFromOffsets, escapeHTML, formatTextMarkup, getRangeOffsets, getRangeText, insertCKEditor, isHTML, isSupportedInputElement, updateContentEditable, updateTextArea, useClickOutsideRoot, useStyles, waitForElementVisibilityChange };

package/dist/index.d.ts

@@ -1383,7 +1383,17 @@ type Transcript = Array<{
     source: string;
     text: string;
 }>;
-type TranscriptOption = 'in-memory-transcript' | 'stored-transcript' | Transcript;
+type TranscriptOption = 'in-memory-transcript' | Transcript;
+interface EvaluateInput {
+    assistantCode: string;
+    threadId?: number;
+    input?: any;
+    transcript?: TranscriptOption;
+    includeMetadata?: boolean;
+    skipState?: boolean;
+    expectFormat: Server.ResponseFormat;
+}
+type SummaryInput = Omit<EvaluateInput, 'assistantCode' | 'expectFormat'>;
 
 type State$1 = {
     data: Entity[] | null;
@@ -1990,12 +2000,12 @@ interface SDKEventMap {
         suggestion: TextSuggestion;
         eventMetrics: SuggestionEventMetrics;
     };
-    'reset': {
+    reset: {
         text: string;
         selectionAfter: SelectionRange;
     };
-    'cues': LegacyCue[];
-    'replace': {
+    cues: LegacyCue[];
+    replace: {
         text: string;
         replace: SelectionRange;
     };
@@ -2005,7 +2015,7 @@ interface SDKEventMap {
     'edit-suggestion': EditTextSuggestionPayload;
     'send-message': string;
     'send-message-event': SendMessageEventData$1;
-    'event': {
+    event: {
         name: string;
         data: unknown;
     };
@@ -2050,6 +2060,7 @@ interface WidgetOptions {
     showImages?: boolean;
     isEmbedded?: boolean;
     knowledgeAssist?: KnowledgeAssistOptions;
+    assistantOptions?: Omit<EvaluateInput, 'assistantCode'>;
 }
 interface KnowledgeAssistantWidgetOptions extends KnowledgeAssistOptions {
     customStyles?: WidgetCustomStyles;
@@ -2260,7 +2271,7 @@ declare class DeepdeskSDK {
     /**
      * Evaluate conversation lifecycle assistant
      * Convenient wrapper around `evaluateAssistant`.
-     * By default includes 'stored-transcript' and 'metadata'.
+     * By default includes the server transcript and 'metadata'.
      */
     evaluateConversationAssistant(event: 'accepted' | 'new-message' | 'ended', options?: {
         input?: Record<string, any>;
@@ -2271,7 +2282,7 @@ declare class DeepdeskSDK {
     /**
      * Get summary from conversation
      */
-    getSummary(): Promise<string | null>;
+    getSummary(args?: SummaryInput): Promise<string | null>;
     private handleKeyDown;
     private handleAfterSendMessage;
     handlingTimeStart(): void;
@@ -2467,4 +2478,4 @@ declare function waitForElementVisibilityChange(element: HTMLElement, callback:
 type CSSModule = Record<string, string>;
 declare function useStyles<TStyles extends CSSModule>(componentName: string, defaultStyles: TStyles): TStyles;
 
-export { AgentInfo, Card, ContentEditableInput, Conversation, ConversationMessage, DeepdeskAPI, DeepdeskSDK, HTTPClient, InputMediator, InputOverlayCustomStyles, InputType, KeyboardHint, Label, Locale, Logger, MountOptions, PinnedMessage, PlatformConfig, RootState, Section, SectionList, SelectionRange, Sources, Suggestion, SuggestionEventMetrics, SuggestionList, SuggestionMetrics, TextAreaInput, TextSuggestion, ToggleButton, UrlSuggestion, VisitorInfo, WidgetCustomStyles, WidgetOptions, attachFile, authenticateWithKey, createFullRange, createOverlayContainer, createRangeFromOffsets, escapeHTML, formatTextMarkup, getRangeOffsets, getRangeText, insertCKEditor, isHTML, isSupportedInputElement, updateContentEditable, updateTextArea, useClickOutsideRoot, useStyles, waitForElementVisibilityChange };
+export { type AgentInfo, Card, ContentEditableInput, type Conversation, type ConversationMessage, DeepdeskAPI, DeepdeskSDK, HTTPClient, InputMediator, type InputOverlayCustomStyles, InputType, KeyboardHint, Label, Locale, type Logger, type MountOptions, type PinnedMessage, type PlatformConfig, type RootState, Section, SectionList, type SelectionRange, Sources, Suggestion, type SuggestionEventMetrics, SuggestionList, type SuggestionMetrics, TextAreaInput, type TextSuggestion, ToggleButton, type UrlSuggestion, type VisitorInfo, type WidgetCustomStyles, type WidgetOptions, attachFile, authenticateWithKey, createFullRange, createOverlayContainer, createRangeFromOffsets, escapeHTML, formatTextMarkup, getRangeOffsets, getRangeText, insertCKEditor, isHTML, isSupportedInputElement, updateContentEditable, updateTextArea, useClickOutsideRoot, useStyles, waitForElementVisibilityChange };