@langchain/classic 1.0.0-alpha.1

package/dist/chains/serde.d.cts

@@ -0,0 +1,156 @@
+import { SerializedLLM } from "@langchain/core/language_models/llms";
+import { SerializedBasePromptTemplate } from "@langchain/core/prompts";
+
+//#region src/chains/serde.d.ts
+
+/**
+ * Represents the serialized form of an LLMChain. It includes properties
+ * such as `_type`, `llm`, and `prompt`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedLLMChain = {
+  _type: "llm_chain";
+  llm?: SerializedLLM;
+  prompt?: SerializedBasePromptTemplate;
+};
+/**
+ * Represents the serialized form of a SequentialChain. It includes
+ * properties such as `_type`, `input_variables`, `output_variables`, and
+ * `chains`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedSequentialChain = {
+  _type: "sequential_chain";
+  input_variables: string[];
+  output_variables: string[];
+  chains: SerializedBaseChain[];
+};
+/**
+ * Represents the serialized form of a SimpleSequentialChain. It includes
+ * properties such as `_type` and `chains`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedSimpleSequentialChain = {
+  _type: "simple_sequential_chain";
+  chains: Array<SerializedBaseChain>;
+};
+/**
+ * Represents the serialized form of a VectorDBQAChain. It includes
+ * properties such as `_type`, `k`, and `combine_documents_chain`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedVectorDBQAChain = {
+  _type: "vector_db_qa";
+  k: number;
+  combine_documents_chain: SerializedBaseChain;
+};
+/**
+ * Represents the serialized form of an APIChain. It includes properties
+ * such as `_type`, `api_request_chain`, `api_answer_chain`, and
+ * `api_docs`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedAPIChain = {
+  _type: "api_chain";
+  api_request_chain: SerializedLLMChain;
+  api_answer_chain: SerializedLLMChain;
+  api_docs: string;
+};
+/**
+ * Represents the serialized form of a StuffDocumentsChain. It includes
+ * properties such as `_type` and `llm_chain`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedStuffDocumentsChain = {
+  _type: "stuff_documents_chain";
+  llm_chain?: SerializedLLMChain;
+};
+/**
+ * Represents the serialized form of a ChatVectorDBQAChain. It includes
+ * properties such as `_type`, `k`, `combine_documents_chain`, and
+ * `question_generator`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedChatVectorDBQAChain = {
+  _type: "chat-vector-db";
+  k: number;
+  combine_documents_chain: SerializedBaseChain;
+  question_generator: SerializedLLMChain;
+};
+/**
+ * Represents the serialized form of a MapReduceDocumentsChain. It
+ * includes properties such as `_type`, `llm_chain`, and
+ * `combine_document_chain`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedMapReduceDocumentsChain = {
+  _type: "map_reduce_documents_chain";
+  llm_chain?: SerializedLLMChain;
+  combine_document_chain?: SerializedStuffDocumentsChain;
+};
+/**
+ * Represents the serialized form of a RefineDocumentsChain. It includes
+ * properties such as `_type`, `llm_chain`, and `refine_llm_chain`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedRefineDocumentsChain = {
+  _type: "refine_documents_chain";
+  llm_chain?: SerializedLLMChain;
+  refine_llm_chain?: SerializedLLMChain;
+};
+/**
+ * Represents the serialized form of an AnalyzeDocumentChain. It includes
+ * properties such as `_type` and `combine_document_chain`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedAnalyzeDocumentChain = {
+  _type: "analyze_document_chain";
+  combine_document_chain?: SerializedBaseChain;
+};
+/**
+ * Represents the serialized form of a ConstitutionalPrinciple. It
+ * includes properties such as `_type`, `critiqueRequest`,
+ * `revisionRequest`, and `name`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedConstitutionalPrinciple = {
+  _type: "constitutional_principle";
+  critiqueRequest: string;
+  revisionRequest: string;
+  name: string;
+};
+/**
+ * Represents the serialized form of a ConstitutionalChain. It includes
+ * properties such as `_type`, `chain`, `critiqueChain`, `revisionChain`,
+ * and `ConstitutionalPrinciple`.
+ *
+ * @deprecated
+ */
+type SerializedConstitutionalChain = {
+  _type: "constitutional_chain";
+  chain?: SerializedLLMChain;
+  critiqueChain?: SerializedBaseChain;
+  revisionChain?: SerializedBaseChain;
+  ConstitutionalPrinciple?: SerializedConstitutionalPrinciple[];
+};
+/**
+ * Represents the serialized form of a BaseChain. It can be one of the
+ * above serialized chain types.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedBaseChain = SerializedLLMChain | SerializedSequentialChain | SerializedSimpleSequentialChain | SerializedVectorDBQAChain | SerializedAPIChain | SerializedStuffDocumentsChain | SerializedChatVectorDBQAChain | SerializedMapReduceDocumentsChain | SerializedAnalyzeDocumentChain | SerializedRefineDocumentsChain | SerializedConstitutionalChain;
+//#endregion
+export { SerializedAPIChain, SerializedAnalyzeDocumentChain, SerializedBaseChain, SerializedChatVectorDBQAChain, SerializedConstitutionalPrinciple, SerializedLLMChain, SerializedMapReduceDocumentsChain, SerializedRefineDocumentsChain, SerializedSequentialChain, SerializedSimpleSequentialChain, SerializedStuffDocumentsChain, SerializedVectorDBQAChain };
+//# sourceMappingURL=serde.d.cts.map

package/dist/chains/serde.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serde.d.cts","names":["SerializedLLM","SerializedBasePromptTemplate","SerializedLLMChain","SerializedSequentialChain","SerializedBaseChain","SerializedSimpleSequentialChain","Array","SerializedVectorDBQAChain","SerializedAPIChain","SerializedStuffDocumentsChain","SerializedChatVectorDBQAChain","SerializedMapReduceDocumentsChain","SerializedRefineDocumentsChain","SerializedAnalyzeDocumentChain","SerializedConstitutionalPrinciple","SerializedConstitutionalChain"],"sources":["../../src/chains/serde.d.ts"],"sourcesContent":["import type { SerializedLLM } from \"@langchain/core/language_models/llms\";\nimport { SerializedBasePromptTemplate } from \"@langchain/core/prompts\";\n/**\n * Represents the serialized form of an LLMChain. It includes properties\n * such as `_type`, `llm`, and `prompt`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedLLMChain = {\n    _type: \"llm_chain\";\n    llm?: SerializedLLM;\n    prompt?: SerializedBasePromptTemplate;\n};\n/**\n * Represents the serialized form of a SequentialChain. It includes\n * properties such as `_type`, `input_variables`, `output_variables`, and\n * `chains`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedSequentialChain = {\n    _type: \"sequential_chain\";\n    input_variables: string[];\n    output_variables: string[];\n    chains: SerializedBaseChain[];\n};\n/**\n * Represents the serialized form of a SimpleSequentialChain. It includes\n * properties such as `_type` and `chains`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedSimpleSequentialChain = {\n    _type: \"simple_sequential_chain\";\n    chains: Array<SerializedBaseChain>;\n};\n/**\n * Represents the serialized form of a VectorDBQAChain. It includes\n * properties such as `_type`, `k`, and `combine_documents_chain`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedVectorDBQAChain = {\n    _type: \"vector_db_qa\";\n    k: number;\n    combine_documents_chain: SerializedBaseChain;\n};\n/**\n * Represents the serialized form of an APIChain. It includes properties\n * such as `_type`, `api_request_chain`, `api_answer_chain`, and\n * `api_docs`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedAPIChain = {\n    _type: \"api_chain\";\n    api_request_chain: SerializedLLMChain;\n    api_answer_chain: SerializedLLMChain;\n    api_docs: string;\n};\n/**\n * Represents the serialized form of a StuffDocumentsChain. It includes\n * properties such as `_type` and `llm_chain`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedStuffDocumentsChain = {\n    _type: \"stuff_documents_chain\";\n    llm_chain?: SerializedLLMChain;\n};\n/**\n * Represents the serialized form of a ChatVectorDBQAChain. It includes\n * properties such as `_type`, `k`, `combine_documents_chain`, and\n * `question_generator`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedChatVectorDBQAChain = {\n    _type: \"chat-vector-db\";\n    k: number;\n    combine_documents_chain: SerializedBaseChain;\n    question_generator: SerializedLLMChain;\n};\n/**\n * Represents the serialized form of a MapReduceDocumentsChain. It\n * includes properties such as `_type`, `llm_chain`, and\n * `combine_document_chain`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedMapReduceDocumentsChain = {\n    _type: \"map_reduce_documents_chain\";\n    llm_chain?: SerializedLLMChain;\n    combine_document_chain?: SerializedStuffDocumentsChain;\n};\n/**\n * Represents the serialized form of a RefineDocumentsChain. It includes\n * properties such as `_type`, `llm_chain`, and `refine_llm_chain`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedRefineDocumentsChain = {\n    _type: \"refine_documents_chain\";\n    llm_chain?: SerializedLLMChain;\n    refine_llm_chain?: SerializedLLMChain;\n};\n/**\n * Represents the serialized form of an AnalyzeDocumentChain. It includes\n * properties such as `_type` and `combine_document_chain`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedAnalyzeDocumentChain = {\n    _type: \"analyze_document_chain\";\n    combine_document_chain?: SerializedBaseChain;\n};\n/**\n * Represents the serialized form of a ConstitutionalPrinciple. It\n * includes properties such as `_type`, `critiqueRequest`,\n * `revisionRequest`, and `name`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedConstitutionalPrinciple = {\n    _type: \"constitutional_principle\";\n    critiqueRequest: string;\n    revisionRequest: string;\n    name: string;\n};\n/**\n * Represents the serialized form of a ConstitutionalChain. It includes\n * properties such as `_type`, `chain`, `critiqueChain`, `revisionChain`,\n * and `ConstitutionalPrinciple`.\n *\n * @deprecated\n */\nexport type SerializedConstitutionalChain = {\n    _type: \"constitutional_chain\";\n    chain?: SerializedLLMChain;\n    critiqueChain?: SerializedBaseChain;\n    revisionChain?: SerializedBaseChain;\n    ConstitutionalPrinciple?: SerializedConstitutionalPrinciple[];\n};\n/**\n * Represents the serialized form of a BaseChain. It can be one of the\n * above serialized chain types.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedBaseChain = SerializedLLMChain | SerializedSequentialChain | SerializedSimpleSequentialChain | SerializedVectorDBQAChain | SerializedAPIChain | SerializedStuffDocumentsChain | SerializedChatVectorDBQAChain | SerializedMapReduceDocumentsChain | SerializedAnalyzeDocumentChain | SerializedRefineDocumentsChain | SerializedConstitutionalChain;\n"],"mappings":";;;;;;;AAQA;;;;AAGyC,KAH7BE,kBAAAA,GAG6B;EAS7BC,KAAAA,EAAAA,WAAAA;EAYAE,GAAAA,CAAAA,EAtBFL,aAsBEK;EAA+B,MAAA,CAAA,EArB9BJ,4BAqB8B;CAAA;;AAE1B;AAQjB;AAYA;;;;AAGwC,KArC5BE,yBAAAA,GAqC4B;EAS5BM,KAAAA,EAAAA,kBAAAA;EAWAC,eAAAA,EAAAA,MAAAA,EAAAA;EAA6B,gBAAA,EAAA,MAAA,EAAA;EAAA,MAGZN,EAxDjBA,mBAwDiBA,EAAAA;CAAmB;AACN;AAS1C;;;;AAG0D;AAQ9CQ,KArEAP,+BAAAA,GAqE8B;EAAA,KAAA,EAAA,yBAAA;EAAA,MAE1BH,EArEJI,KAqEIJ,CArEEE,mBAqEFF,CAAAA;CAAkB;AACO;AAQzC;AAWA;AAaA;;;AAGoBE,KAjGRG,yBAAAA,GAiGQH;EAAmB,KACnBA,EAAAA,cAAAA;EAAmB,CAAA,EACTU,MAAAA;EAAiC,uBAAA,EAhGlCV,mBAgGkC;AAQ/D,CAAA;;;;;;;;AAAsMM,KA/F1LF,kBAAAA,GA+F0LE;EAA6B,KAAGC,EAAAA,WAAAA;EAAiC,iBAAGE,EA7FnPX,kBA6FmPW;EAA8B,gBAAGD,EA5FrRV,kBA4FqRU;EAA8B,QAAGG,EAAAA,MAAAA;AAA6B,CAAA;;;;;;;KAnF7VN,6BAAAA;;cAEIP;;;;;;;;;KASJQ,6BAAAA;;;2BAGiBN;sBACLF;;;;;;;;;KASZS,iCAAAA;;cAEIT;2BACaO;;;;;;;;KAQjBG,8BAAAA;;cAEIV;qBACOA;;;;;;;;KAQXW,8BAAAA;;2BAEiBT;;;;;;;;;KASjBU,iCAAAA;;;;;;;;;;;;;KAaAC,6BAAAA;;UAEAb;kBACQE;kBACAA;4BACUU;;;;;;;;KAQlBV,mBAAAA,GAAsBF,qBAAqBC,4BAA4BE,kCAAkCE,4BAA4BC,qBAAqBC,gCAAgCC,gCAAgCC,oCAAoCE,iCAAiCD,iCAAiCG"}

