Adds callback backgrounding env var in more places (#6196)

langchain-ai · Jul 24, 2024 · f1ae405 · f1ae405
1 parent 63305a0
commit f1ae405
Show file tree

Hide file tree

Showing 33 changed files with 103 additions and 11 deletions.
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/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/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",

diff --git a/docs/core_docs/docs/tutorials/llm_chain.ipynb b/docs/core_docs/docs/tutorials/llm_chain.ipynb
@@ -61,6 +61,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/local_rag.ipynb b/docs/core_docs/docs/tutorials/local_rag.ipynb
@@ -40,6 +40,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/tutorials/qa_chat_history.ipynb b/docs/core_docs/docs/tutorials/qa_chat_history.ipynb
@@ -68,6 +68,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",
         "```"
       ]
     },
@@ -80,7 +83,7 @@
     },
     {
       "cell_type": "code",
-      "execution_count": null,
+      "execution_count": 5,
       "metadata": {},
       "outputs": [],
       "source": [
@@ -92,15 +95,8 @@
         "import { pull } from \"langchain/hub\";\n",
         "import { ChatPromptTemplate } from \"@langchain/core/prompts\";\n",
         "import { RunnableSequence, RunnablePassthrough } from \"@langchain/core/runnables\";\n",
-        "import { StringOutputParser } from \"@langchain/core/output_parsers\";"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": 5,
-      "metadata": {},
-      "outputs": [],
-      "source": [
+        "import { StringOutputParser } from \"@langchain/core/output_parsers\";\n",
+        "\n",
         "import { createStuffDocumentsChain } from \"langchain/chains/combine_documents\";\n",
         "\n",
         "const loader = new CheerioWebBaseLoader(\n",

diff --git a/docs/core_docs/docs/tutorials/query_analysis.ipynb b/docs/core_docs/docs/tutorials/query_analysis.ipynb
@@ -69,6 +69,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/rag.ipynb b/docs/core_docs/docs/tutorials/rag.ipynb
@@ -74,6 +74,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",
         "```{=mdx}\n",

diff --git a/docs/core_docs/docs/tutorials/sql_qa.mdx b/docs/core_docs/docs/tutorials/sql_qa.mdx
@@ -51,6 +51,9 @@ export OPENAI_API_KEY=<your key>
 # Uncomment the below to use LangSmith. Not required, but recommended for debugging and observability.
 # export LANGCHAIN_API_KEY=<your key>
 # export LANGCHAIN_TRACING_V2=true
+
+# Reduce tracing latency if you are not in a serverless environment
+# export LANGCHAIN_CALLBACKS_BACKGROUND=true
 ```
 
 import CodeBlock from "@theme/CodeBlock";