This repository has been archived on 2026-07-19. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
shira-hermes/api/services/kb/search.py
T
chaim b127cafb01 feat(kb): chunk_index in /kb/search hits + section-window in /source/{id}/chunks
Two minimal additions for the upcoming v0.1.11 client work:

- /kb/search hits now include chunk_index, so the client can call
  /source/{id}/chunks?around=N&ctx=K to fetch the matched chunk plus K
  chunks before/after as context. Required by the new search-preview
  layout for text sources, which until now duplicated the matched chunk
  in both panes.
- /source/{id}/chunks accepts around (chunk_index) + ctx (window radius
  clamped to 0..10). When around is given, returns only the windowed
  range; otherwise unchanged (returns all chunks of the source).

Refs Task Master #1
2026-04-25 12:25:27 +00:00

217 lines
7.8 KiB
Python

"""Hybrid search: vector + full-text, fused with Reciprocal Rank Fusion,
and finally reranked with a Voyage cross-encoder for precision.
`search()` supports an `expand=True` mode that asks the LLM for query
variants, retrieves candidates for each, merges them, and reranks the
union against the original query. Costs one extra LLM call + one Voyage
embed per variant, but recovers documents that don't share the user's
exact phrasing — e.g. ספר הליקויים when the user types "מהי תקנה 37".
"""
from __future__ import annotations
import asyncio
import logging
import os
from typing import Literal
from openai import AsyncOpenAI
from api.services.kb import voyage
from api.services.kb.db import get_pool
logger = logging.getLogger("shira.kb.search")
_RRF_K = 60 # standard RRF constant
_CANDIDATES_PER_SIDE = 30
# Number of fused RRF candidates fed to the reranker. Higher = better
# recall before the final cut; capped at ~30 to keep latency reasonable.
_RERANK_POOL = 30
# How many alternative phrasings to ask the LLM to generate when expand=True.
_EXPANSION_VARIANTS = 3
_EXPANSION_TIMEOUT_S = 12.0
async def _retrieve_rrf(
query: str,
kind: Literal["law", "regulation", "circular", "any"],
) -> list[dict]:
"""Run vector + lexical retrieval, fuse with RRF. No rerank, no top_k cut.
Each candidate dict carries `chunk_id` (kb_chunk.id) so callers can
deduplicate when merging results from multiple queries.
"""
[vec] = await voyage.embed([query], input_type="query")
kind_filter = ""
params: list = [vec, query, _CANDIDATES_PER_SIDE]
if kind != "any":
kind_filter = "AND s.kind = $4"
params.append(kind)
sql = f"""
WITH vec AS (
SELECT c.id, ROW_NUMBER() OVER (ORDER BY c.embedding <=> $1::vector) AS rank
FROM kb_chunk c
JOIN kb_source s ON s.id = c.source_id
WHERE c.embedding IS NOT NULL
AND s.superseded_by IS NULL
{kind_filter}
ORDER BY c.embedding <=> $1::vector
LIMIT $3
),
lex AS (
SELECT c.id, ROW_NUMBER() OVER (ORDER BY ts_rank_cd(c.content_tsv, q) DESC) AS rank
FROM kb_chunk c
JOIN kb_source s ON s.id = c.source_id,
websearch_to_tsquery('simple', $2) AS q
WHERE c.content_tsv @@ q
AND s.superseded_by IS NULL
{kind_filter}
ORDER BY ts_rank_cd(c.content_tsv, q) DESC
LIMIT $3
),
fused AS (
SELECT id, SUM(score) AS score FROM (
SELECT id, 1.0 / ({_RRF_K} + rank) AS score FROM vec
UNION ALL
SELECT id, 1.0 / ({_RRF_K} + rank) AS score FROM lex
) u GROUP BY id
)
SELECT
c.id AS chunk_id, c.chunk_index,
s.id AS source_id, s.kind, s.title, s.identifier, s.source_url,
s.published_at, s.effective_at, s.original_path,
c.heading_path, c.section_ref, c.content, c.page_number,
f.score
FROM fused f
JOIN kb_chunk c ON c.id = f.id
JOIN kb_source s ON s.id = c.source_id
ORDER BY f.score DESC
LIMIT {_RERANK_POOL}
"""
pool = await get_pool()
async with pool.acquire() as conn:
rows = await conn.fetch(sql, *params)
return [dict(r) for r in rows]
_EXPANSION_PROMPT = (
"אתה עוזר חיפוש בבסיס ידע משפטי של הביטוח הלאומי בישראל "
"(החוק, התקנות, ספרי המבחנים והליקויים, וחוזרי המוסד). "
"המשתמש שואל שאלה. החזר עד {n} ניסוחים חלופיים שיעזרו לאחזר "
"את אותו מידע ממסמכים משפטיים בעברית — תרגומים מסגנון שאלתי "
"לסגנון מסמך, מילים נרדפות (למשל 'תקנה 37''בדיקה מחדש', "
"'נכות''נכה'/'דרגת נכות'/'מוגבלות'), והוספת מונחים רפואיים/משפטיים "
"שלא מופיעים במפורש בשאלה. החזר ניסוח אחד לשורה, ללא מספור או הקדמה. "
"אל תחזור על הניסוח המקורי."
)
async def _expand_query(query: str) -> list[str]:
"""Ask the LLM for alternative phrasings. Empty list on failure (caller
just runs the original query)."""
base = (os.environ.get("AI_GATEWAY_URL") or "http://localhost:3000").rstrip("/")
api_key = os.environ.get("AI_GATEWAY_API_KEY", "")
if not api_key:
return []
client = AsyncOpenAI(base_url=f"{base}/v1", api_key=api_key)
try:
resp = await asyncio.wait_for(
client.chat.completions.create(
model=os.environ.get("CLAUDE_MODEL", "sonnet"),
messages=[
{"role": "system", "content": _EXPANSION_PROMPT.format(n=_EXPANSION_VARIANTS)},
{"role": "user", "content": query},
],
max_tokens=256,
temperature=0.3,
),
timeout=_EXPANSION_TIMEOUT_S,
)
except (asyncio.TimeoutError, Exception) as e:
logger.warning("[kb.search] query expansion failed: %s", e)
return []
text = (resp.choices[0].message.content or "").strip()
variants: list[str] = []
for line in text.splitlines():
v = line.strip(" -•·*\t").strip()
if not v or v == query or v in variants:
continue
variants.append(v)
if len(variants) >= _EXPANSION_VARIANTS:
break
return variants
async def _rerank_or_truncate(
query: str, candidates: list[dict], top_k: int,
) -> list[dict]:
"""Cross-encoder rerank against `query`; fall back to RRF order on error."""
rerank_disabled = os.environ.get("KB_RERANK_DISABLED", "").lower() in ("1", "true")
if rerank_disabled or len(candidates) <= top_k:
return candidates[:top_k]
texts = [c["content"] for c in candidates]
try:
ranked = await voyage.rerank(query=query, documents=texts, top_k=top_k)
except voyage.VoyageError as e:
logger.warning("[kb.search] rerank failed, falling back to RRF: %s", e)
return candidates[:top_k]
out: list[dict] = []
for r in ranked:
i = r["index"]
if 0 <= i < len(candidates):
out.append({**candidates[i], "rerank_score": r["relevance_score"]})
logger.info("[kb.search] rerank kept top %d / %d", len(out), len(candidates))
return out
async def search(
query: str,
kind: Literal["law", "regulation", "circular", "any"] = "any",
top_k: int = 8,
expand: bool = False,
) -> list[dict]:
query = (query or "").strip()
if not query:
return []
if not expand:
candidates = await _retrieve_rrf(query, kind)
logger.info(
"[kb.search] query=%r kind=%s RRF_candidates=%d",
query[:80], kind, len(candidates),
)
if not candidates:
return []
return await _rerank_or_truncate(query, candidates, top_k)
# Multi-query expansion: variants run in parallel with the original.
variants = await _expand_query(query)
queries = [query] + variants
logger.info("[kb.search] expand=true variants=%d", len(variants))
results = await asyncio.gather(
*[_retrieve_rrf(q, kind) for q in queries],
return_exceptions=True,
)
merged: dict[int, dict] = {}
for r in results:
if isinstance(r, Exception):
logger.warning("[kb.search] sub-retrieval failed: %s", r)
continue
for c in r:
cid = c["chunk_id"]
if cid not in merged or c["score"] > merged[cid]["score"]:
merged[cid] = c
candidates = sorted(merged.values(), key=lambda x: -x["score"])[:_RERANK_POOL]
logger.info(
"[kb.search] merged candidates=%d (from %d queries)",
len(candidates), len(queries),
)
if not candidates:
return []
return await _rerank_or_truncate(query, candidates, top_k)