package/dist/chains/serde.d.ts

@@ -0,0 +1,156 @@
+import { SerializedBasePromptTemplate } from "@langchain/core/prompts";
+import { SerializedLLM } from "@langchain/core/language_models/llms";
+
+//#region src/chains/serde.d.ts
+
+/**
+ * Represents the serialized form of an LLMChain. It includes properties
+ * such as `_type`, `llm`, and `prompt`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedLLMChain = {
+  _type: "llm_chain";
+  llm?: SerializedLLM;
+  prompt?: SerializedBasePromptTemplate;
+};
+/**
+ * Represents the serialized form of a SequentialChain. It includes
+ * properties such as `_type`, `input_variables`, `output_variables`, and
+ * `chains`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedSequentialChain = {
+  _type: "sequential_chain";
+  input_variables: string[];
+  output_variables: string[];
+  chains: SerializedBaseChain[];
+};
+/**
+ * Represents the serialized form of a SimpleSequentialChain. It includes
+ * properties such as `_type` and `chains`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedSimpleSequentialChain = {
+  _type: "simple_sequential_chain";
+  chains: Array<SerializedBaseChain>;
+};
+/**
+ * Represents the serialized form of a VectorDBQAChain. It includes
+ * properties such as `_type`, `k`, and `combine_documents_chain`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedVectorDBQAChain = {
+  _type: "vector_db_qa";
+  k: number;
+  combine_documents_chain: SerializedBaseChain;
+};
+/**
+ * Represents the serialized form of an APIChain. It includes properties
+ * such as `_type`, `api_request_chain`, `api_answer_chain`, and
+ * `api_docs`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedAPIChain = {
+  _type: "api_chain";
+  api_request_chain: SerializedLLMChain;
+  api_answer_chain: SerializedLLMChain;
+  api_docs: string;
+};
+/**
+ * Represents the serialized form of a StuffDocumentsChain. It includes
+ * properties such as `_type` and `llm_chain`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedStuffDocumentsChain = {
+  _type: "stuff_documents_chain";
+  llm_chain?: SerializedLLMChain;
+};
+/**
+ * Represents the serialized form of a ChatVectorDBQAChain. It includes
+ * properties such as `_type`, `k`, `combine_documents_chain`, and
+ * `question_generator`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedChatVectorDBQAChain = {
+  _type: "chat-vector-db";
+  k: number;
+  combine_documents_chain: SerializedBaseChain;
+  question_generator: SerializedLLMChain;
+};
+/**
+ * Represents the serialized form of a MapReduceDocumentsChain. It
+ * includes properties such as `_type`, `llm_chain`, and
+ * `combine_document_chain`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedMapReduceDocumentsChain = {
+  _type: "map_reduce_documents_chain";
+  llm_chain?: SerializedLLMChain;
+  combine_document_chain?: SerializedStuffDocumentsChain;
+};
+/**
+ * Represents the serialized form of a RefineDocumentsChain. It includes
+ * properties such as `_type`, `llm_chain`, and `refine_llm_chain`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedRefineDocumentsChain = {
+  _type: "refine_documents_chain";
+  llm_chain?: SerializedLLMChain;
+  refine_llm_chain?: SerializedLLMChain;
+};
+/**
+ * Represents the serialized form of an AnalyzeDocumentChain. It includes
+ * properties such as `_type` and `combine_document_chain`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedAnalyzeDocumentChain = {
+  _type: "analyze_document_chain";
+  combine_document_chain?: SerializedBaseChain;
+};
+/**
+ * Represents the serialized form of a ConstitutionalPrinciple. It
+ * includes properties such as `_type`, `critiqueRequest`,
+ * `revisionRequest`, and `name`.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedConstitutionalPrinciple = {
+  _type: "constitutional_principle";
+  critiqueRequest: string;
+  revisionRequest: string;
+  name: string;
+};
+/**
+ * Represents the serialized form of a ConstitutionalChain. It includes
+ * properties such as `_type`, `chain`, `critiqueChain`, `revisionChain`,
+ * and `ConstitutionalPrinciple`.
+ *
+ * @deprecated
+ */
+type SerializedConstitutionalChain = {
+  _type: "constitutional_chain";
+  chain?: SerializedLLMChain;
+  critiqueChain?: SerializedBaseChain;
+  revisionChain?: SerializedBaseChain;
+  ConstitutionalPrinciple?: SerializedConstitutionalPrinciple[];
+};
+/**
+ * Represents the serialized form of a BaseChain. It can be one of the
+ * above serialized chain types.
+ *
+ * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.
+ */
+type SerializedBaseChain = SerializedLLMChain | SerializedSequentialChain | SerializedSimpleSequentialChain | SerializedVectorDBQAChain | SerializedAPIChain | SerializedStuffDocumentsChain | SerializedChatVectorDBQAChain | SerializedMapReduceDocumentsChain | SerializedAnalyzeDocumentChain | SerializedRefineDocumentsChain | SerializedConstitutionalChain;
+//#endregion
+export { SerializedAPIChain, SerializedAnalyzeDocumentChain, SerializedBaseChain, SerializedChatVectorDBQAChain, SerializedConstitutionalPrinciple, SerializedLLMChain, SerializedMapReduceDocumentsChain, SerializedRefineDocumentsChain, SerializedSequentialChain, SerializedSimpleSequentialChain, SerializedStuffDocumentsChain, SerializedVectorDBQAChain };
+//# sourceMappingURL=serde.d.ts.map

