Files
boshu2__agentops/docs/contracts/retrieval-comparison.md
T
Bo 62cc3b6ee0 Clear the operations-layer alignment residuals (#1054)
Closes out the six residual items #1051 disclosed: terminology residue
on non-authority surfaces, the eval command-surface fixture that failed
when executed (#{3,4} -> #{3,5}), the vacuous retrieval-quality canary
and the nightly job that ran it, the consumer-free dream config block
and its exclusive helpers, the remaining knowledge-shaped writers moved
to the scratch tier, and the MEMORY.md consumer audit.

bin/ralph still resumes legacy .agents/ralph/ checkpoints so the
documented backwards-compat contract holds without a migration; both
paths and the outside-both refusal are now tested.

Fresh author-distinct validation returned PASS with empty not_checked,
after an earlier revision failed on a dangling nightly invoker and a
back-compat test regression that were fixed and independently
re-verified.

Test-Removal-Reason: the dream config subsystem was deleted with its tests (operations-layer residuals)
2026-08-08 14:34:14 -04:00

3.0 KiB

Retrieval Comparison Contract (dormant)

Status (2026-08-07): dormant. The retrieval-bench surface is fully retired: the ao eval bench seat is deliberately unwired, the Go tests the former comparison smoke named were deleted with their implementation, and the smoke itself was removed once it could no longer execute anything (a canary that runs zero tests is theater, not proof). The one live retrieval guard is the blocking always.retrieval-manifest-paths gate, which keeps the checked-in eval manifest's ground-truth paths resolvable. The sections below are retained as the binding policy for any future retrieval-backend revival; they govern nothing until such an implementation exists and brings its own executable comparison smoke.

Report Shape

Comparison JSON is an object with:

  • id, manifest_path, search_root, queries, and k
  • backends, an array of per-backend reports

Each backend report must include:

  • backend
  • queries, k, hits, and missing_ground_truth
  • any_relevant_at_k
  • avg_precision_at_k
  • mean_reciprocal_rank
  • results, with per-query result paths and hit metadata

All fields are additive relative to legacy single-backend JSON unless explicitly documented in a future versioned contract.

Backend Semantics

  • local-lexical is the canonical default backend.
  • ao-auto is a deterministic file-backed adapter. It may select an internal strategy, but it must not require services or network access.
  • agentic-rg is the deterministic file-backed search adapter for repository knowledge surfaces and session turns.
  • wiki-link-expand starts from file-backed results, expands local wiki-style links, and may only return existing paths under allowed repository knowledge roots.
  • rerank-llamacpp is opt-in. When AGENTOPS_RETRIEVAL_RERANK_ENDPOINT is unset, it returns the base file-backed ordering. When set, the endpoint may reorder candidates only; it must not introduce unknown paths.

Every backend result path must resolve under the allowed search roots and exist at evaluation time.

Promotion Thresholds

A backend can replace local-lexical as the default only when all of these are true:

  • The comparison smoke passes.
  • any_relevant_at_k is greater than or equal to local-lexical.
  • mean_reciprocal_rank is greater than or equal to local-lexical.
  • missing_ground_truth does not increase.
  • The result is stable across at least two consecutive checked-in evidence runs or an equivalent reviewable CI artifact.

rerank-llamacpp cannot become the default while its endpoint is only an operator-local environment variable. Promotion requires repo-owned endpoint configuration, documented failure behavior, and the same offline fallback contract.

Deferred Stores

Qdrant and Neo4j remain deferred. Reconsider them only after file-backed comparison metrics justify the added lifecycle cost, and only through a separate contract that covers service startup, persistence, data migration, fallback behavior, and CI/offline operation.