langchain 0.0.170 → 0.0.171

package/dist/document_loaders/web/pdf.cjs

@@ -1,14 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebPDFLoader = void 0;
-const pdf_js_1 = require("pdf-parse/lib/pdf.js/v1.10.100/build/pdf.js");
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
 /**
  * A document loader for loading data from PDFs.
  */
 class WebPDFLoader extends base_js_1.BaseDocumentLoader {
-    constructor(blob, { splitPages = true } = {}) {
+    constructor(blob, { splitPages = true, pdfjs = PDFLoaderImports } = {}) {
         super();
         Object.defineProperty(this, "blob", {
             enumerable: true,
@@ -22,15 +21,23 @@ class WebPDFLoader extends base_js_1.BaseDocumentLoader {
             writable: true,
             value: true
         });
+        Object.defineProperty(this, "pdfjs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.blob = blob;
         this.splitPages = splitPages ?? this.splitPages;
+        this.pdfjs = pdfjs;
     }
     /**
      * Loads the contents of the PDF as documents.
      * @returns An array of Documents representing the retrieved data.
      */
     async load() {
-        const parsedPdf = await (0, pdf_js_1.getDocument)({
+        const { getDocument, version } = await this.pdfjs();
+        const parsedPdf = await getDocument({
             data: new Uint8Array(await this.blob.arrayBuffer()),
             useWorkerFetch: false,
             isEvalSupported: false,
@@ -51,7 +58,7 @@ class WebPDFLoader extends base_js_1.BaseDocumentLoader {
                 pageContent: text,
                 metadata: {
                     pdf: {
-                        version: pdf_js_1.version,
+                        version,
                         info: meta?.info,
                         metadata: meta?.metadata,
                         totalPages: parsedPdf.numPages,
@@ -73,7 +80,7 @@ class WebPDFLoader extends base_js_1.BaseDocumentLoader {
                 pageContent: documents.map((doc) => doc.pageContent).join("\n\n"),
                 metadata: {
                     pdf: {
-                        version: pdf_js_1.version,
+                        version,
                         info: meta?.info,
                         metadata: meta?.metadata,
                         totalPages: parsedPdf.numPages,
@@ -85,3 +92,14 @@ class WebPDFLoader extends base_js_1.BaseDocumentLoader {
     }
 }
 exports.WebPDFLoader = WebPDFLoader;
+async function PDFLoaderImports() {
+    try {
+        const { default: mod } = await import("pdf-parse/lib/pdf.js/v1.10.100/build/pdf.js");
+        const { getDocument, version } = mod;
+        return { getDocument, version };
+    }
+    catch (e) {
+        console.error(e);
+        throw new Error("Failed to load pdf-parse. Please install it with eg. `npm install pdf-parse`.");
+    }
+}

package/dist/document_loaders/web/pdf.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="../../../src/types/pdf-parse.d.ts" />
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
 /**
@@ -6,8 +7,10 @@ import { BaseDocumentLoader } from "../base.js";
 export declare class WebPDFLoader extends BaseDocumentLoader {
     protected blob: Blob;
     protected splitPages: boolean;
-    constructor(blob: Blob, { splitPages }?: {
+    private pdfjs;
+    constructor(blob: Blob, { splitPages, pdfjs }?: {
         splitPages?: boolean | undefined;
+        pdfjs?: typeof PDFLoaderImports | undefined;
     });
     /**
      * Loads the contents of the PDF as documents.
@@ -15,3 +18,8 @@ export declare class WebPDFLoader extends BaseDocumentLoader {
      */
     load(): Promise<Document[]>;
 }
+declare function PDFLoaderImports(): Promise<{
+    getDocument: typeof import("pdf-parse/lib/pdf.js/v1.10.100/build/pdf.js").getDocument;
+    version: string;
+}>;
+export {};

package/dist/document_loaders/web/pdf.js

@@ -1,11 +1,10 @@
-import { getDocument, version, } from "pdf-parse/lib/pdf.js/v1.10.100/build/pdf.js";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
 /**
  * A document loader for loading data from PDFs.
  */
 export class WebPDFLoader extends BaseDocumentLoader {
-    constructor(blob, { splitPages = true } = {}) {
+    constructor(blob, { splitPages = true, pdfjs = PDFLoaderImports } = {}) {
         super();
         Object.defineProperty(this, "blob", {
             enumerable: true,
@@ -19,14 +18,22 @@ export class WebPDFLoader extends BaseDocumentLoader {
             writable: true,
             value: true
         });
+        Object.defineProperty(this, "pdfjs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.blob = blob;
         this.splitPages = splitPages ?? this.splitPages;
+        this.pdfjs = pdfjs;
     }
     /**
      * Loads the contents of the PDF as documents.
      * @returns An array of Documents representing the retrieved data.
      */
     async load() {
+        const { getDocument, version } = await this.pdfjs();
         const parsedPdf = await getDocument({
             data: new Uint8Array(await this.blob.arrayBuffer()),
             useWorkerFetch: false,
@@ -81,3 +88,14 @@ export class WebPDFLoader extends BaseDocumentLoader {
         return documents;
     }
 }
+async function PDFLoaderImports() {
+    try {
+        const { default: mod } = await import("pdf-parse/lib/pdf.js/v1.10.100/build/pdf.js");
+        const { getDocument, version } = mod;
+        return { getDocument, version };
+    }
+    catch (e) {
+        console.error(e);
+        throw new Error("Failed to load pdf-parse. Please install it with eg. `npm install pdf-parse`.");
+    }
+}

package/dist/graphs/neo4j_graph.cjs

@@ -5,6 +5,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Neo4jGraph = void 0;
 const neo4j_driver_1 = __importDefault(require("neo4j-driver"));
+/**
+ * @security *Security note*: Make sure that the database connection uses credentials
+ * that are narrowly-scoped to only include necessary permissions.
+ * Failure to do so may result in data corruption or loss, since the calling
+ * code may attempt commands that would result in deletion, mutation
+ * of data if appropriately prompted or reading sensitive data if such
+ * data is present in the database.
+ * The best way to guard against such negative outcomes is to (as appropriate)
+ * limit the permissions granted to the credentials used with this tool.
+ * For example, creating read only users for the database is a good way to
+ * ensure that the calling code cannot mutate or delete data.
+ *
+ * @link See https://js.langchain.com/docs/security for more information.
+ */
 class Neo4jGraph {
     constructor({ url, username, password, database = "neo4j", }) {
         Object.defineProperty(this, "driver", {

package/dist/graphs/neo4j_graph.d.ts

@@ -4,6 +4,20 @@ interface Neo4jGraphConfig {
     password: string;
     database?: string;
 }
+/**
+ * @security *Security note*: Make sure that the database connection uses credentials
+ * that are narrowly-scoped to only include necessary permissions.
+ * Failure to do so may result in data corruption or loss, since the calling
+ * code may attempt commands that would result in deletion, mutation
+ * of data if appropriately prompted or reading sensitive data if such
+ * data is present in the database.
+ * The best way to guard against such negative outcomes is to (as appropriate)
+ * limit the permissions granted to the credentials used with this tool.
+ * For example, creating read only users for the database is a good way to
+ * ensure that the calling code cannot mutate or delete data.
+ *
+ * @link See https://js.langchain.com/docs/security for more information.
+ */
 export declare class Neo4jGraph {
     private driver;
     private database;

package/dist/graphs/neo4j_graph.js

@@ -1,4 +1,18 @@
 import neo4j from "neo4j-driver";
+/**
+ * @security *Security note*: Make sure that the database connection uses credentials
+ * that are narrowly-scoped to only include necessary permissions.
+ * Failure to do so may result in data corruption or loss, since the calling
+ * code may attempt commands that would result in deletion, mutation
+ * of data if appropriately prompted or reading sensitive data if such
+ * data is present in the database.
+ * The best way to guard against such negative outcomes is to (as appropriate)
+ * limit the permissions granted to the credentials used with this tool.
+ * For example, creating read only users for the database is a good way to
+ * ensure that the calling code cannot mutate or delete data.
+ *
+ * @link See https://js.langchain.com/docs/security for more information.
+ */
 export class Neo4jGraph {
     constructor({ url, username, password, database = "neo4j", }) {
         Object.defineProperty(this, "driver", {

package/dist/llms/googlepalm.cjs

@@ -83,6 +83,9 @@ class GooglePaLM extends base_js_1.LLM {
         if (this.topP && this.topP < 0) {
             throw new Error("`topP` must be a positive integer");
         }
+        if (this.topP && this.topP > 1) {
+            throw new Error("Google PaLM `topP` must in the range of [0,1]");
+        }
         this.topK = fields?.topK ?? this.topK;
         if (this.topK && this.topK < 0) {
             throw new Error("`topK` must be a positive integer");

package/dist/llms/googlepalm.js

@@ -80,6 +80,9 @@ export class GooglePaLM extends LLM {
         if (this.topP && this.topP < 0) {
             throw new Error("`topP` must be a positive integer");
         }
+        if (this.topP && this.topP > 1) {
+            throw new Error("Google PaLM `topP` must in the range of [0,1]");
+        }
         this.topK = fields?.topK ?? this.topK;
         if (this.topK && this.topK < 0) {
             throw new Error("`topK` must be a positive integer");

package/dist/load/import_constants.cjs

@@ -112,6 +112,7 @@ exports.optionalImportEntrypoints = [
     "langchain/chat_models/googlevertexai",
     "langchain/chat_models/googlevertexai/web",
     "langchain/chat_models/googlepalm",
+    "langchain/chat_models/llama_cpp",
     "langchain/sql_db",
     "langchain/callbacks/handlers/llmonitor",
     "langchain/output_parsers/expression",

package/dist/load/import_constants.js

@@ -109,6 +109,7 @@ export const optionalImportEntrypoints = [
     "langchain/chat_models/googlevertexai",
     "langchain/chat_models/googlevertexai/web",
     "langchain/chat_models/googlepalm",
+    "langchain/chat_models/llama_cpp",
     "langchain/sql_db",
     "langchain/callbacks/handlers/llmonitor",
     "langchain/output_parsers/expression",

package/dist/retrievers/parent_document.cjs

@@ -84,6 +84,12 @@ class ParentDocumentRetriever extends multi_vector_js_1.MultiVectorRetriever {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "childDocumentRetriever", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.vectorstore = fields.vectorstore;
         this.docstore = fields.docstore;
         this.childSplitter = fields.childSplitter;
@@ -91,9 +97,17 @@ class ParentDocumentRetriever extends multi_vector_js_1.MultiVectorRetriever {
         this.idKey = fields.idKey ?? this.idKey;
         this.childK = fields.childK;
         this.parentK = fields.parentK;
+        this.childDocumentRetriever = fields.childDocumentRetriever;
     }
     async _getRelevantDocuments(query) {
-        const subDocs = await this.vectorstore.similaritySearch(query, this.childK);
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let subDocs = [];
+        if (this.childDocumentRetriever) {
+            subDocs = await this.childDocumentRetriever.getRelevantDocuments(query);
+        }
+        else {
+            subDocs = await this.vectorstore.similaritySearch(query, this.childK);
+        }
         // Maintain order
         const parentDocIds = [];
         for (const doc of subDocs) {
@@ -109,6 +123,7 @@ class ParentDocumentRetriever extends multi_vector_js_1.MultiVectorRetriever {
     }
     /**
      * Adds documents to the docstore and vectorstores.
+     * If a retriever is provided, it will be used to add documents instead of the vectorstore.
      * @param docs The documents to add
      * @param config.ids Optional list of ids for documents. If provided should be the same
      *   length as the list of documents. Can provided if parent documents
@@ -150,7 +165,12 @@ class ParentDocumentRetriever extends multi_vector_js_1.MultiVectorRetriever {
             embeddedDocs.push(...taggedSubDocs);
             fullDocs[parentDocId] = parentDoc;
         }
-        await this.vectorstore.addDocuments(embeddedDocs);
+        if (this.childDocumentRetriever) {
+            await this.childDocumentRetriever.addDocuments(embeddedDocs);
+        }
+        else {
+            await this.vectorstore.addDocuments(embeddedDocs);
+        }
         if (addToDocstore) {
             await this.docstore.mset(Object.entries(fullDocs));
         }

package/dist/retrievers/parent_document.d.ts

@@ -1,5 +1,5 @@
 import { Document } from "../document.js";
-import { VectorStore } from "../vectorstores/base.js";
+import { VectorStore, VectorStoreRetriever } from "../vectorstores/base.js";
 import { TextSplitter } from "../text_splitter.js";
 import { MultiVectorRetriever, type MultiVectorRetrieverInput } from "./multi_vector.js";
 /**
@@ -9,6 +9,11 @@ import { MultiVectorRetriever, type MultiVectorRetrieverInput } from "./multi_ve
 export type ParentDocumentRetrieverFields = MultiVectorRetrieverInput & {
     childSplitter: TextSplitter;
     parentSplitter?: TextSplitter;
+    /**
+     * A custom retriever to use when retrieving instead of
+     * the `.similaritySearch` method of the vectorstore.
+     */
+    childDocumentRetriever?: VectorStoreRetriever<VectorStore>;
 };
 /**
  * A type of document retriever that splits input documents into smaller chunks
@@ -28,10 +33,12 @@ export declare class ParentDocumentRetriever extends MultiVectorRetriever {
     protected idKey: string;
     protected childK?: number;
     protected parentK?: number;
+    childDocumentRetriever: VectorStoreRetriever<VectorStore> | undefined;
     constructor(fields: ParentDocumentRetrieverFields);
     _getRelevantDocuments(query: string): Promise<Document[]>;
     /**
      * Adds documents to the docstore and vectorstores.
+     * If a retriever is provided, it will be used to add documents instead of the vectorstore.
      * @param docs The documents to add
      * @param config.ids Optional list of ids for documents. If provided should be the same
      *   length as the list of documents. Can provided if parent documents

package/dist/retrievers/parent_document.js

@@ -58,6 +58,12 @@ export class ParentDocumentRetriever extends MultiVectorRetriever {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "childDocumentRetriever", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.vectorstore = fields.vectorstore;
         this.docstore = fields.docstore;
         this.childSplitter = fields.childSplitter;
@@ -65,9 +71,17 @@ export class ParentDocumentRetriever extends MultiVectorRetriever {
         this.idKey = fields.idKey ?? this.idKey;
         this.childK = fields.childK;
         this.parentK = fields.parentK;
+        this.childDocumentRetriever = fields.childDocumentRetriever;
     }
     async _getRelevantDocuments(query) {
-        const subDocs = await this.vectorstore.similaritySearch(query, this.childK);
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        let subDocs = [];
+        if (this.childDocumentRetriever) {
+            subDocs = await this.childDocumentRetriever.getRelevantDocuments(query);
+        }
+        else {
+            subDocs = await this.vectorstore.similaritySearch(query, this.childK);
+        }
         // Maintain order
         const parentDocIds = [];
         for (const doc of subDocs) {
@@ -83,6 +97,7 @@ export class ParentDocumentRetriever extends MultiVectorRetriever {
     }
     /**
      * Adds documents to the docstore and vectorstores.
+     * If a retriever is provided, it will be used to add documents instead of the vectorstore.
      * @param docs The documents to add
      * @param config.ids Optional list of ids for documents. If provided should be the same
      *   length as the list of documents. Can provided if parent documents
@@ -124,7 +139,12 @@ export class ParentDocumentRetriever extends MultiVectorRetriever {
             embeddedDocs.push(...taggedSubDocs);
             fullDocs[parentDocId] = parentDoc;
         }
-        await this.vectorstore.addDocuments(embeddedDocs);
+        if (this.childDocumentRetriever) {
+            await this.childDocumentRetriever.addDocuments(embeddedDocs);
+        }
+        else {
+            await this.vectorstore.addDocuments(embeddedDocs);
+        }
         if (addToDocstore) {
             await this.docstore.mset(Object.entries(fullDocs));
         }

package/dist/schema/runnable/passthrough.cjs

@@ -56,7 +56,9 @@ class RunnablePassthrough extends base_js_1.Runnable {
     async invoke(input, options) {
         return this._callWithConfig((input) => Promise.resolve(input), input, options);
     }
-    static assign(mapping) {
+    static assign(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    mapping) {
         return new RunnableAssign(new base_js_1.RunnableMap({ steps: mapping }));
     }
 }

package/dist/schema/runnable/passthrough.js

@@ -52,7 +52,9 @@ export class RunnablePassthrough extends Runnable {
     async invoke(input, options) {
         return this._callWithConfig((input) => Promise.resolve(input), input, options);
     }
-    static assign(mapping) {
+    static assign(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    mapping) {
         return new RunnableAssign(new RunnableMap({ steps: mapping }));
     }
 }

package/dist/sql_db.cjs

@@ -14,6 +14,8 @@ const serializable_js_1 = require("./load/serializable.cjs");
  * to read and scope to the tables that are needed.
  * Optionally, use the includesTables or ignoreTables class parameters
  * to limit which tables can/cannot be accessed.
+ *
+ * @link See https://js.langchain.com/docs/security for more information.
  */
 class SqlDatabase extends serializable_js_1.Serializable {
     toJSON() {

package/dist/sql_db.d.ts

@@ -13,6 +13,8 @@ export type { SqlDatabaseDataSourceParams, SqlDatabaseOptionsParams };
  * to read and scope to the tables that are needed.
  * Optionally, use the includesTables or ignoreTables class parameters
  * to limit which tables can/cannot be accessed.
+ *
+ * @link See https://js.langchain.com/docs/security for more information.
  */
 export declare class SqlDatabase extends Serializable implements SqlDatabaseOptionsParams, SqlDatabaseDataSourceParams {
     lc_namespace: string[];

package/dist/sql_db.js

@@ -11,6 +11,8 @@ import { Serializable } from "./load/serializable.js";
  * to read and scope to the tables that are needed.
  * Optionally, use the includesTables or ignoreTables class parameters
  * to limit which tables can/cannot be accessed.
+ *
+ * @link See https://js.langchain.com/docs/security for more information.
  */
 export class SqlDatabase extends Serializable {
     toJSON() {

package/dist/util/stream.cjs

@@ -62,6 +62,9 @@ class IterableReadableStream extends ReadableStream {
                     });
                 }
             },
+            cancel() {
+                reader.releaseLock();
+            },
         });
     }
     static fromAsyncGenerator(generator) {

package/dist/util/stream.js

@@ -59,6 +59,9 @@ export class IterableReadableStream extends ReadableStream {
                     });
                 }
             },
+            cancel() {
+                reader.releaseLock();
+            },
         });
     }
     static fromAsyncGenerator(generator) {

package/dist/vectorstores/cassandra.cjs

@@ -53,6 +53,12 @@ class CassandraStore extends base_js_1.VectorStore {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "indices", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "isInitialized", {
             enumerable: true,
             configurable: true,
@@ -65,6 +71,7 @@ class CassandraStore extends base_js_1.VectorStore {
         this.table = args.table;
         this.primaryKey = args.primaryKey;
         this.metadataColumns = args.metadataColumns;
+        this.indices = args.indices;
     }
     /**
      * Method to save vectors to the Cassandra database.
@@ -94,13 +101,14 @@ class CassandraStore extends base_js_1.VectorStore {
      * Method to search for vectors that are similar to a given query vector.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns Promise that resolves with an array of tuples, each containing a Document and a score.
      */
-    async similaritySearchVectorWithScore(query, k) {
+    async similaritySearchVectorWithScore(query, k, filter) {
         if (!this.isInitialized) {
             await this.initialize();
         }
-        const queryStr = this.buildSearchQuery(query, k);
+        const queryStr = this.buildSearchQuery(query, k, filter);
         const queryResultSet = await this.client.execute(queryStr);
         return queryResultSet?.rows.map((row, index) => {
             const textContent = row.text;
@@ -173,6 +181,11 @@ class CassandraStore extends base_js_1.VectorStore {
         await this.client
             .execute(`CREATE CUSTOM INDEX IF NOT EXISTS idx_vector_${this.table}
   ON ${this.keyspace}.${this.table}(vector) USING 'StorageAttachedIndex';`);
+        for await (const { name, value } of this.indices) {
+            await this.client
+                .execute(`CREATE CUSTOM INDEX IF NOT EXISTS idx_${this.table}_${name}
+  ON ${this.keyspace}.${this.table} ${value} USING 'StorageAttachedIndex';`);
+        }
         this.isInitialized = true;
     }
     /**
@@ -200,15 +213,23 @@ class CassandraStore extends base_js_1.VectorStore {
         }
         return queries;
     }
+    buildWhereClause(filter) {
+        const whereClause = Object.entries(filter)
+            .map(([key, value]) => `${key} = '${value}'`)
+            .join(" AND ");
+        return `WHERE ${whereClause}`;
+    }
     /**
      * Method to build an CQL query for searching for similar vectors in the
      * Cassandra database.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns The CQL query string.
      */
-    buildSearchQuery(query, k) {
-        return `SELECT * FROM ${this.keyspace}.${this.table} ORDER BY vector ANN OF [${query}] LIMIT ${k || 1};`;
+    buildSearchQuery(query, k = 1, filter = undefined) {
+        const whereClause = filter ? this.buildWhereClause(filter) : "";
+        return `SELECT * FROM ${this.keyspace}.${this.table} ${whereClause} ORDER BY vector ANN OF [${query}] LIMIT ${k}`;
     }
 }
 exports.CassandraStore = CassandraStore;

package/dist/vectorstores/cassandra.d.ts

@@ -6,12 +6,17 @@ export interface Column {
     type: string;
     name: string;
 }
+export interface Index {
+    name: string;
+    value: string;
+}
 export interface CassandraLibArgs extends DseClientOptions {
     table: string;
     keyspace: string;
     dimensions: number;
     primaryKey: Column;
     metadataColumns: Column[];
+    indices: Index[];
 }
 /**
  * Class for interacting with the Cassandra database. It extends the
@@ -20,12 +25,14 @@ export interface CassandraLibArgs extends DseClientOptions {
  * texts or documents.
  */
 export declare class CassandraStore extends VectorStore {
+    FilterType: Record<string, any>;
     private client;
     private readonly dimensions;
     private readonly keyspace;
     private primaryKey;
     private metadataColumns;
     private readonly table;
+    private indices;
     private isInitialized;
     _vectorstoreType(): string;
     constructor(embeddings: Embeddings, args: CassandraLibArgs);
@@ -46,9 +53,10 @@ export declare class CassandraStore extends VectorStore {
      * Method to search for vectors that are similar to a given query vector.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns Promise that resolves with an array of tuples, each containing a Document and a score.
      */
-    similaritySearchVectorWithScore(query: number[], k: number): Promise<[Document, number][]>;
+    similaritySearchVectorWithScore(query: number[], k: number, filter?: this["FilterType"]): Promise<[Document, number][]>;
     /**
      * Static method to create an instance of CassandraStore from texts.
      * @param texts The texts to use.
@@ -87,11 +95,13 @@ export declare class CassandraStore extends VectorStore {
      * @returns The CQL query string.
      */
     private buildInsertQuery;
+    private buildWhereClause;
     /**
      * Method to build an CQL query for searching for similar vectors in the
      * Cassandra database.
      * @param query The query vector.
      * @param k The number of similar vectors to return.
+     * @param filter
      * @returns The CQL query string.
      */
     private buildSearchQuery;