Refactors entrypoints to remove hidden typeorm peer dep

docs/docs/modules/agents/toolkits/sql.mdx

@@ -6,6 +6,16 @@ hide_table_of_contents: true
 
 This example shows how to load and use an agent with a SQL toolkit.
 
+## Setup
+
+You'll need to first install `typeorm`:
+
+```bash npm2yarn
+npm install typeorm
+```
+
+## Usage
+
 import CodeBlock from "@theme/CodeBlock";
 import Example from "@examples/agents/sql.ts";
 

docs/docs/modules/agents/tools/integrations/index.mdx

@@ -19,7 +19,7 @@ LangChain provides the following tools you can use out of the box:
 - [`JsonListKeysTool`][JsonListKeysTool] and [`JsonGetValueTool`][JsonGetValueTool] - Useful for extracting data from JSON objects. These tools can be used collectively in a [`JsonToolkit`][JsonToolkit].
 - [`RequestsGetTool`][RequestsGetTool] and [`RequestsPostTool`][RequestsPostTool] - Useful for making HTTP requests.
 - [`SerpAPI`][SerpAPI] - A wrapper around the SerpAPI API. Useful for when you need to answer questions about current events. Input should be a search query.
-- [`QuerySqlTool`][QuerySqlTool], [`InfoSqlTool`][InfoSqlTool], [`ListTablesSqlTool`][ListTablesSqlTool], and [`QueryCheckerTool`][QueryCheckerTool] - Useful for interacting with SQL databases. Can be used together in a [`SqlToolkit`][SqlToolkit].
+- [`QuerySqlTool`][QuerySqlTool], [`InfoSqlTool`][InfoSqlTool], [`ListTablesSqlTool`][ListTablesSqlTool], and [`QueryCheckerTool`][QueryCheckerTool] - Useful for interacting with SQL databases. Can be used together in a [`SqlToolkit`][SqlToolkit]. Requires `typeorm` as a peer dependency.
 - [`VectorStoreQATool`][VectorStoreQATool] - Useful for retrieving relevant text data from a vector store.
 - [`ZapierNLARunAction`][ZapierNLARunAction] - A wrapper around the Zapier NLP API. Useful for triggering Zapier actions with a natural language input. Best when used in a [`ZapierToolkit`][ZapierToolkit].
 
@@ -35,10 +35,10 @@ LangChain provides the following tools you can use out of the box:
 [RequestsGetTool]: /docs/api/tools/classes/RequestsGetTool
 [RequestsPostTool]: /docs/api/tools/classes/RequestsPostTool
 [SerpAPI]: /docs/api/tools/classes/SerpAPI
-[QuerySqlTool]: /docs/api/tools/classes/QuerySqlTool
-[InfoSqlTool]: /docs/api/tools/classes/InfoSqlTool
-[ListTablesSqlTool]: /docs/api/tools/classes/ListTablesSqlTool
-[QueryCheckerTool]: /docs/api/tools/classes/QueryCheckerTool
+[QuerySqlTool]: /docs/api/tools_sql/classes/QuerySqlTool
+[InfoSqlTool]: /docs/api/tools_sql/classes/InfoSqlTool
+[ListTablesSqlTool]: /docs/api/tools_sql/classes/ListTablesSqlTool
+[QueryCheckerTool]: /docs/api/tools_sql/classes/QueryCheckerTool
 [SqlToolkit]: ../../toolkits/sql
 [VectorStoreQATool]: /docs/api/tools/classes/VectorStoreQATool
 [ZapierNLARunAction]: /docs/api/tools/classes/ZapierNLARunAction

examples/src/agents/aws_sfn.ts

