langchain 0.0.130 → 0.0.132

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

@@ -1,13 +1,43 @@
 import { Comparator, Comparison, Operation, Operator, StructuredQuery, Visitor, VisitorComparisonResult, VisitorOperationResult, VisitorStructuredQueryResult } from "../../chains/query_constructor/ir.js";
 import { VectorStore } from "../../vectorstores/base.js";
+/**
+ * Options object for the BasicTranslator class. Specifies the allowed
+ * operators and comparators.
+ */
 export type TranslatorOpts = {
     allowedOperators: Operator[];
     allowedComparators: Comparator[];
 };
+/**
+ * Abstract class that provides a blueprint for creating specific
+ * translator classes. Defines two abstract methods: formatFunction and
+ * mergeFilters.
+ */
 export declare abstract class BaseTranslator<T extends VectorStore = VectorStore> extends Visitor<T> {
+    /**
+     * Formats a given function (either an operator or a comparator) into a
+     * string.
+     * @param func The function to format.
+     * @returns Formatted string representation of the function.
+     */
     abstract formatFunction(func: Operator | Comparator): string;
+    /**
+     * Merges two filters into one, using a specified merge type.
+     * @param defaultFilter The default filter.
+     * @param generatedFilter The generated filter.
+     * @param mergeType The type of merge to perform. Can be 'and', 'or', or 'replace'.
+     * @returns The merged filter, or undefined if both filters are empty.
+     */
     abstract mergeFilters(defaultFilter: this["VisitStructuredQueryOutput"]["filter"] | undefined, generatedFilter: this["VisitStructuredQueryOutput"]["filter"] | undefined, mergeType?: "and" | "or" | "replace"): this["VisitStructuredQueryOutput"]["filter"] | undefined;
 }
+/**
+ * Class that extends the BaseTranslator class and provides concrete
+ * implementations for the abstract methods. Also declares three types:
+ * VisitOperationOutput, VisitComparisonOutput, and
+ * VisitStructuredQueryOutput, which are used as the return types for the
+ * visitOperation, visitComparison, and visitStructuredQuery methods
+ * respectively.
+ */
 export declare class BasicTranslator<T extends VectorStore = VectorStore> extends BaseTranslator<T> {
     VisitOperationOutput: VisitorOperationResult;
     VisitComparisonOutput: VisitorComparisonResult;
@@ -16,8 +46,23 @@ export declare class BasicTranslator<T extends VectorStore = VectorStore> extend
     allowedComparators: Comparator[];
     constructor(opts?: TranslatorOpts);
     formatFunction(func: Operator | Comparator): string;
+    /**
+     * Visits an operation and returns a result.
+     * @param operation The operation to visit.
+     * @returns The result of visiting the operation.
+     */
     visitOperation(operation: Operation): this["VisitOperationOutput"];
+    /**
+     * Visits a comparison and returns a result.
+     * @param comparison The comparison to visit.
+     * @returns The result of visiting the comparison.
+     */
     visitComparison(comparison: Comparison): this["VisitComparisonOutput"];
+    /**
+     * Visits a structured query and returns a result.
+     * @param query The structured query to visit.
+     * @returns The result of visiting the structured query.
+     */
     visitStructuredQuery(query: StructuredQuery): this["VisitStructuredQueryOutput"];
     mergeFilters(defaultFilter: VisitorStructuredQueryResult["filter"] | undefined, generatedFilter: VisitorStructuredQueryResult["filter"] | undefined, mergeType?: string): VisitorStructuredQueryResult["filter"] | undefined;
 }

package/dist/retrievers/self_query/base.js

@@ -1,7 +1,20 @@
 import { Comparators, Operators, Visitor, } from "../../chains/query_constructor/ir.js";
 import { isFilterEmpty } from "./utils.js";
+/**
+ * Abstract class that provides a blueprint for creating specific
+ * translator classes. Defines two abstract methods: formatFunction and
+ * mergeFilters.
+ */
 export class BaseTranslator extends Visitor {
 }
