@deepdesk/deepdesk-sdk 14.2.1-beta.0 → 14.2.1-beta.2

package/dist/index.d.mts

@@ -457,9 +457,9 @@ declare class DeepdeskBrokerAPI {
     closeStream(platformSessionId: string): void;
 }
 
-type EvaluationOutput = CamelCaseKeys<Server.EvaluationOutput>;
+type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
 type State$f = {
-    outputs: EvaluationOutput[];
+    cues: EvaluationOutput<'json-schema:cues'>;
     fetchState: FetchState;
 };
 type Transcript = Array<{
@@ -1008,18 +1008,25 @@ declare namespace Server {
         event: string;
         value: string;
     }
-    interface Cue {
+    type ResponseFormat = 'text' | 'json-object' | 'json-schema:cues' | 'json-schema:knowledge-assist';
+    interface LegacyCue {
         text: string;
         title: string;
         rule: Pick<Rule, 'id' | 'name' | 'label' | 'description'>;
         call_to_action?: CallToAction;
     }
-    interface EvaluationOutput {
+    type EvaluationOutput<T extends ResponseFormat> = T extends 'text' ? string : T extends 'json-object' ? unknown : T extends 'json-schema:cues' ? Array<{
         code: string;
         name: string;
         response: string;
         call_to_action?: CallToAction;
-    }
+    }> : T extends 'json-schema:knowledge-assist' ? Array<{
+        answer: string;
+        sources: {
+            name: string;
+            url: string;
+        };
+    }> : never;
     /**
      * Handling time event data
      */
@@ -1436,7 +1443,7 @@ declare class DeepdeskAPI {
      */
     evaluateRule<Payload = unknown>(label: string, conversationId: string, payload: Payload, opts?: {
         raiseForFailingConditions?: boolean;
-    }): Promise<CamelCaseKeys<Server.Cue[]>>;
+    }): Promise<CamelCaseKeys<Server.LegacyCue[]>>;
     /**
      * Temporarily restore getSummary for more controlled rollout
      * @deprecated
@@ -1450,14 +1457,15 @@ declare class DeepdeskAPI {
         agentId?: string;
         externalConversationId?: string;
     }): Promise<CamelCaseKeys<Server.Summary>>;
-    evaluateAssistant<TInput = Record<string, unknown>>(assistantCode: string, options: {
+    evaluateAssistant<TOutput extends Server.ResponseFormat = 'text', TInput = Record<string, unknown>>(assistantCode: string, options?: {
+        expectFormat: TOutput;
         input: TInput;
         transcript?: Array<{
             source: string;
             text: string;
         }>;
         conversationId?: string;
-    }): Promise<CamelCaseKeys<Server.EvaluationOutput[]> | string>;
+    }): Promise<CamelCaseKeys<Server.EvaluationOutput<TOutput>>>;
     getRules(): Promise<CamelCaseKeys<Server.Rule[]>>;
     translateMessages(params: TranslationRequest): Promise<TranslationResponse>;
     private handleDeepdeskVersionHeaders;
@@ -1672,7 +1680,7 @@ interface State$2 {
     fetchState: FetchState;
 }
 
-type Cue = CamelCaseKeys<Server.Cue>;
+type Cue = CamelCaseKeys<Server.LegacyCue>;
 type State$1 = {
     cues: Cue[];
     fetchState: FetchState;
@@ -2312,19 +2320,17 @@ declare class DeepdeskSDK {
     evaluateRule(label: string, params?: Record<string, any>, options?: EvaluateRuleOptions): Promise<Cue[]>;
     /**
      * Evaluate assistant
-     * By default will show cues in widget
+     * By default will expect cues and show them in the widget.
+     * Disable cues in widget by providing `showCuesInWidget: false`-option.
+     * `expectFormat` could be 'text', 'json-object', 'json-schema:cues' or 'json-schema:knowledge-assist'
      */
-    evaluateAssistant(assistantCode: string, options?: {
+    evaluateAssistant<T extends Server.ResponseFormat = 'json-schema:cues'>(assistantCode: string, options?: {
+        expectFormat?: T;
         input?: Record<string, any>;
         transcript?: TranscriptOption;
         includeTags?: boolean;
         showCuesInWidget?: boolean;
-    }): Promise<EvaluationOutput[] | string>;
-    /**
-     * @deprecated in favor of passing `payload` through `options` argument
-     * TODO: remove when integrations use first call signature
-     */
-    evaluateAssistant(assistantCode: string, payload?: Record<string, any>): Promise<EvaluationOutput[] | string>;
+    }): Promise<EvaluationOutput<T> | string>;
     /**
      * Evaluate conversation lifecycle assistant
      * Convenient wrapper around `evaluateAssistant`.

package/dist/index.d.ts

@@ -457,9 +457,9 @@ declare class DeepdeskBrokerAPI {
     closeStream(platformSessionId: string): void;
 }
 
-type EvaluationOutput = CamelCaseKeys<Server.EvaluationOutput>;
+type EvaluationOutput<T extends Server.ResponseFormat> = CamelCaseKeys<Server.EvaluationOutput<T>>;
 type State$f = {
-    outputs: EvaluationOutput[];
+    cues: EvaluationOutput<'json-schema:cues'>;
     fetchState: FetchState;
 };
 type Transcript = Array<{
@@ -1008,18 +1008,25 @@ declare namespace Server {
         event: string;
         value: string;
     }
-    interface Cue {
+    type ResponseFormat = 'text' | 'json-object' | 'json-schema:cues' | 'json-schema:knowledge-assist';
+    interface LegacyCue {
         text: string;
         title: string;
         rule: Pick<Rule, 'id' | 'name' | 'label' | 'description'>;
         call_to_action?: CallToAction;
     }
-    interface EvaluationOutput {
+    type EvaluationOutput<T extends ResponseFormat> = T extends 'text' ? string : T extends 'json-object' ? unknown : T extends 'json-schema:cues' ? Array<{
         code: string;
         name: string;
         response: string;
         call_to_action?: CallToAction;
-    }
+    }> : T extends 'json-schema:knowledge-assist' ? Array<{
+        answer: string;
+        sources: {
+            name: string;
+            url: string;
+        };
+    }> : never;
     /**
      * Handling time event data
      */
@@ -1436,7 +1443,7 @@ declare class DeepdeskAPI {
      */
     evaluateRule<Payload = unknown>(label: string, conversationId: string, payload: Payload, opts?: {
         raiseForFailingConditions?: boolean;
-    }): Promise<CamelCaseKeys<Server.Cue[]>>;
+    }): Promise<CamelCaseKeys<Server.LegacyCue[]>>;
     /**
      * Temporarily restore getSummary for more controlled rollout
      * @deprecated
@@ -1450,14 +1457,15 @@ declare class DeepdeskAPI {
         agentId?: string;
         externalConversationId?: string;
     }): Promise<CamelCaseKeys<Server.Summary>>;
-    evaluateAssistant<TInput = Record<string, unknown>>(assistantCode: string, options: {
+    evaluateAssistant<TOutput extends Server.ResponseFormat = 'text', TInput = Record<string, unknown>>(assistantCode: string, options?: {
+        expectFormat: TOutput;
         input: TInput;
         transcript?: Array<{
             source: string;
             text: string;
         }>;
         conversationId?: string;
-    }): Promise<CamelCaseKeys<Server.EvaluationOutput[]> | string>;
+    }): Promise<CamelCaseKeys<Server.EvaluationOutput<TOutput>>>;
     getRules(): Promise<CamelCaseKeys<Server.Rule[]>>;
     translateMessages(params: TranslationRequest): Promise<TranslationResponse>;
     private handleDeepdeskVersionHeaders;
@@ -1672,7 +1680,7 @@ interface State$2 {
     fetchState: FetchState;
 }
 
-type Cue = CamelCaseKeys<Server.Cue>;
+type Cue = CamelCaseKeys<Server.LegacyCue>;
 type State$1 = {
     cues: Cue[];
     fetchState: FetchState;
@@ -2312,19 +2320,17 @@ declare class DeepdeskSDK {
     evaluateRule(label: string, params?: Record<string, any>, options?: EvaluateRuleOptions): Promise<Cue[]>;
     /**
      * Evaluate assistant
-     * By default will show cues in widget
+     * By default will expect cues and show them in the widget.
+     * Disable cues in widget by providing `showCuesInWidget: false`-option.
+     * `expectFormat` could be 'text', 'json-object', 'json-schema:cues' or 'json-schema:knowledge-assist'
      */
-    evaluateAssistant(assistantCode: string, options?: {
+    evaluateAssistant<T extends Server.ResponseFormat = 'json-schema:cues'>(assistantCode: string, options?: {
+        expectFormat?: T;
         input?: Record<string, any>;
         transcript?: TranscriptOption;
         includeTags?: boolean;
         showCuesInWidget?: boolean;
-    }): Promise<EvaluationOutput[] | string>;
-    /**
-     * @deprecated in favor of passing `payload` through `options` argument
-     * TODO: remove when integrations use first call signature
-     */
-    evaluateAssistant(assistantCode: string, payload?: Record<string, any>): Promise<EvaluationOutput[] | string>;
+    }): Promise<EvaluationOutput<T> | string>;
     /**
      * Evaluate conversation lifecycle assistant
      * Convenient wrapper around `evaluateAssistant`.