DOC-4199: add TCEs to the combined query page

doctests/query-combined.js

@@ -0,0 +1,191 @@
+// EXAMPLE: query_combined
+// HIDE_START
+import assert from 'assert';
+import fs from 'fs';
+import { createClient } from 'redis';
+import { SchemaFieldTypes, VectorAlgorithms } from '@redis/search';
+import { pipeline } from '@xenova/transformers';
+
+const float32Buffer = (arr) => {
+  const floatArray = new Float32Array(arr);
+  const float32Buffer = Buffer.from(floatArray.buffer);
+  return float32Buffer;
+};
+
+async function embedText(sentence) {
+  let modelName = 'Xenova/all-MiniLM-L6-v2';
+  let pipe = await pipeline('feature-extraction', modelName);
+
+  let vectorOutput = await pipe(sentence, {
+      pooling: 'mean',
+      normalize: true,
+  });
+
+  const embedding = Object.values(vectorOutput?.data);
+
+  return embedding;
+}
+
+let query = "Bike for small kids";
+let vector_query = float32Buffer(await embedText("That is a very happy person"));
+
+const client = createClient();
+await client.connect();
+
+// create index
+await client.ft.create('idx:bicycle', {
+    '$.description': {
+      type: SchemaFieldTypes.TEXT,
+      AS: 'description',
+      sortable: false
+    },
+    '$.condition': {
+      type: SchemaFieldTypes.TAG,
+      AS: 'condition',
+      sortable: false
+    },
+    '$.price': {
+      type: SchemaFieldTypes.NUMERIC,
+      AS: 'price',
+      sortable: false
+    },
+    '$.description_embeddings': {
+        type: SchemaFieldTypes.VECTOR,
+        TYPE: 'FLOAT32',
+        ALGORITHM: VectorAlgorithms.FLAT,
+        DIM: 384,
+        DISTANCE_METRIC: 'COSINE',
+        AS: 'vector',
+    }
+}, {
+  ON: 'JSON',
+    PREFIX: 'bicycle:'
+});
+
+// load data
+const bicycles = JSON.parse(fs.readFileSync('data/query_vector.json', 'utf8'));
+
+await Promise.all(
+  bicycles.map((bicycle, bid) => {
+      return client.json.set(`bicycle:${bid}`, '$', bicycle);
+  })
+);
+// HIDE_END
+
+// STEP_START combined1
+let res = await client.ft.search('idx:bicycle', '@price:[500 1000] @condition:{new}');
+console.log(res.total); // >>> 1
+console.log(res); // >>>
+//{
+//  total: 1,
+//  documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]
+//}
+// REMOVE_START
+assert.strictEqual(res.total, 1);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined2
+res = await client.ft.search('idx:bicycle', 'kids @price:[500 1000] @condition:{used}');
+console.log(res.total); // >>> 1
+console.log(res); // >>>
+// {
+//   total: 1,
+//   documents: [ { id: 'bicycle:2', value: [Object: null prototype] } ]
+// }
+// REMOVE_START
+assert.strictEqual(res.total, 1);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined3
+res = await client.ft.search('idx:bicycle', '(kids | small) @condition:{used}');
+console.log(res.total); // >>> 2
+console.log(res); // >>>
+//{
+//  total: 2,
+//  documents: [
+//    { id: 'bicycle:2', value: [Object: null prototype] },
+//    { id: 'bicycle:1', value: [Object: null prototype] }
+//  ]
+//}
+// REMOVE_START
+assert.strictEqual(res.total, 2);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined4
+res = await client.ft.search('idx:bicycle', '@description:(kids | small) @condition:{used}');
+console.log(res.total); // >>> 2
+console.log(res); // >>>
+//{
+//  total: 2,
+//  documents: [
+//    { id: 'bicycle:2', value: [Object: null prototype] },
+//    { id: 'bicycle:1', value: [Object: null prototype] }
+//  ]
+//}
+// REMOVE_START
+assert.strictEqual(res.total, 2);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined5
+res = await client.ft.search('idx:bicycle', '@description:(kids | small) @condition:{new | used}');
+console.log(res.total); // >>> 3
+console.log(res); // >>>
+//{
+//  total: 3,
+//  documents: [
+//    { id: 'bicycle:1', value: [Object: null prototype] },
+//    { id: 'bicycle:0', value: [Object: null prototype] },
+//    { id: 'bicycle:2', value: [Object: null prototype] }
+//  ]
+//}
+// REMOVE_START
+assert.strictEqual(res.total, 3);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined6
+res = await client.ft.search('idx:bicycle', '@price:[500 1000] -@condition:{new}');
+console.log(res.total); // >>> 2
+console.log(res); // >>>
+//{
+//  total: 2,
+//  documents: [
+//    { id: 'bicycle:2', value: [Object: null prototype] },
+//    { id: 'bicycle:9', value: [Object: null prototype] }
+//  ]
+//}
+// REMOVE_START
+assert.strictEqual(res.total, 2);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined7
+res = await client.ft.search('idx:bicycle', 
+  '(@price:[500 1000] -@condition:{new})=>[KNN 3 @vector $query_vector]', {
+    PARAMS: { query_vector: vector_query },
+    DIALECT: 2
+  }
+);
+console.log(res.total); // >>> 2
+console.log(res); // >>>
+//{
+//  total: 2,
+//  documents: [
+//    { id: 'bicycle:2', value: [Object: null prototype] },
+//    { id: 'bicycle:9', value: [Object: null prototype] }
+//  ]
+//}
+// REMOVE_START
+assert.strictEqual(res.total, 2);
+// REMOVE_END
+// STEP_END
+
+// REMOVE_START
+// destroy index and data
+await client.ft.dropIndex('idx:bicycle', { DD: true });
+await client.disconnect();
+// REMOVE_END