package/dist/chains/serde.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serde.d.ts","names":["SerializedLLM","SerializedBasePromptTemplate","SerializedLLMChain","SerializedSequentialChain","SerializedBaseChain","SerializedSimpleSequentialChain","Array","SerializedVectorDBQAChain","SerializedAPIChain","SerializedStuffDocumentsChain","SerializedChatVectorDBQAChain","SerializedMapReduceDocumentsChain","SerializedRefineDocumentsChain","SerializedAnalyzeDocumentChain","SerializedConstitutionalPrinciple","SerializedConstitutionalChain"],"sources":["../../src/chains/serde.d.ts"],"sourcesContent":["import type { SerializedLLM } from \"@langchain/core/language_models/llms\";\nimport { SerializedBasePromptTemplate } from \"@langchain/core/prompts\";\n/**\n * Represents the serialized form of an LLMChain. It includes properties\n * such as `_type`, `llm`, and `prompt`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedLLMChain = {\n    _type: \"llm_chain\";\n    llm?: SerializedLLM;\n    prompt?: SerializedBasePromptTemplate;\n};\n/**\n * Represents the serialized form of a SequentialChain. It includes\n * properties such as `_type`, `input_variables`, `output_variables`, and\n * `chains`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedSequentialChain = {\n    _type: \"sequential_chain\";\n    input_variables: string[];\n    output_variables: string[];\n    chains: SerializedBaseChain[];\n};\n/**\n * Represents the serialized form of a SimpleSequentialChain. It includes\n * properties such as `_type` and `chains`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedSimpleSequentialChain = {\n    _type: \"simple_sequential_chain\";\n    chains: Array<SerializedBaseChain>;\n};\n/**\n * Represents the serialized form of a VectorDBQAChain. It includes\n * properties such as `_type`, `k`, and `combine_documents_chain`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedVectorDBQAChain = {\n    _type: \"vector_db_qa\";\n    k: number;\n    combine_documents_chain: SerializedBaseChain;\n};\n/**\n * Represents the serialized form of an APIChain. It includes properties\n * such as `_type`, `api_request_chain`, `api_answer_chain`, and\n * `api_docs`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedAPIChain = {\n    _type: \"api_chain\";\n    api_request_chain: SerializedLLMChain;\n    api_answer_chain: SerializedLLMChain;\n    api_docs: string;\n};\n/**\n * Represents the serialized form of a StuffDocumentsChain. It includes\n * properties such as `_type` and `llm_chain`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedStuffDocumentsChain = {\n    _type: \"stuff_documents_chain\";\n    llm_chain?: SerializedLLMChain;\n};\n/**\n * Represents the serialized form of a ChatVectorDBQAChain. It includes\n * properties such as `_type`, `k`, `combine_documents_chain`, and\n * `question_generator`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedChatVectorDBQAChain = {\n    _type: \"chat-vector-db\";\n    k: number;\n    combine_documents_chain: SerializedBaseChain;\n    question_generator: SerializedLLMChain;\n};\n/**\n * Represents the serialized form of a MapReduceDocumentsChain. It\n * includes properties such as `_type`, `llm_chain`, and\n * `combine_document_chain`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedMapReduceDocumentsChain = {\n    _type: \"map_reduce_documents_chain\";\n    llm_chain?: SerializedLLMChain;\n    combine_document_chain?: SerializedStuffDocumentsChain;\n};\n/**\n * Represents the serialized form of a RefineDocumentsChain. It includes\n * properties such as `_type`, `llm_chain`, and `refine_llm_chain`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedRefineDocumentsChain = {\n    _type: \"refine_documents_chain\";\n    llm_chain?: SerializedLLMChain;\n    refine_llm_chain?: SerializedLLMChain;\n};\n/**\n * Represents the serialized form of an AnalyzeDocumentChain. It includes\n * properties such as `_type` and `combine_document_chain`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedAnalyzeDocumentChain = {\n    _type: \"analyze_document_chain\";\n    combine_document_chain?: SerializedBaseChain;\n};\n/**\n * Represents the serialized form of a ConstitutionalPrinciple. It\n * includes properties such as `_type`, `critiqueRequest`,\n * `revisionRequest`, and `name`.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedConstitutionalPrinciple = {\n    _type: \"constitutional_principle\";\n    critiqueRequest: string;\n    revisionRequest: string;\n    name: string;\n};\n/**\n * Represents the serialized form of a ConstitutionalChain. It includes\n * properties such as `_type`, `chain`, `critiqueChain`, `revisionChain`,\n * and `ConstitutionalPrinciple`.\n *\n * @deprecated\n */\nexport type SerializedConstitutionalChain = {\n    _type: \"constitutional_chain\";\n    chain?: SerializedLLMChain;\n    critiqueChain?: SerializedBaseChain;\n    revisionChain?: SerializedBaseChain;\n    ConstitutionalPrinciple?: SerializedConstitutionalPrinciple[];\n};\n/**\n * Represents the serialized form of a BaseChain. It can be one of the\n * above serialized chain types.\n *\n * @deprecated Use newer {@link https://api.js.langchain.com/functions/langchain.load.load.html | serialization methods}.\n */\nexport type SerializedBaseChain = SerializedLLMChain | SerializedSequentialChain | SerializedSimpleSequentialChain | SerializedVectorDBQAChain | SerializedAPIChain | SerializedStuffDocumentsChain | SerializedChatVectorDBQAChain | SerializedMapReduceDocumentsChain | SerializedAnalyzeDocumentChain | SerializedRefineDocumentsChain | SerializedConstitutionalChain;\n"],"mappings":";;;;;;;AAQA;;;;AAGyC,KAH7BE,kBAAAA,GAG6B;EAS7BC,KAAAA,EAAAA,WAAAA;EAYAE,GAAAA,CAAAA,EAtBFL,aAsBEK;EAA+B,MAAA,CAAA,EArB9BJ,4BAqB8B;CAAA;;AAE1B;AAQjB;AAYA;;;;AAGwC,KArC5BE,yBAAAA,GAqC4B;EAS5BM,KAAAA,EAAAA,kBAAAA;EAWAC,eAAAA,EAAAA,MAAAA,EAAAA;EAA6B,gBAAA,EAAA,MAAA,EAAA;EAAA,MAGZN,EAxDjBA,mBAwDiBA,EAAAA;CAAmB;AACN;AAS1C;;;;AAG0D;AAQ9CQ,KArEAP,+BAAAA,GAqE8B;EAAA,KAAA,EAAA,yBAAA;EAAA,MAE1BH,EArEJI,KAqEIJ,CArEEE,mBAqEFF,CAAAA;CAAkB;AACO;AAQzC;AAWA;AAaA;;;AAGoBE,KAjGRG,yBAAAA,GAiGQH;EAAmB,KACnBA,EAAAA,cAAAA;EAAmB,CAAA,EACTU,MAAAA;EAAiC,uBAAA,EAhGlCV,mBAgGkC;AAQ/D,CAAA;;;;;;;;AAAsMM,KA/F1LF,kBAAAA,GA+F0LE;EAA6B,KAAGC,EAAAA,WAAAA;EAAiC,iBAAGE,EA7FnPX,kBA6FmPW;EAA8B,gBAAGD,EA5FrRV,kBA4FqRU;EAA8B,QAAGG,EAAAA,MAAAA;AAA6B,CAAA;;;;;;;KAnF7VN,6BAAAA;;cAEIP;;;;;;;;;KASJQ,6BAAAA;;;2BAGiBN;sBACLF;;;;;;;;;KASZS,iCAAAA;;cAEIT;2BACaO;;;;;;;;KAQjBG,8BAAAA;;cAEIV;qBACOA;;;;;;;;KAQXW,8BAAAA;;2BAEiBT;;;;;;;;;KASjBU,iCAAAA;;;;;;;;;;;;;KAaAC,6BAAAA;;UAEAb;kBACQE;kBACAA;4BACUU;;;;;;;;KAQlBV,mBAAAA,GAAsBF,qBAAqBC,4BAA4BE,kCAAkCE,4BAA4BC,qBAAqBC,gCAAgCC,gCAAgCC,oCAAoCE,iCAAiCD,iCAAiCG"}