@@ -2,7 +2,7 @@ import { OpenAI } from "langchain/llms/openai";
 import {
   createAWSSfnAgent,
   AWSSfnToolkit,
-} from "langchain/agents/agent_toolkits/aws_sfn";
+} from "langchain/agents/toolkits/aws_sfn";
 
 const _EXAMPLE_STATE_MACHINE_ASL = `
 {

examples/src/agents/sql.ts

@@ -1,6 +1,6 @@
 import { OpenAI } from "langchain/llms/openai";
 import { SqlDatabase } from "langchain/sql_db";
-import { createSqlAgent, SqlToolkit } from "langchain/agents";
+import { createSqlAgent, SqlToolkit } from "langchain/agents/toolkits/sql";
 import { DataSource } from "typeorm";
 
 /** This example uses Chinook database, which is a sample database available for SQL Server, Oracle, MySQL, etc.

examples/src/chains/sql_db.ts

@@ -1,7 +1,7 @@
 import { DataSource } from "typeorm";
 import { OpenAI } from "langchain/llms/openai";
 import { SqlDatabase } from "langchain/sql_db";
-import { SqlDatabaseChain } from "langchain/chains";
+import { SqlDatabaseChain } from "langchain/chains/sql_db";
 
 /**
  * This example uses Chinook database, which is a sample database available for SQL Server, Oracle, MySQL, etc.

examples/src/chains/sql_db_sql_output.ts

@@ -1,7 +1,7 @@
 import { DataSource } from "typeorm";
 import { OpenAI } from "langchain/llms/openai";
 import { SqlDatabase } from "langchain/sql_db";
-import { SqlDatabaseChain } from "langchain/chains";
+import { SqlDatabaseChain } from "langchain/chains/sql_db";
 
 /**
  * This example uses Chinook database, which is a sample database available for SQL Server, Oracle, MySQL, etc.

langchain/.gitignore

@@ -10,9 +10,12 @@ agents.d.ts
 agents/load.cjs
 agents/load.js
 agents/load.d.ts
-agents/agent_toolkits/aws_sfn.cjs
-agents/agent_toolkits/aws_sfn.js
-agents/agent_toolkits/aws_sfn.d.ts
+agents/toolkits/aws_sfn.cjs
+agents/toolkits/aws_sfn.js
+agents/toolkits/aws_sfn.d.ts
+agents/toolkits/sql.cjs
+agents/toolkits/sql.js
+agents/toolkits/sql.d.ts
 base_language.cjs
 base_language.js
 base_language.d.ts
@@ -28,6 +31,9 @@ tools/aws_sfn.d.ts
 tools/calculator.cjs
 tools/calculator.js
 tools/calculator.d.ts
+tools/sql.cjs
+tools/sql.js
+tools/sql.d.ts
 tools/webbrowser.cjs
 tools/webbrowser.js
 tools/webbrowser.d.ts
@@ -43,6 +49,9 @@ chains/query_constructor.d.ts
 chains/query_constructor/ir.cjs
 chains/query_constructor/ir.js
 chains/query_constructor/ir.d.ts
+chains/sql_db.cjs
+chains/sql_db.js
+chains/sql_db.d.ts
 embeddings.cjs
 embeddings.js
 embeddings.d.ts

langchain/package.json

@@ -22,9 +22,12 @@
     "agents/load.cjs",
     "agents/load.js",
     "agents/load.d.ts",
-    "agents/agent_toolkits/aws_sfn.cjs",
-    "agents/agent_toolkits/aws_sfn.js",
-    "agents/agent_toolkits/aws_sfn.d.ts",
+    "agents/toolkits/aws_sfn.cjs",
+    "agents/toolkits/aws_sfn.js",
+    "agents/toolkits/aws_sfn.d.ts",
+    "agents/toolkits/sql.cjs",
+    "agents/toolkits/sql.js",
+    "agents/toolkits/sql.d.ts",
     "base_language.cjs",
     "base_language.js",
     "base_language.d.ts",
@@ -40,6 +43,9 @@
     "tools/calculator.cjs",
     "tools/calculator.js",
     "tools/calculator.d.ts",
+    "tools/sql.cjs",
+    "tools/sql.js",
+    "tools/sql.d.ts",
     "tools/webbrowser.cjs",
     "tools/webbrowser.js",
     "tools/webbrowser.d.ts",
@@ -55,6 +61,9 @@
     "chains/query_constructor/ir.cjs",
     "chains/query_constructor/ir.js",
     "chains/query_constructor/ir.d.ts",
+    "chains/sql_db.cjs",
+    "chains/sql_db.js",
+    "chains/sql_db.d.ts",
     "embeddings.cjs",
     "embeddings.js",
     "embeddings.d.ts",
@@ -827,10 +836,15 @@
       "import": "./agents/load.js",
       "require": "./agents/load.cjs"
     },
-    "./agents/agent_toolkits/aws_sfn": {
-      "types": "./agents/agent_toolkits/aws_sfn.d.ts",
-      "import": "./agents/agent_toolkits/aws_sfn.js",
-      "require": "./agents/agent_toolkits/aws_sfn.cjs"
+    "./agents/toolkits/aws_sfn": {
+      "types": "./agents/toolkits/aws_sfn.d.ts",
+      "import": "./agents/toolkits/aws_sfn.js",
+      "require": "./agents/toolkits/aws_sfn.cjs"
+    },
+    "./agents/toolkits/sql": {
+      "types": "./agents/toolkits/sql.d.ts",
+      "import": "./agents/toolkits/sql.js",
+      "require": "./agents/toolkits/sql.cjs"
     },
     "./base_language": {
       "types": "./base_language.d.ts",
@@ -857,6 +871,11 @@
       "import": "./tools/calculator.js",
       "require": "./tools/calculator.cjs"
     },
+    "./tools/sql": {
+      "types": "./tools/sql.d.ts",
+      "import": "./tools/sql.js",
+      "require": "./tools/sql.cjs"
+    },
     "./tools/webbrowser": {
       "types": "./tools/webbrowser.d.ts",
       "import": "./tools/webbrowser.js",
@@ -882,6 +901,11 @@
       "import": "./chains/query_constructor/ir.js",
       "require": "./chains/query_constructor/ir.cjs"
     },
+    "./chains/sql_db": {
+      "types": "./chains/sql_db.d.ts",
+      "import": "./chains/sql_db.js",
+      "require": "./chains/sql_db.cjs"
+    },
     "./embeddings": {
       "node": {
         "types": "./embeddings.d.ts",

langchain/scripts/create-entrypoints.js

@@ -13,20 +13,23 @@ const entrypoints = {
   // agents
   agents: "agents/index",
   "agents/load": "agents/load",
-  "agents/agent_toolkits/aws_sfn": "agents/agent_toolkits/aws_sfn",
+  "agents/toolkits/aws_sfn": "agents/toolkits/aws_sfn",
+  "agents/toolkits/sql": "agents/toolkits/sql/index",
   // base language
   base_language: "base_language/index",
   // tools
   tools: "tools/index",
   "tools/aws_lambda": "tools/aws_lambda",
   "tools/aws_sfn": "tools/aws_sfn",
   "tools/calculator": "tools/calculator",
+  "tools/sql": "tools/sql",
   "tools/webbrowser": "tools/webbrowser",
   // chains
   chains: "chains/index",
   "chains/load": "chains/load",
   "chains/query_constructor": "chains/query_constructor/index",
   "chains/query_constructor/ir": "chains/query_constructor/ir",
+  "chains/sql_db": "chains/sql_db/index",
   // embeddings
   embeddings: "embeddings/index",
   "embeddings/base": "embeddings/base",
@@ -190,12 +193,15 @@ const deprecatedNodeOnly = [
 // Therefore they are not tested in the generated test-exports-* packages.
 const requiresOptionalDependency = [
   "agents/load",
-  "agents/agent_toolkits/aws_sfn",
+  "agents/toolkits/aws_sfn",
+  "agents/toolkits/sql",
   "tools/aws_lambda",
   "tools/aws_sfn",
   "tools/calculator",
+  "tools/sql",
   "tools/webbrowser",
   "chains/load",
+  "chains/sql_db",
   "embeddings/cohere",
   "embeddings/googlevertexai",
   "embeddings/tensorflow",

langchain/src/agents/index.ts

@@ -10,19 +10,16 @@ export {
   JsonToolkit,
   OpenApiToolkit,
   RequestsToolkit,
-  SqlToolkit,
   VectorStoreInfo,
   VectorStoreRouterToolkit,
   VectorStoreToolkit,
   ZapierToolKit,
   createJsonAgent,
   createOpenApiAgent,
-  createSqlAgent,
-  SqlCreatePromptArgs,
   createVectorStoreAgent,
   createVectorStoreRouterAgent,
-} from "./agent_toolkits/index.js";
-export { Toolkit } from "./agent_toolkits/base.js";
+} from "./toolkits/index.js";
+export { Toolkit } from "./toolkits/base.js";
 export {
   ChatAgent,
   ChatAgentInput,

langchain/src/agents/tests/aws_sfn.int.test.ts

@@ -5,7 +5,7 @@ import { test } from "@jest/globals";
 import { StartExecutionAWSSfnTool } from "../../tools/aws_sfn.js";
 
 import { OpenAI } from "../../llms/openai.js";
-import { AWSSfnToolkit, createAWSSfnAgent } from "../agent_toolkits/aws_sfn.js";
+import { AWSSfnToolkit, createAWSSfnAgent } from "../toolkits/aws_sfn.js";
 
 test.skip("StartExecutionAWSSfnTool invokes the correct state machine and returns the executionArn", async () => {
   const sfn = new StartExecutionAWSSfnTool({

langchain/src/agents/tests/zapier_toolkit.int.test.ts

@@ -1,5 +1,5 @@
 import { beforeEach, describe, expect, test } from "@jest/globals";
-import { ZapierToolKit } from "../agent_toolkits/zapier/zapier.js";
+import { ZapierToolKit } from "../toolkits/zapier/zapier.js";
 import { ZapierNLAWrapper, ZapierValues } from "../../tools/zapier.js";
 
 describe("ZapierNLAWrapper", () => {

langchain/src/agents/agent_toolkits/index.ts → langchain/src/agents/toolkits/index.ts

@@ -1,5 +1,4 @@
 export { JsonToolkit, createJsonAgent } from "./json/json.js";
-export { SqlToolkit, createSqlAgent, SqlCreatePromptArgs } from "./sql/sql.js";
 export {
   RequestsToolkit,
   OpenApiToolkit,

langchain/src/agents/toolkits/sql/index.ts

@@ -0,0 +1 @@
+export { SqlCreatePromptArgs, SqlToolkit, createSqlAgent } from "./sql.js";

langchain/src/chains/constitutional_ai/constitutional_principle.ts

@@ -1,4 +1,4 @@
-import { SerializedConstitutionalPrinciple } from "../../chains/serde.js";
+import { SerializedConstitutionalPrinciple } from "../serde.js";
 
 export class ConstitutionalPrinciple {
   critiqueRequest: string;

langchain/src/chains/index.ts

@@ -39,17 +39,6 @@ export {
   loadSummarizationChain,
   SummarizationChainParams,
 } from "./summarization/load.js";
-export {
-  SqlDatabaseChain,
-  SqlDatabaseChainInput,
-} from "./sql_db/sql_db_chain.js";
-export {
-  DEFAULT_SQL_DATABASE_PROMPT,
-  SQL_POSTGRES_PROMPT,
-  SQL_SQLITE_PROMPT,
-  SQL_MSSQL_PROMPT,
-  SQL_MYSQL_PROMPT,
-} from "./sql_db/sql_db_prompt.js";
 export {
   ConversationalRetrievalQAChain,
   ConversationalRetrievalQAChainInput,
@@ -67,7 +56,6 @@ export {
   SerializedLLMChain,
   SerializedSequentialChain,
   SerializedSimpleSequentialChain,
-  SerializedSqlDatabaseChain,
   SerializedAnalyzeDocumentChain,
   SerializedAPIChain,
   SerializedBaseChain,

langchain/src/chains/serde.ts

@@ -1,6 +1,5 @@
 import type { SerializedLLM } from "../llms/base.js";
 import type { SerializedBasePromptTemplate } from "../prompts/serde.js";
-import type { SerializedSqlDatabase } from "../util/sql_utils.js";
 
 export type SerializedLLMChain = {
   _type: "llm_chain";
@@ -20,12 +19,6 @@ export type SerializedSimpleSequentialChain = {
   chains: Array<SerializedBaseChain>;
 };
 
-export type SerializedSqlDatabaseChain = {
-  _type: "sql_database_chain";
-  sql_database: SerializedSqlDatabase;
-  llm: SerializedLLM;
-};
-
 export type SerializedVectorDBQAChain = {
   _type: "vector_db_qa";
   k: number;
@@ -90,7 +83,6 @@ export type SerializedBaseChain =
   | SerializedVectorDBQAChain
   | SerializedAPIChain
   | SerializedStuffDocumentsChain
-  | SerializedSqlDatabaseChain
   | SerializedChatVectorDBQAChain
   | SerializedMapReduceDocumentsChain
   | SerializedAnalyzeDocumentChain

langchain/src/chains/sql_db/index.ts

@@ -0,0 +1,8 @@
+export { SqlDatabaseChain, SqlDatabaseChainInput } from "./sql_db_chain.js";
+export {
+  DEFAULT_SQL_DATABASE_PROMPT,
+  SQL_POSTGRES_PROMPT,
+  SQL_SQLITE_PROMPT,
+  SQL_MSSQL_PROMPT,
+  SQL_MYSQL_PROMPT,
+} from "./sql_db_prompt.js";

langchain/src/chains/sql_db/sql_db_chain.ts

@@ -5,7 +5,6 @@ import type { OpenAI } from "../../llms/openai.js";
 import { LLMChain } from "../llm_chain.js";
 import type { SqlDatabase } from "../../sql_db.js";
 import { ChainValues } from "../../schema/index.js";
-import { SerializedSqlDatabaseChain } from "../serde.js";
 import { BaseLanguageModel } from "../../base_language/index.js";
 import {
   calculateMaxTokens,
@@ -137,27 +136,6 @@ export class SqlDatabaseChain extends BaseChain {
     return [this.outputKey];
   }
 
-  static async deserialize(
-    data: SerializedSqlDatabaseChain,
-    SqlDatabaseFromOptionsParams: (typeof SqlDatabase)["fromOptionsParams"]
-  ) {
-    const llm = await BaseLanguageModel.deserialize(data.llm);
-    const sqlDataBase = await SqlDatabaseFromOptionsParams(data.sql_database);
-
-    return new SqlDatabaseChain({
-      llm,
-      database: sqlDataBase,
-    });
-  }
-
-  serialize(): SerializedSqlDatabaseChain {
-    return {
-      _type: this._chainType(),
-      llm: this.llm.serialize(),
-      sql_database: this.database.serialize(),
-    };
-  }
-
   private async verifyNumberOfTokens(
     inputText: string,
     tableinfo: string