admin/basicmachines-co-basic-memory
1
0
Fork 0
mirror of https://github.com/basicmachines-co/basic-memory synced 2026-06-21 13:47:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: build_context related_results schema validation failure (#631)

Browse Source 
Signed-off-by: phernandez <paul@basicmachines.co>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Paul Hernandez
2026-02-27 12:30:44 -06:00
committed by GitHub
parent 254e30423d
commit e97eafa55a
15 changed files with 348 additions and 201 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/basic_memory/alembic/versions/j3d4e5f6g7h8_rename_entity_type_to_note_type.py
+1 -4
View File
@@ -22,10 +22,7 @@ def table_exists(connection, table_name: str) -> bool:
"""Check if a table exists (idempotent migration support)."""
if connection.dialect.name == "postgresql":
result = connection.execute(
text(
"SELECT 1 FROM information_schema.tables "
"WHERE table_name = :table_name"
),
text("SELECT 1 FROM information_schema.tables WHERE table_name = :table_name"),
{"table_name": table_name},
)
return result.fetchone() is not None
src/basic_memory/mcp/prompts/continue_conversation.py
+1 -1
View File
@@ -125,7 +125,7 @@ def _format_continuation_results(result: SearchResponse, topic: str) -> str:
lines.append(f"### {title}")
if permalink:
lines.append(f"permalink: {permalink}")
lines.append(f"Read with: `read_note(\"{permalink}\")`")
lines.append(f'Read with: `read_note("{permalink}")`')
if item.content:
content = item.content[:300] + "..." if len(item.content) > 300 else item.content
lines.append(f"\n{content}")
src/basic_memory/mcp/tools/build_context.py
+4 -72
View File
@@ -22,74 +22,6 @@ from basic_memory.schemas.memory import (
RelationSummary,
)
# --- Fields to strip from each model (redundant with parent entity) ---
_OBSERVATION_STRIP = {
"observation_id",
"entity_id",
"entity_external_id",
"title",
"file_path",
"created_at",
}
_RELATION_STRIP = {
"relation_id",
"entity_id",
"from_entity_id",
"from_entity_external_id",
"to_entity_id",
"to_entity_external_id",
"title",
"file_path",
"created_at",
}
_ENTITY_STRIP = {"entity_id", "created_at"}
_METADATA_STRIP = {"total_results", "generated_at"}
def _slim_summary(summary: EntitySummary | RelationSummary | ObservationSummary) -> dict:
"""Strip redundant fields from a summary model based on its type."""
if isinstance(summary, ObservationSummary):
strip = _OBSERVATION_STRIP
elif isinstance(summary, RelationSummary):
strip = _RELATION_STRIP
else:
strip = _ENTITY_STRIP
data = summary.model_dump()
for key in strip:
data.pop(key, None)
return data
def _slim_context(graph: GraphContext) -> dict:
"""Transform GraphContext into a slimmed dict, stripping redundant fields.
Reduces payload size ~40% by removing fields on nested objects that
duplicate information already present on the parent entity (IDs,
timestamps, file paths).
"""
slimmed_results = []
for result in graph.results:
slimmed_results.append(
{
"primary_result": _slim_summary(result.primary_result),
"observations": [_slim_summary(obs) for obs in result.observations],
"related_results": [_slim_summary(rel) for rel in result.related_results],
}
)
metadata = graph.metadata.model_dump()
for key in _METADATA_STRIP:
metadata.pop(key, None)
return {
"results": slimmed_results,
"metadata": metadata,
"page": graph.page,
"page_size": graph.page_size,
}
def _format_entity_block(result: ContextResult) -> str:
"""Format a single context result as a markdown block."""
@@ -194,7 +126,7 @@ def _format_context_markdown(graph: GraphContext, project: str) -> str:
- Or standard formats like "7d", "24h"
Format options:
- "json" (default): Slimmed JSON with redundant fields removed
- "json" (default): Structured JSON with internal fields excluded
- "text": Compact markdown text for LLM consumption
""",
annotations={"readOnlyHint": True, "openWorldHint": False},
@@ -231,12 +163,12 @@ async def build_context(
page: Page number of results to return (default: 1)
page_size: Number of results to return per page (default: 10)
max_related: Maximum number of related results to return (default: 10)
output_format: Response format - "json" for slimmed JSON dict,
output_format: Response format - "json" for structured JSON dict,
"text" for compact markdown text
context: Optional FastMCP context for performance caching.
Returns:
dict (output_format="json"): Slimmed JSON with redundant fields removed
dict (output_format="json"): Structured JSON with internal fields excluded
str (output_format="text"): Compact markdown representation
Examples:
@@ -292,4 +224,4 @@ async def build_context(
if output_format == "text":
return _format_context_markdown(graph, active_project.name)
return _slim_context(graph)
return graph.model_dump()
src/basic_memory/mcp/tools/search.py
+6 -1
View File
@@ -466,7 +466,12 @@ async def search_notes(
effective_query = (query or "").strip()
if effective_query:
valid_search_types = {
"text", "title", "permalink", "vector", "semantic", "hybrid",
"text",
"title",
"permalink",
"vector",
"semantic",
"hybrid",
}
if effective_search_type == "text":
search_query.text = effective_query
src/basic_memory/repository/observation_repository.py
+6 -1
View File
@@ -2,9 +2,10 @@
from typing import Dict, List, Sequence
from sqlalchemy import select
from sqlalchemy.ext.asyncio import async_sessionmaker
from sqlalchemy.orm import selectinload
from sqlalchemy.orm.interfaces import LoaderOption
from basic_memory.models import Observation
from basic_memory.repository.repository import Repository
@@ -22,6 +23,10 @@ class ObservationRepository(Repository[Observation]):
"""
super().__init__(session_maker, Observation, project_id=project_id)
def get_load_options(self) -> List[LoaderOption]:
"""Eager-load parent entity to prevent N+1 if obs.entity is accessed."""
return [selectinload(Observation.entity)]
async def find_by_entity(self, entity_id: int) -> Sequence[Observation]:
"""Find all observations for a specific entity."""
query = select(Observation).filter(Observation.entity_id == entity_id)
src/basic_memory/repository/postgres_search_repository.py
+1 -3
View File
@@ -689,9 +689,7 @@ class PostgresSearchRepository(SearchRepositoryBase):
for idx, note_type in enumerate(note_types):
param_name = f"note_type_{idx}"
params[param_name] = json.dumps({"note_type": note_type})
type_conditions.append(
f"search_index.metadata @> CAST(:{param_name} AS jsonb)"
)
type_conditions.append(f"search_index.metadata @> CAST(:{param_name} AS jsonb)")
conditions.append(f"({' OR '.join(type_conditions)})")
# Handle date filter
src/basic_memory/schemas/memory.py
+13 -19
View File
@@ -125,7 +125,7 @@ class EntitySummary(BaseModel):
type: Literal["entity"] = "entity"
external_id: str # UUID for v2 API routing
entity_id: int # Database ID for v2 API consistency
entity_id: Optional[int] = Field(None, exclude=True) # Internal DB ID
permalink: Optional[str]
title: str
content: Optional[str] = None
@@ -143,18 +143,18 @@ class RelationSummary(BaseModel):
"""Simplified relation representation."""
type: Literal["relation"] = "relation"
relation_id: int # Database ID for v2 API consistency
entity_id: Optional[int] = None # ID of the entity this relation belongs to
relation_id: Optional[int] = Field(None, exclude=True) # Internal DB ID
entity_id: Optional[int] = Field(None, exclude=True) # Internal FK
title: str
file_path: str
permalink: str
relation_type: str
from_entity: Optional[str] = None
from_entity_id: Optional[int] = None # ID of source entity
from_entity_external_id: Optional[str] = None # UUID of source entity for v2 API routing
from_entity_id: Optional[int] = Field(None, exclude=True) # Internal FK
from_entity_external_id: Optional[str] = Field(None, exclude=True) # Internal routing ID
to_entity: Optional[str] = None
to_entity_id: Optional[int] = None # ID of target entity
to_entity_external_id: Optional[str] = None # UUID of target entity for v2 API routing
to_entity_id: Optional[int] = Field(None, exclude=True) # Internal FK
to_entity_external_id: Optional[str] = Field(None, exclude=True) # Internal routing ID
created_at: Annotated[
datetime, Field(json_schema_extra={"type": "string", "format": "date-time"})
]
@@ -168,10 +168,10 @@ class ObservationSummary(BaseModel):
"""Simplified observation representation."""
type: Literal["observation"] = "observation"
observation_id: int # Database ID for v2 API consistency
entity_id: Optional[int] = None # ID of the entity this observation belongs to
entity_external_id: Optional[str] = None # UUID of parent entity for v2 API routing
title: str
observation_id: Optional[int] = Field(None, exclude=True) # Internal DB ID
entity_id: Optional[int] = Field(None, exclude=True) # Internal FK
entity_external_id: Optional[str] = Field(None, exclude=True) # Internal routing ID
title: Optional[str] = Field(None, exclude=True) # Redundant with parent entity
file_path: str
permalink: str
category: str
@@ -192,19 +192,13 @@ class MemoryMetadata(BaseModel):
types: Optional[List[SearchItemType]] = None
depth: int
timeframe: Optional[str] = None
generated_at: Annotated[
datetime, Field(json_schema_extra={"type": "string", "format": "date-time"})
]
generated_at: Optional[datetime] = Field(None, exclude=True) # Internal timing
primary_count: Optional[int] = None # Changed field name
related_count: Optional[int] = None # Changed field name
total_results: Optional[int] = None # For backward compatibility
total_results: Optional[int] = Field(None, exclude=True) # Internal counter
total_relations: Optional[int] = None
total_observations: Optional[int] = None
@field_serializer("generated_at")
def serialize_generated_at(self, dt: datetime) -> str:
return dt.isoformat()
class ContextResult(BaseModel):
"""Context result containing a primary item with its observations and related items."""
src/basic_memory/services/project_service.py
+5 -14
View File
@@ -977,16 +977,13 @@ class ProjectService:
total_indexed_entities=total_indexed_entities,
vector_tables_exist=False,
reindex_recommended=True,
reindex_reason=(
"Vector tables not initialized — run: bm reindex --embeddings"
),
reindex_reason=("Vector tables not initialized — run: bm reindex --embeddings"),
)
# --- Count queries (tables exist) ---
si_result = await self.repository.execute_query(
text(
"SELECT COUNT(DISTINCT entity_id) FROM search_index "
"WHERE project_id = :project_id"
"SELECT COUNT(DISTINCT entity_id) FROM search_index WHERE project_id = :project_id"
),
{"project_id": project_id},
)
@@ -1040,9 +1037,7 @@ class ProjectService:
"WHERE c.project_id = :project_id AND e.rowid IS NULL"
)
orphan_result = await self.repository.execute_query(
orphan_sql, {"project_id": project_id}
)
orphan_result = await self.repository.execute_query(orphan_sql, {"project_id": project_id})
orphaned_chunks = orphan_result.scalar() or 0
# --- Reindex recommendation logic (priority order) ---
@@ -1051,9 +1046,7 @@ class ProjectService:
if total_indexed_entities > 0 and total_chunks == 0:
reindex_recommended = True
reindex_reason = (
"Embeddings have never been built — run: bm reindex --embeddings"
)
reindex_reason = "Embeddings have never been built — run: bm reindex --embeddings"
elif orphaned_chunks > 0:
reindex_recommended = True
reindex_reason = (
@@ -1063,9 +1056,7 @@ class ProjectService:
elif total_indexed_entities > total_entities_with_chunks:
missing = total_indexed_entities - total_entities_with_chunks
reindex_recommended = True
reindex_reason = (
f"{missing} entities missing embeddings — run: bm reindex --embeddings"
)
reindex_reason = f"{missing} entities missing embeddings — run: bm reindex --embeddings"
return EmbeddingStatus(
semantic_search_enabled=True,