@deepdesk/deepdesk-sdk 18.2.1-beta.1 → 18.2.1-beta.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +8 -8
- package/dist/index.d.mts +16 -82
- package/dist/index.d.ts +16 -82
- package/dist/index.esm.js +8 -8
- package/dist/index.iife.js +71 -72
- package/input.css +1 -1
- package/package.json +33 -70
- package/styles/index.js +1 -1
- package/styles.css +1 -1
- package/widget.css +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -4,7 +4,6 @@ import * as _reduxjs_toolkit from '@reduxjs/toolkit';
|
|
|
4
4
|
import { Middleware, Tuple } from '@reduxjs/toolkit';
|
|
5
5
|
import * as redux from 'redux';
|
|
6
6
|
import { Unsubscribe } from 'redux';
|
|
7
|
-
import * as redux_thunk from 'redux-thunk';
|
|
8
7
|
|
|
9
8
|
declare const styles$s: {
|
|
10
9
|
readonly "content": string;
|
|
@@ -101,6 +100,8 @@ declare const styles$n: {
|
|
|
101
100
|
readonly "actionsIsFixed": string;
|
|
102
101
|
readonly "button": string;
|
|
103
102
|
readonly "buttonDisabled": string;
|
|
103
|
+
readonly "buttonPrimary": string;
|
|
104
|
+
readonly "buttonSecondary": string;
|
|
104
105
|
readonly "buttonWithIcon": string;
|
|
105
106
|
readonly "buttonsContainer": string;
|
|
106
107
|
readonly "dropdownButton": string;
|
|
@@ -126,8 +127,9 @@ interface ButtonProps<T extends React.ElementType> {
|
|
|
126
127
|
title?: string;
|
|
127
128
|
icon?: ReactNode;
|
|
128
129
|
disabled?: boolean;
|
|
130
|
+
variant?: 'primary' | 'secondary';
|
|
129
131
|
}
|
|
130
|
-
declare function Button<T extends React.ElementType = 'button'>({ as, className, icon, title, children, disabled, ...restProps }: ButtonProps<T> & Omit<React.ComponentPropsWithoutRef<T>, keyof ButtonProps<T>>): react_jsx_runtime.JSX.Element;
|
|
132
|
+
declare function Button<T extends React.ElementType = 'button'>({ as, className, icon, title, children, disabled, variant, ...restProps }: ButtonProps<T> & Omit<React.ComponentPropsWithoutRef<T>, keyof ButtonProps<T>>): react_jsx_runtime.JSX.Element;
|
|
131
133
|
declare const ButtonsContainer: React.FC<{
|
|
132
134
|
children: React.ReactNode;
|
|
133
135
|
}>;
|
|
@@ -380,7 +382,7 @@ type VariableMapping = Record<string, string>;
|
|
|
380
382
|
type CustomDataSchema = Array<{
|
|
381
383
|
path: string;
|
|
382
384
|
label: string;
|
|
383
|
-
type: 'string' | 'number';
|
|
385
|
+
type: 'string' | 'number' | 'array';
|
|
384
386
|
} | {
|
|
385
387
|
path: string;
|
|
386
388
|
label: string;
|
|
@@ -407,15 +409,13 @@ declare enum FetchState {
|
|
|
407
409
|
type LegacyCue = CamelCaseKeys<Server.LegacyCue> & {
|
|
408
410
|
isLoading?: boolean;
|
|
409
411
|
editable?: boolean;
|
|
410
|
-
specialType?: 'summary';
|
|
411
412
|
evaluationId: string;
|
|
412
413
|
};
|
|
413
414
|
|
|
414
|
-
type EvaluationOutput
|
|
415
|
+
type EvaluationOutput = CamelCaseKeys<Server.EvaluationOutput>;
|
|
415
416
|
type ArrayItemType<T> = T extends Array<infer I> ? I : never;
|
|
416
|
-
type Cue = ArrayItemType<EvaluationOutput
|
|
417
|
+
type Cue = ArrayItemType<EvaluationOutput> & {
|
|
417
418
|
isLoading?: boolean;
|
|
418
|
-
specialType?: 'summary';
|
|
419
419
|
evaluationId: string;
|
|
420
420
|
};
|
|
421
421
|
type AssistantAnswerSource = {
|
|
@@ -447,9 +447,7 @@ interface EvaluateInput {
|
|
|
447
447
|
transcript?: TranscriptOption;
|
|
448
448
|
includeMetadata?: boolean;
|
|
449
449
|
skipState?: boolean;
|
|
450
|
-
expectFormat: Server.ResponseFormat;
|
|
451
450
|
}
|
|
452
|
-
type SummaryInput = Omit<EvaluateInput, 'expectFormat'>;
|
|
453
451
|
|
|
454
452
|
type Fetch = typeof window.fetch;
|
|
455
453
|
type HTTPClientOptions = {
|
|
@@ -674,7 +672,6 @@ declare namespace Server {
|
|
|
674
672
|
event: string;
|
|
675
673
|
value?: string;
|
|
676
674
|
}
|
|
677
|
-
type ResponseFormat = 'text' | 'json-object' | 'json-schema:cues' | 'json-schema:knowledge-assist';
|
|
678
675
|
interface LegacyCue {
|
|
679
676
|
text: string;
|
|
680
677
|
title: string;
|
|
@@ -688,24 +685,22 @@ declare namespace Server {
|
|
|
688
685
|
MAX_RECURSION_LEVEL = "max_recursion_level",
|
|
689
686
|
NO_ACCESS_TO_ASSISTANT = "no_access_to_assistant"
|
|
690
687
|
}
|
|
691
|
-
type EvaluationResponse
|
|
688
|
+
type EvaluationResponse = {
|
|
692
689
|
evaluation_id: string;
|
|
693
690
|
evaluation_status: EvaluationStatus;
|
|
694
|
-
output: EvaluationOutput
|
|
691
|
+
output: EvaluationOutput;
|
|
695
692
|
};
|
|
696
|
-
type EvaluationOutput
|
|
693
|
+
type EvaluationOutput = Array<{
|
|
697
694
|
code: string;
|
|
698
695
|
name: string;
|
|
699
696
|
response: string;
|
|
700
697
|
editable?: boolean;
|
|
701
698
|
call_to_action?: CallToAction;
|
|
702
|
-
}> : T extends 'json-schema:knowledge-assist' ? {
|
|
703
|
-
response: string;
|
|
704
699
|
sources?: {
|
|
705
700
|
name: string;
|
|
706
701
|
url: string;
|
|
707
702
|
}[];
|
|
708
|
-
}
|
|
703
|
+
}>;
|
|
709
704
|
/**
|
|
710
705
|
* Handling time event data
|
|
711
706
|
*/
|
|
@@ -1141,8 +1136,7 @@ declare class DeepdeskAPI {
|
|
|
1141
1136
|
verifyLoginToken(token: string): Promise<{
|
|
1142
1137
|
isLoggedIn: boolean;
|
|
1143
1138
|
}>;
|
|
1144
|
-
evaluateAssistant<
|
|
1145
|
-
expectFormat: TOutput;
|
|
1139
|
+
evaluateAssistant<TInput = Record<string, unknown>>(assistantCode: string, options?: {
|
|
1146
1140
|
threadId?: number;
|
|
1147
1141
|
input: TInput;
|
|
1148
1142
|
transcript?: Array<{
|
|
@@ -1150,7 +1144,7 @@ declare class DeepdeskAPI {
|
|
|
1150
1144
|
text: string;
|
|
1151
1145
|
}>;
|
|
1152
1146
|
externalConversationId?: string;
|
|
1153
|
-
}): Promise<CamelCaseKeys<Server.EvaluationResponse
|
|
1147
|
+
}): Promise<CamelCaseKeys<Server.EvaluationResponse>>;
|
|
1154
1148
|
createAssistantThread(init: {
|
|
1155
1149
|
assistantCode: string;
|
|
1156
1150
|
}): Promise<{
|
|
@@ -2020,7 +2014,6 @@ interface WidgetOptions {
|
|
|
2020
2014
|
}
|
|
2021
2015
|
interface KnowledgeAssistantWidgetOptions extends KnowledgeAssistOptions {
|
|
2022
2016
|
customStyles?: WidgetCustomStyles;
|
|
2023
|
-
isLegacyKnowledgeAssist?: boolean;
|
|
2024
2017
|
title?: string;
|
|
2025
2018
|
}
|
|
2026
2019
|
declare class DeepdeskSDK {
|
|
@@ -2752,7 +2745,6 @@ declare class DeepdeskSDK {
|
|
|
2752
2745
|
*
|
|
2753
2746
|
* @param assistantCode - The assistant code to evaluate
|
|
2754
2747
|
* @param options - Evaluation options
|
|
2755
|
-
* @param options.expectFormat - Expected response format ('json-schema:cues', 'json-schema:knowledge-assist', 'text', 'json-object')
|
|
2756
2748
|
* @param options.input - Additional input data for the assistant
|
|
2757
2749
|
* @param options.transcript - Transcript option ('in-memory-transcript' or custom transcript)
|
|
2758
2750
|
* @param options.includeMetadata - Whether to include metadata in the response
|
|
@@ -2763,7 +2755,6 @@ declare class DeepdeskSDK {
|
|
|
2763
2755
|
* ```typescript
|
|
2764
2756
|
* // Evaluate assistant with cues format
|
|
2765
2757
|
* const result = await sdk.evaluateAssistant('assistant-code-123', {
|
|
2766
|
-
* expectFormat: 'json-schema:cues',
|
|
2767
2758
|
* input: {
|
|
2768
2759
|
* customerType: 'premium',
|
|
2769
2760
|
* issueType: 'technical'
|
|
@@ -2772,7 +2763,6 @@ declare class DeepdeskSDK {
|
|
|
2772
2763
|
*
|
|
2773
2764
|
* // Evaluate with custom transcript
|
|
2774
2765
|
* const result = await sdk.evaluateAssistant('assistant-code-456', {
|
|
2775
|
-
* expectFormat: 'text',
|
|
2776
2766
|
* transcript: [
|
|
2777
2767
|
* { source: 'visitor', text: 'I have a problem with my order' },
|
|
2778
2768
|
* { source: 'agent', text: 'I can help you with that' }
|
|
@@ -2786,13 +2776,12 @@ declare class DeepdeskSDK {
|
|
|
2786
2776
|
* });
|
|
2787
2777
|
* ```
|
|
2788
2778
|
*/
|
|
2789
|
-
evaluateAssistant
|
|
2790
|
-
expectFormat?: T;
|
|
2779
|
+
evaluateAssistant(assistantCode: string, options?: {
|
|
2791
2780
|
input?: Record<string, any>;
|
|
2792
2781
|
transcript?: TranscriptOption;
|
|
2793
2782
|
includeMetadata?: boolean;
|
|
2794
2783
|
showCuesInWidget?: boolean;
|
|
2795
|
-
}): Promise<EvaluationOutput
|
|
2784
|
+
}): Promise<EvaluationOutput | string>;
|
|
2796
2785
|
/**
|
|
2797
2786
|
* Evaluates conversation lifecycle assistants.
|
|
2798
2787
|
*
|
|
@@ -2839,52 +2828,6 @@ declare class DeepdeskSDK {
|
|
|
2839
2828
|
includeMetadata?: boolean;
|
|
2840
2829
|
showCuesInWidget?: boolean;
|
|
2841
2830
|
}): Promise<void>;
|
|
2842
|
-
/**
|
|
2843
|
-
* @deprecated Specific 'Summarizer' assistants are deprecated.
|
|
2844
|
-
*
|
|
2845
|
-
* Generates a summary of the current conversation.
|
|
2846
|
-
*
|
|
2847
|
-
* This method uses the summarizer assistant configured in the profile to
|
|
2848
|
-
* generate a concise summary of the current conversation. It assumes that
|
|
2849
|
-
* `setConversationQuery()` has been called before this method and will
|
|
2850
|
-
* throw an error if this is not the case.
|
|
2851
|
-
*
|
|
2852
|
-
* @param args - Summary generation options
|
|
2853
|
-
* @param args.includeMetadata - Whether to include metadata in the summary
|
|
2854
|
-
* @param args.transcript - Custom transcript to use (optional)
|
|
2855
|
-
* @returns Promise that resolves to the summary text or null if no summarizer is configured
|
|
2856
|
-
*
|
|
2857
|
-
* @example
|
|
2858
|
-
* ```typescript
|
|
2859
|
-
* // Set up conversation query first
|
|
2860
|
-
* sdk.setConversationQuery(async () => {
|
|
2861
|
-
* return [
|
|
2862
|
-
* { source: 'visitor', text: 'I have a problem with my order' },
|
|
2863
|
-
* { source: 'agent', text: 'I can help you with that' },
|
|
2864
|
-
* { source: 'visitor', text: 'My order number is 12345' }
|
|
2865
|
-
* ];
|
|
2866
|
-
* });
|
|
2867
|
-
*
|
|
2868
|
-
* // Generate summary
|
|
2869
|
-
* const summary = await sdk.getSummary();
|
|
2870
|
-
* console.log('Conversation summary:', summary);
|
|
2871
|
-
*
|
|
2872
|
-
* // Generate summary with metadata
|
|
2873
|
-
* const summaryWithMetadata = await sdk.getSummary({
|
|
2874
|
-
* includeMetadata: true
|
|
2875
|
-
* });
|
|
2876
|
-
*
|
|
2877
|
-
* // Generate summary with custom transcript
|
|
2878
|
-
* const customSummary = await sdk.getSummary({
|
|
2879
|
-
* transcript: [
|
|
2880
|
-
* { source: 'visitor', text: 'Custom conversation data' },
|
|
2881
|
-
* { source: 'agent', text: 'Agent response' }
|
|
2882
|
-
* ]
|
|
2883
|
-
* });
|
|
2884
|
-
* ```
|
|
2885
|
-
*
|
|
2886
|
-
*/
|
|
2887
|
-
getSummary(args?: Omit<SummaryInput, 'assistantCode'>): Promise<string | null>;
|
|
2888
2831
|
private handleKeyDown;
|
|
2889
2832
|
private handleAfterSendMessage;
|
|
2890
2833
|
/**
|
|
@@ -3558,16 +3501,7 @@ type LogEvent<T extends keyof SendEventArgumentMap, P extends T = T> = {
|
|
|
3558
3501
|
name: T;
|
|
3559
3502
|
data: SendEventArgumentMap[P]['data'];
|
|
3560
3503
|
};
|
|
3561
|
-
declare function logEvent<T extends keyof SendEventArgumentMap>(event: LogEvent<T>): _reduxjs_toolkit.AsyncThunkAction<void, LogEvent<T, T>,
|
|
3562
|
-
state?: unknown;
|
|
3563
|
-
dispatch?: redux_thunk.ThunkDispatch<unknown, unknown, redux.UnknownAction>;
|
|
3564
|
-
extra?: unknown;
|
|
3565
|
-
rejectValue?: unknown;
|
|
3566
|
-
serializedErrorType?: unknown;
|
|
3567
|
-
pendingMeta?: unknown;
|
|
3568
|
-
fulfilledMeta?: unknown;
|
|
3569
|
-
rejectedMeta?: unknown;
|
|
3570
|
-
}>;
|
|
3504
|
+
declare function logEvent<T extends keyof SendEventArgumentMap>(event: LogEvent<T>): _reduxjs_toolkit.AsyncThunkAction<void, LogEvent<T, T>, _reduxjs_toolkit.AsyncThunkConfig>;
|
|
3571
3505
|
|
|
3572
3506
|
type CSSModule = Record<string, string>;
|
|
3573
3507
|
declare function useStyles<TStyles extends CSSModule>(componentName: string, defaultStyles: TStyles): TStyles;
|
package/dist/index.d.ts
CHANGED
|
@@ -4,7 +4,6 @@ import * as _reduxjs_toolkit from '@reduxjs/toolkit';
|
|
|
4
4
|
import { Middleware, Tuple } from '@reduxjs/toolkit';
|
|
5
5
|
import * as redux from 'redux';
|
|
6
6
|
import { Unsubscribe } from 'redux';
|
|
7
|
-
import * as redux_thunk from 'redux-thunk';
|
|
8
7
|
|
|
9
8
|
declare const styles$s: {
|
|
10
9
|
readonly "content": string;
|
|
@@ -101,6 +100,8 @@ declare const styles$n: {
|
|
|
101
100
|
readonly "actionsIsFixed": string;
|
|
102
101
|
readonly "button": string;
|
|
103
102
|
readonly "buttonDisabled": string;
|
|
103
|
+
readonly "buttonPrimary": string;
|
|
104
|
+
readonly "buttonSecondary": string;
|
|
104
105
|
readonly "buttonWithIcon": string;
|
|
105
106
|
readonly "buttonsContainer": string;
|
|
106
107
|
readonly "dropdownButton": string;
|
|
@@ -126,8 +127,9 @@ interface ButtonProps<T extends React.ElementType> {
|
|
|
126
127
|
title?: string;
|
|
127
128
|
icon?: ReactNode;
|
|
128
129
|
disabled?: boolean;
|
|
130
|
+
variant?: 'primary' | 'secondary';
|
|
129
131
|
}
|
|
130
|
-
declare function Button<T extends React.ElementType = 'button'>({ as, className, icon, title, children, disabled, ...restProps }: ButtonProps<T> & Omit<React.ComponentPropsWithoutRef<T>, keyof ButtonProps<T>>): react_jsx_runtime.JSX.Element;
|
|
132
|
+
declare function Button<T extends React.ElementType = 'button'>({ as, className, icon, title, children, disabled, variant, ...restProps }: ButtonProps<T> & Omit<React.ComponentPropsWithoutRef<T>, keyof ButtonProps<T>>): react_jsx_runtime.JSX.Element;
|
|
131
133
|
declare const ButtonsContainer: React.FC<{
|
|
132
134
|
children: React.ReactNode;
|
|
133
135
|
}>;
|
|
@@ -380,7 +382,7 @@ type VariableMapping = Record<string, string>;
|
|
|
380
382
|
type CustomDataSchema = Array<{
|
|
381
383
|
path: string;
|
|
382
384
|
label: string;
|
|
383
|
-
type: 'string' | 'number';
|
|
385
|
+
type: 'string' | 'number' | 'array';
|
|
384
386
|
} | {
|
|
385
387
|
path: string;
|
|
386
388
|
label: string;
|
|
@@ -407,15 +409,13 @@ declare enum FetchState {
|
|
|
407
409
|
type LegacyCue = CamelCaseKeys<Server.LegacyCue> & {
|
|
408
410
|
isLoading?: boolean;
|
|
409
411
|
editable?: boolean;
|
|
410
|
-
specialType?: 'summary';
|
|
411
412
|
evaluationId: string;
|
|
412
413
|
};
|
|
413
414
|
|
|
414
|
-
type EvaluationOutput
|
|
415
|
+
type EvaluationOutput = CamelCaseKeys<Server.EvaluationOutput>;
|
|
415
416
|
type ArrayItemType<T> = T extends Array<infer I> ? I : never;
|
|
416
|
-
type Cue = ArrayItemType<EvaluationOutput
|
|
417
|
+
type Cue = ArrayItemType<EvaluationOutput> & {
|
|
417
418
|
isLoading?: boolean;
|
|
418
|
-
specialType?: 'summary';
|
|
419
419
|
evaluationId: string;
|
|
420
420
|
};
|
|
421
421
|
type AssistantAnswerSource = {
|
|
@@ -447,9 +447,7 @@ interface EvaluateInput {
|
|
|
447
447
|
transcript?: TranscriptOption;
|
|
448
448
|
includeMetadata?: boolean;
|
|
449
449
|
skipState?: boolean;
|
|
450
|
-
expectFormat: Server.ResponseFormat;
|
|
451
450
|
}
|
|
452
|
-
type SummaryInput = Omit<EvaluateInput, 'expectFormat'>;
|
|
453
451
|
|
|
454
452
|
type Fetch = typeof window.fetch;
|
|
455
453
|
type HTTPClientOptions = {
|
|
@@ -674,7 +672,6 @@ declare namespace Server {
|
|
|
674
672
|
event: string;
|
|
675
673
|
value?: string;
|
|
676
674
|
}
|
|
677
|
-
type ResponseFormat = 'text' | 'json-object' | 'json-schema:cues' | 'json-schema:knowledge-assist';
|
|
678
675
|
interface LegacyCue {
|
|
679
676
|
text: string;
|
|
680
677
|
title: string;
|
|
@@ -688,24 +685,22 @@ declare namespace Server {
|
|
|
688
685
|
MAX_RECURSION_LEVEL = "max_recursion_level",
|
|
689
686
|
NO_ACCESS_TO_ASSISTANT = "no_access_to_assistant"
|
|
690
687
|
}
|
|
691
|
-
type EvaluationResponse
|
|
688
|
+
type EvaluationResponse = {
|
|
692
689
|
evaluation_id: string;
|
|
693
690
|
evaluation_status: EvaluationStatus;
|
|
694
|
-
output: EvaluationOutput
|
|
691
|
+
output: EvaluationOutput;
|
|
695
692
|
};
|
|
696
|
-
type EvaluationOutput
|
|
693
|
+
type EvaluationOutput = Array<{
|
|
697
694
|
code: string;
|
|
698
695
|
name: string;
|
|
699
696
|
response: string;
|
|
700
697
|
editable?: boolean;
|
|
701
698
|
call_to_action?: CallToAction;
|
|
702
|
-
}> : T extends 'json-schema:knowledge-assist' ? {
|
|
703
|
-
response: string;
|
|
704
699
|
sources?: {
|
|
705
700
|
name: string;
|
|
706
701
|
url: string;
|
|
707
702
|
}[];
|
|
708
|
-
}
|
|
703
|
+
}>;
|
|
709
704
|
/**
|
|
710
705
|
* Handling time event data
|
|
711
706
|
*/
|
|
@@ -1141,8 +1136,7 @@ declare class DeepdeskAPI {
|
|
|
1141
1136
|
verifyLoginToken(token: string): Promise<{
|
|
1142
1137
|
isLoggedIn: boolean;
|
|
1143
1138
|
}>;
|
|
1144
|
-
evaluateAssistant<
|
|
1145
|
-
expectFormat: TOutput;
|
|
1139
|
+
evaluateAssistant<TInput = Record<string, unknown>>(assistantCode: string, options?: {
|
|
1146
1140
|
threadId?: number;
|
|
1147
1141
|
input: TInput;
|
|
1148
1142
|
transcript?: Array<{
|
|
@@ -1150,7 +1144,7 @@ declare class DeepdeskAPI {
|
|
|
1150
1144
|
text: string;
|
|
1151
1145
|
}>;
|
|
1152
1146
|
externalConversationId?: string;
|
|
1153
|
-
}): Promise<CamelCaseKeys<Server.EvaluationResponse
|
|
1147
|
+
}): Promise<CamelCaseKeys<Server.EvaluationResponse>>;
|
|
1154
1148
|
createAssistantThread(init: {
|
|
1155
1149
|
assistantCode: string;
|
|
1156
1150
|
}): Promise<{
|
|
@@ -2020,7 +2014,6 @@ interface WidgetOptions {
|
|
|
2020
2014
|
}
|
|
2021
2015
|
interface KnowledgeAssistantWidgetOptions extends KnowledgeAssistOptions {
|
|
2022
2016
|
customStyles?: WidgetCustomStyles;
|
|
2023
|
-
isLegacyKnowledgeAssist?: boolean;
|
|
2024
2017
|
title?: string;
|
|
2025
2018
|
}
|
|
2026
2019
|
declare class DeepdeskSDK {
|
|
@@ -2752,7 +2745,6 @@ declare class DeepdeskSDK {
|
|
|
2752
2745
|
*
|
|
2753
2746
|
* @param assistantCode - The assistant code to evaluate
|
|
2754
2747
|
* @param options - Evaluation options
|
|
2755
|
-
* @param options.expectFormat - Expected response format ('json-schema:cues', 'json-schema:knowledge-assist', 'text', 'json-object')
|
|
2756
2748
|
* @param options.input - Additional input data for the assistant
|
|
2757
2749
|
* @param options.transcript - Transcript option ('in-memory-transcript' or custom transcript)
|
|
2758
2750
|
* @param options.includeMetadata - Whether to include metadata in the response
|
|
@@ -2763,7 +2755,6 @@ declare class DeepdeskSDK {
|
|
|
2763
2755
|
* ```typescript
|
|
2764
2756
|
* // Evaluate assistant with cues format
|
|
2765
2757
|
* const result = await sdk.evaluateAssistant('assistant-code-123', {
|
|
2766
|
-
* expectFormat: 'json-schema:cues',
|
|
2767
2758
|
* input: {
|
|
2768
2759
|
* customerType: 'premium',
|
|
2769
2760
|
* issueType: 'technical'
|
|
@@ -2772,7 +2763,6 @@ declare class DeepdeskSDK {
|
|
|
2772
2763
|
*
|
|
2773
2764
|
* // Evaluate with custom transcript
|
|
2774
2765
|
* const result = await sdk.evaluateAssistant('assistant-code-456', {
|
|
2775
|
-
* expectFormat: 'text',
|
|
2776
2766
|
* transcript: [
|
|
2777
2767
|
* { source: 'visitor', text: 'I have a problem with my order' },
|
|
2778
2768
|
* { source: 'agent', text: 'I can help you with that' }
|
|
@@ -2786,13 +2776,12 @@ declare class DeepdeskSDK {
|
|
|
2786
2776
|
* });
|
|
2787
2777
|
* ```
|
|
2788
2778
|
*/
|
|
2789
|
-
evaluateAssistant
|
|
2790
|
-
expectFormat?: T;
|
|
2779
|
+
evaluateAssistant(assistantCode: string, options?: {
|
|
2791
2780
|
input?: Record<string, any>;
|
|
2792
2781
|
transcript?: TranscriptOption;
|
|
2793
2782
|
includeMetadata?: boolean;
|
|
2794
2783
|
showCuesInWidget?: boolean;
|
|
2795
|
-
}): Promise<EvaluationOutput
|
|
2784
|
+
}): Promise<EvaluationOutput | string>;
|
|
2796
2785
|
/**
|
|
2797
2786
|
* Evaluates conversation lifecycle assistants.
|
|
2798
2787
|
*
|
|
@@ -2839,52 +2828,6 @@ declare class DeepdeskSDK {
|
|
|
2839
2828
|
includeMetadata?: boolean;
|
|
2840
2829
|
showCuesInWidget?: boolean;
|
|
2841
2830
|
}): Promise<void>;
|
|
2842
|
-
/**
|
|
2843
|
-
* @deprecated Specific 'Summarizer' assistants are deprecated.
|
|
2844
|
-
*
|
|
2845
|
-
* Generates a summary of the current conversation.
|
|
2846
|
-
*
|
|
2847
|
-
* This method uses the summarizer assistant configured in the profile to
|
|
2848
|
-
* generate a concise summary of the current conversation. It assumes that
|
|
2849
|
-
* `setConversationQuery()` has been called before this method and will
|
|
2850
|
-
* throw an error if this is not the case.
|
|
2851
|
-
*
|
|
2852
|
-
* @param args - Summary generation options
|
|
2853
|
-
* @param args.includeMetadata - Whether to include metadata in the summary
|
|
2854
|
-
* @param args.transcript - Custom transcript to use (optional)
|
|
2855
|
-
* @returns Promise that resolves to the summary text or null if no summarizer is configured
|
|
2856
|
-
*
|
|
2857
|
-
* @example
|
|
2858
|
-
* ```typescript
|
|
2859
|
-
* // Set up conversation query first
|
|
2860
|
-
* sdk.setConversationQuery(async () => {
|
|
2861
|
-
* return [
|
|
2862
|
-
* { source: 'visitor', text: 'I have a problem with my order' },
|
|
2863
|
-
* { source: 'agent', text: 'I can help you with that' },
|
|
2864
|
-
* { source: 'visitor', text: 'My order number is 12345' }
|
|
2865
|
-
* ];
|
|
2866
|
-
* });
|
|
2867
|
-
*
|
|
2868
|
-
* // Generate summary
|
|
2869
|
-
* const summary = await sdk.getSummary();
|
|
2870
|
-
* console.log('Conversation summary:', summary);
|
|
2871
|
-
*
|
|
2872
|
-
* // Generate summary with metadata
|
|
2873
|
-
* const summaryWithMetadata = await sdk.getSummary({
|
|
2874
|
-
* includeMetadata: true
|
|
2875
|
-
* });
|
|
2876
|
-
*
|
|
2877
|
-
* // Generate summary with custom transcript
|
|
2878
|
-
* const customSummary = await sdk.getSummary({
|
|
2879
|
-
* transcript: [
|
|
2880
|
-
* { source: 'visitor', text: 'Custom conversation data' },
|
|
2881
|
-
* { source: 'agent', text: 'Agent response' }
|
|
2882
|
-
* ]
|
|
2883
|
-
* });
|
|
2884
|
-
* ```
|
|
2885
|
-
*
|
|
2886
|
-
*/
|
|
2887
|
-
getSummary(args?: Omit<SummaryInput, 'assistantCode'>): Promise<string | null>;
|
|
2888
2831
|
private handleKeyDown;
|
|
2889
2832
|
private handleAfterSendMessage;
|
|
2890
2833
|
/**
|
|
@@ -3558,16 +3501,7 @@ type LogEvent<T extends keyof SendEventArgumentMap, P extends T = T> = {
|
|
|
3558
3501
|
name: T;
|
|
3559
3502
|
data: SendEventArgumentMap[P]['data'];
|
|
3560
3503
|
};
|
|
3561
|
-
declare function logEvent<T extends keyof SendEventArgumentMap>(event: LogEvent<T>): _reduxjs_toolkit.AsyncThunkAction<void, LogEvent<T, T>,
|
|
3562
|
-
state?: unknown;
|
|
3563
|
-
dispatch?: redux_thunk.ThunkDispatch<unknown, unknown, redux.UnknownAction>;
|
|
3564
|
-
extra?: unknown;
|
|
3565
|
-
rejectValue?: unknown;
|
|
3566
|
-
serializedErrorType?: unknown;
|
|
3567
|
-
pendingMeta?: unknown;
|
|
3568
|
-
fulfilledMeta?: unknown;
|
|
3569
|
-
rejectedMeta?: unknown;
|
|
3570
|
-
}>;
|
|
3504
|
+
declare function logEvent<T extends keyof SendEventArgumentMap>(event: LogEvent<T>): _reduxjs_toolkit.AsyncThunkAction<void, LogEvent<T, T>, _reduxjs_toolkit.AsyncThunkConfig>;
|
|
3571
3505
|
|
|
3572
3506
|
type CSSModule = Record<string, string>;
|
|
3573
3507
|
declare function useStyles<TStyles extends CSSModule>(componentName: string, defaultStyles: TStyles): TStyles;
|