Merge branch 'main' into brace/vertex-tool-choice

langchain-ai · Jul 24, 2024 · e92fc0f · e92fc0f
2 parents 149524b + e8a9458
commit e92fc0f
Show file tree

Hide file tree

Showing 95 changed files with 3,245 additions and 337 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -43,3 +43,20 @@ jobs:
     uses:
       ./.github/workflows/test-exports.yml
     secrets: inherit
+
+  platform-compatibility:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: "yarn"
+      - name: Install dependencies
+        run: yarn install --immutable
+      - name: Build `@langchain/core`
+        run: yarn build --filter=@langchain/core
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ You can use npm, yarn, or pnpm to install LangChain.js
 
 LangChain is written in TypeScript and can be used in:
 
-- Node.js (ESM and CommonJS) - 18.x, 19.x, 20.x
+- Node.js (ESM and CommonJS) - 18.x, 19.x, 20.x, 22.x
 - Cloudflare Workers
 - Vercel / Next.js (Browser, Serverless and Edge functions)
 - Supabase Edge Functions

diff --git a/docs/core_docs/docs/concepts.mdx b/docs/core_docs/docs/concepts.mdx
@@ -72,6 +72,9 @@ After that, you can enable it by setting environment variables:
 ```shell
 export LANGCHAIN_TRACING_V2=true
 export LANGCHAIN_API_KEY=ls__...
+
+# Reduce tracing latency if you are not in a serverless environment
+# export LANGCHAIN_CALLBACKS_BACKGROUND=true
 ```
 
 ## LangChain Expression Language

diff --git a/docs/core_docs/docs/how_to/agent_executor.ipynb b/docs/core_docs/docs/how_to/agent_executor.ipynb
@@ -67,6 +67,9 @@
     "```shell\n",
     "export LANGCHAIN_TRACING_V2=\"true\"\n",
     "export LANGCHAIN_API_KEY=\"...\"\n",
+    "\n",
+    "# Reduce tracing latency if you are not in a serverless environment\n",
+    "# export LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
     "```\n"
    ]
   },

