langchain 0.0.76 → 0.0.77

package/dist/chains/query_constructor/parser.cjs

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryTransformer = void 0;
+const ir_js_1 = require("./ir.cjs");
+const expression_js_1 = require("../../output_parsers/expression.cjs");
+class QueryTransformer {
+    constructor(allowedComparators = [], allowedOperators = []) {
+        Object.defineProperty(this, "allowedComparators", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: allowedComparators
+        });
+        Object.defineProperty(this, "allowedOperators", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: allowedOperators
+        });
+    }
+    matchFunctionName(funcName) {
+        if (funcName in ir_js_1.Comparators) {
+            if (this.allowedComparators.length > 0) {
+                if (this.allowedComparators.includes(funcName)) {
+                    return funcName;
+                }
+                else {
+                    throw new Error("Received comparator not allowed");
+                }
+            }
+            else {
+                return funcName;
+            }
+        }
+        if (funcName in ir_js_1.Operators) {
+            if (this.allowedOperators.length > 0) {
+                if (this.allowedOperators.includes(funcName)) {
+                    return funcName;
+                }
+                else {
+                    throw new Error("Received operator not allowed");
+                }
+            }
+            else {
+                return funcName;
+            }
+        }
+        throw new Error("Unknown function name");
+    }
+    transform(parsed) {
+        const traverse = (node) => {
+            switch (node.type) {
+                case "call_expression": {
+                    if (typeof node.funcCall !== "string") {
+                        throw new Error("Property access expression and element access expression not supported");
+                    }
+                    const funcName = this.matchFunctionName(node.funcCall);
+                    if (funcName in ir_js_1.Operators) {
+                        return new ir_js_1.Operation(funcName, node.args?.map((arg) => traverse(arg)));
+                    }
+                    if (funcName in ir_js_1.Comparators) {
+                        if (node.args && node.args.length === 2) {
+                            return new ir_js_1.Comparison(funcName, traverse(node.args[0]), traverse(node.args[1]));
+                        }
+                        throw new Error("Comparator must have exactly 2 arguments");
+                    }
+                    throw new Error("Function name neither operator nor comparator");
+                }
+                case "string_literal": {
+                    return node.value;
+                }
+                case "numeric_literal": {
+                    return node.value;
+                }
+                case "array_literal": {
+                    return node.values.map((value) => traverse(value));
+                }
+                case "object_literal": {
+                    return node.values.reduce((acc, value) => {
+                        acc[value.identifier] = traverse(value.value);
+                        return acc;
+                    }, {});
+                }
+                case "boolean_literal": {
+                    return node.value;
+                }
+                default: {
+                    throw new Error("Unknown node type");
+                }
+            }
+        };
+        return traverse(parsed);
+    }
+    async parse(expression) {
+        const expressionParser = new expression_js_1.ExpressionParser();
+        const parsed = (await expressionParser.parse(expression));
+        if (!parsed) {
+            throw new Error("Could not parse expression");
+        }
+        return this.transform(parsed);
+    }
+}
+exports.QueryTransformer = QueryTransformer;

package/dist/chains/query_constructor/parser.d.ts

@@ -0,0 +1,12 @@
+import { Comparator, Comparison, Operation, Operator } from "./ir.js";
+export type TraverseType = boolean | Operation | Comparison | string | number | {
+    [key: string]: TraverseType;
+} | TraverseType[];
+export declare class QueryTransformer {
+    allowedComparators: Comparator[];
+    allowedOperators: Operator[];
+    constructor(allowedComparators?: Comparator[], allowedOperators?: Operator[]);
+    private matchFunctionName;
+    private transform;
+    parse(expression: string): Promise<Operation | Comparison>;
+}

package/dist/chains/query_constructor/parser.js