package/dist/chains/sql_db/index.cjs

@@ -0,0 +1,35 @@
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_sql_db_prompt = require('./sql_db_prompt.cjs');
+const require_sql_db_chain = require('./sql_db_chain.cjs');
+
+//#region src/chains/sql_db/index.ts
+var sql_db_exports = {};
+require_rolldown_runtime.__export(sql_db_exports, {
+	DEFAULT_SQL_DATABASE_PROMPT: () => require_sql_db_prompt.DEFAULT_SQL_DATABASE_PROMPT,
+	SQL_MSSQL_PROMPT: () => require_sql_db_prompt.SQL_MSSQL_PROMPT,
+	SQL_MYSQL_PROMPT: () => require_sql_db_prompt.SQL_MYSQL_PROMPT,
+	SQL_POSTGRES_PROMPT: () => require_sql_db_prompt.SQL_POSTGRES_PROMPT,
+	SQL_PROMPTS_MAP: () => require_sql_db_prompt.SQL_PROMPTS_MAP,
+	SQL_SAP_HANA_PROMPT: () => require_sql_db_prompt.SQL_SAP_HANA_PROMPT,
+	SQL_SQLITE_PROMPT: () => require_sql_db_prompt.SQL_SQLITE_PROMPT,
+	SqlDatabaseChain: () => require_sql_db_chain.SqlDatabaseChain,
+	createSqlQueryChain: () => require_sql_db_chain.createSqlQueryChain
+});
+
+//#endregion
+exports.DEFAULT_SQL_DATABASE_PROMPT = require_sql_db_prompt.DEFAULT_SQL_DATABASE_PROMPT;
+exports.SQL_MSSQL_PROMPT = require_sql_db_prompt.SQL_MSSQL_PROMPT;
+exports.SQL_MYSQL_PROMPT = require_sql_db_prompt.SQL_MYSQL_PROMPT;
+exports.SQL_POSTGRES_PROMPT = require_sql_db_prompt.SQL_POSTGRES_PROMPT;
+exports.SQL_PROMPTS_MAP = require_sql_db_prompt.SQL_PROMPTS_MAP;
+exports.SQL_SAP_HANA_PROMPT = require_sql_db_prompt.SQL_SAP_HANA_PROMPT;
+exports.SQL_SQLITE_PROMPT = require_sql_db_prompt.SQL_SQLITE_PROMPT;
+exports.SqlDatabaseChain = require_sql_db_chain.SqlDatabaseChain;
+exports.createSqlQueryChain = require_sql_db_chain.createSqlQueryChain;
+Object.defineProperty(exports, 'sql_db_exports', {
+  enumerable: true,
+  get: function () {
+    return sql_db_exports;
+  }
+});
+//# sourceMappingURL=index.cjs.map

package/dist/chains/sql_db/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":[],"sources":["../../../src/chains/sql_db/index.ts"],"sourcesContent":["export {\n  SqlDatabaseChain,\n  type SqlDatabaseChainInput,\n  type CreateSqlQueryChainFields,\n  createSqlQueryChain,\n} from \"./sql_db_chain.js\";\nexport {\n  DEFAULT_SQL_DATABASE_PROMPT,\n  SQL_POSTGRES_PROMPT,\n  SQL_SQLITE_PROMPT,\n  SQL_MSSQL_PROMPT,\n  SQL_MYSQL_PROMPT,\n  SQL_SAP_HANA_PROMPT,\n  SQL_PROMPTS_MAP,\n} from \"./sql_db_prompt.js\";\n"],"mappings":""}

package/dist/chains/sql_db/index.d.cts

@@ -0,0 +1,3 @@
+import { DEFAULT_SQL_DATABASE_PROMPT, SQL_MSSQL_PROMPT, SQL_MYSQL_PROMPT, SQL_POSTGRES_PROMPT, SQL_PROMPTS_MAP, SQL_SAP_HANA_PROMPT, SQL_SQLITE_PROMPT } from "./sql_db_prompt.cjs";
+import { CreateSqlQueryChainFields, SqlDatabaseChain, SqlDatabaseChainInput, createSqlQueryChain } from "./sql_db_chain.cjs";
+export { type CreateSqlQueryChainFields, DEFAULT_SQL_DATABASE_PROMPT, SQL_MSSQL_PROMPT, SQL_MYSQL_PROMPT, SQL_POSTGRES_PROMPT, SQL_PROMPTS_MAP, SQL_SAP_HANA_PROMPT, SQL_SQLITE_PROMPT, SqlDatabaseChain, type SqlDatabaseChainInput, createSqlQueryChain };

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

