langchain 0.0.131 → 0.0.132

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,6 +8,11 @@ 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";
@@ -79,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,6 +23,11 @@ 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[];
@@ -34,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,6 +3,11 @@ 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";
@@ -74,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({

package/dist/retrievers/self_query/supabase.cjs

@@ -5,6 +5,11 @@ const ir_js_1 = require("../../chains/query_constructor/ir.cjs");
 const base_js_1 = require("./base.cjs");
 const utils_js_1 = require("./utils.cjs");
 const supabase_utils_js_1 = require("./supabase_utils.cjs");
+/**
+ * A specialized translator designed to work with Supabase, extending the
+ * BaseTranslator class. It translates structured queries into a format
+ * that can be understood by the Supabase database.
+ */
 class SupabaseTranslator extends base_js_1.BaseTranslator {
     constructor() {
         super(...arguments);
@@ -31,6 +36,13 @@ class SupabaseTranslator extends base_js_1.BaseTranslator {
     formatFunction() {
         throw new Error("Not implemented");
     }
+    /**
+     * Returns a function that applies the appropriate comparator operation on
+     * the attribute and value provided. The function returned is used to
+     * filter data in a Supabase database.
+     * @param comparator The comparator to be used in the operation.
+     * @returns A function that applies the comparator operation on the attribute and value provided.
+     */
     getComparatorFunction(comparator) {
         switch (comparator) {
             case ir_js_1.Comparators.eq: {
@@ -56,6 +68,14 @@ class SupabaseTranslator extends base_js_1.BaseTranslator {
             }
         }
     }
+    /**
+     * Builds a column name based on the attribute and value provided. The
+     * column name is used in filtering data in a Supabase database.
+     * @param attr The attribute to be used in the column name.
+     * @param value The value to be used in the column name.
+     * @param includeType Whether to include the data type in the column name.
+     * @returns The built column name.
+     */
     buildColumnName(attr, value, includeType = true) {
         let column = "";
         if ((0, utils_js_1.isString)(value)) {
@@ -72,6 +92,13 @@ class SupabaseTranslator extends base_js_1.BaseTranslator {
         }
         return column;
     }
+    /**
+     * Visits an operation and returns a string representation of it. This is
+     * used in translating a structured query into a format that can be
+     * understood by Supabase.
+     * @param operation The operation to be visited.
+     * @returns A string representation of the operation.
+     */
     visitOperationAsString(operation) {
         const { args } = operation;
         if (!args) {
@@ -90,6 +117,13 @@ class SupabaseTranslator extends base_js_1.BaseTranslator {
         }, [])
             .join(",");
     }
+    /**
+     * Visits an operation and returns a function that applies the operation
+     * on a Supabase database. This is used in translating a structured query
+     * into a format that can be understood by Supabase.
+     * @param operation The operation to be visited.
+     * @returns A function that applies the operation on a Supabase database.
+     */
     visitOperation(operation) {
         const { operator, args } = operation;
         if (this.allowedOperators.includes(operator)) {
@@ -114,6 +148,13 @@ class SupabaseTranslator extends base_js_1.BaseTranslator {
             throw new Error("Operator not allowed");
         }
     }
+    /**
+     * Visits a comparison and returns a string representation of it. This is
+     * used in translating a structured query into a format that can be
+     * understood by Supabase.
+     * @param comparison The comparison to be visited.
+     * @returns A string representation of the comparison.
+     */
     visitComparisonAsString(comparison) {
         let { value } = comparison;
         const { comparator: _comparator, attribute } = comparison;
@@ -132,6 +173,13 @@ class SupabaseTranslator extends base_js_1.BaseTranslator {
         }
         return `${this.buildColumnName(attribute, value, false)}.${comparator}.${value}}`;
     }
+    /**
+     * Visits a comparison and returns a function that applies the comparison
+     * on a Supabase database. This is used in translating a structured query
+     * into a format that can be understood by Supabase.
+     * @param comparison The comparison to be visited.
+     * @returns A function that applies the comparison on a Supabase database.
+     */
     visitComparison(comparison) {
         const { comparator, attribute, value } = comparison;
         if (this.allowedComparators.includes(comparator)) {
@@ -142,6 +190,13 @@ class SupabaseTranslator extends base_js_1.BaseTranslator {
             throw new Error("Comparator not allowed");
         }
     }
+    /**
+     * Visits a structured query and returns a function that applies the query
+     * on a Supabase database. This is used in translating a structured query
+     * into a format that can be understood by Supabase.
+     * @param query The structured query to be visited.
+     * @returns A function that applies the query on a Supabase database.
+     */
     visitStructuredQuery(query) {
         if (!query.filter) {
             return {};
@@ -149,6 +204,14 @@ class SupabaseTranslator extends base_js_1.BaseTranslator {
         const filterFunction = query.filter?.accept(this);
         return { filter: filterFunction ?? {} };
     }
+    /**
+     * Merges two filters into one. The merged filter can be used to filter
+     * data in a Supabase database.
+     * @param defaultFilter The default filter to be merged.
+     * @param generatedFilter The generated filter to be merged.
+     * @param mergeType The type of merge to be performed. It can be 'and', 'or', or 'replace'.
+     * @returns The merged filter.
+     */
     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/supabase.d.ts

@@ -1,6 +1,10 @@
 import { Comparator, Comparison, Operation, Operator, StructuredQuery } from "../../chains/query_constructor/ir.js";
 import type { SupabaseFilterRPCCall, SupabaseMetadata, SupabaseVectorStore } from "../../vectorstores/supabase.js";
 import { BaseTranslator } from "./base.js";
+/**
+ * Represents the possible values that can be used in a comparison in a
+ * structured query. It can be a string or a number.
+ */
 type ValueType = {
     eq: string | number;
     ne: string | number;
@@ -9,19 +13,82 @@ type ValueType = {
     gt: string | number;
     gte: string | number;
 };
+/**
+ * A specialized translator designed to work with Supabase, extending the
+ * BaseTranslator class. It translates structured queries into a format
+ * that can be understood by the Supabase database.
+ */
 export declare class SupabaseTranslator<T extends SupabaseVectorStore> extends BaseTranslator<T> {
     VisitOperationOutput: SupabaseFilterRPCCall;
     VisitComparisonOutput: SupabaseFilterRPCCall;
     allowedOperators: Operator[];
     allowedComparators: Comparator[];
     formatFunction(): string;
+    /**
+     * Returns a function that applies the appropriate comparator operation on
+     * the attribute and value provided. The function returned is used to
+     * filter data in a Supabase database.
+     * @param comparator The comparator to be used in the operation.
+     * @returns A function that applies the comparator operation on the attribute and value provided.
+     */
     getComparatorFunction<C extends Comparator>(comparator: Comparator): (attr: string, value: ValueType[C]) => SupabaseFilterRPCCall;
+    /**
+     * Builds a column name based on the attribute and value provided. The
+     * column name is used in filtering data in a Supabase database.
+     * @param attr The attribute to be used in the column name.
+     * @param value The value to be used in the column name.
+     * @param includeType Whether to include the data type in the column name.
+     * @returns The built column name.
+     */
     buildColumnName(attr: string, value: string | number, includeType?: boolean): string;
+    /**
+     * Visits an operation and returns a string representation of it. This is
+     * used in translating a structured query into a format that can be
+     * understood by Supabase.
+     * @param operation The operation to be visited.
+     * @returns A string representation of the operation.
+     */
     visitOperationAsString(operation: Operation): string;
+    /**
+     * Visits an operation and returns a function that applies the operation
+     * on a Supabase database. This is used in translating a structured query
+     * into a format that can be understood by Supabase.
+     * @param operation The operation to be visited.
+     * @returns A function that applies the operation on a Supabase database.
+     */
     visitOperation(operation: Operation): this["VisitOperationOutput"];
+    /**
+     * Visits a comparison and returns a string representation of it. This is
+     * used in translating a structured query into a format that can be
+     * understood by Supabase.
+     * @param comparison The comparison to be visited.
+     * @returns A string representation of the comparison.
+     */
     visitComparisonAsString(comparison: Comparison): string;
+    /**
+     * Visits a comparison and returns a function that applies the comparison
+     * on a Supabase database. This is used in translating a structured query
+     * into a format that can be understood by Supabase.
+     * @param comparison The comparison to be visited.
+     * @returns A function that applies the comparison on a Supabase database.
+     */
     visitComparison(comparison: Comparison): this["VisitComparisonOutput"];
+    /**
+     * Visits a structured query and returns a function that applies the query
+     * on a Supabase database. This is used in translating a structured query
+     * into a format that can be understood by Supabase.
+     * @param query The structured query to be visited.
+     * @returns A function that applies the query on a Supabase database.
+     */
     visitStructuredQuery(query: StructuredQuery): this["VisitStructuredQueryOutput"];
+    /**
+     * Merges two filters into one. The merged filter can be used to filter
+     * data in a Supabase database.
+     * @param defaultFilter The default filter to be merged.
+     * @param generatedFilter The generated filter to be merged.
+     * @param mergeType The type of merge to be performed. It can be 'and', 'or', or 'replace'.
+     * @returns The merged filter.
+     */
     mergeFilters(defaultFilter: SupabaseFilterRPCCall | SupabaseMetadata | undefined, generatedFilter: SupabaseFilterRPCCall | undefined, mergeType?: string): SupabaseFilterRPCCall | SupabaseMetadata | undefined;
 }
 export {};