Files
AFFiNE-Mirror/packages/backend/server/src/plugins/copilot/tools/conversation-summary.ts
T
DarkSky ad5a122391 feat(server): summary tools (#13133)
fix AI-281

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **New Features**
* Added a new AI-powered conversation summary tool that generates
concise summaries of key topics, decisions, and details from
conversations, with options to focus on specific areas and adjust
summary length.
* Introduced a new prompt for conversation summarization, supporting
customizable focus and summary length.

* **Bug Fixes**
* Improved tool handling and error messages for conversation
summarization when required input is missing.

* **Tests**
* Expanded test coverage to include scenarios for the new conversation
summary feature.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-07-10 06:47:34 +00:00

77 lines
2.5 KiB
TypeScript

import { Logger } from '@nestjs/common';
import { tool } from 'ai';
import { z } from 'zod';
import type { PromptService } from '../prompt';
import type { CopilotProviderFactory } from '../providers';
import { toolError } from './error';
const logger = new Logger('ConversationSummaryTool');
export const createConversationSummaryTool = (
sessionId: string | undefined,
promptService: PromptService,
factory: CopilotProviderFactory
) => {
return tool({
description:
'Create a concise, AI-generated summary of the conversation so far—capturing key topics, decisions, and critical details. Use this tool whenever the context becomes lengthy to preserve essential information that might otherwise be lost to truncation in future turns.',
parameters: z.object({
focus: z
.string()
.optional()
.describe(
'Optional focus area for the summary (e.g., "technical decisions", "user requirements", "project status")'
),
length: z
.enum(['brief', 'detailed', 'comprehensive'])
.default('detailed')
.describe(
'The desired length of the summary: brief (1-2 sentences), detailed (paragraph), comprehensive (multiple paragraphs)'
),
}),
execute: async ({ focus, length }, { messages }) => {
try {
if (!messages || messages.length === 0) {
return toolError(
'No Conversation Context',
'No messages available to summarize'
);
}
const prompt = await promptService.get('Conversation Summary');
const provider = await factory.getProviderByModel(prompt?.model || '');
if (!prompt || !provider) {
return toolError(
'Prompt Not Found',
'Failed to summarize conversation.'
);
}
const summary = await provider.text(
{ modelId: prompt.model },
prompt.finish({
messages: messages.map(m => ({
...m,
content: m.content.toString(),
})),
focus: focus || 'general',
length,
})
);
return {
focusArea: focus || 'general',
messageCount: messages.length,
summary,
timestamp: new Date().toISOString(),
};
} catch (err: any) {
logger.error(`Failed to summarize conversation (${sessionId})`, err);
return toolError('Conversation Summary Failed', err.message);
}
},
});
};