diff --git a/docs/core_docs/docs/how_to/chat_models_universal_init.mdx b/docs/core_docs/docs/how_to/chat_models_universal_init.mdx
@@ -0,0 +1,75 @@
+# How to init any model in one line
+
+import CodeBlock from "@theme/CodeBlock";
+
+Many LLM applications let end users specify what model provider and model they want the application to be powered by.
+This requires writing some logic to initialize different ChatModels based on some user configuration.
+The `initChatModel()` helper method makes it easy to initialize a number of different model integrations without having to worry about import paths and class names.
+Keep in mind this feature is only for chat models.
+
+:::info Prerequisites
+
+This guide assumes familiarity with the following concepts:
+
+- [Chat models](/docs/concepts/#chat-models)
+
+- [LangChain Expression Language (LCEL)](/docs/concepts#langchain-expression-language)
+
+- [Tool calling](/docs/concepts#tools)
+
+:::
+
+:::caution Compatibility
+**This feature is only intended to be used in Node environments. Use in non Node environments or with bundlers is not guaranteed to work and not officially supported.**
+
+`initChatModel` requires `langchain>=0.2.11`. See [this guide](/docs/how_to/installation/#installing-integration-packages) for some considerations to take when upgrading.
+
+See the [initChatModel()](https://v02.api.js.langchain.com/functions/langchain_chat_models_configurable.initChatModel.html) API reference for a full list of supported integrations.
+
+Make sure you have the integration packages installed for any model providers you want to support. E.g. you should have `@langchain/openai` installed to init an OpenAI model.
+:::
+
+## Basic usage
+
+import BasicExample from "@examples/models/chat/configurable/basic.ts";
+
+<CodeBlock language="typescript">{BasicExample}</CodeBlock>
+
+## Inferring model provider
+
+For common and distinct model names `initChatModel()` will attempt to infer the model provider.
+See the [API reference](https://v02.api.js.langchain.com/functions/langchain_chat_models_configurable.initChatModel.html) for a full list of inference behavior.
+E.g. any model that starts with `gpt-3...` or `gpt-4...` will be inferred as using model provider `openai`.
+
+import InferringProviderExample from "@examples/models/chat/configurable/inferring_model_provider.ts";
+
+<CodeBlock language="typescript">{InferringProviderExample}</CodeBlock>
+
+## Creating a configurable model
+
+You can also create a runtime-configurable model by specifying `configurableFields`.
+If you don't specify a `model` value, then "model" and "modelProvider" be configurable by default.
+
+import ConfigurableModelExample from "@examples/models/chat/configurable/configurable_model.ts";
+
+<CodeBlock language="typescript">{ConfigurableModelExample}</CodeBlock>
+
+### Configurable model with default values
+
+We can create a configurable model with default model values, specify which parameters are configurable, and add prefixes to configurable params:
+
+import ConfigurableModelWithDefaultsExample from "@examples/models/chat/configurable/configurable_model_with_defaults.ts";
+
+<CodeBlock language="typescript">
+  {ConfigurableModelWithDefaultsExample}
+</CodeBlock>
+
+### Using a configurable model declaratively
+
+We can call declarative operations like `bindTools`, `withStructuredOutput`, `withConfig`, etc. on a configurable model and chain a configurable model in the same way that we would a regularly instantiated chat model object.
+
+import ConfigurableModelDeclarativelyExample from "@examples/models/chat/configurable/configurable_model_declaratively.ts";
+
+<CodeBlock language="typescript">
+  {ConfigurableModelDeclarativelyExample}
+</CodeBlock>
diff --git a/docs/core_docs/docs/how_to/debugging.mdx b/docs/core_docs/docs/how_to/debugging.mdx
@@ -18,6 +18,9 @@ After you sign up at the link above, make sure to set your environment variables
 ```shell
 export LANGCHAIN_TRACING_V2="true"
 export LANGCHAIN_API_KEY="..."
+
+# Reduce tracing latency if you are not in a serverless environment
+# export LANGCHAIN_CALLBACKS_BACKGROUND=true
 ```
 
 Let's suppose we have an agent, and want to visualize the actions it takes and tool outputs it receives. Without any debugging, here's what we see:

diff --git a/docs/core_docs/docs/how_to/graph_constructing.ipynb b/docs/core_docs/docs/how_to/graph_constructing.ipynb
@@ -42,6 +42,9 @@
         "# Optional, use LangSmith for best-in-class observability\n",
         "LANGSMITH_API_KEY=your-api-key\n",
         "LANGCHAIN_TRACING_V2=true\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```\n",
         "\n",
         "Next, we need to define Neo4j credentials.\n",

diff --git a/docs/core_docs/docs/how_to/graph_mapping.ipynb b/docs/core_docs/docs/how_to/graph_mapping.ipynb
@@ -41,6 +41,9 @@
         "# Optional, use LangSmith for best-in-class observability\n",
         "LANGSMITH_API_KEY=your-api-key\n",
         "LANGCHAIN_TRACING_V2=true\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```\n",
         "\n",
         "Next, we need to define Neo4j credentials.\n",

diff --git a/docs/core_docs/docs/how_to/graph_prompting.ipynb b/docs/core_docs/docs/how_to/graph_prompting.ipynb
@@ -37,6 +37,9 @@
         "# Optional, use LangSmith for best-in-class observability\n",
         "LANGSMITH_API_KEY=your-api-key\n",
         "LANGCHAIN_TRACING_V2=true\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```\n",
         "\n",
         "Next, we need to define Neo4j credentials.\n",

diff --git a/docs/core_docs/docs/how_to/graph_semantic.ipynb b/docs/core_docs/docs/how_to/graph_semantic.ipynb
@@ -44,6 +44,9 @@
         "# Optional, use LangSmith for best-in-class observability\n",
         "LANGSMITH_API_KEY=your-api-key\n",
         "LANGCHAIN_TRACING_V2=true\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```\n",
         "\n",
         "Next, we need to define Neo4j credentials.\n",

diff --git a/docs/core_docs/docs/how_to/index.mdx b/docs/core_docs/docs/how_to/index.mdx
@@ -9,7 +9,7 @@ Here you'll find answers to “How do I….?” types of questions.
 These guides are _goal-oriented_ and _concrete_; they're meant to help you complete a specific task.
 For conceptual explanations see [Conceptual Guides](/docs/concepts/).
 For end-to-end walkthroughs see [Tutorials](/docs/tutorials).
-For comprehensive descriptions of every class and function see [API Reference](https://v2.v02.api.js.langchain.com/).
+For comprehensive descriptions of every class and function see [API Reference](https://api.js.langchain.com/).
 
 ## Installation
 
@@ -76,6 +76,7 @@ These are the core building blocks you can use when building applications.
 - [How to: stream tool calls](/docs/how_to/tool_streaming)
 - [How to: few shot prompt tool behavior](/docs/how_to/tool_calling#few-shotting-with-tools)
 - [How to: force a specific tool call](/docs/how_to/tool_choice)
+- [How to: init any model in one line](/docs/how_to/chat_models_universal_init/)
 
 ### Messages
 

diff --git a/docs/core_docs/docs/how_to/message_history.mdx b/docs/core_docs/docs/how_to/message_history.mdx
@@ -48,6 +48,9 @@ If you do want to use LangSmith, after you sign up at the link above, make sure
 ```bash
 export LANGCHAIN_TRACING_V2="true"
 export LANGCHAIN_API_KEY="<your-api-key>"
+
+# Reduce tracing latency if you are not in a serverless environment
+# export LANGCHAIN_CALLBACKS_BACKGROUND=true
 ```
 
 Let's create a simple runnable that takes a dict as input and returns a `BaseMessage`.

diff --git a/docs/core_docs/docs/how_to/migrate_agent.ipynb b/docs/core_docs/docs/how_to/migrate_agent.ipynb
@@ -60,7 +60,10 @@
     "// process.env.LANGCHAIN_API_KEY = \"ls...\";\n",
     "// process.env.LANGCHAIN_CALLBACKS_BACKGROUND = \"true\";\n",
     "// process.env.LANGCHAIN_TRACING_V2 = \"true\";\n",
-    "// process.env.LANGCHAIN_PROJECT = \"How to migrate: LangGraphJS\";"
+    "// process.env.LANGCHAIN_PROJECT = \"How to migrate: LangGraphJS\";\n",
+    "\n",
+    "// Reduce tracing latency if you are not in a serverless environment\n",
+    "// process.env.LANGCHAIN_CALLBACKS_BACKGROUND = \"true\";"
    ]
   },
   {

diff --git a/docs/core_docs/docs/how_to/qa_chat_history_how_to.ipynb b/docs/core_docs/docs/how_to/qa_chat_history_how_to.ipynb
@@ -60,6 +60,9 @@
         "```bash\n",
         "export LANGCHAIN_TRACING_V2=true\n",
         "export LANGCHAIN_API_KEY=YOUR_KEY\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# export LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```"
       ]
     },

diff --git a/docs/core_docs/docs/how_to/qa_citations.ipynb b/docs/core_docs/docs/how_to/qa_citations.ipynb
@@ -57,6 +57,9 @@
         "```bash\n",
         "export LANGCHAIN_TRACING_V2=true\n",
         "export LANGCHAIN_API_KEY=YOUR_KEY\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# export LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```"
       ]
     },

diff --git a/docs/core_docs/docs/how_to/qa_per_user.ipynb b/docs/core_docs/docs/how_to/qa_per_user.ipynb
@@ -89,6 +89,9 @@
         "# Optional, use LangSmith for best-in-class observability\n",
         "LANGSMITH_API_KEY=your-api-key\n",
         "LANGCHAIN_TRACING_V2=true\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```"
       ]
     },

diff --git a/docs/core_docs/docs/how_to/qa_sources.ipynb b/docs/core_docs/docs/how_to/qa_sources.ipynb
@@ -55,6 +55,9 @@
         "```bash\n",
         "export LANGCHAIN_TRACING_V2=true\n",
         "export LANGCHAIN_API_KEY=YOUR_KEY\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# export LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```"
       ]
     },