@@ -0,0 +1,99 @@
+import { Comparators, Comparison, Operation, Operators, } from "./ir.js";
+import { ExpressionParser, } from "../../output_parsers/expression.js";
+export class QueryTransformer {
+    constructor(allowedComparators = [], allowedOperators = []) {
+        Object.defineProperty(this, "allowedComparators", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: allowedComparators
+        });
+        Object.defineProperty(this, "allowedOperators", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: allowedOperators
+        });
+    }
+    matchFunctionName(funcName) {
+        if (funcName in Comparators) {
+            if (this.allowedComparators.length > 0) {
+                if (this.allowedComparators.includes(funcName)) {
+                    return funcName;
+                }
+                else {
+                    throw new Error("Received comparator not allowed");
+                }
+            }
+            else {
+                return funcName;
+            }
+        }
+        if (funcName in Operators) {
+            if (this.allowedOperators.length > 0) {
+                if (this.allowedOperators.includes(funcName)) {
+                    return funcName;
+                }
+                else {
+                    throw new Error("Received operator not allowed");
+                }
+            }
+            else {
+                return funcName;
+            }
+        }
+        throw new Error("Unknown function name");
+    }
+    transform(parsed) {
+        const traverse = (node) => {
+            switch (node.type) {
+                case "call_expression": {
+                    if (typeof node.funcCall !== "string") {
+                        throw new Error("Property access expression and element access expression not supported");
+                    }
+                    const funcName = this.matchFunctionName(node.funcCall);
+                    if (funcName in Operators) {
+                        return new Operation(funcName, node.args?.map((arg) => traverse(arg)));
+                    }
+                    if (funcName in Comparators) {
+                        if (node.args && node.args.length === 2) {
+                            return new Comparison(funcName, traverse(node.args[0]), traverse(node.args[1]));
+                        }
+                        throw new Error("Comparator must have exactly 2 arguments");
+                    }
+                    throw new Error("Function name neither operator nor comparator");
+                }
+                case "string_literal": {
+                    return node.value;
+                }
+                case "numeric_literal": {
+                    return node.value;
+                }
+                case "array_literal": {
+                    return node.values.map((value) => traverse(value));
+                }
+                case "object_literal": {
+                    return node.values.reduce((acc, value) => {
+                        acc[value.identifier] = traverse(value.value);
+                        return acc;
+                    }, {});
+                }
+                case "boolean_literal": {
+                    return node.value;
+                }
+                default: {
+                    throw new Error("Unknown node type");
+                }
+            }
+        };
+        return traverse(parsed);
+    }
+    async parse(expression) {
+        const expressionParser = new ExpressionParser();
+        const parsed = (await expressionParser.parse(expression));
+        if (!parsed) {
+            throw new Error("Could not parse expression");
+        }
+        return this.transform(parsed);
+    }
+}

package/dist/chains/query_constructor/prompt.cjs

@@ -0,0 +1,127 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SUFFIX = exports.DEFAULT_PREFIX = exports.DEFAULT_SCHEMA = exports.EXAMPLE_PROMPT = exports.EXAMPLE_PROMPT_TEMPLATE = exports.DEFAULT_EXAMPLES = exports.NO_FILTER_ANSWER = exports.FULL_ANSWER = exports.SONG_DATA_SOURCE = void 0;
+const prompt_js_1 = require("../../prompts/prompt.cjs");
+exports.SONG_DATA_SOURCE = `\
+\`\`\`json
+{
+    content: "Lyrics of a song",
+    attributes: {
+        "artist": {
+            "type": "string",
+            "description": "Name of the song artist"
+        },
+        "length": {
+            "type": "integer",
+            "description": "Length of the song in seconds"
+        },
+        "genre": {
+            "type": "string",
+            "description": "The song genre, one of 'pop', 'rock' or 'rap'"
+        }
+    }
+}
+\`\`\`\
+`
+    .replaceAll("{", "{{")
+    .replaceAll("}", "}}");
+exports.FULL_ANSWER = `\
+\`\`\`json
+{{
+    "query": "teenager love",
+    "filter": "and(or(eq(\\"artist\\", \\"Taylor Swift\\"), eq(\\"artist\\", \\"Katy Perry\\")), \
+lt(\\"length\\", 180), eq(\\"genre\\", \\"pop\\"))"
+}}`;
+exports.NO_FILTER_ANSWER = `\
+\`\`\`json
+{{
+    "query": "",
+    "filter": "NO_FILTER"
+}}
+\`\`\`\
+`;
+exports.DEFAULT_EXAMPLES = [
+    {
+        i: "1",
+        data_source: exports.SONG_DATA_SOURCE,
+        user_query: "What are songs by Taylor Swift or Katy Perry about teenage romance under 3 minutes long in the dance pop genre",
+        structured_request: exports.FULL_ANSWER,
+    },
+    {
+        i: "2",
+        data_source: exports.SONG_DATA_SOURCE,
+        user_query: "What are songs that were not published on Spotify",
+        structured_request: exports.NO_FILTER_ANSWER,
+    },
+];
+exports.EXAMPLE_PROMPT_TEMPLATE = `\
+<< Example {i}. >>
+Data Source:
+{data_source}
+
+User Query:
+{user_query}
+
+Structured Request:
+{structured_request}
+`;
+exports.EXAMPLE_PROMPT = new prompt_js_1.PromptTemplate({
+    inputVariables: ["i", "data_source", "user_query", "structured_request"],
+    template: exports.EXAMPLE_PROMPT_TEMPLATE,
+});
+exports.DEFAULT_SCHEMA = `\
+<< Structured Request Schema >>
+When responding use a markdown code snippet with a JSON object formatted in the \
+following schema:
+
+\`\`\`json
+{{{{
+    "query": string \\ text string to compare to document contents
+    "filter": string \\ logical condition statement for filtering documents
+}}}}
+\`\`\`
+
+The query string should contain only text that is expected to match the contents of \
+documents. Any conditions in the filter should not be mentioned in the query as well.
+
+A logical condition statement is composed of one or more comparison and logical \
+operation statements.
+
+A comparison statement takes the form: \`comp(attr, val)\`:
+- \`comp\` ({allowed_comparators}): comparator
+- \`attr\` (string):  name of attribute to apply the comparison to
+- \`val\` (string): is the comparison value
+
+A logical operation statement takes the form \`op(statement1, statement2, ...)\`:
+- \`op\` ({allowed_operators}): logical operator
+- \`statement1\`, \`statement2\`, ... (comparison statements or logical operation \
+statements): one or more statements to appy the operation to
+
+Make sure that you only use the comparators and logical operators listed above and \
+no others.
+Make sure that filters only refer to attributes that exist in the data source.
+Make sure that filters take into account the descriptions of attributes and only make \
+comparisons that are feasible given the type of data being stored.
+Make sure that filters are only used as needed. If there are no filters that should be \
+applied return "NO_FILTER" for the filter value.\
+`;
+exports.DEFAULT_PREFIX = `\
+Your goal is to structure the user's query to match the request schema provided below.
+
+{schema}\
+`;
+exports.DEFAULT_SUFFIX = `\
+<< Example {i}. >>
+Data Source:
+\`\`\`json
+{{{{
+    content: {content},
+    attributes: {attributes}
+}}}}
+\`\`\`
+
+User Query:
+{{query}}
+
+Structured Request:
+`;

