summarize

Generate a summary of the conversation. The service rate limits this per conversation.

Parameters

Returns

Promise<string> — the generated summary.

Throws

SummaryError when the service reports that generation failed. The service returns exactly one of summary or error, both on the success envelope, so a failed summary surfaces as an exception rather than reaching you as an empty string. RateLimitError when you exceed the per-conversation limit.

Example

import { AIChatClient } from '@signalwire/sdk';
const client = new AIChatClient({ space: 'your-space' });
const summary = await client.summarize('chat-8f21', {
  summaryPrompt: 'Summarize the ride request in two sentences.',
});
console.log(summary);