Spaces:
Sleeping
Sleeping
Commit
·
09e23a2
1
Parent(s):
85ac081
feat: Implement Anthropic context engineering with compaction, structured prompts, and tool result clearing
Browse files- ANTHROPIC_CONTEXT_ENGINEERING.md +201 -0
- CONTEXT_ENGINEERING_IMPLEMENTATION.md +128 -0
- KB_FIRST_IMPLEMENTATION.md +81 -0
- app.py +10 -4
- backend/api/services/agent_orchestrator.py +192 -40
- backend/api/services/context_engineer.py +512 -0
ANTHROPIC_CONTEXT_ENGINEERING.md
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Anthropic Context Engineering Implementation
|
| 2 |
+
|
| 3 |
+
## Overview
|
| 4 |
+
Enhanced context engineering implementation based on Anthropic's best practices and research.
|
| 5 |
+
|
| 6 |
+
## Key Principles from Anthropic
|
| 7 |
+
|
| 8 |
+
### 1. Context as Finite Resource
|
| 9 |
+
- **Context Rot**: As tokens increase, model's ability to recall information decreases
|
| 10 |
+
- **Attention Budget**: LLMs have finite attention, every token depletes it
|
| 11 |
+
- **Diminishing Returns**: More context doesn't always mean better performance
|
| 12 |
+
|
| 13 |
+
### 2. Minimal High-Signal Tokens
|
| 14 |
+
- Find the smallest possible set of high-signal tokens
|
| 15 |
+
- Maximize likelihood of desired outcome
|
| 16 |
+
- Balance between too much and too little context
|
| 17 |
+
|
| 18 |
+
## Implemented Strategies
|
| 19 |
+
|
| 20 |
+
### 1. Structured Prompt Organization ✅
|
| 21 |
+
**Anthropic's Recommendation**: Use clear sections with XML tags or Markdown headers
|
| 22 |
+
|
| 23 |
+
**Implementation**:
|
| 24 |
+
- All prompts now use XML-style tags: `<system>`, `<background_information>`, `<instructions>`, etc.
|
| 25 |
+
- Clear separation of concerns
|
| 26 |
+
- Better model understanding of context structure
|
| 27 |
+
|
| 28 |
+
**Example Structure**:
|
| 29 |
+
```
|
| 30 |
+
<system>
|
| 31 |
+
System instructions
|
| 32 |
+
</system>
|
| 33 |
+
|
| 34 |
+
<background_information>
|
| 35 |
+
Context and rules
|
| 36 |
+
</background_information>
|
| 37 |
+
|
| 38 |
+
<knowledge_base_documents>
|
| 39 |
+
RAG results
|
| 40 |
+
</knowledge_base_documents>
|
| 41 |
+
|
| 42 |
+
<instructions>
|
| 43 |
+
Task instructions
|
| 44 |
+
</instructions>
|
| 45 |
+
```
|
| 46 |
+
|
| 47 |
+
### 2. Compaction (High-Fidelity Summarization) ✅
|
| 48 |
+
**Anthropic's Strategy**: Summarize conversations nearing context limit while preserving critical details
|
| 49 |
+
|
| 50 |
+
**Implementation**:
|
| 51 |
+
- `compact_conversation()`: Preserves architectural decisions, unresolved issues, implementation details
|
| 52 |
+
- Discards redundant tool outputs
|
| 53 |
+
- Keeps first message + summary + last N messages
|
| 54 |
+
- High-fidelity compression maintaining coherence
|
| 55 |
+
|
| 56 |
+
**Key Features**:
|
| 57 |
+
- Preserves: Architectural decisions, unresolved bugs, implementation details, key facts
|
| 58 |
+
- Discards: Redundant tool outputs, repetitive information, verbose explanations
|
| 59 |
+
|
| 60 |
+
### 3. Tool Result Clearing ✅
|
| 61 |
+
**Anthropic's Safest Compaction**: Clear tool results once processed
|
| 62 |
+
|
| 63 |
+
**Implementation**:
|
| 64 |
+
- `clear_tool_results()`: Removes large tool outputs while keeping metadata
|
| 65 |
+
- Once a tool is called deep in history, raw results often no longer needed
|
| 66 |
+
- Safest form of compaction with minimal information loss
|
| 67 |
+
|
| 68 |
+
**Usage**:
|
| 69 |
+
- Automatically applied before full compaction
|
| 70 |
+
- Reduces tokens without losing critical context
|
| 71 |
+
- Preserves tool call metadata for debugging
|
| 72 |
+
|
| 73 |
+
### 4. Structured Note-Taking ✅
|
| 74 |
+
**Anthropic's Memory Strategy**: Write notes outside context window, pull back when needed
|
| 75 |
+
|
| 76 |
+
**Enhanced Implementation**:
|
| 77 |
+
- **Objectives Tracking**: Like Claude playing Pokémon - tracks progress toward goals
|
| 78 |
+
- **Architectural Decisions**: Preserved during compaction
|
| 79 |
+
- **Unresolved Issues**: Tracked separately for later resolution
|
| 80 |
+
- **Structured Summary**: Organized sections (Plan, Objectives, Decisions, Issues, Facts, Notes)
|
| 81 |
+
|
| 82 |
+
**Example**:
|
| 83 |
+
```
|
| 84 |
+
## Plan
|
| 85 |
+
Multi-step plan: ...
|
| 86 |
+
|
| 87 |
+
## Objectives
|
| 88 |
+
- Objective 1: Progress (target: ...)
|
| 89 |
+
- Objective 2: Progress (target: ...)
|
| 90 |
+
|
| 91 |
+
## Architectural Decisions
|
| 92 |
+
- Decision 1
|
| 93 |
+
- Decision 2
|
| 94 |
+
|
| 95 |
+
## Unresolved Issues
|
| 96 |
+
- Issue 1
|
| 97 |
+
- Issue 2
|
| 98 |
+
```
|
| 99 |
+
|
| 100 |
+
### 5. Just-in-Time Context Loading ✅
|
| 101 |
+
**Anthropic's Approach**: Use lightweight identifiers, load data at runtime
|
| 102 |
+
|
| 103 |
+
**Implementation**:
|
| 104 |
+
- Memory selection: Only relevant memories loaded
|
| 105 |
+
- Tool selection: Only relevant tools provided
|
| 106 |
+
- Progressive disclosure: Context discovered incrementally
|
| 107 |
+
|
| 108 |
+
### 6. Context Compression Thresholds ✅
|
| 109 |
+
**Anthropic's Guidance**: Compress at 80% of context window
|
| 110 |
+
|
| 111 |
+
**Implementation**:
|
| 112 |
+
- Monitors token usage
|
| 113 |
+
- Triggers compression at 80% threshold
|
| 114 |
+
- Targets 60% after compression
|
| 115 |
+
- Uses tool result clearing first (safest), then full compaction
|
| 116 |
+
|
| 117 |
+
## Prompt Engineering Improvements
|
| 118 |
+
|
| 119 |
+
### System Prompt Structure
|
| 120 |
+
- **Right Altitude**: Balance between too specific (brittle) and too vague (ineffective)
|
| 121 |
+
- **Clear Sections**: XML tags for better organization
|
| 122 |
+
- **Minimal but Complete**: Enough information without bloat
|
| 123 |
+
|
| 124 |
+
### Tool Design
|
| 125 |
+
- **Token Efficient**: Tools return concise, relevant information
|
| 126 |
+
- **Minimal Overlap**: Clear tool boundaries
|
| 127 |
+
- **Self-Contained**: Each tool is independent and robust
|
| 128 |
+
|
| 129 |
+
### Examples (Few-Shot)
|
| 130 |
+
- **Diverse, Canonical**: Not laundry lists of edge cases
|
| 131 |
+
- **Effective Portrayal**: Examples that show expected behavior
|
| 132 |
+
- **Quality over Quantity**: Few good examples better than many mediocre ones
|
| 133 |
+
|
| 134 |
+
## Integration Points
|
| 135 |
+
|
| 136 |
+
### In `agent_orchestrator.py`:
|
| 137 |
+
|
| 138 |
+
1. **Conversation History Compression**:
|
| 139 |
+
- Checks token usage at 80% threshold
|
| 140 |
+
- Uses tool result clearing first
|
| 141 |
+
- Falls back to full compaction if needed
|
| 142 |
+
|
| 143 |
+
2. **Structured Note-Taking**:
|
| 144 |
+
- Saves plans, objectives, decisions, issues
|
| 145 |
+
- Pulls notes into prompts when relevant
|
| 146 |
+
- Preserves across compaction cycles
|
| 147 |
+
|
| 148 |
+
3. **Prompt Structure**:
|
| 149 |
+
- All prompts use XML-style sections
|
| 150 |
+
- Clear organization improves model understanding
|
| 151 |
+
- Better separation of concerns
|
| 152 |
+
|
| 153 |
+
4. **Tool Output Compression**:
|
| 154 |
+
- Automatically compresses RAG/web outputs
|
| 155 |
+
- Limits results to top 5
|
| 156 |
+
- Truncates long text fields
|
| 157 |
+
|
| 158 |
+
## Benefits
|
| 159 |
+
|
| 160 |
+
1. **Better Performance**: Structured prompts improve model understanding
|
| 161 |
+
2. **Reduced Token Usage**: Compression and clearing reduce costs
|
| 162 |
+
3. **Longer Conversations**: Compaction enables extended agent trajectories
|
| 163 |
+
4. **Better Coherence**: Structured notes maintain context across resets
|
| 164 |
+
5. **Cost Efficiency**: Fewer tokens = lower API costs
|
| 165 |
+
|
| 166 |
+
## Comparison: Before vs After
|
| 167 |
+
|
| 168 |
+
### Before:
|
| 169 |
+
- Flat prompt structure
|
| 170 |
+
- No conversation compression
|
| 171 |
+
- All tool outputs kept in context
|
| 172 |
+
- No structured note-taking
|
| 173 |
+
|
| 174 |
+
### After:
|
| 175 |
+
- XML-structured prompts
|
| 176 |
+
- Automatic compaction at 80% threshold
|
| 177 |
+
- Tool result clearing (safest compaction)
|
| 178 |
+
- Structured note-taking with objectives, decisions, issues
|
| 179 |
+
- Better context selection
|
| 180 |
+
|
| 181 |
+
## Files Modified
|
| 182 |
+
|
| 183 |
+
- `backend/api/services/context_engineer.py` - Enhanced with Anthropic strategies
|
| 184 |
+
- `backend/api/services/agent_orchestrator.py` - Integrated structured prompts and compaction
|
| 185 |
+
|
| 186 |
+
## Testing Recommendations
|
| 187 |
+
|
| 188 |
+
1. **Long Conversations**: Test with 20+ message exchanges
|
| 189 |
+
2. **Compaction**: Verify compaction preserves critical information
|
| 190 |
+
3. **Tool Clearing**: Ensure tool results are cleared appropriately
|
| 191 |
+
4. **Note-Taking**: Verify notes persist across compaction cycles
|
| 192 |
+
5. **Structured Prompts**: Test that XML structure improves responses
|
| 193 |
+
|
| 194 |
+
## Future Enhancements
|
| 195 |
+
|
| 196 |
+
1. **Fine-tuned Compaction**: Train models specifically for context compression
|
| 197 |
+
2. **Hierarchical Summarization**: Multi-level compression for very long conversations
|
| 198 |
+
3. **Embedding-based Selection**: Better memory/tool selection using embeddings
|
| 199 |
+
4. **Sub-agent Architectures**: Specialized agents with clean context windows
|
| 200 |
+
5. **Adaptive Thresholds**: Dynamic compression thresholds based on task complexity
|
| 201 |
+
|
CONTEXT_ENGINEERING_IMPLEMENTATION.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Context Engineering Implementation
|
| 2 |
+
|
| 3 |
+
## Overview
|
| 4 |
+
Implemented comprehensive context engineering strategies based on LangChain's best practices to optimize agent performance and reduce token usage.
|
| 5 |
+
|
| 6 |
+
## Four Main Strategies
|
| 7 |
+
|
| 8 |
+
### 1. Write Context ✅
|
| 9 |
+
**Purpose**: Save context outside the context window for later use.
|
| 10 |
+
|
| 11 |
+
**Implementation**:
|
| 12 |
+
- **Scratchpad**: `ContextScratchpad` class saves notes, plans, and key facts during agent execution
|
| 13 |
+
- **Plan Saving**: Agent plans are saved to scratchpad for persistence
|
| 14 |
+
- **Key Facts**: Important information extracted from responses is saved
|
| 15 |
+
- **Notes**: Categorized notes (user_query, intent, tool_execution, etc.)
|
| 16 |
+
|
| 17 |
+
**Usage in Agent**:
|
| 18 |
+
- Saves user queries to scratchpad
|
| 19 |
+
- Saves intent classifications
|
| 20 |
+
- Saves agent plans from multi-step decisions
|
| 21 |
+
- Saves key facts from LLM responses
|
| 22 |
+
|
| 23 |
+
### 2. Select Context ✅
|
| 24 |
+
**Purpose**: Pull only relevant context into the context window.
|
| 25 |
+
|
| 26 |
+
**Implementation**:
|
| 27 |
+
- **Memory Selection**: `ContextSelector.select_relevant_memories()` selects top N relevant memories
|
| 28 |
+
- **Tool Selection**: `ContextSelector.select_relevant_tools()` selects most relevant tools
|
| 29 |
+
- **Keyword-based**: Uses keyword matching (can be enhanced with embeddings)
|
| 30 |
+
|
| 31 |
+
**Usage in Agent**:
|
| 32 |
+
- Selects relevant memories before tool selection
|
| 33 |
+
- Filters conversation history to most relevant parts
|
| 34 |
+
- Can be extended for better RAG retrieval
|
| 35 |
+
|
| 36 |
+
### 3. Compress Context ✅
|
| 37 |
+
**Purpose**: Retain only necessary tokens.
|
| 38 |
+
|
| 39 |
+
**Implementation**:
|
| 40 |
+
- **Conversation Summarization**: `ContextCompressor.summarize_conversation()` summarizes long conversations
|
| 41 |
+
- **Message Trimming**: `ContextCompressor.trim_messages()` keeps first N and last M messages
|
| 42 |
+
- **Tool Output Compression**: `ContextCompressor.compress_tool_output()` reduces tool output size
|
| 43 |
+
- Limits RAG results to top 5
|
| 44 |
+
- Limits web search results to top 5
|
| 45 |
+
- Truncates long text fields
|
| 46 |
+
|
| 47 |
+
**Usage in Agent**:
|
| 48 |
+
- Compresses conversation history if > 10 messages
|
| 49 |
+
- Compresses RAG tool outputs automatically
|
| 50 |
+
- Compresses web search tool outputs automatically
|
| 51 |
+
- Summarizes middle sections of long conversations
|
| 52 |
+
|
| 53 |
+
### 4. Isolate Context ✅
|
| 54 |
+
**Purpose**: Split context to prevent token bloat.
|
| 55 |
+
|
| 56 |
+
**Implementation**:
|
| 57 |
+
- **ContextIsolator**: Stores large tool outputs separately
|
| 58 |
+
- **Reference System**: Returns references instead of full data
|
| 59 |
+
- **Automatic Cleanup**: Clears old isolated data after timeout
|
| 60 |
+
|
| 61 |
+
**Usage in Agent**:
|
| 62 |
+
- Can isolate large tool outputs (images, audio, large JSON)
|
| 63 |
+
- Prevents context window overflow
|
| 64 |
+
- Maintains references for later retrieval
|
| 65 |
+
|
| 66 |
+
## Integration Points
|
| 67 |
+
|
| 68 |
+
### In `agent_orchestrator.py`:
|
| 69 |
+
|
| 70 |
+
1. **Request Start**:
|
| 71 |
+
- Writes user query to scratchpad
|
| 72 |
+
- Compresses conversation history if needed
|
| 73 |
+
|
| 74 |
+
2. **Intent Classification**:
|
| 75 |
+
- Saves intent to scratchpad
|
| 76 |
+
|
| 77 |
+
3. **Memory Retrieval**:
|
| 78 |
+
- Selects relevant memories using context selector
|
| 79 |
+
|
| 80 |
+
4. **Tool Selection**:
|
| 81 |
+
- Saves multi-step plans to scratchpad
|
| 82 |
+
|
| 83 |
+
5. **Tool Execution**:
|
| 84 |
+
- Compresses RAG outputs
|
| 85 |
+
- Compresses web search outputs
|
| 86 |
+
- Saves key facts from responses
|
| 87 |
+
|
| 88 |
+
6. **Prompt Building**:
|
| 89 |
+
- Includes scratchpad context in prompts
|
| 90 |
+
- Adds context from previous steps
|
| 91 |
+
|
| 92 |
+
## Benefits
|
| 93 |
+
|
| 94 |
+
1. **Reduced Token Usage**: Compression and selection reduce context window usage
|
| 95 |
+
2. **Better Performance**: Relevant context improves agent accuracy
|
| 96 |
+
3. **Longer Conversations**: Summarization enables longer agent trajectories
|
| 97 |
+
4. **Cost Savings**: Fewer tokens = lower costs
|
| 98 |
+
5. **Faster Responses**: Smaller context = faster LLM calls
|
| 99 |
+
|
| 100 |
+
## Future Enhancements
|
| 101 |
+
|
| 102 |
+
1. **Embedding-based Selection**: Use embeddings for better memory/tool selection
|
| 103 |
+
2. **Hierarchical Summarization**: Multi-level summarization for very long conversations
|
| 104 |
+
3. **Fine-tuned Compression**: Train models specifically for context compression
|
| 105 |
+
4. **Knowledge Graph Integration**: Use knowledge graphs for better context selection
|
| 106 |
+
5. **Adaptive Compression**: Adjust compression based on context window usage
|
| 107 |
+
|
| 108 |
+
## Files Created
|
| 109 |
+
|
| 110 |
+
- `backend/api/services/context_engineer.py` - Main context engineering service
|
| 111 |
+
- `ContextScratchpad` - Write context
|
| 112 |
+
- `ContextCompressor` - Compress context
|
| 113 |
+
- `ContextSelector` - Select context
|
| 114 |
+
- `ContextIsolator` - Isolate context
|
| 115 |
+
- `ContextEngineer` - Main orchestrator
|
| 116 |
+
|
| 117 |
+
## Files Modified
|
| 118 |
+
|
| 119 |
+
- `backend/api/services/agent_orchestrator.py` - Integrated context engineering throughout
|
| 120 |
+
|
| 121 |
+
## Testing
|
| 122 |
+
|
| 123 |
+
Test with:
|
| 124 |
+
- Long conversations (> 10 messages)
|
| 125 |
+
- Multiple tool calls
|
| 126 |
+
- Large tool outputs
|
| 127 |
+
- Memory retrieval scenarios
|
| 128 |
+
|
KB_FIRST_IMPLEMENTATION.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# KB-First Strategy Implementation
|
| 2 |
+
|
| 3 |
+
## Overview
|
| 4 |
+
The system now implements a **Knowledge Base (KB) first, web search as fallback** strategy with enhanced safety rules.
|
| 5 |
+
|
| 6 |
+
## Key Behavior
|
| 7 |
+
|
| 8 |
+
### 1. KB-First Approach
|
| 9 |
+
- **Always check Knowledge Base first** - RAG search is performed before any other tool
|
| 10 |
+
- **Web search is ONLY a fallback** - Used when KB has no relevant information
|
| 11 |
+
- **KB is authoritative** - Knowledge Base information takes priority over web search
|
| 12 |
+
|
| 13 |
+
### 2. Safety Rules for Web Search
|
| 14 |
+
|
| 15 |
+
When web search is used as a fallback:
|
| 16 |
+
- ✅ Keep responses **short, factual, and neutral**
|
| 17 |
+
- ✅ **Limit to 2-4 sentences** for web search content
|
| 18 |
+
- ❌ Do NOT provide long legal, medical, or highly detailed professional explanations
|
| 19 |
+
- ⚠️ For legal, medical, financial, or safety topics: provide brief general explanation + recommend consulting a qualified professional
|
| 20 |
+
- 📝 Always clarify that information comes from external sources, not the Knowledge Base
|
| 21 |
+
|
| 22 |
+
### 3. Professional Disclaimers
|
| 23 |
+
|
| 24 |
+
For topics involving:
|
| 25 |
+
- Legal advice
|
| 26 |
+
- Medical advice
|
| 27 |
+
- Financial advice
|
| 28 |
+
- Safety-critical information
|
| 29 |
+
|
| 30 |
+
**Response format:**
|
| 31 |
+
> "Brief general explanation. For specific advice, please consult a qualified professional."
|
| 32 |
+
|
| 33 |
+
## Implementation Details
|
| 34 |
+
|
| 35 |
+
### Prompt Updates
|
| 36 |
+
|
| 37 |
+
1. **RAG Prompt (when KB has results)**
|
| 38 |
+
- Emphasizes KB as primary and authoritative source
|
| 39 |
+
- Clarifies that web search is supplementary only
|
| 40 |
+
|
| 41 |
+
2. **RAG Prompt (when KB has no results)**
|
| 42 |
+
- Includes rules for web search fallback
|
| 43 |
+
- Adds safety disclaimers for professional advice topics
|
| 44 |
+
|
| 45 |
+
3. **Web Search Prompt**
|
| 46 |
+
- Explicitly states KB was checked first
|
| 47 |
+
- Includes all safety rules and disclaimers
|
| 48 |
+
- Enforces 2-4 sentence limit
|
| 49 |
+
|
| 50 |
+
4. **Multi-Step Synthesis Prompt**
|
| 51 |
+
- Prioritizes KB information over web search
|
| 52 |
+
- Distinguishes between authoritative (KB) and supplementary (web) sources
|
| 53 |
+
|
| 54 |
+
### Example Test Query
|
| 55 |
+
|
| 56 |
+
**Query:** "What are the international laws regarding subletting?"
|
| 57 |
+
|
| 58 |
+
**Expected Flow:**
|
| 59 |
+
1. ✅ Check Knowledge Base first
|
| 60 |
+
2. ✅ No relevant KB information found
|
| 61 |
+
3. ✅ Trigger web search as fallback
|
| 62 |
+
4. ✅ Generate short, safe answer
|
| 63 |
+
|
| 64 |
+
**Expected Response:**
|
| 65 |
+
> "I don't have this in the knowledge base, but based on general information from the web, subletting laws differ widely by country. For specific legal advice, please consult a local authority or legal professional."
|
| 66 |
+
|
| 67 |
+
## Safety Features
|
| 68 |
+
|
| 69 |
+
- ✅ Professional advice disclaimers
|
| 70 |
+
- ✅ Source distinction (KB vs web)
|
| 71 |
+
- ✅ Response length limits for web content
|
| 72 |
+
- ✅ Clear messaging about fallback behavior
|
| 73 |
+
|
| 74 |
+
## Configuration
|
| 75 |
+
|
| 76 |
+
All rules are built into the prompt templates in:
|
| 77 |
+
- `backend/api/services/agent_orchestrator.py`
|
| 78 |
+
- `_build_prompt_with_rag()`
|
| 79 |
+
- `_build_prompt_with_web()`
|
| 80 |
+
- `_execute_multi_step()` (multi-step synthesis)
|
| 81 |
+
|
app.py
CHANGED
|
@@ -2123,7 +2123,11 @@ with gr.Blocks(
|
|
| 2123 |
visible=False
|
| 2124 |
)
|
| 2125 |
|
| 2126 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2127 |
|
| 2128 |
with kb_library_content:
|
| 2129 |
gr.Markdown(
|
|
@@ -2313,11 +2317,13 @@ with gr.Blocks(
|
|
| 2313 |
|
| 2314 |
# Update visibility when role changes
|
| 2315 |
def update_kb_full_visibility(role):
|
| 2316 |
-
|
| 2317 |
-
|
|
|
|
|
|
|
| 2318 |
return (
|
| 2319 |
gr.update(visible=is_editor), # Access denied for Editor
|
| 2320 |
-
gr.update(visible=not is_editor), # KB content for Owner/Admin
|
| 2321 |
gr.update(visible=can_delete), # Delete all button
|
| 2322 |
gr.update(visible=can_delete), # Delete section
|
| 2323 |
)
|
|
|
|
| 2123 |
visible=False
|
| 2124 |
)
|
| 2125 |
|
| 2126 |
+
# Set initial visibility based on default role
|
| 2127 |
+
# Editor should NOT see Knowledge Base Library content
|
| 2128 |
+
initial_is_editor = (DEFAULT_ROLE or "").lower().strip() == "editor"
|
| 2129 |
+
kb_access_denied.visible = initial_is_editor # Show access denied for editor
|
| 2130 |
+
kb_library_content = gr.Column(visible=not initial_is_editor)
|
| 2131 |
|
| 2132 |
with kb_library_content:
|
| 2133 |
gr.Markdown(
|
|
|
|
| 2317 |
|
| 2318 |
# Update visibility when role changes
|
| 2319 |
def update_kb_full_visibility(role):
|
| 2320 |
+
# Normalize role to lowercase for comparison
|
| 2321 |
+
role_lower = (role or DEFAULT_ROLE).lower().strip()
|
| 2322 |
+
is_editor = role_lower == "editor"
|
| 2323 |
+
can_delete = can_delete_documents(role_lower)
|
| 2324 |
return (
|
| 2325 |
gr.update(visible=is_editor), # Access denied for Editor
|
| 2326 |
+
gr.update(visible=not is_editor), # KB content for Owner/Admin/Viewer
|
| 2327 |
gr.update(visible=can_delete), # Delete all button
|
| 2328 |
gr.update(visible=can_delete), # Delete section
|
| 2329 |
)
|
backend/api/services/agent_orchestrator.py
CHANGED
|
@@ -29,6 +29,7 @@ from .result_merger import merge_parallel_results, format_merged_context_for_pro
|
|
| 29 |
from .tool_metadata import validate_tool_output, get_tool_schema
|
| 30 |
from .query_cache import get_cache
|
| 31 |
from .query_expander import QueryExpander
|
|
|
|
| 32 |
import time
|
| 33 |
|
| 34 |
logger = logging.getLogger(__name__)
|
|
@@ -55,6 +56,7 @@ class AgentOrchestrator:
|
|
| 55 |
self.tool_scorer = ToolScoringService()
|
| 56 |
self.query_expander = QueryExpander(llm_client=self.llm)
|
| 57 |
self.cache = get_cache()
|
|
|
|
| 58 |
|
| 59 |
self._analytics: Optional[AnalyticsStore] = None
|
| 60 |
self._analytics_disabled = os.getenv("ANALYTICS_DISABLED", "").lower() in {"1", "true", "yes"}
|
|
@@ -158,6 +160,12 @@ class AgentOrchestrator:
|
|
| 158 |
"message_preview": req.message[:120]
|
| 159 |
})
|
| 160 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 161 |
# Check cache first (skip for admin queries and rule checks)
|
| 162 |
cached_response = self.cache.get(req.message, req.tenant_id)
|
| 163 |
if cached_response:
|
|
@@ -491,12 +499,43 @@ Answer:"""
|
|
| 491 |
})
|
| 492 |
|
| 493 |
# 3) Tool selection (hybrid) - pass RAG results, memory, and admin violations in context
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 494 |
# Get recent memory for context-aware routing
|
| 495 |
from backend.mcp_server.common.memory import get_recent
|
| 496 |
session_id = req.conversation_history[-1].get("session_id") if req.conversation_history else None
|
| 497 |
recent_memory = []
|
| 498 |
if session_id:
|
| 499 |
recent_memory = get_recent(session_id)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 500 |
|
| 501 |
# Get admin violations if any
|
| 502 |
admin_violations = []
|
|
@@ -605,6 +644,10 @@ Answer:"""
|
|
| 605 |
|
| 606 |
# Validate and format RAG output to conform to schema
|
| 607 |
rag_formatted = self._format_tool_output("rag", rag_resp, rag_latency_ms)
|
|
|
|
|
|
|
|
|
|
|
|
|
| 608 |
tool_traces.append({"tool": "rag", "response": rag_formatted})
|
| 609 |
hits = self._extract_hits(rag_formatted)
|
| 610 |
|
|
@@ -688,6 +731,10 @@ Answer:"""
|
|
| 688 |
|
| 689 |
# Validate and format Web output to conform to schema
|
| 690 |
web_formatted = self._format_tool_output("web", web_resp, web_latency_ms)
|
|
|
|
|
|
|
|
|
|
|
|
|
| 691 |
tool_traces.append({"tool": "web", "response": web_formatted})
|
| 692 |
hits_count = len(self._extract_hits(web_formatted))
|
| 693 |
|
|
@@ -830,6 +877,10 @@ Answer:"""
|
|
| 830 |
tools_used.append("web")
|
| 831 |
|
| 832 |
web_formatted = self._format_tool_output("web", web_resp, web_latency_ms)
|
|
|
|
|
|
|
|
|
|
|
|
|
| 833 |
tool_traces.append({"tool": "web", "response": web_formatted})
|
| 834 |
hits_count = len(self._extract_hits(web_formatted))
|
| 835 |
|
|
@@ -1171,6 +1222,10 @@ Answer:"""
|
|
| 1171 |
tools_used.append("web")
|
| 1172 |
|
| 1173 |
web_formatted = self._format_tool_output("web", web_resp, web_latency_ms)
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1174 |
tool_traces.append({"tool": "web", "response": web_formatted})
|
| 1175 |
hits_count = len(self._extract_hits(web_formatted))
|
| 1176 |
|
|
@@ -1334,28 +1389,58 @@ Answer:"""
|
|
| 1334 |
f"## User Question\n{req.message}\n\n"
|
| 1335 |
f"## Context\n"
|
| 1336 |
f"No relevant documents were found in the knowledge base for this question.\n\n"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1337 |
f"## Your Task\n"
|
| 1338 |
-
f"
|
| 1339 |
-
f"
|
| 1340 |
-
f"acknowledge that and provide general guidance."
|
|
|
|
| 1341 |
)
|
| 1342 |
else:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1343 |
prompt = (
|
|
|
|
| 1344 |
f"You are an assistant helping tenant {req.tenant_id}. "
|
| 1345 |
-
f"Your goal is to provide the most accurate, comprehensive, and helpful answer possible.\n
|
| 1346 |
-
f"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1347 |
f"The following documents were retrieved from the tenant's knowledge base as relevant to the user's question:\n\n"
|
| 1348 |
f"{snippet_text}\n\n"
|
| 1349 |
f"{'## Relevance Scores\n' + scores_text + '\n\n' if scores_text else ''}"
|
| 1350 |
-
f"
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1351 |
f"## Your Task\n"
|
| 1352 |
f"1. **Primary Goal**: Answer the user's question using the information from the knowledge base documents above.\n"
|
| 1353 |
-
f"2. **
|
| 1354 |
-
f"3. **
|
| 1355 |
-
f"4. **
|
| 1356 |
-
f"5. **
|
| 1357 |
-
f"6. **
|
| 1358 |
-
f"7. **
|
|
|
|
|
|
|
| 1359 |
f"Provide your answer now:"
|
| 1360 |
)
|
| 1361 |
return prompt
|
|
@@ -1758,23 +1843,72 @@ Answer:"""
|
|
| 1758 |
|
| 1759 |
# Otherwise, build the normal multi-step synthesis prompt.
|
| 1760 |
if data_section:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1761 |
prompt = (
|
|
|
|
| 1762 |
f"You are an assistant helping tenant {req.tenant_id}. "
|
| 1763 |
-
f"Your goal is to provide the most accurate, comprehensive, and helpful answer possible.\n
|
| 1764 |
-
f"
|
| 1765 |
-
f"
|
| 1766 |
-
f"{
|
| 1767 |
-
f"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1768 |
f"## Your Task\n"
|
| 1769 |
f"1. **Primary Goal**: Use the information above to directly and completely address the user's request.\n"
|
| 1770 |
-
f"2. **
|
| 1771 |
-
f"3. **
|
| 1772 |
-
f"4. **
|
| 1773 |
-
f"5. **
|
| 1774 |
-
f"6. **
|
| 1775 |
-
f"7. **
|
| 1776 |
-
f"8. **
|
| 1777 |
-
f"9. **
|
|
|
|
|
|
|
|
|
|
| 1778 |
f"If the information is incomplete, explain what can and cannot be concluded from the available data. "
|
| 1779 |
f"Focus on giving the user exactly what they need—clear guidance, accurate facts, and practical steps whenever possible.\n\n"
|
| 1780 |
f"Provide your comprehensive answer now:"
|
|
@@ -2353,24 +2487,42 @@ Rewritten message:"""
|
|
| 2353 |
f"acknowledge that and provide general guidance."
|
| 2354 |
)
|
| 2355 |
else:
|
|
|
|
| 2356 |
prompt = (
|
| 2357 |
-
f"
|
| 2358 |
-
f"
|
| 2359 |
-
f"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2360 |
f"The following search results were found for the user's question:\n\n"
|
| 2361 |
-
f"{snippet_text}\n
|
| 2362 |
-
f"
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2363 |
f"## Your Task\n"
|
| 2364 |
-
f"1. **Primary Goal**:
|
| 2365 |
-
f"2. **
|
| 2366 |
-
f"3. **
|
| 2367 |
-
f"4. **
|
| 2368 |
-
f"
|
| 2369 |
-
f"
|
| 2370 |
-
f"
|
| 2371 |
-
f"
|
| 2372 |
-
f"
|
| 2373 |
-
f"Provide your answer now:"
|
| 2374 |
)
|
| 2375 |
|
| 2376 |
return prompt
|
|
|
|
| 29 |
from .tool_metadata import validate_tool_output, get_tool_schema
|
| 30 |
from .query_cache import get_cache
|
| 31 |
from .query_expander import QueryExpander
|
| 32 |
+
from .context_engineer import ContextEngineer
|
| 33 |
import time
|
| 34 |
|
| 35 |
logger = logging.getLogger(__name__)
|
|
|
|
| 56 |
self.tool_scorer = ToolScoringService()
|
| 57 |
self.query_expander = QueryExpander(llm_client=self.llm)
|
| 58 |
self.cache = get_cache()
|
| 59 |
+
self.context_engineer = ContextEngineer(llm_client=self.llm)
|
| 60 |
|
| 61 |
self._analytics: Optional[AnalyticsStore] = None
|
| 62 |
self._analytics_disabled = os.getenv("ANALYTICS_DISABLED", "").lower() in {"1", "true", "yes"}
|
|
|
|
| 160 |
"message_preview": req.message[:120]
|
| 161 |
})
|
| 162 |
|
| 163 |
+
# Context Engineering: Write to scratchpad
|
| 164 |
+
self.context_engineer.write_to_scratchpad(
|
| 165 |
+
f"User query: {req.message[:200]}",
|
| 166 |
+
category="user_query"
|
| 167 |
+
)
|
| 168 |
+
|
| 169 |
# Check cache first (skip for admin queries and rule checks)
|
| 170 |
cached_response = self.cache.get(req.message, req.tenant_id)
|
| 171 |
if cached_response:
|
|
|
|
| 499 |
})
|
| 500 |
|
| 501 |
# 3) Tool selection (hybrid) - pass RAG results, memory, and admin violations in context
|
| 502 |
+
# Context Engineering: Compress conversation history if too long (Anthropic's compaction)
|
| 503 |
+
# Use tool result clearing first (safest), then full compaction if needed
|
| 504 |
+
if req.conversation_history and len(req.conversation_history) > 10:
|
| 505 |
+
# Check token usage
|
| 506 |
+
total_chars = sum(len(str(m.get("content", ""))) for m in req.conversation_history)
|
| 507 |
+
estimated_tokens = total_chars // 4
|
| 508 |
+
|
| 509 |
+
# Compress if approaching context limit (80% threshold)
|
| 510 |
+
if estimated_tokens > 8000: # ~80% of typical 10k context
|
| 511 |
+
compressed_history = await self.context_engineer.compress_if_needed(
|
| 512 |
+
req.conversation_history,
|
| 513 |
+
max_tokens=6000, # Target 60% after compression
|
| 514 |
+
use_compaction=True
|
| 515 |
+
)
|
| 516 |
+
req.conversation_history = compressed_history
|
| 517 |
+
reasoning_trace.append({
|
| 518 |
+
"step": "context_compaction",
|
| 519 |
+
"original_length": len(req.conversation_history),
|
| 520 |
+
"compressed_length": len(compressed_history),
|
| 521 |
+
"compressed": len(compressed_history) < len(req.conversation_history),
|
| 522 |
+
"strategy": "anthropic_compaction"
|
| 523 |
+
})
|
| 524 |
+
|
| 525 |
# Get recent memory for context-aware routing
|
| 526 |
from backend.mcp_server.common.memory import get_recent
|
| 527 |
session_id = req.conversation_history[-1].get("session_id") if req.conversation_history else None
|
| 528 |
recent_memory = []
|
| 529 |
if session_id:
|
| 530 |
recent_memory = get_recent(session_id)
|
| 531 |
+
|
| 532 |
+
# Context Engineering: Select relevant memories
|
| 533 |
+
if recent_memory:
|
| 534 |
+
selected_memories = await self.context_engineer.select_context(
|
| 535 |
+
req.message,
|
| 536 |
+
{"memories": recent_memory}
|
| 537 |
+
)
|
| 538 |
+
recent_memory = selected_memories.get("memories", recent_memory)
|
| 539 |
|
| 540 |
# Get admin violations if any
|
| 541 |
admin_violations = []
|
|
|
|
| 644 |
|
| 645 |
# Validate and format RAG output to conform to schema
|
| 646 |
rag_formatted = self._format_tool_output("rag", rag_resp, rag_latency_ms)
|
| 647 |
+
|
| 648 |
+
# Context Engineering: Compress tool output if needed
|
| 649 |
+
rag_formatted = await self.context_engineer.compressor.compress_tool_output("rag", rag_formatted)
|
| 650 |
+
|
| 651 |
tool_traces.append({"tool": "rag", "response": rag_formatted})
|
| 652 |
hits = self._extract_hits(rag_formatted)
|
| 653 |
|
|
|
|
| 731 |
|
| 732 |
# Validate and format Web output to conform to schema
|
| 733 |
web_formatted = self._format_tool_output("web", web_resp, web_latency_ms)
|
| 734 |
+
|
| 735 |
+
# Context Engineering: Compress tool output if needed
|
| 736 |
+
web_formatted = await self.context_engineer.compressor.compress_tool_output("web", web_formatted)
|
| 737 |
+
|
| 738 |
tool_traces.append({"tool": "web", "response": web_formatted})
|
| 739 |
hits_count = len(self._extract_hits(web_formatted))
|
| 740 |
|
|
|
|
| 877 |
tools_used.append("web")
|
| 878 |
|
| 879 |
web_formatted = self._format_tool_output("web", web_resp, web_latency_ms)
|
| 880 |
+
|
| 881 |
+
# Context Engineering: Compress tool output if needed
|
| 882 |
+
web_formatted = await self.context_engineer.compressor.compress_tool_output("web", web_formatted)
|
| 883 |
+
|
| 884 |
tool_traces.append({"tool": "web", "response": web_formatted})
|
| 885 |
hits_count = len(self._extract_hits(web_formatted))
|
| 886 |
|
|
|
|
| 1222 |
tools_used.append("web")
|
| 1223 |
|
| 1224 |
web_formatted = self._format_tool_output("web", web_resp, web_latency_ms)
|
| 1225 |
+
|
| 1226 |
+
# Context Engineering: Compress tool output if needed
|
| 1227 |
+
web_formatted = await self.context_engineer.compressor.compress_tool_output("web", web_formatted)
|
| 1228 |
+
|
| 1229 |
tool_traces.append({"tool": "web", "response": web_formatted})
|
| 1230 |
hits_count = len(self._extract_hits(web_formatted))
|
| 1231 |
|
|
|
|
| 1389 |
f"## User Question\n{req.message}\n\n"
|
| 1390 |
f"## Context\n"
|
| 1391 |
f"No relevant documents were found in the knowledge base for this question.\n\n"
|
| 1392 |
+
f"## Important Rules\n"
|
| 1393 |
+
f"If the user asks a question that cannot be answered directly from the Knowledge Base, "
|
| 1394 |
+
f"then and ONLY then use the web-search tool to gather information. "
|
| 1395 |
+
f"When using web search, keep the response short, factual, and neutral. "
|
| 1396 |
+
f"Do NOT provide long legal, medical, or highly detailed professional explanations. "
|
| 1397 |
+
f"If the topic involves legal, medical, financial, or safety-critical advice, provide a brief general explanation "
|
| 1398 |
+
f"and tell the user to consult a qualified professional. "
|
| 1399 |
+
f"Never present external information as part of the official Knowledge Base.\n\n"
|
| 1400 |
f"## Your Task\n"
|
| 1401 |
+
f"Since no Knowledge Base documents were found, you may use web search as a fallback if needed. "
|
| 1402 |
+
f"Provide a brief, helpful answer. If you're uncertain about tenant-specific details, "
|
| 1403 |
+
f"acknowledge that and provide general guidance. "
|
| 1404 |
+
f"For legal, medical, financial, or safety-critical topics, keep responses brief and recommend consulting a professional."
|
| 1405 |
)
|
| 1406 |
else:
|
| 1407 |
+
# Context Engineering: Get structured scratchpad context (Anthropic's note-taking)
|
| 1408 |
+
scratchpad_context = self.context_engineer.get_scratchpad_context(limit=5)
|
| 1409 |
+
scratchpad_section = f"\n## Structured Notes from Previous Steps\n{scratchpad_context}\n\n" if scratchpad_context else ""
|
| 1410 |
+
|
| 1411 |
+
# Build prompt with Anthropic's recommended structure
|
| 1412 |
+
# Clear sections with XML/Markdown headers for better organization
|
| 1413 |
prompt = (
|
| 1414 |
+
f"<system>\n"
|
| 1415 |
f"You are an assistant helping tenant {req.tenant_id}. "
|
| 1416 |
+
f"Your goal is to provide the most accurate, comprehensive, and helpful answer possible.\n"
|
| 1417 |
+
f"</system>\n\n"
|
| 1418 |
+
f"<background_information>\n"
|
| 1419 |
+
f"## KB-First Strategy\n"
|
| 1420 |
+
f"The Knowledge Base was checked first and relevant documents were found. "
|
| 1421 |
+
f"Use these documents as your PRIMARY and AUTHORITATIVE source. "
|
| 1422 |
+
f"Web search should ONLY be used as a fallback if the Knowledge Base cannot answer the question.\n"
|
| 1423 |
+
f"{scratchpad_section}"
|
| 1424 |
+
f"</background_information>\n\n"
|
| 1425 |
+
f"<knowledge_base_documents>\n"
|
| 1426 |
f"The following documents were retrieved from the tenant's knowledge base as relevant to the user's question:\n\n"
|
| 1427 |
f"{snippet_text}\n\n"
|
| 1428 |
f"{'## Relevance Scores\n' + scores_text + '\n\n' if scores_text else ''}"
|
| 1429 |
+
f"</knowledge_base_documents>\n\n"
|
| 1430 |
+
f"<user_question>\n"
|
| 1431 |
+
f"{req.message}\n"
|
| 1432 |
+
f"</user_question>\n\n"
|
| 1433 |
+
f"<instructions>\n"
|
| 1434 |
f"## Your Task\n"
|
| 1435 |
f"1. **Primary Goal**: Answer the user's question using the information from the knowledge base documents above.\n"
|
| 1436 |
+
f"2. **KB Priority**: Base your answer PRIMARILY on the Knowledge Base. This is the authoritative source for tenant-specific information.\n"
|
| 1437 |
+
f"3. **Accuracy**: Base your answer primarily on the highest-scoring sources (most relevant documents).\n"
|
| 1438 |
+
f"4. **Comprehensiveness**: If multiple sources provide complementary information, synthesize them into a complete answer.\n"
|
| 1439 |
+
f"5. **Citation**: When referencing specific information, indicate which source(s) you used (e.g., 'According to Source 1...' or 'Sources 1 and 2 indicate...').\n"
|
| 1440 |
+
f"6. **Completeness**: If the documents don't fully answer the question, clearly state what information is available and what is missing.\n"
|
| 1441 |
+
f"7. **Clarity**: Write in a clear, professional, and easy-to-understand manner.\n"
|
| 1442 |
+
f"8. **Directness**: Get straight to the point - provide the answer the user needs without unnecessary preamble.\n"
|
| 1443 |
+
f"</instructions>\n\n"
|
| 1444 |
f"Provide your answer now:"
|
| 1445 |
)
|
| 1446 |
return prompt
|
|
|
|
| 1843 |
|
| 1844 |
# Otherwise, build the normal multi-step synthesis prompt.
|
| 1845 |
if data_section:
|
| 1846 |
+
# Check if we have both RAG and web data
|
| 1847 |
+
has_rag = "[RAG]" in data_section
|
| 1848 |
+
has_web = "[WEB]" in data_section
|
| 1849 |
+
|
| 1850 |
+
kb_first_note = ""
|
| 1851 |
+
web_fallback_note = ""
|
| 1852 |
+
if has_rag and has_web:
|
| 1853 |
+
kb_first_note = (
|
| 1854 |
+
f"\n## KB-First Strategy\n"
|
| 1855 |
+
f"**Knowledge Base (RAG) was checked FIRST** and found relevant information. "
|
| 1856 |
+
f"This is the PRIMARY and AUTHORITATIVE source. "
|
| 1857 |
+
f"Web search results are provided as supplementary information only. "
|
| 1858 |
+
f"Prioritize Knowledge Base information over web search results.\n\n"
|
| 1859 |
+
)
|
| 1860 |
+
web_fallback_note = (
|
| 1861 |
+
f"\n## Web Search Rules\n"
|
| 1862 |
+
f"When using web search information as supplementary data:\n"
|
| 1863 |
+
f"- Keep web search details brief and factual\n"
|
| 1864 |
+
f"- For legal, medical, financial, or safety topics, add: 'For specific advice, consult a qualified professional.'\n"
|
| 1865 |
+
f"- Clearly distinguish between Knowledge Base (authoritative) and web search (supplementary) information\n\n"
|
| 1866 |
+
)
|
| 1867 |
+
elif has_web and not has_rag:
|
| 1868 |
+
kb_first_note = (
|
| 1869 |
+
f"\n## KB-First Strategy\n"
|
| 1870 |
+
f"The Knowledge Base was checked FIRST but no relevant information was found. "
|
| 1871 |
+
f"Web search results below are provided as a FALLBACK. "
|
| 1872 |
+
f"Keep the response short, factual, and neutral. "
|
| 1873 |
+
f"For legal, medical, financial, or safety topics, recommend consulting a qualified professional.\n\n"
|
| 1874 |
+
)
|
| 1875 |
+
|
| 1876 |
+
# Get structured scratchpad context (Anthropic's note-taking)
|
| 1877 |
+
scratchpad_context = self.context_engineer.get_scratchpad_context(limit=5)
|
| 1878 |
+
scratchpad_section = f"\n## Structured Notes\n{scratchpad_context}\n" if scratchpad_context else ""
|
| 1879 |
+
|
| 1880 |
+
# Build prompt with Anthropic's structured format (XML-style sections)
|
| 1881 |
prompt = (
|
| 1882 |
+
f"<system>\n"
|
| 1883 |
f"You are an assistant helping tenant {req.tenant_id}. "
|
| 1884 |
+
f"Your goal is to provide the most accurate, comprehensive, and helpful answer possible.\n"
|
| 1885 |
+
f"</system>\n\n"
|
| 1886 |
+
f"<background_information>\n"
|
| 1887 |
+
f"{kb_first_note.strip()}"
|
| 1888 |
+
f"{scratchpad_section}"
|
| 1889 |
+
f"</background_information>\n\n"
|
| 1890 |
+
f"<information_collected>\n"
|
| 1891 |
+
f"The following details have been gathered from reliable sources:\n\n"
|
| 1892 |
+
f"{data_section}\n"
|
| 1893 |
+
f"</information_collected>\n\n"
|
| 1894 |
+
f"{f'<web_search_guidance>\n{web_fallback_note.strip()}\n</web_search_guidance>\n\n' if web_fallback_note else ''}"
|
| 1895 |
+
f"<user_request>\n"
|
| 1896 |
+
f"{req.message}\n"
|
| 1897 |
+
f"</user_request>\n\n"
|
| 1898 |
+
f"<instructions>\n"
|
| 1899 |
f"## Your Task\n"
|
| 1900 |
f"1. **Primary Goal**: Use the information above to directly and completely address the user's request.\n"
|
| 1901 |
+
f"2. **Source Priority**: {'If both Knowledge Base (RAG) and web search results are present, prioritize Knowledge Base as the authoritative source. ' if has_rag and has_web else ''}Use web search information only to supplement or when KB has no relevant information.\n"
|
| 1902 |
+
f"3. **Synthesis**: Combine information from different sources when they provide complementary details.\n"
|
| 1903 |
+
f"4. **Prioritization**: If sources conflict, prioritize Knowledge Base information over web search results.\n"
|
| 1904 |
+
f"5. **Completeness**: Provide a comprehensive answer that covers all aspects of the user's question.\n"
|
| 1905 |
+
f"6. **Accuracy**: Base your answer on the provided information. If information is missing or uncertain, clearly state that.\n"
|
| 1906 |
+
f"7. **Clarity**: Write in a clear, professional, and easy-to-understand manner.\n"
|
| 1907 |
+
f"8. **Directness**: Get straight to the point - provide the answer the user needs without unnecessary preamble.\n"
|
| 1908 |
+
f"9. **Actionability**: If the question requires steps or actions, provide clear, actionable guidance.\n"
|
| 1909 |
+
f"10. **Citation**: When referencing specific sources, indicate which source(s) you used (e.g., '[RAG]', '[WEB]').\n"
|
| 1910 |
+
f"{'11. **Brief Web Content**: If using web search, keep that portion of the response brief (2-4 sentences). Add professional disclaimers for legal/medical/financial topics.\n' if has_web else ''}"
|
| 1911 |
+
f"</instructions>\n\n"
|
| 1912 |
f"If the information is incomplete, explain what can and cannot be concluded from the available data. "
|
| 1913 |
f"Focus on giving the user exactly what they need—clear guidance, accurate facts, and practical steps whenever possible.\n\n"
|
| 1914 |
f"Provide your comprehensive answer now:"
|
|
|
|
| 2487 |
f"acknowledge that and provide general guidance."
|
| 2488 |
)
|
| 2489 |
else:
|
| 2490 |
+
# Build prompt with Anthropic's recommended structure (clear sections with XML tags)
|
| 2491 |
prompt = (
|
| 2492 |
+
f"<system>\n"
|
| 2493 |
+
f"You are an assistant helping tenant {req.tenant_id}. "
|
| 2494 |
+
f"The Knowledge Base was checked first but no relevant information was found. "
|
| 2495 |
+
f"Web search results are provided below as a fallback.\n"
|
| 2496 |
+
f"</system>\n\n"
|
| 2497 |
+
f"<background_information>\n"
|
| 2498 |
+
f"## Important Rules for Web Search Responses\n"
|
| 2499 |
+
f"1. **KB-First Approach**: Always check Knowledge Base first. Web search is ONLY a fallback when KB has no relevant information.\n"
|
| 2500 |
+
f"2. **Keep it Short**: When using web search, keep responses short, factual, and neutral. Do NOT provide long explanations.\n"
|
| 2501 |
+
f"3. **No Professional Advice**: Do NOT provide long legal, medical, or highly detailed professional explanations. "
|
| 2502 |
+
f"If the topic involves legal, medical, financial, or safety-critical advice, provide a brief general explanation "
|
| 2503 |
+
f"and tell the user to consult a qualified professional.\n"
|
| 2504 |
+
f"4. **Clear Source Distinction**: Never present external web search information as part of the official Knowledge Base. "
|
| 2505 |
+
f"Always clarify that this information comes from external sources.\n"
|
| 2506 |
+
f"5. **Safety First**: For safety-critical topics, always recommend consulting qualified professionals.\n"
|
| 2507 |
+
f"</background_information>\n\n"
|
| 2508 |
+
f"<web_search_results>\n"
|
| 2509 |
f"The following search results were found for the user's question:\n\n"
|
| 2510 |
+
f"{snippet_text}\n"
|
| 2511 |
+
f"</web_search_results>\n\n"
|
| 2512 |
+
f"<user_question>\n"
|
| 2513 |
+
f"{req.message}\n"
|
| 2514 |
+
f"</user_question>\n\n"
|
| 2515 |
+
f"<instructions>\n"
|
| 2516 |
f"## Your Task\n"
|
| 2517 |
+
f"1. **Primary Goal**: Provide a short, factual answer using the web search results above.\n"
|
| 2518 |
+
f"2. **Keep it Brief**: Limit your response to 2-4 sentences. Do NOT provide lengthy explanations.\n"
|
| 2519 |
+
f"3. **Accuracy**: Prioritize information from authoritative sources (recognized websites, official sources, etc.).\n"
|
| 2520 |
+
f"4. **Professional Disclaimers**: For legal, medical, financial, or safety topics, include: "
|
| 2521 |
+
f"'For specific advice, please consult a qualified professional.'\n"
|
| 2522 |
+
f"5. **Source Clarity**: Start by mentioning this information comes from web search, not the Knowledge Base.\n"
|
| 2523 |
+
f"6. **Citation**: Briefly indicate which source(s) you used.\n"
|
| 2524 |
+
f"</instructions>\n\n"
|
| 2525 |
+
f"Provide a short, helpful answer now:"
|
|
|
|
| 2526 |
)
|
| 2527 |
|
| 2528 |
return prompt
|
backend/api/services/context_engineer.py
ADDED
|
@@ -0,0 +1,512 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# =============================================================
|
| 2 |
+
# File: backend/api/services/context_engineer.py
|
| 3 |
+
# =============================================================
|
| 4 |
+
"""
|
| 5 |
+
Context Engineering Service
|
| 6 |
+
Implements write, select, compress, and isolate strategies for managing agent context.
|
| 7 |
+
Based on LangChain's context engineering best practices.
|
| 8 |
+
"""
|
| 9 |
+
|
| 10 |
+
import time
|
| 11 |
+
from typing import Dict, Any, List, Optional
|
| 12 |
+
from collections import deque
|
| 13 |
+
|
| 14 |
+
|
| 15 |
+
class ContextScratchpad:
|
| 16 |
+
"""Scratchpad for saving context during agent execution.
|
| 17 |
+
|
| 18 |
+
Based on Anthropic's structured note-taking strategy:
|
| 19 |
+
- Agents write notes persisted outside context window
|
| 20 |
+
- Notes pulled back into context when needed
|
| 21 |
+
- Enables tracking progress across complex tasks
|
| 22 |
+
"""
|
| 23 |
+
|
| 24 |
+
def __init__(self, max_size: int = 50):
|
| 25 |
+
self.notes: deque = deque(maxlen=max_size)
|
| 26 |
+
self.plan: Optional[str] = None
|
| 27 |
+
self.key_facts: List[str] = []
|
| 28 |
+
self.objectives: List[Dict[str, Any]] = [] # Track objectives like Claude playing Pokémon
|
| 29 |
+
self.architectural_decisions: List[str] = [] # Track design decisions
|
| 30 |
+
self.unresolved_issues: List[str] = [] # Track bugs/issues
|
| 31 |
+
|
| 32 |
+
def add_note(self, note: str, category: str = "general"):
|
| 33 |
+
"""Add a note to the scratchpad."""
|
| 34 |
+
self.notes.append({
|
| 35 |
+
"timestamp": time.time(),
|
| 36 |
+
"note": note,
|
| 37 |
+
"category": category
|
| 38 |
+
})
|
| 39 |
+
|
| 40 |
+
def set_plan(self, plan: str):
|
| 41 |
+
"""Save the agent's plan."""
|
| 42 |
+
self.plan = plan
|
| 43 |
+
|
| 44 |
+
def add_fact(self, fact: str):
|
| 45 |
+
"""Add a key fact."""
|
| 46 |
+
if fact not in self.key_facts:
|
| 47 |
+
self.key_facts.append(fact)
|
| 48 |
+
if len(self.key_facts) > 20: # Limit facts
|
| 49 |
+
self.key_facts.pop(0)
|
| 50 |
+
|
| 51 |
+
def get_recent_notes(self, limit: int = 10, category: Optional[str] = None) -> List[str]:
|
| 52 |
+
"""Get recent notes, optionally filtered by category."""
|
| 53 |
+
notes = list(self.notes)
|
| 54 |
+
if category:
|
| 55 |
+
notes = [n for n in notes if n.get("category") == category]
|
| 56 |
+
return [n["note"] for n in notes[-limit:]]
|
| 57 |
+
|
| 58 |
+
def add_objective(self, objective: str, progress: str = "", target: str = ""):
|
| 59 |
+
"""Add or update an objective (like Claude playing Pokémon tracking)."""
|
| 60 |
+
# Update existing or add new
|
| 61 |
+
for obj in self.objectives:
|
| 62 |
+
if objective in obj.get("objective", ""):
|
| 63 |
+
obj["progress"] = progress
|
| 64 |
+
obj["target"] = target
|
| 65 |
+
return
|
| 66 |
+
self.objectives.append({
|
| 67 |
+
"objective": objective,
|
| 68 |
+
"progress": progress,
|
| 69 |
+
"target": target
|
| 70 |
+
})
|
| 71 |
+
if len(self.objectives) > 10:
|
| 72 |
+
self.objectives.pop(0)
|
| 73 |
+
|
| 74 |
+
def add_architectural_decision(self, decision: str):
|
| 75 |
+
"""Add an architectural decision (preserved during compaction)."""
|
| 76 |
+
if decision not in self.architectural_decisions:
|
| 77 |
+
self.architectural_decisions.append(decision)
|
| 78 |
+
if len(self.architectural_decisions) > 10:
|
| 79 |
+
self.architectural_decisions.pop(0)
|
| 80 |
+
|
| 81 |
+
def add_unresolved_issue(self, issue: str):
|
| 82 |
+
"""Add an unresolved issue (preserved during compaction)."""
|
| 83 |
+
if issue not in self.unresolved_issues:
|
| 84 |
+
self.unresolved_issues.append(issue)
|
| 85 |
+
if len(self.unresolved_issues) > 10:
|
| 86 |
+
self.unresolved_issues.pop(0)
|
| 87 |
+
|
| 88 |
+
def get_summary(self) -> str:
|
| 89 |
+
"""Get a structured summary of scratchpad contents.
|
| 90 |
+
Based on Anthropic's structured note-taking approach."""
|
| 91 |
+
parts = []
|
| 92 |
+
if self.plan:
|
| 93 |
+
parts.append(f"## Plan\n{self.plan}")
|
| 94 |
+
if self.objectives:
|
| 95 |
+
obj_text = "\n".join([f"- {o['objective']}: {o.get('progress', '')} (target: {o.get('target', 'N/A')})"
|
| 96 |
+
for o in self.objectives[-5:]])
|
| 97 |
+
parts.append(f"## Objectives\n{obj_text}")
|
| 98 |
+
if self.architectural_decisions:
|
| 99 |
+
parts.append(f"## Architectural Decisions\n" + "\n".join([f"- {d}" for d in self.architectural_decisions[-5:]]))
|
| 100 |
+
if self.unresolved_issues:
|
| 101 |
+
parts.append(f"## Unresolved Issues\n" + "\n".join([f"- {i}" for i in self.unresolved_issues[-5:]]))
|
| 102 |
+
if self.key_facts:
|
| 103 |
+
parts.append(f"## Key Facts\n" + ", ".join(self.key_facts[:5]))
|
| 104 |
+
if self.notes:
|
| 105 |
+
recent = self.get_recent_notes(5)
|
| 106 |
+
parts.append(f"## Recent Notes\n" + "\n".join([f"- {n}" for n in recent]))
|
| 107 |
+
return "\n\n".join(parts) if parts else ""
|
| 108 |
+
|
| 109 |
+
|
| 110 |
+
class ContextCompressor:
|
| 111 |
+
"""Compresses context to reduce token usage.
|
| 112 |
+
|
| 113 |
+
Based on Anthropic's context engineering best practices:
|
| 114 |
+
- Compaction: Summarize conversations nearing context limit
|
| 115 |
+
- Tool result clearing: Remove raw tool outputs once processed
|
| 116 |
+
- High-fidelity summarization preserving critical details
|
| 117 |
+
"""
|
| 118 |
+
|
| 119 |
+
def __init__(self, llm_client):
|
| 120 |
+
self.llm = llm_client
|
| 121 |
+
|
| 122 |
+
async def compact_conversation(self, messages: List[Dict[str, Any]], preserve_recent: int = 5, max_tokens: int = 1000) -> List[Dict[str, Any]]:
|
| 123 |
+
"""
|
| 124 |
+
Compact a conversation using Anthropic's compaction strategy.
|
| 125 |
+
Preserves architectural decisions, unresolved issues, and implementation details
|
| 126 |
+
while discarding redundant tool outputs.
|
| 127 |
+
|
| 128 |
+
Args:
|
| 129 |
+
messages: List of message dicts with 'role' and 'content'
|
| 130 |
+
preserve_recent: Number of recent messages to keep verbatim
|
| 131 |
+
max_tokens: Target token count for summary
|
| 132 |
+
|
| 133 |
+
Returns:
|
| 134 |
+
Compacted message list with summary + recent messages
|
| 135 |
+
"""
|
| 136 |
+
if len(messages) <= preserve_recent + 2:
|
| 137 |
+
return messages
|
| 138 |
+
|
| 139 |
+
# Keep first message (system/initial context) and last N messages
|
| 140 |
+
first = messages[:1] if messages else []
|
| 141 |
+
recent = messages[-preserve_recent:] if len(messages) > preserve_recent else messages
|
| 142 |
+
middle = messages[1:-preserve_recent] if len(messages) > preserve_recent + 1 else []
|
| 143 |
+
|
| 144 |
+
if not middle:
|
| 145 |
+
return messages
|
| 146 |
+
|
| 147 |
+
# Extract key information for compaction
|
| 148 |
+
user_queries = [m.get("content", "") for m in middle if m.get("role") == "user"]
|
| 149 |
+
assistant_responses = [m.get("content", "") for m in middle if m.get("role") == "assistant"]
|
| 150 |
+
tool_calls = [m for m in middle if m.get("role") == "tool" or "tool" in str(m.get("content", "")).lower()]
|
| 151 |
+
|
| 152 |
+
# Compaction prompt based on Anthropic's guidance
|
| 153 |
+
prompt = f"""You are compacting a conversation history. Preserve:
|
| 154 |
+
1. Architectural decisions and design choices
|
| 155 |
+
2. Unresolved bugs or issues
|
| 156 |
+
3. Implementation details and progress
|
| 157 |
+
4. Key facts and information shared
|
| 158 |
+
5. User preferences and requirements
|
| 159 |
+
|
| 160 |
+
Discard:
|
| 161 |
+
- Redundant tool outputs (raw results already processed)
|
| 162 |
+
- Repetitive information
|
| 163 |
+
- Verbose explanations that don't add value
|
| 164 |
+
- Tool call details that are no longer needed
|
| 165 |
+
|
| 166 |
+
Conversation to compact:
|
| 167 |
+
{chr(10).join([f"{m.get('role', 'user')}: {str(m.get('content', ''))[:400]}" for m in middle[:20]])}
|
| 168 |
+
|
| 169 |
+
Provide a high-fidelity summary that preserves critical context (max {max_tokens} tokens):"""
|
| 170 |
+
|
| 171 |
+
try:
|
| 172 |
+
summary = await self.llm.simple_call(prompt, temperature=0.0)
|
| 173 |
+
summary_msg = {
|
| 174 |
+
"role": "system",
|
| 175 |
+
"content": f"[Compacted conversation history: {summary}]",
|
| 176 |
+
"_compacted": True,
|
| 177 |
+
"_original_length": len(middle)
|
| 178 |
+
}
|
| 179 |
+
return first + [summary_msg] + recent
|
| 180 |
+
except Exception:
|
| 181 |
+
# Fallback: simple trimming
|
| 182 |
+
return first + recent
|
| 183 |
+
|
| 184 |
+
async def summarize_conversation(self, messages: List[Dict[str, Any]], max_tokens: int = 500) -> str:
|
| 185 |
+
"""
|
| 186 |
+
Summarize a conversation while preserving key decisions and facts.
|
| 187 |
+
Uses Anthropic's compaction principles.
|
| 188 |
+
|
| 189 |
+
Args:
|
| 190 |
+
messages: List of message dicts with 'role' and 'content'
|
| 191 |
+
max_tokens: Target token count for summary
|
| 192 |
+
|
| 193 |
+
Returns:
|
| 194 |
+
Summarized conversation
|
| 195 |
+
"""
|
| 196 |
+
if len(messages) <= 2:
|
| 197 |
+
return "\n".join([f"{m.get('role', 'user')}: {m.get('content', '')[:200]}" for m in messages])
|
| 198 |
+
|
| 199 |
+
# Extract key information
|
| 200 |
+
user_queries = [m.get("content", "") for m in messages if m.get("role") == "user"]
|
| 201 |
+
assistant_responses = [m.get("content", "") for m in messages if m.get("role") == "assistant"]
|
| 202 |
+
|
| 203 |
+
prompt = f"""Summarize this conversation using high-fidelity compaction. Preserve:
|
| 204 |
+
1. Key user questions/requests
|
| 205 |
+
2. Important decisions made (architectural, design, implementation)
|
| 206 |
+
3. Critical facts or information shared
|
| 207 |
+
4. Unresolved issues or bugs
|
| 208 |
+
5. Implementation progress
|
| 209 |
+
|
| 210 |
+
Discard redundant tool outputs and repetitive information.
|
| 211 |
+
|
| 212 |
+
Conversation:
|
| 213 |
+
{chr(10).join([f"User: {q[:300]}" for q in user_queries[-5:]])}
|
| 214 |
+
{chr(10).join([f"Assistant: {r[:300]}" for r in assistant_responses[-5:]])}
|
| 215 |
+
|
| 216 |
+
Provide a concise, high-fidelity summary (max {max_tokens} tokens):"""
|
| 217 |
+
|
| 218 |
+
try:
|
| 219 |
+
summary = await self.llm.simple_call(prompt, temperature=0.0)
|
| 220 |
+
return summary[:max_tokens * 4] # Rough token limit
|
| 221 |
+
except Exception:
|
| 222 |
+
# Fallback: simple truncation
|
| 223 |
+
return "\n".join([f"{m.get('role', 'user')}: {m.get('content', '')[:100]}..." for m in messages[-5:]])
|
| 224 |
+
|
| 225 |
+
def trim_messages(self, messages: List[Dict[str, Any]], keep_first: int = 2, keep_last: int = 10) -> List[Dict[str, Any]]:
|
| 226 |
+
"""
|
| 227 |
+
Trim messages, keeping first N and last M.
|
| 228 |
+
Based on Anthropic's guidance: preserve system context and recent interactions.
|
| 229 |
+
|
| 230 |
+
Args:
|
| 231 |
+
messages: List of messages
|
| 232 |
+
keep_first: Number of initial messages to keep (system context)
|
| 233 |
+
keep_last: Number of recent messages to keep
|
| 234 |
+
|
| 235 |
+
Returns:
|
| 236 |
+
Trimmed message list
|
| 237 |
+
"""
|
| 238 |
+
if len(messages) <= keep_first + keep_last:
|
| 239 |
+
return messages
|
| 240 |
+
|
| 241 |
+
return messages[:keep_first] + messages[-keep_last:]
|
| 242 |
+
|
| 243 |
+
def clear_tool_results(self, messages: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
|
| 244 |
+
"""
|
| 245 |
+
Clear tool call results from messages (safest form of compaction).
|
| 246 |
+
Based on Anthropic's recommendation: once a tool has been called deep in history,
|
| 247 |
+
the raw result is often no longer needed.
|
| 248 |
+
|
| 249 |
+
Args:
|
| 250 |
+
messages: List of messages
|
| 251 |
+
|
| 252 |
+
Returns:
|
| 253 |
+
Messages with tool results cleared (tool calls kept, results removed)
|
| 254 |
+
"""
|
| 255 |
+
cleared = []
|
| 256 |
+
for msg in messages:
|
| 257 |
+
# Keep tool calls but clear large results
|
| 258 |
+
if msg.get("role") == "tool" or "tool" in str(msg.get("content", "")).lower():
|
| 259 |
+
# Keep tool metadata but truncate large results
|
| 260 |
+
content = str(msg.get("content", ""))
|
| 261 |
+
if len(content) > 500:
|
| 262 |
+
msg_copy = msg.copy()
|
| 263 |
+
msg_copy["content"] = content[:200] + "... [tool result truncated]"
|
| 264 |
+
msg_copy["_tool_result_cleared"] = True
|
| 265 |
+
cleared.append(msg_copy)
|
| 266 |
+
else:
|
| 267 |
+
cleared.append(msg)
|
| 268 |
+
else:
|
| 269 |
+
cleared.append(msg)
|
| 270 |
+
return cleared
|
| 271 |
+
|
| 272 |
+
async def compress_tool_output(self, tool_name: str, output: Dict[str, Any], max_length: int = 500) -> Dict[str, Any]:
|
| 273 |
+
"""
|
| 274 |
+
Compress tool output to reduce tokens.
|
| 275 |
+
|
| 276 |
+
Args:
|
| 277 |
+
tool_name: Name of the tool
|
| 278 |
+
output: Tool output dict
|
| 279 |
+
max_length: Max characters for compressed output
|
| 280 |
+
|
| 281 |
+
Returns:
|
| 282 |
+
Compressed output
|
| 283 |
+
"""
|
| 284 |
+
if tool_name == "web":
|
| 285 |
+
# Compress web search results
|
| 286 |
+
hits = output.get("results", [])
|
| 287 |
+
if len(hits) > 5:
|
| 288 |
+
# Keep only top 5 results
|
| 289 |
+
output["results"] = hits[:5]
|
| 290 |
+
output["_compressed"] = True
|
| 291 |
+
output["_original_count"] = len(hits)
|
| 292 |
+
|
| 293 |
+
elif tool_name == "rag":
|
| 294 |
+
# Compress RAG results
|
| 295 |
+
hits = output.get("results", [])
|
| 296 |
+
if len(hits) > 5:
|
| 297 |
+
output["results"] = hits[:5]
|
| 298 |
+
output["_compressed"] = True
|
| 299 |
+
output["_original_count"] = len(hits)
|
| 300 |
+
|
| 301 |
+
# Summarize long text fields
|
| 302 |
+
for key in ["text", "content", "snippet"]:
|
| 303 |
+
if key in output and len(str(output[key])) > max_length:
|
| 304 |
+
text = str(output[key])
|
| 305 |
+
output[key] = text[:max_length] + "..."
|
| 306 |
+
output[f"{key}_compressed"] = True
|
| 307 |
+
|
| 308 |
+
return output
|
| 309 |
+
|
| 310 |
+
|
| 311 |
+
class ContextSelector:
|
| 312 |
+
"""Selects relevant context for agent steps."""
|
| 313 |
+
|
| 314 |
+
def __init__(self, llm_client):
|
| 315 |
+
self.llm = llm_client
|
| 316 |
+
|
| 317 |
+
async def select_relevant_memories(self, query: str, memories: List[Dict[str, Any]], limit: int = 5) -> List[Dict[str, Any]]:
|
| 318 |
+
"""
|
| 319 |
+
Select most relevant memories for a query.
|
| 320 |
+
|
| 321 |
+
Args:
|
| 322 |
+
query: User query
|
| 323 |
+
memories: List of memory dicts
|
| 324 |
+
limit: Max memories to return
|
| 325 |
+
|
| 326 |
+
Returns:
|
| 327 |
+
Selected memories
|
| 328 |
+
"""
|
| 329 |
+
if not memories or len(memories) <= limit:
|
| 330 |
+
return memories
|
| 331 |
+
|
| 332 |
+
# Simple keyword-based selection (can be enhanced with embeddings)
|
| 333 |
+
query_lower = query.lower()
|
| 334 |
+
scored = []
|
| 335 |
+
|
| 336 |
+
for mem in memories:
|
| 337 |
+
content = str(mem.get("content", "")).lower()
|
| 338 |
+
score = sum(1 for word in query_lower.split() if word in content)
|
| 339 |
+
scored.append((score, mem))
|
| 340 |
+
|
| 341 |
+
# Sort by score and return top N
|
| 342 |
+
scored.sort(reverse=True, key=lambda x: x[0])
|
| 343 |
+
return [mem for score, mem in scored[:limit] if score > 0]
|
| 344 |
+
|
| 345 |
+
def select_relevant_tools(self, query: str, available_tools: List[Dict[str, Any]], limit: int = 5) -> List[Dict[str, Any]]:
|
| 346 |
+
"""
|
| 347 |
+
Select most relevant tools for a query.
|
| 348 |
+
|
| 349 |
+
Args:
|
| 350 |
+
query: User query
|
| 351 |
+
available_tools: List of tool dicts with descriptions
|
| 352 |
+
limit: Max tools to return
|
| 353 |
+
|
| 354 |
+
Returns:
|
| 355 |
+
Selected tools
|
| 356 |
+
"""
|
| 357 |
+
if not available_tools or len(available_tools) <= limit:
|
| 358 |
+
return available_tools
|
| 359 |
+
|
| 360 |
+
# Simple keyword matching (can be enhanced with semantic search)
|
| 361 |
+
query_lower = query.lower()
|
| 362 |
+
scored = []
|
| 363 |
+
|
| 364 |
+
for tool in available_tools:
|
| 365 |
+
desc = str(tool.get("description", "")).lower()
|
| 366 |
+
name = str(tool.get("name", "")).lower()
|
| 367 |
+
score = sum(1 for word in query_lower.split() if word in desc or word in name)
|
| 368 |
+
scored.append((score, tool))
|
| 369 |
+
|
| 370 |
+
scored.sort(reverse=True, key=lambda x: x[0])
|
| 371 |
+
return [tool for score, tool in scored[:limit]]
|
| 372 |
+
|
| 373 |
+
|
| 374 |
+
class ContextIsolator:
|
| 375 |
+
"""Isolates context to prevent token bloat."""
|
| 376 |
+
|
| 377 |
+
def __init__(self):
|
| 378 |
+
self.isolated_data: Dict[str, Any] = {}
|
| 379 |
+
|
| 380 |
+
def isolate_tool_output(self, tool_name: str, output: Any, key: Optional[str] = None) -> str:
|
| 381 |
+
"""
|
| 382 |
+
Isolate tool output, storing it separately and returning a reference.
|
| 383 |
+
|
| 384 |
+
Args:
|
| 385 |
+
tool_name: Name of the tool
|
| 386 |
+
output: Tool output
|
| 387 |
+
key: Optional key for storage
|
| 388 |
+
|
| 389 |
+
Returns:
|
| 390 |
+
Reference string to use in context
|
| 391 |
+
"""
|
| 392 |
+
storage_key = key or f"{tool_name}_{int(time.time())}"
|
| 393 |
+
self.isolated_data[storage_key] = {
|
| 394 |
+
"tool": tool_name,
|
| 395 |
+
"output": output,
|
| 396 |
+
"timestamp": time.time()
|
| 397 |
+
}
|
| 398 |
+
return f"[ISOLATED:{storage_key}]"
|
| 399 |
+
|
| 400 |
+
def get_isolated(self, key: str) -> Optional[Any]:
|
| 401 |
+
"""Retrieve isolated data by key."""
|
| 402 |
+
return self.isolated_data.get(key, {}).get("output")
|
| 403 |
+
|
| 404 |
+
def clear_old_isolated(self, max_age_seconds: int = 3600):
|
| 405 |
+
"""Clear isolated data older than max_age_seconds."""
|
| 406 |
+
current_time = time.time()
|
| 407 |
+
keys_to_remove = [
|
| 408 |
+
key for key, data in self.isolated_data.items()
|
| 409 |
+
if current_time - data.get("timestamp", 0) > max_age_seconds
|
| 410 |
+
]
|
| 411 |
+
for key in keys_to_remove:
|
| 412 |
+
del self.isolated_data[key]
|
| 413 |
+
|
| 414 |
+
|
| 415 |
+
class ContextEngineer:
|
| 416 |
+
"""Main context engineering service combining all strategies."""
|
| 417 |
+
|
| 418 |
+
def __init__(self, llm_client):
|
| 419 |
+
self.scratchpad = ContextScratchpad()
|
| 420 |
+
self.compressor = ContextCompressor(llm_client)
|
| 421 |
+
self.selector = ContextSelector(llm_client)
|
| 422 |
+
self.isolator = ContextIsolator()
|
| 423 |
+
self.llm = llm_client
|
| 424 |
+
|
| 425 |
+
def write_to_scratchpad(self, note: str, category: str = "general"):
|
| 426 |
+
"""Write to scratchpad."""
|
| 427 |
+
self.scratchpad.add_note(note, category)
|
| 428 |
+
|
| 429 |
+
def save_plan(self, plan: str):
|
| 430 |
+
"""Save agent plan."""
|
| 431 |
+
self.scratchpad.set_plan(plan)
|
| 432 |
+
|
| 433 |
+
def save_fact(self, fact: str):
|
| 434 |
+
"""Save key fact."""
|
| 435 |
+
self.scratchpad.add_fact(fact)
|
| 436 |
+
|
| 437 |
+
def get_scratchpad_context(self, limit: int = 10) -> str:
|
| 438 |
+
"""Get relevant scratchpad context."""
|
| 439 |
+
return self.scratchpad.get_summary()
|
| 440 |
+
|
| 441 |
+
async def compress_if_needed(self, messages: List[Dict[str, Any]], max_tokens: int = 8000,
|
| 442 |
+
use_compaction: bool = True) -> List[Dict[str, Any]]:
|
| 443 |
+
"""
|
| 444 |
+
Compress messages if they exceed token limit.
|
| 445 |
+
Uses Anthropic's compaction strategy: high-fidelity summarization
|
| 446 |
+
preserving architectural decisions, unresolved issues, and implementation details.
|
| 447 |
+
|
| 448 |
+
Args:
|
| 449 |
+
messages: List of messages
|
| 450 |
+
max_tokens: Token limit
|
| 451 |
+
use_compaction: Use full compaction vs simple trimming
|
| 452 |
+
|
| 453 |
+
Returns:
|
| 454 |
+
Compressed messages
|
| 455 |
+
"""
|
| 456 |
+
# Rough token estimate (4 chars per token)
|
| 457 |
+
total_chars = sum(len(str(m.get("content", ""))) for m in messages)
|
| 458 |
+
estimated_tokens = total_chars // 4
|
| 459 |
+
|
| 460 |
+
if estimated_tokens > max_tokens:
|
| 461 |
+
# First, try tool result clearing (safest form of compaction)
|
| 462 |
+
cleared = self.compressor.clear_tool_results(messages)
|
| 463 |
+
cleared_chars = sum(len(str(m.get("content", ""))) for m in cleared)
|
| 464 |
+
cleared_tokens = cleared_chars // 4
|
| 465 |
+
|
| 466 |
+
if cleared_tokens <= max_tokens:
|
| 467 |
+
return cleared
|
| 468 |
+
|
| 469 |
+
# If still over limit, use full compaction
|
| 470 |
+
if use_compaction and len(messages) > 10:
|
| 471 |
+
return await self.compressor.compact_conversation(messages, preserve_recent=5, max_tokens=1000)
|
| 472 |
+
else:
|
| 473 |
+
# Fallback: simple trimming
|
| 474 |
+
return self.compressor.trim_messages(messages, keep_first=2, keep_last=5)
|
| 475 |
+
|
| 476 |
+
return messages
|
| 477 |
+
|
| 478 |
+
async def select_context(self, query: str, available_context: Dict[str, Any]) -> Dict[str, Any]:
|
| 479 |
+
"""
|
| 480 |
+
Select relevant context for a query.
|
| 481 |
+
|
| 482 |
+
Args:
|
| 483 |
+
query: User query
|
| 484 |
+
available_context: Dict with keys like 'memories', 'tools', etc.
|
| 485 |
+
|
| 486 |
+
Returns:
|
| 487 |
+
Selected context dict
|
| 488 |
+
"""
|
| 489 |
+
selected = {}
|
| 490 |
+
|
| 491 |
+
# Select memories
|
| 492 |
+
if "memories" in available_context:
|
| 493 |
+
selected["memories"] = await self.selector.select_relevant_memories(
|
| 494 |
+
query, available_context["memories"]
|
| 495 |
+
)
|
| 496 |
+
|
| 497 |
+
# Select tools
|
| 498 |
+
if "tools" in available_context:
|
| 499 |
+
selected["tools"] = self.selector.select_relevant_tools(
|
| 500 |
+
query, available_context["tools"]
|
| 501 |
+
)
|
| 502 |
+
|
| 503 |
+
return selected
|
| 504 |
+
|
| 505 |
+
def isolate_large_output(self, tool_name: str, output: Any) -> str:
|
| 506 |
+
"""Isolate large tool output."""
|
| 507 |
+
return self.isolator.isolate_tool_output(tool_name, output)
|
| 508 |
+
|
| 509 |
+
def get_isolated_context(self, key: str) -> Optional[Any]:
|
| 510 |
+
"""Get isolated context."""
|
| 511 |
+
return self.isolator.get_isolated(key)
|
| 512 |
+
|