Compare commits

..
Author SHA1 Message Date
Garry TanandClaude Fable 5 89579780e0 fix(embed): extend #1717 model labeling to the embed-backfill stale path
src/core/embed-stale.ts (used by the embed-backfill minion handler) built
its merged ChunkInput without a model field, so every chunk on a touched
page — re-embedded AND preserved — was relabeled to the engine default on
each backfill pass. Mirror the embed.ts semantics: stamp the resolved
gateway label on re-embedded chunks, carry the existing label on untouched
ones. Pinned by a PGLite test that fails without the fix.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-22 11:06:16 -07:00
cf2deedfc6 fix(embed): label content_chunks.model with the model that produced the vector (#1717)
The embed paths (embedPage, embedAll, embedAllStale) and the inline
import/sync embed paths built ChunkInput[] without a model field, so the
engines' upsertChunks defaulted content_chunks.model to the hardcoded
DEFAULT_EMBEDDING_MODEL instead of the gateway-configured model that
actually produced the vector.

- New core helper resolveEmbeddingModelLabel() in src/core/embedding.ts
  (returns the resolved gateway model, undefined when unconfigured).
- embed.ts: stamp the label on (re)embedded chunks in all three paths;
  chunks preserved from a prior embed keep their existing model so a
  mixed-model page isn't relabeled wholesale.
- import-file.ts: stamp the label on inline-embedded markdown chunks and
  re-embedded code chunks; reused (incremental) code-chunk embeddings
  carry their existing model label forward.

Takeover of PR #1803 (rebased onto master over the pace-mode changes;
helper moved into core so import-file.ts can share it).

