v18 … v19

Breaking changes

replace SDK event removed — use select-suggestion

The top-level SDK listener on('replace', …) has been removed. The same moment in the flow is now exposed as select-suggestion, with a richer payload (including how text should be applied to the input).

Before (v18)

deepdeskSDK.on('replace', (payload) => {
    // handle replacement
});

After (v19)

deepdeskSDK.on('select-suggestion', (payload) => {
    // payload includes suggestion metadata, type, and `replace: { start, end }`
    // for the range to replace in the input when applicable
});

Unregister with deepdeskSDK.off('select-suggestion', handler) instead of deepdeskSDK.off('replace', …).

Deprecated getSummary method was removed

It can be replaced by the evaluateConversationAssistant method, see details here.

Before (v18)

deepdeskSDK.getSummary()

After (v19)

const results = await deepdeskSDK.evaluateConversationAssistant('ended', {
  showCuesInWidget: false,
  transcript: messages,
});

// Optional: scope evaluation to a specific conversation without switching the loaded one
await deepdeskSDK.evaluateConversationAssistant('ended', {
  externalConversationId: conversationId,
  transcript: messages,
  showCuesInWidget: false,
});

For headless or custom UI integrations, prefer awaiting the returned results or listening for 'Assistant evaluation completed'. 'Assistant response displayed' remains available for widget analytics when cues are rendered.

// Event-driven headless integration
deepdeskSDK.on('event', ({ name, data }) => {
    if (name === 'Assistant evaluation completed' && data.assistantCode === 'summarizer-chat') {
        console.log('Assistant evaluation completed', data.assistantOutput);
    }
});

// Widget analytics only
deepdeskSDK.on('event', ({ name, data }) => {
    if (name === 'Assistant response displayed' && data.assistantCode === 'summarizer-chat') {
        console.log('Assistant response displayed', data.assistantOutput);
    }
});

Removed expectFormat options from assistants

The expectFormat option has been removed from assistant evaluation (including knowledge assist). Response shaping is no longer controlled via this SDK/API field.

Action: Remove any expectFormat (or equivalent) argument from:

• programmatic assistant calls (e.g. evaluateAssistant / conversation or knowledge assist helpers you use from the SDK), and
• any direct API payloads you built that mirrored the old shape.

If you relied on a specific format, configure that on the backend / assistant configuration instead.