+/**
+ * Class that extends the BaseTranslator class and provides concrete
+ * implementations for the abstract methods. Also declares three types:
+ * VisitOperationOutput, VisitComparisonOutput, and
+ * VisitStructuredQueryOutput, which are used as the return types for the
+ * visitOperation, visitComparison, and visitStructuredQuery methods
+ * respectively.
+ */
 export class BasicTranslator extends BaseTranslator {
     constructor(opts) {
         super();
@@ -48,12 +61,22 @@ export class BasicTranslator extends BaseTranslator {
         }
         return `$${func}`;
     }
+    /**
+     * Visits an operation and returns a result.
+     * @param operation The operation to visit.
+     * @returns The result of visiting the operation.
+     */
     visitOperation(operation) {
         const args = operation.args?.map((arg) => arg.accept(this));
         return {
             [this.formatFunction(operation.operator)]: args,
         };
     }
+    /**
+     * Visits a comparison and returns a result.
+     * @param comparison The comparison to visit.
+     * @returns The result of visiting the comparison.
+     */
     visitComparison(comparison) {
         return {
             [comparison.attribute]: {
@@ -61,6 +84,11 @@ export class BasicTranslator extends BaseTranslator {
             },
         };
     }
+    /**
+     * Visits a structured query and returns a result.
+     * @param query The structured query to visit.
+     * @returns The result of visiting the structured query.
+     */
     visitStructuredQuery(query) {
         let nextArg = {};
         if (query.filter) {

package/dist/retrievers/self_query/chroma.cjs

@@ -3,6 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChromaTranslator = void 0;
 const ir_js_1 = require("../../chains/query_constructor/ir.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * Specialized translator for the Chroma vector database. It extends the
+ * BasicTranslator class and translates internal query language elements
+ * to valid filters. The class defines a subset of allowed logical
+ * operators and comparators that can be used in the translation process.
+ */
 class ChromaTranslator extends base_js_1.BasicTranslator {
     constructor() {
         super({

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

@@ -1,5 +1,11 @@
 import { Chroma } from "../../vectorstores/chroma.js";
 import { BasicTranslator } from "./base.js";
+/**
+ * Specialized translator for the Chroma vector database. It extends the
+ * BasicTranslator class and translates internal query language elements
+ * to valid filters. The class defines a subset of allowed logical
+ * operators and comparators that can be used in the translation process.
+ */
 export declare class ChromaTranslator<T extends Chroma> extends BasicTranslator<T> {
     constructor();
 }

package/dist/retrievers/self_query/chroma.js

@@ -1,5 +1,11 @@
 import { Comparators, Operators } from "../../chains/query_constructor/ir.js";
 import { BasicTranslator } from "./base.js";
+/**
+ * Specialized translator for the Chroma vector database. It extends the
+ * BasicTranslator class and translates internal query language elements
+ * to valid filters. The class defines a subset of allowed logical
+ * operators and comparators that can be used in the translation process.
+ */
 export class ChromaTranslator extends BasicTranslator {
     constructor() {
         super({

package/dist/retrievers/self_query/functional.cjs

@@ -4,6 +4,10 @@ exports.FunctionalTranslator = 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");
+/**
+ * A class that extends `BaseTranslator` to translate structured queries
+ * into functional filters.
+ */
 class FunctionalTranslator extends base_js_1.BaseTranslator {
     constructor() {
         super(...arguments);
@@ -30,6 +34,12 @@ class FunctionalTranslator extends base_js_1.BaseTranslator {
     formatFunction() {
         throw new Error("Not implemented");
     }
+    /**
+     * Returns a function that performs a comparison based on the provided
+     * comparator.
+     * @param comparator The comparator to base the comparison function on.
+     * @returns A function that takes two arguments and returns a boolean based on the comparison.
+     */
     getComparatorFunction(comparator) {
         switch (comparator) {
             case ir_js_1.Comparators.eq: {
@@ -55,6 +65,12 @@ class FunctionalTranslator extends base_js_1.BaseTranslator {
             }
         }
     }
+    /**
+     * Returns a function that performs an operation based on the provided
+     * operator.
+     * @param operator The operator to base the operation function on.
+     * @returns A function that takes two boolean arguments and returns a boolean based on the operation.
+     */
     getOperatorFunction(operator) {
         switch (operator) {
             case ir_js_1.Operators.and: {
@@ -68,6 +84,12 @@ class FunctionalTranslator extends base_js_1.BaseTranslator {
             }
         }
     }
+    /**
+     * Visits the operation part of a structured query and translates it into
+     * a functional filter.
+     * @param operation The operation part of a structured query.
+     * @returns A function that takes a `Document` as an argument and returns a boolean based on the operation.
+     */
     visitOperation(operation) {
         const { operator, args } = operation;
         if (this.allowedOperators.includes(operator)) {
@@ -91,6 +113,12 @@ class FunctionalTranslator extends base_js_1.BaseTranslator {
             throw new Error("Operator not allowed");
         }
     }
+    /**
+     * Visits the comparison part of a structured query and translates it into
+     * a functional filter.
+     * @param comparison The comparison part of a structured query.
+     * @returns A function that takes a `Document` as an argument and returns a boolean based on the comparison.
+     */
     visitComparison(comparison) {
         const { comparator, attribute, value } = comparison;
         const undefinedTrue = [ir_js_1.Comparators.ne];
@@ -111,6 +139,11 @@ class FunctionalTranslator extends base_js_1.BaseTranslator {
             throw new Error("Comparator not allowed");
         }
     }
+    /**
+     * Visits a structured query and translates it into a functional filter.
+     * @param query The structured query to translate.
+     * @returns An object containing a `filter` property, which is a function that takes a `Document` as an argument and returns a boolean based on the structured query.
+     */
     visitStructuredQuery(query) {
         if (!query.filter) {
             return {};
@@ -121,6 +154,13 @@ class FunctionalTranslator extends base_js_1.BaseTranslator {
         }
         return { filter: filterFunction };
     }
+    /**
+     * Merges two filters into one, based on the specified merge type.
+     * @param defaultFilter The default filter function.
+     * @param generatedFilter The generated filter function.
+     * @param mergeType The type of merge to perform. Can be 'and', 'or', or 'replace'. Default is 'and'.
+     * @returns A function that takes a `Document` as an argument and returns a boolean based on the merged filters, or `undefined` if both filters are empty.
+     */
     mergeFilters(defaultFilter, generatedFilter, mergeType = "and") {
         if ((0, utils_js_1.isFilterEmpty)(defaultFilter) && (0, utils_js_1.isFilterEmpty)(generatedFilter)) {
             return undefined;

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

@@ -1,6 +1,11 @@
 import { Comparator, Comparison, Operation, Operator, StructuredQuery } from "../../chains/query_constructor/ir.js";
 import { Document } from "../../document.js";
 import { BaseTranslator } from "./base.js";
+/**
+ * A type alias for an object that maps comparison operators to string or
+ * number values. This is used in the comparison functions to determine
+ * the result of a comparison operation.
+ */
 type ValueType = {
     eq: string | number;
     ne: string | number;
@@ -9,7 +14,15 @@ type ValueType = {
     gt: string | number;
     gte: string | number;
 };
+/**
+ * A type alias for a function that takes a `Document` as an argument and
+ * returns a boolean. This function is used as a filter for documents.
+ */
 export type FunctionFilter = (document: Document) => boolean;
+/**
+ * A class that extends `BaseTranslator` to translate structured queries
+ * into functional filters.
+ */
 export declare class FunctionalTranslator extends BaseTranslator {
     VisitOperationOutput: FunctionFilter;
     VisitComparisonOutput: FunctionFilter;
@@ -21,11 +34,47 @@ export declare class FunctionalTranslator extends BaseTranslator {
     allowedOperators: Operator[];
     allowedComparators: Comparator[];
     formatFunction(): string;
+    /**
+     * Returns a function that performs a comparison based on the provided
+     * comparator.
+     * @param comparator The comparator to base the comparison function on.
+     * @returns A function that takes two arguments and returns a boolean based on the comparison.
+     */
     getComparatorFunction<C extends Comparator>(comparator: Comparator): (a: string | number, b: ValueType[C]) => boolean;
+    /**
+     * Returns a function that performs an operation based on the provided
+     * operator.
+     * @param operator The operator to base the operation function on.
+     * @returns A function that takes two boolean arguments and returns a boolean based on the operation.
+     */
     getOperatorFunction(operator: Operator): (a: boolean, b: boolean) => boolean;
+    /**
+     * Visits the operation part of a structured query and translates it into
+     * a functional filter.
+     * @param operation The operation part of a structured query.
+     * @returns A function that takes a `Document` as an argument and returns a boolean based on the operation.
+     */
     visitOperation(operation: Operation): this["VisitOperationOutput"];
+    /**
+     * Visits the comparison part of a structured query and translates it into
+     * a functional filter.
+     * @param comparison The comparison part of a structured query.
+     * @returns A function that takes a `Document` as an argument and returns a boolean based on the comparison.
+     */
     visitComparison(comparison: Comparison): this["VisitComparisonOutput"];
+    /**
+     * Visits a structured query and translates it into a functional filter.
+     * @param query The structured query to translate.
+     * @returns An object containing a `filter` property, which is a function that takes a `Document` as an argument and returns a boolean based on the structured query.
+     */
     visitStructuredQuery(query: StructuredQuery): this["VisitStructuredQueryOutput"];
+    /**
+     * Merges two filters into one, based on the specified merge type.
+     * @param defaultFilter The default filter function.
+     * @param generatedFilter The generated filter function.
+     * @param mergeType The type of merge to perform. Can be 'and', 'or', or 'replace'. Default is 'and'.
+     * @returns A function that takes a `Document` as an argument and returns a boolean based on the merged filters, or `undefined` if both filters are empty.
+     */
     mergeFilters(defaultFilter: FunctionFilter, generatedFilter: FunctionFilter, mergeType?: string): FunctionFilter | undefined;
 }
 export {};

package/dist/retrievers/self_query/functional.js

@@ -1,6 +1,10 @@
 import { Comparators, Operators, } from "../../chains/query_constructor/ir.js";
 import { BaseTranslator } from "./base.js";
 import { isFilterEmpty } from "./utils.js";
+/**
+ * A class that extends `BaseTranslator` to translate structured queries
+ * into functional filters.
+ */
 export class FunctionalTranslator extends BaseTranslator {
     constructor() {
         super(...arguments);
@@ -27,6 +31,12 @@ export class FunctionalTranslator extends BaseTranslator {
     formatFunction() {
         throw new Error("Not implemented");
     }
+    /**
+     * Returns a function that performs a comparison based on the provided
+     * comparator.
+     * @param comparator The comparator to base the comparison function on.
+     * @returns A function that takes two arguments and returns a boolean based on the comparison.
+     */
     getComparatorFunction(comparator) {
         switch (comparator) {
             case Comparators.eq: {
@@ -52,6 +62,12 @@ export class FunctionalTranslator extends BaseTranslator {
             }
         }
     }
+    /**
+     * Returns a function that performs an operation based on the provided
+     * operator.
+     * @param operator The operator to base the operation function on.
+     * @returns A function that takes two boolean arguments and returns a boolean based on the operation.
+     */
     getOperatorFunction(operator) {
         switch (operator) {
             case Operators.and: {
@@ -65,6 +81,12 @@ export class FunctionalTranslator extends BaseTranslator {
             }
         }
     }
+    /**
+     * Visits the operation part of a structured query and translates it into
+     * a functional filter.
+     * @param operation The operation part of a structured query.
+     * @returns A function that takes a `Document` as an argument and returns a boolean based on the operation.
+     */
     visitOperation(operation) {
         const { operator, args } = operation;
         if (this.allowedOperators.includes(operator)) {
@@ -88,6 +110,12 @@ export class FunctionalTranslator extends BaseTranslator {
             throw new Error("Operator not allowed");
         }
     }
+    /**
+     * Visits the comparison part of a structured query and translates it into
+     * a functional filter.
+     * @param comparison The comparison part of a structured query.
+     * @returns A function that takes a `Document` as an argument and returns a boolean based on the comparison.
+     */
     visitComparison(comparison) {
         const { comparator, attribute, value } = comparison;
         const undefinedTrue = [Comparators.ne];
@@ -108,6 +136,11 @@ export class FunctionalTranslator extends BaseTranslator {
             throw new Error("Comparator not allowed");
         }
     }
+    /**
+     * Visits a structured query and translates it into a functional filter.
+     * @param query The structured query to translate.
+     * @returns An object containing a `filter` property, which is a function that takes a `Document` as an argument and returns a boolean based on the structured query.
+     */
     visitStructuredQuery(query) {
         if (!query.filter) {
             return {};
@@ -118,6 +151,13 @@ export class FunctionalTranslator extends BaseTranslator {
         }
         return { filter: filterFunction };
     }
+    /**
+     * Merges two filters into one, based on the specified merge type.
+     * @param defaultFilter The default filter function.
+     * @param generatedFilter The generated filter function.
+     * @param mergeType The type of merge to perform. Can be 'and', 'or', or 'replace'. Default is 'and'.
+     * @returns A function that takes a `Document` as an argument and returns a boolean based on the merged filters, or `undefined` if both filters are empty.
+     */
     mergeFilters(defaultFilter, generatedFilter, mergeType = "and") {
         if (isFilterEmpty(defaultFilter) && isFilterEmpty(generatedFilter)) {
             return undefined;

package/dist/retrievers/self_query/index.cjs

@@ -8,7 +8,15 @@ Object.defineProperty(exports, "FunctionalTranslator", { enumerable: true, get:
 const base_js_1 = require("./base.cjs");
 Object.defineProperty(exports, "BaseTranslator", { enumerable: true, get: function () { return base_js_1.BaseTranslator; } });
 Object.defineProperty(exports, "BasicTranslator", { enumerable: true, get: function () { return base_js_1.BasicTranslator; } });
+/**
+ * Class for question answering over an index. It retrieves relevant
+ * documents based on a query. It extends the BaseRetriever class and
+ * implements the SelfQueryRetrieverArgs interface.
+ */
 class SelfQueryRetriever extends retriever_js_1.BaseRetriever {
+    static lc_name() {
+        return "SelfQueryRetriever";
+    }
     get lc_namespace() {
         return ["langchain", "retrievers", "self_query"];
     }
@@ -76,6 +84,15 @@ class SelfQueryRetriever extends retriever_js_1.BaseRetriever {
             return this.vectorStore.similaritySearch(myQuery, this.searchParams?.k, filter, runManager?.getChild("vectorstore"));
         }
     }
+    /**
+     * Static method to create a new SelfQueryRetriever instance from a
+     * BaseLanguageModel and a VectorStore. It first loads a query constructor
+     * chain using the loadQueryConstructorChain function, then creates a new
+     * SelfQueryRetriever instance with the loaded chain and the provided
+     * options.
+     * @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.
+     * @returns A new instance of SelfQueryRetriever.
+     */
     static fromLLM(options) {
         const { structuredQueryTranslator, allowedComparators, allowedOperators, llm, documentContents, attributeInfo, examples, vectorStore, ...rest } = options;
         const llmChain = (0, index_js_1.loadQueryConstructorChain)({

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

@@ -7,6 +7,10 @@ import { FunctionalTranslator } from "./functional.js";
 import { BaseTranslator, BasicTranslator } from "./base.js";
 import { CallbackManagerForRetrieverRun } from "../../callbacks/manager.js";
 export { BaseTranslator, BasicTranslator, FunctionalTranslator };
+/**
+ * Interface for the arguments required to create a SelfQueryRetriever
+ * instance. It extends the BaseRetrieverInput interface.
+ */
 export interface SelfQueryRetrieverArgs<T extends VectorStore> extends BaseRetrieverInput {
     vectorStore: T;
     structuredQueryTranslator: BaseTranslator<T>;
@@ -19,7 +23,13 @@ export interface SelfQueryRetrieverArgs<T extends VectorStore> extends BaseRetri
         mergeFiltersOperator?: "or" | "and" | "replace";
     };
 }
+/**
+ * Class for question answering over an index. It retrieves relevant
+ * documents based on a query. It extends the BaseRetriever class and
+ * implements the SelfQueryRetrieverArgs interface.
+ */
 export declare class SelfQueryRetriever<T extends VectorStore> extends BaseRetriever implements SelfQueryRetrieverArgs<T> {
+    static lc_name(): string;
     get lc_namespace(): string[];
     vectorStore: T;
     llmChain: LLMChain;
@@ -33,5 +43,14 @@ export declare class SelfQueryRetriever<T extends VectorStore> extends BaseRetri
     };
     constructor(options: SelfQueryRetrieverArgs<T>);
     _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, unknown>>[]>;
+    /**
+     * Static method to create a new SelfQueryRetriever instance from a
+     * BaseLanguageModel and a VectorStore. It first loads a query constructor
+     * chain using the loadQueryConstructorChain function, then creates a new
+     * SelfQueryRetriever instance with the loaded chain and the provided
+     * options.
+     * @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.
+     * @returns A new instance of SelfQueryRetriever.
+     */
     static fromLLM<T extends VectorStore>(options: QueryConstructorChainOptions & Omit<SelfQueryRetrieverArgs<T>, "llmChain">): SelfQueryRetriever<T>;
 }

package/dist/retrievers/self_query/index.js

@@ -3,7 +3,15 @@ import { BaseRetriever } from "../../schema/retriever.js";
 import { FunctionalTranslator } from "./functional.js";
 import { BaseTranslator, BasicTranslator } from "./base.js";
 export { BaseTranslator, BasicTranslator, FunctionalTranslator };
+/**
+ * Class for question answering over an index. It retrieves relevant
+ * documents based on a query. It extends the BaseRetriever class and
+ * implements the SelfQueryRetrieverArgs interface.
+ */
 export class SelfQueryRetriever extends BaseRetriever {
+    static lc_name() {
+        return "SelfQueryRetriever";
+    }
     get lc_namespace() {
         return ["langchain", "retrievers", "self_query"];
     }
@@ -71,6 +79,15 @@ export class SelfQueryRetriever extends BaseRetriever {
             return this.vectorStore.similaritySearch(myQuery, this.searchParams?.k, filter, runManager?.getChild("vectorstore"));
         }
     }
+    /**
+     * Static method to create a new SelfQueryRetriever instance from a
+     * BaseLanguageModel and a VectorStore. It first loads a query constructor
+     * chain using the loadQueryConstructorChain function, then creates a new
+     * SelfQueryRetriever instance with the loaded chain and the provided
+     * options.
+     * @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.
+     * @returns A new instance of SelfQueryRetriever.
+     */
     static fromLLM(options) {
         const { structuredQueryTranslator, allowedComparators, allowedOperators, llm, documentContents, attributeInfo, examples, vectorStore, ...rest } = options;
         const llmChain = loadQueryConstructorChain({

package/dist/retrievers/self_query/pinecone.cjs

@@ -3,6 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PineconeTranslator = void 0;
 const ir_js_1 = require("../../chains/query_constructor/ir.cjs");
 const base_js_1 = require("./base.cjs");
+/**
+ * Specialized translator class that extends the BasicTranslator. It is
+ * designed to work with PineconeStore, a type of vector store in
+ * LangChain. The class is initialized with a set of allowed operators and
+ * comparators, which are used in the translation process to construct
+ * queries and compare results.
+ */
 class PineconeTranslator extends base_js_1.BasicTranslator {
     constructor() {
         super({

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

@@ -1,5 +1,12 @@
 import { PineconeStore } from "../../vectorstores/pinecone.js";
 import { BasicTranslator } from "./base.js";
+/**
+ * Specialized translator class that extends the BasicTranslator. It is
+ * designed to work with PineconeStore, a type of vector store in
+ * LangChain. The class is initialized with a set of allowed operators and
+ * comparators, which are used in the translation process to construct
+ * queries and compare results.
+ */
 export declare class PineconeTranslator<T extends PineconeStore> extends BasicTranslator<T> {
     constructor();
 }

package/dist/retrievers/self_query/pinecone.js

@@ -1,5 +1,12 @@
 import { Comparators, Operators } from "../../chains/query_constructor/ir.js";
 import { BasicTranslator } from "./base.js";
+/**
+ * Specialized translator class that extends the BasicTranslator. It is
+ * designed to work with PineconeStore, a type of vector store in
+ * LangChain. The class is initialized with a set of allowed operators and
+ * comparators, which are used in the translation process to construct
+ * queries and compare results.
+ */
 export class PineconeTranslator extends BasicTranslator {
     constructor() {
         super({