Generate comprehensive summaries of all session documents with optional question-answering capability.Overview#
The Summarize Tool supports two operating modes:1.
Direct Summary (return_direct=True): Returns the consolidated summary
2.
Question Answering (return_direct=False): Uses the summary to answer specific questions
Method Signature#
Parameters#
prompt (str | None, optional): Question to answer using the summary (default: None)
return_direct (bool, optional): If True, return summary directly; if False, answer the prompt (default: True)
use_memory (bool, optional): Enable conversation context (default: True)
Parameter Rules#
The prompt and return_direct parameters are mutually exclusive:prompt | return_direct | Behavior |
|---|
None | True | ✅ Returns summary directly |
"question" | False | ✅ Answers question using summary |
None | False | ❌ Raises InvalidParameterError |
"question" | True | ❌ Raises InvalidParameterError |
Returns#
Async iterator yielding text chunks (strings)Raises#
InvalidParameterError: If prompt/return_direct mutual exclusivity is violated
ValueError: If Shadai instance is not used as a context manager
Examples#
Mode 1: Direct Summary (Default)#
Get the consolidated summary of all documents:Mode 2: Question Answering#
Ask specific questions about the documents:Mode 3: Multi-turn Conversation#
Maintain conversation context across questions:Disable Memory#
For independent requests without conversation history:Important Notes#
1.
Summary Source: Answers are based strictly on the consolidated summary, not the original documents
2.
No External Knowledge: The tool only uses information from the session's document summaries
3.
Memory Persistence: When use_memory=True, conversation context is preserved across calls
4.
Streaming: Both modes stream responses in real-time for better UX
5.
Backward Compatible: Existing code using only use_memory continues to work
Error Handling#
See Also#
Modified at 2025-10-18 00:59:33
