* feat: introduce hindsight-api-slim and hindsight-all-slim packages Closes #552 - Move all source code from hindsight-api/ to new hindsight-api-slim/ - hindsight-api-slim has heavy ML deps (torch, sentence-transformers, transformers, einops, flashrank, mlx, mlx-lm, safetensors) and pg0-embedded as optional extras: [local-ml], [embedded-db], [all] - hindsight-api becomes a zero-code meta-package depending on hindsight-api-slim[all] for full backward compatibility - Add hindsight-all-slim meta-package: hindsight-api-slim + client + embed - hindsight-all updated to depend on hindsight-api-slim[all] - pg0.py: lazy-import pg0 with clear ImportError pointing to [embedded-db] - Dockerfile: replace sed hack with proper uv sync --extra flags - Update release.yml, test.yml, lint.sh, release.sh, CLAUDE.md and all path references throughout the repo * refactor: rename hindsight/ directory to hindsight-all/ * docs: document hindsight-api-slim and hindsight-all-slim package variants Add package variants table and extras explanation to installation.md * docs: remove emojis from installation.md, use professional tone * docs: link Docker slim variant to pip package variants section * docs: consolidate Docker image variants into single table * ci: fix working-directory paths after package restructure - Replace all hindsight-api → hindsight-api-slim in test.yml - Replace hindsight → hindsight-all in test.yml - Add --extra embedded-db to test-embed API install step * ci: add local-ml and embedded-db extras to API sync steps These extras were previously implicit in the old hindsight-api package (which bundled everything). Now that hindsight-api-slim uses optional extras, we must explicitly request local-ml and embedded-db in CI. * ci: add API install step with embedded-db to test-embed smoke test The smoke test starts hindsight-api as a daemon, which requires pg0-embedded. Add a dedicated install step for hindsight-api-slim with embedded-db extra so the daemon can start successfully. * ci: remove --no-install-project when using optional extras When --no-install-project is combined with --extra, the optional deps are not installed because extras require the project to be active. Remove --no-install-project from steps that need local-ml or embedded-db. * ci: fix ordering of uv sync steps to preserve optional extras When uv sync runs for a different workspace member, it removes optional extras installed for other members. Fix by always running extra-requiring API sync last, after other workspace member syncs. Also remove --no-install-project from embedded-db sync in test-embed, as --no-install-project prevents optional extras from being active. * ci: add local-ml extra to test-embed API install for smoke test The smoke test starts the full API server which needs sentence-transformers for local embeddings (default provider). Add local-ml extra to the install. * ci: simplify extras with --all-extras and add slim pip smoke test - Replace explicit --extra local-ml --extra embedded-db with --all-extras for cleaner, more maintainable sync steps - Add test-pip-slim job: tests hindsight-api-slim[embedded-db] without local ML models, using Cohere for embeddings/reranking (mirrors Docker slim smoke test approach) * ci: simplify slim smoke test to health check only (mirrors Docker test)
510 lines
20 KiB
Python
510 lines
20 KiB
Python
"""
|
|
System prompts for the reflect agent.
|
|
|
|
The reflect agent uses hierarchical retrieval:
|
|
1. search_mental_models - User-curated summaries (highest quality)
|
|
2. search_observations - Consolidated knowledge with freshness awareness
|
|
3. recall - Raw facts as ground truth fallback
|
|
"""
|
|
|
|
import json
|
|
from typing import Any
|
|
|
|
import tiktoken
|
|
|
|
_TIKTOKEN_ENCODING = tiktoken.get_encoding("cl100k_base")
|
|
|
|
# Fraction of max_context_tokens reserved for tool results in the final synthesis prompt.
|
|
# The remainder covers the system prompt, question, bank context, and output tokens.
|
|
_FINAL_PROMPT_CONTEXT_FRACTION = 0.8
|
|
|
|
|
|
def _extract_directive_rules(directives: list[dict[str, Any]]) -> list[str]:
|
|
"""Extract directive rules as a list of strings."""
|
|
rules = []
|
|
for directive in directives:
|
|
name = directive.get("name", "")
|
|
content = directive.get("content", "")
|
|
if content:
|
|
rules.append(f"**{name}**: {content}" if name else content)
|
|
return rules
|
|
|
|
|
|
def build_directives_section(directives: list[dict[str, Any]]) -> str:
|
|
"""Build the directives section for the system prompt.
|
|
|
|
Directives are hard rules that MUST be followed in all responses.
|
|
"""
|
|
if not directives:
|
|
return ""
|
|
|
|
rules = _extract_directive_rules(directives)
|
|
if not rules:
|
|
return ""
|
|
|
|
parts = [
|
|
"## DIRECTIVES (MANDATORY)",
|
|
"These are hard rules you MUST follow in ALL responses:",
|
|
"",
|
|
]
|
|
|
|
for rule in rules:
|
|
parts.append(f"- {rule}")
|
|
|
|
parts.extend(
|
|
[
|
|
"",
|
|
"NEVER violate these directives, even if other context suggests otherwise.",
|
|
"IMPORTANT: Do NOT explain or justify how you handled directives in your answer. Just follow them silently.",
|
|
"",
|
|
]
|
|
)
|
|
return "\n".join(parts)
|
|
|
|
|
|
def build_directives_reminder(directives: list[dict[str, Any]]) -> str:
|
|
"""
|
|
Build a reminder section for directives to place at the end of the prompt.
|
|
|
|
Args:
|
|
directives: List of directive mental models with observations
|
|
"""
|
|
if not directives:
|
|
return ""
|
|
|
|
rules = _extract_directive_rules(directives)
|
|
if not rules:
|
|
return ""
|
|
|
|
parts = [
|
|
"",
|
|
"## REMINDER: MANDATORY DIRECTIVES",
|
|
"Before responding, ensure your answer complies with ALL of these directives:",
|
|
"",
|
|
]
|
|
|
|
for i, rule in enumerate(rules, 1):
|
|
parts.append(f"{i}. {rule}")
|
|
|
|
parts.append("")
|
|
parts.append("Your response will be REJECTED if it violates any directive above.")
|
|
parts.append("Do NOT include any commentary about how you handled directives - just follow them.")
|
|
return "\n".join(parts)
|
|
|
|
|
|
def build_system_prompt_for_tools(
|
|
bank_profile: dict[str, Any],
|
|
context: str | None = None,
|
|
directives: list[dict[str, Any]] | None = None,
|
|
has_mental_models: bool = False,
|
|
budget: str | None = None,
|
|
) -> str:
|
|
"""
|
|
Build the system prompt for tool-calling reflect agent.
|
|
|
|
The agent uses hierarchical retrieval:
|
|
1. search_mental_models - User-curated summaries (try first, if available)
|
|
2. search_observations - Consolidated knowledge with freshness
|
|
3. recall - Raw facts as ground truth
|
|
|
|
Args:
|
|
bank_profile: Bank profile with name and mission
|
|
context: Optional additional context
|
|
directives: Optional list of directive mental models to inject as hard rules
|
|
has_mental_models: Whether the bank has any mental models (skip if not)
|
|
budget: Search depth budget - "low", "mid", or "high". Controls exploration thoroughness.
|
|
"""
|
|
name = bank_profile.get("name", "Assistant")
|
|
mission = bank_profile.get("mission", "")
|
|
|
|
parts = []
|
|
|
|
# Anti-hallucination rule at the very top
|
|
parts.extend(
|
|
[
|
|
"CRITICAL: You MUST ONLY use information from retrieved tool results. NEVER make up names, people, events, or entities.",
|
|
"",
|
|
]
|
|
)
|
|
|
|
# Inject directives after anti-hallucination rule
|
|
if directives:
|
|
parts.append(build_directives_section(directives))
|
|
|
|
parts.extend(
|
|
[
|
|
"You are a reflection agent that answers questions by reasoning over retrieved memories.",
|
|
"",
|
|
]
|
|
)
|
|
|
|
parts.extend(
|
|
[
|
|
"## LANGUAGE RULE (default - directives take precedence)",
|
|
"- By default, detect the language of the user's question and respond in that SAME language.",
|
|
"- If the question is in Chinese, respond in Chinese. If in Japanese, respond in Japanese.",
|
|
"- IMPORTANT: The DIRECTIVES section above has HIGHER PRIORITY than this rule.",
|
|
" If a directive specifies a language (e.g. 'Always respond in French'), follow the directive.",
|
|
"",
|
|
"## CRITICAL RULES",
|
|
"- ONLY use information from tool results - no external knowledge or guessing",
|
|
"- You SHOULD synthesize, infer, and reason from the retrieved memories",
|
|
"- You MUST search before saying you don't have information",
|
|
"",
|
|
"## How to Reason",
|
|
"- If memories mention someone did an activity, you can infer they likely enjoyed it",
|
|
"- Synthesize a coherent narrative from related memories",
|
|
"- Be a thoughtful interpreter, not just a literal repeater",
|
|
"- When the exact answer isn't stated, use what IS stated to give the best answer",
|
|
"",
|
|
"## HIERARCHICAL RETRIEVAL STRATEGY",
|
|
"",
|
|
]
|
|
)
|
|
|
|
# Build retrieval levels based on what's available
|
|
if has_mental_models:
|
|
parts.extend(
|
|
[
|
|
"You have access to THREE levels of knowledge. Use them in this order:",
|
|
"",
|
|
"### 1. MENTAL MODELS (search_mental_models) - Try First",
|
|
"- User-curated summaries about specific topics",
|
|
"- HIGHEST quality - manually created and maintained",
|
|
"- If a relevant mental model exists and is FRESH, it may fully answer the question",
|
|
"- Check `is_stale` field - if stale, also verify with lower levels",
|
|
"",
|
|
"### 2. OBSERVATIONS (search_observations) - Second Priority",
|
|
"- Auto-consolidated knowledge from memories",
|
|
"- Check `is_stale` field - if stale, ALSO use recall() to verify",
|
|
"- Good for understanding patterns and summaries",
|
|
"",
|
|
"### 3. RAW FACTS (recall) - Ground Truth",
|
|
"- Individual memories (world facts and experiences)",
|
|
"- Use when: no mental models/observations exist, they're stale, or you need specific details",
|
|
"- MANDATORY: If search_mental_models and search_observations both return 0 results, you MUST call recall() before giving up",
|
|
"- This is the source of truth that other levels are built from",
|
|
"",
|
|
]
|
|
)
|
|
else:
|
|
parts.extend(
|
|
[
|
|
"You have access to TWO levels of knowledge. Use them in this order:",
|
|
"",
|
|
"### 1. OBSERVATIONS (search_observations) - Try First",
|
|
"- Auto-consolidated knowledge from memories",
|
|
"- Check `is_stale` field - if stale, ALSO use recall() to verify",
|
|
"- Good for understanding patterns and summaries",
|
|
"",
|
|
"### 2. RAW FACTS (recall) - Ground Truth",
|
|
"- Individual memories (world facts and experiences)",
|
|
"- Use when: no observations exist, they're stale, or you need specific details",
|
|
"- MANDATORY: If search_observations returns 0 results or count=0, you MUST call recall() before giving up",
|
|
"- This is the source of truth that observations are built from",
|
|
"",
|
|
]
|
|
)
|
|
|
|
parts.extend(
|
|
[
|
|
"## Query Strategy",
|
|
"recall() uses semantic search. NEVER just echo the user's question - decompose it into targeted searches:",
|
|
"",
|
|
"BAD: User asks 'recurring lesson themes between students' → recall('recurring lesson themes between students')",
|
|
"GOOD: Break it down into component searches:",
|
|
" 1. recall('lessons') - find all lesson-related memories",
|
|
" 2. recall('teaching sessions') - alternative phrasing",
|
|
" 3. recall('student progress') - find student-related memories",
|
|
"",
|
|
"Think: What ENTITIES and CONCEPTS does this question involve? Search for each separately.",
|
|
"",
|
|
]
|
|
)
|
|
|
|
# Add budget guidance
|
|
if budget:
|
|
budget_lower = budget.lower()
|
|
if budget_lower == "low":
|
|
parts.extend(
|
|
[
|
|
"## RESEARCH DEPTH: SHALLOW (Quick Response)",
|
|
"- Prioritize speed over completeness",
|
|
"- If mental models or observations provide a reasonable answer, stop there",
|
|
"- Only dig deeper if the initial results are clearly insufficient",
|
|
"- Prefer a quick overview rather than exhaustive details",
|
|
"- Answer promptly with available information",
|
|
"",
|
|
]
|
|
)
|
|
elif budget_lower == "mid":
|
|
parts.extend(
|
|
[
|
|
"## RESEARCH DEPTH: MODERATE (Balanced)",
|
|
"- Balance thoroughness with efficiency",
|
|
"- Check multiple sources when the question warrants it",
|
|
"- Verify stale data if it's central to the answer",
|
|
"- Don't over-explore, but ensure reasonable coverage",
|
|
"",
|
|
]
|
|
)
|
|
elif budget_lower == "high":
|
|
parts.extend(
|
|
[
|
|
"## RESEARCH DEPTH: DEEP (Thorough Exploration)",
|
|
"- Explore comprehensively before answering",
|
|
"- Search across all available knowledge levels",
|
|
"- Use multiple query variations to ensure coverage",
|
|
"- Verify information across different retrieval levels",
|
|
"- Use expand() to get full context on important memories",
|
|
"- Take time to synthesize a complete, well-researched answer",
|
|
"",
|
|
]
|
|
)
|
|
|
|
parts.append("## Workflow")
|
|
|
|
if has_mental_models:
|
|
parts.extend(
|
|
[
|
|
"1. First, try search_mental_models() - check if a curated summary exists",
|
|
"2. If no mental model or it's stale, try search_observations() for consolidated knowledge",
|
|
"3. If observations are stale OR you need specific details, use recall() for raw facts",
|
|
"4. Use expand() if you need more context on specific memories",
|
|
"5. When ready, call done() with your answer and supporting IDs",
|
|
]
|
|
)
|
|
else:
|
|
parts.extend(
|
|
[
|
|
"1. First, try search_observations() - check for consolidated knowledge",
|
|
"2. If search_observations returns 0 results OR observations are stale, you MUST call recall() for raw facts",
|
|
"3. Use expand() if you need more context on specific memories",
|
|
"4. When ready, call done() with your answer and supporting IDs",
|
|
]
|
|
)
|
|
|
|
parts.extend(
|
|
[
|
|
"",
|
|
"## Output Format: Well-Formatted Markdown Answer",
|
|
"Call done() with a well-formatted markdown 'answer' field.",
|
|
"- USE markdown formatting for structure (headers, lists, bold, italic, code blocks, tables, etc.)",
|
|
"- CRITICAL: Add blank lines before and after block elements (tables, code blocks, lists)",
|
|
"- Format for clarity and readability with proper spacing and hierarchy",
|
|
"- NEVER include memory IDs, UUIDs, or 'Memory references' in the answer text",
|
|
"- Put IDs ONLY in the memory_ids/mental_model_ids/observation_ids arrays, not in the answer",
|
|
"- CRITICAL: This is a NON-CONVERSATIONAL system. NEVER ask follow-up questions, offer further assistance, or suggest next steps. Your answer must be complete and self-contained. The user cannot reply.",
|
|
]
|
|
)
|
|
|
|
parts.append("")
|
|
parts.append(f"## Memory Bank: {name}")
|
|
|
|
if mission:
|
|
parts.append(f"Mission: {mission}")
|
|
|
|
# Disposition traits
|
|
disposition = bank_profile.get("disposition", {})
|
|
if disposition:
|
|
traits = []
|
|
if "skepticism" in disposition:
|
|
traits.append(f"skepticism={disposition['skepticism']}")
|
|
if "literalism" in disposition:
|
|
traits.append(f"literalism={disposition['literalism']}")
|
|
if "empathy" in disposition:
|
|
traits.append(f"empathy={disposition['empathy']}")
|
|
if traits:
|
|
parts.append(f"Disposition: {', '.join(traits)}")
|
|
|
|
if context:
|
|
parts.append(f"\n## Additional Context\n{context}")
|
|
|
|
# Add directive reminder at the END for recency effect
|
|
if directives:
|
|
parts.append(build_directives_reminder(directives))
|
|
|
|
return "\n".join(parts)
|
|
|
|
|
|
def build_agent_prompt(
|
|
query: str,
|
|
context_history: list[dict],
|
|
bank_profile: dict,
|
|
additional_context: str | None = None,
|
|
) -> str:
|
|
"""Build the user prompt for the reflect agent."""
|
|
parts = []
|
|
|
|
# Bank identity
|
|
name = bank_profile.get("name", "Assistant")
|
|
mission = bank_profile.get("mission", "")
|
|
|
|
parts.append(f"## Memory Bank Context\nName: {name}")
|
|
if mission:
|
|
parts.append(f"Mission: {mission}")
|
|
|
|
# Disposition traits if present
|
|
disposition = bank_profile.get("disposition", {})
|
|
if disposition:
|
|
traits = []
|
|
if "skepticism" in disposition:
|
|
traits.append(f"skepticism={disposition['skepticism']}")
|
|
if "literalism" in disposition:
|
|
traits.append(f"literalism={disposition['literalism']}")
|
|
if "empathy" in disposition:
|
|
traits.append(f"empathy={disposition['empathy']}")
|
|
if traits:
|
|
parts.append(f"Disposition: {', '.join(traits)}")
|
|
|
|
# Additional context from caller
|
|
if additional_context:
|
|
parts.append(f"\n## Additional Context\n{additional_context}")
|
|
|
|
# Tool call history
|
|
if context_history:
|
|
parts.append("\n## Tool Results (synthesize and reason from this data)")
|
|
for i, entry in enumerate(context_history, 1):
|
|
tool = entry["tool"]
|
|
output = entry["output"]
|
|
# Format as proper JSON for LLM readability
|
|
try:
|
|
output_str = json.dumps(output, indent=2, default=str)
|
|
except (TypeError, ValueError):
|
|
output_str = str(output)
|
|
parts.append(f"\n### Call {i}: {tool}\n```json\n{output_str}\n```")
|
|
|
|
# The question
|
|
parts.append(f"\n## Question\n{query}")
|
|
|
|
# Instructions
|
|
if context_history:
|
|
parts.append(
|
|
"\n## Instructions\n"
|
|
"Based on the tool results above, either call more tools or provide your final answer. "
|
|
"Synthesize and reason from the data - make reasonable inferences when helpful. "
|
|
"If you have related information, use it to give the best possible answer."
|
|
)
|
|
else:
|
|
parts.append(
|
|
"\n## Instructions\n"
|
|
"Start by searching for relevant information using the hierarchical retrieval strategy:\n"
|
|
"1. Try search_mental_models() first for curated summaries\n"
|
|
"2. Try search_observations() for consolidated knowledge\n"
|
|
"3. Use recall() for specific details or to verify stale data"
|
|
)
|
|
|
|
return "\n".join(parts)
|
|
|
|
|
|
def build_final_prompt(
|
|
query: str,
|
|
context_history: list[dict],
|
|
bank_profile: dict,
|
|
additional_context: str | None = None,
|
|
max_context_tokens: int = 100_000,
|
|
) -> str:
|
|
"""Build the final prompt when forcing a text response (no tools)."""
|
|
parts = []
|
|
|
|
# Bank identity
|
|
name = bank_profile.get("name", "Assistant")
|
|
mission = bank_profile.get("mission", "")
|
|
|
|
parts.append(f"## Memory Bank Context\nName: {name}")
|
|
if mission:
|
|
parts.append(f"Mission: {mission}")
|
|
|
|
# Disposition traits if present
|
|
disposition = bank_profile.get("disposition", {})
|
|
if disposition:
|
|
traits = []
|
|
if "skepticism" in disposition:
|
|
traits.append(f"skepticism={disposition['skepticism']}")
|
|
if "literalism" in disposition:
|
|
traits.append(f"literalism={disposition['literalism']}")
|
|
if "empathy" in disposition:
|
|
traits.append(f"empathy={disposition['empathy']}")
|
|
if traits:
|
|
parts.append(f"Disposition: {', '.join(traits)}")
|
|
|
|
# Additional context from caller
|
|
if additional_context:
|
|
parts.append(f"\n## Additional Context\n{additional_context}")
|
|
|
|
# Tool call history — include as many entries as fit within the token budget,
|
|
# preferring the most recent calls (they tend to be the most targeted).
|
|
if context_history:
|
|
parts.append("\n## Retrieved Data (synthesize and reason from this data)")
|
|
token_budget = int(max_context_tokens * _FINAL_PROMPT_CONTEXT_FRACTION)
|
|
# Render entries newest-first, then reverse so the prompt reads chronologically.
|
|
rendered: list[str] = []
|
|
truncated = False
|
|
for entry in reversed(context_history):
|
|
tool = entry["tool"]
|
|
output = entry["output"]
|
|
try:
|
|
output_str = json.dumps(output, indent=2, default=str)
|
|
except (TypeError, ValueError):
|
|
output_str = str(output)
|
|
block = f"\n### From {tool}:\n```json\n{output_str}\n```"
|
|
block_tokens = len(_TIKTOKEN_ENCODING.encode(block))
|
|
if block_tokens > token_budget:
|
|
truncated = True
|
|
break
|
|
rendered.append(block)
|
|
token_budget -= block_tokens
|
|
for block in reversed(rendered):
|
|
parts.append(block)
|
|
if truncated:
|
|
parts.append("\n*Note: Some earlier tool results were omitted to stay within the context window.*")
|
|
else:
|
|
parts.append("\n## Retrieved Data\nNo data was retrieved.")
|
|
|
|
# The question
|
|
parts.append(f"\n## Question\n{query}")
|
|
|
|
# Final instructions
|
|
parts.append(
|
|
"\n## Instructions\n"
|
|
"Provide a thoughtful answer by synthesizing and reasoning from the retrieved data above. "
|
|
"You can make reasonable inferences from the memories, but don't completely fabricate information. "
|
|
"If the exact answer isn't stated, use what IS stated to give the best possible answer. "
|
|
"Only say 'I don't have information' if the retrieved data is truly unrelated to the question.\n\n"
|
|
"IMPORTANT: Output ONLY the final answer. Do NOT include meta-commentary like "
|
|
'"I\'ll search..." or "Let me analyze...". Do NOT explain your reasoning process. '
|
|
"Just provide the direct synthesized answer."
|
|
)
|
|
|
|
return "\n".join(parts)
|
|
|
|
|
|
FINAL_SYSTEM_PROMPT = """CRITICAL: You MUST ONLY use information from retrieved tool results. NEVER make up names, people, events, or entities.
|
|
|
|
You are a thoughtful assistant that synthesizes answers from retrieved memories.
|
|
|
|
Your approach:
|
|
- Reason over the retrieved memories to answer the question
|
|
- Make reasonable inferences when the exact answer isn't explicitly stated
|
|
- Connect related memories to form a complete picture
|
|
- Be helpful - if you have related information, use it to give the best possible answer
|
|
- ONLY use information from tool results - no external knowledge or guessing
|
|
|
|
Only say "I don't have information" if the retrieved data is truly unrelated to the question.
|
|
|
|
FORMATTING: Use proper markdown formatting in your answer:
|
|
- Headers (##, ###) for sections
|
|
- Lists (bullet or numbered) for enumerations
|
|
- Bold/italic for emphasis
|
|
- Tables with proper syntax (ensure blank line before and after)
|
|
- Code blocks where appropriate
|
|
- CRITICAL: Always add blank lines before and after block elements (tables, code blocks, lists)
|
|
- Proper spacing between sections
|
|
|
|
CRITICAL: Output ONLY the final synthesized answer. Do NOT include:
|
|
- Meta-commentary about what you're doing ("I'll search...", "Let me analyze...")
|
|
- Explanations of your reasoning process
|
|
- Descriptions of your approach
|
|
Just provide the direct answer with proper markdown formatting.
|
|
|
|
CRITICAL: This is a NON-CONVERSATIONAL system. NEVER ask follow-up questions, offer to search again, suggest alternatives, or end with anything like "Would you like me to..." or "Let me know if...". The user cannot reply. Your answer must be complete and self-contained."""
|