diff --git a/docs/core_docs/docs/how_to/qa_streaming.ipynb b/docs/core_docs/docs/how_to/qa_streaming.ipynb
@@ -55,6 +55,9 @@
         "```bash\n",
         "export LANGCHAIN_TRACING_V2=true\n",
         "export LANGCHAIN_API_KEY=YOUR_KEY\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# export LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```"
       ]
     },

diff --git a/docs/core_docs/docs/how_to/query_few_shot.ipynb b/docs/core_docs/docs/how_to/query_few_shot.ipynb
@@ -46,6 +46,9 @@
     "# Optional, use LangSmith for best-in-class observability\n",
     "LANGSMITH_API_KEY=your-api-key\n",
     "LANGCHAIN_TRACING_V2=true\n",
+    "\n",
+    "# Reduce tracing latency if you are not in a serverless environment\n",
+    "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
     "```"
    ]
   },

diff --git a/docs/core_docs/docs/how_to/query_high_cardinality.ipynb b/docs/core_docs/docs/how_to/query_high_cardinality.ipynb
@@ -48,6 +48,9 @@
         "# Optional, use LangSmith for best-in-class observability\n",
         "LANGSMITH_API_KEY=your-api-key\n",
         "LANGCHAIN_TRACING_V2=true\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```"
       ]
     },

