@deepdesk/deepdesk-sdk 18.2.1-beta.10 → 18.2.1-beta.12

package/dist/index.d.mts

@@ -409,15 +409,13 @@ declare enum FetchState {
 type LegacyCue = CamelCaseKeys<Server.LegacyCue> & {
     isLoading?: boolean;
     editable?: boolean;
-    specialType?: 'summary';
     evaluationId: string;
 };
 
-type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
+type EvaluationOutput = CamelCaseKeys<Server.EvaluationOutput>;
 type ArrayItemType<T> = T extends Array<infer I> ? I : never;
-type Cue = ArrayItemType<EvaluationOutput<'json-schema:cues'>> & {
+type Cue = ArrayItemType<EvaluationOutput> & {
     isLoading?: boolean;
-    specialType?: 'summary';
     evaluationId: string;
 };
 type AssistantAnswerSource = {
@@ -449,9 +447,7 @@ interface EvaluateInput {
     transcript?: TranscriptOption;
     includeMetadata?: boolean;
     skipState?: boolean;
-    expectFormat: Server.ResponseFormat;
 }
-type SummaryInput = Omit<EvaluateInput, 'expectFormat'>;
 
 type Fetch = typeof window.fetch;
 type HTTPClientOptions = {
@@ -676,7 +672,6 @@ declare namespace Server {
         event: string;
         value?: string;
     }
-    type ResponseFormat = 'text' | 'json-object' | 'json-schema:cues' | 'json-schema:knowledge-assist';
     interface LegacyCue {
         text: string;
         title: string;
@@ -690,24 +685,22 @@ declare namespace Server {
         MAX_RECURSION_LEVEL = "max_recursion_level",
         NO_ACCESS_TO_ASSISTANT = "no_access_to_assistant"
     }
-    type EvaluationResponse<Output extends ResponseFormat> = {
+    type EvaluationResponse = {
         evaluation_id: string;
         evaluation_status: EvaluationStatus;
-        output: EvaluationOutput<Output>;
+        output: EvaluationOutput;
     };
-    type EvaluationOutput<T extends ResponseFormat> = T extends 'text' ? string : T extends 'json-object' ? unknown : T extends 'json-schema:cues' ? Array<{
+    type EvaluationOutput = Array<{
         code: string;
         name: string;
         response: string;
         editable?: boolean;
         call_to_action?: CallToAction;
-    }> : T extends 'json-schema:knowledge-assist' ? {
-        response: string;
         sources?: {
             name: string;
             url: string;
         }[];
-    } : never;
+    }>;
     /**
      * Handling time event data
      */
@@ -1130,10 +1123,6 @@ declare class DeepdeskAPI {
      * Search
      */
     search(params: SearchOptions): Promise<CamelCaseKeys<Server.SearchResultsData>>;
-    knowledgeAssist(request: CamelCaseKeys<Server.KnowledgeRequest>, chatHistory: Server.KnowledgeResponse[], assistantCode: string, meta?: {
-        agentId?: string;
-        conversationId?: string;
-    }): Promise<CamelCaseKeys<Server.KnowledgeResponse['answer']>>;
     requestLoginByEmail(email: string): Promise<{
         code: string;
         message: string;
@@ -1143,8 +1132,7 @@ declare class DeepdeskAPI {
     verifyLoginToken(token: string): Promise<{
         isLoggedIn: boolean;
     }>;
-    evaluateAssistant<TOutput extends Server.ResponseFormat = 'text', TInput = Record<string, unknown>>(assistantCode: string, options?: {
-        expectFormat: TOutput;
+    evaluateAssistant<TInput = Record<string, unknown>>(assistantCode: string, options?: {
         threadId?: number;
         input: TInput;
         transcript?: Array<{
@@ -1152,7 +1140,7 @@ declare class DeepdeskAPI {
             text: string;
         }>;
         externalConversationId?: string;
-    }): Promise<CamelCaseKeys<Server.EvaluationResponse<TOutput>>>;
+    }): Promise<CamelCaseKeys<Server.EvaluationResponse>>;
     createAssistantThread(init: {
         assistantCode: string;
     }): Promise<{
@@ -2022,7 +2010,6 @@ interface WidgetOptions {
 }
 interface KnowledgeAssistantWidgetOptions extends KnowledgeAssistOptions {
     customStyles?: WidgetCustomStyles;
-    isLegacyKnowledgeAssist?: boolean;
     title?: string;
 }
 declare class DeepdeskSDK {
@@ -2754,7 +2741,6 @@ declare class DeepdeskSDK {
      *
      * @param assistantCode - The assistant code to evaluate
      * @param options - Evaluation options
-     * @param options.expectFormat - Expected response format ('json-schema:cues', 'json-schema:knowledge-assist', 'text', 'json-object')
      * @param options.input - Additional input data for the assistant
      * @param options.transcript - Transcript option ('in-memory-transcript' or custom transcript)
      * @param options.includeMetadata - Whether to include metadata in the response
@@ -2765,7 +2751,6 @@ declare class DeepdeskSDK {
      * ```typescript
      * // Evaluate assistant with cues format
      * const result = await sdk.evaluateAssistant('assistant-code-123', {
-     *   expectFormat: 'json-schema:cues',
      *   input: {
      *     customerType: 'premium',
      *     issueType: 'technical'
@@ -2774,7 +2759,6 @@ declare class DeepdeskSDK {
      *
      * // Evaluate with custom transcript
      * const result = await sdk.evaluateAssistant('assistant-code-456', {
-     *   expectFormat: 'text',
      *   transcript: [
      *     { source: 'visitor', text: 'I have a problem with my order' },
      *     { source: 'agent', text: 'I can help you with that' }
@@ -2788,13 +2772,12 @@ declare class DeepdeskSDK {
      * });
      * ```
      */
-    evaluateAssistant<T extends Server.ResponseFormat = 'json-schema:cues'>(assistantCode: string, options?: {
-        expectFormat?: T;
+    evaluateAssistant(assistantCode: string, options?: {
         input?: Record<string, any>;
         transcript?: TranscriptOption;
         includeMetadata?: boolean;
         showCuesInWidget?: boolean;
-    }): Promise<EvaluationOutput<T> | string>;
+    }): Promise<EvaluationOutput | string>;
     /**
      * Evaluates conversation lifecycle assistants.
      *
@@ -2841,52 +2824,6 @@ declare class DeepdeskSDK {
         includeMetadata?: boolean;
         showCuesInWidget?: boolean;
     }): Promise<void>;
-    /**
-     * @deprecated Specific 'Summarizer' assistants are deprecated.
-     *
-     * Generates a summary of the current conversation.
-     *
-     * This method uses the summarizer assistant configured in the profile to
-     * generate a concise summary of the current conversation. It assumes that
-     * `setConversationQuery()` has been called before this method and will
-     * throw an error if this is not the case.
-     *
-     * @param args - Summary generation options
-     * @param args.includeMetadata - Whether to include metadata in the summary
-     * @param args.transcript - Custom transcript to use (optional)
-     * @returns Promise that resolves to the summary text or null if no summarizer is configured
-     *
-     * @example
-     * ```typescript
-     * // Set up conversation query first
-     * sdk.setConversationQuery(async () => {
-     *   return [
-     *     { source: 'visitor', text: 'I have a problem with my order' },
-     *     { source: 'agent', text: 'I can help you with that' },
-     *     { source: 'visitor', text: 'My order number is 12345' }
-     *   ];
-     * });
-     *
-     * // Generate summary
-     * const summary = await sdk.getSummary();
-     * console.log('Conversation summary:', summary);
-     *
-     * // Generate summary with metadata
-     * const summaryWithMetadata = await sdk.getSummary({
-     *   includeMetadata: true
-     * });
-     *
-     * // Generate summary with custom transcript
-     * const customSummary = await sdk.getSummary({
-     *   transcript: [
-     *     { source: 'visitor', text: 'Custom conversation data' },
-     *     { source: 'agent', text: 'Agent response' }
-     *   ]
-     * });
-     * ```
-     *
-     */
-    getSummary(args?: Omit<SummaryInput, 'assistantCode'>): Promise<string | null>;
     private handleKeyDown;
     private handleAfterSendMessage;
     /**
@@ -3061,9 +2998,6 @@ declare class DeepdeskSDK {
      *     text: msg.content
      *   }));
      * });
-     *
-     * // Now you can use features that require setConversationQuery to be set
-     * const summary = await sdk.getSummary();
      * ```
      */
     setConversationQuery(fetchFn: () => Promise<Array<{
@@ -3331,7 +3265,6 @@ declare class DeepdeskSDK {
      * @param options.customStyles - Custom styling for the widget
      * @param options.initialQuestion - Initial question to display
      * @param options.emptyState - Custom empty state configuration
-     * @param options.isLegacyKnowledgeAssist - Whether to use legacy knowledge assistant (default: false)
      * @param options.title - Custom title for the widget
      * @returns Object with unmount function to clean up the widget
      *

package/dist/index.d.ts

@@ -409,15 +409,13 @@ declare enum FetchState {
 type LegacyCue = CamelCaseKeys<Server.LegacyCue> & {
     isLoading?: boolean;
     editable?: boolean;
-    specialType?: 'summary';
     evaluationId: string;
 };
 
-type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
+type EvaluationOutput = CamelCaseKeys<Server.EvaluationOutput>;
 type ArrayItemType<T> = T extends Array<infer I> ? I : never;
-type Cue = ArrayItemType<EvaluationOutput<'json-schema:cues'>> & {
+type Cue = ArrayItemType<EvaluationOutput> & {
     isLoading?: boolean;
-    specialType?: 'summary';
     evaluationId: string;
 };
 type AssistantAnswerSource = {
@@ -449,9 +447,7 @@ interface EvaluateInput {
     transcript?: TranscriptOption;
     includeMetadata?: boolean;
     skipState?: boolean;
-    expectFormat: Server.ResponseFormat;
 }
-type SummaryInput = Omit<EvaluateInput, 'expectFormat'>;
 
 type Fetch = typeof window.fetch;
 type HTTPClientOptions = {
@@ -676,7 +672,6 @@ declare namespace Server {
         event: string;
         value?: string;
     }
-    type ResponseFormat = 'text' | 'json-object' | 'json-schema:cues' | 'json-schema:knowledge-assist';
     interface LegacyCue {
         text: string;
         title: string;
@@ -690,24 +685,22 @@ declare namespace Server {
         MAX_RECURSION_LEVEL = "max_recursion_level",
         NO_ACCESS_TO_ASSISTANT = "no_access_to_assistant"
     }
-    type EvaluationResponse<Output extends ResponseFormat> = {
+    type EvaluationResponse = {
         evaluation_id: string;
         evaluation_status: EvaluationStatus;
-        output: EvaluationOutput<Output>;
+        output: EvaluationOutput;
     };
-    type EvaluationOutput<T extends ResponseFormat> = T extends 'text' ? string : T extends 'json-object' ? unknown : T extends 'json-schema:cues' ? Array<{
+    type EvaluationOutput = Array<{
         code: string;
         name: string;
         response: string;
         editable?: boolean;
         call_to_action?: CallToAction;
-    }> : T extends 'json-schema:knowledge-assist' ? {
-        response: string;
         sources?: {
             name: string;
             url: string;
         }[];
-    } : never;
+    }>;
     /**
      * Handling time event data
      */
@@ -1130,10 +1123,6 @@ declare class DeepdeskAPI {
      * Search
      */
     search(params: SearchOptions): Promise<CamelCaseKeys<Server.SearchResultsData>>;
-    knowledgeAssist(request: CamelCaseKeys<Server.KnowledgeRequest>, chatHistory: Server.KnowledgeResponse[], assistantCode: string, meta?: {
-        agentId?: string;
-        conversationId?: string;
-    }): Promise<CamelCaseKeys<Server.KnowledgeResponse['answer']>>;
     requestLoginByEmail(email: string): Promise<{
         code: string;
         message: string;
@@ -1143,8 +1132,7 @@ declare class DeepdeskAPI {
     verifyLoginToken(token: string): Promise<{
         isLoggedIn: boolean;
     }>;
-    evaluateAssistant<TOutput extends Server.ResponseFormat = 'text', TInput = Record<string, unknown>>(assistantCode: string, options?: {
-        expectFormat: TOutput;
+    evaluateAssistant<TInput = Record<string, unknown>>(assistantCode: string, options?: {
         threadId?: number;
         input: TInput;
         transcript?: Array<{
@@ -1152,7 +1140,7 @@ declare class DeepdeskAPI {
             text: string;
         }>;
         externalConversationId?: string;
-    }): Promise<CamelCaseKeys<Server.EvaluationResponse<TOutput>>>;
+    }): Promise<CamelCaseKeys<Server.EvaluationResponse>>;
     createAssistantThread(init: {
         assistantCode: string;
     }): Promise<{
@@ -2022,7 +2010,6 @@ interface WidgetOptions {
 }
 interface KnowledgeAssistantWidgetOptions extends KnowledgeAssistOptions {
     customStyles?: WidgetCustomStyles;
-    isLegacyKnowledgeAssist?: boolean;
     title?: string;
 }
 declare class DeepdeskSDK {
@@ -2754,7 +2741,6 @@ declare class DeepdeskSDK {
      *
      * @param assistantCode - The assistant code to evaluate
      * @param options - Evaluation options
-     * @param options.expectFormat - Expected response format ('json-schema:cues', 'json-schema:knowledge-assist', 'text', 'json-object')
      * @param options.input - Additional input data for the assistant
      * @param options.transcript - Transcript option ('in-memory-transcript' or custom transcript)
      * @param options.includeMetadata - Whether to include metadata in the response
@@ -2765,7 +2751,6 @@ declare class DeepdeskSDK {
      * ```typescript
      * // Evaluate assistant with cues format
      * const result = await sdk.evaluateAssistant('assistant-code-123', {
-     *   expectFormat: 'json-schema:cues',
      *   input: {
      *     customerType: 'premium',
      *     issueType: 'technical'
@@ -2774,7 +2759,6 @@ declare class DeepdeskSDK {
      *
      * // Evaluate with custom transcript
      * const result = await sdk.evaluateAssistant('assistant-code-456', {
-     *   expectFormat: 'text',
      *   transcript: [
      *     { source: 'visitor', text: 'I have a problem with my order' },
      *     { source: 'agent', text: 'I can help you with that' }
@@ -2788,13 +2772,12 @@ declare class DeepdeskSDK {
      * });
      * ```
      */
-    evaluateAssistant<T extends Server.ResponseFormat = 'json-schema:cues'>(assistantCode: string, options?: {
-        expectFormat?: T;
+    evaluateAssistant(assistantCode: string, options?: {
         input?: Record<string, any>;
         transcript?: TranscriptOption;
         includeMetadata?: boolean;
         showCuesInWidget?: boolean;
-    }): Promise<EvaluationOutput<T> | string>;
+    }): Promise<EvaluationOutput | string>;
     /**
      * Evaluates conversation lifecycle assistants.
      *
@@ -2841,52 +2824,6 @@ declare class DeepdeskSDK {
         includeMetadata?: boolean;
         showCuesInWidget?: boolean;
     }): Promise<void>;
-    /**
-     * @deprecated Specific 'Summarizer' assistants are deprecated.
-     *
-     * Generates a summary of the current conversation.
-     *
-     * This method uses the summarizer assistant configured in the profile to
-     * generate a concise summary of the current conversation. It assumes that
-     * `setConversationQuery()` has been called before this method and will
-     * throw an error if this is not the case.
-     *
-     * @param args - Summary generation options
-     * @param args.includeMetadata - Whether to include metadata in the summary
-     * @param args.transcript - Custom transcript to use (optional)
-     * @returns Promise that resolves to the summary text or null if no summarizer is configured
-     *
-     * @example
-     * ```typescript
-     * // Set up conversation query first
-     * sdk.setConversationQuery(async () => {
-     *   return [
-     *     { source: 'visitor', text: 'I have a problem with my order' },
-     *     { source: 'agent', text: 'I can help you with that' },
-     *     { source: 'visitor', text: 'My order number is 12345' }
-     *   ];
-     * });
-     *
-     * // Generate summary
-     * const summary = await sdk.getSummary();
-     * console.log('Conversation summary:', summary);
-     *
-     * // Generate summary with metadata
-     * const summaryWithMetadata = await sdk.getSummary({
-     *   includeMetadata: true
-     * });
-     *
-     * // Generate summary with custom transcript
-     * const customSummary = await sdk.getSummary({
-     *   transcript: [
-     *     { source: 'visitor', text: 'Custom conversation data' },
-     *     { source: 'agent', text: 'Agent response' }
-     *   ]
-     * });
-     * ```
-     *
-     */
-    getSummary(args?: Omit<SummaryInput, 'assistantCode'>): Promise<string | null>;
     private handleKeyDown;
     private handleAfterSendMessage;
     /**
@@ -3061,9 +2998,6 @@ declare class DeepdeskSDK {
      *     text: msg.content
      *   }));
      * });
-     *
-     * // Now you can use features that require setConversationQuery to be set
-     * const summary = await sdk.getSummary();
      * ```
      */
     setConversationQuery(fetchFn: () => Promise<Array<{
@@ -3331,7 +3265,6 @@ declare class DeepdeskSDK {
      * @param options.customStyles - Custom styling for the widget
      * @param options.initialQuestion - Initial question to display
      * @param options.emptyState - Custom empty state configuration
-     * @param options.isLegacyKnowledgeAssist - Whether to use legacy knowledge assistant (default: false)
      * @param options.title - Custom title for the widget
      * @returns Object with unmount function to clean up the widget
      *