langchain 0.2.17 → 0.3.0-rc.0

package/dist/retrievers/self_query/supabase.js

@@ -1,274 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { isFilterEmpty, isFloat, isInt, isObject, isString, BaseTranslator, Comparators, Operators, } from "@langchain/core/structured_query";
-import { ProxyParamsDuplicator, convertObjectFilterToStructuredQuery, } from "./supabase_utils.js";
-import { logVersion020MigrationWarning } from "../../util/entrypoint_deprecation.js";
-/* #__PURE__ */ logVersion020MigrationWarning({
-    oldEntrypointName: "retrievers/self_query/supabase",
-    newEntrypointName: "structured_query/supabase",
-    newPackageName: "@langchain/community",
-});
-/**
- * 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.
- * @example
- * ```typescript
- * const selfQueryRetriever = new SelfQueryRetriever({
- *   llm: new ChatOpenAI(),
- *   vectorStore: new SupabaseVectorStore(),
- *   documentContents: "Brief summary of a movie",
- *   attributeInfo: [],
- *   structuredQueryTranslator: new SupabaseTranslator(),
- * });
- *
- * const queryResult = await selfQueryRetriever.getRelevantDocuments(
- *   "Which movies are directed by Greta Gerwig?",
- * );
- * ```
- */
-export class SupabaseTranslator extends BaseTranslator {
-    constructor() {
-        super(...arguments);
-        Object.defineProperty(this, "allowedOperators", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: [Operators.and, Operators.or]
-        });
-        Object.defineProperty(this, "allowedComparators", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: [
-                Comparators.eq,
-                Comparators.ne,
-                Comparators.gt,
-                Comparators.gte,
-                Comparators.lt,
-                Comparators.lte,
-            ]
-        });
-    }
-    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 Comparators.eq: {
-                return (attr, value) => (rpc) => rpc.eq(this.buildColumnName(attr, value), value);
-            }
-            case Comparators.ne: {
-                return (attr, value) => (rpc) => rpc.neq(this.buildColumnName(attr, value), value);
-            }
-            case Comparators.gt: {
-                return (attr, value) => (rpc) => rpc.gt(this.buildColumnName(attr, value), value);
-            }
-            case Comparators.gte: {
-                return (attr, value) => (rpc) => rpc.gte(this.buildColumnName(attr, value), value);
-            }
-            case Comparators.lt: {
-                return (attr, value) => (rpc) => rpc.lt(this.buildColumnName(attr, value), value);
-            }
-            case Comparators.lte: {
-                return (attr, value) => (rpc) => rpc.lte(this.buildColumnName(attr, value), value);
-            }
-            default: {
-                throw new Error("Unknown comparator");
-            }
-        }
-    }
-    /**
-     * 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 (isString(value)) {
-            column = `metadata->>${attr}`;
-        }
-        else if (isInt(value)) {
-            column = `metadata->${attr}${includeType ? "::int" : ""}`;
-        }
-        else if (isFloat(value)) {
-            column = `metadata->${attr}${includeType ? "::float" : ""}`;
-        }
-        else {
-            throw new Error("Data type not supported");
-        }
-        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) {
-            return "";
-        }
-        return args
-            ?.reduce((acc, arg) => {
-            if (arg.exprName === "Comparison") {
-                acc.push(this.visitComparisonAsString(arg));
-            }
-            else if (arg.exprName === "Operation") {
-                const { operator: innerOperator } = arg;
-                acc.push(`${innerOperator}(${this.visitOperationAsString(arg)})`);
-            }
-            return acc;
-        }, [])
-            .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)) {
-            if (operator === Operators.and) {
-                if (!args) {
-                    return (rpc) => rpc;
-                }
-                const filter = (rpc) => args.reduce((acc, arg) => {
-                    const filter = arg.accept(this);
-                    return filter(acc);
-                }, rpc);
-                return filter;
-            }
-            else if (operator === Operators.or) {
-                return (rpc) => rpc.or(this.visitOperationAsString(operation));
-            }
-            else {
-                throw new Error("Unknown operator");
-            }
-        }
-        else {
-            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;
-        let comparator = _comparator;
-        if (comparator === Comparators.ne) {
-            comparator = "neq";
-        }
-        if (Array.isArray(value)) {
-            value = `(${value
-                .map((v) => {
-                if (typeof v === "string" && /[,()]/.test(v))
-                    return `"${v}"`;
-                return v;
-            })
-                .join(",")})`;
-        }
-        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)) {
-            const comparatorFunction = this.getComparatorFunction(comparator);
-            return comparatorFunction(attribute, value);
-        }
-        else {
-            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 {};
-        }
-        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 (isFilterEmpty(defaultFilter) && isFilterEmpty(generatedFilter)) {
-            return undefined;
-        }
-        if (isFilterEmpty(defaultFilter) || mergeType === "replace") {
-            if (isFilterEmpty(generatedFilter)) {
-                return undefined;
-            }
-            return generatedFilter;
-        }
-        if (isFilterEmpty(generatedFilter)) {
-            if (mergeType === "and") {
-                return undefined;
-            }
-            return defaultFilter;
-        }
-        let myDefaultFilter = defaultFilter;
-        if (isObject(defaultFilter)) {
-            const { filter } = this.visitStructuredQuery(convertObjectFilterToStructuredQuery(defaultFilter));
-            // just in case the built filter is empty somehow
-            if (isFilterEmpty(filter)) {
-                if (isFilterEmpty(generatedFilter)) {
-                    return undefined;
-                }
-                return generatedFilter;
-            }
-            myDefaultFilter = filter;
-        }
-        // After this point, myDefaultFilter will always be SupabaseFilterRPCCall
-        if (mergeType === "or") {
-            return (rpc) => {
-                const defaultFlattenedParams = ProxyParamsDuplicator.getFlattenedParams(rpc, myDefaultFilter);
-                const generatedFlattenedParams = ProxyParamsDuplicator.getFlattenedParams(rpc, generatedFilter);
-                return rpc.or(`${defaultFlattenedParams},${generatedFlattenedParams}`);
-            };
-        }
-        else if (mergeType === "and") {
-            return (rpc) => generatedFilter(myDefaultFilter(rpc));
-        }
-        else {
-            throw new Error("Unknown merge type");
-        }
-    }
-}

package/dist/retrievers/self_query/supabase_utils.cjs

@@ -1,264 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertObjectFilterToStructuredQuery = exports.ProxyParamsDuplicator = void 0;
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const structured_query_1 = require("@langchain/core/structured_query");
-/**
- * Utility class used to duplicate parameters for a proxy object,
- * specifically designed to work with `SupabaseFilter` objects. It
- * contains methods to handle different types of operations such as "or",
- * "filter", "in", "contains", "textSearch", "match", "not", and default
- * operations.
- */
-class ProxyParamsDuplicator {
-    constructor() {
-        Object.defineProperty(this, "duplicationAllowedOps", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: [
-                "eq",
-                "neq",
-                "lt",
-                "lte",
-                "gt",
-                "gte",
-                "like",
-                "ilike",
-                "or",
-                "in",
-                "contains",
-                "match",
-                "not",
-                "textSearch",
-                "filter",
-            ]
-        });
-        Object.defineProperty(this, "values", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: []
-        });
-    }
-    /**
-     * Creates a proxy handler for a `SupabaseFilter` object. The handler
-     * intercepts get operations and applies specific logic based on the
-     * property being accessed.
-     * @returns A proxy handler for a `SupabaseFilter` object.
-     */
-    buildProxyHandler() {
-        const proxyHandler = {
-            get: (target, prop, receiver) => {
-                if (typeof target[prop] === "function") {
-                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                    return (...args) => {
-                        if (this.duplicationAllowedOps.includes(String(prop))) {
-                            switch (String(prop)) {
-                                case "or":
-                                    // args[0]: filters, args[1]: { foreignTable }
-                                    this.addOrClause(args[0], args[1]);
-                                    break;
-                                case "filter":
-                                    // args[0]: column, args[1]: operator, args[2]: value
-                                    this.addFilterClause(args[0], args[1], args[2]);
-                                    break;
-                                case "in":
-                                    // args[0]: column, args[1]: values
-                                    this.addInClause(args[0], args[1]);
-                                    break;
-                                case "contains":
-                                    // args[0]: column, args[1]: value
-                                    this.addContainsClause(args[0], args[1]);
-                                    break;
-                                case "textSearch":
-                                    // args[0]: column, args[1]: query, args[2]: { config, type }
-                                    this.addTextSearchClause(args[0], args[1], args[2]);
-                                    break;
-                                case "match":
-                                    // args[0]: query
-                                    this.addMatchClause(args[0]);
-                                    break;
-                                case "not":
-                                    // args[0]: column, args[1]: operator, args[2]: value
-                                    this.addNotClause(args[0], args[1], args[2]);
-                                    break;
-                                default:
-                                    // args[0]: column, args[1]: value
-                                    this.addDefaultOpClause(prop, args[0], args[1]);
-                            }
-                            return new Proxy(target, proxyHandler);
-                        }
-                        else {
-                            throw new Error("Filter operation not supported for 'or' mergeFiltersOperator");
-                        }
-                    };
-                }
-                else {
-                    return Reflect.get(target, prop, receiver);
-                }
-            },
-        };
-        return proxyHandler;
-    }
-    /**
-     * Removes type annotations from a value string.
-     * @param value The value string to clean.
-     * @returns The cleaned value string.
-     */
-    removeType(value) {
-        let cleanedValue = value;
-        if (cleanedValue.includes("::float")) {
-            cleanedValue = cleanedValue.replace("::float", "");
-        }
-        if (cleanedValue.includes("::int")) {
-            cleanedValue = cleanedValue.replace("::int", "");
-        }
-        return cleanedValue;
-    }
-    /**
-     * Adds a default operation clause to the values array.
-     * @param prop The operation property.
-     * @param column The column to apply the operation to.
-     * @param value The value for the operation.
-     */
-    addDefaultOpClause(prop, column, value) {
-        this.values.push([this.removeType(column), `${String(prop)}.${value}`]);
-    }
-    /**
-     * Adds an 'or' clause to the values array.
-     * @param filters The filters for the 'or' clause.
-     * @param foreignTable Optional foreign table for the 'or' clause.
-     */
-    addOrClause(filters, { foreignTable } = {}) {
-        const key = foreignTable ? `${foreignTable}.or` : "or";
-        this.values.push([this.removeType(key), `(${filters})`]);
-    }
-    /**
-     * Adds a 'filter' clause to the values array.
-     * @param column The column to apply the filter to.
-     * @param operator The operator for the filter.
-     * @param value The value for the filter.
-     */
-    addFilterClause(column, operator, value) {
-        this.values.push([this.removeType(column), `${operator}.${value}`]);
-    }
-    /**
-     * Adds an 'in' clause to the values array.
-     * @param column The column to apply the 'in' clause to.
-     * @param values The values for the 'in' clause.
-     */
-    addInClause(column, values) {
-        const cleanedValues = values
-            .map((s) => {
-            if (typeof s === "string" && /[,()]/.test(s))
-                return `"${s}"`;
-            else
-                return `${s}`;
-        })
-            .join(",");
-        this.values.push([this.removeType(column), `in.(${cleanedValues})`]);
-    }
-    /**
-     * Adds a 'contains' clause to the values array.
-     * @param column The column to apply the 'contains' clause to.
-     * @param value The value for the 'contains' clause.
-     */
-    addContainsClause(column, value) {
-        if (typeof value === "string") {
-            this.values.push([this.removeType(column), `cs.${value}`]);
-        }
-        else if (Array.isArray(value)) {
-            this.values.push([this.removeType(column), `cs.{${value.join(",")}}`]);
-        }
-        else {
-            this.values.push([
-                this.removeType(column),
-                `cs.${JSON.stringify(value)}`,
-            ]);
-        }
-    }
-    /**
-     * Adds a 'textSearch' clause to the values array.
-     * @param column The column to apply the 'textSearch' clause to.
-     * @param query The query for the 'textSearch' clause.
-     * @param config Optional configuration for the 'textSearch' clause.
-     * @param type Optional type for the 'textSearch' clause.
-     */
-    addTextSearchClause(column, query, { config, type, } = {}) {
-        let typePart = "";
-        if (type === "plain") {
-            typePart = "pl";
-        }
-        else if (type === "phrase") {
-            typePart = "ph";
-        }
-        else if (type === "websearch") {
-            typePart = "w";
-        }
-        const configPart = config === undefined ? "" : `(${config})`;
-        this.values.push([
-            this.removeType(column),
-            `${typePart}fts${configPart}.${query}`,
-        ]);
-    }
-    /**
-     * Adds a 'not' clause to the values array.
-     * @param column The column to apply the 'not' clause to.
-     * @param operator The operator for the 'not' clause.
-     * @param value The value for the 'not' clause.
-     */
-    addNotClause(column, operator, value) {
-        this.values.push([column, `not.${operator}.${value}`]);
-    }
-    /**
-     * Adds a 'match' clause to the values array.
-     * @param query The query for the 'match' clause.
-     */
-    addMatchClause(query) {
-        Object.entries(query).forEach(([column, value]) => {
-            this.values.push([column, `eq.${value}`]);
-        });
-    }
-    /**
-     * Returns the flattened parameters as a string.
-     * @returns The flattened parameters as a string.
-     */
-    flattenedParams() {
-        const mapped = this.values.map(([k, v]) => `${k}.${v}`);
-        if (mapped.length === 1)
-            return mapped[0];
-        return `and(${mapped.join(",")})`;
-    }
-    /**
-     * Gets flattened parameters from a `SupabaseFilter` and a
-     * `SupabaseFilterRPCCall`.
-     * @param rpc The `SupabaseFilter` object.
-     * @param filter The `SupabaseFilterRPCCall` object.
-     * @returns The flattened parameters as a string.
-     */
-    static getFlattenedParams(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    rpc, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    filter) {
-        const proxiedDuplicator = new ProxyParamsDuplicator();
-        const proxiedRpc = new Proxy(rpc, proxiedDuplicator.buildProxyHandler());
-        void filter(proxiedRpc);
-        return proxiedDuplicator.flattenedParams();
-    }
-}
-exports.ProxyParamsDuplicator = ProxyParamsDuplicator;
-/**
- * Converts a `SupabaseMetadata` object into a `StructuredQuery` object.
- * The function creates a new `StructuredQuery` object and uses the
- * `Operation` and `Comparison` classes to build the query.
- */
-function convertObjectFilterToStructuredQuery(
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-objFilter) {
-    return new structured_query_1.StructuredQuery("", new structured_query_1.Operation(structured_query_1.Operators.and, Object.entries(objFilter).map(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    ([column, value]) => new structured_query_1.Comparison(structured_query_1.Comparators.eq, column, value))));
-}
-exports.convertObjectFilterToStructuredQuery = convertObjectFilterToStructuredQuery;

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