Co-authored-by: harjothkhara <harjothkhara@users.noreply.github.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-21 14:42:17 -07:00
21 changed files with 147 additions and 439 deletions
File diff suppressed because one or more lines are too long
-4
View File
@@ -85,10 +85,6 @@ gbrain get media/articles/<slug>
# 5. Cross-link entities
# For every person/company mentioned, add a timeline back-link.
# Mark NEW pages minted for article subjects the reader only reads ABOUT
# (not personal contacts) as reference: `gbrain reference <slug>`
# (or reference: true in frontmatter). Exempts them from coverage nudges;
# they stay searchable. Default for real contacts: do NOT set it.
```
## Quality bar
-7
View File
@@ -273,13 +273,6 @@ Cross-link entities mentioned in the analysis:
- For every person the right column references with a brain page, add a
back-link from `people/<slug>` to the new `media/books/<slug>-personalized`
page (per `conventions/quality.md` Iron Law).
- **Mark book figures as reference entities.** Any NEW person/company page you
mint for a figure from the book (an author, a historical figure, a company
the book discusses) — someone the reader reads ABOUT but doesn't personally
interact with — should be flagged: `gbrain reference <slug>` (or
`reference: true` in frontmatter). They stay fully searchable/linkable but
are exempt from coverage nudges (timeline/links). Skip this for anyone the
reader actually knows. Default for normal contacts: do NOT set it.
## Quality bar (the bar)
-62
View File
@@ -1,62 +0,0 @@
# Convention: Reference entities (canon figures)
Some person/company pages are people/orgs the user **reads about** but does not
personally interact with — a book's author, a historical figure, a company an
article discusses (Andy Grove, Kleiner Perkins, Intel…). They are real
knowledge, worth a page, but they have **no dated history in the user's own
life**, so the entity coverage metrics (`timeline_coverage`,
`entity_link_coverage`) flag them as permanently incomplete with no honest fix.
The `reference: true` frontmatter flag resolves this.
## What it does
- A page with `reference: true` is **exempt from the entity coverage metrics
only** (`timeline_coverage`, `entity_link_coverage`, and their onboard
nudges).
- It keeps its real `type` (`person` / `company`), so it stays **fully
searchable, enrichable, linkable, and edge-resolvable**. NOTHING about
retrieval changes — this is the whole reason it's a flag, not a new `type`.
- It is **opt-in**. Absent / `false` / anything-but-`true` = a normal entity
that DOES count toward coverage. **This is the default — do not set it on real
contacts.**
## When to set it
Set `reference: true` when the entity is a figure/org the user reads ABOUT, not
someone they deal with:
- authors and figures discussed in a book (book-mirror) or article
(article-enrichment)
- historical / canon figures imported as reference knowledge
- companies named only as examples in source material
Do NOT set it for people the user actually meets, emails, or works with — those
are normal entities whose missing timeline/links is a real, actionable gap.
## How to set it
```bash
gbrain reference <slug> # mark as reference
gbrain reference <slug> --unset # back to a normal entity
```
The command writes the flag to BOTH the markdown frontmatter (durable; survives
re-ingest / engine rebuild — markdown is the source of truth) AND the engine
JSONB (so coverage reflects it immediately, no re-sync). It's idempotent. You
can also hand-edit frontmatter (`reference: true`) and re-ingest.
## Why a flag, not a type
A new `type: reference-person` would drop the page out of every
`type IN ('person','company')` filter — search, enrichment, whoknows, link
inference — so you'd lose the figure everywhere, not just the metric. The flag
narrows the change to exactly the coverage denominators and nothing else.
## Implementation
`src/core/reference-flag.ts``referenceExclusionSql(alias?)` is the single
source of truth for the predicate `(frontmatter->>'reference') IS DISTINCT FROM
'true'`, ANDed into both numerator and denominator at every coverage site
(getHealth in both engines, onboard/checks.ts, init-nudge.ts). Backed by the GIN
index on `pages.frontmatter`.
-12
View File
@@ -268,18 +268,6 @@ Active items, pending decisions, things to track.
- **YYYY-MM-DD** | Event description [Source: ...]
```
### Reference entities (canon figures)
If the entity is someone/something the user reads ABOUT but does not personally
interact with — a book author, a historical figure, a company discussed in an
article — mark the page as reference: `gbrain reference <slug>` (or
`reference: true` in frontmatter). Reference pages keep their `person`/`company`
type and stay fully searchable, enrichable, and linkable; they are only exempt
from the entity coverage nudges (timeline/links) that don't apply to figures
with no dated history in the user's own life. **Default: do NOT set it** — real
people and companies the user deals with are normal entities. Full convention:
`conventions/reference-entities.md`.
### Step 7: Cross-reference
- Update company pages from person enrichment (and vice versa)
-5
View File
@@ -270,11 +270,6 @@ Populate them periodically or after major imports:
- `gbrain stats` — verify `link_count > 0` and `timeline_entry_count > 0` after extraction.
- `gbrain health` — review `link_coverage` and `timeline_coverage` percentages
on entity pages (person/company). Below 50% means more extraction is needed.
Note: pages flagged `reference: true` (canon/reference figures the user only
reads about) are EXEMPT from these two metrics — if coverage looks stuck
because of book/article-imported figures with no real history, mark them with
`gbrain reference <slug>` rather than chasing the percentage. See
`conventions/reference-entities.md`.
Available link types (use with `gbrain graph-query --type`):
`attended`, `works_at`, `invested_in`, `founded`, `advises`, `mentions`, `source`.
+1 -6
View File
@@ -54,7 +54,7 @@ export function bigintToStringReplacer(_key: string, value: unknown): unknown {
}
// CLI-only commands that bypass the operation layer
export const CLI_ONLY = new Set(['init', 'reinit-pglite', 'upgrade', 'post-upgrade', 'check-update', 'integrations', 'publish', 'check-backlinks', 'lint', 'report', 'import', 'export', 'files', 'embed', 'serve', 'call', 'config', 'doctor', 'migrate', 'eval', 'sync', 'extract', 'extract-conversation-facts', 'enrich', 'reference', 'features', 'autopilot', 'graph-query', 'jobs', 'agent', 'apply-migrations', 'skillpack-check', 'skillpack', 'resolvers', 'integrity', 'repair-jsonb', 'orphans', 'sources', 'mounts', 'dream', 'check-resolvable', 'routing-eval', 'skillify', 'smoke-test', 'providers', 'storage', 'repos', 'code-def', 'code-refs', 'reindex', 'reindex-code', 'reindex-frontmatter', 'code-callers', 'code-callees', 'reconcile-links', 'frontmatter', 'auth', 'friction', 'claw-test', 'book-mirror', 'takes', 'think', 'salience', 'anomalies', 'calibration', 'transcripts', 'models', 'remote', 'recall', 'forget', 'edges-backfill', 'cache', 'ze-switch', 'founder', 'brainstorm', 'lsd', 'schema', 'capture', 'onboard', 'conversation-parser', 'status', 'connect', 'skillopt', 'quarantine', 'self-upgrade', 'advisor', 'watch', 'reindex-search-vector']);
export const CLI_ONLY = new Set(['init', 'reinit-pglite', 'upgrade', 'post-upgrade', 'check-update', 'integrations', 'publish', 'check-backlinks', 'lint', 'report', 'import', 'export', 'files', 'embed', 'serve', 'call', 'config', 'doctor', 'migrate', 'eval', 'sync', 'extract', 'extract-conversation-facts', 'enrich', 'features', 'autopilot', 'graph-query', 'jobs', 'agent', 'apply-migrations', 'skillpack-check', 'skillpack', 'resolvers', 'integrity', 'repair-jsonb', 'orphans', 'sources', 'mounts', 'dream', 'check-resolvable', 'routing-eval', 'skillify', 'smoke-test', 'providers', 'storage', 'repos', 'code-def', 'code-refs', 'reindex', 'reindex-code', 'reindex-frontmatter', 'code-callers', 'code-callees', 'reconcile-links', 'frontmatter', 'auth', 'friction', 'claw-test', 'book-mirror', 'takes', 'think', 'salience', 'anomalies', 'calibration', 'transcripts', 'models', 'remote', 'recall', 'forget', 'edges-backfill', 'cache', 'ze-switch', 'founder', 'brainstorm', 'lsd', 'schema', 'capture', 'onboard', 'conversation-parser', 'status', 'connect', 'skillopt', 'quarantine', 'self-upgrade', 'advisor', 'watch', 'reindex-search-vector']);
// CLI-only commands whose handlers print their own --help text. These are
// excluded from the generic short-circuit so detailed per-command and
// per-subcommand usage stays reachable.
@@ -1652,11 +1652,6 @@ async function handleCliOnly(command: string, args: string[]) {
await runFiles(engine, args);
break;
}
case 'reference': {
const { runReference } = await import('./commands/reference.ts');
await runReference(engine, args);
break;
}
case 'embed': {
const { runEmbed } = await import('./commands/embed.ts');
await runEmbed(engine, args);
+14 -1
View File
@@ -1,5 +1,5 @@
import type { BrainEngine } from '../core/engine.ts';
import { embedBatch, currentEmbeddingSignature } from '../core/embedding.ts';
import { embedBatch, currentEmbeddingSignature, resolveEmbeddingModelLabel } from '../core/embedding.ts';
import type { ChunkInput } from '../core/types.ts';
import { chunkText } from '../core/chunkers/recursive.ts';
import { createProgress, type ProgressReporter } from '../core/progress.ts';
@@ -581,11 +581,16 @@ async function embedPage(
for (let j = 0; j < toEmbed.length; j++) {
embeddingMap.set(toEmbed[j].chunk_index, embeddings[j]);
}
// #1717: label each (re)embedded chunk with the model that actually
// produced its vector. Preserved chunks (not re-embedded this pass) keep
// their existing model so a mixed-model page isn't relabeled wholesale.
const embedModelLabel = resolveEmbeddingModelLabel();
const updated: ChunkInput[] = chunks.map(c => ({
chunk_index: c.chunk_index,
chunk_text: c.chunk_text,
chunk_source: c.chunk_source,
embedding: embeddingMap.get(c.chunk_index),
model: embeddingMap.has(c.chunk_index) && embedModelLabel ? embedModelLabel : c.model,
token_count: c.token_count || Math.ceil(c.chunk_text.length / 4),
}));
@@ -717,12 +722,16 @@ async function embedAll(
for (let j = 0; j < toEmbed.length; j++) {
embeddingMap.set(toEmbed[j].chunk_index, embeddings[j]);
}
// #1717: stamp the resolved embedding model on (re)embedded chunks;
// preserve the existing model on chunks left untouched.
const embedModelLabel = resolveEmbeddingModelLabel();
// Preserve ALL chunks, only update embeddings for stale ones
const updated: ChunkInput[] = chunks.map(c => ({
chunk_index: c.chunk_index,
chunk_text: c.chunk_text,
chunk_source: c.chunk_source,
embedding: embeddingMap.get(c.chunk_index) ?? undefined,
model: embeddingMap.has(c.chunk_index) && embedModelLabel ? embedModelLabel : c.model,
token_count: c.token_count || Math.ceil(c.chunk_text.length / 4),
}));
await observed(pacer, () => engine.upsertChunks(page.slug, updated, pageOpts));
@@ -1012,11 +1021,15 @@ async function embedAllStale(
for (let j = 0; j < stale.length; j++) {
staleIdxToEmbedding.set(stale[j].chunk_index, embeddings[j]);
}
// #1717: label the re-embedded (stale) chunks with the resolved
// model; preserve the existing model on the non-stale chunks.
const embedModelLabel = resolveEmbeddingModelLabel();
const merged: ChunkInput[] = existing.map(c => ({
chunk_index: c.chunk_index,
chunk_text: c.chunk_text,
chunk_source: c.chunk_source,
embedding: staleIdxToEmbedding.get(c.chunk_index) ?? undefined,
model: staleIdxToEmbedding.has(c.chunk_index) && embedModelLabel ? embedModelLabel : c.model,
token_count: c.token_count || Math.ceil(c.chunk_text.length / 4),
}));
await observed(pacer, () => engine.upsertChunks(slug, merged, { sourceId: keySourceId }));
-130
View File
@@ -1,130 +0,0 @@
// gbrain reference <slug> [--unset] [--brain <dir>] [--json]
//
// Mark (or unmark) a page as a reference-only entity. A reference page keeps its
// real type (person/company) — fully searchable/enrichable/linkable — but is
// exempt from the entity coverage metrics (timeline_coverage,
// entity_link_coverage). See src/core/reference-flag.ts for the rationale.
//
// Durability: the flag is written to BOTH the markdown frontmatter (source of
// truth; survives re-ingest / engine rebuild) AND the engine `pages.frontmatter`
// JSONB (so the metric reflects it immediately, no re-sync needed).
import { existsSync, readFileSync, writeFileSync } from 'node:fs';
import { isAbsolute, join, resolve } from 'node:path';
import { setCliExitVerdict } from '../core/cli-force-exit.ts';
import type { BrainEngine } from '../core/engine.ts';
import { REFERENCE_FRONTMATTER_KEY } from '../core/reference-flag.ts';
import { resolveSourceId } from '../core/source-resolver.ts';
/** Insert/replace/remove `reference: true` in a markdown frontmatter block.
* Minimal-diff: only the one line changes; key order is otherwise preserved. */
export function applyReferenceFrontmatter(content: string, on: boolean): string {
const keyLine = `${REFERENCE_FRONTMATTER_KEY}: true`;
const block = content.match(/^---\n([\s\S]*?)\n---/);
if (!block) {
// No frontmatter. Nothing to remove; if setting, prepend a block.
if (!on) return content;
return `---\n${keyLine}\n---\n\n${content}`;
}
let fm = block[1];
const hasKey = new RegExp(`^${REFERENCE_FRONTMATTER_KEY}:.*$`, 'm').test(fm);
if (on) {
fm = hasKey
? fm.replace(new RegExp(`^${REFERENCE_FRONTMATTER_KEY}:.*$`, 'm'), keyLine)
: `${fm}\n${keyLine}`;
} else {
if (!hasKey) return content;
fm = fm.replace(new RegExp(`^${REFERENCE_FRONTMATTER_KEY}:.*$\\n?`, 'm'), '');
}
// Function replacement so YAML chars ($, & …) in fm aren't treated as
// replacement patterns.
return content.replace(/^---\n[\s\S]*?\n---/, () => `---\n${fm}\n---`);
}
function parseArgs(args: string[]): { slug?: string; unset: boolean; json: boolean; brain?: string; source?: string } {
let slug: string | undefined;
let unset = false;
let json = false;
let brain: string | undefined;
let source: string | undefined;
for (let i = 0; i < args.length; i++) {
const a = args[i];
if (a === '--unset') unset = true;
else if (a === '--json') json = true;
else if (a === '--brain' || a === '--dir') brain = args[++i];
else if (a === '--source') source = args[++i];
else if (!a.startsWith('--') && !slug) slug = a;
}
return { slug, unset, json, brain, source };
}
async function resolveBrainDir(engine: BrainEngine, explicit?: string): Promise<string | null> {
if (explicit) return resolve(explicit);
const configured = await engine.getConfig('sync.repo_path');
if (configured && existsSync(configured)) return resolve(configured);
return null;
}
export async function runReference(engine: BrainEngine, args: string[]): Promise<void> {
const { slug, unset, json, brain, source } = parseArgs(args);
if (!slug) {
console.error('Usage: gbrain reference <slug> [--unset] [--source <id>] [--brain <dir>] [--json]');
setCliExitVerdict(2);
return;
}
const brainDir = await resolveBrainDir(engine, brain);
if (!brainDir) {
console.error('reference: could not resolve brain dir. Pass --brain <dir> or set sync.repo_path.');
setCliExitVerdict(1);
return;
}
const rel = slug.endsWith('.md') ? slug : `${slug}.md`;
const filePath = isAbsolute(rel) ? rel : join(brainDir, rel);
if (!existsSync(filePath)) {
console.error(`reference: page not found on disk: ${filePath}`);
setCliExitVerdict(1);
return;
}
// 1) Durable: edit the markdown frontmatter.
const before = readFileSync(filePath, 'utf8');
const after = applyReferenceFrontmatter(before, !unset);
const fileChanged = after !== before;
if (fileChanged) writeFileSync(filePath, after, 'utf8');
// 2) Immediate: update the engine frontmatter JSONB so the metric reflects it
// without waiting for a re-sync. Scoped to (source_id, slug) — slug is only
// unique per source, so a bare-slug UPDATE would clobber same-named pages
// in every other source. Resolve the source from the brain dir (tier-4
// local_path match) unless --source / GBRAIN_SOURCE overrides.
const cleanSlug = slug.replace(/\.md$/, '');
const sourceId = await resolveSourceId(engine, source ?? null, brainDir);
if (unset) {
await engine.executeRaw(
`UPDATE pages SET frontmatter = frontmatter - '${REFERENCE_FRONTMATTER_KEY}' WHERE slug = $1 AND source_id = $2`,
[cleanSlug, sourceId],
);
} else {
await engine.executeRaw(
`UPDATE pages SET frontmatter = jsonb_set(COALESCE(frontmatter, '{}'::jsonb), '{${REFERENCE_FRONTMATTER_KEY}}', 'true'::jsonb) WHERE slug = $1 AND source_id = $2`,
[cleanSlug, sourceId],
);
}
const result = { slug: cleanSlug, source_id: sourceId, reference: !unset, file_changed: fileChanged, file: filePath };
if (json) {
console.log(JSON.stringify(result));
} else {
const verb = unset ? 'unmarked' : 'marked';
console.log(`${verb} ${cleanSlug} as reference=${!unset}${fileChanged ? '' : ' (frontmatter already current)'}`);
if (!unset) {
console.log(' → exempt from timeline_coverage / entity_link_coverage; still fully searchable & linkable.');
}
}
}
+7
View File
@@ -20,6 +20,7 @@
import type { BrainEngine } from './engine.ts';
import type { ChunkInput } from './types.ts';
import { embedBatchWithBackoff } from '../commands/embed.ts';
import { resolveEmbeddingModelLabel } from './embedding.ts';
import { type DbPacer, createNoopPacer, observed } from './db-pacer.ts';
import { AbortError } from './abort-check.ts';
@@ -200,11 +201,17 @@ export async function embedStaleForSource(
for (let j = 0; j < stale.length; j++) {
staleIdxToEmbedding.set(stale[j].chunk_index, embeddings[j]);
}
// #1717: label re-embedded chunks with the model that produced the
// vector; preserved chunks keep their existing model. Without this,
// upsertChunks falls back to DEFAULT_EMBEDDING_MODEL for every chunk
// (the same mislabel the embed.ts paths fixed).
const embedModelLabel = resolveEmbeddingModelLabel();
const merged: ChunkInput[] = existing.map((c) => ({
chunk_index: c.chunk_index,
chunk_text: c.chunk_text,
chunk_source: c.chunk_source,
embedding: staleIdxToEmbedding.get(c.chunk_index) ?? undefined,
model: staleIdxToEmbedding.has(c.chunk_index) && embedModelLabel ? embedModelLabel : c.model,
token_count: c.token_count || Math.ceil(c.chunk_text.length / 4),
// Carry through per-chunk metadata. upsertChunks writes these as
// EXCLUDED.<col> (not COALESCE), so omitting them here resets image
+15
View File
@@ -113,6 +113,21 @@ export async function embedBatch(
return results;
}
/**
* Resolve the embedding model label (`provider:model`) to stamp onto
* `content_chunks.model`, so each chunk records the model that actually
* produced its vector instead of the engine's hardcoded default (#1717).
* Returns undefined if the gateway is unconfigured; callers then fall back
* to the chunk's existing model rather than mislabeling it.
*/
export function resolveEmbeddingModelLabel(): string | undefined {
try {
return gatewayGetModel();
} catch {
return undefined;
}
}
/** Currently-configured embedding model (short form without provider prefix). */
export function getEmbeddingModelName(): string {
return gatewayGetModel().split(':').slice(1).join(':') || 'text-embedding-3-large';
+11 -1
View File
@@ -8,7 +8,7 @@ import { chunkText } from './chunkers/recursive.ts';
import { chunkCodeText, chunkCodeTextFull, detectCodeLanguage, CHUNKER_VERSION } from './chunkers/code.ts';
import { findChunkForOffset } from './chunkers/edge-extractor.ts';
import { extractCodeRefs, imageOfCandidates } from './link-extraction.ts';
import { embedBatch, embedMultimodal, currentEmbeddingSignature } from './embedding.ts';
import { embedBatch, embedMultimodal, currentEmbeddingSignature, resolveEmbeddingModelLabel } from './embedding.ts';
import { slugifyPath, slugifyCodePath, isCodeFilePath } from './sync.ts';
import type { ChunkInput, PageInput, PageType } from './types.ts';
import { computeEffectiveDate } from './effective-date.ts';
@@ -716,8 +716,12 @@ export async function importFromContent(
? chunks.map((c) => wrapChunkForEmbedding(c.chunk_text, prefix, c.chunk_source))
: chunks.map((c) => c.chunk_text);
const embeddings = await embedBatch(wrappedTexts);
// #1717: label each chunk with the model that actually produced its
// vector, not the engine's hardcoded default.
const embedModelLabel = resolveEmbeddingModelLabel();
for (let i = 0; i < chunks.length; i++) {
chunks[i].embedding = embeddings[i];
if (embedModelLabel) chunks[i].model = embedModelLabel;
// token_count tracks the wrapped string length so cost reporting
// reflects what we actually sent to the embedder.
chunks[i].token_count = Math.ceil(wrappedTexts[i].length / 4);
@@ -1141,7 +1145,10 @@ export async function importCodeFile(
const matched = existingByKey.get(key);
if (matched && matched.embedding) {
// Reuse the existing embedding verbatim. No API call, no cost.
// #1717: carry the existing model label along with the reused vector
// so the upsert doesn't relabel it with the engine default.
chunks[i]!.embedding = matched.embedding as Float32Array;
chunks[i]!.model = matched.model ?? undefined;
chunks[i]!.token_count = matched.token_count ?? undefined;
} else {
needsEmbedIndexes.push(i);
@@ -1153,9 +1160,12 @@ export async function importCodeFile(
try {
const textsToEmbed = needsEmbedIndexes.map((i) => chunks[i]!.chunk_text);
const embeddings = await embedBatch(textsToEmbed);
// #1717: stamp the model that produced these vectors.
const embedModelLabel = resolveEmbeddingModelLabel();
for (let j = 0; j < needsEmbedIndexes.length; j++) {
const i = needsEmbedIndexes[j]!;
chunks[i]!.embedding = embeddings[j]!;
if (embedModelLabel) chunks[i]!.model = embedModelLabel;
chunks[i]!.token_count = Math.ceil(chunks[i]!.chunk_text.length / 4);
}
} catch (e: unknown) {
+2 -7
View File
@@ -18,7 +18,6 @@
import type { BrainEngine } from '../engine.ts';
import type { RemediationStep } from '../remediation-step.ts';
import { makeRemediationStep } from '../remediation-step.ts';
import { referenceExclusionSql } from '../reference-flag.ts';
/** Shared shape returned by all four checks. */
export interface OnboardCheckResult {
@@ -121,8 +120,7 @@ export async function checkEntityLinkCoverage(
engine,
`SELECT COUNT(*) AS count FROM pages
WHERE type IN ('person', 'company', 'organization', 'entity')
AND deleted_at IS NULL
AND ${referenceExclusionSql()}`,
AND deleted_at IS NULL`,
);
if (totalEntities === 0) {
@@ -146,7 +144,6 @@ export async function checkEntityLinkCoverage(
SELECT p.id FROM pages p ${sampleClause}
WHERE p.type IN ('person', 'company', 'organization', 'entity')
AND p.deleted_at IS NULL
AND ${referenceExclusionSql('p')}
AND EXISTS (SELECT 1 FROM links l WHERE l.to_page_id = p.id)
) sub`,
);
@@ -218,8 +215,7 @@ export async function checkTimelineCoverage(
engine,
`SELECT COUNT(*) AS count FROM pages
WHERE type IN ('person', 'company', 'organization', 'entity')
AND deleted_at IS NULL
AND ${referenceExclusionSql()}`,
AND deleted_at IS NULL`,
);
if (totalEntities === 0) {
@@ -241,7 +237,6 @@ export async function checkTimelineCoverage(
SELECT p.id FROM pages p ${sampleClause}
WHERE p.type IN ('person', 'company', 'organization', 'entity')
AND p.deleted_at IS NULL
AND ${referenceExclusionSql('p')}
AND EXISTS (SELECT 1 FROM timeline_entries t WHERE t.page_id = p.id)
) sub`,
);
+1 -5
View File
@@ -14,7 +14,6 @@
// also short-circuits (CI/scripted callers see nothing).
import type { BrainEngine } from '../engine.ts';
import { referenceExclusionSql } from '../reference-flag.ts';
const NUDGE_BUDGET_MS = 3000;
@@ -58,8 +57,7 @@ export async function runInitNudge(engine: BrainEngine): Promise<void> {
engine.executeRaw<{ count: string | number }>(
`SELECT COUNT(*) AS count FROM pages
WHERE type IN ('person', 'company', 'organization', 'entity')
AND deleted_at IS NULL
AND ${referenceExclusionSql()}`,
AND deleted_at IS NULL`,
[],
{ signal: controller.signal },
),
@@ -67,7 +65,6 @@ export async function runInitNudge(engine: BrainEngine): Promise<void> {
`SELECT COUNT(*) AS count FROM pages p
WHERE p.type IN ('person', 'company', 'organization', 'entity')
AND p.deleted_at IS NULL
AND ${referenceExclusionSql('p')}
AND EXISTS (SELECT 1 FROM links l WHERE l.to_page_id = p.id)`,
[],
{ signal: controller.signal },
@@ -76,7 +73,6 @@ export async function runInitNudge(engine: BrainEngine): Promise<void> {
`SELECT COUNT(*) AS count FROM pages p
WHERE p.type IN ('person', 'company', 'organization', 'entity')
AND p.deleted_at IS NULL
AND ${referenceExclusionSql('p')}
AND EXISTS (SELECT 1 FROM timeline_entries t WHERE t.page_id = p.id)`,
[],
{ signal: controller.signal },
-2
View File
@@ -23,7 +23,6 @@ import { runMigrations } from './migrate.ts';
import { PGLITE_SCHEMA_SQL, getPGLiteSchema } from './pglite-schema.ts';
import { DEFAULT_EMBEDDING_MODEL, DEFAULT_EMBEDDING_DIMENSIONS } from './ai/defaults.ts';
import { DELETE_BATCH_SIZE } from './engine-constants.ts';
import { referenceExclusionSql } from './reference-flag.ts';
import { MARKDOWN_CHUNKER_VERSION } from './chunkers/recursive.ts';
import { acquireLock, releaseLock, type LockHandle } from './pglite-lock.ts';
import { getFtsLanguage } from './fts-language.ts';
@@ -5203,7 +5202,6 @@ export class PGLiteEngine implements BrainEngine {
const { rows: [h] } = await this.db.query(`
WITH entity_pages AS (
SELECT id, slug FROM pages WHERE type IN ('person', 'company')
AND ${referenceExclusionSql()}
)
SELECT
(SELECT count(*) FROM pages) as page_count,
-5
View File
@@ -5320,12 +5320,7 @@ export class PostgresEngine implements BrainEngine {
// is working as intended, not an orphan.
const [h] = await sql`
WITH entity_pages AS (
-- reference:true pages are exempt from coverage metrics.
-- Inlined (postgres.js tagged-template interpolation = bound param,
-- not raw SQL); keep in sync with referenceExclusionSql() in
-- reference-flag.ts.
SELECT id, slug FROM pages WHERE type IN ('person', 'company')
AND (frontmatter->>'reference') IS DISTINCT FROM 'true'
)
SELECT
(SELECT count(*) FROM pages) as page_count,
-37
View File
@@ -1,37 +0,0 @@
// Reference / canon entities.
//
// A page with frontmatter `reference: true` is a reference-only entity — a
// figure or organization imported from a book / article / external source that
// the user reads ABOUT but does not actively interact with (e.g. Andy Grove,
// Kleiner Perkins). It keeps its real `type` (`person` / `company`), so it stays
// fully searchable, enrichable, linkable, and edge-resolvable — NOTHING about
// retrieval changes.
//
// The ONLY behavior it opts out of is the entity *coverage* metrics
// (`timeline_coverage`, `entity_link_coverage` + their onboard-nudge mirrors).
// Those metrics nudge "this entity should accumulate dated history / inbound
// links"; that assumption is right for people you actually deal with and wrong
// for canon imports, which have no dated events in the user's life. Excluding
// them keeps the metric honest and actionable instead of permanently red.
//
// Opt-in: absent / false / anything-but-true = normal entity (the default).
// Set via `gbrain reference <slug>` (or hand-edit frontmatter).
export const REFERENCE_FRONTMATTER_KEY = 'reference';
/**
* SQL predicate (true for NON-reference pages) to AND into entity-coverage
* denominators AND numerators so the ratio stays consistent. JSONB `->>` yields
* text; `IS DISTINCT FROM 'true'` treats absent (NULL) and every non-true value
* as a normal counted entity. Backed by the GIN index on `pages.frontmatter`.
*
* @param alias optional table alias (e.g. 'p' for `pages p`); omit for bare `pages`.
*
* NOTE: postgres-engine.ts uses a postgres.js tagged template where `${}` is a
* bound parameter, not raw SQL, so it inlines this predicate literally — keep
* the two in sync.
*/
export function referenceExclusionSql(alias = ''): string {
const col = alias ? `${alias}.frontmatter` : 'frontmatter';
return `(${col}->>'${REFERENCE_FRONTMATTER_KEY}') IS DISTINCT FROM 'true'`;
}
+46
View File
@@ -15,6 +15,7 @@ import { describe, test, expect, beforeAll, afterAll, beforeEach } from 'bun:tes
import { PGLiteEngine } from '../src/core/pglite-engine.ts';
import { resetPgliteState } from './helpers/reset-pglite.ts';
import { embedStaleForSource } from '../src/core/embed-stale.ts';
import { configureGateway, resetGateway } from '../src/core/ai/gateway.ts';
import type { ChunkInput } from '../src/core/types.ts';
let engine: PGLiteEngine;
@@ -276,4 +277,49 @@ describe('embedStaleForSource', () => {
// The stale text row actually got its embedding.
expect(txtRow.embedded_at).not.toBeNull();
});
// #1717: the backfill path must label re-embedded chunks with the model
// that produced the vector, and preserve the existing label on chunks it
// did not touch (before the fix, both were reset to the engine default).
test('labels re-embedded chunks with the gateway model, preserves untouched labels (#1717)', async () => {
configureGateway({
embedding_model: 'openai:text-embedding-3-large',
env: { OPENAI_API_KEY: 'sk-test-embed-stale-1717' },
});
try {
await engine.putPage('notes/model-label', {
type: 'note',
title: 'model-label',
compiled_truth: '# model-label\n\nseeded',
});
await engine.upsertChunks('notes/model-label', [
{
chunk_index: 0,
chunk_text: 'already embedded elsewhere',
chunk_source: 'compiled_truth',
embedding: new Float32Array(1536).fill(0.01),
model: 'voyage:voyage-3',
token_count: 4,
},
{
chunk_index: 1,
chunk_text: 'stale chunk needing embed',
chunk_source: 'compiled_truth',
token_count: 5,
embedding: undefined, // stale
},
]);
const result = await embedStaleForSource(engine, 'default', { embedFn: fakeEmbedFn });
expect(result.embedded).toBe(1);
const after = await engine.getChunks('notes/model-label');
const preserved = after.find((c) => c.chunk_index === 0)!;
const reembedded = after.find((c) => c.chunk_index === 1)!;
expect(reembedded.model).toBe('openai:text-embedding-3-large');
expect(preserved.model).toBe('voyage:voyage-3');
} finally {
resetGateway();
}
});
});
+33
View File
@@ -37,6 +37,8 @@ mock.module('../src/core/embedding.ts', () => ({
// setPageEmbeddingSignature / invalidateStaleSignatureEmbeddings resolve to
// null via the Proxy default, so the signature value is inert here.
currentEmbeddingSignature: () => 'test:model:1536',
// #1717: embed paths stamp this label on (re)embedded chunks.
resolveEmbeddingModelLabel: () => 'openai:text-embedding-3-large',
}));
// Import AFTER mocking.
@@ -803,3 +805,34 @@ describe('embedAllStale --source threading (D7)', () => {
expect((firstCallOpts as { sourceId?: string }).sourceId).toBe('media-corpus');
});
});
// #1717: content_chunks.model must record the model that actually produced
// each vector, not the gateway/engine default.
describe('content_chunks.model labeling (#1717)', () => {
test('stamps the resolved embedding model on re-embedded chunks, preserves it on untouched chunks', async () => {
let upserted: any[] | undefined;
// Chunk 0 is stale (no embedded_at) → gets re-embedded this pass.
// Chunk 1 is already embedded with a DIFFERENT model → must be preserved,
// not relabeled to the current model.
const chunks = [
{ chunk_index: 0, chunk_text: 'a', chunk_source: 'compiled_truth', embedded_at: null, model: 'zeroentropyai:zembed-1', token_count: 1 },
{ chunk_index: 1, chunk_text: 'b', chunk_source: 'compiled_truth', embedded_at: '2026-01-01', embedding: new Float32Array(1536), model: 'voyage:voyage-3', token_count: 1 },
];
const engine = mockEngine({
getPage: async () => ({ slug: 'notes/x', compiled_truth: 'a', timeline: '', source_id: 'default' }),
getChunks: async () => chunks,
upsertChunks: async (_slug: string, c: any[]) => { upserted = c; },
setPageEmbeddingSignature: async () => null,
});
await runEmbedCore(engine, { slugs: ['notes/x'] });
expect(upserted).toBeDefined();
const byIdx = Object.fromEntries(upserted!.map(c => [c.chunk_index, c]));
// Re-embedded chunk carries the model that produced its vector (was
// mislabeled with the default before the fix).
expect(byIdx[0].model).toBe('openai:text-embedding-3-large');
// Untouched chunk keeps its original model — no wholesale relabel.
expect(byIdx[1].model).toBe('voyage:voyage-3');
});
});
@@ -73,4 +73,21 @@ describe('importFromContent embedding_signature stamping (F1)', () => {
await importFromContent(engine, 'concepts/unstamped', '# Unstamped\n\nbody content.', { noEmbed: true });
expect(await signatureOf('concepts/unstamped')).toBeNull();
});
// #1717: content_chunks.model must record the model that produced the
// vector (the configured gateway model), not the engine's hardcoded
// default. The gateway here is configured to openai:text-embedding-3-large,
// which differs from DEFAULT_EMBEDDING_MODEL — so this fails without the
// import-path model stamping.
test('inline embed labels content_chunks.model with the configured model (#1717)', async () => {
await importFromContent(engine, 'concepts/labeled', '# Labeled\n\nsome body content to chunk and embed.', {});
const rows = await engine.executeRaw<{ model: string }>(
`SELECT cc.model FROM content_chunks cc
JOIN pages p ON p.id = cc.page_id
WHERE p.slug = $1 AND p.source_id = 'default'`,
['concepts/labeled'],
);
expect(rows.length).toBeGreaterThan(0);
for (const r of rows) expect(r.model).toBe('openai:text-embedding-3-large');
});
});
-154
View File
@@ -1,154 +0,0 @@
import { describe, expect, test } from 'bun:test';
import { referenceExclusionSql, REFERENCE_FRONTMATTER_KEY } from '../src/core/reference-flag.ts';
import { applyReferenceFrontmatter } from '../src/commands/reference.ts';
describe('referenceExclusionSql', () => {
test('bare pages (no alias)', () => {
expect(referenceExclusionSql()).toBe(`(frontmatter->>'reference') IS DISTINCT FROM 'true'`);
});
test('aliased', () => {
expect(referenceExclusionSql('p')).toBe(`(p.frontmatter->>'reference') IS DISTINCT FROM 'true'`);
});
test('key constant', () => {
expect(REFERENCE_FRONTMATTER_KEY).toBe('reference');
});
});
describe('applyReferenceFrontmatter', () => {
const page = `---\ntitle: Andy Grove\ntype: person\ntags: []\n---\n\n# Andy Grove\n\nBody.`;
test('adds reference: true to an existing frontmatter block', () => {
const out = applyReferenceFrontmatter(page, true);
expect(out).toContain('reference: true');
expect(out).toContain('type: person'); // other keys preserved
expect(out).toContain('# Andy Grove'); // body preserved
});
test('is idempotent — does not duplicate the key', () => {
const once = applyReferenceFrontmatter(page, true);
const twice = applyReferenceFrontmatter(once, true);
expect(twice).toBe(once);
expect(twice.match(/reference: true/g)).toHaveLength(1);
});
test('replaces a stale reference: false with true', () => {
const off = `---\ntype: person\nreference: false\n---\n\nBody.`;
const out = applyReferenceFrontmatter(off, true);
expect(out).toContain('reference: true');
expect(out).not.toContain('reference: false');
});
test('--unset removes the key', () => {
const on = applyReferenceFrontmatter(page, true);
const off = applyReferenceFrontmatter(on, false);
expect(off).not.toContain('reference:');
expect(off).toContain('type: person');
});
test('--unset on a page without the key is a no-op', () => {
expect(applyReferenceFrontmatter(page, false)).toBe(page);
});
test('setting on a frontmatter-less page prepends a block', () => {
const raw = '# Just a heading\n\nNo frontmatter here.';
const out = applyReferenceFrontmatter(raw, true);
expect(out.startsWith('---\nreference: true\n---\n')).toBe(true);
expect(out).toContain('# Just a heading');
});
test('preserves body containing YAML-special chars', () => {
const tricky = `---\ntype: person\n---\n\nText with $& and $1 literals.`;
const out = applyReferenceFrontmatter(tricky, true);
expect(out).toContain('Text with $& and $1 literals.');
expect(out).toContain('reference: true');
});
});
// ── e2e: getHealth exemption + (source_id, slug)-scoped JSONB write ─────────
import { afterAll, beforeAll } from 'bun:test';
import * as fs from 'node:fs';
import * as os from 'node:os';
import * as path from 'node:path';
import { PGLiteEngine } from '../src/core/pglite-engine.ts';
import { runReference } from '../src/commands/reference.ts';
import { withEnv } from './helpers/with-env.ts';
describe('reference flag e2e (PGLite)', () => {
let engine: PGLiteEngine;
let brainDir: string;
beforeAll(async () => {
engine = new PGLiteEngine();
await engine.connect({ database_url: '' });
await engine.initSchema();
brainDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gbrain-ref-'));
fs.mkdirSync(path.join(brainDir, 'people'), { recursive: true });
fs.writeFileSync(
path.join(brainDir, 'people/andy-grove.md'),
'---\ntitle: Andy Grove\ntype: person\n---\n\n# Andy Grove\n',
'utf8',
);
await engine.executeRaw(
`INSERT INTO sources (id, name, local_path, config, created_at)
VALUES ('src-a', 'a', $1, '{}'::jsonb, now()), ('src-b', 'b', NULL, '{}'::jsonb, now())`,
[brainDir],
);
// Same slug in BOTH sources — the write must only touch src-a.
await engine.putPage('people/andy-grove', {
type: 'person', title: 'Andy Grove', compiled_truth: 'canon figure',
}, { sourceId: 'src-a' });
await engine.putPage('people/andy-grove', {
type: 'person', title: 'Andy Grove', compiled_truth: 'other-source twin',
}, { sourceId: 'src-b' });
// A normal contact WITH a timeline entry, so coverage has a live numerator.
const contact = await engine.putPage('people/alice-example', {
type: 'person', title: 'Alice Example', compiled_truth: 'real contact',
}, { sourceId: 'src-a' });
await engine.executeRaw(
`INSERT INTO timeline_entries (page_id, date, summary) VALUES ($1, '2026-01-01', 'met')`,
[contact.id],
);
});
afterAll(async () => {
await engine.disconnect();
fs.rmSync(brainDir, { recursive: true, force: true });
});
test('runReference scopes the JSONB write to the resolved (source_id, slug)', async () => {
await withEnv({ GBRAIN_SOURCE: undefined }, () =>
runReference(engine, ['people/andy-grove', '--brain', brainDir]));
const rows = await engine.executeRaw<{ source_id: string; ref: string | null }>(
`SELECT source_id, frontmatter->>'reference' AS ref FROM pages WHERE slug = 'people/andy-grove' ORDER BY source_id`,
);
expect(rows).toEqual([
{ source_id: 'src-a', ref: 'true' },
{ source_id: 'src-b', ref: null }, // twin in the other source untouched
]);
// Durable half: frontmatter on disk got the flag too.
expect(fs.readFileSync(path.join(brainDir, 'people/andy-grove.md'), 'utf8'))
.toContain('reference: true');
});
test('getHealth exempts reference pages from timeline/link coverage', async () => {
const health = await engine.getHealth();
// 3 person pages; the 2 reference-less twins would drag coverage to 1/3.
// With the src-a twin marked reference, denominator = 2 (alice + src-b twin).
expect(health.timeline_coverage).toBeCloseTo(0.5);
});
test('unset restores the page to a normal counted entity', async () => {
await withEnv({ GBRAIN_SOURCE: undefined }, () =>
runReference(engine, ['people/andy-grove', '--unset', '--brain', brainDir]));
const rows = await engine.executeRaw<{ ref: string | null }>(
`SELECT frontmatter->>'reference' AS ref FROM pages WHERE slug = 'people/andy-grove' AND source_id = 'src-a'`,
);
expect(rows[0].ref).toBeNull();
const health = await engine.getHealth();
expect(health.timeline_coverage).toBeCloseTo(1 / 3);
});
});