langchain 0.0.130 → 0.0.132

package/dist/retrievers/self_query/utils.js

@@ -1,8 +1,17 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * Checks if the provided argument is an object and not an array.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function isObject(obj) {
     return obj && typeof obj === "object" && !Array.isArray(obj);
 }
-export function isFilterEmpty(filter) {
+/**
+ * Checks if a provided filter is empty. The filter can be a function, an
+ * object, a string, or undefined.
+ */
+export function isFilterEmpty(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+filter) {
     if (!filter)
         return true;
     // for Milvus
@@ -14,3 +23,24 @@ export function isFilterEmpty(filter) {
     }
     return isObject(filter) && Object.keys(filter).length === 0;
 }
+/**
+ * Checks if the provided value is an integer.
+ */
+export function isInt(value) {
+    const numberValue = parseFloat(value);
+    return !Number.isNaN(numberValue) && numberValue % 1 === 0;
+}
+/**
+ * Checks if the provided value is a floating-point number.
+ */
+export function isFloat(value) {
+    const numberValue = parseFloat(value);
+    return !Number.isNaN(numberValue) && numberValue % 1 !== 0;
+}
+/**
+ * Checks if the provided value is a string that cannot be parsed into a
+ * number.
+ */
+export function isString(value) {
+    return typeof value === "string" && Number.isNaN(parseFloat(value));
+}

package/dist/retrievers/self_query/weaviate.cjs

@@ -4,17 +4,11 @@ exports.WeaviateTranslator = void 0;
 const ir_js_1 = require("../../chains/query_constructor/ir.cjs");
 const base_js_1 = require("./base.cjs");
 const utils_js_1 = require("./utils.cjs");
-function isInt(value) {
-    const numberValue = parseFloat(value);
-    return !Number.isNaN(numberValue) && numberValue % 1 === 0;
-}
-function isFloat(value) {
-    const numberValue = parseFloat(value);
-    return !Number.isNaN(numberValue) && numberValue % 1 !== 0;
-}
-function isString(value) {
-    return typeof value === "string" && Number.isNaN(parseFloat(value));
-}
+/**
+ * A class that translates or converts data into a format that can be used
+ * with Weaviate, a vector search engine. It extends the `BaseTranslator`
+ * class and provides specific implementation for Weaviate.
+ */
 class WeaviateTranslator extends base_js_1.BaseTranslator {
     constructor() {
         super(...arguments);
@@ -38,6 +32,13 @@ class WeaviateTranslator extends base_js_1.BaseTranslator {
             ]
         });
     }