diff --git a/docs/core_docs/docs/how_to/query_multiple_queries.ipynb b/docs/core_docs/docs/how_to/query_multiple_queries.ipynb
@@ -46,6 +46,9 @@
         "# Optional, use LangSmith for best-in-class observability\n",
         "LANGSMITH_API_KEY=your-api-key\n",
         "LANGCHAIN_TRACING_V2=true\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```"
       ]
     },

diff --git a/docs/core_docs/docs/how_to/query_multiple_retrievers.ipynb b/docs/core_docs/docs/how_to/query_multiple_retrievers.ipynb
@@ -46,6 +46,9 @@
         "# Optional, use LangSmith for best-in-class observability\n",
         "LANGSMITH_API_KEY=your-api-key\n",
         "LANGCHAIN_TRACING_V2=true\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```"
       ]
     },

diff --git a/docs/core_docs/docs/how_to/query_no_queries.ipynb b/docs/core_docs/docs/how_to/query_no_queries.ipynb
@@ -48,6 +48,9 @@
         "# Optional, use LangSmith for best-in-class observability\n",
         "LANGSMITH_API_KEY=your-api-key\n",
         "LANGCHAIN_TRACING_V2=true\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```"
       ]
     },

diff --git a/docs/core_docs/docs/how_to/sql_large_db.mdx b/docs/core_docs/docs/how_to/sql_large_db.mdx
@@ -25,6 +25,9 @@ export OPENAI_API_KEY="your api key"
 # Uncomment the below to use LangSmith. Not required.
 # export LANGCHAIN_API_KEY="your api key"
 # export LANGCHAIN_TRACING_V2=true