@@ -0,0 +1,3 @@
+import { DEFAULT_SQL_DATABASE_PROMPT, SQL_MSSQL_PROMPT, SQL_MYSQL_PROMPT, SQL_POSTGRES_PROMPT, SQL_PROMPTS_MAP, SQL_SAP_HANA_PROMPT, SQL_SQLITE_PROMPT } from "./sql_db_prompt.js";
+import { CreateSqlQueryChainFields, SqlDatabaseChain, SqlDatabaseChainInput, createSqlQueryChain } from "./sql_db_chain.js";
+export { type CreateSqlQueryChainFields, DEFAULT_SQL_DATABASE_PROMPT, SQL_MSSQL_PROMPT, SQL_MYSQL_PROMPT, SQL_POSTGRES_PROMPT, SQL_PROMPTS_MAP, SQL_SAP_HANA_PROMPT, SQL_SQLITE_PROMPT, SqlDatabaseChain, type SqlDatabaseChainInput, createSqlQueryChain };

package/dist/chains/sql_db/index.js

@@ -0,0 +1,21 @@
+import { __export } from "../../_virtual/rolldown_runtime.js";
+import { DEFAULT_SQL_DATABASE_PROMPT, SQL_MSSQL_PROMPT, SQL_MYSQL_PROMPT, SQL_POSTGRES_PROMPT, SQL_PROMPTS_MAP, SQL_SAP_HANA_PROMPT, SQL_SQLITE_PROMPT } from "./sql_db_prompt.js";
+import { SqlDatabaseChain, createSqlQueryChain } from "./sql_db_chain.js";
+
+//#region src/chains/sql_db/index.ts
+var sql_db_exports = {};
+__export(sql_db_exports, {
+	DEFAULT_SQL_DATABASE_PROMPT: () => DEFAULT_SQL_DATABASE_PROMPT,
+	SQL_MSSQL_PROMPT: () => SQL_MSSQL_PROMPT,
+	SQL_MYSQL_PROMPT: () => SQL_MYSQL_PROMPT,
+	SQL_POSTGRES_PROMPT: () => SQL_POSTGRES_PROMPT,
+	SQL_PROMPTS_MAP: () => SQL_PROMPTS_MAP,
+	SQL_SAP_HANA_PROMPT: () => SQL_SAP_HANA_PROMPT,
+	SQL_SQLITE_PROMPT: () => SQL_SQLITE_PROMPT,
+	SqlDatabaseChain: () => SqlDatabaseChain,
+	createSqlQueryChain: () => createSqlQueryChain
+});
+
+//#endregion
+export { DEFAULT_SQL_DATABASE_PROMPT, SQL_MSSQL_PROMPT, SQL_MYSQL_PROMPT, SQL_POSTGRES_PROMPT, SQL_PROMPTS_MAP, SQL_SAP_HANA_PROMPT, SQL_SQLITE_PROMPT, SqlDatabaseChain, createSqlQueryChain, sql_db_exports };
+//# sourceMappingURL=index.js.map

package/dist/chains/sql_db/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../../src/chains/sql_db/index.ts"],"sourcesContent":["export {\n  SqlDatabaseChain,\n  type SqlDatabaseChainInput,\n  type CreateSqlQueryChainFields,\n  createSqlQueryChain,\n} from \"./sql_db_chain.js\";\nexport {\n  DEFAULT_SQL_DATABASE_PROMPT,\n  SQL_POSTGRES_PROMPT,\n  SQL_SQLITE_PROMPT,\n  SQL_MSSQL_PROMPT,\n  SQL_MYSQL_PROMPT,\n  SQL_SAP_HANA_PROMPT,\n  SQL_PROMPTS_MAP,\n} from \"./sql_db_prompt.js\";\n"],"mappings":""}

package/dist/chains/sql_db/sql_db_chain.cjs

