montycat 1.1.6 → 1.1.7

package/README.md

@@ -14,8 +14,8 @@ The official Node.js & TypeScript SDK for [Montycat](https://montygovernance.com
 ```typescript
 // Search your data by MEANING — no external APIs, no separate vector database.
 // (already ON by default in the montycat-semantic server edition)
-const hits = await Sales.semanticSearchGetValues({ query: 'something to listen to music without wires', limitOutput: { start: 0, stop: 5 } });
-// → [{ key, score, value: { name: 'Wireless Headphones' } }, ...]  (matched by meaning, not keywords)
+const hits = await Sales.semanticSearchGetValues({ query: 'Show all Bluetooth devices', limitOutput: { start: 0, stop: 5 } });
+// → [{ __key__, __score__, __value__: { name: 'Wireless Headphones' } }, ...]  (matched by meaning, not keywords)
 ```
 
 > ### 🧩 All-in-one. AI-native. **Zero external dependencies.**
@@ -328,13 +328,13 @@ in the background as data is written (the embedding model is downloaded on deman
 ```typescript
 // Semantic search is ON by default in the montycat-semantic edition — just search.
 // Rank stored items by meaning — two flavors:
-//   getValues → each hit is { key, score, value }
-//   getKeys   → each hit is { key, score } (lighter; fetch a page later with getBulk)
-const hits = await Sales.semanticSearchGetValues({ query: 'something to listen to music without wires', limitOutput: { start: 0, stop: 5 } });
-const keys = await Sales.semanticSearchGetKeys({ query: 'something to listen to music without wires', limitOutput: { start: 0, stop: 5 } });
+//   getValues → each hit is { __key__, __score__, __value__ }
+//   getKeys   → each hit is { __key__, __score__ } (lighter; fetch a page later with getBulk)
+const hits = await Sales.semanticSearchGetValues({ query: 'Show all Bluetooth devices', limitOutput: { start: 0, stop: 5 } });
+const keys = await Sales.semanticSearchGetKeys({ query: 'Show all Bluetooth devices', limitOutput: { start: 0, stop: 5 } });
 
 // Optionally drop weak matches by cosine similarity (range [-1, 1]).
-const strong = await Sales.semanticSearchGetKeys({ query: 'something to listen to music without wires', limitOutput: { start: 0, stop: 5 }, minScore: 0.35 });
+const strong = await Sales.semanticSearchGetKeys({ query: 'Show all Bluetooth devices', limitOutput: { start: 0, stop: 5 }, minScore: 0.35 });
 
 // Control the DB-wide switch (optional — it's already on):
 // switch the embedding model: 'minilm' | 'bge-small' (default) | 'bge-base' | 'e5-small'

package/dist/classes/generic.d.ts

@@ -173,7 +173,7 @@ declare class GenericKV {
      *                      (the default) lets the server apply its default top-k (10).
      * @param minScore - Drop hits whose cosine similarity (in [-1, 1]) is below
      *                   this value. Default null (no score filter).
-     * @return A promise resolving with ranked hits, each `{key, score}`.
+     * @return A promise resolving with ranked hits, each `{__key__, __score__}`.
      */
     static semanticSearchGetKeys({ query, limitOutput, minScore }: {
         query: string;
@@ -204,7 +204,9 @@ declare class GenericKV {
      *                       returned value.
      * @param pointersMetadata - Whether to include pointer metadata in each
      *                           returned value.
-     * @return A promise resolving with ranked hits, each `{key, score, value}`.
+     * @return A promise resolving with ranked hits, each
+     *         `{__key__, __score__, __value__}` — the same dunder envelope
+     *         `lookupValuesWhere` returns with `keyIncluded: true`, plus the score.
      */
     static semanticSearchGetValues({ query, limitOutput, minScore, withPointers, pointersMetadata }: {
         query: string;

package/dist/classes/generic.js

@@ -254,7 +254,7 @@ class GenericKV {
      *                      (the default) lets the server apply its default top-k (10).
      * @param minScore - Drop hits whose cosine similarity (in [-1, 1]) is below
      *                   this value. Default null (no score filter).
-     * @return A promise resolving with ranked hits, each `{key, score}`.
+     * @return A promise resolving with ranked hits, each `{__key__, __score__}`.
      */
     static async semanticSearchGetKeys({ query, limitOutput = { start: 0, stop: 0 }, minScore = null }) {
         return this.semanticSearchCore(query, limitOutput, minScore, false, false, false);
@@ -280,7 +280,9 @@ class GenericKV {
      *                       returned value.
      * @param pointersMetadata - Whether to include pointer metadata in each
      *                           returned value.
-     * @return A promise resolving with ranked hits, each `{key, score, value}`.
+     * @return A promise resolving with ranked hits, each
+     *         `{__key__, __score__, __value__}` — the same dunder envelope
+     *         `lookupValuesWhere` returns with `keyIncluded: true`, plus the score.
      */
     static async semanticSearchGetValues({ query, limitOutput = { start: 0, stop: 0 }, minScore = null, withPointers = false, pointersMetadata = false }) {
         return this.semanticSearchCore(query, limitOutput, minScore, withPointers, true, pointersMetadata);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "montycat",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "Self-hosted vector database + NoSQL with built-in AI semantic search — the Node.js & TypeScript client for Montycat. A Rust-powered, AI-native Pinecone / Weaviate / Chroma alternative for RAG, AI agents & LLM memory.",
   "type": "module",
   "main": "dist/index.js",