@x12i/memorix-similarity

Generic similarity indexing and query primitives for Memorix foundation packages.

Bridge packages declare similarityFields on object-type descriptors and register indexes via this module. The foundation does not know domain object semantics.

Usage

import {
  createMemorixSimilarityClient,
  createMongoAtlasSimilarityBackend,
  ensureSimilarityIndex,
  querySimilarRecords,
} from "@x12i/memorix-similarity";

const client = createMemorixSimilarityClient({
  backend: createMongoAtlasSimilarityBackend({ client: mongoClient }),
});

await ensureSimilarityIndex(client, {
  objectType: "my-bridge-type",
  target: "entity",
  database: "memorix-entities",
  collection: "my-bridge-type-snapshots",
  fields: [{ field: "embedding", kind: "vector", dimensions: 1536 }],
});

const result = await querySimilarRecords(client, {
  objectType: "my-bridge-type",
  field: "embedding",
  vector: queryVector,
  limit: 10,
});