package/dist/chains/query_constructor/prompt.d.ts

@@ -0,0 +1,15 @@
+import { PromptTemplate } from "../../prompts/prompt.js";
+export declare const SONG_DATA_SOURCE: string;
+export declare const FULL_ANSWER = "```json\n{{\n    \"query\": \"teenager love\",\n    \"filter\": \"and(or(eq(\\\"artist\\\", \\\"Taylor Swift\\\"), eq(\\\"artist\\\", \\\"Katy Perry\\\")), lt(\\\"length\\\", 180), eq(\\\"genre\\\", \\\"pop\\\"))\"\n}}";
+export declare const NO_FILTER_ANSWER = "```json\n{{\n    \"query\": \"\",\n    \"filter\": \"NO_FILTER\"\n}}\n```";
+export declare const DEFAULT_EXAMPLES: {
+    i: string;
+    data_source: string;
+    user_query: string;
+    structured_request: string;
+}[];
+export declare const EXAMPLE_PROMPT_TEMPLATE = "<< Example {i}. >>\nData Source:\n{data_source}\n\nUser Query:\n{user_query}\n\nStructured Request:\n{structured_request}\n";
+export declare const EXAMPLE_PROMPT: PromptTemplate;
+export declare const DEFAULT_SCHEMA = "<< Structured Request Schema >>\nWhen responding use a markdown code snippet with a JSON object formatted in the following schema:\n\n```json\n{{{{\n    \"query\": string \\ text string to compare to document contents\n    \"filter\": string \\ logical condition statement for filtering documents\n}}}}\n```\n\nThe query string should contain only text that is expected to match the contents of documents. Any conditions in the filter should not be mentioned in the query as well.\n\nA logical condition statement is composed of one or more comparison and logical operation statements.\n\nA comparison statement takes the form: `comp(attr, val)`:\n- `comp` ({allowed_comparators}): comparator\n- `attr` (string):  name of attribute to apply the comparison to\n- `val` (string): is the comparison value\n\nA logical operation statement takes the form `op(statement1, statement2, ...)`:\n- `op` ({allowed_operators}): logical operator\n- `statement1`, `statement2`, ... (comparison statements or logical operation statements): one or more statements to appy the operation to\n\nMake sure that you only use the comparators and logical operators listed above and no others.\nMake sure that filters only refer to attributes that exist in the data source.\nMake sure that filters take into account the descriptions of attributes and only make comparisons that are feasible given the type of data being stored.\nMake sure that filters are only used as needed. If there are no filters that should be applied return \"NO_FILTER\" for the filter value.";
+export declare const DEFAULT_PREFIX = "Your goal is to structure the user's query to match the request schema provided below.\n\n{schema}";
+export declare const DEFAULT_SUFFIX = "<< Example {i}. >>\nData Source:\n```json\n{{{{\n    content: {content},\n    attributes: {attributes}\n}}}}\n```\n\nUser Query:\n{{query}}\n\nStructured Request:\n";