@@ -0,0 +1,196 @@
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_sql_db_prompt = require('./sql_db_prompt.cjs');
+const require_sql_utils = require('../../util/sql_utils.cjs');
+const require_base = require('../base.cjs');
+const require_llm_chain = require('../llm_chain.cjs');
+const __langchain_core_runnables = require_rolldown_runtime.__toESM(require("@langchain/core/runnables"));
+const __langchain_core_language_models_base = require_rolldown_runtime.__toESM(require("@langchain/core/language_models/base"));
+const __langchain_core_output_parsers = require_rolldown_runtime.__toESM(require("@langchain/core/output_parsers"));
+
+//#region src/chains/sql_db/sql_db_chain.ts
+/**
+* Class that represents a SQL database chain in the LangChain framework.
+* It extends the BaseChain class and implements the functionality
+* specific to a SQL database chain.
+*
+* @security **Security Notice**
+* This chain generates SQL queries for the given database.
+* The SQLDatabase class provides a getTableInfo method that can be used
+* to get column information as well as sample data from the table.
+* To mitigate risk of leaking sensitive data, limit permissions
+* to read and scope to the tables that are needed.
+* Optionally, use the includesTables or ignoreTables class parameters
+* to limit which tables can/cannot be accessed.
+*
+* @link See https://js.langchain.com/docs/security for more information.
+* @example
+* ```typescript
+* const chain = new SqlDatabaseChain({
+*   llm: new OpenAI({ temperature: 0 }),
+*   database: new SqlDatabase({ ...config }),
+* });
+*
+* const result = await chain.run("How many tracks are there?");
+* ```
+*/
+var SqlDatabaseChain = class extends require_base.BaseChain {
+	static lc_name() {
+		return "SqlDatabaseChain";
+	}
+	llm;
+	database;
+	prompt = require_sql_db_prompt.DEFAULT_SQL_DATABASE_PROMPT;
+	topK = 5;
+	inputKey = "query";
+	outputKey = "result";
+	sqlOutputKey = void 0;
+	returnDirect = false;
+	constructor(fields) {
+		super(fields);
+		this.llm = fields.llm;
+		this.database = fields.database;
+		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 ?? require_sql_utils.getPromptTemplateFromDataSource(this.database.appDataSource);
+	}
+	/** @ignore */
+	async _call(values, runManager) {
+		const llmChain = new require_llm_chain.LLMChain({
+			prompt: this.prompt,
+			llm: this.llm,
+			outputKey: this.outputKey,
+			memory: this.memory
+		});
+		if (!(this.inputKey in values)) throw new Error(`Question key ${this.inputKey} not found.`);
+		const question = values[this.inputKey];
+		let inputText = `${question}\nSQLQuery:`;
+		const tablesToUse = values.table_names_to_use;
+		const tableInfo = await this.database.getTableInfo(tablesToUse);
+		const llmInputs = {
+			input: inputText,
+			top_k: this.topK,
+			dialect: this.database.appDataSourceOptions.type,
+			table_info: tableInfo,
+			stop: ["\nSQLResult:"]
+		};
+		await this.verifyNumberOfTokens(inputText, tableInfo);
+		const sqlCommand = await llmChain.predict(llmInputs, runManager?.getChild("sql_generation"));
+		let queryResult = "";
+		try {
+			queryResult = await this.database.appDataSource.query(sqlCommand);
+		} catch (error) {
+			console.error(error);
+		}
+		let finalResult;
+		if (this.returnDirect) finalResult = { [this.outputKey]: queryResult };
+		else {
+			inputText += `${sqlCommand}\nSQLResult: ${JSON.stringify(queryResult)}\nAnswer:`;
+			llmInputs.input = inputText;
+			finalResult = { [this.outputKey]: await llmChain.predict(llmInputs, runManager?.getChild("result_generation")) };
+		}
+		if (this.sqlOutputKey != null) finalResult[this.sqlOutputKey] = sqlCommand;
+		return finalResult;
+	}
+	_chainType() {
+		return "sql_database_chain";
+	}
+	get inputKeys() {
+		return [this.inputKey];
+	}
+	get outputKeys() {
+		if (this.sqlOutputKey != null) return [this.outputKey, this.sqlOutputKey];
+		return [this.outputKey];
+	}
+	/**
+	* Private method that verifies the number of tokens in the input text and
+	* table information. It throws an error if the number of tokens exceeds
+	* the maximum allowed by the language model.
+	* @param inputText The input text.
+	* @param tableinfo The table information.
+	* @returns A promise that resolves when the verification is complete.
+	*/
+	async verifyNumberOfTokens(inputText, tableinfo) {
+		if (this.llm._llmType() !== "openai") return;
+		const llm = this.llm;
+		const promptTemplate = this.prompt.template;
+		const stringWeSend = `${inputText}${promptTemplate}${tableinfo}`;
+		const maxToken = await (0, __langchain_core_language_models_base.calculateMaxTokens)({
+			prompt: stringWeSend,
+			modelName: llm.model
+		});
+		if (maxToken < (llm.maxTokens ?? -1)) throw new Error(`The combination of the database structure and your question is too big for the model ${llm.model} which can compute only a max tokens of ${(0, __langchain_core_language_models_base.getModelContextSize)(llm.model)}.
+      We suggest you to use the includeTables parameters when creating the SqlDatabase object to select only a subset of the tables. You can also use a model which can handle more tokens.`);
+	}
+};
+const strip = (text) => {
+	let newText = text.replace(/\\"/g, "\"").trim();
+	if (newText.startsWith("\"") && newText.endsWith("\"")) newText = newText.substring(1, newText.length - 1);
+	return newText;
+};
+const difference = (setA, setB) => new Set([...setA].filter((x) => !setB.has(x)));
+/**
+* Create a SQL query chain that can create SQL queries for the given database.
+* Returns a Runnable.
+*
+* @param {BaseLanguageModel} llm The language model to use in the chain.
+* @param {SqlDatabase} db The database to use in the chain.
+* @param {BasePromptTemplate | undefined} prompt The prompt to use in the chain.
+* @param {BaseLanguageModel | undefined} k The amount of docs/results to return. Passed through the prompt input value `top_k`.
+* @param {SqlDialect} dialect The SQL dialect to use in the chain.
+* @returns {Promise<RunnableSequence<Record<string, unknown>, string>>} A runnable sequence representing the chain.
+* @example ```typescript
+* const datasource = new DataSource({
+*   type: "sqlite",
+*   database: "../../../../Chinook.db",
+* });
+* const db = await SqlDatabase.fromDataSourceParams({
+*   appDataSource: datasource,
+* });
+* const llm = new ChatOpenAI({ model: "gpt-4o-mini", temperature: 0 });
+* const chain = await createSqlQueryChain({
+*   llm,
+*   db,
+*   dialect: "sqlite",
+* });
+* ```
+*/
+async function createSqlQueryChain({ llm, db, prompt, k = 5, dialect }) {
+	let promptToUse;
+	if (prompt) promptToUse = prompt;
+	else if (require_sql_db_prompt.SQL_PROMPTS_MAP[dialect]) promptToUse = require_sql_db_prompt.SQL_PROMPTS_MAP[dialect];
+	else promptToUse = require_sql_db_prompt.DEFAULT_SQL_DATABASE_PROMPT;
+	if (difference(new Set([
+		"input",
+		"top_k",
+		"table_info"
+	]), new Set(promptToUse.inputVariables)).size > 0) throw new Error(`Prompt must have input variables: 'input', 'top_k', 'table_info'. Received prompt with input variables: ${promptToUse.inputVariables}. Full prompt:\n\n${promptToUse}`);
+	if (promptToUse.inputVariables.includes("dialect")) promptToUse = await promptToUse.partial({ dialect });
+	promptToUse = await promptToUse.partial({ top_k: k.toString() });
+	const inputs = {
+		input: (x) => {
+			if ("question" in x) return `${x.question}\nSQLQuery: `;
+			throw new Error("Input must include a question property.");
+		},
+		table_info: async (x) => db.getTableInfo(x.tableNamesToUse)
+	};
+	return __langchain_core_runnables.RunnableSequence.from([
+		__langchain_core_runnables.RunnablePassthrough.assign(inputs),
+		(x) => {
+			const newInputs = { ...x };
+			delete newInputs.question;
+			delete newInputs.tableNamesToUse;
+			return newInputs;
+		},
+		promptToUse,
+		llm.withConfig({ stop: ["\nSQLResult:"] }),
+		new __langchain_core_output_parsers.StringOutputParser(),
+		strip
+	]);
+}
+
+//#endregion
+exports.SqlDatabaseChain = SqlDatabaseChain;
+exports.createSqlQueryChain = createSqlQueryChain;
+//# sourceMappingURL=sql_db_chain.cjs.map