+    /**
+     * Formats the given function into a string representation. Throws an
+     * error if the function is not a known comparator or operator, or if it
+     * is not allowed.
+     * @param func The function to format, which can be an Operator or Comparator.
+     * @returns A string representation of the function.
+     */
     formatFunction(func) {
         if (func in ir_js_1.Comparators) {
             if (this.allowedComparators.length > 0 &&
@@ -66,6 +67,12 @@ class WeaviateTranslator extends base_js_1.BaseTranslator {
         };
         return dict[func];
     }
+    /**
+     * Visits an operation and returns a WeaviateOperationResult. The
+     * operation's arguments are visited and the operator is formatted.
+     * @param operation The operation to visit.
+     * @returns A WeaviateOperationResult.
+     */
     visitOperation(operation) {
         const args = operation.args?.map((arg) => arg.accept(this));
         return {
@@ -73,22 +80,29 @@ class WeaviateTranslator extends base_js_1.BaseTranslator {
             operands: args,
         };
     }
+    /**
+     * Visits a comparison and returns a WeaviateComparisonResult. The
+     * comparison's value is checked for type and the comparator is formatted.
+     * Throws an error if the value type is not supported.
+     * @param comparison The comparison to visit.
+     * @returns A WeaviateComparisonResult.
+     */
     visitComparison(comparison) {
-        if (isString(comparison.value)) {
+        if ((0, utils_js_1.isString)(comparison.value)) {
             return {
                 path: [comparison.attribute],
                 operator: this.formatFunction(comparison.comparator),
                 valueText: comparison.value,
             };
         }
-        if (isInt(comparison.value)) {
+        if ((0, utils_js_1.isInt)(comparison.value)) {
             return {
                 path: [comparison.attribute],
                 operator: this.formatFunction(comparison.comparator),
                 valueInt: parseInt(comparison.value, 10),
             };
         }
-        if (isFloat(comparison.value)) {
+        if ((0, utils_js_1.isFloat)(comparison.value)) {
             return {
                 path: [comparison.attribute],
                 operator: this.formatFunction(comparison.comparator),
@@ -97,6 +111,12 @@ class WeaviateTranslator extends base_js_1.BaseTranslator {
         }
         throw new Error("Value type is not supported");
     }
+    /**
+     * Visits a structured query and returns a WeaviateStructuredQueryResult.
+     * If the query has a filter, it is visited.
+     * @param query The structured query to visit.
+     * @returns A WeaviateStructuredQueryResult.
+     */
     visitStructuredQuery(query) {
         let nextArg = {};
         if (query.filter) {
@@ -106,6 +126,17 @@ class WeaviateTranslator extends base_js_1.BaseTranslator {
         }
         return nextArg;
     }
+    /**
+     * Merges two filters into one. If both filters are empty, returns
+     * undefined. If one filter is empty or the merge type is 'replace',
+     * returns the other filter. If the merge type is 'and' or 'or', returns a
+     * new filter with the merged results. Throws an error for unknown merge
+     * types.
+     * @param defaultFilter The default filter to merge.
+     * @param generatedFilter The generated filter to merge.
+     * @param mergeType The type of merge to perform. Can be 'and', 'or', or 'replace'. Defaults to 'and'.
+     * @returns A merged WeaviateFilter, or undefined if both filters are empty.
+     */
     mergeFilters(defaultFilter, generatedFilter, mergeType = "and") {
         if ((0, utils_js_1.isFilterEmpty)(defaultFilter?.where) &&
             (0, utils_js_1.isFilterEmpty)(generatedFilter?.where)) {

package/dist/retrievers/self_query/weaviate.d.ts

@@ -29,15 +29,57 @@ export type WeaviateStructuredQueryResult = {
         where?: WeaviateComparisonResult | WeaviateOperationResult;
     };
 };
+/**
+ * A class that translates or converts data into a format that can be used
+ * with Weaviate, a vector search engine. It extends the `BaseTranslator`
+ * class and provides specific implementation for Weaviate.
+ */
 export declare class WeaviateTranslator<T extends WeaviateStore> extends BaseTranslator<T> {
     VisitOperationOutput: WeaviateOperationResult;
     VisitComparisonOutput: WeaviateComparisonResult;
     allowedOperators: Operator[];
     allowedComparators: Comparator[];
+    /**
+     * Formats the given function into a string representation. Throws an
+     * error if the function is not a known comparator or operator, or if it
+     * is not allowed.
+     * @param func The function to format, which can be an Operator or Comparator.
+     * @returns A string representation of the function.
+     */
     formatFunction(func: Operator | Comparator): string;
+    /**
+     * Visits an operation and returns a WeaviateOperationResult. The
+     * operation's arguments are visited and the operator is formatted.
+     * @param operation The operation to visit.
+     * @returns A WeaviateOperationResult.
+     */
     visitOperation(operation: Operation): this["VisitOperationOutput"];
+    /**
+     * Visits a comparison and returns a WeaviateComparisonResult. The
+     * comparison's value is checked for type and the comparator is formatted.
+     * Throws an error if the value type is not supported.
+     * @param comparison The comparison to visit.
+     * @returns A WeaviateComparisonResult.
+     */
     visitComparison(comparison: Comparison): this["VisitComparisonOutput"];
+    /**
+     * Visits a structured query and returns a WeaviateStructuredQueryResult.
+     * If the query has a filter, it is visited.
+     * @param query The structured query to visit.
+     * @returns A WeaviateStructuredQueryResult.
+     */
     visitStructuredQuery(query: StructuredQuery): this["VisitStructuredQueryOutput"];
+    /**
+     * Merges two filters into one. If both filters are empty, returns
+     * undefined. If one filter is empty or the merge type is 'replace',
+     * returns the other filter. If the merge type is 'and' or 'or', returns a
+     * new filter with the merged results. Throws an error for unknown merge
+     * types.
+     * @param defaultFilter The default filter to merge.
+     * @param generatedFilter The generated filter to merge.
+     * @param mergeType The type of merge to perform. Can be 'and', 'or', or 'replace'. Defaults to 'and'.
+     * @returns A merged WeaviateFilter, or undefined if both filters are empty.
+     */
     mergeFilters(defaultFilter: WeaviateFilter | undefined, generatedFilter: WeaviateFilter | undefined, mergeType?: string): WeaviateFilter | undefined;
 }
 export {};

package/dist/retrievers/self_query/weaviate.js

@@ -1,17 +1,11 @@
 import { Comparators, Operators, } from "../../chains/query_constructor/ir.js";
 import { BaseTranslator } from "./base.js";
-import { isFilterEmpty } from "./utils.js";
-function isInt(value) {
-    const numberValue = parseFloat(value);
-    return !Number.isNaN(numberValue) && numberValue % 1 === 0;
-}
-function isFloat(value) {
-    const numberValue = parseFloat(value);
-    return !Number.isNaN(numberValue) && numberValue % 1 !== 0;
-}
-function isString(value) {
-    return typeof value === "string" && Number.isNaN(parseFloat(value));
-}
+import { isFilterEmpty, isString, isInt, isFloat } from "./utils.js";
+/**
+ * A class that translates or converts data into a format that can be used
+ * with Weaviate, a vector search engine. It extends the `BaseTranslator`
+ * class and provides specific implementation for Weaviate.
+ */
 export class WeaviateTranslator extends BaseTranslator {
     constructor() {
         super(...arguments);
@@ -35,6 +29,13 @@ export class WeaviateTranslator extends BaseTranslator {
             ]
         });
     }
+    /**
+     * Formats the given function into a string representation. Throws an
+     * error if the function is not a known comparator or operator, or if it
+     * is not allowed.
+     * @param func The function to format, which can be an Operator or Comparator.
+     * @returns A string representation of the function.
+     */
     formatFunction(func) {
         if (func in Comparators) {
             if (this.allowedComparators.length > 0 &&
@@ -63,6 +64,12 @@ export class WeaviateTranslator extends BaseTranslator {
         };
         return dict[func];
     }
+    /**
+     * Visits an operation and returns a WeaviateOperationResult. The
+     * operation's arguments are visited and the operator is formatted.
+     * @param operation The operation to visit.
+     * @returns A WeaviateOperationResult.
+     */
     visitOperation(operation) {
         const args = operation.args?.map((arg) => arg.accept(this));
         return {
@@ -70,6 +77,13 @@ export class WeaviateTranslator extends BaseTranslator {
             operands: args,
         };
     }
+    /**
+     * Visits a comparison and returns a WeaviateComparisonResult. The
+     * comparison's value is checked for type and the comparator is formatted.
+     * Throws an error if the value type is not supported.
+     * @param comparison The comparison to visit.
+     * @returns A WeaviateComparisonResult.
+     */
     visitComparison(comparison) {
         if (isString(comparison.value)) {
             return {
@@ -94,6 +108,12 @@ export class WeaviateTranslator extends BaseTranslator {
         }
         throw new Error("Value type is not supported");
     }
+    /**
+     * Visits a structured query and returns a WeaviateStructuredQueryResult.
+     * If the query has a filter, it is visited.
+     * @param query The structured query to visit.
+     * @returns A WeaviateStructuredQueryResult.
+     */
     visitStructuredQuery(query) {
         let nextArg = {};
         if (query.filter) {
@@ -103,6 +123,17 @@ export class WeaviateTranslator extends BaseTranslator {
         }
         return nextArg;
     }
+    /**
+     * Merges two filters into one. If both filters are empty, returns
+     * undefined. If one filter is empty or the merge type is 'replace',
+     * returns the other filter. If the merge type is 'and' or 'or', returns a
+     * new filter with the merged results. Throws an error for unknown merge
+     * types.
+     * @param defaultFilter The default filter to merge.
+     * @param generatedFilter The generated filter to merge.
+     * @param mergeType The type of merge to perform. Can be 'and', 'or', or 'replace'. Defaults to 'and'.
+     * @returns A merged WeaviateFilter, or undefined if both filters are empty.
+     */
     mergeFilters(defaultFilter, generatedFilter, mergeType = "and") {
         if (isFilterEmpty(defaultFilter?.where) &&
             isFilterEmpty(generatedFilter?.where)) {

package/dist/retrievers/supabase.cjs

@@ -3,7 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SupabaseHybridSearch = void 0;
 const document_js_1 = require("../document.cjs");
 const retriever_js_1 = require("../schema/retriever.cjs");
+/**
+ * Class for performing hybrid search operations on a Supabase database.
+ * It extends the `BaseRetriever` class and implements methods for
+ * similarity search, keyword search, and hybrid search.
+ */
 class SupabaseHybridSearch extends retriever_js_1.BaseRetriever {
+    static lc_name() {
+        return "SupabaseHybridSearch";
+    }
     constructor(embeddings, args) {
         super(args);
         Object.defineProperty(this, "lc_namespace", {
@@ -68,6 +76,14 @@ class SupabaseHybridSearch extends retriever_js_1.BaseRetriever {
         this.similarityK = args.similarityK || 2;
         this.keywordK = args.keywordK || 2;
     }
+    /**
+     * Performs a similarity search on the Supabase database using the
+     * provided query and returns the top 'k' similar documents.
+     * @param query The query to use for the similarity search.
+     * @param k The number of top similar documents to return.
+     * @param _callbacks Optional callbacks to pass to the embedQuery method.
+     * @returns A promise that resolves to an array of search results. Each result is a tuple containing a Document, its similarity score, and its ID.
+     */
     async similaritySearch(query, k, _callbacks // implement passing to embedQuery later
     ) {
         const embeddedQuery = await this.embeddings.embedQuery(query);
@@ -91,6 +107,13 @@ class SupabaseHybridSearch extends retriever_js_1.BaseRetriever {
             resp.id,
         ]);
     }
+    /**
+     * Performs a keyword search on the Supabase database using the provided
+     * query and returns the top 'k' documents that match the keywords.
+     * @param query The query to use for the keyword search.
+     * @param k The number of top documents to return that match the keywords.
+     * @returns A promise that resolves to an array of search results. Each result is a tuple containing a Document, its similarity score multiplied by 10, and its ID.
+     */
     async keywordSearch(query, k) {
         const kwMatchDocumentsParams = {
             query_text: query,
@@ -109,6 +132,16 @@ class SupabaseHybridSearch extends retriever_js_1.BaseRetriever {
             resp.id,
         ]);
     }
+    /**
+     * Combines the results of the `similaritySearch` and `keywordSearch`
+     * methods and returns the top 'k' documents based on a combination of
+     * similarity and keyword matching.
+     * @param query The query to use for the hybrid search.
+     * @param similarityK The number of top similar documents to return.
+     * @param keywordK The number of top documents to return that match the keywords.
+     * @param callbacks Optional callbacks to pass to the similaritySearch method.
+     * @returns A promise that resolves to an array of search results. Each result is a tuple containing a Document, its combined score, and its ID.
+     */
     async hybridSearch(query, similarityK, keywordK, callbacks) {
         const similarity_search = this.similaritySearch(query, similarityK, callbacks);
         const keyword_search = this.keywordSearch(query, keywordK);

package/dist/retrievers/supabase.d.ts

@@ -32,7 +32,13 @@ export interface SupabaseHybridSearchParams {
     similarityK: number;
     keywordK: number;
 }
+/**
+ * Class for performing hybrid search operations on a Supabase database.
+ * It extends the `BaseRetriever` class and implements methods for
+ * similarity search, keyword search, and hybrid search.
+ */
 export declare class SupabaseHybridSearch extends BaseRetriever {
+    static lc_name(): string;
     lc_namespace: string[];
     similarityK: number;
     query: string;
@@ -43,8 +49,33 @@ export declare class SupabaseHybridSearch extends BaseRetriever {
     keywordQueryName: string;
     embeddings: Embeddings;
     constructor(embeddings: Embeddings, args: SupabaseLibArgs);
+    /**
+     * Performs a similarity search on the Supabase database using the
+     * provided query and returns the top 'k' similar documents.
+     * @param query The query to use for the similarity search.
+     * @param k The number of top similar documents to return.
+     * @param _callbacks Optional callbacks to pass to the embedQuery method.
+     * @returns A promise that resolves to an array of search results. Each result is a tuple containing a Document, its similarity score, and its ID.
+     */
     protected similaritySearch(query: string, k: number, _callbacks?: Callbacks): Promise<SearchResult[]>;
+    /**
+     * Performs a keyword search on the Supabase database using the provided
+     * query and returns the top 'k' documents that match the keywords.
+     * @param query The query to use for the keyword search.
+     * @param k The number of top documents to return that match the keywords.
+     * @returns A promise that resolves to an array of search results. Each result is a tuple containing a Document, its similarity score multiplied by 10, and its ID.
+     */
     protected keywordSearch(query: string, k: number): Promise<SearchResult[]>;
+    /**
+     * Combines the results of the `similaritySearch` and `keywordSearch`
+     * methods and returns the top 'k' documents based on a combination of
+     * similarity and keyword matching.
+     * @param query The query to use for the hybrid search.
+     * @param similarityK The number of top similar documents to return.
+     * @param keywordK The number of top documents to return that match the keywords.
+     * @param callbacks Optional callbacks to pass to the similaritySearch method.
+     * @returns A promise that resolves to an array of search results. Each result is a tuple containing a Document, its combined score, and its ID.
+     */
     protected hybridSearch(query: string, similarityK: number, keywordK: number, callbacks?: Callbacks): Promise<SearchResult[]>;
     _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document[]>;
 }

package/dist/retrievers/supabase.js

@@ -1,6 +1,14 @@
 import { Document } from "../document.js";
 import { BaseRetriever } from "../schema/retriever.js";
+/**
+ * Class for performing hybrid search operations on a Supabase database.
+ * It extends the `BaseRetriever` class and implements methods for
+ * similarity search, keyword search, and hybrid search.
+ */
 export class SupabaseHybridSearch extends BaseRetriever {
+    static lc_name() {
+        return "SupabaseHybridSearch";
+    }
     constructor(embeddings, args) {
         super(args);
         Object.defineProperty(this, "lc_namespace", {
@@ -65,6 +73,14 @@ export class SupabaseHybridSearch extends BaseRetriever {
         this.similarityK = args.similarityK || 2;
         this.keywordK = args.keywordK || 2;
     }
+    /**
+     * Performs a similarity search on the Supabase database using the
+     * provided query and returns the top 'k' similar documents.
+     * @param query The query to use for the similarity search.
+     * @param k The number of top similar documents to return.
+     * @param _callbacks Optional callbacks to pass to the embedQuery method.
+     * @returns A promise that resolves to an array of search results. Each result is a tuple containing a Document, its similarity score, and its ID.
+     */
     async similaritySearch(query, k, _callbacks // implement passing to embedQuery later
     ) {
         const embeddedQuery = await this.embeddings.embedQuery(query);
@@ -88,6 +104,13 @@ export class SupabaseHybridSearch extends BaseRetriever {
             resp.id,
         ]);
     }
+    /**
+     * Performs a keyword search on the Supabase database using the provided
+     * query and returns the top 'k' documents that match the keywords.
+     * @param query The query to use for the keyword search.
+     * @param k The number of top documents to return that match the keywords.
+     * @returns A promise that resolves to an array of search results. Each result is a tuple containing a Document, its similarity score multiplied by 10, and its ID.
+     */
     async keywordSearch(query, k) {
         const kwMatchDocumentsParams = {
             query_text: query,
@@ -106,6 +129,16 @@ export class SupabaseHybridSearch extends BaseRetriever {
             resp.id,
         ]);
     }
+    /**
+     * Combines the results of the `similaritySearch` and `keywordSearch`
+     * methods and returns the top 'k' documents based on a combination of
+     * similarity and keyword matching.
+     * @param query The query to use for the hybrid search.
+     * @param similarityK The number of top similar documents to return.
+     * @param keywordK The number of top documents to return that match the keywords.
+     * @param callbacks Optional callbacks to pass to the similaritySearch method.
+     * @returns A promise that resolves to an array of search results. Each result is a tuple containing a Document, its combined score, and its ID.
+     */
     async hybridSearch(query, similarityK, keywordK, callbacks) {
         const similarity_search = this.similaritySearch(query, similarityK, callbacks);
         const keyword_search = this.keywordSearch(query, keywordK);

package/dist/retrievers/time_weighted.cjs

@@ -9,6 +9,9 @@ exports.BUFFER_IDX = "buffer_idx";
  * ref: https://github.com/hwchase17/langchain/blob/master/langchain/retrievers/time_weighted_retriever.py
  */
 class TimeWeightedVectorStoreRetriever extends retriever_js_1.BaseRetriever {
+    static lc_name() {
+        return "TimeWeightedVectorStoreRetriever";
+    }
     get lc_namespace() {
         return ["langchain", "retrievers", "time_weighted"];
     }
@@ -89,9 +92,17 @@ class TimeWeightedVectorStoreRetriever extends retriever_js_1.BaseRetriever {
         this.otherScoreKeys = fields.otherScoreKeys ?? [];
         this.defaultSalience = fields.defaultSalience ?? null;
     }
+    /**
+     * Get the memory stream of documents.
+     * @returns The memory stream of documents.
+     */
     getMemoryStream() {
         return this.memoryStream;
     }
+    /**
+     * Set the memory stream of documents.
+     * @param memoryStream The new memory stream of documents.
+     */
     setMemoryStream(memoryStream) {
         this.memoryStream = memoryStream;
     }

package/dist/retrievers/time_weighted.d.ts

@@ -2,6 +2,10 @@ import { VectorStore } from "../vectorstores/base.js";
 import { Document } from "../document.js";
 import { BaseRetriever, BaseRetrieverInput } from "../schema/retriever.js";
 import { CallbackManagerForRetrieverRun } from "../callbacks/manager.js";
+/**
+ * Interface for the fields required to initialize a
+ * TimeWeightedVectorStoreRetriever instance.
+ */
 export interface TimeWeightedVectorStoreRetrieverFields extends BaseRetrieverInput {
     vectorStore: VectorStore;
     searchKwargs?: number;
@@ -18,6 +22,7 @@ export declare const BUFFER_IDX = "buffer_idx";
  * ref: https://github.com/hwchase17/langchain/blob/master/langchain/retrievers/time_weighted_retriever.py
  */
 export declare class TimeWeightedVectorStoreRetriever extends BaseRetriever {
+    static lc_name(): string;
     get lc_namespace(): string[];
     /**
      * The vectorstore to store documents and determine salience.
@@ -52,7 +57,15 @@ export declare class TimeWeightedVectorStoreRetriever extends BaseRetriever {
      * @param fields - The fields required for initializing the TimeWeightedVectorStoreRetriever
      */
     constructor(fields: TimeWeightedVectorStoreRetrieverFields);
+    /**
+     * Get the memory stream of documents.
+     * @returns The memory stream of documents.
+     */
     getMemoryStream(): Document[];
+    /**
+     * Set the memory stream of documents.
+     * @param memoryStream The new memory stream of documents.
+     */
     setMemoryStream(memoryStream: Document[]): void;
     /**
      * Get relevant documents based on time-weighted relevance

package/dist/retrievers/time_weighted.js

@@ -6,6 +6,9 @@ export const BUFFER_IDX = "buffer_idx";
  * ref: https://github.com/hwchase17/langchain/blob/master/langchain/retrievers/time_weighted_retriever.py
  */
 export class TimeWeightedVectorStoreRetriever extends BaseRetriever {
+    static lc_name() {
+        return "TimeWeightedVectorStoreRetriever";
+    }
     get lc_namespace() {
         return ["langchain", "retrievers", "time_weighted"];
     }
@@ -86,9 +89,17 @@ export class TimeWeightedVectorStoreRetriever extends BaseRetriever {
         this.otherScoreKeys = fields.otherScoreKeys ?? [];
         this.defaultSalience = fields.defaultSalience ?? null;
     }
+    /**
+     * Get the memory stream of documents.
+     * @returns The memory stream of documents.
+     */
     getMemoryStream() {
         return this.memoryStream;
     }
+    /**
+     * Set the memory stream of documents.
+     * @param memoryStream The new memory stream of documents.
+     */
     setMemoryStream(memoryStream) {
         this.memoryStream = memoryStream;
     }

package/dist/retrievers/vespa.cjs

@@ -3,7 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VespaRetriever = void 0;
 const document_js_1 = require("../document.cjs");
 const base_js_1 = require("./remote/base.cjs");
+/**
+ * Class responsible for retrieving data from Vespa. It extends the
+ * `RemoteRetriever` class and includes methods for creating the JSON body
+ * for a query and processing the JSON response from Vespa.
+ */
 class VespaRetriever extends base_js_1.RemoteRetriever {
+    static lc_name() {
+        return "VespaRetriever";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "lc_namespace", {
@@ -28,12 +36,25 @@ class VespaRetriever extends base_js_1.RemoteRetriever {
         this.content_field = fields.content_field;
         this.url = `${this.url}/search/?`;
     }
+    /**
+     * Method that takes a query string as input and returns a JSON object
+     * that includes the query and the original `query_body`.
+     * @param query The query string to be sent to Vespa.
+     * @returns A JSON object that includes the query and the original `query_body`.
+     */
     createJsonBody(query) {
         return {
             ...this.query_body,
             query,
         };
     }
+    /**
+     * Method that processes the JSON response from Vespa into an array of
+     * `Document` instances. Each `Document` instance includes the content
+     * from the specified `content_field` and the document's ID.
+     * @param json The JSON response from Vespa.
+     * @returns An array of `Document` instances.
+     */
     processJsonResponse(json) {
         return json.root.children.map((doc) => new document_js_1.Document({
             pageContent: doc.fields[this.content_field],

package/dist/retrievers/vespa.d.ts

@@ -10,11 +10,30 @@ export interface VespaRetrieverParams extends RemoteRetrieverParams {
      */
     content_field: string;
 }
+/**
+ * Class responsible for retrieving data from Vespa. It extends the
+ * `RemoteRetriever` class and includes methods for creating the JSON body
+ * for a query and processing the JSON response from Vespa.
+ */
 export declare class VespaRetriever extends RemoteRetriever {
+    static lc_name(): string;
     lc_namespace: string[];
     query_body: object;
     content_field: string;
     constructor(fields: VespaRetrieverParams);
+    /**
+     * Method that takes a query string as input and returns a JSON object
+     * that includes the query and the original `query_body`.
+     * @param query The query string to be sent to Vespa.
+     * @returns A JSON object that includes the query and the original `query_body`.
+     */
     createJsonBody(query: string): RemoteRetrieverValues;
+    /**
+     * Method that processes the JSON response from Vespa into an array of
+     * `Document` instances. Each `Document` instance includes the content
+     * from the specified `content_field` and the document's ID.
+     * @param json The JSON response from Vespa.
+     * @returns An array of `Document` instances.
+     */
     processJsonResponse(json: RemoteRetrieverValues): Document[];
 }