+
+# Reduce tracing latency if you are not in a serverless environment
+# export LANGCHAIN_CALLBACKS_BACKGROUND=true
 ```
 
 The below example will use a SQLite connection with Chinook database. Follow these [installation steps](https://database.guide/2-sample-databases-sqlite/) to create `Chinook.db` in the same directory as this notebook:

diff --git a/docs/core_docs/docs/how_to/sql_prompting.mdx b/docs/core_docs/docs/how_to/sql_prompting.mdx
@@ -24,6 +24,9 @@ export OPENAI_API_KEY="your api key"
 # Uncomment the below to use LangSmith. Not required.
 # export LANGCHAIN_API_KEY="your api key"
 # export LANGCHAIN_TRACING_V2=true
+
+# Reduce tracing latency if you are not in a serverless environment
+# export LANGCHAIN_CALLBACKS_BACKGROUND=true
 ```
 
 The below example will use a SQLite connection with Chinook database. Follow these [installation steps](https://database.guide/2-sample-databases-sqlite/) to create `Chinook.db` in the same directory as this notebook:

diff --git a/docs/core_docs/docs/how_to/sql_query_checking.mdx b/docs/core_docs/docs/how_to/sql_query_checking.mdx
@@ -28,6 +28,9 @@ export OPENAI_API_KEY="your api key"
 # Uncomment the below to use LangSmith. Not required.
 # export LANGCHAIN_API_KEY="your api key"
 # export LANGCHAIN_TRACING_V2=true
+
+# Reduce tracing latency if you are not in a serverless environment
+# export LANGCHAIN_CALLBACKS_BACKGROUND=true
 ```
 
 The below example will use a SQLite connection with Chinook database. Follow these [installation steps](https://database.guide/2-sample-databases-sqlite/) to create `Chinook.db` in the same directory as this notebook:

diff --git a/docs/core_docs/docs/how_to/tools_prompting.ipynb b/docs/core_docs/docs/how_to/tools_prompting.ipynb
@@ -53,6 +53,9 @@
     "# Optional, use LangSmith for best-in-class observability\n",
     "LANGSMITH_API_KEY=your-api-key\n",
     "LANGCHAIN_TRACING_V2=true\n",
+    "\n",
+    "# Reduce tracing latency if you are not in a serverless environment\n",
+    "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
     "```"
    ]
   },

diff --git a/docs/core_docs/docs/tutorials/agents.mdx b/docs/core_docs/docs/tutorials/agents.mdx
@@ -31,6 +31,9 @@ When building with LangChain, all steps will automatically be traced in LangSmit
 ```bash
 export LANGCHAIN_TRACING_V2="true"
 export LANGCHAIN_API_KEY="<your-api-key>"
+
+# Reduce tracing latency if you are not in a serverless environment
+# export LANGCHAIN_CALLBACKS_BACKGROUND=true
 ```
 
 ## Define tools

diff --git a/docs/core_docs/docs/tutorials/chatbot.ipynb b/docs/core_docs/docs/tutorials/chatbot.ipynb
@@ -71,6 +71,9 @@
     "```shell\n",
     "export LANGCHAIN_TRACING_V2=\"true\"\n",
     "export LANGCHAIN_API_KEY=\"...\"\n",
+    "\n",
+    "# Reduce tracing latency if you are not in a serverless environment\n",
+    "# export LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
     "```\n",
     "\n",
     "## Quickstart\n",

diff --git a/docs/core_docs/docs/tutorials/extraction.ipynb b/docs/core_docs/docs/tutorials/extraction.ipynb
@@ -66,6 +66,9 @@
     "```shell\n",
     "export LANGCHAIN_TRACING_V2=\"true\"\n",
     "export LANGCHAIN_API_KEY=\"...\"\n",
+    "\n",
+    "# Reduce tracing latency if you are not in a serverless environment\n",
+    "# export LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
     "```"
    ]
   },

diff --git a/docs/core_docs/docs/tutorials/graph.ipynb b/docs/core_docs/docs/tutorials/graph.ipynb
@@ -62,6 +62,9 @@
         "# Optional, use LangSmith for best-in-class observability\n",
         "LANGSMITH_API_KEY=your-api-key\n",
         "LANGCHAIN_TRACING_V2=true\n",
+        "\n",
+        "# Reduce tracing latency if you are not in a serverless environment\n",
+        "# LANGCHAIN_CALLBACKS_BACKGROUND=true\n",
         "```\n",
         "\n",
         "Next, we need to define Neo4j credentials.\n",