package/dist/chains/sql_db/sql_db_chain.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql_db_chain.cjs","names":["BaseChain","DEFAULT_SQL_DATABASE_PROMPT","fields: SqlDatabaseChainInput","getPromptTemplateFromDataSource","values: ChainValues","runManager?: CallbackManagerForChainRun","LLMChain","question: string","inputText: string","tableinfo: string","text: string","setA: Set<string>","setB: Set<string>","promptToUse: BasePromptTemplate","SQL_PROMPTS_MAP","x: Record<string, unknown>","RunnableSequence","RunnablePassthrough","StringOutputParser"],"sources":["../../../src/chains/sql_db/sql_db_chain.ts"],"sourcesContent":["import type {\n  BaseLanguageModel,\n  BaseLanguageModelInterface,\n} from \"@langchain/core/language_models/base\";\nimport type { OpenAI, TiktokenModel } from \"@langchain/openai\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { BasePromptTemplate, PromptTemplate } from \"@langchain/core/prompts\";\nimport {\n  calculateMaxTokens,\n  getModelContextSize,\n} from \"@langchain/core/language_models/base\";\nimport { CallbackManagerForChainRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  RunnablePassthrough,\n  RunnableSequence,\n} from \"@langchain/core/runnables\";\nimport { StringOutputParser } from \"@langchain/core/output_parsers\";\nimport {\n  DEFAULT_SQL_DATABASE_PROMPT,\n  SQL_PROMPTS_MAP,\n  SqlDialect,\n} from \"./sql_db_prompt.js\";\nimport { BaseChain, ChainInputs } from \"../base.js\";\nimport { LLMChain } from \"../llm_chain.js\";\nimport type { SqlDatabase } from \"../../sql_db.js\";\nimport { getPromptTemplateFromDataSource } from \"../../util/sql_utils.js\";\n\n/**\n * Interface that extends the ChainInputs interface and defines additional\n * fields specific to a SQL database chain. It represents the input fields\n * for a SQL database chain.\n */\nexport interface SqlDatabaseChainInput extends ChainInputs {\n  llm: BaseLanguageModelInterface;\n  database: SqlDatabase;\n  topK?: number;\n  inputKey?: string;\n  outputKey?: string;\n  sqlOutputKey?: string;\n  prompt?: PromptTemplate;\n}\n\n/**\n * Class that represents a SQL database chain in the LangChain framework.\n * It extends the BaseChain class and implements the functionality\n * specific to a SQL database chain.\n *\n * @security **Security Notice**\n * This chain generates SQL queries for the given database.\n * The SQLDatabase class provides a getTableInfo method that can be used\n * to get column information as well as sample data from the table.\n * To mitigate risk of leaking sensitive data, limit permissions\n * to read and scope to the tables that are needed.\n * Optionally, use the includesTables or ignoreTables class parameters\n * to limit which tables can/cannot be accessed.\n *\n * @link See https://js.langchain.com/docs/security for more information.\n * @example\n * ```typescript\n * const chain = new SqlDatabaseChain({\n *   llm: new OpenAI({ temperature: 0 }),\n *   database: new SqlDatabase({ ...config }),\n * });\n *\n * const result = await chain.run(\"How many tracks are there?\");\n * ```\n */\nexport class SqlDatabaseChain extends BaseChain {\n  static lc_name() {\n    return \"SqlDatabaseChain\";\n  }\n\n  // LLM wrapper to use\n  llm: BaseLanguageModelInterface;\n\n  // SQL Database to connect to.\n  database: SqlDatabase;\n\n  // Prompt to use to translate natural language to SQL.\n  prompt = DEFAULT_SQL_DATABASE_PROMPT;\n\n  // Number of results to return from the query\n  topK = 5;\n\n  inputKey = \"query\";\n\n  outputKey = \"result\";\n\n  sqlOutputKey: string | undefined = undefined;\n\n  // Whether to return the result of querying the SQL table directly.\n  returnDirect = false;\n\n  constructor(fields: SqlDatabaseChainInput) {\n    super(fields);\n    this.llm = fields.llm;\n    this.database = fields.database;\n    this.topK = fields.topK ?? this.topK;\n    this.inputKey = fields.inputKey ?? this.inputKey;\n    this.outputKey = fields.outputKey ?? this.outputKey;\n    this.sqlOutputKey = fields.sqlOutputKey ?? this.sqlOutputKey;\n    this.prompt =\n      fields.prompt ??\n      getPromptTemplateFromDataSource(this.database.appDataSource);\n  }\n\n  /** @ignore */\n  async _call(\n    values: ChainValues,\n    runManager?: CallbackManagerForChainRun\n  ): Promise<ChainValues> {\n    const llmChain = new LLMChain({\n      prompt: this.prompt,\n      llm: this.llm,\n      outputKey: this.outputKey,\n      memory: this.memory,\n    });\n    if (!(this.inputKey in values)) {\n      throw new Error(`Question key ${this.inputKey} not found.`);\n    }\n    const question: string = values[this.inputKey];\n    let inputText = `${question}\\nSQLQuery:`;\n    const tablesToUse = values.table_names_to_use;\n    const tableInfo = await this.database.getTableInfo(tablesToUse);\n\n    const llmInputs = {\n      input: inputText,\n      top_k: this.topK,\n      dialect: this.database.appDataSourceOptions.type,\n      table_info: tableInfo,\n      stop: [\"\\nSQLResult:\"],\n    };\n    await this.verifyNumberOfTokens(inputText, tableInfo);\n\n    const sqlCommand = await llmChain.predict(\n      llmInputs,\n      runManager?.getChild(\"sql_generation\")\n    );\n    let queryResult = \"\";\n    try {\n      queryResult = await this.database.appDataSource.query(sqlCommand);\n    } catch (error) {\n      console.error(error);\n    }\n\n    let finalResult;\n    if (this.returnDirect) {\n      finalResult = { [this.outputKey]: queryResult };\n    } else {\n      inputText += `${sqlCommand}\\nSQLResult: ${JSON.stringify(\n        queryResult\n      )}\\nAnswer:`;\n      llmInputs.input = inputText;\n      finalResult = {\n        [this.outputKey]: await llmChain.predict(\n          llmInputs,\n          runManager?.getChild(\"result_generation\")\n        ),\n      };\n    }\n\n    if (this.sqlOutputKey != null) {\n      finalResult[this.sqlOutputKey] = sqlCommand;\n    }\n\n    return finalResult;\n  }\n\n  _chainType() {\n    return \"sql_database_chain\" as const;\n  }\n\n  get inputKeys(): string[] {\n    return [this.inputKey];\n  }\n\n  get outputKeys(): string[] {\n    if (this.sqlOutputKey != null) {\n      return [this.outputKey, this.sqlOutputKey];\n    }\n    return [this.outputKey];\n  }\n\n  /**\n   * Private method that verifies the number of tokens in the input text and\n   * table information. It throws an error if the number of tokens exceeds\n   * the maximum allowed by the language model.\n   * @param inputText The input text.\n   * @param tableinfo The table information.\n   * @returns A promise that resolves when the verification is complete.\n   */\n  private async verifyNumberOfTokens(\n    inputText: string,\n    tableinfo: string\n  ): Promise<void> {\n    // We verify it only for OpenAI for the moment\n    if (this.llm._llmType() !== \"openai\") {\n      return;\n    }\n    const llm = this.llm as OpenAI;\n    const promptTemplate = this.prompt.template;\n    const stringWeSend = `${inputText}${promptTemplate}${tableinfo}`;\n\n    const maxToken = await calculateMaxTokens({\n      prompt: stringWeSend,\n      // Cast here to allow for other models that may not fit the union\n      modelName: llm.model as TiktokenModel,\n    });\n\n    if (maxToken < (llm.maxTokens ?? -1)) {\n      throw new Error(`The combination of the database structure and your question is too big for the model ${\n        llm.model\n      } which can compute only a max tokens of ${getModelContextSize(\n        llm.model\n      )}.\n      We suggest you to use the includeTables parameters when creating the SqlDatabase object to select only a subset of the tables. You can also use a model which can handle more tokens.`);\n    }\n  }\n}\n\nexport interface CreateSqlQueryChainFields {\n  llm: BaseLanguageModel;\n  db: SqlDatabase;\n  prompt?: BasePromptTemplate;\n  /**\n   * @default 5\n   */\n  k?: number;\n  dialect: SqlDialect;\n}\n\ntype SqlInput = {\n  question: string;\n};\n\ntype SqlInoutWithTables = SqlInput & {\n  tableNamesToUse: string[];\n};\n\nconst strip = (text: string) => {\n  // Replace escaped quotes with actual quotes\n  let newText = text.replace(/\\\\\"/g, '\"').trim();\n  // Remove wrapping quotes if the entire string is wrapped in quotes\n  if (newText.startsWith('\"') && newText.endsWith('\"')) {\n    newText = newText.substring(1, newText.length - 1);\n  }\n  return newText;\n};\n\nconst difference = (setA: Set<string>, setB: Set<string>) =>\n  new Set([...setA].filter((x) => !setB.has(x)));\n\n/**\n * Create a SQL query chain that can create SQL queries for the given database.\n * Returns a Runnable.\n *\n * @param {BaseLanguageModel} llm The language model to use in the chain.\n * @param {SqlDatabase} db The database to use in the chain.\n * @param {BasePromptTemplate | undefined} prompt The prompt to use in the chain.\n * @param {BaseLanguageModel | undefined} k The amount of docs/results to return. Passed through the prompt input value `top_k`.\n * @param {SqlDialect} dialect The SQL dialect to use in the chain.\n * @returns {Promise<RunnableSequence<Record<string, unknown>, string>>} A runnable sequence representing the chain.\n * @example ```typescript\n * const datasource = new DataSource({\n *   type: \"sqlite\",\n *   database: \"../../../../Chinook.db\",\n * });\n * const db = await SqlDatabase.fromDataSourceParams({\n *   appDataSource: datasource,\n * });\n * const llm = new ChatOpenAI({ model: \"gpt-4o-mini\", temperature: 0 });\n * const chain = await createSqlQueryChain({\n *   llm,\n *   db,\n *   dialect: \"sqlite\",\n * });\n * ```\n */\nexport async function createSqlQueryChain({\n  llm,\n  db,\n  prompt,\n  k = 5,\n  dialect,\n}: CreateSqlQueryChainFields) {\n  let promptToUse: BasePromptTemplate;\n  if (prompt) {\n    promptToUse = prompt;\n  } else if (SQL_PROMPTS_MAP[dialect]) {\n    promptToUse = SQL_PROMPTS_MAP[dialect];\n  } else {\n    promptToUse = DEFAULT_SQL_DATABASE_PROMPT;\n  }\n\n  if (\n    difference(\n      new Set([\"input\", \"top_k\", \"table_info\"]),\n      new Set(promptToUse.inputVariables)\n    ).size > 0\n  ) {\n    throw new Error(\n      `Prompt must have input variables: 'input', 'top_k', 'table_info'. Received prompt with input variables: ` +\n        `${promptToUse.inputVariables}. Full prompt:\\n\\n${promptToUse}`\n    );\n  }\n  if (promptToUse.inputVariables.includes(\"dialect\")) {\n    promptToUse = await promptToUse.partial({ dialect });\n  }\n\n  promptToUse = await promptToUse.partial({ top_k: k.toString() });\n\n  const inputs = {\n    input: (x: Record<string, unknown>) => {\n      if (\"question\" in x) {\n        return `${(x as SqlInput).question}\\nSQLQuery: `;\n      }\n      throw new Error(\"Input must include a question property.\");\n    },\n    table_info: async (x: Record<string, unknown>) =>\n      db.getTableInfo((x as SqlInoutWithTables).tableNamesToUse),\n  };\n\n  return RunnableSequence.from([\n    RunnablePassthrough.assign(inputs),\n    (x) => {\n      const newInputs = { ...x };\n      delete newInputs.question;\n      delete newInputs.tableNamesToUse;\n      return newInputs;\n    },\n    promptToUse,\n    llm.withConfig({ stop: [\"\\nSQLResult:\"] }),\n    new StringOutputParser(),\n    strip,\n  ]);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmEA,IAAa,mBAAb,cAAsCA,uBAAU;CAC9C,OAAO,UAAU;AACf,SAAO;CACR;CAGD;CAGA;CAGA,SAASC;CAGT,OAAO;CAEP,WAAW;CAEX,YAAY;CAEZ,eAAmC;CAGnC,eAAe;CAEf,YAAYC,QAA+B;EACzC,MAAM,OAAO;EACb,KAAK,MAAM,OAAO;EAClB,KAAK,WAAW,OAAO;EACvB,KAAK,OAAO,OAAO,QAAQ,KAAK;EAChC,KAAK,WAAW,OAAO,YAAY,KAAK;EACxC,KAAK,YAAY,OAAO,aAAa,KAAK;EAC1C,KAAK,eAAe,OAAO,gBAAgB,KAAK;EAChD,KAAK,SACH,OAAO,UACPC,kDAAgC,KAAK,SAAS,cAAc;CAC/D;;CAGD,MAAM,MACJC,QACAC,YACsB;EACtB,MAAM,WAAW,IAAIC,2BAAS;GAC5B,QAAQ,KAAK;GACb,KAAK,KAAK;GACV,WAAW,KAAK;GAChB,QAAQ,KAAK;EACd;AACD,MAAI,EAAE,KAAK,YAAY,QACrB,OAAM,IAAI,MAAM,CAAC,aAAa,EAAE,KAAK,SAAS,WAAW,CAAC;EAE5D,MAAMC,WAAmB,OAAO,KAAK;EACrC,IAAI,YAAY,GAAG,SAAS,WAAW,CAAC;EACxC,MAAM,cAAc,OAAO;EAC3B,MAAM,YAAY,MAAM,KAAK,SAAS,aAAa,YAAY;EAE/D,MAAM,YAAY;GAChB,OAAO;GACP,OAAO,KAAK;GACZ,SAAS,KAAK,SAAS,qBAAqB;GAC5C,YAAY;GACZ,MAAM,CAAC,cAAe;EACvB;EACD,MAAM,KAAK,qBAAqB,WAAW,UAAU;EAErD,MAAM,aAAa,MAAM,SAAS,QAChC,WACA,YAAY,SAAS,iBAAiB,CACvC;EACD,IAAI,cAAc;AAClB,MAAI;GACF,cAAc,MAAM,KAAK,SAAS,cAAc,MAAM,WAAW;EAClE,SAAQ,OAAO;GACd,QAAQ,MAAM,MAAM;EACrB;EAED,IAAI;AACJ,MAAI,KAAK,cACP,cAAc,GAAG,KAAK,YAAY,YAAa;OAC1C;GACL,aAAa,GAAG,WAAW,aAAa,EAAE,KAAK,UAC7C,YACD,CAAC,SAAS,CAAC;GACZ,UAAU,QAAQ;GAClB,cAAc,GACX,KAAK,YAAY,MAAM,SAAS,QAC/B,WACA,YAAY,SAAS,oBAAoB,CAC1C,CACF;EACF;AAED,MAAI,KAAK,gBAAgB,MACvB,YAAY,KAAK,gBAAgB;AAGnC,SAAO;CACR;CAED,aAAa;AACX,SAAO;CACR;CAED,IAAI,YAAsB;AACxB,SAAO,CAAC,KAAK,QAAS;CACvB;CAED,IAAI,aAAuB;AACzB,MAAI,KAAK,gBAAgB,KACvB,QAAO,CAAC,KAAK,WAAW,KAAK,YAAa;AAE5C,SAAO,CAAC,KAAK,SAAU;CACxB;;;;;;;;;CAUD,MAAc,qBACZC,WACAC,WACe;AAEf,MAAI,KAAK,IAAI,UAAU,KAAK,SAC1B;EAEF,MAAM,MAAM,KAAK;EACjB,MAAM,iBAAiB,KAAK,OAAO;EACnC,MAAM,eAAe,GAAG,YAAY,iBAAiB,WAAW;EAEhE,MAAM,WAAW,oEAAyB;GACxC,QAAQ;GAER,WAAW,IAAI;EAChB,EAAC;AAEF,MAAI,YAAY,IAAI,aAAa,IAC/B,OAAM,IAAI,MAAM,CAAC,qFAAqF,EACpG,IAAI,MACL,wCAAwC,iEACvC,IAAI,MACL,CAAC;2LACmL,CAAC;CAEzL;AACF;AAqBD,MAAM,QAAQ,CAACC,SAAiB;CAE9B,IAAI,UAAU,KAAK,QAAQ,QAAQ,KAAI,CAAC,MAAM;AAE9C,KAAI,QAAQ,WAAW,KAAI,IAAI,QAAQ,SAAS,KAAI,EAClD,UAAU,QAAQ,UAAU,GAAG,QAAQ,SAAS,EAAE;AAEpD,QAAO;AACR;AAED,MAAM,aAAa,CAACC,MAAmBC,SACrC,IAAI,IAAI,CAAC,GAAG,IAAK,EAAC,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4B/C,eAAsB,oBAAoB,EACxC,KACA,IACA,QACA,IAAI,GACJ,SAC0B,EAAE;CAC5B,IAAIC;AACJ,KAAI,QACF,cAAc;UACLC,sCAAgB,UACzB,cAAcA,sCAAgB;MAE9B,cAAcb;AAGhB,KACE,WACE,IAAI,IAAI;EAAC;EAAS;EAAS;CAAa,IACxC,IAAI,IAAI,YAAY,gBACrB,CAAC,OAAO,EAET,OAAM,IAAI,MACR,CAAC,wGAAwG,EACpG,YAAY,eAAe,kBAAkB,EAAE,aAAa;AAGrE,KAAI,YAAY,eAAe,SAAS,UAAU,EAChD,cAAc,MAAM,YAAY,QAAQ,EAAE,QAAS,EAAC;CAGtD,cAAc,MAAM,YAAY,QAAQ,EAAE,OAAO,EAAE,UAAU,CAAE,EAAC;CAEhE,MAAM,SAAS;EACb,OAAO,CAACc,MAA+B;AACrC,OAAI,cAAc,EAChB,QAAO,GAAI,EAAe,SAAS,YAAY,CAAC;AAElD,SAAM,IAAI,MAAM;EACjB;EACD,YAAY,OAAOA,MACjB,GAAG,aAAc,EAAyB,gBAAgB;CAC7D;AAED,QAAOC,4CAAiB,KAAK;EAC3BC,+CAAoB,OAAO,OAAO;EAClC,CAAC,MAAM;GACL,MAAM,YAAY,EAAE,GAAG,EAAG;GAC1B,OAAO,UAAU;GACjB,OAAO,UAAU;AACjB,UAAO;EACR;EACD;EACA,IAAI,WAAW,EAAE,MAAM,CAAC,cAAe,EAAE,EAAC;EAC1C,IAAIC;EACJ;CACD,EAAC;AACH"}