package/dist/chains/query_constructor/prompt.js

@@ -0,0 +1,124 @@
+import { PromptTemplate } from "../../prompts/prompt.js";
+export const SONG_DATA_SOURCE = `\
+\`\`\`json
+{
+    content: "Lyrics of a song",
+    attributes: {
+        "artist": {
+            "type": "string",
+            "description": "Name of the song artist"
+        },
+        "length": {
+            "type": "integer",
+            "description": "Length of the song in seconds"
+        },
+        "genre": {
+            "type": "string",
+            "description": "The song genre, one of 'pop', 'rock' or 'rap'"
+        }
+    }
+}
+\`\`\`\
+`
+    .replaceAll("{", "{{")
+    .replaceAll("}", "}}");
+export const FULL_ANSWER = `\
+\`\`\`json
+{{
+    "query": "teenager love",
+    "filter": "and(or(eq(\\"artist\\", \\"Taylor Swift\\"), eq(\\"artist\\", \\"Katy Perry\\")), \
+lt(\\"length\\", 180), eq(\\"genre\\", \\"pop\\"))"
+}}`;
+export const NO_FILTER_ANSWER = `\
+\`\`\`json
+{{
+    "query": "",
+    "filter": "NO_FILTER"
+}}
+\`\`\`\
+`;
+export const DEFAULT_EXAMPLES = [
+    {
+        i: "1",
+        data_source: SONG_DATA_SOURCE,
+        user_query: "What are songs by Taylor Swift or Katy Perry about teenage romance under 3 minutes long in the dance pop genre",
+        structured_request: FULL_ANSWER,
+    },
+    {
+        i: "2",
+        data_source: SONG_DATA_SOURCE,
+        user_query: "What are songs that were not published on Spotify",
+        structured_request: NO_FILTER_ANSWER,
+    },
+];
+export const EXAMPLE_PROMPT_TEMPLATE = `\
+<< Example {i}. >>
+Data Source:
+{data_source}
+
+User Query:
+{user_query}
+
+Structured Request:
+{structured_request}
+`;
+export const EXAMPLE_PROMPT = /* #__PURE__ */ new PromptTemplate({
+    inputVariables: ["i", "data_source", "user_query", "structured_request"],
+    template: EXAMPLE_PROMPT_TEMPLATE,
+});
+export const DEFAULT_SCHEMA = `\
+<< Structured Request Schema >>
+When responding use a markdown code snippet with a JSON object formatted in the \
+following schema:
+
+\`\`\`json
+{{{{
+    "query": string \\ text string to compare to document contents
+    "filter": string \\ logical condition statement for filtering documents
+}}}}
+\`\`\`
+
+The query string should contain only text that is expected to match the contents of \
+documents. Any conditions in the filter should not be mentioned in the query as well.
+
+A logical condition statement is composed of one or more comparison and logical \
+operation statements.
+
+A comparison statement takes the form: \`comp(attr, val)\`:
+- \`comp\` ({allowed_comparators}): comparator
+- \`attr\` (string):  name of attribute to apply the comparison to
+- \`val\` (string): is the comparison value
+
+A logical operation statement takes the form \`op(statement1, statement2, ...)\`:
+- \`op\` ({allowed_operators}): logical operator
+- \`statement1\`, \`statement2\`, ... (comparison statements or logical operation \
+statements): one or more statements to appy the operation to
+
+Make sure that you only use the comparators and logical operators listed above and \
+no others.
+Make sure that filters only refer to attributes that exist in the data source.
+Make sure that filters take into account the descriptions of attributes and only make \
+comparisons that are feasible given the type of data being stored.
+Make sure that filters are only used as needed. If there are no filters that should be \
+applied return "NO_FILTER" for the filter value.\
+`;
+export const DEFAULT_PREFIX = `\
+Your goal is to structure the user's query to match the request schema provided below.
+
+{schema}\
+`;
+export const DEFAULT_SUFFIX = `\
+<< Example {i}. >>
+Data Source:
+\`\`\`json
+{{{{
+    content: {content},
+    attributes: {attributes}
+}}}}
+\`\`\`
+
+User Query:
+{{query}}
+
+Structured Request:
+`;