@@ -1,101 +0,0 @@
-import { StructuredQuery } from "@langchain/core/structured_query";
-/**
- * Utility class used to duplicate parameters for a proxy object,
- * specifically designed to work with `SupabaseFilter` objects. It
- * contains methods to handle different types of operations such as "or",
- * "filter", "in", "contains", "textSearch", "match", "not", and default
- * operations.
- */
-export declare class ProxyParamsDuplicator {
-    duplicationAllowedOps: string[];
-    values: [string, string][];
-    /**
-     * Creates a proxy handler for a `SupabaseFilter` object. The handler
-     * intercepts get operations and applies specific logic based on the
-     * property being accessed.
-     * @returns A proxy handler for a `SupabaseFilter` object.
-     */
-    buildProxyHandler(): ProxyHandler<any>;
-    /**
-     * Removes type annotations from a value string.
-     * @param value The value string to clean.
-     * @returns The cleaned value string.
-     */
-    removeType(value: string): string;
-    /**
-     * Adds a default operation clause to the values array.
-     * @param prop The operation property.
-     * @param column The column to apply the operation to.
-     * @param value The value for the operation.
-     */
-    addDefaultOpClause(prop: string, column: string, value: unknown): void;
-    /**
-     * Adds an 'or' clause to the values array.
-     * @param filters The filters for the 'or' clause.
-     * @param foreignTable Optional foreign table for the 'or' clause.
-     */
-    addOrClause(filters: string, { foreignTable }?: {
-        foreignTable?: string;
-    }): void;
-    /**
-     * Adds a 'filter' clause to the values array.
-     * @param column The column to apply the filter to.
-     * @param operator The operator for the filter.
-     * @param value The value for the filter.
-     */
-    addFilterClause(column: string, operator: string, value: unknown): void;
-    /**
-     * Adds an 'in' clause to the values array.
-     * @param column The column to apply the 'in' clause to.
-     * @param values The values for the 'in' clause.
-     */
-    addInClause(column: string, values: unknown[]): void;
-    /**
-     * Adds a 'contains' clause to the values array.
-     * @param column The column to apply the 'contains' clause to.
-     * @param value The value for the 'contains' clause.
-     */
-    addContainsClause(column: string, value: unknown): void;
-    /**
-     * Adds a 'textSearch' clause to the values array.
-     * @param column The column to apply the 'textSearch' clause to.
-     * @param query The query for the 'textSearch' clause.
-     * @param config Optional configuration for the 'textSearch' clause.
-     * @param type Optional type for the 'textSearch' clause.
-     */
-    addTextSearchClause(column: string, query: string[], { config, type, }?: {
-        config?: string;
-        type?: "plain" | "phrase" | "websearch";
-    }): void;
-    /**
-     * Adds a 'not' clause to the values array.
-     * @param column The column to apply the 'not' clause to.
-     * @param operator The operator for the 'not' clause.
-     * @param value The value for the 'not' clause.
-     */
-    addNotClause(column: string, operator: string, value: unknown): void;
-    /**
-     * Adds a 'match' clause to the values array.
-     * @param query The query for the 'match' clause.
-     */
-    addMatchClause(query: Record<string, unknown>): void;
-    /**
-     * Returns the flattened parameters as a string.
-     * @returns The flattened parameters as a string.
-     */
-    flattenedParams(): string;
-    /**
-     * Gets flattened parameters from a `SupabaseFilter` and a
-     * `SupabaseFilterRPCCall`.
-     * @param rpc The `SupabaseFilter` object.
-     * @param filter The `SupabaseFilterRPCCall` object.
-     * @returns The flattened parameters as a string.
-     */
-    static getFlattenedParams(rpc: any, filter: any): string;
-}
-/**
- * Converts a `SupabaseMetadata` object into a `StructuredQuery` object.
- * The function creates a new `StructuredQuery` object and uses the
- * `Operation` and `Comparison` classes to build the query.
- */
-export declare function convertObjectFilterToStructuredQuery(objFilter: any): StructuredQuery;