package/dist/chains/sql_db/sql_db_chain.cjs

@@ -50,6 +50,12 @@ class SqlDatabaseChain extends base_js_1.BaseChain {
             writable: true,
             value: "result"
         });
+        Object.defineProperty(this, "sqlOutputKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined
+        });
         // Whether to return the result of querying the SQL table directly.
         Object.defineProperty(this, "returnDirect", {
             enumerable: true,
@@ -62,6 +68,7 @@ class SqlDatabaseChain extends base_js_1.BaseChain {
         this.topK = fields.topK ?? this.topK;
         this.inputKey = fields.inputKey ?? this.inputKey;
         this.outputKey = fields.outputKey ?? this.outputKey;
+        this.sqlOutputKey = fields.sqlOutputKey ?? this.sqlOutputKey;
         this.prompt =
             fields.prompt ??
                 (0, sql_utils_js_1.getPromptTemplateFromDataSource)(this.database.appDataSource);
@@ -111,6 +118,9 @@ class SqlDatabaseChain extends base_js_1.BaseChain {
                 [this.outputKey]: await llmChain.predict(llmInputs, runManager?.getChild()),
             };
         }
+        if (this.sqlOutputKey != null) {
+            finalResult[this.sqlOutputKey] = sqlCommand;
+        }
         return finalResult;
     }
     _chainType() {
@@ -120,6 +130,9 @@ class SqlDatabaseChain extends base_js_1.BaseChain {
         return [this.inputKey];
     }
     get outputKeys() {
+        if (this.sqlOutputKey != null) {
+            return [this.outputKey, this.sqlOutputKey];
+        }
         return [this.outputKey];
     }
     static async deserialize(data, SqlDatabaseFromOptionsParams) {

package/dist/chains/sql_db/sql_db_chain.d.ts

@@ -11,6 +11,7 @@ export interface SqlDatabaseChainInput extends ChainInputs {
     topK?: number;
     inputKey?: string;
     outputKey?: string;
+    sqlOutputKey?: string;
     prompt?: PromptTemplate;
 }
 export declare class SqlDatabaseChain extends BaseChain {
@@ -20,6 +21,7 @@ export declare class SqlDatabaseChain extends BaseChain {
     topK: number;
     inputKey: string;
     outputKey: string;
+    sqlOutputKey: string | undefined;
     returnDirect: boolean;
     constructor(fields: SqlDatabaseChainInput);
     /** @ignore */

package/dist/chains/sql_db/sql_db_chain.js

@@ -47,6 +47,12 @@ export class SqlDatabaseChain extends BaseChain {
             writable: true,
             value: "result"
         });
+        Object.defineProperty(this, "sqlOutputKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: undefined
+        });
         // Whether to return the result of querying the SQL table directly.
         Object.defineProperty(this, "returnDirect", {
             enumerable: true,
@@ -59,6 +65,7 @@ export class SqlDatabaseChain extends BaseChain {
         this.topK = fields.topK ?? this.topK;
         this.inputKey = fields.inputKey ?? this.inputKey;
         this.outputKey = fields.outputKey ?? this.outputKey;
+        this.sqlOutputKey = fields.sqlOutputKey ?? this.sqlOutputKey;
         this.prompt =
             fields.prompt ??
                 getPromptTemplateFromDataSource(this.database.appDataSource);
@@ -108,6 +115,9 @@ export class SqlDatabaseChain extends BaseChain {
                 [this.outputKey]: await llmChain.predict(llmInputs, runManager?.getChild()),
             };
         }
+        if (this.sqlOutputKey != null) {
+            finalResult[this.sqlOutputKey] = sqlCommand;
+        }
         return finalResult;
     }
     _chainType() {
@@ -117,6 +127,9 @@ export class SqlDatabaseChain extends BaseChain {
         return [this.inputKey];
     }
     get outputKeys() {
+        if (this.sqlOutputKey != null) {
+            return [this.outputKey, this.sqlOutputKey];
+        }
         return [this.outputKey];
     }
     static async deserialize(data, SqlDatabaseFromOptionsParams) {