bump version to 158 (#4091)

As of right now when trying to use functions like
`max_marginal_relevance_search()` or
`max_marginal_relevance_search_by_vector()` the rest of the kwargs are
not propagated to `self._search_helper()`. For example a user cannot
explicitly state the distance_metric they want to use when calling
`max_marginal_relevance_search`

.github/workflows/linkcheck.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
 
 env:
-  POETRY_VERSION: "1.3.1"
+  POETRY_VERSION: "1.4.2"
 
 jobs:
   build:

.github/workflows/lint.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
 
 env:
-  POETRY_VERSION: "1.3.1"
+  POETRY_VERSION: "1.4.2"
 
 jobs:
   build:

.github/workflows/release.yml

@@ -10,7 +10,7 @@ on:
       - 'pyproject.toml'
 
 env:
-  POETRY_VERSION: "1.3.1"
+  POETRY_VERSION: "1.4.2"
 
 jobs:
   if_release:
@@ -45,5 +45,5 @@ jobs:
       - name: Publish to PyPI
         env:
           POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_API_TOKEN }}
-        run: | 
+        run: |
           poetry publish

.github/workflows/test.yml

@@ -6,7 +6,7 @@ on:
   pull_request:
 
 env:
-  POETRY_VERSION: "1.3.1"
+  POETRY_VERSION: "1.4.2"
 
 jobs:
   build:

.gitignore

@@ -1,3 +1,4 @@
+.vs/
 .vscode/
 .idea/
 # Byte-compiled / optimized / DLL files
@@ -144,4 +145,8 @@ wandb/
 /.ruff_cache/
 
 *.pkl
-*.bin
+*.bin
+
+# integration test artifacts
+data_map*
+\[('_type', 'fake'), ('stop', None)]

Dockerfile

@@ -1,5 +1,7 @@
 # This is a Dockerfile for running unit tests
 
+ARG POETRY_HOME=/opt/poetry
+
 # Use the Python base image
 FROM python:3.11.2-bullseye AS builder
 
@@ -7,7 +9,7 @@ FROM python:3.11.2-bullseye AS builder
 ARG POETRY_VERSION=1.4.2
 
 # Define the directory to install Poetry to (default is /opt/poetry)
-ARG POETRY_HOME=/opt/poetry
+ARG POETRY_HOME
 
 # Create a Python virtual environment for Poetry and install it
 RUN python3 -m venv ${POETRY_HOME} && \
@@ -23,6 +25,8 @@ WORKDIR /app
 # Use a multi-stage build to install dependencies
 FROM builder AS dependencies
 
+ARG POETRY_HOME
+
 # Copy only the dependency files for installation
 COPY pyproject.toml poetry.lock poetry.toml ./
 

README.md

@@ -4,6 +4,8 @@
 
 [![lint](https://github.com/hwchase17/langchain/actions/workflows/lint.yml/badge.svg)](https://github.com/hwchase17/langchain/actions/workflows/lint.yml) [![test](https://github.com/hwchase17/langchain/actions/workflows/test.yml/badge.svg)](https://github.com/hwchase17/langchain/actions/workflows/test.yml) [![linkcheck](https://github.com/hwchase17/langchain/actions/workflows/linkcheck.yml/badge.svg)](https://github.com/hwchase17/langchain/actions/workflows/linkcheck.yml) [![Downloads](https://static.pepy.tech/badge/langchain/month)](https://pepy.tech/project/langchain) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai) [![](https://dcbadge.vercel.app/api/server/6adMQxSpJS?compact=true&style=flat)](https://discord.gg/6adMQxSpJS)
 
+Looking for the JS/TS version? Check out [LangChain.js](https://github.com/hwchase17/langchainjs).
+
 **Production Support:** As you move your LangChains into production, we'd love to offer more comprehensive support.
 Please fill out [this form](https://forms.gle/57d8AmXBYp8PP8tZA) and we'll set up a dedicated support Slack channel.
 
@@ -15,12 +17,9 @@ or
 
 ## 🤔 What is this?
 
-Large language models (LLMs) are emerging as a transformative technology, enabling
-developers to build applications that they previously could not.
-But using these LLMs in isolation is often not enough to
-create a truly powerful app - the real power comes when you can combine them with other sources of computation or knowledge.
+Large language models (LLMs) are emerging as a transformative technology, enabling developers to build applications that they previously could not. However, using these LLMs in isolation is often insufficient for creating a truly powerful app - the real power comes when you can combine them with other sources of computation or knowledge.
 
-This library is aimed at assisting in the development of those types of applications. Common examples of these types of applications include:
+This library aims to assist in the development of those types of applications. Common examples of these applications include:
 
 **❓ Question Answering over specific documents**
 
@@ -53,23 +52,23 @@ These are, in increasing order of complexity:
 
 **📃 LLMs and Prompts:**
 
-This includes prompt management, prompt optimization, generic interface for all LLMs, and common utilities for working with LLMs.
+This includes prompt management, prompt optimization, a generic interface for all LLMs, and common utilities for working with LLMs.
 
 **🔗 Chains:**
 
-Chains go beyond just a single LLM call, and are sequences of calls (whether to an LLM or a different utility). LangChain provides a standard interface for chains, lots of integrations with other tools, and end-to-end chains for common applications.
+Chains go beyond a single LLM call and involve sequences of calls (whether to an LLM or a different utility). LangChain provides a standard interface for chains, lots of integrations with other tools, and end-to-end chains for common applications.
 
 **📚 Data Augmented Generation:**
 
-Data Augmented Generation involves specific types of chains that first interact with an external datasource to fetch data to use in the generation step. Examples of this include summarization of long pieces of text and question/answering over specific data sources.
+Data Augmented Generation involves specific types of chains that first interact with an external data source to fetch data for use in the generation step. Examples include summarization of long pieces of text and question/answering over specific data sources.
 
 **🤖 Agents:**
 
-Agents involve an LLM making decisions about which Actions to take, taking that Action, seeing an Observation, and repeating that until done. LangChain provides a standard interface for agents, a selection of agents to choose from, and examples of end to end agents.
+Agents involve an LLM making decisions about which Actions to take, taking that Action, seeing an Observation, and repeating that until done. LangChain provides a standard interface for agents, a selection of agents to choose from, and examples of end-to-end agents.
 
 **🧠 Memory:**
 
-Memory is the concept of persisting state between calls of a chain/agent. LangChain provides a standard interface for memory, a collection of memory implementations, and examples of chains/agents that use memory.
+Memory refers to persisting state between calls of a chain/agent. LangChain provides a standard interface for memory, a collection of memory implementations, and examples of chains/agents that use memory.
 
 **🧐 Evaluation:**
 
@@ -79,6 +78,6 @@ For more information on these concepts, please see our [full documentation](http
 
 ## 💁 Contributing
 
-As an open source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infra, or better documentation.
+As an open-source project in a rapidly developing field, we are extremely open to contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation.
 
 For detailed information on how to contribute, see [here](.github/CONTRIBUTING.md).

docs/deployments.md

@@ -1,14 +1,10 @@
 # Deployments
 
-So you've made a really cool chain - now what? How do you deploy it and make it easily sharable with the world?
+So, you've created a really cool chain - now what? How do you deploy it and make it easily shareable with the world?
 
-This section covers several options for that.
-Note that these are meant as quick deployment options for prototypes and demos, and not for production systems.
-If you are looking for help with deployment of a production system, please contact us directly.
+This section covers several options for that. Note that these options are meant for quick deployment of prototypes and demos, not for production systems. If you need help with the deployment of a production system, please contact us directly.
 
-What follows is a list of template GitHub repositories aimed that are intended to be
-very easy to fork and modify to use your chain.
-This is far from an exhaustive list of options, and we are EXTREMELY open to contributions here.
+What follows is a list of template GitHub repositories designed to be easily forked and modified to use your chain. This list is far from exhaustive, and we are EXTREMELY open to contributions here.
 
 ## [Streamlit](https://github.com/hwchase17/langchain-streamlit-template)
 
@@ -33,6 +29,10 @@ It implements a Question Answering app and contains instructions for deploying t
 
 A minimal example on how to run LangChain on Vercel using Flask.
 
+## [Fly.io](https://github.com/fly-apps/hello-fly-langchain)
+
+A minimal example of how to deploy LangChain to [Fly.io](https://fly.io/) using Flask.
+
 ## [Digitalocean App Platform](https://github.com/homanp/digitalocean-langchain)
 
 A minimal example on how to deploy LangChain to DigitalOcean App Platform.
@@ -43,13 +43,16 @@ A minimal example on how to deploy LangChain to Google Cloud Run.
 
 ## [SteamShip](https://github.com/steamship-core/steamship-langchain/)
 
-This repository contains LangChain adapters for Steamship, enabling LangChain developers to rapidly deploy their apps on Steamship.
-This includes: production ready endpoints, horizontal scaling across dependencies, persistant storage of app state, multi-tenancy support, etc.
+This repository contains LangChain adapters for Steamship, enabling LangChain developers to rapidly deploy their apps on Steamship. This includes: production-ready endpoints, horizontal scaling across dependencies, persistent storage of app state, multi-tenancy support, etc.
 
 ## [Langchain-serve](https://github.com/jina-ai/langchain-serve)
 
-This repository allows users to serve local chains and agents as RESTful, gRPC, or Websocket APIs thanks to [Jina](https://docs.jina.ai/). Deploy your chains & agents with ease and enjoy independent scaling, serverless and autoscaling APIs, as well as a Streamlit playground on Jina AI Cloud.
+This repository allows users to serve local chains and agents as RESTful, gRPC, or WebSocket APIs, thanks to [Jina](https://docs.jina.ai/). Deploy your chains & agents with ease and enjoy independent scaling, serverless and autoscaling APIs, as well as a Streamlit playground on Jina AI Cloud.
 
 ## [BentoML](https://github.com/ssheng/BentoChain)
 
 This repository provides an example of how to deploy a LangChain application with [BentoML](https://github.com/bentoml/BentoML). BentoML is a framework that enables the containerization of machine learning applications as standard OCI images. BentoML also allows for the automatic generation of OpenAPI and gRPC endpoints. With BentoML, you can integrate models from all popular ML frameworks and deploy them as microservices running on the most optimal hardware and scaling independently.
+
+## [Databutton](https://databutton.com/home?new-data-app=true)
+
+These templates serve as examples of how to build, deploy, and share LangChain applications using Databutton. You can create user interfaces with Streamlit, automate tasks by scheduling Python code, and store files and data in the built-in store. Examples include a Chatbot interface with conversational memory, a Personal search engine, and a starter template for LangChain apps. Deploying and sharing is just one click away.

docs/ecosystem.rst

@@ -3,6 +3,25 @@ LangChain Ecosystem
 
 Guides for how other companies/products can be used with LangChain
 
+Groups
+----------
+
+LangChain provides integration with many LLMs and systems:
+
+- `LLM Providers <./modules/models/llms/integrations.html>`_
+- `Chat Model Providers <./modules/models/chat/integrations.html>`_
+- `Text Embedding Model Providers <./modules/models/text_embedding.html>`_
+- `Document Loader Integrations <./modules/indexes/document_loaders.html>`_
+- `Text Splitter Integrations <./modules/indexes/text_splitters.html>`_
+- `Vectorstore Providers <./modules/indexes/vectorstores.html>`_
+- `Retriever Providers <./modules/indexes/retrievers.html>`_
+- `Tool Providers <./modules/agents/tools.html>`_
+- `Toolkit Integrations <./modules/agents/toolkits.html>`_
+
+Companies / Products
+----------
+
+
 .. toctree::
    :maxdepth: 1
    :glob:

docs/ecosystem/aim_tracking.ipynb

@@ -61,7 +61,6 @@
     "from datetime import datetime\n",
     "\n",
     "from langchain.llms import OpenAI\n",
-    "from langchain.callbacks.base import CallbackManager\n",
     "from langchain.callbacks import AimCallbackHandler, StdOutCallbackHandler"
    ]
   },
@@ -109,8 +108,8 @@
     "    experiment_name=\"scenario 1: OpenAI LLM\",\n",
     ")\n",
     "\n",
-    "manager = CallbackManager([StdOutCallbackHandler(), aim_callback])\n",
-    "llm = OpenAI(temperature=0, callback_manager=manager, verbose=True)"
+    "callbacks = [StdOutCallbackHandler(), aim_callback]\n",
+    "llm = OpenAI(temperature=0, callbacks=callbacks)"
    ]
   },
   {
@@ -177,7 +176,7 @@
     "Title: {title}\n",
     "Playwright: This is a synopsis for the above play:\"\"\"\n",
     "prompt_template = PromptTemplate(input_variables=[\"title\"], template=template)\n",
-    "synopsis_chain = LLMChain(llm=llm, prompt=prompt_template, callback_manager=manager)\n",
+    "synopsis_chain = LLMChain(llm=llm, prompt=prompt_template, callbacks=callbacks)\n",
     "\n",
     "test_prompts = [\n",
     "    {\"title\": \"documentary about good video games that push the boundary of game design\"},\n",
@@ -249,13 +248,12 @@
    ],
    "source": [
     "# scenario 3 - Agent with Tools\n",
-    "tools = load_tools([\"serpapi\", \"llm-math\"], llm=llm, callback_manager=manager)\n",
+    "tools = load_tools([\"serpapi\", \"llm-math\"], llm=llm, callbacks=callbacks)\n",
     "agent = initialize_agent(\n",
     "    tools,\n",
     "    llm,\n",
     "    agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION,\n",
-    "    callback_manager=manager,\n",
-    "    verbose=True,\n",
+    "    callbacks=callbacks,\n",
     ")\n",
     "agent.run(\n",
     "    \"Who is Leo DiCaprio's girlfriend? What is her current age raised to the 0.43 power?\"\n",

docs/ecosystem/clearml_tracking.ipynb

@@ -79,7 +79,6 @@
    "source": [
     "from datetime import datetime\n",
     "from langchain.callbacks import ClearMLCallbackHandler, StdOutCallbackHandler\n",
-    "from langchain.callbacks.base import CallbackManager\n",
     "from langchain.llms import OpenAI\n",
     "\n",
     "# Setup and use the ClearML Callback\n",
@@ -93,9 +92,9 @@
     "    complexity_metrics=True,\n",
     "    stream_logs=True\n",
     ")\n",
-    "manager = CallbackManager([StdOutCallbackHandler(), clearml_callback])\n",
+    "callbacks = [StdOutCallbackHandler(), clearml_callback]\n",
     "# Get the OpenAI model ready to go\n",
-    "llm = OpenAI(temperature=0, callback_manager=manager, verbose=True)"
+    "llm = OpenAI(temperature=0, callbacks=callbacks)"
    ]
   },
   {
@@ -523,13 +522,12 @@
     "from langchain.agents import AgentType\n",
     "\n",
     "# SCENARIO 2 - Agent with Tools\n",
-    "tools = load_tools([\"serpapi\", \"llm-math\"], llm=llm, callback_manager=manager)\n",
+    "tools = load_tools([\"serpapi\", \"llm-math\"], llm=llm, callbacks=callbacks)\n",
     "agent = initialize_agent(\n",
     "    tools,\n",
     "    llm,\n",
     "    agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION,\n",
-    "    callback_manager=manager,\n",
-    "    verbose=True,\n",
+    "    callbacks=callbacks,\n",
     ")\n",
     "agent.run(\n",
     "    \"Who is the wife of the person who sang summer of 69?\"\n",

docs/ecosystem/comet_tracking.ipynb

@@ -64,7 +64,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "You can grab your [Comet API Key here](https://www.comet.com/signup?utm_source=langchain&utm_medium=referral&utm_campaign=comet_notebook) or click the link after intializing Comet"
+    "You can grab your [Comet API Key here](https://www.comet.com/signup?utm_source=langchain&utm_medium=referral&utm_campaign=comet_notebook) or click the link after initializing Comet"
    ]
   },
   {
@@ -121,7 +121,6 @@
     "from datetime import datetime\n",
     "\n",
     "from langchain.callbacks import CometCallbackHandler, StdOutCallbackHandler\n",
-    "from langchain.callbacks.base import CallbackManager\n",
     "from langchain.llms import OpenAI\n",
     "\n",
     "comet_callback = CometCallbackHandler(\n",
@@ -131,8 +130,8 @@
     "    tags=[\"llm\"],\n",
     "    visualizations=[\"dep\"],\n",
     ")\n",
-    "manager = CallbackManager([StdOutCallbackHandler(), comet_callback])\n",
-    "llm = OpenAI(temperature=0.9, callback_manager=manager, verbose=True)\n",
+    "callbacks = [StdOutCallbackHandler(), comet_callback]\n",
+    "llm = OpenAI(temperature=0.9, callbacks=callbacks, verbose=True)\n",
     "\n",
     "llm_result = llm.generate([\"Tell me a joke\", \"Tell me a poem\", \"Tell me a fact\"] * 3)\n",
     "print(\"LLM result\", llm_result)\n",
@@ -153,7 +152,6 @@
    "outputs": [],
    "source": [
     "from langchain.callbacks import CometCallbackHandler, StdOutCallbackHandler\n",
-    "from langchain.callbacks.base import CallbackManager\n",
     "from langchain.chains import LLMChain\n",
     "from langchain.llms import OpenAI\n",
     "from langchain.prompts import PromptTemplate\n",
@@ -164,15 +162,14 @@
     "    stream_logs=True,\n",
     "    tags=[\"synopsis-chain\"],\n",
     ")\n",
-    "manager = CallbackManager([StdOutCallbackHandler(), comet_callback])\n",
-    "\n",
-    "llm = OpenAI(temperature=0.9, callback_manager=manager, verbose=True)\n",
+    "callbacks = [StdOutCallbackHandler(), comet_callback]\n",
+    "llm = OpenAI(temperature=0.9, callbacks=callbacks)\n",
     "\n",
     "template = \"\"\"You are a playwright. Given the title of play, it is your job to write a synopsis for that title.\n",
     "Title: {title}\n",
     "Playwright: This is a synopsis for the above play:\"\"\"\n",
     "prompt_template = PromptTemplate(input_variables=[\"title\"], template=template)\n",
-    "synopsis_chain = LLMChain(llm=llm, prompt=prompt_template, callback_manager=manager)\n",
+    "synopsis_chain = LLMChain(llm=llm, prompt=prompt_template, callbacks=callbacks)\n",
     "\n",
     "test_prompts = [{\"title\": \"Documentary about Bigfoot in Paris\"}]\n",
     "print(synopsis_chain.apply(test_prompts))\n",
@@ -194,7 +191,6 @@
    "source": [
     "from langchain.agents import initialize_agent, load_tools\n",
     "from langchain.callbacks import CometCallbackHandler, StdOutCallbackHandler\n",
-    "from langchain.callbacks.base import CallbackManager\n",
     "from langchain.llms import OpenAI\n",
     "\n",
     "comet_callback = CometCallbackHandler(\n",
@@ -203,15 +199,15 @@
     "    stream_logs=True,\n",
     "    tags=[\"agent\"],\n",
     ")\n",
-    "manager = CallbackManager([StdOutCallbackHandler(), comet_callback])\n",
-    "llm = OpenAI(temperature=0.9, callback_manager=manager, verbose=True)\n",
+    "callbacks = [StdOutCallbackHandler(), comet_callback]\n",
+    "llm = OpenAI(temperature=0.9, callbacks=callbacks)\n",
     "\n",
-    "tools = load_tools([\"serpapi\", \"llm-math\"], llm=llm, callback_manager=manager)\n",
+    "tools = load_tools([\"serpapi\", \"llm-math\"], llm=llm, callbacks=callbacks)\n",
     "agent = initialize_agent(\n",
     "    tools,\n",
     "    llm,\n",
     "    agent=\"zero-shot-react-description\",\n",
-    "    callback_manager=manager,\n",
+    "    callbacks=callbacks,\n",
     "    verbose=True,\n",
     ")\n",
     "agent.run(\n",
@@ -255,7 +251,6 @@
     "from rouge_score import rouge_scorer\n",
     "\n",
     "from langchain.callbacks import CometCallbackHandler, StdOutCallbackHandler\n",
-    "from langchain.callbacks.base import CallbackManager\n",
     "from langchain.chains import LLMChain\n",
     "from langchain.llms import OpenAI\n",
     "from langchain.prompts import PromptTemplate\n",
@@ -298,10 +293,10 @@
     "    tags=[\"custom_metrics\"],\n",
     "    custom_metrics=rouge_score.compute_metric,\n",
     ")\n",
-    "manager = CallbackManager([StdOutCallbackHandler(), comet_callback])\n",
-    "llm = OpenAI(temperature=0.9, callback_manager=manager, verbose=True)\n",
+    "callbacks = [StdOutCallbackHandler(), comet_callback]\n",
+    "llm = OpenAI(temperature=0.9)\n",
     "\n",
-    "synopsis_chain = LLMChain(llm=llm, prompt=prompt_template, callback_manager=manager)\n",
+    "synopsis_chain = LLMChain(llm=llm, prompt=prompt_template)\n",
     "\n",
     "test_prompts = [\n",
     "    {\n",
@@ -323,7 +318,7 @@
     "                 \"\"\"\n",
     "    }\n",
     "]\n",
-    "print(synopsis_chain.apply(test_prompts))\n",
+    "print(synopsis_chain.apply(test_prompts, callbacks=callbacks))\n",
     "comet_callback.flush_tracker(synopsis_chain, finish=True)"
    ]
   }

docs/ecosystem/gpt4all.md

@@ -3,6 +3,7 @@
 This page covers how to use the `GPT4All` wrapper within LangChain. The tutorial is divided into two parts: installation and setup, followed by usage with an example.
 
 ## Installation and Setup
+
 - Install the Python package with `pip install pyllamacpp`
 - Download a [GPT4All model](https://github.com/nomic-ai/pyllamacpp#supported-model) and place it in your desired directory
 
@@ -28,16 +29,16 @@ To stream the model's predictions, add in a CallbackManager.
 
 ```python
 from langchain.llms import GPT4All
-from langchain.callbacks.base import CallbackManager
 from langchain.callbacks.streaming_stdout import StreamingStdOutCallbackHandler
+
 # There are many CallbackHandlers supported, such as
 # from langchain.callbacks.streamlit import StreamlitCallbackHandler
 
-callback_manager = CallbackManager([StreamingStdOutCallbackHandler()])
-model = GPT4All(model="./models/gpt4all-model.bin", n_ctx=512, n_threads=8, callback_handler=callback_handler, verbose=True)
+callbacks = [StreamingStdOutCallbackHandler()]
+model = GPT4All(model="./models/gpt4all-model.bin", n_ctx=512, n_threads=8)
 
 # Generate text. Tokens are streamed through the callback manager.
-model("Once upon a time, ")
+model("Once upon a time, ", callbacks=callbacks)
 ```
 
 ## Model File

docs/ecosystem/lancedb.md

@@ -0,0 +1,23 @@
+# LanceDB
+
+This page covers how to use [LanceDB](https://github.com/lancedb/lancedb) within LangChain.
+It is broken into two parts: installation and setup, and then references to specific LanceDB wrappers.
+
+## Installation and Setup
+
+- Install the Python SDK with `pip install lancedb`
+
+## Wrappers
+
+### VectorStore
+
+There exists a wrapper around LanceDB databases, allowing you to use it as a vectorstore,
+whether for semantic search or example selection.
+
+To import this vectorstore:
+
+```python
+from langchain.vectorstores import LanceDB
+```
+
+For a more detailed walkthrough of the LanceDB wrapper, see [this notebook](../modules/indexes/vectorstores/examples/lancedb.ipynb)

docs/ecosystem/metal.md

@@ -0,0 +1,26 @@
+# Metal
+
+This page covers how to use [Metal](https://getmetal.io) within LangChain.
+
+## What is Metal?
+
+Metal is a  managed retrieval & memory platform built for production. Easily index your data into `Metal` and run semantic search and retrieval on it.
+
+![Metal](../_static/MetalDash.png)
+
+## Quick start
+
+Get started by [creating a Metal account](https://app.getmetal.io/signup).
+
+Then, you can easily take advantage of the `MetalRetriever` class to start retrieving your data for semantic search, prompting context, etc. This class takes a `Metal` instance and a dictionary of parameters to pass to the Metal API.
+
+```python
+from langchain.retrievers import MetalRetriever
+from metal_sdk.metal import Metal
+
+
+metal = Metal("API_KEY", "CLIENT_ID", "INDEX_ID");
+retriever = MetalRetriever(metal, params={"limit": 2})
+
+docs = retriever.get_relevant_documents("search term")
+```

docs/ecosystem/pipelineai.md

@@ -0,0 +1,19 @@
+# PipelineAI
+
+This page covers how to use the PipelineAI ecosystem within LangChain.
+It is broken into two parts: installation and setup, and then references to specific PipelineAI wrappers.
+
+## Installation and Setup
+
+- Install with `pip install pipeline-ai`
+- Get a Pipeline Cloud api key and set it as an environment variable (`PIPELINE_API_KEY`)
+
+## Wrappers
+
+### LLM
+
+There exists a PipelineAI LLM wrapper, which you can access with
+
+```python
+from langchain.llms import PipelineAI
+```

docs/ecosystem/predictionguard.md

@@ -0,0 +1,56 @@
+# Prediction Guard
+
+This page covers how to use the Prediction Guard ecosystem within LangChain.
+It is broken into two parts: installation and setup, and then references to specific Prediction Guard wrappers.
+
+## Installation and Setup
+- Install the Python SDK with `pip install predictionguard`
+- Get an Prediction Guard access token (as described [here](https://docs.predictionguard.com/)) and set it as an environment variable (`PREDICTIONGUARD_TOKEN`)
+
+## LLM Wrapper
+
+There exists a Prediction Guard LLM wrapper, which you can access with 
+```python
+from langchain.llms import PredictionGuard
+```
+
+You can provide the name of your Prediction Guard "proxy" as an argument when initializing the LLM:
+```python
+pgllm = PredictionGuard(name="your-text-gen-proxy")
+```
+
+Alternatively, you can use Prediction Guard's default proxy for SOTA LLMs:
+```python
+pgllm = PredictionGuard(name="default-text-gen")
+```
+
+You can also provide your access token directly as an argument:
+```python
+pgllm = PredictionGuard(name="default-text-gen", token="<your access token>")
+```
+
+## Example usage
+
+Basic usage of the LLM wrapper:
+```python
+from langchain.llms import PredictionGuard
+
+pgllm = PredictionGuard(name="default-text-gen")
+pgllm("Tell me a joke")
+```
+
+Basic LLM Chaining with the Prediction Guard wrapper:
+```python
+from langchain import PromptTemplate, LLMChain
+from langchain.llms import PredictionGuard
+
+template = """Question: {question}
+
+Answer: Let's think step by step."""
+prompt = PromptTemplate(template=template, input_variables=["question"])
+llm_chain = LLMChain(prompt=prompt, llm=PredictionGuard(name="default-text-gen"), verbose=True)
+
+question = "What NFL team won the Super Bowl in the year Justin Beiber was born?"
+
+llm_chain.predict(question=question)
+```

docs/ecosystem/redis.md

@@ -0,0 +1,79 @@
+# Redis
+
+This page covers how to use the [Redis](https://redis.com) ecosystem within LangChain.
+It is broken into two parts: installation and setup, and then references to specific Redis wrappers.
+
+## Installation and Setup
+- Install the Redis Python SDK with `pip install redis`
+
+## Wrappers
+
+### Cache
+
+The Cache wrapper allows for [Redis](https://redis.io) to be used as a remote, low-latency, in-memory cache for LLM prompts and responses.
+
+#### Standard Cache
+The standard cache is the Redis bread & butter of use case in production for both [open source](https://redis.io) and [enterprise](https://redis.com) users globally.
+
+To import this cache:
+```python
+from langchain.cache import RedisCache
+```
+
+To use this cache with your LLMs:
+```python
+import langchain
+import redis
+
+redis_client = redis.Redis.from_url(...)
+langchain.llm_cache = RedisCache(redis_client)
+```
+
+#### Semantic Cache
+Semantic caching allows users to retrieve cached prompts based on semantic similarity between the user input and previously cached results. Under the hood it blends Redis as both a cache and a vectorstore.
+
+To import this cache:
+```python
+from langchain.cache import RedisSemanticCache
+```
+
+To use this cache with your LLMs:
+```python
+import langchain
+import redis
+
+# use any embedding provider...
+from tests.integration_tests.vectorstores.fake_embeddings import FakeEmbeddings
+
+redis_url = "redis://localhost:6379"
+
+langchain.llm_cache = RedisSemanticCache(
+    embedding=FakeEmbeddings(),
+    redis_url=redis_url
+)
+```
+
+### VectorStore
+
+The vectorstore wrapper turns Redis into a low-latency [vector database](https://redis.com/solutions/use-cases/vector-database/) for semantic search or LLM content retrieval.
+
+To import this vectorstore:
+```python
+from langchain.vectorstores import Redis
+```
+
+For a more detailed walkthrough of the Redis vectorstore wrapper, see [this notebook](../modules/indexes/vectorstores/examples/redis.ipynb).
+
+### Retriever
+
+The Redis vector store retriever wrapper generalizes the vectorstore class to perform low-latency document retrieval. To create the retriever, simply call `.as_retriever()` on the base vectorstore class.
+
+### Memory
+Redis can be used to persist LLM conversations.
+
+#### Vector Store Retriever Memory
+
+For a more detailed walkthrough of the `VectorStoreRetrieverMemory` wrapper, see [this notebook](../modules/memory/types/vectorstore_retriever_memory.ipynb).
+
+#### Chat Message History Memory
+For a detailed example of Redis to cache conversation message history, see [this notebook](../modules/memory/examples/redis_chat_message_history.ipynb).

docs/ecosystem/replicate.md

@@ -9,7 +9,7 @@ This page covers how to run models on Replicate within LangChain.
 
 Find a model on the [Replicate explore page](https://replicate.com/explore), and then paste in the model name and version in this format: `owner-name/model-name:version`
 
-For example, for this [flan-t5 model](https://replicate.com/daanelson/flan-t5), click on the API tab. The model name/version would be: `daanelson/flan-t5:04e422a9b85baed86a4f24981d7f9953e20c5fd82f6103b74ebc431588e1cec8`
+For example, for this [dolly model](https://replicate.com/replicate/dolly-v2-12b), click on the API tab. The model name/version would be: `"replicate/dolly-v2-12b:ef0e1aefc61f8e096ebe4db6b2bacc297daf2ef6899f0f7e001ec445893500e5"`
 
 Only the `model` param is required, but any other model parameters can also be passed in with the format `input={model_param: value, ...}`
 
@@ -24,7 +24,7 @@ Replicate(model="stability-ai/stable-diffusion:db21e45d3f7023abc2a46ee38a23973f6
 From here, we can initialize our model:
 
 ```python
-llm = Replicate(model="daanelson/flan-t5:04e422a9b85baed86a4f24981d7f9953e20c5fd82f6103b74ebc431588e1cec8")
+llm = Replicate(model="replicate/dolly-v2-12b:ef0e1aefc61f8e096ebe4db6b2bacc297daf2ef6899f0f7e001ec445893500e5")
 ```
 
 And run it:
@@ -40,8 +40,7 @@ llm(prompt)
 We can call any Replicate model (not just LLMs) using this syntax. For example, we can call [Stable Diffusion](https://replicate.com/stability-ai/stable-diffusion):
 
 ```python
-text2image = Replicate(model="stability-ai/stable-diffusion:db21e45d3f7023abc2a46ee38a23973f6dce16bb082a930b0c49861f96d1e5bf",
-                       input={'image_dimensions'='512x512'}
+text2image = Replicate(model="stability-ai/stable-diffusion:db21e45d3f7023abc2a46ee38a23973f6dce16bb082a930b0c49861f96d1e5bf", input={'image_dimensions':'512x512'})
 
 image_output = text2image("A cat riding a motorcycle by Picasso")
 ```

docs/ecosystem/tair.md

@@ -0,0 +1,22 @@
+# Tair
+
+This page covers how to use the Tair ecosystem within LangChain.
+
+## Installation and Setup
+
+Install Tair Python SDK with `pip install tair`.
+
+## Wrappers
+
+### VectorStore
+
+There exists a wrapper around TairVector, allowing you to use it as a vectorstore,
+whether for semantic search or example selection.
+
+To import this vectorstore:
+
+```python
+from langchain.vectorstores import Tair
+```
+
+For a more detailed walkthrough of the Tair wrapper, see [this notebook](../modules/indexes/vectorstores/examples/tair.ipynb)

docs/ecosystem/unstructured.md

@@ -10,6 +10,10 @@ This page is broken into two parts: installation and setup, and then references
 `unstructured` wrappers.
 
 ## Installation and Setup
+
+If you are using a loader that runs locally, use the following steps to get `unstructured` and
+its dependencies running locally.
+
 - Install the Python SDK with `pip install "unstructured[local-inference]"`
 - Install the following system dependencies if they are not already available on your system.
   Depending on what document types you're parsing, you may not need all of these.
@@ -25,6 +29,15 @@ This page is broken into two parts: installation and setup, and then references
       using the `"fast"` strategy, which uses `pdfminer` directly and doesn't require
       `detectron2`.
 
+If you want to get up and running with less set up, you can
+simply run `pip install unstructured` and use `UnstructuredAPIFileLoader` or
+`UnstructuredAPIFileIOLoader`. That will process your document using the hosted Unstructured API.
+Note that currently (as of 1 May 2023) the Unstructured API is open, but it will soon require
+an API. The [Unstructured documentation page](https://unstructured-io.github.io/) will have
+instructions on how to generate an API key once they're available. Check out the instructions
+[here](https://github.com/Unstructured-IO/unstructured-api#dizzy-instructions-for-using-the-docker-image)
+if you'd like to self-host the Unstructured API or run it locally.
+
 ## Wrappers
 
 ### Data Loaders

docs/ecosystem/wandb_tracking.ipynb

@@ -50,7 +50,6 @@
    "source": [
     "from datetime import datetime\n",
     "from langchain.callbacks import WandbCallbackHandler, StdOutCallbackHandler\n",
-    "from langchain.callbacks.base import CallbackManager\n",
     "from langchain.llms import OpenAI"
    ]
   },
@@ -196,8 +195,8 @@
     "    name=\"llm\",\n",
     "    tags=[\"test\"],\n",
     ")\n",
-    "manager = CallbackManager([StdOutCallbackHandler(), wandb_callback])\n",
-    "llm = OpenAI(temperature=0, callback_manager=manager, verbose=True)"
+    "callbacks = [StdOutCallbackHandler(), wandb_callback]\n",
+    "llm = OpenAI(temperature=0, callbacks=callbacks)"
    ]
   },
   {
@@ -484,7 +483,7 @@
     "Title: {title}\n",
     "Playwright: This is a synopsis for the above play:\"\"\"\n",
     "prompt_template = PromptTemplate(input_variables=[\"title\"], template=template)\n",
-    "synopsis_chain = LLMChain(llm=llm, prompt=prompt_template, callback_manager=manager)\n",
+    "synopsis_chain = LLMChain(llm=llm, prompt=prompt_template, callbacks=callbacks)\n",
     "\n",
     "test_prompts = [\n",
     "    {\n",
@@ -577,16 +576,15 @@
    ],
    "source": [
     "# SCENARIO 3 - Agent with Tools\n",
-    "tools = load_tools([\"serpapi\", \"llm-math\"], llm=llm, callback_manager=manager)\n",
+    "tools = load_tools([\"serpapi\", \"llm-math\"], llm=llm)\n",
     "agent = initialize_agent(\n",
     "    tools,\n",
     "    llm,\n",
     "    agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION,\n",
-    "    callback_manager=manager,\n",
-    "    verbose=True,\n",
     ")\n",
     "agent.run(\n",
-    "    \"Who is Leo DiCaprio's girlfriend? What is her current age raised to the 0.43 power?\"\n",
+    "    \"Who is Leo DiCaprio's girlfriend? What is her current age raised to the 0.43 power?\",\n",
+    "    callbacks=callbacks,\n",
     ")\n",
     "wandb_callback.flush_tracker(agent, reset=False, finish=True)"
    ]

docs/gallery.rst

@@ -343,4 +343,12 @@ Proprietary
     +++
 
     A journaling app for self-care that uses AI to uncover insights and patterns over time.
-    
+
+
+Articles on **Google Scholar**
+-----------------------------
+
+LangChain is used in many scientific and research projects.
+
+**Google Scholar** presents a `list of the papers <https://scholar.google.com/scholar?q=%22langchain%22&hl=en&as_sdt=0,5&as_vis=1>`_
+with references to LangChain.

docs/getting_started/getting_started.md

@@ -172,9 +172,9 @@ In order to load agents, you should understand the following concepts:
 - LLM: The language model powering the agent.
 - Agent: The agent to use. This should be a string that references a support agent class. Because this notebook focuses on the simplest, highest level API, this only covers using the standard supported agents. If you want to implement a custom agent, see the documentation for custom agents (coming soon).
 
-**Agents**: For a list of supported agents and their specifications, see [here](../modules/agents/agents.md).
+**Agents**: For a list of supported agents and their specifications, see [here](../modules/agents/getting_started.ipynb).
 
-**Tools**: For a list of predefined tools and their specifications, see [here](../modules/agents/tools.md).
+**Tools**: For a list of predefined tools and their specifications, see [here](../modules/agents/tools/getting_started.md).
 
 For this example, you will also need to install the SerpAPI Python package.
 
@@ -316,7 +316,7 @@ You can also pass in multiple messages for OpenAI's gpt-3.5-turbo and gpt-4 mode
 ```python
 messages = [
     SystemMessage(content="You are a helpful assistant that translates English to French."),
-    HumanMessage(content="Translate this sentence from English to French. I love programming.")
+    HumanMessage(content="I love programming.")
 ]
 chat(messages)
 # -> AIMessage(content="J'aime programmer.", additional_kwargs={})
@@ -327,29 +327,29 @@ You can go one step further and generate completions for multiple sets of messag
 batch_messages = [
     [
         SystemMessage(content="You are a helpful assistant that translates English to French."),
-        HumanMessage(content="Translate this sentence from English to French. I love programming.")
+        HumanMessage(content="I love programming.")
     ],
     [
         SystemMessage(content="You are a helpful assistant that translates English to French."),
-        HumanMessage(content="Translate this sentence from English to French. I love artificial intelligence.")
+        HumanMessage(content="I love artificial intelligence.")
     ],
 ]
 result = chat.generate(batch_messages)
 result
-# -> LLMResult(generations=[[ChatGeneration(text="J'aime programmer.", generation_info=None, message=AIMessage(content="J'aime programmer.", additional_kwargs={}))], [ChatGeneration(text="J'aime l'intelligence artificielle.", generation_info=None, message=AIMessage(content="J'aime l'intelligence artificielle.", additional_kwargs={}))]], llm_output={'token_usage': {'prompt_tokens': 71, 'completion_tokens': 18, 'total_tokens': 89}})
+# -> LLMResult(generations=[[ChatGeneration(text="J'aime programmer.", generation_info=None, message=AIMessage(content="J'aime programmer.", additional_kwargs={}))], [ChatGeneration(text="J'aime l'intelligence artificielle.", generation_info=None, message=AIMessage(content="J'aime l'intelligence artificielle.", additional_kwargs={}))]], llm_output={'token_usage': {'prompt_tokens': 57, 'completion_tokens': 20, 'total_tokens': 77}})
 ```
 
 You can recover things like token usage from this LLMResult:
 ```
 result.llm_output['token_usage']
-# -> {'prompt_tokens': 71, 'completion_tokens': 18, 'total_tokens': 89}
+# -> {'prompt_tokens': 57, 'completion_tokens': 20, 'total_tokens': 77}
 ```
 
 
 ## Chat Prompt Templates
 Similar to LLMs, you can make use of templating by using a `MessagePromptTemplate`. You can build a `ChatPromptTemplate` from one or more `MessagePromptTemplate`s. You can use `ChatPromptTemplate`'s `format_prompt` -- this returns a `PromptValue`, which you can convert to a string or `Message` object, depending on whether you want to use the formatted value as input to an llm or chat model.
 
-For convience, there is a `from_template` method exposed on the template. If you were to use this template, this is what it would look like:
+For convenience, there is a `from_template` method exposed on the template. If you were to use this template, this is what it would look like:
 
 ```python
 from langchain.chat_models import ChatOpenAI
@@ -361,9 +361,9 @@ from langchain.prompts.chat import (
 
 chat = ChatOpenAI(temperature=0)
 
-template="You are a helpful assistant that translates {input_language} to {output_language}."
+template = "You are a helpful assistant that translates {input_language} to {output_language}."
 system_message_prompt = SystemMessagePromptTemplate.from_template(template)
-human_template="{text}"
+human_template = "{text}"
 human_message_prompt = HumanMessagePromptTemplate.from_template(human_template)
 
 chat_prompt = ChatPromptTemplate.from_messages([system_message_prompt, human_message_prompt])
@@ -387,9 +387,9 @@ from langchain.prompts.chat import (
 
 chat = ChatOpenAI(temperature=0)
 
-template="You are a helpful assistant that translates {input_language} to {output_language}."
+template = "You are a helpful assistant that translates {input_language} to {output_language}."
 system_message_prompt = SystemMessagePromptTemplate.from_template(template)
-human_template="{text}"
+human_template = "{text}"
 human_message_prompt = HumanMessagePromptTemplate.from_template(human_template)
 chat_prompt = ChatPromptTemplate.from_messages([system_message_prompt, human_message_prompt])
 

docs/index.rst

@@ -44,6 +44,8 @@ These modules are, in increasing order of complexity:
 
 - `Agents <./modules/agents.html>`_: Agents involve an LLM making decisions about which Actions to take, taking that Action, seeing an Observation, and repeating that until done. LangChain provides a standard interface for agents, a selection of agents to choose from, and examples of end to end agents.
 
+- `Callbacks <./modules/callbacks/getting_started.html>`_: It can be difficult to track all that occurs inside a chain or agent - callbacks help add a level of observability and introspection.
+
 
 .. toctree::
    :maxdepth: 1
@@ -57,6 +59,7 @@ These modules are, in increasing order of complexity:
    ./modules/memory.md
    ./modules/chains.md
    ./modules/agents.md
+   ./modules/callbacks/getting_started.ipynb
 
 Use Cases
 ----------

docs/modules/agents.rst

@@ -10,6 +10,30 @@ but potentially an unknown chain that depends on the user's input.
 In these types of chains, there is a “agent” which has access to a suite of tools.
 Depending on the user input, the agent can then decide which, if any, of these tools to call.
 
+High level pseudocode of agents looks something like:
+
+- Some user input is received
+- The `agent` decides which `tool` - if any - to use, and what the input to that tool should be
+- That `tool` is then called with that `tool input`, and an `observation` is recorded (this is just the output of calling that tool with that tool input.
+- That history of `tool`, `tool input`, and `observation` is passed back into the `agent`, and it decides what steps to take next
+- This is repeated until the `agent` decides it no longer needs to use a `tool`, and then it responds directly to the user.
+
+The different abstractions involved in agents are as follows:
+
+- Agent: this is where the logic of the application lives. Agents expose an interface that takes in user input along with a list of previous steps the agent has taken, and returns either an `AgentAction` or `AgentFinish`
+    - `AgentAction` corresponds to the tool to use and the input to that tool
+    - `AgentFinish` means the agent is done, and has information around what to return to the user
+- Tools: these are the actions an agent can take. What tools you give an agent highly depend on what you want the agent to do
+- Toolkits: these are groups of tools designed for a specific use case. For example, in order for an agent to interact with a SQL database in the best way it may need access to one tool to execute queries and another tool to inspect tables.
+- Agent Executor: this wraps an agent and a list of tools. This is responsible for the loop of running the agent iteratively until the stopping criteria is met.
+
+The most important abstraction of the four above to understand is that of the agent.
+Although an agent can be defined in whatever way one chooses, the typical way to construct an agent is with:
+
+- PromptTemplate: this is responsible for taking the user input and previous steps and constructing a prompt to send to the language model
+- Language Model: this takes the prompt constructed by the PromptTemplate and returns some output
+- Output Parser: this takes the output of the Language Model and parses it into an `AgentAction` or `AgentFinish` object.
+
 In this section of documentation, we first start with a Getting Started notebook to cover how to use all things related to agents in an end-to-end manner.
 
 .. toctree::
@@ -23,22 +47,27 @@ We then split the documentation into the following sections:
 
 **Tools**
 
-An overview of the various tools LangChain supports.
+In this section we cover the different types of tools LangChain supports natively.
+We then cover how to add your own tools.
 
 
 **Agents**
 
-An overview of the different agent types.
+In this section we cover the different types of agents LangChain supports natively.
+We then cover how to modify and create your own agents.
 
 
 **Toolkits**
 
-An overview of toolkits, and examples of the different ones LangChain supports.
+In this section we go over the various toolkits that LangChain supports out of the box,
+and how to create an agent from them.
 
 
 **Agent Executor**
 
-An overview of the Agent Executor class and examples of how to use it.
+In this section we go over the Agent Executor class, which is responsible for calling
+the agent and tools in a loop. We go over different ways to customize this, and options you
+can use for more control.
 
 Go Deeper
 ---------

docs/modules/agents/agent_executors/examples/async_agent.ipynb

@@ -9,9 +9,9 @@
     "\n",
     "LangChain provides async support for Agents by leveraging the [asyncio](https://docs.python.org/3/library/asyncio.html) library.\n",
     "\n",
-    "Async methods are currently supported for the following `Tools`: [`SerpAPIWrapper`](https://github.com/hwchase17/langchain/blob/master/langchain/serpapi.py) and [`LLMMathChain`](https://github.com/hwchase17/langchain/blob/master/langchain/chains/llm_math/base.py). Async support for other agent tools are on the roadmap.\n",
+    "Async methods are currently supported for the following `Tools`: [`GoogleSerperAPIWrapper`](https://github.com/hwchase17/langchain/blob/master/langchain/utilities/google_serper.py), [`SerpAPIWrapper`](https://github.com/hwchase17/langchain/blob/master/langchain/serpapi.py) and [`LLMMathChain`](https://github.com/hwchase17/langchain/blob/master/langchain/chains/llm_math/base.py). Async support for other agent tools are on the roadmap.\n",
     "\n",
-    "For `Tool`s that have a `coroutine` implemented (the two mentioned above), the `AgentExecutor` will `await` them directly. Otherwise, the `AgentExecutor` will call the `Tool`'s `func` via `asyncio.get_event_loop().run_in_executor` to avoid blocking the main runloop.\n",
+    "For `Tool`s that have a `coroutine` implemented (the three mentioned above), the `AgentExecutor` will `await` them directly. Otherwise, the `AgentExecutor` will call the `Tool`'s `func` via `asyncio.get_event_loop().run_in_executor` to avoid blocking the main runloop.\n",
     "\n",
     "You can use `arun` to call an `AgentExecutor` asynchronously."
    ]
@@ -28,10 +28,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 5,
    "id": "da5df06c-af6f-4572-b9f5-0ab971c16487",
    "metadata": {
-    "tags": []
+    "tags": [],
+    "ExecuteTime": {
+     "end_time": "2023-05-04T01:27:22.755025Z",
+     "start_time": "2023-05-04T01:27:22.754041Z"
+    }
    },
    "outputs": [],
    "source": [
@@ -42,7 +46,6 @@
     "from langchain.agents import AgentType\n",
     "from langchain.llms import OpenAI\n",
     "from langchain.callbacks.stdout import StdOutCallbackHandler\n",
-    "from langchain.callbacks.base import CallbackManager\n",
     "from langchain.callbacks.tracers import LangChainTracer\n",
     "from aiohttp import ClientSession\n",
     "\n",
@@ -57,10 +60,14 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "id": "fd4c294e-b1d6-44b8-b32e-2765c017e503",
    "metadata": {
-    "tags": []
+    "tags": [],
+    "ExecuteTime": {
+     "end_time": "2023-05-04T01:15:35.466212Z",
+     "start_time": "2023-05-04T01:14:05.452245Z"
+    }
    },
    "outputs": [
     {
@@ -69,119 +76,105 @@
      "text": [
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who won the US Open men's final in 2019 and then calculate his age raised to the 0.334 power.\n",
-      "Action: Search\n",
-      "Action Input: \"US Open men's final 2019 winner\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mRafael Nadal\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Rafael Nadal's age\n",
-      "Action: Search\n",
-      "Action Input: \"Rafael Nadal age\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m36 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate 36 raised to the 0.334 power\n",
+      "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n",
+      "\u001B[32;1m\u001B[1;3m I need to find out who won the US Open men's final in 2019 and then calculate his age raised to the 0.334 power.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"Who won the US Open men's final in 2019?\"\u001B[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3mRafael Nadal defeated Daniil Medvedev in the final, 7–5, 6–3, 5–7, 4–6, 6–4 to win the men's singles tennis title at the 2019 US Open. It was his fourth US ... Draw: 128 (16 Q / 8 WC). Champion: Rafael Nadal. Runner-up: Daniil Medvedev. Score: 7–5, 6–3, 5–7, 4–6, 6–4. Bianca Andreescu won the women's singles title, defeating Serena Williams in straight sets in the final, becoming the first Canadian to win a Grand Slam singles ... Rafael Nadal won his 19th career Grand Slam title, and his fourth US Open crown, by surviving an all-time comback effort from Daniil ... Rafael Nadal beats Daniil Medvedev in US Open final to claim 19th major title. World No2 claims 7-5, 6-3, 5-7, 4-6, 6-4 victory over Russian ... Rafael Nadal defeated Daniil Medvedev in the men's singles final of the U.S. Open on Sunday. Rafael Nadal survived. The 33-year-old defeated Daniil Medvedev in the final of the 2019 U.S. Open to earn his 19th Grand Slam title Sunday ... NEW YORK -- Rafael Nadal defeated Daniil Medvedev in an epic five-set match, 7-5, 6-3, 5-7, 4-6, 6-4 to win the men's singles title at the ... Nadal previously won the U.S. Open three times, most recently in 2017. Ahead of the match, Nadal said he was “super happy to be back in the ... Watch the full match between Daniil Medvedev and Rafael ... Duration: 4:47:32. Posted: Mar 20, 2020. US Open 2019: Rafael Nadal beats Daniil Medvedev · Updated: Sep. 08, 2019, 11:11 p.m. |; Published: Sep · Published: Sep. 08, 2019, 10:06 p.m.. 26. US Open ...\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I now know that Rafael Nadal won the US Open men's final in 2019 and he is 33 years old.\n",
       "Action: Calculator\n",
-      "Action Input: 36^0.334\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 3.3098250249682484\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Rafael Nadal, aged 36, won the US Open men's final in 2019 and his age raised to the 0.334 power is 3.3098250249682484.\u001b[0m\n",
+      "Action Input: 33^0.334\u001B[0m\n",
+      "Observation: \u001B[33;1m\u001B[1;3mAnswer: 3.215019829667466\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I now know the final answer.\n",
+      "Final Answer: Rafael Nadal won the US Open men's final in 2019 and his age raised to the 0.334 power is 3.215019829667466.\u001B[0m\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\u001B[1m> Finished chain.\u001B[0m\n",
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who Olivia Wilde's boyfriend is and then calculate his age raised to the 0.23 power.\n",
-      "Action: Search\n",
-      "Action Input: \"Olivia Wilde boyfriend\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mJason Sudeikis\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Jason Sudeikis' age\n",
-      "Action: Search\n",
-      "Action Input: \"Jason Sudeikis age\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m47 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate 47 raised to the 0.23 power\n",
+      "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n",
+      "\u001B[32;1m\u001B[1;3m I need to find out who Olivia Wilde's boyfriend is and then calculate his age raised to the 0.23 power.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"Olivia Wilde boyfriend\"\u001B[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3mSudeikis and Wilde's relationship ended in November 2020. Wilde was publicly served with court documents regarding child custody while she was presenting Don't Worry Darling at CinemaCon 2022. In January 2021, Wilde began dating singer Harry Styles after meeting during the filming of Don't Worry Darling.\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I need to find out Harry Styles' age.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"Harry Styles age\"\u001B[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3m29 years\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I need to calculate 29 raised to the 0.23 power.\n",
       "Action: Calculator\n",
-      "Action Input: 47^0.23\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 2.4242784855673896\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Jason Sudeikis, Olivia Wilde's boyfriend, is 47 years old and his age raised to the 0.23 power is 2.4242784855673896.\u001b[0m\n",
+      "Action Input: 29^0.23\u001B[0m\n",
+      "Observation: \u001B[33;1m\u001B[1;3mAnswer: 2.169459462491557\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I now know the final answer.\n",
+      "Final Answer: Harry Styles is Olivia Wilde's boyfriend and his current age raised to the 0.23 power is 2.169459462491557.\u001B[0m\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\u001B[1m> Finished chain.\u001B[0m\n",
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who won the grand prix and then calculate their age raised to the 0.23 power.\n",
-      "Action: Search\n",
-      "Action Input: \"Formula 1 Grand Prix Winner\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mMax Verstappen\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Max Verstappen's age\n",
-      "Action: Search\n",
-      "Action Input: \"Max Verstappen Age\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m25 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate 25 raised to the 0.23 power\n",
+      "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n",
+      "\u001B[32;1m\u001B[1;3m I need to find out who won the most recent grand prix and then calculate their age raised to the 0.23 power.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"who won the most recent formula 1 grand prix\"\u001B[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3mMax Verstappen won his first Formula 1 world title on Sunday after the championship was decided by a last-lap overtake of his rival Lewis Hamilton in the Abu Dhabi Grand Prix. Dec 12, 2021\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I need to find out Max Verstappen's age\n",
+      "Action: Google Serper\n",
+      "Action Input: \"Max Verstappen age\"\u001B[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3m25 years\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I need to calculate 25 raised to the 0.23 power\n",
       "Action: Calculator\n",
-      "Action Input: 25^0.23\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 1.84599359907945\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Max Verstappen, 25 years old, raised to the 0.23 power is 1.84599359907945.\u001b[0m\n",
+      "Action Input: 25^0.23\u001B[0m\n",
+      "Observation: \u001B[33;1m\u001B[1;3mAnswer: 2.096651272316035\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I now know the final answer\n",
+      "Final Answer: Max Verstappen, aged 25, won the most recent Formula 1 grand prix and his age raised to the 0.23 power is 2.096651272316035.\u001B[0m\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\u001B[1m> Finished chain.\u001B[0m\n",
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who won the US Open women's final in 2019 and then calculate her age raised to the 0.34 power.\n",
-      "Action: Search\n",
-      "Action Input: \"US Open women's final 2019 winner\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mBianca Andreescu defeated Serena Williams in the final, 6–3, 7–5 to win the women's singles tennis title at the 2019 US Open. It was her first major title, and she became the first Canadian, as well as the first player born in the 2000s, to win a major singles title.\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Bianca Andreescu's age.\n",
-      "Action: Search\n",
-      "Action Input: \"Bianca Andreescu age\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m22 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the age of Bianca Andreescu and can calculate her age raised to the 0.34 power.\n",
+      "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n",
+      "\u001B[32;1m\u001B[1;3m I need to find out who won the US Open women's final in 2019 and then calculate her age raised to the 0.34 power.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"US Open women's final 2019 winner\"\u001B[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3mWHAT HAPPENED: #SheTheNorth? She the champion. Nineteen-year-old Canadian Bianca Andreescu sealed her first Grand Slam title on Saturday, downing 23-time major champion Serena Williams in the 2019 US Open women's singles final, 6-3, 7-5. Sep 7, 2019\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I now need to calculate her age raised to the 0.34 power.\n",
       "Action: Calculator\n",
-      "Action Input: 22^0.34\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 2.8603798598506933\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer.\n",
-      "Final Answer: Bianca Andreescu won the US Open women's final in 2019 and her age raised to the 0.34 power is 2.8603798598506933.\u001b[0m\n",
+      "Action Input: 19^0.34\u001B[0m\n",
+      "Observation: \u001B[33;1m\u001B[1;3mAnswer: 2.7212987634680084\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I now know the final answer.\n",
+      "Final Answer: Nineteen-year-old Canadian Bianca Andreescu won the US Open women's final in 2019 and her age raised to the 0.34 power is 2.7212987634680084.\u001B[0m\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\u001B[1m> Finished chain.\u001B[0m\n",
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who Beyonce's husband is and then calculate his age raised to the 0.19 power.\n",
-      "Action: Search\n",
-      "Action Input: \"Who is Beyonce's husband?\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mJay-Z\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Jay-Z's age\n",
-      "Action: Search\n",
-      "Action Input: \"How old is Jay-Z?\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m53 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate 53 raised to the 0.19 power\n",
+      "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n",
+      "\u001B[32;1m\u001B[1;3m I need to find out who Beyonce's husband is and then calculate his age raised to the 0.19 power.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"Who is Beyonce's husband?\"\u001B[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3mJay-Z\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I need to find out Jay-Z's age\n",
+      "Action: Google Serper\n",
+      "Action Input: \"How old is Jay-Z?\"\u001B[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3m53 years\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I need to calculate 53 raised to the 0.19 power\n",
       "Action: Calculator\n",
-      "Action Input: 53^0.19\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 2.12624064206896\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Jay-Z is Beyonce's husband and his age raised to the 0.19 power is 2.12624064206896.\u001b[0m\n",
+      "Action Input: 53^0.19\u001B[0m\n",
+      "Observation: \u001B[33;1m\u001B[1;3mAnswer: 2.12624064206896\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I now know the final answer\n",
+      "Final Answer: Jay-Z is Beyonce's husband and his age raised to the 0.19 power is 2.12624064206896.\u001B[0m\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "Serial executed in 65.11 seconds.\n"
+      "\u001B[1m> Finished chain.\u001B[0m\n",
+      "Serial executed in 89.97 seconds.\n"
      ]
     }
    ],
    "source": [
-    "def generate_serially():\n",
-    "    for q in questions:\n",
-    "        llm = OpenAI(temperature=0)\n",
-    "        tools = load_tools([\"llm-math\", \"serpapi\"], llm=llm)\n",
-    "        agent = initialize_agent(\n",
-    "            tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True\n",
-    "        )\n",
-    "        agent.run(q)\n",
+    "llm = OpenAI(temperature=0)\n",
+    "tools = load_tools([\"google-serper\", \"llm-math\"], llm=llm)\n",
+    "agent = initialize_agent(\n",
+    "    tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True\n",
+    ")\n",
     "\n",
     "s = time.perf_counter()\n",
-    "generate_serially()\n",
+    "for q in questions:\n",
+    "    agent.run(q)\n",
     "elapsed = time.perf_counter() - s\n",
     "print(f\"Serial executed in {elapsed:0.2f} seconds.\")"
    ]
@@ -191,7 +184,11 @@
    "execution_count": 4,
    "id": "076d7b85-45ec-465d-8b31-c2ad119c3438",
    "metadata": {
-    "tags": []
+    "tags": [],
+    "ExecuteTime": {
+     "end_time": "2023-05-04T01:26:59.737657Z",
+     "start_time": "2023-05-04T01:26:42.182078Z"
+    }
    },
    "outputs": [
     {
@@ -200,192 +197,95 @@
      "text": [
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n",
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n",
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n",
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n",
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who Olivia Wilde's boyfriend is and then calculate his age raised to the 0.23 power.\n",
-      "Action: Search\n",
-      "Action Input: \"Olivia Wilde boyfriend\"\u001b[0m\u001b[32;1m\u001b[1;3m I need to find out who Beyonce's husband is and then calculate his age raised to the 0.19 power.\n",
-      "Action: Search\n",
-      "Action Input: \"Who is Beyonce's husband?\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mJay-Z\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out who won the grand prix and then calculate their age raised to the 0.23 power.\n",
-      "Action: Search\n",
-      "Action Input: \"Formula 1 Grand Prix Winner\"\u001b[0m\u001b[32;1m\u001b[1;3m I need to find out who won the US Open women's final in 2019 and then calculate her age raised to the 0.34 power.\n",
-      "Action: Search\n",
-      "Action Input: \"US Open women's final 2019 winner\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mJason Sudeikis\u001b[0m\n",
+      "\u001B[1m> Entering new AgentExecutor chain...\u001B[0m\n",
+      "\u001B[32;1m\u001B[1;3m I need to find out who Olivia Wilde's boyfriend is and then calculate his age raised to the 0.23 power.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"Olivia Wilde boyfriend\"\u001B[0m\u001B[32;1m\u001B[1;3m I need to find out who Beyonce's husband is and then calculate his age raised to the 0.19 power.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"Who is Beyonce's husband?\"\u001B[0m\u001B[32;1m\u001B[1;3m I need to find out who won the most recent formula 1 grand prix and then calculate their age raised to the 0.23 power.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"most recent formula 1 grand prix winner\"\u001B[0m\u001B[32;1m\u001B[1;3m I need to find out who won the US Open men's final in 2019 and then calculate his age raised to the 0.334 power.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"Who won the US Open men's final in 2019?\"\u001B[0m\u001B[32;1m\u001B[1;3m I need to find out who won the US Open women's final in 2019 and then calculate her age raised to the 0.34 power.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"US Open women's final 2019 winner\"\u001B[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3mSudeikis and Wilde's relationship ended in November 2020. Wilde was publicly served with court documents regarding child custody while she was presenting Don't Worry Darling at CinemaCon 2022. In January 2021, Wilde began dating singer Harry Styles after meeting during the filming of Don't Worry Darling.\u001B[0m\n",
       "Thought:\n",
-      "Observation: \u001b[33;1m\u001b[1;3mMax Verstappen\u001b[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3mJay-Z\u001B[0m\n",
       "Thought:\n",
-      "Observation: \u001b[33;1m\u001b[1;3mBianca Andreescu defeated Serena Williams in the final, 6–3, 7–5 to win the women's singles tennis title at the 2019 US Open. It was her first major title, and she became the first Canadian, as well as the first player born in the 2000s, to win a major singles title.\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Jason Sudeikis' age\n",
-      "Action: Search\n",
-      "Action Input: \"Jason Sudeikis age\"\u001b[0m\u001b[32;1m\u001b[1;3m I need to find out Jay-Z's age\n",
-      "Action: Search\n",
-      "Action Input: \"How old is Jay-Z?\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m53 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out who won the US Open men's final in 2019 and then calculate his age raised to the 0.334 power.\n",
-      "Action: Search\n",
-      "Action Input: \"US Open men's final 2019 winner\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mRafael Nadal defeated Daniil Medvedev in the final, 7–5, 6–3, 5–7, 4–6, 6–4 to win the men's singles tennis title at the 2019 US Open. It was his fourth US ...\u001b[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3mRafael Nadal defeated Daniil Medvedev in the final, 7–5, 6–3, 5–7, 4–6, 6–4 to win the men's singles tennis title at the 2019 US Open. It was his fourth US ... Draw: 128 (16 Q / 8 WC). Champion: Rafael Nadal. Runner-up: Daniil Medvedev. Score: 7–5, 6–3, 5–7, 4–6, 6–4. Bianca Andreescu won the women's singles title, defeating Serena Williams in straight sets in the final, becoming the first Canadian to win a Grand Slam singles ... Rafael Nadal won his 19th career Grand Slam title, and his fourth US Open crown, by surviving an all-time comback effort from Daniil ... Rafael Nadal beats Daniil Medvedev in US Open final to claim 19th major title. World No2 claims 7-5, 6-3, 5-7, 4-6, 6-4 victory over Russian ... Rafael Nadal defeated Daniil Medvedev in the men's singles final of the U.S. Open on Sunday. Rafael Nadal survived. The 33-year-old defeated Daniil Medvedev in the final of the 2019 U.S. Open to earn his 19th Grand Slam title Sunday ... NEW YORK -- Rafael Nadal defeated Daniil Medvedev in an epic five-set match, 7-5, 6-3, 5-7, 4-6, 6-4 to win the men's singles title at the ... Nadal previously won the U.S. Open three times, most recently in 2017. Ahead of the match, Nadal said he was “super happy to be back in the ... Watch the full match between Daniil Medvedev and Rafael ... Duration: 4:47:32. Posted: Mar 20, 2020. US Open 2019: Rafael Nadal beats Daniil Medvedev · Updated: Sep. 08, 2019, 11:11 p.m. |; Published: Sep · Published: Sep. 08, 2019, 10:06 p.m.. 26. US Open ...\u001B[0m\n",
       "Thought:\n",
-      "Observation: \u001b[33;1m\u001b[1;3m47 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Max Verstappen's age\n",
-      "Action: Search\n",
-      "Action Input: \"Max Verstappen Age\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m25 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Bianca Andreescu's age.\n",
-      "Action: Search\n",
-      "Action Input: \"Bianca Andreescu age\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m22 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate 53 raised to the 0.19 power\n",
-      "Action: Calculator\n",
-      "Action Input: 53^0.19\u001b[0m\u001b[32;1m\u001b[1;3m I need to find out the age of the winner\n",
-      "Action: Search\n",
-      "Action Input: \"Rafael Nadal age\"\u001b[0m\u001b[32;1m\u001b[1;3m I need to calculate 47 raised to the 0.23 power\n",
-      "Action: Calculator\n",
-      "Action Input: 47^0.23\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m36 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate 25 raised to the 0.23 power\n",
-      "Action: Calculator\n",
-      "Action Input: 25^0.23\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 2.12624064206896\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the age of Bianca Andreescu and can calculate her age raised to the 0.34 power.\n",
-      "Action: Calculator\n",
-      "Action Input: 22^0.34\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 1.84599359907945\u001b[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3mWHAT HAPPENED: #SheTheNorth? She the champion. Nineteen-year-old Canadian Bianca Andreescu sealed her first Grand Slam title on Saturday, downing 23-time major champion Serena Williams in the 2019 US Open women's singles final, 6-3, 7-5. Sep 7, 2019\u001B[0m\n",
       "Thought:\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 2.4242784855673896\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now need to calculate his age raised to the 0.334 power\n",
+      "Observation: \u001B[36;1m\u001B[1;3mLewis Hamilton holds the record for the most race wins in Formula One history, with 103 wins to date. Michael Schumacher, the previous record holder, ... Michael Schumacher (top left) and Lewis Hamilton (top right) have each won the championship a record seven times during their careers, while Sebastian Vettel ( ... Grand Prix, Date, Winner, Car, Laps, Time. Bahrain, 05 Mar 2023, Max Verstappen VER, Red Bull Racing Honda RBPT, 57, 1:33:56.736. Saudi Arabia, 19 Mar 2023 ... The Red Bull driver Max Verstappen of the Netherlands celebrated winning his first Formula 1 world title at the Abu Dhabi Grand Prix. Perez wins sprint as Verstappen, Russell clash. Red Bull's Sergio Perez won the first sprint of the 2023 Formula One season after catching and passing Charles ... The most successful driver in the history of F1 is Lewis Hamilton. The man from Stevenage has won 103 Grands Prix throughout his illustrious career and is still ... Lewis Hamilton: 103. Max Verstappen: 37. Michael Schumacher: 91. Fernando Alonso: 32. Max Verstappen and Sergio Perez will race in a very different-looking Red Bull this weekend after the team unveiled a striking special livery for the Miami GP. Lewis Hamilton holds the record of most victories with 103, ahead of Michael Schumacher (91) and Sebastian Vettel (53). Schumacher also holds the record for the ... Lewis Hamilton holds the record for the most race wins in Formula One history, with 103 wins to date. Michael Schumacher, the previous record holder, is second ...\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I need to find out Harry Styles' age.\n",
+      "Action: Google Serper\n",
+      "Action Input: \"Harry Styles age\"\u001B[0m\u001B[32;1m\u001B[1;3m I need to find out Jay-Z's age\n",
+      "Action: Google Serper\n",
+      "Action Input: \"How old is Jay-Z?\"\u001B[0m\u001B[32;1m\u001B[1;3m I now know that Rafael Nadal won the US Open men's final in 2019 and he is 33 years old.\n",
       "Action: Calculator\n",
-      "Action Input: 36^0.334\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 2.8603798598506933\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Jay-Z is Beyonce's husband and his age raised to the 0.19 power is 2.12624064206896.\u001b[0m\n",
+      "Action Input: 33^0.334\u001B[0m\u001B[32;1m\u001B[1;3m I now need to calculate her age raised to the 0.34 power.\n",
+      "Action: Calculator\n",
+      "Action Input: 19^0.34\u001B[0m\n",
+      "Observation: \u001B[36;1m\u001B[1;3m29 years\u001B[0m\n",
+      "Thought:\n",
+      "Observation: \u001B[36;1m\u001B[1;3m53 years\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m Max Verstappen won the most recent Formula 1 grand prix.\n",
+      "Action: Calculator\n",
+      "Action Input: Max Verstappen's age (23) raised to the 0.23 power\u001B[0m\n",
+      "Observation: \u001B[33;1m\u001B[1;3mAnswer: 2.7212987634680084\u001B[0m\n",
+      "Thought:\n",
+      "Observation: \u001B[33;1m\u001B[1;3mAnswer: 3.215019829667466\u001B[0m\n",
+      "Thought:\u001B[32;1m\u001B[1;3m I need to calculate 29 raised to the 0.23 power.\n",
+      "Action: Calculator\n",
+      "Action Input: 29^0.23\u001B[0m\u001B[32;1m\u001B[1;3m I need to calculate 53 raised to the 0.19 power\n",
+      "Action: Calculator\n",
+      "Action Input: 53^0.19\u001B[0m\n",
+      "Observation: \u001B[33;1m\u001B[1;3mAnswer: 2.0568252837687546\u001B[0m\n",
+      "Thought:\n",
+      "Observation: \u001B[33;1m\u001B[1;3mAnswer: 2.169459462491557\u001B[0m\n",
+      "Thought:\n",
+      "\u001B[1m> Finished chain.\u001B[0m\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Max Verstappen, 25 years old, raised to the 0.23 power is 1.84599359907945.\u001b[0m\n",
+      "\u001B[1m> Finished chain.\u001B[0m\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "Observation: \u001B[33;1m\u001B[1;3mAnswer: 2.12624064206896\u001B[0m\n",
+      "Thought:\n",
+      "\u001B[1m> Finished chain.\u001B[0m\n",
       "\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 3.3098250249682484\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Jason Sudeikis, Olivia Wilde's boyfriend, is 47 years old and his age raised to the 0.23 power is 2.4242784855673896.\u001b[0m\n",
+      "\u001B[1m> Finished chain.\u001B[0m\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I now know the final answer.\n",
-      "Final Answer: Bianca Andreescu won the US Open women's final in 2019 and her age raised to the 0.34 power is 2.8603798598506933.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Rafael Nadal, aged 36, won the US Open men's final in 2019 and his age raised to the 0.334 power is 3.3098250249682484.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "Concurrent executed in 12.38 seconds.\n"
+      "\u001B[1m> Finished chain.\u001B[0m\n",
+      "Concurrent executed in 17.52 seconds.\n"
      ]
     }
    ],
    "source": [
-    "async def generate_concurrently():\n",
-    "    agents = []\n",
-    "    # To make async requests in Tools more efficient, you can pass in your own aiohttp.ClientSession, \n",
-    "    # but you must manually close the client session at the end of your program/event loop\n",
-    "    aiosession = ClientSession()\n",
-    "    for _ in questions:\n",
-    "        manager = CallbackManager([StdOutCallbackHandler()])\n",
-    "        llm = OpenAI(temperature=0, callback_manager=manager)\n",
-    "        async_tools = load_tools([\"llm-math\", \"serpapi\"], llm=llm, aiosession=aiosession, callback_manager=manager)\n",
-    "        agents.append(\n",
-    "            initialize_agent(async_tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True, callback_manager=manager)\n",
-    "        )\n",
-    "    tasks = [async_agent.arun(q) for async_agent, q in zip(agents, questions)]\n",
-    "    await asyncio.gather(*tasks)\n",
-    "    await aiosession.close()\n",
+    "llm = OpenAI(temperature=0)\n",
+    "tools = load_tools([\"google-serper\",\"llm-math\"], llm=llm)\n",
+    "agent = initialize_agent(\n",
+    "    tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True\n",
+    ")\n",
     "\n",
     "s = time.perf_counter()\n",
-    "# If running this outside of Jupyter, use asyncio.run(generate_concurrently())\n",
-    "await generate_concurrently()\n",
+    "# If running this outside of Jupyter, use asyncio.run or loop.run_until_complete\n",
+    "tasks = [agent.arun(q) for q in questions]\n",
+    "await asyncio.gather(*tasks)\n",
     "elapsed = time.perf_counter() - s\n",
     "print(f\"Concurrent executed in {elapsed:0.2f} seconds.\")"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "97ef285c-4a43-4a4e-9698-cd52a1bc56c9",
-   "metadata": {},
-   "source": [
-    "## Using Tracing with Asynchronous Agents\n",
-    "\n",
-    "To use tracing with async agents, you must pass in a custom `CallbackManager` with `LangChainTracer` to each agent running asynchronously. This way, you avoid collisions while the trace is being collected."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "44bda05a-d33e-4e91-9a71-a0f3f96aae95",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who won the US Open men's final in 2019 and then calculate his age raised to the 0.334 power.\n",
-      "Action: Search\n",
-      "Action Input: \"US Open men's final 2019 winner\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mRafael Nadal\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Rafael Nadal's age\n",
-      "Action: Search\n",
-      "Action Input: \"Rafael Nadal age\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m36 years\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate 36 raised to the 0.334 power\n",
-      "Action: Calculator\n",
-      "Action Input: 36^0.334\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 3.3098250249682484\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Rafael Nadal, aged 36, won the US Open men's final in 2019 and his age raised to the 0.334 power is 3.3098250249682484.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    }
-   ],
-   "source": [
-    "# To make async requests in Tools more efficient, you can pass in your own aiohttp.ClientSession, \n",
-    "# but you must manually close the client session at the end of your program/event loop\n",
-    "aiosession = ClientSession()\n",
-    "tracer = LangChainTracer()\n",
-    "tracer.load_default_session()\n",
-    "manager = CallbackManager([StdOutCallbackHandler(), tracer])\n",
-    "\n",
-    "# Pass the manager into the llm if you want llm calls traced.\n",
-    "llm = OpenAI(temperature=0, callback_manager=manager)\n",
-    "\n",
-    "async_tools = load_tools([\"llm-math\", \"serpapi\"], llm=llm, aiosession=aiosession)\n",
-    "async_agent = initialize_agent(async_tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True, callback_manager=manager)\n",
-    "await async_agent.arun(questions[0])\n",
-    "await aiosession.close()"
-   ]
   }
  ],
  "metadata": {
@@ -404,7 +304,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.9"
   }
  },
  "nbformat": 4,

docs/modules/agents/agents/custom_agent.ipynb

@@ -49,7 +49,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 3,
    "id": "a33e2f7e",
    "metadata": {},
    "outputs": [],
@@ -97,7 +97,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 4,
    "id": "655d72f6",
    "metadata": {},
    "outputs": [],
@@ -107,7 +107,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 5,
    "id": "490604e9",
    "metadata": {},
    "outputs": [],
@@ -117,7 +117,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 6,
    "id": "653b1617",
    "metadata": {},
    "outputs": [
@@ -128,7 +128,7 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m\u001b[0m\u001b[36;1m\u001b[1;3mFoo Fighters is an American rock band formed in Seattle in 1994. Foo Fighters was initially formed as a one-man project by former Nirvana drummer Dave Grohl. Following the success of the 1995 eponymous debut album, Grohl recruited a band consisting of Nate Mendel, William Goldsmith, and Pat Smear.\u001b[0m\u001b[32;1m\u001b[1;3m\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3m\u001b[0m\u001b[36;1m\u001b[1;3mThe current population of Canada is 38,669,152 as of Monday, April 24, 2023, based on Worldometer elaboration of the latest United Nations data.\u001b[0m\u001b[32;1m\u001b[1;3m\u001b[0m\n",
       "\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
@@ -136,10 +136,10 @@
     {
      "data": {
       "text/plain": [
-       "'Foo Fighters is an American rock band formed in Seattle in 1994. Foo Fighters was initially formed as a one-man project by former Nirvana drummer Dave Grohl. Following the success of the 1995 eponymous debut album, Grohl recruited a band consisting of Nate Mendel, William Goldsmith, and Pat Smear.'"
+       "'The current population of Canada is 38,669,152 as of Monday, April 24, 2023, based on Worldometer elaboration of the latest United Nations data.'"
       ]
      },
-     "execution_count": 7,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }

docs/modules/agents/agents/custom_agent_with_tool_retrieval.ipynb

@@ -373,6 +373,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "tools = get_tools(\"whats the weather?\")\n",
     "tool_names = [tool.name for tool in tools]\n",
     "agent = LLMSingleActionAgent(\n",
     "    llm_chain=llm_chain, \n",

docs/modules/agents/agents/custom_multi_action_agent.ipynb

@@ -31,7 +31,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 21,
+   "execution_count": 2,
    "id": "d7c4ebdc",
    "metadata": {},
    "outputs": [],
@@ -43,7 +43,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 22,
+   "execution_count": 3,
    "id": "becda2a1",
    "metadata": {},
    "outputs": [],
@@ -66,7 +66,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 23,
+   "execution_count": 4,
    "id": "a33e2f7e",
    "metadata": {},
    "outputs": [],
@@ -96,8 +96,8 @@
     "        \"\"\"\n",
     "        if len(intermediate_steps) == 0:\n",
     "            return [\n",
-    "                AgentAction(tool=\"Search\", tool_input=\"foo\", log=\"\"),\n",
-    "                AgentAction(tool=\"RandomWord\", tool_input=\"foo\", log=\"\"),\n",
+    "                AgentAction(tool=\"Search\", tool_input=kwargs[\"input\"], log=\"\"),\n",
+    "                AgentAction(tool=\"RandomWord\", tool_input=kwargs[\"input\"], log=\"\"),\n",
     "            ]\n",
     "        else:\n",
     "            return AgentFinish(return_values={\"output\": \"bar\"}, log=\"\")\n",
@@ -117,8 +117,8 @@
     "        \"\"\"\n",
     "        if len(intermediate_steps) == 0:\n",
     "            return [\n",
-    "                AgentAction(tool=\"Search\", tool_input=\"foo\", log=\"\"),\n",
-    "                AgentAction(tool=\"RandomWord\", tool_input=\"foo\", log=\"\"),\n",
+    "                AgentAction(tool=\"Search\", tool_input=kwargs[\"input\"], log=\"\"),\n",
+    "                AgentAction(tool=\"RandomWord\", tool_input=kwargs[\"input\"], log=\"\"),\n",
     "            ]\n",
     "        else:\n",
     "            return AgentFinish(return_values={\"output\": \"bar\"}, log=\"\")"
@@ -126,7 +126,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 24,
+   "execution_count": 5,
    "id": "655d72f6",
    "metadata": {},
    "outputs": [],
@@ -136,7 +136,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 25,
+   "execution_count": 6,
    "id": "490604e9",
    "metadata": {},
    "outputs": [],
@@ -146,7 +146,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 26,
+   "execution_count": 7,
    "id": "653b1617",
    "metadata": {},
    "outputs": [
@@ -157,7 +157,7 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m\u001b[0m\u001b[36;1m\u001b[1;3mFoo Fighters is an American rock band formed in Seattle in 1994. Foo Fighters was initially formed as a one-man project by former Nirvana drummer Dave Grohl. Following the success of the 1995 eponymous debut album, Grohl recruited a band consisting of Nate Mendel, William Goldsmith, and Pat Smear.\u001b[0m\u001b[32;1m\u001b[1;3m\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3m\u001b[0m\u001b[36;1m\u001b[1;3mThe current population of Canada is 38,669,152 as of Monday, April 24, 2023, based on Worldometer elaboration of the latest United Nations data.\u001b[0m\u001b[32;1m\u001b[1;3m\u001b[0m\n",
       "Now I'm doing this!\n",
       "\u001b[33;1m\u001b[1;3mfoo\u001b[0m\u001b[32;1m\u001b[1;3m\u001b[0m\n",
       "\n",
@@ -170,7 +170,7 @@
        "'bar'"
       ]
      },
-     "execution_count": 26,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }

docs/modules/agents/agents/examples/structured_chat.ipynb

@@ -0,0 +1,307 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "4658d71a",
+   "metadata": {},
+   "source": [
+    "# Structured Tool Chat Agent\n",
+    "\n",
+    "This notebook walks through using a chat agent capable of using multi-input tools.\n",
+    "\n",
+    "Older agents are configured to specify an action input as a single string, but this agent can use the provided tools' `args_schema` to populate the action input.\n",
+    "\n",
+    "This functionality is natively available in the (`structured-chat-zero-shot-react-description` or `AgentType.STRUCTURED_CHAT_ZERO_SHOT_REACT_DESCRIPTION`)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ccc8ff98",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"LANGCHAIN_TRACING\"] = \"true\" # If you want to trace the execution of the program, set to \"true\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "f65308ab",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.agents import AgentType\n",
+    "from langchain.chat_models import ChatOpenAI\n",
+    "from langchain.agents import initialize_agent"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "30aaf540-9e8e-436e-af8b-89e610e34120",
+   "metadata": {},
+   "source": [
+    "### Initialize Tools\n",
+    "\n",
+    "We will test the agent using a web browser."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "71027ff2-5d09-49cd-92a1-24b2c454a7ae",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.agents.agent_toolkits import PlayWrightBrowserToolkit\n",
+    "from langchain.tools.playwright.utils import (\n",
+    "    create_async_playwright_browser,\n",
+    "    create_sync_playwright_browser, # A synchronous browser is available, though it isn't compatible with jupyter.\n",
+    ")\n",
+    "\n",
+    "# This import is required only for jupyter notebooks, since they have their own eventloop\n",
+    "import nest_asyncio\n",
+    "nest_asyncio.apply()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "5fb14d6d",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "async_browser = create_async_playwright_browser()\n",
+    "browser_toolkit = PlayWrightBrowserToolkit.from_browser(async_browser=async_browser)\n",
+    "tools = browser_toolkit.get_tools()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "cafe9bc1",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "llm = ChatOpenAI(temperature=0) # Also works well with Anthropic models\n",
+    "agent_chain = initialize_agent(tools, llm, agent=AgentType.STRUCTURED_CHAT_ZERO_SHOT_REACT_DESCRIPTION, verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "4f4aa234-9746-47d8-bec7-d76081ac3ef6",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "Hi Erica! How can I assist you today?\n"
+     ]
+    }
+   ],
+   "source": [
+    "response = await agent_chain.arun(input=\"Hi I'm Erica.\")\n",
+    "print(response)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "23e7dc33-50a5-4685-8e9b-4ac49e12877f",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "I'm here to chat! How's your day going?\n"
+     ]
+    }
+   ],
+   "source": [
+    "response = await agent_chain.arun(input=\"Don't need help really just chatting.\")\n",
+    "print(response)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "dc70b454",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mAction:\n",
+      "```\n",
+      "{\n",
+      "  \"action\": \"navigate_browser\",\n",
+      "  \"action_input\": {\n",
+      "    \"url\": \"https://blog.langchain.dev/\"\n",
+      "  }\n",
+      "}\n",
+      "```\n",
+      "\n",
+      "\u001b[0m\n",
+      "Observation: \u001b[33;1m\u001b[1;3mNavigating to https://blog.langchain.dev/ returned status code 200\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI need to extract the text from the webpage to summarize it.\n",
+      "Action:\n",
+      "```\n",
+      "{\n",
+      "  \"action\": \"extract_text\",\n",
+      "  \"action_input\": {}\n",
+      "}\n",
+      "```\n",
+      "\u001b[0m\n",
+      "Observation: \u001b[31;1m\u001b[1;3mLangChain LangChain Home About GitHub Docs LangChain The official LangChain blog. Auto-Evaluator Opportunities Editor's Note: this is a guest blog post by Lance Martin.\n",
+      "\n",
+      "\n",
+      "TL;DR\n",
+      "\n",
+      "We recently open-sourced an auto-evaluator tool for grading LLM question-answer chains. We are now releasing an open source, free to use hosted app and API to expand usability. Below we discuss a few opportunities to further improve May 1, 2023 5 min read Callbacks Improvements TL;DR: We're announcing improvements to our callbacks system, which powers logging, tracing, streaming output, and some awesome third-party integrations. This will better support concurrent runs with independent callbacks, tracing of deeply nested trees of LangChain components, and callback handlers scoped to a single request (which is super useful for May 1, 2023 3 min read Unleashing the power of AI Collaboration with Parallelized LLM Agent Actor Trees Editor's note: the following is a guest blog post from Cyrus at Shaman AI. We use guest blog posts to highlight interesting and novel applciations, and this is certainly that. There's been a lot of talk about agents recently, but most have been discussions around a single agent. If multiple Apr 28, 2023 4 min read Gradio & LLM Agents Editor's note: this is a guest blog post from Freddy Boulton, a software engineer at Gradio. We're excited to share this post because it brings a large number of exciting new tools into the ecosystem. Agents are largely defined by the tools they have, so to be able to equip Apr 23, 2023 4 min read RecAlign - The smart content filter for social media feed [Editor's Note] This is a guest post by Tian Jin. We are highlighting this application as we think it is a novel use case. Specifically, we think recommendation systems are incredibly impactful in our everyday lives and there has not been a ton of discourse on how LLMs will impact Apr 22, 2023 3 min read Improving Document Retrieval with Contextual Compression Note: This post assumes some familiarity with LangChain and is moderately technical.\n",
+      "\n",
+      "💡 TL;DR: We’ve introduced a new abstraction and a new document Retriever to facilitate the post-processing of retrieved documents. Specifically, the new abstraction makes it easy to take a set of retrieved documents and extract from them Apr 20, 2023 3 min read Autonomous Agents & Agent Simulations Over the past two weeks, there has been a massive increase in using LLMs in an agentic manner. Specifically, projects like AutoGPT, BabyAGI, CAMEL, and Generative Agents have popped up. The LangChain community has now implemented some parts of all of those projects in the LangChain framework. While researching and Apr 18, 2023 7 min read AI-Powered Medical Knowledge: Revolutionizing Care for Rare Conditions [Editor's Note]: This is a guest post by Jack Simon, who recently participated in a hackathon at Williams College. He built a LangChain-powered chatbot focused on appendiceal cancer, aiming to make specialized knowledge more accessible to those in need. If you are interested in building a chatbot for another rare Apr 17, 2023 3 min read Auto-Eval of Question-Answering Tasks By Lance Martin\n",
+      "\n",
+      "Context\n",
+      "\n",
+      "LLM ops platforms, such as LangChain, make it easy to assemble LLM components (e.g., models, document retrievers, data loaders) into chains. Question-Answering is one of the most popular applications of these chains. But it is often not always obvious to determine what parameters (e.g. Apr 15, 2023 3 min read Announcing LangChainJS Support for Multiple JS Environments TLDR: We're announcing support for running LangChain.js in browsers, Cloudflare Workers, Vercel/Next.js, Deno, Supabase Edge Functions, alongside existing support for Node.js ESM and CJS. See install/upgrade docs and breaking changes list.\n",
+      "\n",
+      "\n",
+      "Context\n",
+      "\n",
+      "Originally we designed LangChain.js to run in Node.js, which is the Apr 11, 2023 3 min read LangChain x Supabase Supabase is holding an AI Hackathon this week. Here at LangChain we are big fans of both Supabase and hackathons, so we thought this would be a perfect time to highlight the multiple ways you can use LangChain and Supabase together.\n",
+      "\n",
+      "The reason we like Supabase so much is that Apr 8, 2023 2 min read Announcing our $10M seed round led by Benchmark It was only six months ago that we released the first version of LangChain, but it seems like several years. When we launched, generative AI was starting to go mainstream: stable diffusion had just been released and was captivating people’s imagination and fueling an explosion in developer activity, Jasper Apr 4, 2023 4 min read Custom Agents One of the most common requests we've heard is better functionality and documentation for creating custom agents. This has always been a bit tricky - because in our mind it's actually still very unclear what an \"agent\" actually is, and therefor what the \"right\" abstractions for them may be. Recently, Apr 3, 2023 3 min read Retrieval TL;DR: We are adjusting our abstractions to make it easy for other retrieval methods besides the LangChain VectorDB object to be used in LangChain. This is done with the goals of (1) allowing retrievers constructed elsewhere to be used more easily in LangChain, (2) encouraging more experimentation with alternative Mar 23, 2023 4 min read LangChain + Zapier Natural Language Actions (NLA) We are super excited to team up with Zapier and integrate their new Zapier NLA API into LangChain, which you can now use with your agents and chains. With this integration, you have access to the 5k+ apps and 20k+ actions on Zapier's platform through a natural language API interface. Mar 16, 2023 2 min read Evaluation Evaluation of language models, and by extension applications built on top of language models, is hard. With recent model releases (OpenAI, Anthropic, Google) evaluation is becoming a bigger and bigger issue. People are starting to try to tackle this, with OpenAI releasing OpenAI/evals - focused on evaluating OpenAI models. Mar 14, 2023 3 min read LLMs and SQL Francisco Ingham and Jon Luo are two of the community members leading the change on the SQL integrations. We’re really excited to write this blog post with them going over all the tips and tricks they’ve learned doing so. We’re even more excited to announce that we’ Mar 13, 2023 8 min read Origin Web Browser [Editor's Note]: This is the second of hopefully many guest posts. We intend to highlight novel applications building on top of LangChain. If you are interested in working with us on such a post, please reach out to harrison@langchain.dev.\n",
+      "\n",
+      "Authors: Parth Asawa (pgasawa@), Ayushi Batwara (ayushi.batwara@), Jason Mar 8, 2023 4 min read Prompt Selectors One common complaint we've heard is that the default prompt templates do not work equally well for all models. This became especially pronounced this past week when OpenAI released a ChatGPT API. This new API had a completely new interface (which required new abstractions) and as a result many users Mar 8, 2023 2 min read Chat Models Last week OpenAI released a ChatGPT endpoint. It came marketed with several big improvements, most notably being 10x cheaper and a lot faster. But it also came with a completely new API endpoint. We were able to quickly write a wrapper for this endpoint to let users use it like Mar 6, 2023 6 min read Using the ChatGPT API to evaluate the ChatGPT API OpenAI released a new ChatGPT API yesterday. Lots of people were excited to try it. But how does it actually compare to the existing API? It will take some time before there is a definitive answer, but here are some initial thoughts. Because I'm lazy, I also enrolled the help Mar 2, 2023 5 min read Agent Toolkits Today, we're announcing agent toolkits, a new abstraction that allows developers to create agents designed for a particular use-case (for example, interacting with a relational database or interacting with an OpenAPI spec). We hope to continue developing different toolkits that can enable agents to do amazing feats. Toolkits are supported Mar 1, 2023 3 min read TypeScript Support It's finally here... TypeScript support for LangChain.\n",
+      "\n",
+      "What does this mean? It means that all your favorite prompts, chains, and agents are all recreatable in TypeScript natively. Both the Python version and TypeScript version utilize the same serializable format, meaning that artifacts can seamlessly be shared between languages. As an Feb 17, 2023 2 min read Streaming Support in LangChain We’re excited to announce streaming support in LangChain. There's been a lot of talk about the best UX for LLM applications, and we believe streaming is at its core. We’ve also updated the chat-langchain repo to include streaming and async execution. We hope that this repo can serve Feb 14, 2023 2 min read LangChain + Chroma Today we’re announcing LangChain's integration with Chroma, the first step on the path to the Modern A.I Stack.\n",
+      "\n",
+      "\n",
+      "LangChain - The A.I-native developer toolkit\n",
+      "\n",
+      "We started LangChain with the intent to build a modular and flexible framework for developing A.I-native applications. Some of the use cases Feb 13, 2023 2 min read Page 1 of 2 Older Posts → LangChain © 2023 Sign up Powered by Ghost\u001b[0m\n",
+      "Thought:\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "The LangChain blog has recently released an open-source auto-evaluator tool for grading LLM question-answer chains and is now releasing an open-source, free-to-use hosted app and API to expand usability. The blog also discusses various opportunities to further improve the LangChain platform.\n"
+     ]
+    }
+   ],
+   "source": [
+    "response = await agent_chain.arun(input=\"Browse to blog.langchain.dev and summarize the text, please.\")\n",
+    "print(response)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "0084efd6",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mThought: I can navigate to the xkcd website and extract the latest comic title and alt text to answer the question.\n",
+      "Action:\n",
+      "```\n",
+      "{\n",
+      "  \"action\": \"navigate_browser\",\n",
+      "  \"action_input\": {\n",
+      "    \"url\": \"https://xkcd.com/\"\n",
+      "  }\n",
+      "}\n",
+      "```\n",
+      "\u001b[0m\n",
+      "Observation: \u001b[33;1m\u001b[1;3mNavigating to https://xkcd.com/ returned status code 200\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI can extract the latest comic title and alt text using CSS selectors.\n",
+      "Action:\n",
+      "```\n",
+      "{\n",
+      "  \"action\": \"get_elements\",\n",
+      "  \"action_input\": {\n",
+      "    \"selector\": \"#ctitle, #comic img\",\n",
+      "    \"attributes\": [\"alt\", \"src\"]\n",
+      "  }\n",
+      "}\n",
+      "``` \n",
+      "\u001b[0m\n",
+      "Observation: \u001b[33;1m\u001b[1;3m[{\"alt\": \"Tapetum Lucidum\", \"src\": \"//imgs.xkcd.com/comics/tapetum_lucidum.png\"}]\u001b[0m\n",
+      "Thought:\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "The latest xkcd comic is titled \"Tapetum Lucidum\" and the image can be found at https://xkcd.com/2565/.\n"
+     ]
+    }
+   ],
+   "source": [
+    "response = await agent_chain.arun(input=\"What's the latest xkcd comic about?\")\n",
+    "print(response)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ebd7ae33-f67d-4378-ac79-9d91e0c8f53a",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/modules/agents/toolkits/examples/powerbi.ipynb

@@ -55,14 +55,16 @@
    },
    "outputs": [],
    "source": [
-    "llm = AzureOpenAI(temperature=0, deployment_name=\"text-davinci-003\", verbose=True)\n",
+    "fast_llm = AzureOpenAI(temperature=0.5, max_tokens=1000, deployment_name=\"gpt-35-turbo\", verbose=True)\n",
+    "smart_llm = AzureOpenAI(temperature=0, max_tokens=100, deployment_name=\"gpt-4\", verbose=True)\n",
+    "\n",
     "toolkit = PowerBIToolkit(\n",
-    "    powerbi=PowerBIDataset(None, \"<dataset_id>\", ['table1', 'table2'], DefaultAzureCredential()), \n",
-    "    llm=llm\n",
+    "    powerbi=PowerBIDataset(dataset_id=\"<dataset_id>\", table_names=['table1', 'table2'], credential=DefaultAzureCredential()), \n",
+    "    llm=smart_llm\n",
     ")\n",
     "\n",
     "agent_executor = create_pbi_agent(\n",
-    "    llm=llm,\n",
+    "    llm=fast_llm,\n",
     "    toolkit=toolkit,\n",
     "    verbose=True,\n",
     ")"
@@ -141,6 +143,56 @@
    "source": [
     "agent_executor.run(\"What unique values are there for dimensions2 in table2\")"
    ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "6fd950e4",
+   "metadata": {},
+   "source": [
+    "## Example: add your own few-shot prompts"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "87d677f9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#fictional example\n",
+    "few_shots = \"\"\"\n",
+    "Question: How many rows are in the table revenue?\n",
+    "DAX: EVALUATE ROW(\"Number of rows\", COUNTROWS(revenue_details))\n",
+    "----\n",
+    "Question: How many rows are in the table revenue where year is not empty?\n",
+    "DAX: EVALUATE ROW(\"Number of rows\", COUNTROWS(FILTER(revenue_details, revenue_details[year] <> \"\")))\n",
+    "----\n",
+    "Question: What was the average of value in revenue in dollars?\n",
+    "DAX: EVALUATE ROW(\"Average\", AVERAGE(revenue_details[dollar_value]))\n",
+    "----\n",
+    "\"\"\"\n",
+    "toolkit = PowerBIToolkit(\n",
+    "    powerbi=PowerBIDataset(dataset_id=\"<dataset_id>\", table_names=['table1', 'table2'], credential=DefaultAzureCredential()), \n",
+    "    llm=smart_llm,\n",
+    "    examples=few_shots,\n",
+    ")\n",
+    "agent_executor = create_pbi_agent(\n",
+    "    llm=fast_llm,\n",
+    "    toolkit=toolkit,\n",
+    "    verbose=True,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "33f4bb43",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "agent_executor.run(\"What was the maximum of value in revenue in dollars in 2022?\")"
+   ]
   }
  ],
  "metadata": {

docs/modules/agents/toolkits/examples/spark.ipynb

@@ -0,0 +1,229 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Spark Dataframe Agent\n",
+    "\n",
+    "This notebook shows how to use agents to interact with a Spark dataframe. It is mostly optimized for question answering.\n",
+    "\n",
+    "**NOTE: this agent calls the Python agent under the hood, which executes LLM generated Python code - this can be bad if the LLM generated Python code is harmful. Use cautiously.**"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 14,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.agents import create_spark_dataframe_agent\n",
+    "import os\n",
+    "\n",
+    "os.environ[\"OPENAI_API_KEY\"] = \"...input_your_openai_api_key...\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 15,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "+-----------+--------+------+--------------------+------+----+-----+-----+----------------+-------+-----+--------+\n",
+      "|PassengerId|Survived|Pclass|                Name|   Sex| Age|SibSp|Parch|          Ticket|   Fare|Cabin|Embarked|\n",
+      "+-----------+--------+------+--------------------+------+----+-----+-----+----------------+-------+-----+--------+\n",
+      "|          1|       0|     3|Braund, Mr. Owen ...|  male|22.0|    1|    0|       A/5 21171|   7.25| null|       S|\n",
+      "|          2|       1|     1|Cumings, Mrs. Joh...|female|38.0|    1|    0|        PC 17599|71.2833|  C85|       C|\n",
+      "|          3|       1|     3|Heikkinen, Miss. ...|female|26.0|    0|    0|STON/O2. 3101282|  7.925| null|       S|\n",
+      "|          4|       1|     1|Futrelle, Mrs. Ja...|female|35.0|    1|    0|          113803|   53.1| C123|       S|\n",
+      "|          5|       0|     3|Allen, Mr. Willia...|  male|35.0|    0|    0|          373450|   8.05| null|       S|\n",
+      "|          6|       0|     3|    Moran, Mr. James|  male|null|    0|    0|          330877| 8.4583| null|       Q|\n",
+      "|          7|       0|     1|McCarthy, Mr. Tim...|  male|54.0|    0|    0|           17463|51.8625|  E46|       S|\n",
+      "|          8|       0|     3|Palsson, Master. ...|  male| 2.0|    3|    1|          349909| 21.075| null|       S|\n",
+      "|          9|       1|     3|Johnson, Mrs. Osc...|female|27.0|    0|    2|          347742|11.1333| null|       S|\n",
+      "|         10|       1|     2|Nasser, Mrs. Nich...|female|14.0|    1|    0|          237736|30.0708| null|       C|\n",
+      "|         11|       1|     3|Sandstrom, Miss. ...|female| 4.0|    1|    1|         PP 9549|   16.7|   G6|       S|\n",
+      "|         12|       1|     1|Bonnell, Miss. El...|female|58.0|    0|    0|          113783|  26.55| C103|       S|\n",
+      "|         13|       0|     3|Saundercock, Mr. ...|  male|20.0|    0|    0|       A/5. 2151|   8.05| null|       S|\n",
+      "|         14|       0|     3|Andersson, Mr. An...|  male|39.0|    1|    5|          347082| 31.275| null|       S|\n",
+      "|         15|       0|     3|Vestrom, Miss. Hu...|female|14.0|    0|    0|          350406| 7.8542| null|       S|\n",
+      "|         16|       1|     2|Hewlett, Mrs. (Ma...|female|55.0|    0|    0|          248706|   16.0| null|       S|\n",
+      "|         17|       0|     3|Rice, Master. Eugene|  male| 2.0|    4|    1|          382652| 29.125| null|       Q|\n",
+      "|         18|       1|     2|Williams, Mr. Cha...|  male|null|    0|    0|          244373|   13.0| null|       S|\n",
+      "|         19|       0|     3|Vander Planke, Mr...|female|31.0|    1|    0|          345763|   18.0| null|       S|\n",
+      "|         20|       1|     3|Masselmani, Mrs. ...|female|null|    0|    0|            2649|  7.225| null|       C|\n",
+      "+-----------+--------+------+--------------------+------+----+-----+-----+----------------+-------+-----+--------+\n",
+      "only showing top 20 rows\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "from langchain.llms import OpenAI\n",
+    "from pyspark.sql import SparkSession\n",
+    "\n",
+    "spark = SparkSession.builder.getOrCreate()\n",
+    "csv_file_path = \"titanic.csv\"\n",
+    "df = spark.read.csv(csv_file_path, header=True, inferSchema=True)\n",
+    "df.show()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 16,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "agent = create_spark_dataframe_agent(llm=OpenAI(temperature=0), df=df, verbose=True)\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 17,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mThought: I need to find out how many rows are in the dataframe\n",
+      "Action: python_repl_ast\n",
+      "Action Input: df.count()\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m891\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
+      "Final Answer: There are 891 rows in the dataframe.\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'There are 891 rows in the dataframe.'"
+      ]
+     },
+     "execution_count": 17,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent.run(\"how many rows are there?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mThought: I need to find out how many people have more than 3 siblings\n",
+      "Action: python_repl_ast\n",
+      "Action Input: df.filter(df.SibSp > 3).count()\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m30\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
+      "Final Answer: 30 people have more than 3 siblings.\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'30 people have more than 3 siblings.'"
+      ]
+     },
+     "execution_count": 12,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent.run(\"how many people have more than 3 sibligngs\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 13,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mThought: I need to get the average age first\n",
+      "Action: python_repl_ast\n",
+      "Action Input: df.agg({\"Age\": \"mean\"}).collect()[0][0]\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m29.69911764705882\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now have the average age, I need to get the square root\n",
+      "Action: python_repl_ast\n",
+      "Action Input: math.sqrt(29.69911764705882)\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mname 'math' is not defined\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to import math first\n",
+      "Action: python_repl_ast\n",
+      "Action Input: import math\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now have the math library imported, I can get the square root\n",
+      "Action: python_repl_ast\n",
+      "Action Input: math.sqrt(29.69911764705882)\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m5.449689683556195\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
+      "Final Answer: 5.449689683556195\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'5.449689683556195'"
+      ]
+     },
+     "execution_count": 13,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent.run(\"whats the square root of the average age?\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "LangChain",
+   "language": "python",
+   "name": "langchain"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.16"
+  },
+  "orig_nbformat": 4
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/modules/agents/tools/custom_tools.ipynb

@@ -1,6 +1,7 @@
 {
  "cells": [
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "5436020b",
    "metadata": {},
@@ -12,11 +13,10 @@
     "- name (str), is required and must be unique within a set of tools provided to an agent\n",
     "- description (str), is optional but recommended, as it is used by an agent to determine tool use\n",
     "- return_direct (bool), defaults to False\n",
-    "- args_schema (Pydantic BaseModel), is optional but recommended, can be used to provide more information or validation for expected parameters.\n",
+    "- args_schema (Pydantic BaseModel), is optional but recommended, can be used to provide more information (e.g., few-shot examples) or validation for expected parameters.\n",
     "\n",
-    "The function that should be called when the tool is selected should return a single string.\n",
     "\n",
-    "There are two ways to define a tool, we will cover both in the example below."
+    "There are two main ways to define a tool, we will cover both in the example below."
    ]
   },
   {
@@ -30,9 +30,9 @@
    "source": [
     "# Import things that are needed generically\n",
     "from langchain import LLMMathChain, SerpAPIWrapper\n",
-    "from langchain.agents import AgentType, Tool, initialize_agent, tool\n",
+    "from langchain.agents import AgentType, initialize_agent\n",
     "from langchain.chat_models import ChatOpenAI\n",
-    "from langchain.tools import BaseTool"
+    "from langchain.tools import BaseTool, StructuredTool, Tool, tool"
    ]
   },
   {
@@ -56,22 +56,27 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "f8bc72c2",
    "metadata": {},
    "source": [
-    "## Completely New Tools \n",
-    "First, we show how to create completely new tools from scratch.\n",
+    "## Completely New Tools - String Input and Output\n",
+    "\n",
+    "The simplest tools accept a single query string and return a string output. If your tool function requires multiple arguments, you might want to skip down to the `StructuredTool` section below.\n",
     "\n",
     "There are two ways to do this: either by using the Tool dataclass, or by subclassing the BaseTool class."
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "b63fcc3b",
    "metadata": {},
    "source": [
-    "### Tool dataclass"
+    "### Tool dataclass\n",
+    "\n",
+    "The 'Tool' dataclass wraps functions that accept a single string input and returns a string output."
    ]
   },
   {
@@ -81,19 +86,46 @@
    "metadata": {
     "tags": []
    },
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "/Users/wfh/code/lc/lckg/langchain/chains/llm_math/base.py:50: UserWarning: Directly instantiating an LLMMathChain with an llm is deprecated. Please instantiate with llm_chain argument or using the from_llm class method.\n",
+      "  warnings.warn(\n"
+     ]
+    }
+   ],
    "source": [
     "# Load the tool configs that are needed.\n",
     "search = SerpAPIWrapper()\n",
     "llm_math_chain = LLMMathChain(llm=llm, verbose=True)\n",
     "tools = [\n",
-    "    Tool(\n",
-    "        name = \"Search\",\n",
+    "    Tool.from_function(\n",
     "        func=search.run,\n",
+    "        name = \"Search\",\n",
     "        description=\"useful for when you need to answer questions about current events\"\n",
+    "        # coroutine= ... <- you can specify an async method if desired as well\n",
     "    ),\n",
-    "]\n",
-    "# You can also define an args_schema to provide more information about inputs\n",
+    "]"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "e9b560f7",
+   "metadata": {},
+   "source": [
+    "You can also define a custom `args_schema`` to provide more information about inputs."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "631361e7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "from pydantic import BaseModel, Field\n",
     "\n",
     "class CalculatorInput(BaseModel):\n",
@@ -101,18 +133,19 @@
     "        \n",
     "\n",
     "tools.append(\n",
-    "    Tool(\n",
-    "        name=\"Calculator\",\n",
+    "    Tool.from_function(\n",
     "        func=llm_math_chain.run,\n",
+    "        name=\"Calculator\",\n",
     "        description=\"useful for when you need to answer questions about math\",\n",
     "        args_schema=CalculatorInput\n",
+    "        # coroutine= ... <- you can specify an async method if desired as well\n",
     "    )\n",
     ")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "id": "5b93047d",
    "metadata": {
     "tags": []
@@ -126,7 +159,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "id": "6f96a891",
    "metadata": {
     "tags": []
@@ -141,7 +174,17 @@
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
       "\u001b[32;1m\u001b[1;3mI need to find out Leo DiCaprio's girlfriend's name and her age\n",
       "Action: Search\n",
-      "Action Input: \"Leo DiCaprio girlfriend\"\u001b[0m\u001b[36;1m\u001b[1;3mDiCaprio broke up with girlfriend Camila Morrone, 25, in the summer of 2022, after dating for four years.\u001b[0m\u001b[32;1m\u001b[1;3mI need to find out Camila Morrone's current age\n",
+      "Action Input: \"Leo DiCaprio girlfriend\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mAfter rumours of a romance with Gigi Hadid, the Oscar winner has seemingly moved on. First being linked to the television personality in September 2022, it appears as if his \"age bracket\" has moved up. This follows his rumoured relationship with mere 19-year-old Eden Polani.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI still need to find out his current girlfriend's name and age\n",
+      "Action: Search\n",
+      "Action Input: \"Leo DiCaprio current girlfriend\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mJust Jared on Instagram: “Leonardo DiCaprio & girlfriend Camila Morrone couple up for a lunch date!\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mNow that I know his girlfriend's name is Camila Morrone, I need to find her current age\n",
+      "Action: Search\n",
+      "Action Input: \"Camila Morrone age\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m25 years\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mNow that I have her age, I need to calculate her age raised to the 0.43 power\n",
       "Action: Calculator\n",
       "Action Input: 25^(0.43)\u001b[0m\n",
       "\n",
@@ -153,8 +196,10 @@
       "\u001b[0m\n",
       "Answer: \u001b[33;1m\u001b[1;3m3.991298452658078\u001b[0m\n",
       "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\u001b[33;1m\u001b[1;3mAnswer: 3.991298452658078\u001b[0m\u001b[32;1m\u001b[1;3mI now know the final answer\n",
-      "Final Answer: 3.991298452658078\u001b[0m\n",
+      "\n",
+      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 3.991298452658078\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI now know the final answer\n",
+      "Final Answer: Camila Morrone's current age raised to the 0.43 power is approximately 3.99.\u001b[0m\n",
       "\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
@@ -162,10 +207,10 @@
     {
      "data": {
       "text/plain": [
-       "'3.991298452658078'"
+       "\"Camila Morrone's current age raised to the 0.43 power is approximately 3.99.\""
       ]
      },
-     "execution_count": 5,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -175,71 +220,65 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "6f12eaf0",
    "metadata": {},
    "source": [
-    "### Subclassing the BaseTool class"
+    "### Subclassing the BaseTool class\n",
+    "\n",
+    "You can also directly subclass `BaseTool`. This is useful if you want more control over the instance variables or if you want to propagate callbacks to nested chains or other tools."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 7,
    "id": "c58a7c40",
    "metadata": {
     "tags": []
    },
    "outputs": [],
    "source": [
-    "from typing import Type\n",
+    "from typing import Optional, Type\n",
+    "\n",
+    "from langchain.callbacks.manager import AsyncCallbackManagerForToolRun, CallbackManagerForToolRun\n",
     "\n",
     "class CustomSearchTool(BaseTool):\n",
-    "    name = \"Search\"\n",
+    "    name = \"custom_search\"\n",
     "    description = \"useful for when you need to answer questions about current events\"\n",
     "\n",
-    "    def _run(self, query: str) -> str:\n",
+    "    def _run(self, query: str, run_manager: Optional[CallbackManagerForToolRun] = None) -> str:\n",
     "        \"\"\"Use the tool.\"\"\"\n",
     "        return search.run(query)\n",
     "    \n",
-    "    async def _arun(self, query: str) -> str:\n",
+    "    async def _arun(self, query: str, run_manager: Optional[AsyncCallbackManagerForToolRun] = None) -> str:\n",
     "        \"\"\"Use the tool asynchronously.\"\"\"\n",
-    "        raise NotImplementedError(\"BingSearchRun does not support async\")\n",
+    "        raise NotImplementedError(\"custom_search does not support async\")\n",
     "    \n",
     "class CustomCalculatorTool(BaseTool):\n",
     "    name = \"Calculator\"\n",
     "    description = \"useful for when you need to answer questions about math\"\n",
     "    args_schema: Type[BaseModel] = CalculatorInput\n",
     "\n",
-    "    def _run(self, query: str) -> str:\n",
+    "    def _run(self, query: str, run_manager: Optional[CallbackManagerForToolRun] = None) -> str:\n",
     "        \"\"\"Use the tool.\"\"\"\n",
     "        return llm_math_chain.run(query)\n",
     "    \n",
-    "    async def _arun(self, query: str) -> str:\n",
+    "    async def _arun(self, query: str,  run_manager: Optional[AsyncCallbackManagerForToolRun] = None) -> str:\n",
     "        \"\"\"Use the tool asynchronously.\"\"\"\n",
-    "        raise NotImplementedError(\"BingSearchRun does not support async\")"
+    "        raise NotImplementedError(\"Calculator does not support async\")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 8,
    "id": "3318a46f",
    "metadata": {
     "tags": []
    },
    "outputs": [],
    "source": [
-    "tools = [CustomSearchTool(), CustomCalculatorTool()]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "ee2d0f3a",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
+    "tools = [CustomSearchTool(), CustomCalculatorTool()]\n",
     "agent = initialize_agent(tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True)"
    ]
   },
@@ -258,22 +297,30 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mI need to find out Leo DiCaprio's girlfriend's name and her age\n",
-      "Action: Search\n",
-      "Action Input: \"Leo DiCaprio girlfriend\"\u001b[0m\u001b[36;1m\u001b[1;3mDiCaprio broke up with girlfriend Camila Morrone, 25, in the summer of 2022, after dating for four years.\u001b[0m\u001b[32;1m\u001b[1;3mI need to find out Camila Morrone's current age\n",
+      "\u001b[32;1m\u001b[1;3mI need to use custom_search to find out who Leo DiCaprio's girlfriend is, and then use the Calculator to raise her age to the 0.43 power.\n",
+      "Action: custom_search\n",
+      "Action Input: \"Leo DiCaprio girlfriend\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mAfter rumours of a romance with Gigi Hadid, the Oscar winner has seemingly moved on. First being linked to the television personality in September 2022, it appears as if his \"age bracket\" has moved up. This follows his rumoured relationship with mere 19-year-old Eden Polani.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI need to find out the current age of Eden Polani.\n",
+      "Action: custom_search\n",
+      "Action Input: \"Eden Polani age\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m19 years old\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mNow I can use the Calculator to raise her age to the 0.43 power.\n",
       "Action: Calculator\n",
-      "Action Input: 25^(0.43)\u001b[0m\n",
+      "Action Input: 19 ^ 0.43\u001b[0m\n",
       "\n",
       "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\n",
-      "25^(0.43)\u001b[32;1m\u001b[1;3m```text\n",
-      "25**(0.43)\n",
+      "19 ^ 0.43\u001b[32;1m\u001b[1;3m```text\n",
+      "19 ** 0.43\n",
       "```\n",
-      "...numexpr.evaluate(\"25**(0.43)\")...\n",
+      "...numexpr.evaluate(\"19 ** 0.43\")...\n",
       "\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m3.991298452658078\u001b[0m\n",
+      "Answer: \u001b[33;1m\u001b[1;3m3.547023357958959\u001b[0m\n",
       "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\u001b[33;1m\u001b[1;3mAnswer: 3.991298452658078\u001b[0m\u001b[32;1m\u001b[1;3mI now know the final answer\n",
-      "Final Answer: 3.991298452658078\u001b[0m\n",
+      "\n",
+      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 3.547023357958959\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI now know the final answer.\n",
+      "Final Answer: 3.547023357958959\u001b[0m\n",
       "\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
@@ -281,7 +328,7 @@
     {
      "data": {
       "text/plain": [
-       "'3.991298452658078'"
+       "'3.547023357958959'"
       ]
      },
      "execution_count": 9,
@@ -312,34 +359,13 @@
    },
    "outputs": [],
    "source": [
-    "from langchain.agents import tool\n",
+    "from langchain.tools import tool\n",
     "\n",
     "@tool\n",
     "def search_api(query: str) -> str:\n",
     "    \"\"\"Searches the API for the query.\"\"\"\n",
-    "    return f\"Results for query {query}\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "0a23b91b",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "Tool(name='search_api', description='search_api(query: str) -> str - Searches the API for the query.', args_schema=<class 'pydantic.main.SearchApi'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x12748c4c0>, func=<function search_api at 0x16bd664c0>, coroutine=None)"
-      ]
-     },
-     "execution_count": 11,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
+    "    return f\"Results for query {query}\"\n",
+    "\n",
     "search_api"
    ]
   },
@@ -433,18 +459,149 @@
    ]
   },
   {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "61d2e80b",
+   "metadata": {},
+   "source": [
+    "## Custom Structured Tools\n",
+    "\n",
+    "If your functions require more structured arguments, you can use the `StructuredTool` class directly, or still subclass the `BaseTool` class."
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "5be41722",
+   "metadata": {},
+   "source": [
+    "### StructuredTool dataclass\n",
+    "\n",
+    "To dynamically generate a structured tool from a given function, the fastest way to get started is with `StructuredTool.from_function()`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "3c070216",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import requests\n",
+    "from langchain.tools import StructuredTool\n",
+    "\n",
+    "def post_message(url: str, body: dict, parameters: Optional[dict] = None) -> str:\n",
+    "    \"\"\"Sends a POST request to the given url with the given body and parameters.\"\"\"\n",
+    "    result = requests.post(url, json=body, params=parameters)\n",
+    "    return f\"Status: {result.status_code} - {result.text}\"\n",
+    "\n",
+    "tool = StructuredTool.from_function(post_message)"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "fb0a38eb",
+   "metadata": {},
+   "source": [
+    "## Subclassing the BaseTool\n",
+    "\n",
+    "The BaseTool automatically infers the schema from the _run method's signature."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "7505c9c5",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from typing import Optional, Type\n",
+    "\n",
+    "from langchain.callbacks.manager import AsyncCallbackManagerForToolRun, CallbackManagerForToolRun\n",
+    "            \n",
+    "class CustomSearchTool(BaseTool):\n",
+    "    name = \"custom_search\"\n",
+    "    description = \"useful for when you need to answer questions about current events\"\n",
+    "\n",
+    "    def _run(self, query: str, engine: str = \"google\", gl: str = \"us\", hl: str = \"en\", run_manager: Optional[CallbackManagerForToolRun] = None) -> str:\n",
+    "        \"\"\"Use the tool.\"\"\"\n",
+    "        search_wrapper = SerpAPIWrapper(params={\"engine\": engine, \"gl\": gl, \"hl\": hl})\n",
+    "        return search_wrapper.run(query)\n",
+    "    \n",
+    "    async def _arun(self, query: str,  engine: str = \"google\", gl: str = \"us\", hl: str = \"en\", run_manager: Optional[AsyncCallbackManagerForToolRun] = None) -> str:\n",
+    "        \"\"\"Use the tool asynchronously.\"\"\"\n",
+    "        raise NotImplementedError(\"custom_search does not support async\")\n",
+    "\n",
+    "\n",
+    "\n",
+    "# You can provide a custom args schema to add descriptions or custom validation\n",
+    "\n",
+    "class SearchSchema(BaseModel):\n",
+    "    query: str = Field(description=\"should be a search query\")\n",
+    "    engine: str = Field(description=\"should be a search engine\")\n",
+    "    gl: str = Field(description=\"should be a country code\")\n",
+    "    hl: str = Field(description=\"should be a language code\")\n",
+    "\n",
+    "class CustomSearchTool(BaseTool):\n",
+    "    name = \"custom_search\"\n",
+    "    description = \"useful for when you need to answer questions about current events\"\n",
+    "    args_schema: Type[SearchSchema] = SearchSchema\n",
+    "\n",
+    "    def _run(self, query: str, engine: str = \"google\", gl: str = \"us\", hl: str = \"en\", run_manager: Optional[CallbackManagerForToolRun] = None) -> str:\n",
+    "        \"\"\"Use the tool.\"\"\"\n",
+    "        search_wrapper = SerpAPIWrapper(params={\"engine\": engine, \"gl\": gl, \"hl\": hl})\n",
+    "        return search_wrapper.run(query)\n",
+    "    \n",
+    "    async def _arun(self, query: str,  engine: str = \"google\", gl: str = \"us\", hl: str = \"en\", run_manager: Optional[AsyncCallbackManagerForToolRun] = None) -> str:\n",
+    "        \"\"\"Use the tool asynchronously.\"\"\"\n",
+    "        raise NotImplementedError(\"custom_search does not support async\")\n",
+    "    \n",
+    "    "
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "7d68b0ac",
+   "metadata": {},
+   "source": [
+    "## Using the decorator\n",
+    "\n",
+    "The `tool` decorator creates a structured tool automatically if the signature has multiple arguments."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "id": "38d11416",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import requests\n",
+    "from langchain.tools import tool\n",
+    "\n",
+    "@tool\n",
+    "def post_message(url: str, body: dict, parameters: Optional[dict] = None) -> str:\n",
+    "    \"\"\"Sends a POST request to the given url with the given body and parameters.\"\"\"\n",
+    "    result = requests.post(url, json=body, params=parameters)\n",
+    "    return f\"Status: {result.status_code} - {result.text}\""
+   ]
+  },
+  {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "1d0430d6",
    "metadata": {},
    "source": [
     "## Modify existing tools\n",
     "\n",
-    "Now, we show how to load existing tools and just modify them. In the example below, we do something really simple and change the Search tool to have the name `Google Search`."
+    "Now, we show how to load existing tools and modify them directly. In the example below, we do something really simple and change the Search tool to have the name `Google Search`."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 13,
    "id": "79213f40",
    "metadata": {},
    "outputs": [],
@@ -454,7 +611,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 14,
    "id": "e1067dcb",
    "metadata": {},
    "outputs": [],
@@ -464,7 +621,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 15,
    "id": "6c66ffe8",
    "metadata": {},
    "outputs": [],
@@ -474,7 +631,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 17,
+   "execution_count": 16,
    "id": "f45b5bc3",
    "metadata": {},
    "outputs": [],
@@ -484,7 +641,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 18,
+   "execution_count": 17,
    "id": "565e2b9b",
    "metadata": {},
    "outputs": [
@@ -497,10 +654,18 @@
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
       "\u001b[32;1m\u001b[1;3mI need to find out Leo DiCaprio's girlfriend's name and her age.\n",
       "Action: Google Search\n",
-      "Action Input: \"Leo DiCaprio girlfriend\"\u001b[0m\u001b[36;1m\u001b[1;3mI draw the lime at going to get a Mohawk, though.\" DiCaprio broke up with girlfriend Camila Morrone, 25, in the summer of 2022, after dating for four years. He's since been linked to another famous supermodel – Gigi Hadid.\u001b[0m\u001b[32;1m\u001b[1;3mNow I need to find out Camila Morrone's current age.\n",
+      "Action Input: \"Leo DiCaprio girlfriend\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mAfter rumours of a romance with Gigi Hadid, the Oscar winner has seemingly moved on. First being linked to the television personality in September 2022, it appears as if his \"age bracket\" has moved up. This follows his rumoured relationship with mere 19-year-old Eden Polani.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI still need to find out his current girlfriend's name and her age.\n",
+      "Action: Google Search\n",
+      "Action Input: \"Leo DiCaprio current girlfriend age\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mLeonardo DiCaprio has been linked with 19-year-old model Eden Polani, continuing the rumour that he doesn't date any women over the age of ...\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI need to find out the age of Eden Polani.\n",
       "Action: Calculator\n",
-      "Action Input: 25^0.43\u001b[0m\u001b[33;1m\u001b[1;3mAnswer: 3.991298452658078\u001b[0m\u001b[32;1m\u001b[1;3mI now know the final answer.\n",
-      "Final Answer: Camila Morrone's current age raised to the 0.43 power is approximately 3.99.\u001b[0m\n",
+      "Action Input: 19^(0.43)\u001b[0m\n",
+      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 3.547023357958959\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI now know the final answer.\n",
+      "Final Answer: The age of Leo DiCaprio's girlfriend raised to the 0.43 power is approximately 3.55.\u001b[0m\n",
       "\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
@@ -508,10 +673,10 @@
     {
      "data": {
       "text/plain": [
-       "\"Camila Morrone's current age raised to the 0.43 power is approximately 3.99.\""
+       "\"The age of Leo DiCaprio's girlfriend raised to the 0.43 power is approximately 3.55.\""
       ]
      },
-     "execution_count": 18,
+     "execution_count": 17,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -537,7 +702,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 19,
+   "execution_count": 18,
    "id": "3450512e",
    "metadata": {},
    "outputs": [],
@@ -674,153 +839,6 @@
    "source": [
     "agent.run(\"whats 2**.12\")"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "8aa3c353-bd89-467c-9c27-b83a90cd4daa",
-   "metadata": {},
-   "source": [
-    "## Multi-argument tools\n",
-    "\n",
-    "Many functions expect structured inputs. These can also be supported using the Tool decorator or by directly subclassing `BaseTool`! We have to modify the LLM's OutputParser to map its string output to a dictionary to pass to the action, however."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 24,
-   "id": "537bc628",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "from typing import Optional, Union\n",
-    "\n",
-    "@tool\n",
-    "def custom_search(k: int, query: str, other_arg: Optional[str] = None):\n",
-    "    \"\"\"The custom search function.\"\"\"\n",
-    "    return f\"Here are the results for the custom search: k={k}, query={query}, other_arg={other_arg}\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 25,
-   "id": "d5c992cf-776a-40cd-a6c4-e7cf65ea709e",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "import re\n",
-    "from langchain.schema import (\n",
-    "    AgentAction,\n",
-    "    AgentFinish,\n",
-    ")\n",
-    "from langchain.agents import AgentOutputParser\n",
-    "\n",
-    "# We will add a custom parser to map the arguments to a dictionary\n",
-    "class CustomOutputParser(AgentOutputParser):\n",
-    "    \n",
-    "    def parse_tool_input(self, action_input: str) -> dict:\n",
-    "        # Regex pattern to match arguments and their values\n",
-    "        pattern = r\"(\\w+)\\s*=\\s*(None|\\\"[^\\\"]*\\\"|\\d+)\"\n",
-    "        matches = re.findall(pattern, action_input)\n",
-    "        \n",
-    "        if not matches:\n",
-    "            raise ValueError(f\"Could not parse action input: `{action_input}`\")\n",
-    "\n",
-    "        # Create a dictionary with the parsed arguments and their values\n",
-    "        parsed_input = {}\n",
-    "        for arg, value in matches:\n",
-    "            if value == \"None\":\n",
-    "                parsed_value = None\n",
-    "            elif value.isdigit():\n",
-    "                parsed_value = int(value)\n",
-    "            else:\n",
-    "                parsed_value = value.strip('\"')\n",
-    "            parsed_input[arg] = parsed_value\n",
-    "\n",
-    "        return parsed_input\n",
-    "    \n",
-    "    def parse(self, llm_output: str) -> Union[AgentAction, AgentFinish]:\n",
-    "        # Check if agent should finish\n",
-    "        if \"Final Answer:\" in llm_output:\n",
-    "            return AgentFinish(\n",
-    "                # Return values is generally always a dictionary with a single `output` key\n",
-    "                # It is not recommended to try anything else at the moment :)\n",
-    "                return_values={\"output\": llm_output.split(\"Final Answer:\")[-1].strip()},\n",
-    "                log=llm_output,\n",
-    "            )\n",
-    "        # Parse out the action and action input\n",
-    "        regex = r\"Action\\s*\\d*\\s*:(.*?)\\nAction\\s*\\d*\\s*Input\\s*\\d*\\s*:[\\s]*(.*)\"\n",
-    "        match = re.search(regex, llm_output, re.DOTALL)\n",
-    "        if not match:\n",
-    "            raise ValueError(f\"Could not parse LLM output: `{llm_output}`\")\n",
-    "        action = match.group(1).strip()\n",
-    "        action_input = match.group(2)\n",
-    "        tool_input = self.parse_tool_input(action_input)\n",
-    "        # Return the action and action \n",
-    "        return AgentAction(tool=action, tool_input=tool_input, log=llm_output)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 26,
-   "id": "68269547-1482-4138-a6ea-58f00b4a9548",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)\n",
-    "agent = initialize_agent([custom_search], llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True, agent_kwargs={\"output_parser\": CustomOutputParser()})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 27,
-   "id": "0947835a-691c-4f51-b8f4-6744e0e48ab1",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to use a search function to find the answer\n",
-      "Action: custom_search\n",
-      "Action Input: k=1, query=\"me\"\u001b[0m\u001b[36;1m\u001b[1;3mHere are the results for the custom search: k=1, query=me, other_arg=None\u001b[0m\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: The results of the custom search for k=1, query=me, other_arg=None.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'The results of the custom search for k=1, query=me, other_arg=None.'"
-      ]
-     },
-     "execution_count": 27,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"Search for me and tell me whatever it says\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "caf39c66-102b-42c1-baf2-777a49886ce4",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
@@ -839,7 +857,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.11.2"
   },
   "vscode": {
    "interpreter": {

docs/modules/agents/tools/examples/apify.ipynb

@@ -1,7 +1,6 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -20,7 +19,15 @@
    ]
   },
   {
-   "attachments": {},
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#!pip install apify-client"
+   ]
+  },
+  {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -39,7 +46,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -60,7 +66,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -85,7 +90,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -102,7 +106,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -156,9 +159,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/modules/agents/tools/examples/arxiv.ipynb

@@ -5,7 +5,7 @@
    "id": "245a954a",
    "metadata": {},
    "source": [
-    "# Arxiv API\n",
+    "# ArXiv API Tool\n",
     "\n",
     "This notebook goes over how to use the `arxiv` component. \n",
     "\n",
@@ -30,6 +30,92 @@
   {
    "cell_type": "code",
    "execution_count": 2,
+   "id": "ce1a4827-ce89-4f31-a041-3246743e513a",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.chat_models import ChatOpenAI\n",
+    "from langchain.agents import load_tools, initialize_agent, AgentType\n",
+    "\n",
+    "llm = ChatOpenAI(temperature=0.0)\n",
+    "tools = load_tools(\n",
+    "    [\"arxiv\"], \n",
+    ")\n",
+    "\n",
+    "agent_chain = initialize_agent(\n",
+    "    tools,\n",
+    "    llm,\n",
+    "    agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION,\n",
+    "    verbose=True,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "ad7dd945-5ae3-49e5-b667-6d86b15050b6",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mI need to use Arxiv to search for the paper.\n",
+      "Action: Arxiv\n",
+      "Action Input: \"1605.08386\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mPublished: 2016-05-26\n",
+      "Title: Heat-bath random walks with Markov bases\n",
+      "Authors: Caprice Stanley, Tobias Windisch\n",
+      "Summary: Graphs on lattice points are studied whose edges come from a finite set of\n",
+      "allowed moves of arbitrary length. We show that the diameter of these graphs on\n",
+      "fibers of a fixed integer matrix can be bounded from above by a constant. We\n",
+      "then study the mixing behaviour of heat-bath random walks on these graphs. We\n",
+      "also state explicit conditions on the set of moves so that the heat-bath random\n",
+      "walk, a generalization of the Glauber dynamics, is an expander in fixed\n",
+      "dimension.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mThe paper is about heat-bath random walks with Markov bases on graphs of lattice points.\n",
+      "Final Answer: The paper 1605.08386 is about heat-bath random walks with Markov bases on graphs of lattice points.\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'The paper 1605.08386 is about heat-bath random walks with Markov bases on graphs of lattice points.'"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent_chain.run(\n",
+    "    \"What's the paper 1605.08386 about?\",\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b4183343-d69a-4be0-9b2c-cc98464a6825",
+   "metadata": {},
+   "source": [
+    "## The ArXiv API Wrapper\n",
+    "\n",
+    "The tool wraps the API Wrapper. Below, we can explore some of the features it provides."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
    "id": "8d32b39a",
    "metadata": {
     "tags": []
@@ -40,20 +126,24 @@
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "2a50dd27",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
+   "cell_type": "markdown",
+   "id": "c89c110c-96ac-4fe1-ba3e-6056543d1a59",
+   "metadata": {},
    "source": [
-    "arxiv = ArxivAPIWrapper()"
+    "Run a query to get information about some `scientific article`/articles. The query text is limited to 300 characters.\n",
+    "\n",
+    "It returns these article fields:\n",
+    "- Publishing date\n",
+    "- Title\n",
+    "- Authors\n",
+    "- Summary\n",
+    "\n",
+    "Next query returns information about one article with arxiv Id equal \"1605.08386\". "
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "id": "34bb5968",
    "metadata": {
     "tags": []
@@ -65,19 +155,32 @@
        "'Published: 2016-05-26\\nTitle: Heat-bath random walks with Markov bases\\nAuthors: Caprice Stanley, Tobias Windisch\\nSummary: Graphs on lattice points are studied whose edges come from a finite set of\\nallowed moves of arbitrary length. We show that the diameter of these graphs on\\nfibers of a fixed integer matrix can be bounded from above by a constant. We\\nthen study the mixing behaviour of heat-bath random walks on these graphs. We\\nalso state explicit conditions on the set of moves so that the heat-bath random\\nwalk, a generalization of the Glauber dynamics, is an expander in fixed\\ndimension.'"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
+    "\n",
+    "arxiv = ArxivAPIWrapper()\n",
     "docs = arxiv.run(\"1605.08386\")\n",
     "docs"
    ]
   },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "840f70c9-8f80-4680-bb38-46198e931bcf",
+   "metadata": {},
+   "source": [
+    "Now, we want to get information about one author, `Caprice Stanley`.\n",
+    "\n",
+    "This query returns information about three articles. By default, the query returns information only about three top articles."
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "id": "b0867fda-e119-4b19-9ec6-e354fa821db3",
    "metadata": {
     "tags": []
@@ -89,7 +192,7 @@
        "'Published: 2017-10-10\\nTitle: On Mixing Behavior of a Family of Random Walks Determined by a Linear Recurrence\\nAuthors: Caprice Stanley, Seth Sullivant\\nSummary: We study random walks on the integers mod $G_n$ that are determined by an\\ninteger sequence $\\\\{ G_n \\\\}_{n \\\\geq 1}$ generated by a linear recurrence\\nrelation. Fourier analysis provides explicit formulas to compute the\\neigenvalues of the transition matrices and we use this to bound the mixing time\\nof the random walks.\\n\\nPublished: 2016-05-26\\nTitle: Heat-bath random walks with Markov bases\\nAuthors: Caprice Stanley, Tobias Windisch\\nSummary: Graphs on lattice points are studied whose edges come from a finite set of\\nallowed moves of arbitrary length. We show that the diameter of these graphs on\\nfibers of a fixed integer matrix can be bounded from above by a constant. We\\nthen study the mixing behaviour of heat-bath random walks on these graphs. We\\nalso state explicit conditions on the set of moves so that the heat-bath random\\nwalk, a generalization of the Glauber dynamics, is an expander in fixed\\ndimension.\\n\\nPublished: 2003-03-18\\nTitle: Calculation of fluxes of charged particles and neutrinos from atmospheric showers\\nAuthors: V. Plyaskin\\nSummary: The results on the fluxes of charged particles and neutrinos from a\\n3-dimensional (3D) simulation of atmospheric showers are presented. An\\nagreement of calculated fluxes with data on charged particles from the AMS and\\nCAPRICE detectors is demonstrated. Predictions on neutrino fluxes at different\\nexperimental sites are compared with results from other calculations.'"
       ]
      },
-     "execution_count": 5,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -99,9 +202,17 @@
     "docs"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "2d9b6292-a47d-4f99-9827-8e9f244bf887",
+   "metadata": {},
+   "source": [
+    "Now, we are trying to find information about non-existing article. In this case, the response is \"No good Arxiv Result was found\""
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 7,
    "id": "3580aeeb-086f-45ba-bcdc-b46f5134b3dd",
    "metadata": {
     "tags": []
@@ -113,7 +224,7 @@
        "'No good Arxiv Result was found'"
       ]
      },
-     "execution_count": 6,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -122,14 +233,6 @@
     "docs = arxiv.run(\"1605.08386WWW\")\n",
     "docs"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4f4e9602",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
@@ -148,7 +251,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.4"
   }
  },
  "nbformat": 4,

docs/modules/agents/tools/examples/awslambda.ipynb

@@ -0,0 +1,119 @@
+{
+ "cells": [
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## AWS Lambda API"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This notebook goes over how to use the AWS Lambda Tool component.\n",
+    "\n",
+    "AWS Lambda is a serverless computing service provided by Amazon Web Services (AWS), designed to allow developers to build and run applications and services without the need for provisioning or managing servers. This serverless architecture enables you to focus on writing and deploying code, while AWS automatically takes care of scaling, patching, and managing the infrastructure required to run your applications.\n",
+    "\n",
+    "By including a `awslambda` in the list of tools provided to an Agent, you can grant your Agent the ability to invoke code running in your AWS Cloud for whatever purposes you need.\n",
+    "\n",
+    "When an Agent uses the awslambda tool, it will provide an argument of type string which will in turn be passed into the Lambda function via the event parameter.\n",
+    "\n",
+    "First, you need to install `boto3` python package."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "vscode": {
+     "languageId": "shellscript"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "!pip install boto3 > /dev/null"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "In order for an agent to use the tool, you must provide it with the name and description that match the functionality of you lambda function's logic. \n",
+    "\n",
+    "You must also provide the name of your function. "
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Note that because this tool is effectively just a wrapper around the boto3 library, you will need to run `aws configure` in order to make use of the tool. For more detail, see [here](https://docs.aws.amazon.com/cli/index.html)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "vscode": {
+     "languageId": "shellscript"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "from langchain import OpenAI\n",
+    "from langchain.agents import load_tools, AgentType\n",
+    "\n",
+    "llm = OpenAI(temperature=0)\n",
+    "\n",
+    "tools = load_tools(\n",
+    "    [\"awslambda\"],\n",
+    "    awslambda_tool_name=\"email-sender\",\n",
+    "    awslambda_tool_description=\"sends an email with the specified content to test@testing123.com\",\n",
+    "    function_name=\"testFunction1\"\n",
+    ")\n",
+    "\n",
+    "agent = initialize_agent(tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True)\n",
+    "\n",
+    "agent.run(\"Send an email to test@testing123.com saying hello world.\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "vscode": {
+     "languageId": "shellscript"
+    }
+   },
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.2"
+  },
+  "orig_nbformat": 4
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/modules/agents/tools/examples/bash.ipynb

@@ -5,57 +5,158 @@
       "id": "8f210ec3",
       "metadata": {},
       "source": [
-        "# Bash\n",
-        "It can often be useful to have an LLM generate bash commands, and then run them. A common use case for this is letting the LLM interact with your local file system. We provide an easy util to execute bash commands."
+        "# Shell Tool\n",
+        "\n",
+        "Giving agents access to the shell is powerful (though risky outside a sandboxed environment).\n",
+        "\n",
+        "The LLM can use it to execute any shell commands. A common use case for this is letting the LLM interact with your local file system."
       ]
     },
     {
       "cell_type": "code",
       "execution_count": 1,
       "id": "f7b3767b",
-      "metadata": {},
+      "metadata": {
+        "tags": []
+      },
       "outputs": [],
       "source": [
-        "from langchain.utilities import BashProcess"
+        "from langchain.tools import ShellTool\n",
+        "\n",
+        "shell_tool = ShellTool()"
       ]
     },
     {
       "cell_type": "code",
       "execution_count": 2,
-      "id": "cf1c92f0",
-      "metadata": {},
-      "outputs": [],
-      "source": [
-        "bash = BashProcess()"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": 3,
-      "id": "2fa952fc",
-      "metadata": {},
+      "id": "c92ac832-556b-4f66-baa4-b78f965dfba0",
+      "metadata": {
+        "tags": []
+      },
       "outputs": [
         {
           "name": "stdout",
           "output_type": "stream",
           "text": [
-            "bash.ipynb\n",
-            "google_search.ipynb\n",
-            "python.ipynb\n",
-            "requests.ipynb\n",
-            "serpapi.ipynb\n",
+            "Hello World!\n",
+            "\n",
+            "real\t0m0.000s\n",
+            "user\t0m0.000s\n",
+            "sys\t0m0.000s\n",
             "\n"
           ]
+        },
+        {
+          "name": "stderr",
+          "output_type": "stream",
+          "text": [
+            "/Users/wfh/code/lc/lckg/langchain/tools/shell/tool.py:34: UserWarning: The shell tool has no safeguards by default. Use at your own risk.\n",
+            "  warnings.warn(\n"
+          ]
         }
       ],
       "source": [
-        "print(bash.run(\"ls\"))"
+        "print(shell_tool.run({\"commands\": [\"echo 'Hello World!'\", \"time\"]}))"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "id": "2fa952fc",
+      "metadata": {},
+      "source": [
+        "### Use with Agents\n",
+        "\n",
+        "As with all tools, these can be given to an agent to accomplish more complex tasks. Let's have the agent fetch some links from a web page."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": 3,
+      "id": "851fee9f",
+      "metadata": {
+        "tags": []
+      },
+      "outputs": [
+        {
+          "name": "stdout",
+          "output_type": "stream",
+          "text": [
+            "\n",
+            "\n",
+            "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+            "\u001b[32;1m\u001b[1;3mQuestion: What is the task?\n",
+            "Thought: We need to download the langchain.com webpage and extract all the URLs from it. Then we need to sort the URLs and return them.\n",
+            "Action:\n",
+            "```\n",
+            "{\n",
+            "  \"action\": \"shell\",\n",
+            "  \"action_input\": {\n",
+            "    \"commands\": [\n",
+            "      \"curl -s https://langchain.com | grep -o 'http[s]*://[^\\\" ]*' | sort\"\n",
+            "    ]\n",
+            "  }\n",
+            "}\n",
+            "```\n",
+            "\u001b[0m"
+          ]
+        },
+        {
+          "name": "stderr",
+          "output_type": "stream",
+          "text": [
+            "/Users/wfh/code/lc/lckg/langchain/tools/shell/tool.py:34: UserWarning: The shell tool has no safeguards by default. Use at your own risk.\n",
+            "  warnings.warn(\n"
+          ]
+        },
+        {
+          "name": "stdout",
+          "output_type": "stream",
+          "text": [
+            "\n",
+            "Observation: \u001b[36;1m\u001b[1;3mhttps://blog.langchain.dev/\n",
+            "https://discord.gg/6adMQxSpJS\n",
+            "https://docs.langchain.com/docs/\n",
+            "https://github.com/hwchase17/chat-langchain\n",
+            "https://github.com/hwchase17/langchain\n",
+            "https://github.com/hwchase17/langchainjs\n",
+            "https://github.com/sullivan-sean/chat-langchainjs\n",
+            "https://js.langchain.com/docs/\n",
+            "https://python.langchain.com/en/latest/\n",
+            "https://twitter.com/langchainai\n",
+            "\u001b[0m\n",
+            "Thought:\u001b[32;1m\u001b[1;3mThe URLs have been successfully extracted and sorted. We can return the list of URLs as the final answer.\n",
+            "Final Answer: [\"https://blog.langchain.dev/\", \"https://discord.gg/6adMQxSpJS\", \"https://docs.langchain.com/docs/\", \"https://github.com/hwchase17/chat-langchain\", \"https://github.com/hwchase17/langchain\", \"https://github.com/hwchase17/langchainjs\", \"https://github.com/sullivan-sean/chat-langchainjs\", \"https://js.langchain.com/docs/\", \"https://python.langchain.com/en/latest/\", \"https://twitter.com/langchainai\"]\u001b[0m\n",
+            "\n",
+            "\u001b[1m> Finished chain.\u001b[0m\n"
+          ]
+        },
+        {
+          "data": {
+            "text/plain": [
+              "'[\"https://blog.langchain.dev/\", \"https://discord.gg/6adMQxSpJS\", \"https://docs.langchain.com/docs/\", \"https://github.com/hwchase17/chat-langchain\", \"https://github.com/hwchase17/langchain\", \"https://github.com/hwchase17/langchainjs\", \"https://github.com/sullivan-sean/chat-langchainjs\", \"https://js.langchain.com/docs/\", \"https://python.langchain.com/en/latest/\", \"https://twitter.com/langchainai\"]'"
+            ]
+          },
+          "execution_count": 3,
+          "metadata": {},
+          "output_type": "execute_result"
+        }
+      ],
+      "source": [
+        "from langchain.chat_models import ChatOpenAI\n",
+        "from langchain.agents import initialize_agent\n",
+        "from langchain.agents import AgentType\n",
+        "\n",
+        "llm = ChatOpenAI(temperature=0)\n",
+        "\n",
+        "shell_tool.description = shell_tool.description + f\"args {shell_tool.args}\".replace(\"{\", \"{{\").replace(\"}\", \"}}\")\n",
+        "self_ask_with_search = initialize_agent([shell_tool], llm, agent=AgentType.CHAT_ZERO_SHOT_REACT_DESCRIPTION, verbose=True)\n",
+        "self_ask_with_search.run(\"Download the langchain.com webpage and grep for all urls. Return only a sorted list of them. Be sure to use double quotes.\")"
       ]
     },
     {
       "cell_type": "code",
       "execution_count": null,
-      "id": "851fee9f",
+      "id": "8d0ea3ac-0890-4e39-9cec-74bd80b4b8b8",
       "metadata": {},
       "outputs": [],
       "source": []
@@ -77,7 +178,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.10.9"
+      "version": "3.8.16"
     }
   },
   "nbformat": 4,

docs/modules/agents/tools/examples/ddg.ipynb

@@ -27,7 +27,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from langchain.tools import DuckDuckGoSearchTool"
+    "from langchain.tools import DuckDuckGoSearchRun"
    ]
   },
   {
@@ -37,7 +37,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "search = DuckDuckGoSearchTool()"
+    "search = DuckDuckGoSearchRun()"
    ]
   },
   {

docs/modules/agents/tools/examples/filesystem.ipynb

@@ -0,0 +1,190 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# File System Tools\n",
+    "\n",
+    "LangChain provides tools for interacting with a local file system out of the box. This notebook walks through some of them.\n",
+    "\n",
+    "Note: these tools are not recommended for use outside a sandboxed environment! "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "First, we'll import the tools."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.tools.file_management import (\n",
+    "    ReadFileTool,\n",
+    "    CopyFileTool,\n",
+    "    DeleteFileTool,\n",
+    "    MoveFileTool,\n",
+    "    WriteFileTool,\n",
+    "    ListDirectoryTool,\n",
+    ")\n",
+    "from langchain.agents.agent_toolkits import FileManagementToolkit\n",
+    "from tempfile import TemporaryDirectory\n",
+    "\n",
+    "# We'll make a temporary directory to avoid clutter\n",
+    "working_directory = TemporaryDirectory()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## The FileManagementToolkit\n",
+    "\n",
+    "If you want to provide all the file tooling to your agent, it's easy to do so with the toolkit. We'll pass the temporary directory in as a root directory as a workspace for the LLM.\n",
+    "\n",
+    "It's recommended to always pass in a root directory, since without one, it's easy for the LLM to pollute the working directory, and without one, there isn't any validation against\n",
+    "straightforward prompt injection."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[CopyFileTool(name='copy_file', description='Create a copy of a file in a specified location', args_schema=<class 'langchain.tools.file_management.copy.FileCopyInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
+       " DeleteFileTool(name='file_delete', description='Delete a file', args_schema=<class 'langchain.tools.file_management.delete.FileDeleteInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
+       " FileSearchTool(name='file_search', description='Recursively search for files in a subdirectory that match the regex pattern', args_schema=<class 'langchain.tools.file_management.file_search.FileSearchInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
+       " MoveFileTool(name='move_file', description='Move or rename a file from one location to another', args_schema=<class 'langchain.tools.file_management.move.FileMoveInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
+       " ReadFileTool(name='read_file', description='Read file from disk', args_schema=<class 'langchain.tools.file_management.read.ReadFileInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
+       " WriteFileTool(name='write_file', description='Write file to disk', args_schema=<class 'langchain.tools.file_management.write.WriteFileInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
+       " ListDirectoryTool(name='list_directory', description='List files and directories in a specified folder', args_schema=<class 'langchain.tools.file_management.list_dir.DirectoryListingInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug')]"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "toolkit = FileManagementToolkit(root_dir=str(working_directory.name)) # If you don't provide a root_dir, operations will default to the current working directory\n",
+    "toolkit.get_tools()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Selecting File System Tools\n",
+    "\n",
+    "If you only want to select certain tools, you can pass them in as arguments when initializing the toolkit, or you can individually initialize the desired tools."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[ReadFileTool(name='read_file', description='Read file from disk', args_schema=<class 'langchain.tools.file_management.read.ReadFileInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
+       " WriteFileTool(name='write_file', description='Write file to disk', args_schema=<class 'langchain.tools.file_management.write.WriteFileInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug'),\n",
+       " ListDirectoryTool(name='list_directory', description='List files and directories in a specified folder', args_schema=<class 'langchain.tools.file_management.list_dir.DirectoryListingInput'>, return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1156f4350>, root_dir='/var/folders/gf/6rnp_mbx5914kx7qmmh7xzmw0000gn/T/tmpxb8c3aug')]"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "tools = FileManagementToolkit(root_dir=str(working_directory.name), selected_tools=[\"read_file\", \"write_file\", \"list_directory\"]).get_tools()\n",
+    "tools"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'File written successfully to example.txt.'"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "read_tool, write_tool, list_tool = tools\n",
+    "write_tool.run({\"file_path\": \"example.txt\", \"text\": \"Hello World!\"})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'example.txt'"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# List files in the working directory\n",
+    "list_tool.run({})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

docs/modules/agents/tools/examples/google_search.ipynb

@@ -33,7 +33,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from langchain.utilities import GoogleSearchAPIWrapper"
+    "from langchain.tools import Tool\n",
+    "from langchain.utilities import GoogleSearchAPIWrapper\n",
+    "\n",
+    "search = GoogleSearchAPIWrapper()\n",
+    "\n",
+    "tool = Tool(\n",
+    "    name = \"Google Search\",\n",
+    "    description=\"Search Google for recent results.\",\n",
+    "    func=search.run\n",
+    ")"
    ]
   },
   {
@@ -41,30 +50,20 @@
    "execution_count": 3,
    "id": "84b8f773",
    "metadata": {},
-   "outputs": [],
-   "source": [
-    "search = GoogleSearchAPIWrapper()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "068991a6",
-   "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "'1 Child\\'s First Name. 2. 6. 7d. Street Address. 71. (Type or print). BARACK. Sex. 3. This Birth. 4. If Twin or Triplet,. Was Child Born. Barack Hussein Obama II is an American retired politician who served as the 44th president of the United States from 2009 to 2017. His full name is Barack Hussein Obama II. Since the “II” is simply because he was named for his father, his last name is Obama. Feb 9, 2015 ... Michael Jordan misspelled Barack Obama\\'s first name on 50th-birthday gift ... Knowing Obama is a Chicagoan and huge basketball fan,\\xa0... Aug 18, 2017 ... It took him several seconds and multiple clues to remember former President Barack Obama\\'s first name. Miller knew that every answer had to end\\xa0... First Lady Michelle LaVaughn Robinson Obama is a lawyer, writer, and the wife of the 44th President, Barack Obama. She is the first African-American First\\xa0... Barack Obama, in full Barack Hussein Obama II, (born August 4, 1961, Honolulu, Hawaii, U.S.), 44th president of the United States (2009–17) and the first\\xa0... When Barack Obama was elected president in 2008, he became the first African American to hold ... The Middle East remained a key foreign policy challenge. Feb 27, 2020 ... President Barack Obama was born Barack Hussein Obama, II, as shown here on his birth certificate here . As reported by Reuters here , his\\xa0... Jan 16, 2007 ... 4, 1961, in Honolulu. His first name means \"one who is blessed\" in Swahili. While Obama\\'s father, Barack Hussein Obama Sr., was from Kenya, his\\xa0...'"
+       "\"STATE OF HAWAII. 1 Child's First Name. (Type or print). 2. Sex. BARACK. 3. This Birth. CERTIFICATE OF LIVE BIRTH. FILE. NUMBER 151 le. lb. Middle Name. Barack Hussein Obama II is an American former politician who served as the 44th president of the United States from 2009 to 2017. A member of the Democratic\\xa0... When Barack Obama was elected president in 2008, he became the first African American to hold ... The Middle East remained a key foreign policy challenge. Jan 19, 2017 ... Jordan Barack Treasure, New York City, born in 2008 ... Jordan Barack Treasure made national news when he was the focus of a New York newspaper\\xa0... Portrait of George Washington, the 1st President of the United States ... Portrait of Barack Obama, the 44th President of the United States\\xa0... His full name is Barack Hussein Obama II. Since the “II” is simply because he was named for his father, his last name is Obama. Mar 22, 2008 ... Barry Obama decided that he didn't like his nickname. A few of his friends at Occidental College had already begun to call him Barack (his\\xa0... Aug 18, 2017 ... It took him several seconds and multiple clues to remember former President Barack Obama's first name. Miller knew that every answer had to\\xa0... Feb 9, 2015 ... Michael Jordan misspelled Barack Obama's first name on 50th-birthday gift ... Knowing Obama is a Chicagoan and huge basketball fan,\\xa0... 4 days ago ... Barack Obama, in full Barack Hussein Obama II, (born August 4, 1961, Honolulu, Hawaii, U.S.), 44th president of the United States (2009–17) and\\xa0...\""
       ]
      },
-     "execution_count": 4,
+     "execution_count": 3,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "search.run(\"Obama's first name?\")"
+    "tool.run(\"Obama's first name?\")"
    ]
   },
   {
@@ -78,17 +77,23 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 4,
    "id": "5083fbdd",
    "metadata": {},
    "outputs": [],
    "source": [
-    "search = GoogleSearchAPIWrapper(k=1)"
+    "search = GoogleSearchAPIWrapper(k=1)\n",
+    "\n",
+    "tool = Tool(\n",
+    "    name = \"I'm Feeling Lucky\",\n",
+    "    description=\"Search Google and return the first result.\",\n",
+    "    func=search.run\n",
+    ")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 5,
    "id": "77aaa857",
    "metadata": {},
    "outputs": [
@@ -98,13 +103,13 @@
        "'The official home of the Python Programming Language.'"
       ]
      },
-     "execution_count": 6,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "search.run(\"python\")"
+    "tool.run(\"python\")"
    ]
   },
   {
@@ -137,48 +142,30 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 6,
    "id": "028f4cba",
    "metadata": {},
    "outputs": [],
    "source": [
-    "search = GoogleSearchAPIWrapper()"
+    "search = GoogleSearchAPIWrapper()\n",
+    "\n",
+    "def top5_results(query):\n",
+    "    return search.results(query, 5)\n",
+    "\n",
+    "tool = Tool(\n",
+    "    name = \"Google Search Snippets\",\n",
+    "    description=\"Search Google for recent results.\",\n",
+    "    func=top5_results\n",
+    ")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
-   "id": "4d8f734f",
+   "execution_count": null,
+   "id": "4d7f92e1",
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[{'snippet': 'Discover the innovative world of Apple and shop everything iPhone, iPad, Apple Watch, Mac, and Apple TV, plus explore accessories, entertainment,\\xa0...',\n",
-       "  'title': 'Apple',\n",
-       "  'link': 'https://www.apple.com/'},\n",
-       " {'snippet': \"Jul 10, 2022 ... Whether or not you're up on your apple trivia, no doubt you know how delicious this popular fruit is, and how nutritious. Apples are rich in\\xa0...\",\n",
-       "  'title': '25 Types of Apples and What to Make With Them - Parade ...',\n",
-       "  'link': 'https://parade.com/1330308/bethlipton/types-of-apples/'},\n",
-       " {'snippet': 'An apple is an edible fruit produced by an apple tree (Malus domestica). Apple trees are cultivated worldwide and are the most widely grown species in the\\xa0...',\n",
-       "  'title': 'Apple - Wikipedia',\n",
-       "  'link': 'https://en.wikipedia.org/wiki/Apple'},\n",
-       " {'snippet': 'Apples are a popular fruit. They contain antioxidants, vitamins, dietary fiber, and a range of other nutrients. Due to their varied nutrient content,\\xa0...',\n",
-       "  'title': 'Apples: Benefits, nutrition, and tips',\n",
-       "  'link': 'https://www.medicalnewstoday.com/articles/267290'},\n",
-       " {'snippet': \"An apple is a crunchy, bright-colored fruit, one of the most popular in the United States. You've probably heard the age-old saying, “An apple a day keeps\\xa0...\",\n",
-       "  'title': 'Apples: Nutrition & Health Benefits',\n",
-       "  'link': 'https://www.webmd.com/food-recipes/benefits-apples'}]"
-      ]
-     },
-     "execution_count": 8,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "search.results(\"apples\", 5)"
-   ]
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -197,7 +184,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.11.2"
   },
   "vscode": {
    "interpreter": {

docs/modules/agents/tools/examples/google_serper.ipynb

@@ -12,21 +12,34 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 11,
    "outputs": [],
    "source": [
     "import os\n",
+    "import pprint\n",
     "os.environ[\"SERPER_API_KEY\"] = \"\""
    ],
    "metadata": {
-    "collapsed": false
+    "collapsed": false,
+    "pycharm": {
+     "is_executing": true
+    },
+    "ExecuteTime": {
+     "end_time": "2023-05-04T00:56:29.336521Z",
+     "start_time": "2023-05-04T00:56:29.334173Z"
+    }
    }
   },
   {
    "cell_type": "code",
    "execution_count": 2,
    "id": "54bf5afd",
-   "metadata": {},
+   "metadata": {
+    "ExecuteTime": {
+     "end_time": "2023-05-04T00:54:07.676293Z",
+     "start_time": "2023-05-04T00:54:06.665742Z"
+    }
+   },
    "outputs": [],
    "source": [
     "from langchain.utilities import GoogleSerperAPIWrapper"
@@ -36,7 +49,12 @@
    "cell_type": "code",
    "execution_count": 3,
    "id": "31f8f382",
-   "metadata": {},
+   "metadata": {
+    "ExecuteTime": {
+     "end_time": "2023-05-04T00:54:08.324245Z",
+     "start_time": "2023-05-04T00:54:08.321577Z"
+    }
+   },
    "outputs": [],
    "source": [
     "search = GoogleSerperAPIWrapper()"
@@ -46,7 +64,12 @@
    "cell_type": "code",
    "execution_count": 4,
    "id": "25ce0225",
-   "metadata": {},
+   "metadata": {
+    "ExecuteTime": {
+     "end_time": "2023-05-04T00:54:11.399847Z",
+     "start_time": "2023-05-04T00:54:09.335597Z"
+    }
+   },
    "outputs": [
     {
      "data": {
@@ -72,13 +95,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 5,
    "outputs": [],
    "source": [
     "os.environ['OPENAI_API_KEY'] = \"\""
    ],
    "metadata": {
-    "collapsed": false
+    "collapsed": false,
+    "ExecuteTime": {
+     "end_time": "2023-05-04T00:54:14.311773Z",
+     "start_time": "2023-05-04T00:54:14.304389Z"
+    }
    }
   },
   {
@@ -133,6 +160,693 @@
    "metadata": {
     "collapsed": false
    }
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "## Obtaining results with metadata\n",
+    "If you would also like to obtain the results in a structured way including metadata. For this we will be using the `results` method of the wrapper."
+   ],
+   "metadata": {
+    "collapsed": false
+   }
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "{'searchParameters': {'q': 'Apple Inc.',\n",
+      "                      'gl': 'us',\n",
+      "                      'hl': 'en',\n",
+      "                      'num': 10,\n",
+      "                      'type': 'search'},\n",
+      " 'knowledgeGraph': {'title': 'Apple',\n",
+      "                    'type': 'Technology company',\n",
+      "                    'website': 'http://www.apple.com/',\n",
+      "                    'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQwGQRv5TjjkycpctY66mOg_e2-npacrmjAb6_jAWhzlzkFE3OTjxyzbA&s=0',\n",
+      "                    'description': 'Apple Inc. is an American multinational '\n",
+      "                                   'technology company headquartered in '\n",
+      "                                   'Cupertino, California. Apple is the '\n",
+      "                                   \"world's largest technology company by \"\n",
+      "                                   'revenue, with US$394.3 billion in 2022 '\n",
+      "                                   'revenue. As of March 2023, Apple is the '\n",
+      "                                   \"world's biggest...\",\n",
+      "                    'descriptionSource': 'Wikipedia',\n",
+      "                    'descriptionLink': 'https://en.wikipedia.org/wiki/Apple_Inc.',\n",
+      "                    'attributes': {'Customer service': '1 (800) 275-2273',\n",
+      "                                   'CEO': 'Tim Cook (Aug 24, 2011–)',\n",
+      "                                   'Headquarters': 'Cupertino, CA',\n",
+      "                                   'Founded': 'April 1, 1976, Los Altos, CA',\n",
+      "                                   'Founders': 'Steve Jobs, Steve Wozniak, '\n",
+      "                                               'Ronald Wayne, and more',\n",
+      "                                   'Products': 'iPhone, iPad, Apple TV, and '\n",
+      "                                               'more'}},\n",
+      " 'organic': [{'title': 'Apple',\n",
+      "              'link': 'https://www.apple.com/',\n",
+      "              'snippet': 'Discover the innovative world of Apple and shop '\n",
+      "                         'everything iPhone, iPad, Apple Watch, Mac, and Apple '\n",
+      "                         'TV, plus explore accessories, entertainment, ...',\n",
+      "              'sitelinks': [{'title': 'Support',\n",
+      "                             'link': 'https://support.apple.com/'},\n",
+      "                            {'title': 'iPhone',\n",
+      "                             'link': 'https://www.apple.com/iphone/'},\n",
+      "                            {'title': 'Site Map',\n",
+      "                             'link': 'https://www.apple.com/sitemap/'},\n",
+      "                            {'title': 'Business',\n",
+      "                             'link': 'https://www.apple.com/business/'},\n",
+      "                            {'title': 'Mac',\n",
+      "                             'link': 'https://www.apple.com/mac/'},\n",
+      "                            {'title': 'Watch',\n",
+      "                             'link': 'https://www.apple.com/watch/'}],\n",
+      "              'position': 1},\n",
+      "             {'title': 'Apple Inc. - Wikipedia',\n",
+      "              'link': 'https://en.wikipedia.org/wiki/Apple_Inc.',\n",
+      "              'snippet': 'Apple Inc. is an American multinational technology '\n",
+      "                         'company headquartered in Cupertino, California. '\n",
+      "                         \"Apple is the world's largest technology company by \"\n",
+      "                         'revenue, ...',\n",
+      "              'attributes': {'Products': 'AirPods; Apple Watch; iPad; iPhone; '\n",
+      "                                         'Mac; Full list',\n",
+      "                             'Founders': 'Steve Jobs; Steve Wozniak; Ronald '\n",
+      "                                         'Wayne; Mike Markkula'},\n",
+      "              'sitelinks': [{'title': 'History',\n",
+      "                             'link': 'https://en.wikipedia.org/wiki/History_of_Apple_Inc.'},\n",
+      "                            {'title': 'Timeline of Apple Inc. products',\n",
+      "                             'link': 'https://en.wikipedia.org/wiki/Timeline_of_Apple_Inc._products'},\n",
+      "                            {'title': 'Litigation involving Apple Inc.',\n",
+      "                             'link': 'https://en.wikipedia.org/wiki/Litigation_involving_Apple_Inc.'},\n",
+      "                            {'title': 'Apple Store',\n",
+      "                             'link': 'https://en.wikipedia.org/wiki/Apple_Store'}],\n",
+      "              'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRvmB5fT1LjqpZx02UM7IJq0Buoqt0DZs_y0dqwxwSWyP4PIN9FaxuTea0&s',\n",
+      "              'position': 2},\n",
+      "             {'title': 'Apple Inc. | History, Products, Headquarters, & Facts '\n",
+      "                       '| Britannica',\n",
+      "              'link': 'https://www.britannica.com/topic/Apple-Inc',\n",
+      "              'snippet': 'Apple Inc., formerly Apple Computer, Inc., American '\n",
+      "                         'manufacturer of personal computers, smartphones, '\n",
+      "                         'tablet computers, computer peripherals, and computer '\n",
+      "                         '...',\n",
+      "              'attributes': {'Related People': 'Steve Jobs Steve Wozniak Jony '\n",
+      "                                               'Ive Tim Cook Angela Ahrendts',\n",
+      "                             'Date': '1976 - present'},\n",
+      "              'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcS3liELlhrMz3Wpsox29U8jJ3L8qETR0hBWHXbFnwjwQc34zwZvFELst2E&s',\n",
+      "              'position': 3},\n",
+      "             {'title': 'AAPL: Apple Inc Stock Price Quote - NASDAQ GS - '\n",
+      "                       'Bloomberg.com',\n",
+      "              'link': 'https://www.bloomberg.com/quote/AAPL:US',\n",
+      "              'snippet': 'AAPL:USNASDAQ GS. Apple Inc. COMPANY INFO ; Open. '\n",
+      "                         '170.09 ; Prev Close. 169.59 ; Volume. 48,425,696 ; '\n",
+      "                         'Market Cap. 2.667T ; Day Range. 167.54170.35.',\n",
+      "              'position': 4},\n",
+      "             {'title': 'Apple Inc. (AAPL) Company Profile & Facts - Yahoo '\n",
+      "                       'Finance',\n",
+      "              'link': 'https://finance.yahoo.com/quote/AAPL/profile/',\n",
+      "              'snippet': 'Apple Inc. designs, manufactures, and markets '\n",
+      "                         'smartphones, personal computers, tablets, wearables, '\n",
+      "                         'and accessories worldwide. The company offers '\n",
+      "                         'iPhone, a line ...',\n",
+      "              'position': 5},\n",
+      "             {'title': 'Apple Inc. (AAPL) Stock Price, News, Quote & History - '\n",
+      "                       'Yahoo Finance',\n",
+      "              'link': 'https://finance.yahoo.com/quote/AAPL',\n",
+      "              'snippet': 'Find the latest Apple Inc. (AAPL) stock quote, '\n",
+      "                         'history, news and other vital information to help '\n",
+      "                         'you with your stock trading and investing.',\n",
+      "              'position': 6}],\n",
+      " 'peopleAlsoAsk': [{'question': 'What does Apple Inc do?',\n",
+      "                    'snippet': 'Apple Inc. (Apple) designs, manufactures and '\n",
+      "                               'markets smartphones, personal\\n'\n",
+      "                               'computers, tablets, wearables and accessories '\n",
+      "                               'and sells a range of related\\n'\n",
+      "                               'services.',\n",
+      "                    'title': 'AAPL.O - | Stock Price & Latest News - Reuters',\n",
+      "                    'link': 'https://www.reuters.com/markets/companies/AAPL.O/'},\n",
+      "                   {'question': 'What is the full form of Apple Inc?',\n",
+      "                    'snippet': '(formerly Apple Computer Inc.) is an American '\n",
+      "                               'computer and consumer electronics\\n'\n",
+      "                               'company famous for creating the iPhone, iPad '\n",
+      "                               'and Macintosh computers.',\n",
+      "                    'title': 'What is Apple? An products and history overview '\n",
+      "                             '- TechTarget',\n",
+      "                    'link': 'https://www.techtarget.com/whatis/definition/Apple'},\n",
+      "                   {'question': 'What is Apple Inc iPhone?',\n",
+      "                    'snippet': 'Apple Inc (Apple) designs, manufactures, and '\n",
+      "                               'markets smartphones, tablets,\\n'\n",
+      "                               'personal computers, and wearable devices. The '\n",
+      "                               'company also offers software\\n'\n",
+      "                               'applications and related services, '\n",
+      "                               'accessories, and third-party digital content.\\n'\n",
+      "                               \"Apple's product portfolio includes iPhone, \"\n",
+      "                               'iPad, Mac, iPod, Apple Watch, and\\n'\n",
+      "                               'Apple TV.',\n",
+      "                    'title': 'Apple Inc Company Profile - Apple Inc Overview - '\n",
+      "                             'GlobalData',\n",
+      "                    'link': 'https://www.globaldata.com/company-profile/apple-inc/'},\n",
+      "                   {'question': 'Who runs Apple Inc?',\n",
+      "                    'snippet': 'Timothy Donald Cook (born November 1, 1960) is '\n",
+      "                               'an American business executive\\n'\n",
+      "                               'who has been the chief executive officer of '\n",
+      "                               'Apple Inc. since 2011. Cook\\n'\n",
+      "                               \"previously served as the company's chief \"\n",
+      "                               'operating officer under its co-founder\\n'\n",
+      "                               'Steve Jobs. He is the first CEO of any Fortune '\n",
+      "                               '500 company who is openly gay.',\n",
+      "                    'title': 'Tim Cook - Wikipedia',\n",
+      "                    'link': 'https://en.wikipedia.org/wiki/Tim_Cook'}],\n",
+      " 'relatedSearches': [{'query': 'Who invented the iPhone'},\n",
+      "                     {'query': 'Apple iPhone'},\n",
+      "                     {'query': 'History of Apple company PDF'},\n",
+      "                     {'query': 'Apple company history'},\n",
+      "                     {'query': 'Apple company introduction'},\n",
+      "                     {'query': 'Apple India'},\n",
+      "                     {'query': 'What does Apple Inc own'},\n",
+      "                     {'query': 'Apple Inc After Steve'},\n",
+      "                     {'query': 'Apple Watch'},\n",
+      "                     {'query': 'Apple App Store'}]}\n"
+     ]
+    }
+   ],
+   "source": [
+    "search = GoogleSerperAPIWrapper()\n",
+    "results = search.results(\"Apple Inc.\")\n",
+    "pprint.pp(results)"
+   ],
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "is_executing": true
+    },
+    "ExecuteTime": {
+     "end_time": "2023-05-04T00:54:22.863413Z",
+     "start_time": "2023-05-04T00:54:20.827395Z"
+    }
+   }
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "## Searching for Google Images\n",
+    "We can also query Google Images using this wrapper. For example:"
+   ],
+   "metadata": {
+    "collapsed": false
+   }
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "{'searchParameters': {'q': 'Lion',\n",
+      "                      'gl': 'us',\n",
+      "                      'hl': 'en',\n",
+      "                      'num': 10,\n",
+      "                      'type': 'images'},\n",
+      " 'images': [{'title': 'Lion - Wikipedia',\n",
+      "             'imageUrl': 'https://upload.wikimedia.org/wikipedia/commons/thumb/7/73/Lion_waiting_in_Namibia.jpg/1200px-Lion_waiting_in_Namibia.jpg',\n",
+      "             'imageWidth': 1200,\n",
+      "             'imageHeight': 900,\n",
+      "             'thumbnailUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRye79ROKwjfb6017jr0iu8Bz2E1KKuHg-A4qINJaspyxkZrkw&s',\n",
+      "             'thumbnailWidth': 259,\n",
+      "             'thumbnailHeight': 194,\n",
+      "             'source': 'Wikipedia',\n",
+      "             'domain': 'en.wikipedia.org',\n",
+      "             'link': 'https://en.wikipedia.org/wiki/Lion',\n",
+      "             'position': 1},\n",
+      "            {'title': 'Lion | Characteristics, Habitat, & Facts | Britannica',\n",
+      "             'imageUrl': 'https://cdn.britannica.com/55/2155-050-604F5A4A/lion.jpg',\n",
+      "             'imageWidth': 754,\n",
+      "             'imageHeight': 752,\n",
+      "             'thumbnailUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcS3fnDub1GSojI0hJ-ZGS8Tv-hkNNloXh98DOwXZoZ_nUs3GWSd&s',\n",
+      "             'thumbnailWidth': 225,\n",
+      "             'thumbnailHeight': 224,\n",
+      "             'source': 'Encyclopedia Britannica',\n",
+      "             'domain': 'www.britannica.com',\n",
+      "             'link': 'https://www.britannica.com/animal/lion',\n",
+      "             'position': 2},\n",
+      "            {'title': 'African lion, facts and photos',\n",
+      "             'imageUrl': 'https://i.natgeofe.com/n/487a0d69-8202-406f-a6a0-939ed3704693/african-lion.JPG',\n",
+      "             'imageWidth': 3072,\n",
+      "             'imageHeight': 2043,\n",
+      "             'thumbnailUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTPlTarrtDbyTiEm-VI_PML9VtOTVPuDXJ5ybDf_lN11H2mShk&s',\n",
+      "             'thumbnailWidth': 275,\n",
+      "             'thumbnailHeight': 183,\n",
+      "             'source': 'National Geographic',\n",
+      "             'domain': 'www.nationalgeographic.com',\n",
+      "             'link': 'https://www.nationalgeographic.com/animals/mammals/facts/african-lion',\n",
+      "             'position': 3},\n",
+      "            {'title': 'Saint Louis Zoo | African Lion',\n",
+      "             'imageUrl': 'https://optimise2.assets-servd.host/maniacal-finch/production/animals/african-lion-01-01.jpg?w=1200&auto=compress%2Cformat&fit=crop&dm=1658933674&s=4b63f926a0f524f2087a8e0613282bdb',\n",
+      "             'imageWidth': 1200,\n",
+      "             'imageHeight': 1200,\n",
+      "             'thumbnailUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTlewcJ5SwC7yKup6ByaOjTnAFDeoOiMxyJTQaph2W_I3dnks4&s',\n",
+      "             'thumbnailWidth': 225,\n",
+      "             'thumbnailHeight': 225,\n",
+      "             'source': 'St. Louis Zoo',\n",
+      "             'domain': 'stlzoo.org',\n",
+      "             'link': 'https://stlzoo.org/animals/mammals/carnivores/lion',\n",
+      "             'position': 4},\n",
+      "            {'title': 'How to Draw a Realistic Lion like an Artist - Studio '\n",
+      "                      'Wildlife',\n",
+      "             'imageUrl': 'https://studiowildlife.com/wp-content/uploads/2021/10/245528858_183911853822648_6669060845725210519_n.jpg',\n",
+      "             'imageWidth': 1431,\n",
+      "             'imageHeight': 2048,\n",
+      "             'thumbnailUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTmn5HayVj3wqoBDQacnUtzaDPZzYHSLKUlIEcni6VB8w0mVeA&s',\n",
+      "             'thumbnailWidth': 188,\n",
+      "             'thumbnailHeight': 269,\n",
+      "             'source': 'Studio Wildlife',\n",
+      "             'domain': 'studiowildlife.com',\n",
+      "             'link': 'https://studiowildlife.com/how-to-draw-a-realistic-lion-like-an-artist/',\n",
+      "             'position': 5},\n",
+      "            {'title': 'Lion | Characteristics, Habitat, & Facts | Britannica',\n",
+      "             'imageUrl': 'https://cdn.britannica.com/29/150929-050-547070A1/lion-Kenya-Masai-Mara-National-Reserve.jpg',\n",
+      "             'imageWidth': 1600,\n",
+      "             'imageHeight': 1085,\n",
+      "             'thumbnailUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSCqaKY_THr0IBZN8c-2VApnnbuvKmnsWjfrwKoWHFR9w3eN5o&s',\n",
+      "             'thumbnailWidth': 273,\n",
+      "             'thumbnailHeight': 185,\n",
+      "             'source': 'Encyclopedia Britannica',\n",
+      "             'domain': 'www.britannica.com',\n",
+      "             'link': 'https://www.britannica.com/animal/lion',\n",
+      "             'position': 6},\n",
+      "            {'title': \"Where do lions live? Facts about lions' habitats and \"\n",
+      "                      'other cool facts',\n",
+      "             'imageUrl': 'https://www.gannett-cdn.com/-mm-/b2b05a4ab25f4fca0316459e1c7404c537a89702/c=0-0-1365-768/local/-/media/2022/03/16/USATODAY/usatsports/imageForEntry5-ODq.jpg?width=1365&height=768&fit=crop&format=pjpg&auto=webp',\n",
+      "             'imageWidth': 1365,\n",
+      "             'imageHeight': 768,\n",
+      "             'thumbnailUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTc_4vCHscgvFvYy3PSrtIOE81kNLAfhDK8F3mfOuotL0kUkbs&s',\n",
+      "             'thumbnailWidth': 299,\n",
+      "             'thumbnailHeight': 168,\n",
+      "             'source': 'USA Today',\n",
+      "             'domain': 'www.usatoday.com',\n",
+      "             'link': 'https://www.usatoday.com/story/news/2023/01/08/where-do-lions-live-habitat/10927718002/',\n",
+      "             'position': 7},\n",
+      "            {'title': 'Lion',\n",
+      "             'imageUrl': 'https://i.natgeofe.com/k/1d33938b-3d02-4773-91e3-70b113c3b8c7/lion-male-roar_square.jpg',\n",
+      "             'imageWidth': 3072,\n",
+      "             'imageHeight': 3072,\n",
+      "             'thumbnailUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQqLfnBrBLcTiyTZynHH3FGbBtX2bd1ScwpcuOLnksTyS9-4GM&s',\n",
+      "             'thumbnailWidth': 225,\n",
+      "             'thumbnailHeight': 225,\n",
+      "             'source': 'National Geographic Kids',\n",
+      "             'domain': 'kids.nationalgeographic.com',\n",
+      "             'link': 'https://kids.nationalgeographic.com/animals/mammals/facts/lion',\n",
+      "             'position': 8},\n",
+      "            {'title': \"Lion | Smithsonian's National Zoo\",\n",
+      "             'imageUrl': 'https://nationalzoo.si.edu/sites/default/files/styles/1400_scale/public/animals/exhibit/africanlion-005.jpg?itok=6wA745g_',\n",
+      "             'imageWidth': 1400,\n",
+      "             'imageHeight': 845,\n",
+      "             'thumbnailUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSgB3z_D4dMEOWJ7lajJk4XaQSL4DdUvIRj4UXZ0YoE5fGuWuo&s',\n",
+      "             'thumbnailWidth': 289,\n",
+      "             'thumbnailHeight': 174,\n",
+      "             'source': \"Smithsonian's National Zoo\",\n",
+      "             'domain': 'nationalzoo.si.edu',\n",
+      "             'link': 'https://nationalzoo.si.edu/animals/lion',\n",
+      "             'position': 9},\n",
+      "            {'title': \"Zoo's New Male Lion Explores Habitat for the First Time \"\n",
+      "                      '- Virginia Zoo',\n",
+      "             'imageUrl': 'https://virginiazoo.org/wp-content/uploads/2022/04/ZOO_0056-scaled.jpg',\n",
+      "             'imageWidth': 2560,\n",
+      "             'imageHeight': 2141,\n",
+      "             'thumbnailUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTDCG7XvXRCwpe_-Vy5mpvrQpVl5q2qwgnDklQhrJpQzObQGz4&s',\n",
+      "             'thumbnailWidth': 246,\n",
+      "             'thumbnailHeight': 205,\n",
+      "             'source': 'Virginia Zoo',\n",
+      "             'domain': 'virginiazoo.org',\n",
+      "             'link': 'https://virginiazoo.org/zoos-new-male-lion-explores-habitat-for-thefirst-time/',\n",
+      "             'position': 10}]}\n"
+     ]
+    }
+   ],
+   "source": [
+    "search = GoogleSerperAPIWrapper(type=\"images\")\n",
+    "results = search.results(\"Lion\")\n",
+    "pprint.pp(results)"
+   ],
+   "metadata": {
+    "collapsed": false,
+    "ExecuteTime": {
+     "end_time": "2023-05-04T00:54:27.879867Z",
+     "start_time": "2023-05-04T00:54:26.380022Z"
+    }
+   }
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "## Searching for Google News\n",
+    "We can also query Google News using this wrapper. For example:"
+   ],
+   "metadata": {
+    "collapsed": false
+   }
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "{'searchParameters': {'q': 'Tesla Inc.',\n",
+      "                      'gl': 'us',\n",
+      "                      'hl': 'en',\n",
+      "                      'num': 10,\n",
+      "                      'type': 'news'},\n",
+      " 'news': [{'title': 'ISS recommends Tesla investors vote against re-election '\n",
+      "                    'of Robyn Denholm',\n",
+      "           'link': 'https://www.reuters.com/business/autos-transportation/iss-recommends-tesla-investors-vote-against-re-election-robyn-denholm-2023-05-04/',\n",
+      "           'snippet': 'Proxy advisory firm ISS on Wednesday recommended Tesla '\n",
+      "                      'investors vote against re-election of board chair Robyn '\n",
+      "                      'Denholm, citing \"concerns on...',\n",
+      "           'date': '5 mins ago',\n",
+      "           'source': 'Reuters',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcROdETe_GUyp1e8RHNhaRM8Z_vfxCvdfinZwzL1bT1ZGSYaGTeOojIdBoLevA&s',\n",
+      "           'position': 1},\n",
+      "          {'title': 'Global companies by market cap: Tesla fell most in April',\n",
+      "           'link': 'https://www.reuters.com/markets/global-companies-by-market-cap-tesla-fell-most-april-2023-05-02/',\n",
+      "           'snippet': 'Tesla Inc was the biggest loser among top companies by '\n",
+      "                      'market capitalisation in April, hit by disappointing '\n",
+      "                      'quarterly earnings after it...',\n",
+      "           'date': '1 day ago',\n",
+      "           'source': 'Reuters',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQ4u4CP8aOdGyRFH6o4PkXi-_eZDeY96vLSag5gDjhKMYf98YBER2cZPbkStQ&s',\n",
+      "           'position': 2},\n",
+      "          {'title': 'Tesla Wanted an EV Price War. Ford Showed Up.',\n",
+      "           'link': 'https://www.bloomberg.com/opinion/articles/2023-05-03/tesla-wanted-an-ev-price-war-ford-showed-up',\n",
+      "           'snippet': 'The legacy automaker is paring back the cost of its '\n",
+      "                      'Mustang Mach-E model after Tesla discounted its '\n",
+      "                      'competing EVs, portending tighter...',\n",
+      "           'date': '6 hours ago',\n",
+      "           'source': 'Bloomberg.com',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcS_3Eo4VI0H-nTeIbYc5DaQn5ep7YrWnmhx6pv8XddFgNF5zRC9gEpHfDq8yQ&s',\n",
+      "           'position': 3},\n",
+      "          {'title': 'Joby Aviation to get investment from Tesla shareholder '\n",
+      "                    'Baillie Gifford',\n",
+      "           'link': 'https://finance.yahoo.com/news/joby-aviation-investment-tesla-shareholder-204450712.html',\n",
+      "           'snippet': 'This comes days after Joby clinched a $55 million '\n",
+      "                      'contract extension to deliver up to nine air taxis to '\n",
+      "                      'the U.S. Air Force,...',\n",
+      "           'date': '4 hours ago',\n",
+      "           'source': 'Yahoo Finance',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQO0uVn297LI-xryrPNqJ-apUOulj4ohM-xkN4OfmvMOYh1CPdUEBbYx6hviw&s',\n",
+      "           'position': 4},\n",
+      "          {'title': 'Tesla resumes U.S. orders for a Model 3 version at lower '\n",
+      "                    'price, range',\n",
+      "           'link': 'https://finance.yahoo.com/news/tesla-resumes-us-orders-model-045736115.html',\n",
+      "           'snippet': '(Reuters) -Tesla Inc has resumed taking orders for its '\n",
+      "                      'Model 3 long-range vehicle in the United States, the '\n",
+      "                      \"company's website showed late on...\",\n",
+      "           'date': '19 hours ago',\n",
+      "           'source': 'Yahoo Finance',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTIZetJ62sQefPfbQ9KKDt6iH7Mc0ylT5t_hpgeeuUkHhJuAx2FOJ4ZTRVDFg&s',\n",
+      "           'position': 5},\n",
+      "          {'title': 'The Tesla Model 3 Long Range AWD Is Now Available in the '\n",
+      "                    'U.S. With 325 Miles of Range',\n",
+      "           'link': 'https://www.notateslaapp.com/news/1393/tesla-reopens-orders-for-model-3-long-range-after-months-of-unavailability',\n",
+      "           'snippet': 'Tesla has reopened orders for the Model 3 Long Range '\n",
+      "                      'RWD, which has been unavailable for months due to high '\n",
+      "                      'demand.',\n",
+      "           'date': '7 hours ago',\n",
+      "           'source': 'Not a Tesla App',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSecrgxZpRj18xIJY-nDHljyP-A4ejEkswa9eq77qhMNrScnVIqe34uql5U4w&s',\n",
+      "           'position': 6},\n",
+      "          {'title': 'Tesla Cybertruck alpha prototype spotted at the Fremont '\n",
+      "                    'factory in new pics and videos',\n",
+      "           'link': 'https://www.teslaoracle.com/2023/05/03/tesla-cybertruck-alpha-prototype-interior-and-exterior-spotted-at-the-fremont-factory-in-new-pics-and-videos/',\n",
+      "           'snippet': 'A Tesla Cybertruck alpha prototype goes to Fremont, '\n",
+      "                      'California for another round of testing before going to '\n",
+      "                      'production later this year (pics...',\n",
+      "           'date': '14 hours ago',\n",
+      "           'source': 'Tesla Oracle',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRO7M5ZLQE-Zo4-_5dv9hNAQZ3wSqfvYCuKqzxHG-M6CgLpwPMMG_ssebdcMg&s',\n",
+      "           'position': 7},\n",
+      "          {'title': 'Tesla putting facility in new part of country - Austin '\n",
+      "                    'Business Journal',\n",
+      "           'link': 'https://www.bizjournals.com/austin/news/2023/05/02/tesla-leases-building-seattle-area.html',\n",
+      "           'snippet': 'Check out what Puget Sound Business Journal has to '\n",
+      "                      \"report about the Austin-based company's real estate \"\n",
+      "                      'footprint in the Pacific Northwest.',\n",
+      "           'date': '22 hours ago',\n",
+      "           'source': 'The Business Journals',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcR9kIEHWz1FcHKDUtGQBS0AjmkqtyuBkQvD8kyIY3kpaPrgYaN7I_H2zoOJsA&s',\n",
+      "           'position': 8},\n",
+      "          {'title': 'Tesla (TSLA) Resumes Orders for Model 3 Long Range After '\n",
+      "                    'Backlog',\n",
+      "           'link': 'https://www.bloomberg.com/news/articles/2023-05-03/tesla-resumes-orders-for-popular-model-3-long-range-at-47-240',\n",
+      "           'snippet': 'Tesla Inc. has resumed taking orders for its Model 3 '\n",
+      "                      'Long Range edition with a starting price of $47240, '\n",
+      "                      'according to its website.',\n",
+      "           'date': '5 hours ago',\n",
+      "           'source': 'Bloomberg.com',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTWWIC4VpMTfRvSyqiomODOoLg0xhoBf-Tc1qweKnSuaiTk-Y1wMJZM3jct0w&s',\n",
+      "           'position': 9}]}\n"
+     ]
+    }
+   ],
+   "source": [
+    "search = GoogleSerperAPIWrapper(type=\"news\")\n",
+    "results = search.results(\"Tesla Inc.\")\n",
+    "pprint.pp(results)"
+   ],
+   "metadata": {
+    "collapsed": false,
+    "ExecuteTime": {
+     "end_time": "2023-05-04T00:54:34.984087Z",
+     "start_time": "2023-05-04T00:54:33.369231Z"
+    }
+   }
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "If you want to only receive news articles published in the last hour, you can do the following:"
+   ],
+   "metadata": {
+    "collapsed": false
+   }
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "{'searchParameters': {'q': 'Tesla Inc.',\n",
+      "                      'gl': 'us',\n",
+      "                      'hl': 'en',\n",
+      "                      'num': 10,\n",
+      "                      'type': 'news',\n",
+      "                      'tbs': 'qdr:h'},\n",
+      " 'news': [{'title': 'Oklahoma Gov. Stitt sees growing foreign interest in '\n",
+      "                    'investments in ...',\n",
+      "           'link': 'https://www.reuters.com/world/us/oklahoma-gov-stitt-sees-growing-foreign-interest-investments-state-2023-05-04/',\n",
+      "           'snippet': 'T)), a battery supplier to electric vehicle maker Tesla '\n",
+      "                      'Inc (TSLA.O), said on Sunday it is considering building '\n",
+      "                      'a battery plant in Oklahoma, its third in...',\n",
+      "           'date': '53 mins ago',\n",
+      "           'source': 'Reuters',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSSTcsXeenqmEKdiekvUgAmqIPR4nlAmgjTkBqLpza-lLfjX1CwB84MoNVj0Q&s',\n",
+      "           'position': 1},\n",
+      "          {'title': 'Ryder lanza solución llave en mano para vehículos '\n",
+      "                    'eléctricos en EU',\n",
+      "           'link': 'https://www.tyt.com.mx/nota/ryder-lanza-solucion-llave-en-mano-para-vehiculos-electricos-en-eu',\n",
+      "           'snippet': 'Ryder System Inc. presentó RyderElectric+ TM como su '\n",
+      "                      'nueva solución llave en mano ... Ryder también tiene '\n",
+      "                      'reservados los semirremolques Tesla y continúa...',\n",
+      "           'date': '56 mins ago',\n",
+      "           'source': 'Revista Transportes y Turismo',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQJhXTQQtjSUZf9YPM235WQhFU5_d7lEA76zB8DGwZfixcgf1_dhPJyKA1Nbw&s',\n",
+      "           'position': 2},\n",
+      "          {'title': '\"I think people can get by with $999 million,\" Bernie '\n",
+      "                    'Sanders tells American Billionaires.',\n",
+      "           'link': 'https://thebharatexpressnews.com/i-think-people-can-get-by-with-999-million-bernie-sanders-tells-american-billionaires-heres-how-the-ultra-rich-can-pay-less-income-tax-than-you-legally/',\n",
+      "           'snippet': 'The report noted that in 2007 and 2011, Amazon.com Inc. '\n",
+      "                      'founder Jeff Bezos “did not pay a dime in federal ... '\n",
+      "                      'If you want to bet on Musk, check out Tesla.',\n",
+      "           'date': '11 mins ago',\n",
+      "           'source': 'THE BHARAT EXPRESS NEWS',\n",
+      "           'imageUrl': 'https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcR_X9qqSwVFBBdos2CK5ky5IWIE3aJPCQeRYR9O1Jz4t-MjaEYBuwK7AU3AJQ&s',\n",
+      "           'position': 3}]}\n"
+     ]
+    }
+   ],
+   "source": [
+    "search = GoogleSerperAPIWrapper(type=\"news\", tbs=\"qdr:h\")\n",
+    "results = search.results(\"Tesla Inc.\")\n",
+    "pprint.pp(results)"
+   ],
+   "metadata": {
+    "collapsed": false,
+    "ExecuteTime": {
+     "end_time": "2023-05-04T00:54:41.786864Z",
+     "start_time": "2023-05-04T00:54:40.691905Z"
+    }
+   }
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "Some examples of the `tbs` parameter:\n",
+    "\n",
+    "`qdr:h` (past hour)\n",
+    "`qdr:d` (past day)\n",
+    "`qdr:w` (past week)\n",
+    "`qdr:m` (past month)\n",
+    "`qdr:y` (past year)\n",
+    "\n",
+    "You can specify intermediate time periods by adding a number:\n",
+    "`qdr:h12` (past 12 hours)\n",
+    "`qdr:d3` (past 3 days)\n",
+    "`qdr:w2` (past 2 weeks)\n",
+    "`qdr:m6` (past 6 months)\n",
+    "`qdr:m2` (past 2 years)\n",
+    "\n",
+    "For all supported filters simply go to [Google Search](https://google.com), search for something, click on \"Tools\", add your date filter and check the URL for \"tbs=\".\n"
+   ],
+   "metadata": {
+    "collapsed": false
+   }
+  },
+  {
+   "cell_type": "markdown",
+   "source": [
+    "## Searching for Google Places\n",
+    "We can also query Google Places using this wrapper. For example:"
+   ],
+   "metadata": {
+    "collapsed": false
+   }
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "{'searchParameters': {'q': 'Italian restaurants in Upper East Side',\n",
+      "                      'gl': 'us',\n",
+      "                      'hl': 'en',\n",
+      "                      'num': 10,\n",
+      "                      'type': 'places'},\n",
+      " 'places': [{'position': 1,\n",
+      "             'title': \"L'Osteria\",\n",
+      "             'address': '1219 Lexington Ave',\n",
+      "             'latitude': 40.777154599999996,\n",
+      "             'longitude': -73.9571363,\n",
+      "             'thumbnailUrl': 'https://lh5.googleusercontent.com/p/AF1QipNjU7BWEq_aYQANBCbX52Kb0lDpd_lFIx5onw40=w92-h92-n-k-no',\n",
+      "             'rating': 4.7,\n",
+      "             'ratingCount': 91,\n",
+      "             'category': 'Italian'},\n",
+      "            {'position': 2,\n",
+      "             'title': \"Tony's Di Napoli\",\n",
+      "             'address': '1081 3rd Ave',\n",
+      "             'latitude': 40.7643567,\n",
+      "             'longitude': -73.9642373,\n",
+      "             'thumbnailUrl': 'https://lh5.googleusercontent.com/p/AF1QipNbNv6jZkJ9nyVi60__8c1DQbe_eEbugRAhIYye=w92-h92-n-k-no',\n",
+      "             'rating': 4.5,\n",
+      "             'ratingCount': 2265,\n",
+      "             'category': 'Italian'},\n",
+      "            {'position': 3,\n",
+      "             'title': 'Caravaggio',\n",
+      "             'address': '23 E 74th St',\n",
+      "             'latitude': 40.773412799999996,\n",
+      "             'longitude': -73.96473379999999,\n",
+      "             'thumbnailUrl': 'https://lh5.googleusercontent.com/p/AF1QipPDGchokDvppoLfmVEo6X_bWd3Fz0HyxIHTEe9V=w92-h92-n-k-no',\n",
+      "             'rating': 4.5,\n",
+      "             'ratingCount': 276,\n",
+      "             'category': 'Italian'},\n",
+      "            {'position': 4,\n",
+      "             'title': 'Luna Rossa',\n",
+      "             'address': '347 E 85th St',\n",
+      "             'latitude': 40.776593999999996,\n",
+      "             'longitude': -73.950351,\n",
+      "             'thumbnailUrl': 'https://lh5.googleusercontent.com/p/AF1QipNPCpCPuqPAb1Mv6_fOP7cjb8Wu1rbqbk2sMBlh=w92-h92-n-k-no',\n",
+      "             'rating': 4.5,\n",
+      "             'ratingCount': 140,\n",
+      "             'category': 'Italian'},\n",
+      "            {'position': 5,\n",
+      "             'title': \"Paola's\",\n",
+      "             'address': '1361 Lexington Ave',\n",
+      "             'latitude': 40.7822019,\n",
+      "             'longitude': -73.9534096,\n",
+      "             'thumbnailUrl': 'https://lh5.googleusercontent.com/p/AF1QipPJr2Vcx-B6K-GNQa4koOTffggTePz8TKRTnWi3=w92-h92-n-k-no',\n",
+      "             'rating': 4.5,\n",
+      "             'ratingCount': 344,\n",
+      "             'category': 'Italian'},\n",
+      "            {'position': 6,\n",
+      "             'title': 'Come Prima',\n",
+      "             'address': '903 Madison Ave',\n",
+      "             'latitude': 40.772124999999996,\n",
+      "             'longitude': -73.965012,\n",
+      "             'thumbnailUrl': 'https://lh5.googleusercontent.com/p/AF1QipNrX19G0NVdtDyMovCQ-M-m0c_gLmIxrWDQAAbz=w92-h92-n-k-no',\n",
+      "             'rating': 4.5,\n",
+      "             'ratingCount': 176,\n",
+      "             'category': 'Italian'},\n",
+      "            {'position': 7,\n",
+      "             'title': 'Botte UES',\n",
+      "             'address': '1606 1st Ave.',\n",
+      "             'latitude': 40.7750785,\n",
+      "             'longitude': -73.9504801,\n",
+      "             'thumbnailUrl': 'https://lh5.googleusercontent.com/p/AF1QipPPN5GXxfH3NDacBc0Pt3uGAInd9OChS5isz9RF=w92-h92-n-k-no',\n",
+      "             'rating': 4.4,\n",
+      "             'ratingCount': 152,\n",
+      "             'category': 'Italian'},\n",
+      "            {'position': 8,\n",
+      "             'title': 'Piccola Cucina Uptown',\n",
+      "             'address': '106 E 60th St',\n",
+      "             'latitude': 40.7632468,\n",
+      "             'longitude': -73.9689825,\n",
+      "             'thumbnailUrl': 'https://lh5.googleusercontent.com/p/AF1QipPifIgzOCD5SjgzzqBzGkdZCBp0MQsK5k7M7znn=w92-h92-n-k-no',\n",
+      "             'rating': 4.6,\n",
+      "             'ratingCount': 941,\n",
+      "             'category': 'Italian'},\n",
+      "            {'position': 9,\n",
+      "             'title': 'Pinocchio Restaurant',\n",
+      "             'address': '300 E 92nd St',\n",
+      "             'latitude': 40.781453299999995,\n",
+      "             'longitude': -73.9486788,\n",
+      "             'thumbnailUrl': 'https://lh5.googleusercontent.com/p/AF1QipNtxlIyEEJHtDtFtTR9nB38S8A2VyMu-mVVz72A=w92-h92-n-k-no',\n",
+      "             'rating': 4.5,\n",
+      "             'ratingCount': 113,\n",
+      "             'category': 'Italian'},\n",
+      "            {'position': 10,\n",
+      "             'title': 'Barbaresco',\n",
+      "             'address': '843 Lexington Ave #1',\n",
+      "             'latitude': 40.7654332,\n",
+      "             'longitude': -73.9656873,\n",
+      "             'thumbnailUrl': 'https://lh5.googleusercontent.com/p/AF1QipMb9FbPuXF_r9g5QseOHmReejxSHgSahPMPJ9-8=w92-h92-n-k-no',\n",
+      "             'rating': 4.3,\n",
+      "             'ratingCount': 122,\n",
+      "             'locationHint': 'In The Touraine',\n",
+      "             'category': 'Italian'}]}\n"
+     ]
+    }
+   ],
+   "source": [
+    "search = GoogleSerperAPIWrapper(type=\"places\")\n",
+    "results = search.results(\"Italian restaurants in Upper East Side\")\n",
+    "pprint.pp(results)"
+   ],
+   "metadata": {
+    "collapsed": false,
+    "ExecuteTime": {
+     "end_time": "2023-05-04T00:56:07.271164Z",
+     "start_time": "2023-05-04T00:56:05.645847Z"
+    }
+   }
   }
  ],
  "metadata": {

docs/modules/agents/tools/examples/gradio_tools.ipynb

@@ -69,7 +69,8 @@
     }
    ],
    "source": [
-    "StableDiffusionTool().langchain.run(\"Please create a photo of a dog riding a skateboard\")"
+    "local_file_path = StableDiffusionTool().langchain.run(\"Please create a photo of a dog riding a skateboard\")\n",
+    "local_file_path"
    ]
   },
   {
@@ -89,7 +90,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "im = Image.open(\"/Users/harrisonchase/workplace/langchain/docs/modules/agents/tools/examples/b61c1dd9-47e2-46f1-a47c-20d27640993d/tmp4ap48vnm.jpg\")"
+    "im = Image.open(local_file_path)"
    ]
   },
   {

docs/modules/agents/tools/examples/human_tools.ipynb

@@ -13,10 +13,11 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
-    "import sys\n",
     "from langchain.chat_models import ChatOpenAI\n",
     "from langchain.llms import OpenAI\n",
     "from langchain.agents import load_tools, initialize_agent\n",
@@ -42,13 +43,15 @@
    "metadata": {},
    "source": [
     "In the above code you can see the tool takes input directly from command line.\n",
-    "You can customize `prompt_func` and `input_func` according to your need."
+    "You can customize `prompt_func` and `input_func` according to your need (as shown below)."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
+   "execution_count": 2,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -57,29 +60,28 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mI don't know Eric Zhu, so I should ask a human for guidance.\n",
+      "\u001b[32;1m\u001b[1;3mI don't know Eric's surname, so I should ask a human for guidance.\n",
       "Action: Human\n",
-      "Action Input: \"Do you know when Eric Zhu's birthday is?\"\u001b[0m\n",
+      "Action Input: \"What is Eric's surname?\"\u001b[0m\n",
       "\n",
-      "Do you know when Eric Zhu's birthday is?\n",
-      "last week\n",
+      "What is Eric's surname?\n"
+     ]
+    },
+    {
+     "name": "stdin",
+     "output_type": "stream",
+     "text": [
+      " Zhu\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "\n",
-      "Observation: \u001b[36;1m\u001b[1;3mlast week\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3mThat's not very helpful. I should ask for more information.\n",
-      "Action: Human\n",
-      "Action Input: \"Do you know the specific date of Eric Zhu's birthday?\"\u001b[0m\n",
-      "\n",
-      "Do you know the specific date of Eric Zhu's birthday?\n",
-      "august 1st\n",
-      "\n",
-      "Observation: \u001b[36;1m\u001b[1;3maugust 1st\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3mNow that I have the date, I can check if it's a leap year or not.\n",
-      "Action: Calculator\n",
-      "Action Input: \"Is 2021 a leap year?\"\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mAnswer: False\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3mI have all the information I need to answer the original question.\n",
-      "Final Answer: Eric Zhu's birthday is on August 1st and it is not a leap year in 2021.\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mZhu\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI now know Eric's surname is Zhu.\n",
+      "Final Answer: Eric's surname is Zhu.\u001b[0m\n",
       "\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
@@ -87,18 +89,175 @@
     {
      "data": {
       "text/plain": [
-       "\"Eric Zhu's birthday is on August 1st and it is not a leap year in 2021.\""
+       "\"Eric's surname is Zhu.\""
       ]
      },
-     "execution_count": 3,
+     "execution_count": 2,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
+    "agent_chain.run(\"When's my friend Eric's surname?\")\n",
+    "# Answer with 'Zhu'"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configuring the Input Function\n",
     "\n",
-    "agent_chain.run(\"What is Eric Zhu's birthday?\")\n",
-    "# Answer with \"last week\""
+    "By default, the `HumanInputRun` tool uses the python `input` function to get input from the user.\n",
+    "You can customize the input_func to be anything you'd like.\n",
+    "For instance, if you want to accept multi-line input, you could do the following:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "def get_input() -> str:\n",
+    "    print(\"Insert your text. Enter 'q' or press Ctrl-D (or Ctrl-Z on Windows) to end.\")\n",
+    "    contents = []\n",
+    "    while True:\n",
+    "        try:\n",
+    "            line = input()\n",
+    "        except EOFError:\n",
+    "            break\n",
+    "        if line == \"q\":\n",
+    "            break\n",
+    "        contents.append(line)\n",
+    "    return \"\\n\".join(contents)\n",
+    "\n",
+    "\n",
+    "# You can modify the tool when loading\n",
+    "tools = load_tools(\n",
+    "    [\"human\", \"ddg-search\"], \n",
+    "    llm=math_llm,\n",
+    "    input_func=get_input\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "# Or you can directly instantiate the tool\n",
+    "from langchain.tools import HumanInputRun\n",
+    "\n",
+    "tool = HumanInputRun(input_func=get_input)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "agent_chain = initialize_agent(\n",
+    "    tools,\n",
+    "    llm,\n",
+    "    agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION,\n",
+    "    verbose=True,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mI should ask a human for guidance\n",
+      "Action: Human\n",
+      "Action Input: \"Can you help me attribute a quote?\"\u001b[0m\n",
+      "\n",
+      "Can you help me attribute a quote?\n",
+      "Insert your text. Enter 'q' or press Ctrl-D (or Ctrl-Z on Windows) to end.\n"
+     ]
+    },
+    {
+     "name": "stdin",
+     "output_type": "stream",
+     "text": [
+      " vini\n",
+      " vidi\n",
+      " vici\n",
+      " q\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "Observation: \u001b[36;1m\u001b[1;3mvini\n",
+      "vidi\n",
+      "vici\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI need to provide more context about the quote\n",
+      "Action: Human\n",
+      "Action Input: \"The quote is 'Veni, vidi, vici'\"\u001b[0m\n",
+      "\n",
+      "The quote is 'Veni, vidi, vici'\n",
+      "Insert your text. Enter 'q' or press Ctrl-D (or Ctrl-Z on Windows) to end.\n"
+     ]
+    },
+    {
+     "name": "stdin",
+     "output_type": "stream",
+     "text": [
+      " oh who said it \n",
+      " q\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "Observation: \u001b[36;1m\u001b[1;3moh who said it \u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI can use DuckDuckGo Search to find out who said the quote\n",
+      "Action: DuckDuckGo Search\n",
+      "Action Input: \"Who said 'Veni, vidi, vici'?\"\u001b[0m\n",
+      "Observation: \u001b[33;1m\u001b[1;3mUpdated on September 06, 2019. \"Veni, vidi, vici\" is a famous phrase said to have been spoken by the Roman Emperor Julius Caesar (100-44 BCE) in a bit of stylish bragging that impressed many of the writers of his day and beyond. The phrase means roughly \"I came, I saw, I conquered\" and it could be pronounced approximately Vehnee, Veedee ... Veni, vidi, vici (Classical Latin: [weːniː wiːdiː wiːkiː], Ecclesiastical Latin: [ˈveni ˈvidi ˈvitʃi]; \"I came; I saw; I conquered\") is a Latin phrase used to refer to a swift, conclusive victory.The phrase is popularly attributed to Julius Caesar who, according to Appian, used the phrase in a letter to the Roman Senate around 47 BC after he had achieved a quick victory in his short ... veni, vidi, vici Latin quotation from Julius Caesar ve· ni, vi· di, vi· ci ˌwā-nē ˌwē-dē ˈwē-kē ˌvā-nē ˌvē-dē ˈvē-chē : I came, I saw, I conquered Articles Related to veni, vidi, vici 'In Vino Veritas' and Other Latin... Dictionary Entries Near veni, vidi, vici Venite veni, vidi, vici Venizélos See More Nearby Entries Cite this Entry Style The simplest explanation for why veni, vidi, vici is a popular saying is that it comes from Julius Caesar, one of history's most famous figures, and has a simple, strong meaning: I'm powerful and fast. But it's not just the meaning that makes the phrase so powerful. Caesar was a gifted writer, and the phrase makes use of Latin grammar to ... One of the best known and most frequently quoted Latin expression, veni, vidi, vici may be found hundreds of times throughout the centuries used as an expression of triumph. The words are said to have been used by Caesar as he was enjoying a triumph.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3mI now know the final answer\n",
+      "Final Answer: Julius Caesar said the quote \"Veni, vidi, vici\" which means \"I came, I saw, I conquered\".\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'Julius Caesar said the quote \"Veni, vidi, vici\" which means \"I came, I saw, I conquered\".'"
+      ]
+     },
+     "execution_count": 12,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent_chain.run(\"I need help attributing a quote\")"
    ]
   },
   {
@@ -125,9 +284,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.11.2"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/modules/agents/tools/examples/python.ipynb

@@ -19,6 +19,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "from langchain.agents import Tool\n",
     "from langchain.utilities import PythonREPL"
    ]
   },
@@ -59,7 +60,14 @@
    "id": "54fc1f03",
    "metadata": {},
    "outputs": [],
-   "source": []
+   "source": [
+    "# You can create the tool to pass to an agent\n",
+    "repl_tool = Tool(\n",
+    "    name=\"python_repl\",\n",
+    "    description=\"A Python shell. Use this to execute python commands. Input should be a valid python command. If you want to see the output of a value, you should print it out with `print(...)`.\",\n",
+    "    func=python_repl.run\n",
+    ")"
+   ]
   }
  ],
  "metadata": {

docs/modules/agents/tools/examples/sceneXplain.ipynb

@@ -0,0 +1,139 @@
+{
+ "cells": [
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# SceneXplain\n",
+    "\n",
+    "\n",
+    "[SceneXplain](https://scenex.jina.ai/) is an ImageCaptioning service accessible through the SceneXplain Tool.\n",
+    "\n",
+    "To use this tool, you'll need to make an account and fetch your API Token [from the website](https://scenex.jina.ai/api). Then you can instantiate the tool."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"SCENEX_API_KEY\"] = \"<YOUR_API_KEY>\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.agents import load_tools\n",
+    "\n",
+    "tools = load_tools([\"sceneXplain\"])"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Or directly instantiate the tool."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.tools import SceneXplainTool\n",
+    "\n",
+    "\n",
+    "tool = SceneXplainTool()\n"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Usage in an Agent\n",
+    "\n",
+    "The tool can be used in any LangChain agent as follows:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3m\n",
+      "Thought: Do I need to use a tool? Yes\n",
+      "Action: Image Explainer\n",
+      "Action Input: https://storage.googleapis.com/causal-diffusion.appspot.com/imagePrompts%2F0rw369i5h9t%2Foriginal.png\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mIn a charmingly whimsical scene, a young girl is seen braving the rain alongside her furry companion, the lovable Totoro. The two are depicted standing on a bustling street corner, where they are sheltered from the rain by a bright yellow umbrella. The girl, dressed in a cheerful yellow frock, holds onto the umbrella with both hands while gazing up at Totoro with an expression of wonder and delight.\n",
+      "\n",
+      "Totoro, meanwhile, stands tall and proud beside his young friend, holding his own umbrella aloft to protect them both from the downpour. His furry body is rendered in rich shades of grey and white, while his large ears and wide eyes lend him an endearing charm.\n",
+      "\n",
+      "In the background of the scene, a street sign can be seen jutting out from the pavement amidst a flurry of raindrops. A sign with Chinese characters adorns its surface, adding to the sense of cultural diversity and intrigue. Despite the dreary weather, there is an undeniable sense of joy and camaraderie in this heartwarming image.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m Do I need to use a tool? No\n",
+      "AI: This image appears to be a still from the 1988 Japanese animated fantasy film My Neighbor Totoro. The film follows two young girls, Satsuki and Mei, as they explore the countryside and befriend the magical forest spirits, including the titular character Totoro.\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "This image appears to be a still from the 1988 Japanese animated fantasy film My Neighbor Totoro. The film follows two young girls, Satsuki and Mei, as they explore the countryside and befriend the magical forest spirits, including the titular character Totoro.\n"
+     ]
+    }
+   ],
+   "source": [
+    "from langchain.llms import OpenAI\n",
+    "from langchain.agents import initialize_agent\n",
+    "from langchain.memory import ConversationBufferMemory\n",
+    "\n",
+    "llm = OpenAI(temperature=0)\n",
+    "memory = ConversationBufferMemory(memory_key=\"chat_history\")\n",
+    "agent = initialize_agent(\n",
+    "    tools, llm, memory=memory, agent=\"conversational-react-description\", verbose=True\n",
+    ")\n",
+    "output = agent.run(\n",
+    "    input=(\n",
+    "        \"What is in this image https://storage.googleapis.com/causal-diffusion.appspot.com/imagePrompts%2F0rw369i5h9t%2Foriginal.png. \"\n",
+    "        \"Is it movie or a game? If it is a movie, what is the name of the movie?\"\n",
+    "    )\n",
+    ")\n",
+    "\n",
+    "print(output)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.2"
+  },
+  "orig_nbformat": 4
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

docs/modules/agents/tools/examples/serpapi.ipynb

@@ -102,7 +102,15 @@
    "id": "e0a1dc1c",
    "metadata": {},
    "outputs": [],
-   "source": []
+   "source": [
+    "from langchain.agents import Tool\n",
+    "# You can create the tool to pass to an agent\n",
+    "repl_tool = Tool(\n",
+    "    name=\"python_repl\",\n",
+    "    description=\"A Python shell. Use this to execute python commands. Input should be a valid python command. If you want to see the output of a value, you should print it out with `print(...)`.\",\n",
+    "    func=search.run,\n",
+    ")"
+   ]
   }
  ],
  "metadata": {

docs/modules/agents/tools/multi_input_tool.ipynb

@@ -1,23 +1,144 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "87455ddb",
    "metadata": {},
    "source": [
     "# Multi-Input Tools\n",
     "\n",
-    "This notebook shows how to use a tool that requires multiple inputs with an agent.\n",
-    "\n",
-    "The difficulty in doing so comes from the fact that an agent decides its next step from a language model, which outputs a string. So if that step requires multiple inputs, they need to be parsed from that. Therefore, the currently supported way to do this is to write a smaller wrapper function that parses a string into multiple inputs.\n",
-    "\n",
-    "For a concrete example, let's work on giving an agent access to a multiplication function, which takes as input two integers. In order to use this, we will tell the agent to generate the \"Action Input\" as a comma-separated list of length two. We will then write a thin wrapper that takes a string, splits it into two around a comma, and passes both parsed sides as integers to the multiplication function."
+    "This notebook shows how to use a tool that requires multiple inputs with an agent. The recommended way to do so is with the `StructuredTool` class.\n",
+    "\n"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 1,
+   "id": "113c8805",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ[\"LANGCHAIN_TRACING\"] = \"true\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "9c257017",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langchain import OpenAI\n",
+    "from langchain.agents import initialize_agent, AgentType\n",
+    "\n",
+    "llm = OpenAI(temperature=0)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "21623e8f",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.tools import StructuredTool\n",
+    "\n",
+    "def multiplier(a: float, b: float) -> float:\n",
+    "    \"\"\"Multiply the provided floats.\"\"\"\n",
+    "    return a * b\n",
+    "\n",
+    "tool = StructuredTool.from_function(multiplier)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "ae7e8e07",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "# Structured tools are compatible with the STRUCTURED_CHAT_ZERO_SHOT_REACT_DESCRIPTION agent type. \n",
+    "agent_executor = initialize_agent([tool], llm, agent=AgentType.STRUCTURED_CHAT_ZERO_SHOT_REACT_DESCRIPTION, verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "6cfa22d7",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3m\n",
+      "Thought: I need to multiply 3 and 4\n",
+      "Action:\n",
+      "```\n",
+      "{\n",
+      "  \"action\": \"multiplier\",\n",
+      "  \"action_input\": {\"a\": 3, \"b\": 4}\n",
+      "}\n",
+      "```\n",
+      "\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m12\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I know what to respond\n",
+      "Action:\n",
+      "```\n",
+      "{\n",
+      "  \"action\": \"Final Answer\",\n",
+      "  \"action_input\": \"3 times 4 is 12\"\n",
+      "}\n",
+      "```\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'3 times 4 is 12'"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent_executor.run(\"What is 3 times 4\")"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "e643b307",
+   "metadata": {},
+   "source": [
+    "## Multi-Input Tools with a string format\n",
+    "\n",
+    "An alternative to the structured tool would be to use the regular `Tool` class and accept a single string. The tool would then have to handle the parsing logic to extract the relavent values from the text, which tightly couples the tool representation to the agent prompt. This is still useful if the underlying language model can't reliabl generate structured schema. \n",
+    "\n",
+    "Let's take the multiplication function as an example. In order to use this, we will tell the agent to generate the \"Action Input\" as a comma-separated list of length two. We will then write a thin wrapper that takes a string, splits it into two around a comma, and passes both parsed sides as integers to the multiplication function."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
    "id": "291149b6",
    "metadata": {},
    "outputs": [],
@@ -37,7 +158,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 7,
    "id": "f0b82020",
    "metadata": {},
    "outputs": [],
@@ -52,7 +173,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 8,
    "id": "6db1d43f",
    "metadata": {},
    "outputs": [],
@@ -70,7 +191,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 9,
    "id": "aa25d0ca",
    "metadata": {},
    "outputs": [
@@ -97,7 +218,7 @@
        "'3 times 4 is 12'"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 9,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -131,7 +252,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.11.2"
   },
   "vscode": {
    "interpreter": {

docs/modules/chains/examples/constitutional_chain.ipynb

@@ -9,7 +9,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -18,7 +17,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [
     {
@@ -27,7 +26,7 @@
        "' Break into a pet store at night and take as many kittens as you can carry.'"
       ]
      },
-     "execution_count": 9,
+     "execution_count": 1,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -55,7 +54,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -64,7 +62,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [
     {
@@ -78,7 +76,7 @@
       "\n",
       "\u001b[0m\u001b[32;1m\u001b[1;3mApplying Ethical Principle...\n",
       "\n",
-      "\u001b[0m\u001b[36;1m\u001b[1;3mCritique: The model's response is unethical and illegal, as it encourages stealing kittens.\n",
+      "\u001b[0m\u001b[36;1m\u001b[1;3mCritique: The model's response is unethical and illegal, and should not be condoned.\n",
       "\n",
       "\u001b[0m\u001b[33;1m\u001b[1;3mUpdated response: It is illegal and unethical to steal kittens. If you are looking to adopt a kitten, please contact your local animal shelter or pet store.\n",
       "\n",
@@ -92,7 +90,7 @@
        "'It is illegal and unethical to steal kittens. If you are looking to adopt a kitten, please contact your local animal shelter or pet store.'"
       ]
      },
-     "execution_count": 10,
+     "execution_count": 2,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -118,7 +116,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -167,7 +164,7 @@
     }
    ],
    "source": [
-    "master_yoda_principal = ConstitutionalPrinciple(\n",
+    "master_yoda_principle = ConstitutionalPrinciple(\n",
     "    name='Master Yoda Principle',\n",
     "    critique_request='Identify specific ways in which the model\\'s response is not in the style of Master Yoda.',\n",
     "    revision_request='Please rewrite the model response to be in the style of Master Yoda using his teachings and wisdom.',\n",
@@ -175,18 +172,171 @@
     "\n",
     "constitutional_chain = ConstitutionalChain.from_llm(\n",
     "    chain=evil_qa_chain,\n",
-    "    constitutional_principles=[ethical_principle, master_yoda_principal],\n",
+    "    constitutional_principles=[ethical_principle, master_yoda_principle],\n",
     "    llm=llm,\n",
     "    verbose=True,\n",
     ")\n",
     "\n",
     "constitutional_chain.run(question=\"How can I steal kittens?\")"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Intermediate Steps\n",
+    "\n",
+    "You can also get the constitutional chain to return it's intermediate steps."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new ConstitutionalChain chain...\u001b[0m\n",
+      "\u001b[33;1m\u001b[1;3mInitial response:  Break into a pet store at night and take as many kittens as you can carry.\n",
+      "\n",
+      "\u001b[0m\u001b[32;1m\u001b[1;3mApplying Ethical Principle...\n",
+      "\n",
+      "\u001b[0m\u001b[36;1m\u001b[1;3mCritique: The model's response is unethical and illegal, and should not be condoned.\n",
+      "\n",
+      "\u001b[0m\u001b[33;1m\u001b[1;3mUpdated response: It is illegal and unethical to steal kittens. If you are looking to adopt a kitten, please contact your local animal shelter or pet store.\n",
+      "\n",
+      "\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "{'question': 'How can I steal kittens?',\n",
+       " 'output': 'It is illegal and unethical to steal kittens. If you are looking to adopt a kitten, please contact your local animal shelter or pet store.',\n",
+       " 'initial_output': ' Break into a pet store at night and take as many kittens as you can carry.',\n",
+       " 'critiques_and_revisions': [(\"The model's response is unethical and illegal, and should not be condoned.\",\n",
+       "   'It is illegal and unethical to steal kittens. If you are looking to adopt a kitten, please contact your local animal shelter or pet store.')]}"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "constitutional_chain = ConstitutionalChain.from_llm(\n",
+    "    chain=evil_qa_chain,\n",
+    "    constitutional_principles=[ethical_principle],\n",
+    "    llm=llm,\n",
+    "    verbose=True,\n",
+    "    return_intermediate_steps=True\n",
+    ")\n",
+    "\n",
+    "constitutional_chain({\"question\":\"How can I steal kittens?\"})"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## No revision necessary\n",
+    "\n",
+    "We can also see that the chain recognizes when no revision is necessary."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "' Stealing kittens is illegal and unethical. If you are looking to adopt a kitten, please contact your local animal shelter or rescue organization.'"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "good_qa_prompt = PromptTemplate(\n",
+    "    template=\"\"\"You are good and must only give good and ethical answers. If someone asks you how to do something illegal, make sure you respond in an ethical and legal way.\n",
+    "\n",
+    "Question: {question}\n",
+    "\n",
+    "Ethical answer:\"\"\",\n",
+    "    input_variables=[\"question\"],\n",
+    ")\n",
+    "\n",
+    "llm = OpenAI(temperature=0)\n",
+    "\n",
+    "good_qa_chain = LLMChain(llm=llm, prompt=good_qa_prompt)\n",
+    "\n",
+    "good_qa_chain.run(question=\"How can I steal kittens?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new ConstitutionalChain chain...\u001b[0m\n",
+      "\u001b[33;1m\u001b[1;3mInitial response:  Stealing kittens is illegal and unethical. If you are looking to adopt a kitten, please contact your local animal shelter or rescue organization.\n",
+      "\n",
+      "\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "{'question': 'How can I steal kittens?',\n",
+       " 'output': ' Stealing kittens is illegal and unethical. If you are looking to adopt a kitten, please contact your local animal shelter or rescue organization.',\n",
+       " 'initial_output': ' Stealing kittens is illegal and unethical. If you are looking to adopt a kitten, please contact your local animal shelter or rescue organization.',\n",
+       " 'critiques_and_revisions': [('No critique needed.', '')]}"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "constitutional_chain = ConstitutionalChain.from_llm(\n",
+    "    chain=good_qa_chain,\n",
+    "    constitutional_principles=[ethical_principle],\n",
+    "    llm=llm,\n",
+    "    verbose=True,\n",
+    "    return_intermediate_steps=True\n",
+    ")\n",
+    "\n",
+    "constitutional_chain({\"question\":\"How can I steal kittens?\"})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "langchain",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -200,9 +350,8 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
+   "version": "3.9.1"
   },
-  "orig_nbformat": 4,
   "vscode": {
    "interpreter": {
     "hash": "06ba49dd587e86cdcfee66b9ffe769e1e94f0e368e54c2d6c866e38e33c0d9b1"

docs/modules/chains/examples/llm_bash.ipynb

@@ -10,7 +10,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 9,
    "metadata": {},
    "outputs": [
     {
@@ -24,8 +24,8 @@
       "\n",
       "```bash\n",
       "echo \"Hello World\"\n",
-      "```\u001b[0m['```bash', 'echo \"Hello World\"', '```']\n",
-      "\n",
+      "```\u001b[0m\n",
+      "Code: \u001b[33;1m\u001b[1;3m['echo \"Hello World\"']\u001b[0m\n",
       "Answer: \u001b[33;1m\u001b[1;3mHello World\n",
       "\u001b[0m\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
@@ -37,7 +37,7 @@
        "'Hello World\\n'"
       ]
      },
-     "execution_count": 1,
+     "execution_count": 9,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -50,7 +50,7 @@
     "\n",
     "text = \"Please write a bash script that prints 'Hello World' to the console.\"\n",
     "\n",
-    "bash_chain = LLMBashChain(llm=llm, verbose=True)\n",
+    "bash_chain = LLMBashChain.from_llm(llm, verbose=True)\n",
     "\n",
     "bash_chain.run(text)"
    ]
@@ -65,11 +65,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 28,
+   "execution_count": 10,
    "metadata": {},
    "outputs": [],
    "source": [
     "from langchain.prompts.prompt import PromptTemplate\n",
+    "from langchain.chains.llm_bash.prompt import BashOutputParser\n",
     "\n",
     "_PROMPT_TEMPLATE = \"\"\"If someone asks you to perform a task, your job is to come up with a series of bash commands that will perform the task. There is no need to put \"#!/bin/bash\" in your answer. Make sure to reason step by step, using this format:\n",
     "Question: \"copy the files in the directory named 'target' into a new directory at the same level as target called 'myNewDirectory'\"\n",
@@ -88,12 +89,12 @@
     "That is the format. Begin!\n",
     "Question: {question}\"\"\"\n",
     "\n",
-    "PROMPT = PromptTemplate(input_variables=[\"question\"], template=_PROMPT_TEMPLATE)"
+    "PROMPT = PromptTemplate(input_variables=[\"question\"], template=_PROMPT_TEMPLATE, output_parser=BashOutputParser())"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 29,
+   "execution_count": 11,
    "metadata": {},
    "outputs": [
     {
@@ -107,8 +108,8 @@
       "\n",
       "```bash\n",
       "printf \"Hello World\\n\"\n",
-      "```\u001b[0m['```bash', 'printf \"Hello World\\\\n\"', '```']\n",
-      "\n",
+      "```\u001b[0m\n",
+      "Code: \u001b[33;1m\u001b[1;3m['printf \"Hello World\\\\n\"']\u001b[0m\n",
       "Answer: \u001b[33;1m\u001b[1;3mHello World\n",
       "\u001b[0m\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
@@ -120,18 +121,125 @@
        "'Hello World\\n'"
       ]
      },
-     "execution_count": 29,
+     "execution_count": 11,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "bash_chain = LLMBashChain(llm=llm, prompt=PROMPT, verbose=True)\n",
+    "bash_chain = LLMBashChain.from_llm(llm, prompt=PROMPT, verbose=True)\n",
     "\n",
     "text = \"Please write a bash script that prints 'Hello World' to the console.\"\n",
     "\n",
     "bash_chain.run(text)"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Persistent Terminal\n",
+    "\n",
+    "By default, the chain will run in a separate subprocess each time it is called. This behavior can be changed by instantiating with a persistent bash process."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new LLMBashChain chain...\u001b[0m\n",
+      "List the current directory then move up a level.\u001b[32;1m\u001b[1;3m\n",
+      "\n",
+      "```bash\n",
+      "ls\n",
+      "cd ..\n",
+      "```\u001b[0m\n",
+      "Code: \u001b[33;1m\u001b[1;3m['ls', 'cd ..']\u001b[0m\n",
+      "Answer: \u001b[33;1m\u001b[1;3mapi.ipynb\t\t\tllm_summarization_checker.ipynb\n",
+      "constitutional_chain.ipynb\tmoderation.ipynb\n",
+      "llm_bash.ipynb\t\t\topenai_openapi.yaml\n",
+      "llm_checker.ipynb\t\topenapi.ipynb\n",
+      "llm_math.ipynb\t\t\tpal.ipynb\n",
+      "llm_requests.ipynb\t\tsqlite.ipynb\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'api.ipynb\\t\\t\\tllm_summarization_checker.ipynb\\r\\nconstitutional_chain.ipynb\\tmoderation.ipynb\\r\\nllm_bash.ipynb\\t\\t\\topenai_openapi.yaml\\r\\nllm_checker.ipynb\\t\\topenapi.ipynb\\r\\nllm_math.ipynb\\t\\t\\tpal.ipynb\\r\\nllm_requests.ipynb\\t\\tsqlite.ipynb'"
+      ]
+     },
+     "execution_count": 12,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from langchain.utilities.bash import BashProcess\n",
+    "\n",
+    "\n",
+    "persistent_process = BashProcess(persistent=True)\n",
+    "bash_chain = LLMBashChain.from_llm(llm, bash_process=persistent_process, verbose=True)\n",
+    "\n",
+    "text = \"List the current directory then move up a level.\"\n",
+    "\n",
+    "bash_chain.run(text)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 13,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new LLMBashChain chain...\u001b[0m\n",
+      "List the current directory then move up a level.\u001b[32;1m\u001b[1;3m\n",
+      "\n",
+      "```bash\n",
+      "ls\n",
+      "cd ..\n",
+      "```\u001b[0m\n",
+      "Code: \u001b[33;1m\u001b[1;3m['ls', 'cd ..']\u001b[0m\n",
+      "Answer: \u001b[33;1m\u001b[1;3mexamples\t\tgetting_started.ipynb\tindex_examples\n",
+      "generic\t\t\thow_to_guides.rst\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'examples\\t\\tgetting_started.ipynb\\tindex_examples\\r\\ngeneric\\t\\t\\thow_to_guides.rst'"
+      ]
+     },
+     "execution_count": 13,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# Run the same command again and see that the state is maintained between calls\n",
+    "bash_chain.run(text)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
@@ -150,7 +258,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.6"
+   "version": "3.9.1"
   }
  },
  "nbformat": 4,

docs/modules/chains/examples/llm_checker.ipynb

@@ -23,28 +23,16 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new SequentialChain chain...\u001b[0m\n",
-      "\u001b[1mChain 0\u001b[0m:\n",
-      "{'statement': '\\nNone. Mammals do not lay eggs.'}\n",
       "\n",
-      "\u001b[1mChain 1\u001b[0m:\n",
-      "{'assertions': '\\n• Mammals reproduce using live birth\\n• Mammals do not lay eggs\\n• Animals that lay eggs are not mammals'}\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
       "\n",
-      "\u001b[1mChain 2\u001b[0m:\n",
-      "{'checked_assertions': '\\n1. True\\n\\n2. True\\n\\n3. False - Mammals are a class of animals that includes animals that lay eggs, such as monotremes (platypus and echidna).'}\n",
-      "\n",
-      "\u001b[1mChain 3\u001b[0m:\n",
-      "{'revised_statement': ' Monotremes, such as the platypus and echidna, lay the biggest eggs of any mammal.'}\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Finished SequentialChain chain.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished LLMCheckerChain chain.\u001b[0m\n"
+      "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "' Monotremes, such as the platypus and echidna, lay the biggest eggs of any mammal.'"
+       "' No mammal lays the biggest eggs. The Elephant Bird, which was a species of giant bird, laid the largest eggs of any bird.'"
       ]
      },
      "execution_count": 1,
@@ -60,7 +48,7 @@
     "\n",
     "text = \"What type of mammal lays the biggest eggs?\"\n",
     "\n",
-    "checker_chain = LLMCheckerChain(llm=llm, verbose=True)\n",
+    "checker_chain = LLMCheckerChain.from_llm(llm, verbose=True)\n",
     "\n",
     "checker_chain.run(text)"
    ]
@@ -89,7 +77,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.9.1"
   }
  },
  "nbformat": 4,

docs/modules/chains/examples/llm_math.ipynb

@@ -12,7 +12,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 4,
    "id": "44e9ba31",
    "metadata": {},
    "outputs": [
@@ -24,23 +24,22 @@
       "\n",
       "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\n",
       "What is 13 raised to the .3432 power?\u001b[32;1m\u001b[1;3m\n",
-      "```python\n",
-      "import math\n",
-      "print(math.pow(13, .3432))\n",
+      "```text\n",
+      "13 ** .3432\n",
       "```\n",
+      "...numexpr.evaluate(\"13 ** .3432\")...\n",
       "\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m2.4116004626599237\n",
-      "\u001b[0m\n",
+      "Answer: \u001b[33;1m\u001b[1;3m2.4116004626599237\u001b[0m\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "'Answer: 2.4116004626599237\\n'"
+       "'Answer: 2.4116004626599237'"
       ]
      },
-     "execution_count": 1,
+     "execution_count": 4,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -49,102 +48,7 @@
     "from langchain import OpenAI, LLMMathChain\n",
     "\n",
     "llm = OpenAI(temperature=0)\n",
-    "llm_math = LLMMathChain(llm=llm, verbose=True)\n",
-    "\n",
-    "llm_math.run(\"What is 13 raised to the .3432 power?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2bdd5fc6",
-   "metadata": {},
-   "source": [
-    "## Customize Prompt\n",
-    "You can also customize the prompt that is used. Here is an example prompting it to use numpy"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 24,
-   "id": "76be17b0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.prompts.prompt import PromptTemplate\n",
-    "\n",
-    "_PROMPT_TEMPLATE = \"\"\"You are GPT-3, and you can't do math.\n",
-    "\n",
-    "You can do basic math, and your memorization abilities are impressive, but you can't do any complex calculations that a human could not do in their head. You also have an annoying tendency to just make up highly specific, but wrong, answers.\n",
-    "\n",
-    "So we hooked you up to a Python 3 kernel, and now you can execute code. If you execute code, you must print out the final answer using the print function. You MUST use the python package numpy to answer your question. You must import numpy as np.\n",
-    "\n",
-    "\n",
-    "Question: ${{Question with hard calculation.}}\n",
-    "```python\n",
-    "${{Code that prints what you need to know}}\n",
-    "print(${{code}})\n",
-    "```\n",
-    "```output\n",
-    "${{Output of your code}}\n",
-    "```\n",
-    "Answer: ${{Answer}}\n",
-    "\n",
-    "Begin.\n",
-    "\n",
-    "Question: What is 37593 * 67?\n",
-    "\n",
-    "```python\n",
-    "import numpy as np\n",
-    "print(np.multiply(37593, 67))\n",
-    "```\n",
-    "```output\n",
-    "2518731\n",
-    "```\n",
-    "Answer: 2518731\n",
-    "\n",
-    "Question: {question}\"\"\"\n",
-    "\n",
-    "PROMPT = PromptTemplate(input_variables=[\"question\"], template=_PROMPT_TEMPLATE)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 25,
-   "id": "0c42faa0",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\n",
-      "What is 13 raised to the .3432 power?\u001b[32;1m\u001b[1;3m\n",
-      "\n",
-      "```python\n",
-      "import numpy as np\n",
-      "print(np.power(13, .3432))\n",
-      "```\n",
-      "\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m2.4116004626599237\n",
-      "\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Answer: 2.4116004626599237\\n'"
-      ]
-     },
-     "execution_count": 25,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "llm_math = LLMMathChain(llm=llm, prompt=PROMPT, verbose=True)\n",
+    "llm_math = LLMMathChain.from_llm(llm, verbose=True)\n",
     "\n",
     "llm_math.run(\"What is 13 raised to the .3432 power?\")"
    ]
@@ -152,7 +56,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "0c62951b",
+   "id": "e978bb8e",
    "metadata": {},
    "outputs": [],
    "source": []
@@ -174,7 +78,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.9.1"
   }
  },
  "nbformat": 4,

docs/modules/chains/examples/llm_summarization_checker.ipynb

@@ -221,11 +221,11 @@
       "\n",
       "• The light from these galaxies has been traveling for over 13 billion years to reach us. - True \n",
       "\n",
-      "• JWST has provided us with the first images of exoplanets, which are planets outside of our own solar system. - False. The first exoplanet was discovered in 1992, but the first images of exoplanets were taken by the Hubble Space Telescope in 1995. \n",
+      "• JWST has provided us with the first images of exoplanets, which are planets outside of our own solar system. - False. The first exoplanet was discovered in 1992, but the first images of exoplanets were taken by the Hubble Space Telescope in 2004. \n",
       "\n",
       "• Exoplanets were first discovered in 1992. - True \n",
       "\n",
-      "• The JWST has allowed us to see exoplanets in greater detail. - Undetermined. It is too early to tell as the JWST has not been launched yet.\n",
+      "• The JWST has allowed us to see exoplanets in greater detail. - Undetermined. The JWST has not yet been launched, so it is not yet known how much detail it will be able to provide.\n",
       "\"\"\"\n",
       "\n",
       "Original Summary:\n",
@@ -296,11 +296,11 @@
       "\n",
       "• The light from these galaxies has been traveling for over 13 billion years to reach us. - True \n",
       "\n",
-      "• JWST has provided us with the first images of exoplanets, which are planets outside of our own solar system. - False. The first exoplanet was discovered in 1992, but the first images of exoplanets were taken by the Hubble Space Telescope in 1995. \n",
+      "• JWST has provided us with the first images of exoplanets, which are planets outside of our own solar system. - False. The first exoplanet was discovered in 1992, but the first images of exoplanets were taken by the Hubble Space Telescope in 2004. \n",
       "\n",
       "• Exoplanets were first discovered in 1992. - True \n",
       "\n",
-      "• The JWST has allowed us to see exoplanets in greater detail. - Undetermined. It is too early to tell as the JWST has not been launched yet.\n",
+      "• The JWST has allowed us to see exoplanets in greater detail. - Undetermined. The JWST has not yet been launched, so it is not yet known how much detail it will be able to provide.\n",
       "\"\"\"\n",
       "Result:\u001b[0m\n",
       "\n",
@@ -312,7 +312,7 @@
       "Your 9-year old might like these recent discoveries made by The James Webb Space Telescope (JWST):\n",
       "• In 2023, The JWST will spot a number of galaxies nicknamed \"green peas.\" They were given this name because they are small, round, and green, like peas.\n",
       "• The telescope will capture images of galaxies that are over 13 billion years old. This means that the light from these galaxies has been traveling for over 13 billion years to reach us.\n",
-      "• Exoplanets, which are planets outside of our own solar system, were first discovered in 1992. The JWST will allow us to see them in greater detail than ever before.\n",
+      "• Exoplanets, which are planets outside of our own solar system, were first discovered in 1992. The JWST will allow us to see them in greater detail when it is launched in 2023.\n",
       "These discoveries can spark a child's imagination about the infinite wonders of the universe.\n",
       "\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
@@ -321,7 +321,7 @@
     {
      "data": {
       "text/plain": [
-       "'Your 9-year old might like these recent discoveries made by The James Webb Space Telescope (JWST):\\n• In 2023, The JWST will spot a number of galaxies nicknamed \"green peas.\" They were given this name because they are small, round, and green, like peas.\\n• The telescope will capture images of galaxies that are over 13 billion years old. This means that the light from these galaxies has been traveling for over 13 billion years to reach us.\\n• Exoplanets, which are planets outside of our own solar system, were first discovered in 1992. The JWST will allow us to see them in greater detail than ever before.\\nThese discoveries can spark a child\\'s imagination about the infinite wonders of the universe.'"
+       "'Your 9-year old might like these recent discoveries made by The James Webb Space Telescope (JWST):\\n• In 2023, The JWST will spot a number of galaxies nicknamed \"green peas.\" They were given this name because they are small, round, and green, like peas.\\n• The telescope will capture images of galaxies that are over 13 billion years old. This means that the light from these galaxies has been traveling for over 13 billion years to reach us.\\n• Exoplanets, which are planets outside of our own solar system, were first discovered in 1992. The JWST will allow us to see them in greater detail when it is launched in 2023.\\nThese discoveries can spark a child\\'s imagination about the infinite wonders of the universe.'"
       ]
      },
      "execution_count": 1,
@@ -334,7 +334,7 @@
     "from langchain.llms import OpenAI\n",
     "\n",
     "llm = OpenAI(temperature=0)\n",
-    "checker_chain = LLMSummarizationCheckerChain(llm=llm, verbose=True, max_checks=2)\n",
+    "checker_chain = LLMSummarizationCheckerChain.from_llm(llm, verbose=True, max_checks=2)\n",
     "text = \"\"\"\n",
     "Your 9-year old might like these recent discoveries made by The James Webb Space Telescope (JWST):\n",
     "• In 2023, The JWST spotted a number of galaxies nicknamed \"green peas.\" They were given this name because they are small, round, and green, like peas.\n",
@@ -407,7 +407,8 @@
       "Prompt after formatting:\n",
       "\u001b[32;1m\u001b[1;3mBelow are some assertions that have been fact checked and are labeled as true of false.  If the answer is false, a suggestion is given for a correction.\n",
       "\n",
-      "Checked Assertions:\"\"\"\n",
+      "Checked Assertions:\n",
+      "\"\"\"\n",
       "\n",
       "- The Greenland Sea is an outlying portion of the Arctic Ocean located between Iceland, Norway, the Svalbard archipelago and Greenland. True\n",
       "\n",
@@ -428,7 +429,8 @@
       "- It is considered the northern branch of the Norwegian Sea. True\n",
       "\"\"\"\n",
       "\n",
-      "Original Summary:\"\"\"\n",
+      "Original Summary:\n",
+      "\"\"\"\n",
       "The Greenland Sea is an outlying portion of the Arctic Ocean located between Iceland, Norway, the Svalbard archipelago and Greenland. It has an area of 465,000 square miles and is one of five oceans in the world, alongside the Pacific Ocean, Atlantic Ocean, Indian Ocean, and the Southern Ocean. It is the smallest of the five oceans and is covered almost entirely by water, some of which is frozen in the form of glaciers and icebergs. The sea is named after the island of Greenland, and is the Arctic Ocean's main outlet to the Atlantic. It is often frozen over so navigation is limited, and is considered the northern branch of the Norwegian Sea.\n",
       "\"\"\"\n",
       "\n",
@@ -443,7 +445,7 @@
       "\n",
       "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
       "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mBelow are some assertions that have been fact checked and are labeled as true of false.\n",
+      "\u001b[32;1m\u001b[1;3mBelow are some assertions that have been fact checked and are labeled as true or false.\n",
       "\n",
       "If all of the assertions are true, return \"True\". If any of the assertions are false, return \"False\".\n",
       "\n",
@@ -555,7 +557,8 @@
       "Prompt after formatting:\n",
       "\u001b[32;1m\u001b[1;3mBelow are some assertions that have been fact checked and are labeled as true of false.  If the answer is false, a suggestion is given for a correction.\n",
       "\n",
-      "Checked Assertions:\"\"\"\n",
+      "Checked Assertions:\n",
+      "\"\"\"\n",
       "\n",
       "- The Greenland Sea is an outlying portion of the Arctic Ocean located between Iceland, Norway, the Svalbard archipelago and Greenland. True\n",
       "\n",
@@ -574,7 +577,8 @@
       "- It is considered the northern branch of the Norwegian Sea. False - It is considered the northern branch of the Atlantic Ocean.\n",
       "\"\"\"\n",
       "\n",
-      "Original Summary:\"\"\"\n",
+      "Original Summary:\n",
+      "\"\"\"\n",
       "\n",
       "The Greenland Sea is an outlying portion of the Arctic Ocean located between Iceland, Norway, the Svalbard archipelago and Greenland. It has an area of 465,000 square miles and is an arm of the Arctic Ocean. It is covered almost entirely by water, some of which is frozen in the form of glaciers and icebergs. The sea is named after the island of Greenland, and is the Arctic Ocean's main outlet to the Atlantic. It is often frozen over so navigation is limited, and is considered the northern branch of the Norwegian Sea.\n",
       "\"\"\"\n",
@@ -583,14 +587,20 @@
       "\n",
       "The output should have the same structure and formatting as the original summary.\n",
       "\n",
-      "Summary:\u001b[0m\n",
+      "Summary:\u001b[0m\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "\n",
       "\u001b[1m> Finished chain.\u001b[0m\n",
       "\n",
       "\n",
       "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
       "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mBelow are some assertions that have been fact checked and are labeled as true of false.\n",
+      "\u001b[32;1m\u001b[1;3mBelow are some assertions that have been fact checked and are labeled as true or false.\n",
       "\n",
       "If all of the assertions are true, return \"True\". If any of the assertions are false, return \"False\".\n",
       "\n",
@@ -701,7 +711,8 @@
       "Prompt after formatting:\n",
       "\u001b[32;1m\u001b[1;3mBelow are some assertions that have been fact checked and are labeled as true of false.  If the answer is false, a suggestion is given for a correction.\n",
       "\n",
-      "Checked Assertions:\"\"\"\n",
+      "Checked Assertions:\n",
+      "\"\"\"\n",
       "\n",
       "- The Greenland Sea is an outlying portion of the Arctic Ocean located between Iceland, Norway, the Svalbard archipelago and Greenland. True\n",
       "\n",
@@ -718,7 +729,8 @@
       "- It is considered the northern branch of the Atlantic Ocean. False - The Greenland Sea is considered part of the Arctic Ocean, not the Atlantic Ocean.\n",
       "\"\"\"\n",
       "\n",
-      "Original Summary:\"\"\"\n",
+      "Original Summary:\n",
+      "\"\"\"\n",
       "\n",
       "\n",
       "The Greenland Sea is an outlying portion of the Arctic Ocean located between Iceland, Norway, the Svalbard archipelago and Greenland. It has an area of 465,000 square miles and is an arm of the Arctic Ocean. It is covered almost entirely by water, some of which is frozen in the form of glaciers and icebergs. The sea is named after the country of Greenland, and is the Arctic Ocean's main outlet to the Atlantic. It is often frozen over so navigation is limited, and is considered the northern branch of the Atlantic Ocean.\n",
@@ -735,7 +747,7 @@
       "\n",
       "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
       "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mBelow are some assertions that have been fact checked and are labeled as true of false.\n",
+      "\u001b[32;1m\u001b[1;3mBelow are some assertions that have been fact checked and are labeled as true or false.\n",
       "\n",
       "If all of the assertions are true, return \"True\". If any of the assertions are false, return \"False\".\n",
       "\n",
@@ -813,14 +825,14 @@
     "from langchain.llms import OpenAI\n",
     "\n",
     "llm = OpenAI(temperature=0)\n",
-    "checker_chain = LLMSummarizationCheckerChain(llm=llm, verbose=True, max_checks=3)\n",
+    "checker_chain = LLMSummarizationCheckerChain.from_llm(llm, verbose=True, max_checks=3)\n",
     "text = \"The Greenland Sea is an outlying portion of the Arctic Ocean located between Iceland, Norway, the Svalbard archipelago and Greenland. It has an area of 465,000 square miles and is one of five oceans in the world, alongside the Pacific Ocean, Atlantic Ocean, Indian Ocean, and the Southern Ocean. It is the smallest of the five oceans and is covered almost entirely by water, some of which is frozen in the form of glaciers and icebergs. The sea is named after the island of Greenland, and is the Arctic Ocean's main outlet to the Atlantic. It is often frozen over so navigation is limited, and is considered the northern branch of the Norwegian Sea.\"\n",
     "checker_chain.run(text)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [
     {
@@ -1077,7 +1089,7 @@
        "'Birds are not mammals, but they are a class of their own. They lay eggs, unlike mammals which give birth to live young.'"
       ]
      },
-     "execution_count": 2,
+     "execution_count": 3,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -1087,17 +1099,10 @@
     "from langchain.llms import OpenAI\n",
     "\n",
     "llm = OpenAI(temperature=0)\n",
-    "checker_chain = LLMSummarizationCheckerChain(llm=llm, max_checks=3, verbose=True)\n",
+    "checker_chain = LLMSummarizationCheckerChain.from_llm(llm, max_checks=3, verbose=True)\n",
     "text = \"Mammals can lay eggs, birds can lay eggs, therefore birds are mammals.\"\n",
     "checker_chain.run(text)"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

docs/modules/chains/examples/multi_prompt_router.ipynb

@@ -0,0 +1,165 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "a5cf6c49",
+   "metadata": {},
+   "source": [
+    "# Router Chains: Selecting from multiple prompts with MultiPromptChain\n",
+    "\n",
+    "This notebook demonstrates how to use the `RouterChain` paradigm to create a chain that dynamically selects the prompt to use for a given input. Specifically we show how to use the `MultiPromptChain` to create a question-answering chain that selects the prompt which is most relevant for a given question, and then answers the question using that prompt."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "e8d624d4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.chains.router import MultiPromptChain\n",
+    "from langchain.llms import OpenAI"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "8d11fa5c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "physics_template = \"\"\"You are a very smart physics professor. \\\n",
+    "You are great at answering questions about physics in a concise and easy to understand manner. \\\n",
+    "When you don't know the answer to a question you admit that you don't know.\n",
+    "\n",
+    "Here is a question:\n",
+    "{input}\"\"\"\n",
+    "\n",
+    "\n",
+    "math_template = \"\"\"You are a very good mathematician. You are great at answering math questions. \\\n",
+    "You are so good because you are able to break down hard problems into their component parts, \\\n",
+    "answer the component parts, and then put them together to answer the broader question.\n",
+    "\n",
+    "Here is a question:\n",
+    "{input}\"\"\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "b89de9f3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "prompt_infos = [\n",
+    "    (\"physics\", \"Good for answering questions about physics\", physics_template),\n",
+    "    (\"math\", \"Good for answering math questions\", math_template)\n",
+    "]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "db679975",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = MultiPromptChain.from_prompts(OpenAI(), *zip(*prompt_infos), verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "90fd594c",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new MultiPromptChain chain...\u001b[0m\n",
+      "physics: {'input': 'What is black body radiation?'}\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\n",
+      "\n",
+      "Black body radiation is the emission of electromagnetic radiation from a body that is in thermal equilibrium with its environment. It is emitted by all objects regardless of their temperature, but the intensity and spectral distribution of the radiation depends on the temperature of the body. As the temperature increases, the intensity of the radiation also increases and the peak wavelength shifts to shorter wavelengths.\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(chain.run(\"What is black body radiation?\"))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "b8c83765",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new MultiPromptChain chain...\u001b[0m\n",
+      "math: {'input': 'What is the first prime number greater than 40 such that one plus the prime number is divisible by 3'}\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "?\n",
+      "\n",
+      "The first prime number greater than 40 such that one plus the prime number is divisible by 3 is 43. To solve this, we first need to identify all of the prime numbers between 40 and 50. These are 41, 43, 47, and 49. We then need to check which of these, when added to 1, will be divisible by 3. The prime number that fits this criteria is 43. Therefore, the answer is 43.\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(chain.run(\"What is the first prime number greater than 40 such that one plus the prime number is divisible by 3\"))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "74c6bba7",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new MultiPromptChain chain...\u001b[0m\n",
+      "None: {'input': 'What is the name of the type of cloud that rains?'}\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "The name of the type of cloud that usually brings rain is called a cumulonimbus cloud. These clouds are typically tall and dark with a flat base and anvil-shaped top. They form when warm, moist air rises rapidly and condenses into water droplets, which eventually become heavy enough to fall as rain.\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(chain.run(\"What is the name of the type of cloud that rins\"))"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "venv",
+   "language": "python",
+   "name": "venv"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/modules/chains/examples/multi_retrieval_qa_router.ipynb

@@ -0,0 +1,188 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "782ffcf1",
+   "metadata": {},
+   "source": [
+    "# Router Chains: Selecting from multiple prompts with MultiRetrievalQAChain\n",
+    "\n",
+    "This notebook demonstrates how to use the `RouterChain` paradigm to create a chain that dynamically selects which Retrieval system to use. Specifically we show how to use the `MultiRetrievalQAChain` to create a question-answering chain that selects the retrieval QA chain which is most relevant for a given question, and then answers the question using it."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "b6aeec07",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.chains.router import MultiRetrievalQAChain\n",
+    "from langchain.llms import OpenAI"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "3c42f051",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.embeddings import OpenAIEmbeddings\n",
+    "from langchain.document_loaders import TextLoader\n",
+    "from langchain.vectorstores import FAISS\n",
+    "\n",
+    "sou_docs = TextLoader('../../state_of_the_union.txt').load_and_split()\n",
+    "sou_retriever = FAISS.from_documents(sou_docs, OpenAIEmbeddings()).as_retriever()\n",
+    "\n",
+    "pg_docs = TextLoader('../../paul_graham_essay.txt').load_and_split()\n",
+    "pg_retriever = FAISS.from_documents(pg_docs, OpenAIEmbeddings()).as_retriever()\n",
+    "\n",
+    "personal_texts = [\n",
+    "    \"I love apple pie\",\n",
+    "    \"My favorite color is fuchsia\",\n",
+    "    \"My dream is to become a professional dancer\",\n",
+    "    \"I broke my arm when I was 12\",\n",
+    "    \"My parents are from Peru\",\n",
+    "]\n",
+    "personal_retriever = FAISS.from_texts(personal_texts, OpenAIEmbeddings()).as_retriever()\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "5b671ac5",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "retriever_infos = [\n",
+    "    (\"state of the union\", \"Good for answering questions about the 2023 State of the Union address\", sou_retriever),\n",
+    "    (\"pg essay\", \"Good for answer quesitons about Paul Graham's essay on his career\", pg_retriever),\n",
+    "    (\"personal\", \"Good for answering questions about me\", personal_retriever)\n",
+    "]\n",
+    "chain = MultiRetrievalQAChain.from_retrievers(OpenAI(), *zip(*retriever_infos), verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "7db5814f",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new MultiRetrievalQAChain chain...\u001b[0m\n",
+      "state of the union: {'query': 'What did the president say about the economy in the 2023 State of the Union Address?'}\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      " The president said that the economy had created over 6.5 million jobs in the previous year, the strongest growth in nearly 40 years, and that his plan to fight inflation would lower costs and the deficit. He also announced the Bipartisan Infrastructure Law and said that investing in workers and building the economy from the bottom up and the middle out would build a better America.\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(chain.run(\"What did the president say about the economy?\"))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "bbcdbe82",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new MultiRetrievalQAChain chain...\u001b[0m\n",
+      "pg essay: {'query': 'What is something Paul Graham regrets about his work?'}\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      " Paul Graham regrets that he was so consumed by running Y Combinator that it ended up eating away at his other projects, like writing essays and working on Arc.\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(chain.run(\"What is something Paul Graham regrets about his work?\"))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "37c88a27",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new MultiRetrievalQAChain chain...\u001b[0m\n",
+      "personal: {'query': 'What is my background?'}\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      " Your background is Peruvian.\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(chain.run(\"What is my background?\"))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "de8519b2",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new MultiRetrievalQAChain chain...\u001b[0m\n",
+      "None: {'query': 'What year was the Internet created in?'}\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "The Internet was created in the late 1960s by the United States Department of Defense's Advanced Research Projects Agency (ARPA). It was originally called the ARPANET and was used to connect computers at different universities and research institutions. Over time, it evolved into the global network that we know today. So, to answer your question, the Internet was technically created in the late 1960s.\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(chain.run(\"What year was the Internet created in?\"))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e50a0227",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "venv",
+   "language": "python",
+   "name": "venv"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/modules/chains/examples/openapi.ipynb

@@ -7,7 +7,7 @@
    "source": [
     "# OpenAPI Chain\n",
     "\n",
-    "This notebook shows an example of using an OpenAPI chain to call an endpoint in natural language, and get back a response in natural language"
+    "This notebook shows an example of using an OpenAPI chain to call an endpoint in natural language, and get back a response in natural language."
    ]
   },
   {

docs/modules/chains/examples/pal.ipynb

@@ -28,7 +28,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "llm = OpenAI(model_name='code-davinci-002', temperature=0, max_tokens=512)"
+    "llm = OpenAI(temperature=0, max_tokens=512)"
    ]
   },
   {
@@ -63,7 +63,9 @@
    "cell_type": "code",
    "execution_count": 4,
    "id": "3ef64b27",
-   "metadata": {},
+   "metadata": {
+    "scrolled": true
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -71,17 +73,17 @@
      "text": [
       "\n",
       "\n",
-      "\u001B[1m> Entering new PALChain chain...\u001B[0m\n",
-      "\u001B[32;1m\u001B[1;3mdef solution():\n",
+      "\u001b[1m> Entering new PALChain chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mdef solution():\n",
       "    \"\"\"Jan has three times the number of pets as Marcia. Marcia has two more pets than Cindy. If Cindy has four pets, how many total pets do the three have?\"\"\"\n",
       "    cindy_pets = 4\n",
       "    marcia_pets = cindy_pets + 2\n",
       "    jan_pets = marcia_pets * 3\n",
       "    total_pets = cindy_pets + marcia_pets + jan_pets\n",
       "    result = total_pets\n",
-      "    return result\u001B[0m\n",
+      "    return result\u001b[0m\n",
       "\n",
-      "\u001B[1m> Finished chain.\u001B[0m\n"
+      "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     },
     {
@@ -139,8 +141,8 @@
      "text": [
       "\n",
       "\n",
-      "\u001B[1m> Entering new PALChain chain...\u001B[0m\n",
-      "\u001B[32;1m\u001B[1;3m# Put objects into a list to record ordering\n",
+      "\u001b[1m> Entering new PALChain chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3m# Put objects into a list to record ordering\n",
       "objects = []\n",
       "objects += [('booklet', 'blue')] * 2\n",
       "objects += [('booklet', 'purple')] * 2\n",
@@ -151,9 +153,9 @@
       "\n",
       "# Count number of purple objects\n",
       "num_purple = len([object for object in objects if object[1] == 'purple'])\n",
-      "answer = num_purple\u001B[0m\n",
+      "answer = num_purple\u001b[0m\n",
       "\n",
-      "\u001B[1m> Finished PALChain chain.\u001B[0m\n"
+      "\u001b[1m> Finished PALChain chain.\u001b[0m\n"
      ]
     },
     {
@@ -212,8 +214,8 @@
      "text": [
       "\n",
       "\n",
-      "\u001B[1m> Entering new PALChain chain...\u001B[0m\n",
-      "\u001B[32;1m\u001B[1;3m# Put objects into a list to record ordering\n",
+      "\u001b[1m> Entering new PALChain chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3m# Put objects into a list to record ordering\n",
       "objects = []\n",
       "objects += [('booklet', 'blue')] * 2\n",
       "objects += [('booklet', 'purple')] * 2\n",
@@ -224,9 +226,9 @@
       "\n",
       "# Count number of purple objects\n",
       "num_purple = len([object for object in objects if object[1] == 'purple'])\n",
-      "answer = num_purple\u001B[0m\n",
+      "answer = num_purple\u001b[0m\n",
       "\n",
-      "\u001B[1m> Finished chain.\u001B[0m\n"
+      "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     }
    ],
@@ -280,7 +282,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.9.1"
   }
  },
  "nbformat": 4,

docs/modules/chains/examples/sqlite.ipynb

@@ -73,7 +73,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "db_chain = SQLDatabaseChain(llm=llm, database=db, verbose=True)"
+    "db_chain = SQLDatabaseChain.from_llm(llm, db, verbose=True)"
    ]
   },
   {
@@ -175,7 +175,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "db_chain = SQLDatabaseChain(llm=llm, database=db, prompt=PROMPT, verbose=True)"
+    "db_chain = SQLDatabaseChain.from_llm(llm, db, prompt=PROMPT, verbose=True)"
    ]
   },
   {
@@ -230,7 +230,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "db_chain = SQLDatabaseChain(llm=llm, database=db, prompt=PROMPT, verbose=True, return_intermediate_steps=True)"
+    "db_chain = SQLDatabaseChain.from_llm(llm, db, prompt=PROMPT, verbose=True, return_intermediate_steps=True)"
    ]
   },
   {
@@ -285,7 +285,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "db_chain = SQLDatabaseChain(llm=llm, database=db, verbose=True, top_k=3)"
+    "db_chain = SQLDatabaseChain.from_llm(llm, db, verbose=True, top_k=3)"
    ]
   },
   {
@@ -407,7 +407,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "db_chain = SQLDatabaseChain(llm=llm, database=db, verbose=True)"
+    "db_chain = SQLDatabaseChain.from_llm(llm, db, verbose=True)"
    ]
   },
   {
@@ -569,7 +569,7 @@
     }
    ],
    "source": [
-    "db_chain = SQLDatabaseChain(llm=llm, database=db, verbose=True)\n",
+    "db_chain = SQLDatabaseChain.from_llm(llm, db, verbose=True)\n",
     "db_chain.run(\"What are some example tracks by Bach?\")"
    ]
   },
@@ -681,7 +681,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.10"
+   "version": "3.9.1"
   }
  },
  "nbformat": 4,

docs/modules/chains/generic/custom_chain.ipynb

@@ -0,0 +1,199 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "593f7553-7038-498e-96d4-8255e5ce34f0",
+   "metadata": {},
+   "source": [
+    "# Creating a custom Chain\n",
+    "\n",
+    "To implement your own custom chain you can subclass `Chain` and implement the following methods:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "c19c736e-ca74-4726-bb77-0a849bcc2960",
+   "metadata": {
+    "tags": [],
+    "vscode": {
+     "languageId": "python"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "from __future__ import annotations\n",
+    "\n",
+    "from typing import Any, Dict, List, Optional\n",
+    "\n",
+    "from pydantic import Extra\n",
+    "\n",
+    "from langchain.base_language import BaseLanguageModel\n",
+    "from langchain.callbacks.manager import (\n",
+    "    AsyncCallbackManagerForChainRun,\n",
+    "    CallbackManagerForChainRun,\n",
+    ")\n",
+    "from langchain.chains.base import Chain\n",
+    "from langchain.prompts.base import BasePromptTemplate\n",
+    "\n",
+    "\n",
+    "class MyCustomChain(Chain):\n",
+    "    \"\"\"\n",
+    "    An example of a custom chain.\n",
+    "    \"\"\"\n",
+    "\n",
+    "    prompt: BasePromptTemplate\n",
+    "    \"\"\"Prompt object to use.\"\"\"\n",
+    "    llm: BaseLanguageModel\n",
+    "    output_key: str = \"text\"  #: :meta private:\n",
+    "\n",
+    "    class Config:\n",
+    "        \"\"\"Configuration for this pydantic object.\"\"\"\n",
+    "\n",
+    "        extra = Extra.forbid\n",
+    "        arbitrary_types_allowed = True\n",
+    "\n",
+    "    @property\n",
+    "    def input_keys(self) -> List[str]:\n",
+    "        \"\"\"Will be whatever keys the prompt expects.\n",
+    "\n",
+    "        :meta private:\n",
+    "        \"\"\"\n",
+    "        return self.prompt.input_variables\n",
+    "\n",
+    "    @property\n",
+    "    def output_keys(self) -> List[str]:\n",
+    "        \"\"\"Will always return text key.\n",
+    "\n",
+    "        :meta private:\n",
+    "        \"\"\"\n",
+    "        return [self.output_key]\n",
+    "\n",
+    "    def _call(\n",
+    "        self,\n",
+    "        inputs: Dict[str, Any],\n",
+    "        run_manager: Optional[CallbackManagerForChainRun] = None,\n",
+    "    ) -> Dict[str, str]:\n",
+    "        # Your custom chain logic goes here\n",
+    "        # This is just an example that mimics LLMChain\n",
+    "        prompt_value = self.prompt.format_prompt(**inputs)\n",
+    "        \n",
+    "        # Whenever you call a language model, or another chain, you should pass\n",
+    "        # a callback manager to it. This allows the inner run to be tracked by\n",
+    "        # any callbacks that are registered on the outer run.\n",
+    "        # You can always obtain a callback manager for this by calling\n",
+    "        # `run_manager.get_child()` as shown below.\n",
+    "        response = self.llm.generate_prompt(\n",
+    "            [prompt_value],\n",
+    "            callbacks=run_manager.get_child() if run_manager else None\n",
+    "        )\n",
+    "\n",
+    "        # If you want to log something about this run, you can do so by calling\n",
+    "        # methods on the `run_manager`, as shown below. This will trigger any\n",
+    "        # callbacks that are registered for that event.\n",
+    "        if run_manager:\n",
+    "            run_manager.on_text(\"Log something about this run\")\n",
+    "        \n",
+    "        return {self.output_key: response.generations[0][0].text}\n",
+    "\n",
+    "    async def _acall(\n",
+    "        self,\n",
+    "        inputs: Dict[str, Any],\n",
+    "        run_manager: Optional[AsyncCallbackManagerForChainRun] = None,\n",
+    "    ) -> Dict[str, str]:\n",
+    "        # Your custom chain logic goes here\n",
+    "        # This is just an example that mimics LLMChain\n",
+    "        prompt_value = self.prompt.format_prompt(**inputs)\n",
+    "        \n",
+    "        # Whenever you call a language model, or another chain, you should pass\n",
+    "        # a callback manager to it. This allows the inner run to be tracked by\n",
+    "        # any callbacks that are registered on the outer run.\n",
+    "        # You can always obtain a callback manager for this by calling\n",
+    "        # `run_manager.get_child()` as shown below.\n",
+    "        response = await self.llm.agenerate_prompt(\n",
+    "            [prompt_value],\n",
+    "            callbacks=run_manager.get_child() if run_manager else None\n",
+    "        )\n",
+    "\n",
+    "        # If you want to log something about this run, you can do so by calling\n",
+    "        # methods on the `run_manager`, as shown below. This will trigger any\n",
+    "        # callbacks that are registered for that event.\n",
+    "        if run_manager:\n",
+    "            await run_manager.on_text(\"Log something about this run\")\n",
+    "        \n",
+    "        return {self.output_key: response.generations[0][0].text}\n",
+    "\n",
+    "    @property\n",
+    "    def _chain_type(self) -> str:\n",
+    "        return \"my_custom_chain\"\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "id": "18361f89",
+   "metadata": {
+    "vscode": {
+     "languageId": "python"
+    }
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new MyCustomChain chain...\u001b[0m\n",
+      "Log something about this run\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'Why did the callback function feel lonely? Because it was always waiting for someone to call it back!'"
+      ]
+     },
+     "execution_count": 12,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from langchain.callbacks.stdout import StdOutCallbackHandler\n",
+    "from langchain.chat_models.openai import ChatOpenAI\n",
+    "from langchain.prompts.prompt import PromptTemplate\n",
+    "\n",
+    "\n",
+    "chain = MyCustomChain(\n",
+    "    prompt=PromptTemplate.from_template('tell us a joke about {topic}'),\n",
+    "    llm=ChatOpenAI()\n",
+    ")\n",
+    "\n",
+    "chain.run({'topic': 'callbacks'}, callbacks=[StdOutCallbackHandler()])"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/modules/chains/generic/llm_chain.ipynb

@@ -2,59 +2,90 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "id": "d8a5c5d4",
+   "id": "da7d0df7-f07c-462f-bd46-d0426f11f311",
    "metadata": {},
    "source": [
-    "# LLM Chain\n",
-    "\n",
-    "This notebook showcases a simple LLM chain."
+    "## LLM Chain"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3a55e9a1-becf-4357-889e-f365d23362ff",
+   "metadata": {},
+   "source": [
+    "`LLMChain` is perhaps one of the most popular ways of querying an LLM object. It formats the prompt template using the input key values provided (and also memory key values, if available), passes the formatted string to LLM and returns the LLM output. Below we show additional functionalities of `LLMChain` class."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "835e6978",
-   "metadata": {},
-   "outputs": [],
+   "id": "0e720e34-a0f0-4f1a-9732-43bc1460053a",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'product': 'colorful socks', 'text': '\\n\\nSocktastic!'}"
+      ]
+     },
+     "execution_count": 1,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
-    "from langchain import PromptTemplate, OpenAI, LLMChain"
+    "from langchain import PromptTemplate, OpenAI, LLMChain\n",
+    "\n",
+    "prompt_template = \"What is a good name for a company that makes {product}?\"\n",
+    "\n",
+    "llm = OpenAI(temperature=0)\n",
+    "llm_chain = LLMChain(\n",
+    "    llm=llm,\n",
+    "    prompt=PromptTemplate.from_template(prompt_template)\n",
+    ")\n",
+    "llm_chain(\"colorful socks\")"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "06bcb078",
+   "id": "94304332-6398-4280-a61e-005ba29b5e1e",
    "metadata": {},
    "source": [
-    "## Single Input\n",
-    "\n",
-    "First, lets go over an example using a single input"
+    "## Additional ways of running LLM Chain"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "4e51981f-cde9-4c05-99e1-446c27994e99",
+   "metadata": {},
+   "source": [
+    "Aside from `__call__` and `run` methods shared by all `Chain` object (see [Getting Started](../getting_started.ipynb) to learn more), `LLMChain` offers a few more ways of calling the chain logic:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "c08d2356-412d-4327-b8a0-233dcc443e30",
+   "metadata": {},
+   "source": [
+    "- `apply` allows you run the chain against a list of inputs:"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 2,
-   "id": "51a54c4d",
-   "metadata": {},
+   "id": "cf519eb6-2358-4db7-a28a-27433435181e",
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001B[1m> Entering new LLMChain chain...\u001B[0m\n",
-      "Prompt after formatting:\n",
-      "\u001B[32;1m\u001B[1;3mQuestion: What NFL team won the Super Bowl in the year Justin Beiber was born?\n",
-      "\n",
-      "Answer: Let's think step by step.\u001B[0m\n",
-      "\n",
-      "\u001B[1m> Finished LLMChain chain.\u001B[0m\n"
-     ]
-    },
     {
      "data": {
       "text/plain": [
-       "' Justin Bieber was born in 1994, so the NFL team that won the Super Bowl in 1994 was the Dallas Cowboys.'"
+       "[{'text': '\\n\\nSocktastic!'},\n",
+       " {'text': '\\n\\nTechCore Solutions.'},\n",
+       " {'text': '\\n\\nFootwear Factory.'}]"
       ]
      },
      "execution_count": 2,
@@ -63,49 +94,37 @@
     }
    ],
    "source": [
-    "template = \"\"\"Question: {question}\n",
+    "input_list = [\n",
+    "    {\"product\": \"socks\"},\n",
+    "    {\"product\": \"computer\"},\n",
+    "    {\"product\": \"shoes\"}\n",
+    "]\n",
     "\n",
-    "Answer: Let's think step by step.\"\"\"\n",
-    "prompt = PromptTemplate(template=template, input_variables=[\"question\"])\n",
-    "llm_chain = LLMChain(prompt=prompt, llm=OpenAI(temperature=0), verbose=True)\n",
-    "\n",
-    "question = \"What NFL team won the Super Bowl in the year Justin Beiber was born?\"\n",
-    "\n",
-    "llm_chain.predict(question=question)"
+    "llm_chain.apply(input_list)"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "79c3ec4d",
-   "metadata": {},
+   "id": "add442fb-baf6-40d9-ae8e-4ac1d8251ad0",
+   "metadata": {
+    "tags": []
+   },
    "source": [
-    "## Multiple Inputs\n",
-    "Now lets go over an example using multiple inputs."
+    "- `generate` is similar to `apply`, except it return an `LLMResult` instead of string. `LLMResult` often contains useful generation such as token usages and finish reason."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 3,
-   "id": "03dd6918",
-   "metadata": {},
+   "id": "85cbff83-a5cc-40b7-823c-47274ae4117d",
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001B[1m> Entering new LLMChain chain...\u001B[0m\n",
-      "Prompt after formatting:\n",
-      "\u001B[32;1m\u001B[1;3mWrite a sad poem about ducks.\u001B[0m\n",
-      "\n",
-      "\u001B[1m> Finished LLMChain chain.\u001B[0m\n"
-     ]
-    },
     {
      "data": {
       "text/plain": [
-       "\"\\n\\nThe ducks swim in the pond,\\nTheir feathers so soft and warm,\\nBut they can't help but feel so forlorn.\\n\\nTheir quacks echo in the air,\\nBut no one is there to hear,\\nFor they have no one to share.\\n\\nThe ducks paddle around in circles,\\nTheir heads hung low in despair,\\nFor they have no one to care.\\n\\nThe ducks look up to the sky,\\nBut no one is there to see,\\nFor they have no one to be.\\n\\nThe ducks drift away in the night,\\nTheir hearts filled with sorrow and pain,\\nFor they have no one to gain.\""
+       "LLMResult(generations=[[Generation(text='\\n\\nSocktastic!', generation_info={'finish_reason': 'stop', 'logprobs': None})], [Generation(text='\\n\\nTechCore Solutions.', generation_info={'finish_reason': 'stop', 'logprobs': None})], [Generation(text='\\n\\nFootwear Factory.', generation_info={'finish_reason': 'stop', 'logprobs': None})]], llm_output={'token_usage': {'prompt_tokens': 36, 'total_tokens': 55, 'completion_tokens': 19}, 'model_name': 'text-davinci-003'})"
       ]
      },
      "execution_count": 3,
@@ -114,46 +133,200 @@
     }
    ],
    "source": [
-    "template = \"\"\"Write a {adjective} poem about {subject}.\"\"\"\n",
+    "llm_chain.generate(input_list)"
+   ]
+  },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "id": "a178173b-b183-432a-a517-250fe3191173",
+   "metadata": {},
+   "source": [
+    "- `predict` is similar to `run` method except that the input keys are specified as keyword arguments instead of a Python dict."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "id": "787d9f55-b080-4123-bed2-0598a9cb0466",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'\\n\\nSocktastic!'"
+      ]
+     },
+     "execution_count": 12,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# Single input example\n",
+    "llm_chain.predict(product=\"colorful socks\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 14,
+   "id": "092a769f-9661-42a0-9da1-19d09ccbc4a7",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'\\n\\nQ: What did the duck say when his friend died?\\nA: Quack, quack, goodbye.'"
+      ]
+     },
+     "execution_count": 14,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# Multiple inputs example\n",
+    "\n",
+    "template = \"\"\"Tell me a {adjective} joke about {subject}.\"\"\"\n",
     "prompt = PromptTemplate(template=template, input_variables=[\"adjective\", \"subject\"])\n",
-    "llm_chain = LLMChain(prompt=prompt, llm=OpenAI(temperature=0), verbose=True)\n",
+    "llm_chain = LLMChain(prompt=prompt, llm=OpenAI(temperature=0))\n",
     "\n",
     "llm_chain.predict(adjective=\"sad\", subject=\"ducks\")"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "672f59d4",
+   "id": "4b72ad22-0a5d-4ca7-9e3f-8c46dc17f722",
+   "metadata": {},
+   "source": [
+    "## Parsing the outputs"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "85a77662-d028-4048-be4b-aa496e2dde22",
+   "metadata": {},
+   "source": [
+    "By default, `LLMChain` does not parse the output even if the underlying `prompt` object has an output parser. If you would like to apply that output parser on the LLM output, use `predict_and_parse` instead of `predict` and `apply_and_parse` instead of `apply`. "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b83977f1-847c-45de-b840-f1aff6725f83",
+   "metadata": {},
+   "source": [
+    "With `predict`:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 24,
+   "id": "5feb5177-c20b-4909-890b-a64d7e551f55",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'\\n\\nRed, orange, yellow, green, blue, indigo, violet'"
+      ]
+     },
+     "execution_count": 24,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from langchain.output_parsers import CommaSeparatedListOutputParser\n",
+    "\n",
+    "output_parser = CommaSeparatedListOutputParser()\n",
+    "template = \"\"\"List all the colors in a rainbow\"\"\"\n",
+    "prompt = PromptTemplate(template=template, input_variables=[], output_parser=output_parser)\n",
+    "llm_chain = LLMChain(prompt=prompt, llm=llm)\n",
+    "\n",
+    "llm_chain.predict()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "7b931615-804b-4f34-8086-7bbc2f96b3b2",
+   "metadata": {},
+   "source": [
+    "With `predict_and_parser`:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 25,
+   "id": "43a374cd-a179-43e5-9aa0-62f3cbdf510d",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['Red', 'orange', 'yellow', 'green', 'blue', 'indigo', 'violet']"
+      ]
+     },
+     "execution_count": 25,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llm_chain.predict_and_parse()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8176f619-4e5c-4a02-91ba-e96ebe2aabda",
+   "metadata": {},
+   "source": [
+    "## Initialize from string"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9813ac87-e118-413b-b448-2fefdf2319b8",
    "metadata": {},
    "source": [
-    "## From string\n",
     "You can also construct an LLMChain from a string template directly."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
-   "id": "f8bc262e",
-   "metadata": {},
+   "execution_count": 16,
+   "id": "ca88ccb1-974e-41c1-81ce-753e3f1234fa",
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
-    "template = \"\"\"Write a {adjective} poem about {subject}.\"\"\"\n",
-    "llm_chain = LLMChain.from_string(llm=OpenAI(temperature=0), template=template)\n"
+    "template = \"\"\"Tell me a {adjective} joke about {subject}.\"\"\"\n",
+    "llm_chain = LLMChain.from_string(llm=llm, template=template)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
-   "id": "cb164a76",
-   "metadata": {},
+   "execution_count": 18,
+   "id": "4703d1bc-f4fc-44bc-9ea1-b4498835833d",
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "\"\\n\\nThe ducks swim in the pond,\\nTheir feathers so soft and warm,\\nBut they can't help but feel so forlorn.\\n\\nTheir quacks echo in the air,\\nBut no one is there to hear,\\nFor they have no one to share.\\n\\nThe ducks paddle around in circles,\\nTheir heads hung low in despair,\\nFor they have no one to care.\\n\\nThe ducks look up to the sky,\\nBut no one is there to see,\\nFor they have no one to be.\\n\\nThe ducks drift away in the night,\\nTheir hearts filled with sorrow and pain,\\nFor they have no one to gain.\""
+       "'\\n\\nQ: What did the duck say when his friend died?\\nA: Quack, quack, goodbye.'"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 18,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -161,14 +334,6 @@
    "source": [
     "llm_chain.predict(adjective=\"sad\", subject=\"ducks\")"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9f0adbc7",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
@@ -187,7 +352,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.10.10"
   }
  },
  "nbformat": 4,

docs/modules/chains/getting_started.ipynb

@@ -22,10 +22,11 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Query an LLM with the `LLMChain`\n",
+    "## Quick start: Using `LLMChain`\n",
     "\n",
     "The `LLMChain` is a simple chain that takes in a prompt template, formats it with the user input and returns the response from an LLM.\n",
     "\n",
+    "\n",
     "To use the `LLMChain`, first create a prompt template."
    ]
   },
@@ -67,7 +68,7 @@
      "text": [
       "\n",
       "\n",
-      "Rainbow Socks Co.\n"
+      "SockSplash!\n"
      ]
     }
    ],
@@ -88,7 +89,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 3,
    "metadata": {
     "tags": []
    },
@@ -97,9 +98,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\n",
-      "\n",
-      "Rainbow Threads\n"
+      "Rainbow Sox Co.\n"
      ]
     }
    ],
@@ -125,7 +124,252 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "This is one of the simpler types of chains, but understanding how it works will set you up well for working with more complex chains."
+    "## Different ways of calling chains\n",
+    "\n",
+    "All classes inherited from `Chain` offer a few ways of running chain logic. The most direct one is by using `__call__`:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'adjective': 'corny',\n",
+       " 'text': 'Why did the tomato turn red? Because it saw the salad dressing!'}"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chat = ChatOpenAI(temperature=0)\n",
+    "prompt_template = \"Tell me a {adjective} joke\"\n",
+    "llm_chain = LLMChain(\n",
+    "    llm=chat,\n",
+    "    prompt=PromptTemplate.from_template(prompt_template)\n",
+    ")\n",
+    "\n",
+    "llm_chain(inputs={\"adjective\":\"corny\"})"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "By default, `__call__` returns both the input and output key values. You can configure it to only return output key values by setting `return_only_outputs` to `True`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'text': 'Why did the tomato turn red? Because it saw the salad dressing!'}"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llm_chain(\"corny\", return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "If the `Chain` only outputs one output key (i.e. only has one element in its `output_keys`), you can  use `run` method. Note that `run` outputs a string instead of a dictionary."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['text']"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# llm_chain only has one output key, so we can use run\n",
+    "llm_chain.output_keys"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Why did the tomato turn red? Because it saw the salad dressing!'"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llm_chain.run({\"adjective\":\"corny\"})"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "In the case of one input key, you can input the string directly without specifying the input mapping."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'adjective': 'corny',\n",
+       " 'text': 'Why did the tomato turn red? Because it saw the salad dressing!'}"
+      ]
+     },
+     "execution_count": 8,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# These two are equivalent\n",
+    "llm_chain.run({\"adjective\":\"corny\"})\n",
+    "llm_chain.run(\"corny\")\n",
+    "\n",
+    "# These two are also equivalent\n",
+    "llm_chain(\"corny\")\n",
+    "llm_chain({\"adjective\":\"corny\"})"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Tips: You can easily integrate a `Chain` object as a `Tool` in your `Agent` via its `run` method. See an example [here](../agents/tools/custom_tools.ipynb)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Add memory to chains\n",
+    "\n",
+    "`Chain` supports taking a `BaseMemory` object as its `memory` argument, allowing `Chain` object to persist data across multiple calls. In other words, it makes `Chain` a stateful object."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'The next four colors of a rainbow are green, blue, indigo, and violet.'"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from langchain.chains import ConversationChain\n",
+    "from langchain.memory import ConversationBufferMemory\n",
+    "\n",
+    "conversation = ConversationChain(\n",
+    "    llm=chat,\n",
+    "    memory=ConversationBufferMemory()\n",
+    ")\n",
+    "\n",
+    "conversation.run(\"Answer briefly. What are the first 3 colors of a rainbow?\")\n",
+    "# -> The first three colors of a rainbow are red, orange, and yellow.\n",
+    "conversation.run(\"And the next 4?\")\n",
+    "# -> The next four colors of a rainbow are green, blue, indigo, and violet."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Essentially, `BaseMemory` defines an interface of how `langchain` stores memory. It allows reading of stored data through `load_memory_variables` method and storing new data through `save_context` method. You can learn more about it in [Memory](../memory/getting_started.ipynb) section."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Debug Chain\n",
+    "\n",
+    "It can be hard to debug `Chain` object solely from its output as most `Chain` objects involve a fair amount of input prompt preprocessing and LLM output post-processing. Setting `verbose` to `True` will print out some internal states of the `Chain` object while it is being ran."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new ConversationChain chain...\u001b[0m\n",
+      "Prompt after formatting:\n",
+      "\u001b[32;1m\u001b[1;3mThe following is a friendly conversation between a human and an AI. The AI is talkative and provides lots of specific details from its context. If the AI does not know the answer to a question, it truthfully says it does not know.\n",
+      "\n",
+      "Current conversation:\n",
+      "\n",
+      "Human: What is ChatGPT?\n",
+      "AI:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'ChatGPT is an AI language model developed by OpenAI. It is based on the GPT-3 architecture and is capable of generating human-like responses to text prompts. ChatGPT has been trained on a massive amount of text data and can understand and respond to a wide range of topics. It is often used for chatbots, virtual assistants, and other conversational AI applications.'"
+      ]
+     },
+     "execution_count": 10,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "conversation = ConversationChain(\n",
+    "    llm=chat,\n",
+    "    memory=ConversationBufferMemory(),\n",
+    "    verbose=True\n",
+    ")\n",
+    "conversation.run(\"What is ChatGPT?\")"
    ]
   },
   {
@@ -143,7 +387,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 11,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -163,7 +407,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 12,
    "metadata": {},
    "outputs": [
     {
@@ -173,17 +417,15 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new SimpleSequentialChain chain...\u001b[0m\n",
-      "\u001b[36;1m\u001b[1;3m\n",
-      "\n",
-      "Cheerful Toes.\u001b[0m\n",
+      "\u001b[36;1m\u001b[1;3mRainbow Socks Co.\u001b[0m\n",
       "\u001b[33;1m\u001b[1;3m\n",
       "\n",
-      "\"Spread smiles from your toes!\"\u001b[0m\n",
+      "\"Step into Color with Rainbow Socks!\"\u001b[0m\n",
       "\n",
-      "\u001b[1m> Finished SimpleSequentialChain chain.\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
       "\n",
       "\n",
-      "\"Spread smiles from your toes!\"\n"
+      "\"Step into Color with Rainbow Socks!\"\n"
      ]
     }
    ],
@@ -214,7 +456,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 13,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -248,12 +490,13 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Now, we can try running the chain that we called."
+    "Now, we can try running the chain that we called.\n",
+    "\n"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 14,
    "metadata": {},
    "outputs": [
     {
@@ -263,9 +506,9 @@
       "Concatenated output:\n",
       "\n",
       "\n",
-      "Rainbow Socks Co.\n",
+      "Socktastic Colors.\n",
       "\n",
-      "\"Step Into Colorful Comfort!\"\n"
+      "\"Put Some Color in Your Step!\"\n"
      ]
     }
    ],
@@ -311,7 +554,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.10.6"
   },
   "vscode": {
    "interpreter": {

docs/modules/chains/index_examples/chat_vector_db.ipynb

@@ -12,7 +12,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 1,
    "id": "70c4e529",
    "metadata": {
     "tags": []
@@ -36,7 +36,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 2,
    "id": "01c46e92",
    "metadata": {
     "tags": []
@@ -58,7 +58,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 3,
    "id": "433363a5",
    "metadata": {
     "tags": []
@@ -81,18 +81,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 4,
    "id": "a8930cf7",
    "metadata": {
     "tags": []
    },
    "outputs": [
     {
-     "name": "stdout",
+     "name": "stderr",
      "output_type": "stream",
      "text": [
-      "Running Chroma using direct local API.\n",
-      "Using DuckDB in-memory for database. Data will be transient.\n"
+      "Using embedded DuckDB without persistence: data will be transient\n"
      ]
     }
    ],
@@ -104,6 +103,25 @@
     "vectorstore = Chroma.from_documents(documents, embeddings)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "898b574b",
+   "metadata": {},
+   "source": [
+    "We can now create a memory object, which is neccessary to track the inputs/outputs and hold a conversation."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 20,
+   "id": "af803fee",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.memory import ConversationBufferMemory\n",
+    "memory = ConversationBufferMemory(memory_key=\"chat_history\", return_messages=True)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "3c96b118",
@@ -114,12 +132,96 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 21,
    "id": "7b4110f3",
    "metadata": {
     "tags": []
    },
    "outputs": [],
+   "source": [
+    "qa = ConversationalRetrievalChain.from_llm(OpenAI(temperature=0), vectorstore.as_retriever(), memory=memory)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 22,
+   "id": "e8ce4fe9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "query = \"What did the president say about Ketanji Brown Jackson\"\n",
+    "result = qa({\"question\": query})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 23,
+   "id": "4c79862b",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "\" The president said that Ketanji Brown Jackson is one of the nation's top legal minds, a former top litigator in private practice, a former federal public defender, and from a family of public school educators and police officers. He also said that she is a consensus builder and has received a broad range of support from the Fraternal Order of Police to former judges appointed by Democrats and Republicans.\""
+      ]
+     },
+     "execution_count": 23,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "result[\"answer\"]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 24,
+   "id": "c697d9d1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "query = \"Did he mention who she suceeded\"\n",
+    "result = qa({\"question\": query})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 25,
+   "id": "ba0678f3",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "' Ketanji Brown Jackson succeeded Justice Stephen Breyer on the United States Supreme Court.'"
+      ]
+     },
+     "execution_count": 25,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "result['answer']"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "84426220",
+   "metadata": {},
+   "source": [
+    "## Pass in chat history\n",
+    "\n",
+    "In the above example, we used a Memory object to track chat history. We can also just pass it in explicitly. In order to do this, we need to initialize a chain without any memory object."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 26,
+   "id": "676b8a36",
+   "metadata": {},
+   "outputs": [],
    "source": [
     "qa = ConversationalRetrievalChain.from_llm(OpenAI(temperature=0), vectorstore.as_retriever())"
    ]
@@ -134,7 +236,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 6,
    "id": "7fe3e730",
    "metadata": {
     "tags": []
@@ -148,7 +250,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 7,
    "id": "bfff9cc8",
    "metadata": {
     "tags": []
@@ -160,7 +262,7 @@
        "\" The president said that Ketanji Brown Jackson is one of the nation's top legal minds, a former top litigator in private practice, a former federal public defender, and from a family of public school educators and police officers. He also said that she is a consensus builder and has received a broad range of support from the Fraternal Order of Police to former judges appointed by Democrats and Republicans.\""
       ]
      },
-     "execution_count": 9,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -179,7 +281,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 8,
    "id": "00b4cf00",
    "metadata": {
     "tags": []
@@ -193,7 +295,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 9,
    "id": "f01828d1",
    "metadata": {
     "tags": []
@@ -205,7 +307,7 @@
        "' Ketanji Brown Jackson succeeded Justice Stephen Breyer on the United States Supreme Court.'"
       ]
      },
-     "execution_count": 11,
+     "execution_count": 9,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -487,7 +589,6 @@
    "outputs": [],
    "source": [
     "from langchain.chains.llm import LLMChain\n",
-    "from langchain.callbacks.base import CallbackManager\n",
     "from langchain.callbacks.streaming_stdout import StreamingStdOutCallbackHandler\n",
     "from langchain.chains.conversational_retrieval.prompts import CONDENSE_QUESTION_PROMPT, QA_PROMPT\n",
     "from langchain.chains.question_answering import load_qa_chain\n",
@@ -495,7 +596,7 @@
     "# Construct a ConversationalRetrievalChain with a streaming llm for combine docs\n",
     "# and a separate, non-streaming llm for question generation\n",
     "llm = OpenAI(temperature=0)\n",
-    "streaming_llm = OpenAI(streaming=True, callback_manager=CallbackManager([StreamingStdOutCallbackHandler()]), verbose=True, temperature=0)\n",
+    "streaming_llm = OpenAI(streaming=True, callbacks=[StreamingStdOutCallbackHandler()], temperature=0)\n",
     "\n",
     "question_generator = LLMChain(llm=llm, prompt=CONDENSE_QUESTION_PROMPT)\n",
     "doc_chain = load_qa_chain(streaming_llm, chain_type=\"stuff\", prompt=QA_PROMPT)\n",
@@ -636,7 +737,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.9.1"
   }
  },
  "nbformat": 4,

docs/modules/chains/index_examples/qa_with_sources.ipynb

@@ -7,7 +7,7 @@
    "source": [
     "# Question Answering with Sources\n",
     "\n",
-    "This notebook walks through how to use LangChain for question answering with sources over a list of documents. It covers four different chain types: `stuff`, `map_reduce`, `refine`,`map-rerank`. For a more in depth explanation of what these chain types are, see [here](../combine_docs.md)."
+    "This notebook walks through how to use LangChain for question answering with sources over a list of documents. It covers four different chain types: `stuff`, `map_reduce`, `refine`,`map-rerank`. For a more in depth explanation of what these chain types are, see [here](https://docs.langchain.com/docs/components/chains/index_related_chains)."
    ]
   },
   {
@@ -267,7 +267,7 @@
    "source": [
     "**Intermediate Steps**\n",
     "\n",
-    "We can also return the intermediate steps for `map_reduce` chains, should we want to inspect them. This is done with the `return_map_steps` variable."
+    "We can also return the intermediate steps for `map_reduce` chains, should we want to inspect them. This is done with the `return_intermediate_steps` variable."
    ]
   },
   {

docs/modules/chains/index_examples/question_answering.ipynb

@@ -7,7 +7,7 @@
    "source": [
     "# Question Answering\n",
     "\n",
-    "This notebook walks through how to use LangChain for question answering over a list of documents. It covers four different types of chains: `stuff`, `map_reduce`, `refine`, `map_rerank`. For a more in depth explanation of what these chain types are, see [here](../combine_docs.md)."
+    "This notebook walks through how to use LangChain for question answering over a list of documents. It covers four different types of chains: `stuff`, `map_reduce`, `refine`, `map_rerank`. For a more in depth explanation of what these chain types are, see [here](https://docs.langchain.com/docs/components/chains/index_related_chains)."
    ]
   },
   {

docs/modules/indexes/document_loaders/examples/CoNLL-U.ipynb

@@ -11,9 +11,11 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "id": "d9b2e33e",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "from langchain.document_loaders import CoNLLULoader"
@@ -21,9 +23,11 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
    "id": "5b5eec48",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "loader = CoNLLULoader(\"example_data/conllu.conllu\")"
@@ -31,9 +35,11 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 3,
    "id": "10f3f725",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "document = loader.load()"
@@ -41,10 +47,23 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 4,
    "id": "acbb3579",
-   "metadata": {},
-   "outputs": [],
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Document(page_content='They buy and sell books.', metadata={'source': 'example_data/conllu.conllu'})]"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
    "source": [
     "document"
    ]
@@ -52,7 +71,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -66,7 +85,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.10.6"
   },
   "toc": {
    "base_numbering": 1,

docs/modules/indexes/document_loaders/examples/airbyte_json.ipynb

@@ -5,7 +5,22 @@
    "id": "1f3a5ebf",
    "metadata": {},
    "source": [
-    "# Airbyte JSON\n",
+    "# Airbyte JSON"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "35ac77b1-449b-44f7-b8f3-3494d55c286e",
+   "metadata": {},
+   "source": [
+    ">[Airbyte](https://github.com/airbytehq/airbyte) is a data integration platform for ELT pipelines from APIs, databases & files to warehouses & lakes. It has the largest catalog of ELT connectors to data warehouses and databases."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1fe72234-3110-4c07-a766-3dc505dd25cc",
+   "metadata": {},
+   "source": [
     "This covers how to load any source from Airbyte into a local JSON file that can be read in as a document\n",
     "\n",
     "Prereqs:\n",
@@ -25,7 +40,7 @@
     "\n",
     "6) Set destination as Local JSON, with specified destination path - lets say `/json_data`. Set up manual sync.\n",
     "\n",
-    "7) Run the connection!\n",
+    "7) Run the connection.\n",
     "\n",
     "7) To see what files are create, you can navigate to: `file:///tmp/airbyte_local`\n",
     "\n",
@@ -52,7 +67,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "_airbyte_raw_pokemon.jsonl\r\n"
+      "_airbyte_raw_pokemon.jsonl\n"
      ]
     }
    ],

docs/modules/indexes/document_loaders/examples/apify_dataset.ipynb

@@ -1,15 +1,15 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "# Apify Dataset\n",
     "\n",
+    ">[Apify Dataset](https://docs.apify.com/platform/storage/dataset) is a scaleable append-only storage with sequential access built for storing structured web scraping results, such as a list of products or Google SERPs, and then export them to various formats like JSON, CSV, or Excel. Datasets are mainly used to save results of [Apify Actors](https://apify.com/store)—serverless cloud programs for varius web scraping, crawling, and data extraction use cases.\n",
+    "\n",
     "This notebook shows how to load Apify datasets to LangChain.\n",
     "\n",
-    "[Apify Dataset](https://docs.apify.com/platform/storage/dataset) is a scaleable append-only storage with sequential access built for storing structured web scraping results, such as a list of products or Google SERPs, and then export them to various formats like JSON, CSV, or Excel. Datasets are mainly used to save results of [Apify Actors](https://apify.com/store)—serverless cloud programs for varius web scraping, crawling, and data extraction use cases.\n",
     "\n",
     "## Prerequisites\n",
     "\n",
@@ -17,7 +17,17 @@
    ]
   },
   {
-   "attachments": {},
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "#!pip install apify-client"
+   ]
+  },
+  {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -35,7 +45,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -77,7 +86,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -167,9 +175,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/modules/indexes/document_loaders/examples/arxiv.ipynb

@@ -0,0 +1,176 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "bda1f3f5",
+   "metadata": {},
+   "source": [
+    "# Arxiv\n",
+    "\n",
+    ">[arXiv](https://arxiv.org/) is an open-access archive for 2 million scholarly articles in the fields of physics, mathematics, computer science, quantitative biology, quantitative finance, statistics, electrical engineering and systems science, and economics.\n",
+    "\n",
+    "This notebook shows how to load scientific articles from `Arxiv.org` into a document format that we can use downstream."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1b7a1eef-7bf7-4e7d-8bfc-c4e27c9488cb",
+   "metadata": {},
+   "source": [
+    "## Installation"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "2abd5578-aa3d-46b9-99af-8b262f0b3df8",
+   "metadata": {},
+   "source": [
+    "First, you need to install `arxiv` python package."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b674aaea-ed3a-4541-8414-260a8f67f623",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "#!pip install arxiv"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "094b5f13-7e54-4354-9d83-26d6926ecaa0",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "Second, you need to install `PyMuPDF` python package which transform PDF files from the `arxiv.org` site into the text format."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "7cd91121-2e96-43ba-af50-319853695f86",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "#!pip install pymupdf"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "95f05e1c-195e-4e2b-ae8e-8d6637f15be6",
+   "metadata": {},
+   "source": [
+    "## Examples"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e29b954c-1407-4797-ae21-6ba8937156be",
+   "metadata": {},
+   "source": [
+    "`ArxivLoader` has these arguments:\n",
+    "- `query`: free text which used to find documents in the Arxiv\n",
+    "- optional `load_max_docs`: default=100. Use it to limit number of downloaded documents. It takes time to download all 100 documents, so use a small number for experiments.\n",
+    "- optional `load_all_available_meta`: default=False. By default only the most important fields downloaded: `Published` (date when document was published/last updated), `Title`, `Authors`, `Summary`. If True, other fields also downloaded."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "9bfd5e46",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.document_loaders import ArxivLoader"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "700e4ef2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "docs = ArxivLoader(query=\"1605.08386\", load_max_docs=2).load()\n",
+    "len(docs)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "8977bac0-0042-4f23-9754-247dbd32439b",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'Published': '2016-05-26',\n",
+       " 'Title': 'Heat-bath random walks with Markov bases',\n",
+       " 'Authors': 'Caprice Stanley, Tobias Windisch',\n",
+       " 'Summary': 'Graphs on lattice points are studied whose edges come from a finite set of\\nallowed moves of arbitrary length. We show that the diameter of these graphs on\\nfibers of a fixed integer matrix can be bounded from above by a constant. We\\nthen study the mixing behaviour of heat-bath random walks on these graphs. We\\nalso state explicit conditions on the set of moves so that the heat-bath random\\nwalk, a generalization of the Glauber dynamics, is an expander in fixed\\ndimension.'}"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "docs[0].metadata  # meta-information of the Document"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "46969806-45a9-4c4d-a61b-cfb9658fc9de",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'arXiv:1605.08386v1  [math.CO]  26 May 2016\\nHEAT-BATH RANDOM WALKS WITH MARKOV BASES\\nCAPRICE STANLEY AND TOBIAS WINDISCH\\nAbstract. Graphs on lattice points are studied whose edges come from a finite set of\\nallowed moves of arbitrary length. We show that the diameter of these graphs on fibers of a\\nfixed integer matrix can be bounded from above by a constant. We then study the mixing\\nbehaviour of heat-b'"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "docs[0].page_content[:400]  # all pages of the Document content\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/modules/indexes/document_loaders/examples/azlyrics.ipynb

@@ -6,6 +6,9 @@
    "metadata": {},
    "source": [
     "# AZLyrics\n",
+    "\n",
+    ">[AZLyrics](https://www.azlyrics.com/) is a large, legal, every day growing collection of lyrics.\n",
+    "\n",
     "This covers how to load AZLyrics webpages into a document format that we can use downstream."
    ]
   },
@@ -85,7 +88,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.1"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/azure_blob_storage_container.ipynb

@@ -1,29 +1,28 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "a634365e",
    "metadata": {},
    "source": [
     "# Azure Blob Storage Container\n",
     "\n",
-    "This covers how to load document objects from a container on Azure Blob Storage."
+    ">[Azure Blob Storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction) is Microsoft's object storage solution for the cloud. Blob Storage is optimized for storing massive amounts of unstructured data. Unstructured data is data that doesn't adhere to a particular data model or definition, such as text or binary data.\n",
+    "\n",
+    "`Azure Blob Storage` is designed for:\n",
+    "- Serving images or documents directly to a browser.\n",
+    "- Storing files for distributed access.\n",
+    "- Streaming video and audio.\n",
+    "- Writing to log files.\n",
+    "- Storing data for backup and restore, disaster recovery, and archiving.\n",
+    "- Storing data for analysis by an on-premises or Azure-hosted service.\n",
+    "\n",
+    "This notebook covers how to load document objects from a container on `Azure Blob Storage`."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
-   "id": "2f0cd6a5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.document_loaders import AzureBlobStorageContainerLoader"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "id": "49815096",
    "metadata": {},
    "outputs": [],
@@ -31,6 +30,18 @@
     "#!pip install azure-storage-blob"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "2f0cd6a5",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.document_loaders import AzureBlobStorageContainerLoader"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 3,
@@ -127,7 +138,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/azure_blob_storage_file.ipynb

@@ -1,14 +1,27 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "66a7777e",
    "metadata": {},
    "source": [
     "# Azure Blob Storage File\n",
     "\n",
-    "This covers how to load document objects from a Azure Blob Storage file."
+    ">[Azure Files](https://learn.microsoft.com/en-us/azure/storage/files/storage-files-introduction) offers fully managed file shares in the cloud that are accessible via the industry standard Server Message Block (`SMB`) protocol, Network File System (`NFS`) protocol, and `Azure Files REST API`.\n",
+    "\n",
+    "This covers how to load document objects from a Azure Files."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "43128d8d",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "#!pip install azure-storage-blob"
    ]
   },
   {
@@ -21,16 +34,6 @@
     "from langchain.document_loaders import AzureBlobStorageFileLoader"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "43128d8d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "#!pip install azure-storage-blob"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 8,
@@ -87,7 +90,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/bigquery.ipynb

@@ -4,15 +4,31 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# BigQuery Loader\n",
+    "# BigQuery\n",
     "\n",
-    "Load a BigQuery query with one document per row."
+    ">[BigQuery](https://cloud.google.com/bigquery) is a serverless and cost-effective enterprise data warehouse that works across clouds and scales with your data.\n",
+    "`BigQuery` is a part of the `Google Cloud Platform`.\n",
+    "\n",
+    "Load a `BigQuery` query with one document per row."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "#!pip install google-cloud-bigquery"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "from langchain.document_loaders import BigQueryLoader"
@@ -194,9 +210,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/modules/indexes/document_loaders/examples/bilibili.ipynb

@@ -7,29 +7,33 @@
    "source": [
     "# Bilibili\n",
     "\n",
-    "This loader utilizes the `bilibili-api` to fetch the text transcript from Bilibili, one of the most beloved long-form video sites in China.\n",
+    "This loader utilizes the [bilibili-api](https://github.com/MoyuScript/bilibili-api) to fetch the text transcript from [Bilibili](https://www.bilibili.tv/), one of the most beloved long-form video sites in China.\n",
     "\n",
     "With this BiliBiliLoader, users can easily obtain the transcript of their desired video content on the platform."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
-   "id": "9ec8a3b3",
-   "metadata": {},
+   "execution_count": null,
+   "id": "43128d8d",
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
-    "from langchain.document_loaders.bilibili import BiliBiliLoader"
+    "#!pip install bilibili-api"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
-   "id": "43128d8d",
-   "metadata": {},
+   "execution_count": null,
+   "id": "9ec8a3b3",
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
-    "#!pip install bilibili-api"
+    "from langchain.document_loaders.bilibili import BiliBiliLoader"
    ]
   },
   {
@@ -51,16 +55,20 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "outputs": [],
-   "source": [
-    "loader.load()"
-   ],
+   "id": "3470dadf",
    "metadata": {
     "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    },
     "pycharm": {
      "name": "#%%\n"
     }
-   }
+   },
+   "outputs": [],
+   "source": [
+    "loader.load()"
+   ]
   }
  ],
  "metadata": {
@@ -79,9 +87,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}

docs/modules/indexes/document_loaders/examples/blackboard.ipynb

@@ -1,13 +1,18 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "# Blackboard\n",
     "\n",
-    "This covers how to load data from a Blackboard Learn instance."
+    "This covers how to load data from a [Blackboard Learn](https://www.anthology.com/products/teaching-and-learning/learning-effectiveness/blackboard-learn) instance.\n",
+    "\n",
+    "This loader is not compatible with all `Blackboard` courses. It is only\n",
+    "    compatible with courses that use the new `Blackboard` interface.\n",
+    "    To use this loader, you must have the BbRouter cookie. You can get this\n",
+    "    cookie by logging into the course and then copying the value of the\n",
+    "    BbRouter cookie from the browser's developer tools."
    ]
   },
   {
@@ -28,11 +33,24 @@
   }
  ],
  "metadata": {
-  "language_info": {
-   "name": "python"
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
   },
-  "orig_nbformat": 4
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.6"
+  }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/modules/indexes/document_loaders/examples/blockchain.ipynb

@@ -0,0 +1,149 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "id": "vm8vn9t8DvC_"
+   },
+   "source": [
+    "# Blockchain"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "id": "5WjXERXzFEhg"
+   },
+   "source": [
+    "## Overview"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "id": "juAmbgoWD17u"
+   },
+   "source": [
+    "The intention of this notebook is to provide a means of testing functionality in the Langchain Document Loader for Blockchain.\n",
+    "\n",
+    "Initially this Loader supports:\n",
+    "\n",
+    "*   Loading NFTs as Documents from NFT Smart Contracts (ERC721 and ERC1155)\n",
+    "*   Ethereum Maninnet, Ethereum Testnet, Polgyon Mainnet, Polygon Testnet (default is eth-mainnet)\n",
+    "*   Alchemy's getNFTsForCollection API\n",
+    "\n",
+    "It can be extended if the community finds value in this loader.  Specifically:\n",
+    "\n",
+    "*   Additional APIs can be added (e.g. Tranction-related APIs)\n",
+    "\n",
+    "This Document Loader Requires:\n",
+    "\n",
+    "*   A free [Alchemy API Key](https://www.alchemy.com/)\n",
+    "\n",
+    "The output takes the following format:\n",
+    "\n",
+    "- pageContent= Individual NFT\n",
+    "- metadata={'source': '0x1a92f7381b9f03921564a437210bb9396471050c', 'blockchain': 'eth-mainnet', 'tokenId': '0x15'})"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Load NFTs into Document Loader"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# get ALCHEMY_API_KEY from https://www.alchemy.com/ \n",
+    "\n",
+    "alchemyApiKey = \"...\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Option 1: Ethereum Mainnet (default BlockchainType)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "id": "J3LWHARC-Kn0"
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.document_loaders.blockchain import BlockchainDocumentLoader, BlockchainType\n",
+    "contractAddress = \"0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d\" # Bored Ape Yacht Club contract address\n",
+    "\n",
+    "blockchainType = BlockchainType.ETH_MAINNET  #default value, optional parameter\n",
+    "\n",
+    "blockchainLoader = BlockchainDocumentLoader(contract_address=contractAddress,\n",
+    "                                            api_key=alchemyApiKey)\n",
+    "\n",
+    "nfts = blockchainLoader.load()\n",
+    "\n",
+    "nfts[:2]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Option 2: Polygon Mainnet"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "contractAddress = \"0x448676ffCd0aDf2D85C1f0565e8dde6924A9A7D9\" # Polygon Mainnet contract address\n",
+    "\n",
+    "blockchainType = BlockchainType.POLYGON_MAINNET \n",
+    "\n",
+    "blockchainLoader = BlockchainDocumentLoader(contract_address=contractAddress, \n",
+    "                                            blockchainType=blockchainType, \n",
+    "                                            api_key=alchemyApiKey)\n",
+    "\n",
+    "nfts = blockchainLoader.load()\n",
+    "\n",
+    "nfts[:2]"
+   ]
+  }
+ ],
+ "metadata": {
+  "colab": {
+   "collapsed_sections": [
+    "5WjXERXzFEhg"
+   ],
+   "provenance": []
+  },
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

docs/modules/indexes/document_loaders/examples/chatgpt_loader.ipynb

@@ -1,21 +1,22 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "### ChatGPT Data Loader\n",
     "\n",
-    "This notebook covers how to load `conversations.json` from your ChatGPT data export folder.\n",
+    "This notebook covers how to load `conversations.json` from your `ChatGPT` data export folder.\n",
     "\n",
     "You can get your data export by email by going to: https://chat.openai.com/ -> (Profile) - Settings -> Export data -> Confirm export."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "from langchain.document_loaders.chatgpt import ChatGPTLoader"
@@ -53,7 +54,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -67,10 +68,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.4"
-  },
-  "orig_nbformat": 4
+   "version": "3.10.6"
+  }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/modules/indexes/document_loaders/examples/college_confidential.ipynb

@@ -6,7 +6,10 @@
    "metadata": {},
    "source": [
     "# College Confidential\n",
-    "This covers how to load College Confidential webpages into a document format that we can use downstream."
+    "\n",
+    ">[College Confidential](https://www.collegeconfidential.com/) gives information on 3,800+ colleges and universities.\n",
+    "\n",
+    "This covers how to load `College Confidential` webpages into a document format that we can use downstream."
    ]
   },
   {
@@ -85,7 +88,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/confluence.ipynb

@@ -6,18 +6,29 @@
    "source": [
     "# Confluence\n",
     "\n",
-    "A loader for Confluence pages.\n",
+    "A loader for [Confluence](https://www.atlassian.com/software/confluence) pages.\n",
     "\n",
     "\n",
-    "This currently supports both username/api_key and Oauth2 login.\n",
+    "This currently supports both `username/api_key` and `Oauth2 login`.\n",
     "\n",
     "\n",
     "Specify a list page_ids and/or space_key to load in the corresponding pages into Document objects, if both are specified the union of both sets will be returned.\n",
     "\n",
     "\n",
-    "You can also specify a boolean `include_attachments` to include attachments, this is set to False by default, if set to True all attachments will be downloaded and ConfluenceReader will extract the text from the attachments and add it to the Document object. Currently supported attachment types are: PDF, PNG, JPEG/JPG, SVG, Word and Excel.\n",
+    "You can also specify a boolean `include_attachments` to include attachments, this is set to False by default, if set to True all attachments will be downloaded and ConfluenceReader will extract the text from the attachments and add it to the Document object. Currently supported attachment types are: `PDF`, `PNG`, `JPEG/JPG`, `SVG`, `Word` and `Excel`.\n",
     "\n",
-    "Hint: space_key and page_id can both be found in the URL of a page in Confluence - https://yoursite.atlassian.com/wiki/spaces/<space_key>/pages/<page_id>\n"
+    "Hint: `space_key` and `page_id` can both be found in the URL of a page in Confluence - https://yoursite.atlassian.com/wiki/spaces/<space_key>/pages/<page_id>\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "#!pip install atlassian-python-api"
    ]
   },
   {
@@ -33,7 +44,7 @@
     "    username=\"me\",\n",
     "    api_key=\"12345\"\n",
     ")\n",
-    "documents = loader.load(space_key=\"SPACE\", include_attachments=True, limit=50)\n"
+    "documents = loader.load(space_key=\"SPACE\", include_attachments=True, limit=50)"
    ]
   }
  ],
@@ -53,7 +64,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.6"
   },
   "vscode": {
    "interpreter": {
@@ -62,5 +73,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/modules/indexes/document_loaders/examples/copypaste.ipynb

@@ -94,7 +94,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/csv.ipynb

@@ -2,20 +2,21 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "source": [
-    "# CSV Loader\n",
+    "# CSV Files\n",
     "\n",
-    "Load csv files with a single row per document."
+    "Load [csv](https://en.wikipedia.org/wiki/Comma-separated_values) data with a single row per document."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 25,
    "metadata": {
-    "collapsed": true
+    "collapsed": true,
+    "jupyter": {
+     "outputs_hidden": true
+    }
    },
    "outputs": [],
    "source": [
@@ -26,7 +27,10 @@
    "cell_type": "code",
    "execution_count": 26,
    "metadata": {
-    "collapsed": false
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
    },
    "outputs": [],
    "source": [
@@ -39,7 +43,10 @@
    "cell_type": "code",
    "execution_count": 27,
    "metadata": {
-    "collapsed": false
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
    },
    "outputs": [
     {
@@ -56,9 +63,7 @@
   },
   {
    "cell_type": "markdown",
-   "metadata": {
-    "collapsed": false
-   },
+   "metadata": {},
    "source": [
     "## Customizing the csv parsing and loading\n",
     "\n",
@@ -69,7 +74,10 @@
    "cell_type": "code",
    "execution_count": 28,
    "metadata": {
-    "collapsed": false
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
    },
    "outputs": [],
    "source": [
@@ -86,7 +94,10 @@
    "cell_type": "code",
    "execution_count": 29,
    "metadata": {
-    "collapsed": false
+    "collapsed": false,
+    "jupyter": {
+     "outputs_hidden": false
+    }
    },
    "outputs": [
     {
@@ -102,13 +113,12 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Specify a column to be used identify the document source\n",
+    "## Specify a column to identify the document source\n",
     "\n",
-    "Use the `source_column` argument to specify a column to be set as the source for the document created from each row. Otherwise `file_path` will be used as the source for all documents created from the csv file.\n",
+    "Use the `source_column` argument to specify a source for the document created from each row. Otherwise `file_path` will be used as the source for all documents created from the CSV file.\n",
     "\n",
     "This is useful when using documents loaded from CSV files for chains that answer questions using sources."
    ]
@@ -144,7 +154,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -158,9 +168,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 0
+ "nbformat_minor": 4
 }

docs/modules/indexes/document_loaders/examples/dataframe.ipynb

@@ -5,9 +5,19 @@
    "id": "213a38a2",
    "metadata": {},
    "source": [
-    "# DataFrame Loader\n",
+    "# Pandas DataFrame\n",
     "\n",
-    "This notebook goes over how to load data from a pandas dataframe"
+    "This notebook goes over how to load data from a [pandas](https://pandas.pydata.org/pandas-docs/stable/user_guide/index.html) DataFrame."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f6a7a9e4-80d6-486a-b2e3-636c568aa97c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#!pip install pandas"
    ]
   },
   {
@@ -210,7 +220,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/diffbot.ipynb

@@ -1,13 +1,16 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "2dfc4698",
    "metadata": {},
    "source": [
     "# Diffbot\n",
     "\n",
+    ">Unlike traditional web scraping tools, [Diffbot](https://docs.diffbot.com/docs) doesn't require any rules to read the content on a page.\n",
+    ">It starts with computer vision, which classifies a page into one of 20 possible types. Content is then interpreted by a machine learning model trained to identify the key attributes on a page based on its type.\n",
+    ">The result is a website transformed into clean structured data (like JSON or CSV), ready for your application.\n",
+    "\n",
     "This covers how to extract HTML documents from a list of URLs using the [Diffbot extract API](https://www.diffbot.com/products/extract/), into a document format that we can use downstream."
    ]
   },
@@ -24,7 +27,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "6fffec88",
    "metadata": {},
@@ -45,7 +47,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "e0ce8c05",
    "metadata": {},

docs/modules/indexes/document_loaders/examples/directory_loader.ipynb

@@ -68,13 +68,56 @@
     "len(docs)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "e633d62f",
+   "metadata": {},
+   "source": [
+    "## Show a progress bar"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "43911860",
+   "metadata": {},
+   "source": [
+    "By default a progress bar will not be shown. To show a progress bar, install the `tqdm` library (e.g. `pip install tqdm`), and set the `show_progress` parameter to `True`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "bb93daac",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Requirement already satisfied: tqdm in /Users/jon/.pyenv/versions/3.9.16/envs/microbiome-app/lib/python3.9/site-packages (4.65.0)\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "0it [00:00, ?it/s]\n"
+     ]
+    }
+   ],
+   "source": [
+    "%pip install tqdm\n",
+    "loader = DirectoryLoader('../', glob=\"**/*.md\", show_progress=True)\n",
+    "docs = loader.load()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "c5652850",
    "metadata": {},
    "source": [
     "## Change loader class\n",
-    "By default this uses the UnstructuredLoader class. However, you can change up the type of loader pretty easily."
+    "By default this uses the `UnstructuredLoader` class. However, you can change up the type of loader pretty easily."
    ]
   },
   {
@@ -190,7 +233,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "7f6e0eae",
+   "id": "6a91a0bc",
    "metadata": {},
    "outputs": [],
    "source": []
@@ -212,7 +255,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.3"
+   "version": "3.9.1"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/duckdb.ipynb

@@ -4,15 +4,30 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# DuckDB Loader\n",
+    "# DuckDB\n",
     "\n",
-    "Load a DuckDB query with one document per row."
+    ">[DuckDB](https://duckdb.org/) is an in-process SQL OLAP database management system.\n",
+    "\n",
+    "Load a `DuckDB` query with one document per row."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "#!pip install duckdb"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "from langchain.document_loaders import DuckDBLoader"
@@ -20,8 +35,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
+   "execution_count": 3,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -40,8 +57,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
+   "execution_count": 4,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "loader = DuckDBLoader(\"SELECT * FROM read_csv_auto('example.csv')\")\n",
@@ -51,8 +70,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
+   "execution_count": 5,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -167,9 +188,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 1
+ "nbformat_minor": 4
 }

docs/modules/indexes/document_loaders/examples/email.ipynb

@@ -7,7 +7,7 @@
    "source": [
     "# Email\n",
     "\n",
-    "This notebook shows how to load email (`.eml`) and Microsoft Outlook (`.msg`) files."
+    "This notebook shows how to load email (`.eml`) or `Microsoft Outlook` (`.msg`) files."
    ]
   },
   {
@@ -20,9 +20,23 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
+   "id": "226e50aa-407d-43d9-a81d-f6706298b10c",
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "#!pip install unstructured"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
    "id": "40cd9806",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "from langchain.document_loaders import UnstructuredEmailLoader"
@@ -30,9 +44,11 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 6,
    "id": "2d20b852",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "loader = UnstructuredEmailLoader('example_data/fake-email.eml')"
@@ -40,9 +56,11 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "id": "579fa702",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "data = loader.load()"
@@ -50,17 +68,19 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 8,
    "id": "90c1d899",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "[Document(page_content='This is a test email to use for unit tests.\\n\\nImportant points:\\n\\nRoses are red\\n\\nViolets are blue', lookup_str='', metadata={'source': 'example_data/fake-email.eml'}, lookup_index=0)]"
+       "[Document(page_content='This is a test email to use for unit tests.\\n\\nImportant points:\\n\\nRoses are red\\n\\nViolets are blue', metadata={'source': 'example_data/fake-email.eml'})]"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 8,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -128,6 +148,16 @@
     "## Using OutlookMessageLoader"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "058e670e-9964-44ee-b888-44f23ffb9310",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#!pip install extract_msg"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 8,
@@ -204,7 +234,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/epub.ipynb

@@ -5,16 +5,18 @@
    "id": "39af9ecd",
    "metadata": {},
    "source": [
-    "# EPubs\n",
+    "# EPub \n",
     "\n",
-    "This covers how to load `.epub` documents into a document format that we can use downstream. You'll need to install the [`pandocs`](https://pandoc.org/installing.html) package for this loader to work."
+    "This covers how to load `.epub` documents into the Document format that we can use downstream. You'll need to install the [`pandocs`](https://pandoc.org/installing.html) package for this loader to work."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 1,
    "id": "721c48aa",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "from langchain.document_loaders import UnstructuredEPubLoader"
@@ -24,7 +26,9 @@
    "cell_type": "code",
    "execution_count": 2,
    "id": "9d3d0e35",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "loader = UnstructuredEPubLoader(\"winter-sports.epub\")"
@@ -32,9 +36,11 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "id": "06073f91",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "data = loader.load()"
@@ -54,7 +60,9 @@
    "cell_type": "code",
    "execution_count": 4,
    "id": "064f9162",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "loader = UnstructuredEPubLoader(\"winter-sports.epub\", mode=\"elements\")"
@@ -62,9 +70,11 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": null,
    "id": "abefbbdb",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "data = loader.load()"
@@ -116,7 +126,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/evernote.ipynb

@@ -7,35 +7,41 @@
    "source": [
     "# EverNote\n",
     "\n",
-    "How to load EverNote file from disk."
+    ">[EverNote](https://evernote.com/) is intended for archiving and creating notes in which photos, audio and saved web content can be embedded. Notes are stored in virtual \"notebooks\" and can be tagged, annotated, edited, searched, and exported.\n",
+    "\n",
+    "This notebook shows how to load `EverNote` file from disk."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 3,
    "id": "1a53ece0",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
-    "# !pip install pypandoc\n",
-    "# import pypandoc\n",
+    "#!pip install pypandoc\n",
+    "import pypandoc\n",
     "\n",
-    "# pypandoc.download_pandoc()"
+    "pypandoc.download_pandoc()"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 4,
    "id": "88df766f",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "[Document(page_content='testing this\\n\\nwhat happens?\\n\\nto the world?\\n', lookup_str='', metadata={'source': 'example_data/testing.enex'}, lookup_index=0)]"
+       "[Document(page_content='testing this\\n\\nwhat happens?\\n\\nto the world?\\n', metadata={'source': 'example_data/testing.enex'})]"
       ]
      },
-     "execution_count": 5,
+     "execution_count": 4,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -46,14 +52,6 @@
     "loader = EverNoteLoader(\"example_data/testing.enex\")\n",
     "loader.load()"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "c1329905",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
@@ -72,7 +70,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/example_data/facebook_chat.json

@@ -5,60 +5,60 @@
         {
             "sender_name": "User 1",
             "timestamp_ms": 1675597435669,
-            "content": "Oh no worries! Bye",
+            "content": "Oh no worries! Bye"
         },
         {
             "sender_name": "User 2",
             "timestamp_ms": 1675596277579,
-            "content": "No Im sorry it was my mistake, the blue one is not for sale",
+            "content": "No Im sorry it was my mistake, the blue one is not for sale"
         },
         {
             "sender_name": "User 1",
             "timestamp_ms": 1675595140251,
-            "content": "I thought you were selling the blue one!",
+            "content": "I thought you were selling the blue one!"
         },
         {
             "sender_name": "User 1",
             "timestamp_ms": 1675595109305,
-            "content": "Im not interested in this bag. Im interested in the blue one!",
+            "content": "Im not interested in this bag. Im interested in the blue one!"
         },
         {
             "sender_name": "User 2",
             "timestamp_ms": 1675595068468,
-            "content": "Here is $129",
+            "content": "Here is $129"
         },
         {
             "sender_name": "User 2",
             "timestamp_ms": 1675595060730,
             "photos": [
                 {"uri": "url_of_some_picture.jpg", "creation_timestamp": 1675595059}
-            ],
+            ]
         },
         {
             "sender_name": "User 2",
             "timestamp_ms": 1675595045152,
-            "content": "Online is at least $100",
+            "content": "Online is at least $100"
         },
         {
             "sender_name": "User 1",
             "timestamp_ms": 1675594799696,
-            "content": "How much do you want?",
+            "content": "How much do you want?"
         },
         {
             "sender_name": "User 2",
             "timestamp_ms": 1675577876645,
-            "content": "Goodmorning! $50 is too low.",
+            "content": "Goodmorning! $50 is too low."
         },
         {
             "sender_name": "User 1",
             "timestamp_ms": 1675549022673,
-            "content": "Hi! Im interested in your bag. Im offering $50. Let me know if you are interested. Thanks!",
-        },
+            "content": "Hi! Im interested in your bag. Im offering $50. Let me know if you are interested. Thanks!"
+        }
     ],
     "title": "User 1 and User 2 chat",
     "is_still_participant": true,
     "thread_path": "inbox/User 1 and User 2 chat",
     "magic_words": [],
     "image": {"uri": "image_of_the_chat.jpg", "creation_timestamp": 1675549016},
-    "joinable_mode": {"mode": 1, "link": ""},
+    "joinable_mode": {"mode": 1, "link": ""}
 }

docs/modules/indexes/document_loaders/examples/example_data/fake_rule.toml

@@ -0,0 +1,22 @@
+[internal]
+creation_date = "2023-05-01"
+updated_date = "2022-05-01"
+release = ["release_type"]
+min_endpoint_version = "some_semantic_version"
+os_list = ["operating_system_list"]
+
+[rule]
+uuid = "some_uuid"
+name = "Fake Rule Name"
+description = "Fake description of rule"
+query = '''
+process where process.name : "somequery"
+'''
+
+[[rule.threat]]
+framework = "MITRE ATT&CK"
+
+  [rule.threat.tactic]
+  name = "Execution"
+  id = "TA0002"
+  reference = "https://attack.mitre.org/tactics/TA0002/"

docs/modules/indexes/document_loaders/examples/facebook_chat.ipynb

@@ -6,13 +6,24 @@
    "source": [
     "### Facebook Chat\n",
     "\n",
-    "This notebook covers how to load data from the Facebook Chats into a format that can be ingested into LangChain."
+    "This notebook covers how to load data from the [Facebook Chats](https://www.facebook.com/business/help/1646890868956360) into a format that can be ingested into LangChain."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#pip install pandas"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 1,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "from langchain.document_loaders import FacebookChatLoader"
@@ -21,7 +32,9 @@
   {
    "cell_type": "code",
    "execution_count": 2,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "loader = FacebookChatLoader(\"example_data/facebook_chat.json\")"
@@ -29,16 +42,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
+   "execution_count": 7,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "[Document(page_content='User 2 on 2023-02-05 12:46:11: Bye!\\n\\nUser 1 on 2023-02-05 12:43:55: Oh no worries! Bye\\n\\nUser 2 on 2023-02-05 12:24:37: No Im sorry it was my mistake, the blue one is not for sale\\n\\nUser 1 on 2023-02-05 12:05:40: I thought you were selling the blue one!\\n\\nUser 1 on 2023-02-05 12:05:09: Im not interested in this bag. Im interested in the blue one!\\n\\nUser 2 on 2023-02-05 12:04:28: Here is $129\\n\\nUser 2 on 2023-02-05 12:04:05: Online is at least $100\\n\\nUser 1 on 2023-02-05 11:59:59: How much do you want?\\n\\nUser 2 on 2023-02-05 07:17:56: Goodmorning! $50 is too low.\\n\\nUser 1 on 2023-02-04 23:17:02: Hi! Im interested in your bag. Im offering $50. Let me know if you are interested. Thanks!\\n\\n', lookup_str='', metadata={'source': 'docs/modules/document_loaders/examples/example_data/facebook_chat.json'}, lookup_index=0)]"
+       "[Document(page_content='User 2 on 2023-02-05 03:46:11: Bye!\\n\\nUser 1 on 2023-02-05 03:43:55: Oh no worries! Bye\\n\\nUser 2 on 2023-02-05 03:24:37: No Im sorry it was my mistake, the blue one is not for sale\\n\\nUser 1 on 2023-02-05 03:05:40: I thought you were selling the blue one!\\n\\nUser 1 on 2023-02-05 03:05:09: Im not interested in this bag. Im interested in the blue one!\\n\\nUser 2 on 2023-02-05 03:04:28: Here is $129\\n\\nUser 2 on 2023-02-05 03:04:05: Online is at least $100\\n\\nUser 1 on 2023-02-05 02:59:59: How much do you want?\\n\\nUser 2 on 2023-02-04 22:17:56: Goodmorning! $50 is too low.\\n\\nUser 1 on 2023-02-04 14:17:02: Hi! Im interested in your bag. Im offering $50. Let me know if you are interested. Thanks!\\n\\n', metadata={'source': 'example_data/facebook_chat.json'})]"
       ]
      },
-     "execution_count": 3,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -64,7 +79,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.1"
+   "version": "3.10.6"
   },
   "vscode": {
    "interpreter": {
@@ -73,5 +88,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/modules/indexes/document_loaders/examples/figma.ipynb

@@ -1,21 +1,24 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "33205b12",
    "metadata": {},
    "source": [
     "# Figma\n",
     "\n",
-    "This notebook covers how to load data from the Figma REST API into a format that can be ingested into LangChain, along with example usage for code generation."
+    ">[Figma](https://www.figma.com/) is a collaborative web application for interface design.\n",
+    "\n",
+    "This notebook covers how to load data from the `Figma` REST API into a format that can be ingested into LangChain, along with example usage for code generation."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "id": "90b69c94",
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "import os\n",
@@ -37,7 +40,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "d809744a",
    "metadata": {},
@@ -117,7 +119,6 @@
    ]
   },
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "baf9b2c9",
    "metadata": {},
@@ -151,7 +152,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.10"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/gcs_directory.ipynb

@@ -7,17 +7,9 @@
    "source": [
     "# GCS Directory\n",
     "\n",
-    "This covers how to load document objects from an Google Cloud Storage (GCS) directory."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "5cfb25c9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.document_loaders import GCSDirectoryLoader"
+    ">[Google Cloud Storage](https://en.wikipedia.org/wiki/Google_Cloud_Storage) is a managed service for storing unstructured data.\n",
+    "\n",
+    "This covers how to load document objects from an `Google Cloud Storage (GCS) directory (bucket)`."
    ]
   },
   {
@@ -32,6 +24,16 @@
     "# !pip install google-cloud-storage"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "5cfb25c9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.document_loaders import GCSDirectoryLoader"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 3,
@@ -148,7 +150,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/gcs_file.ipynb

@@ -7,17 +7,9 @@
    "source": [
     "# GCS File Storage\n",
     "\n",
-    "This covers how to load document objects from an Google Cloud Storage (GCS) file object."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "5cfb25c9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.document_loaders import GCSFileLoader"
+    ">[Google Cloud Storage](https://en.wikipedia.org/wiki/Google_Cloud_Storage) is a managed service for storing unstructured data.\n",
+    "\n",
+    "This covers how to load document objects from an `Google Cloud Storage (GCS) file object (blob)`."
    ]
   },
   {
@@ -32,6 +24,16 @@
     "# !pip install google-cloud-storage"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "5cfb25c9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.document_loaders import GCSFileLoader"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 3,
@@ -96,7 +98,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

docs/modules/indexes/document_loaders/examples/git.ipynb

@@ -6,7 +6,9 @@
    "source": [
     "# Git\n",
     "\n",
-    "This notebook shows how to load text files from Git repository."
+    ">[Git](https://en.wikipedia.org/wiki/Git) is a distributed version control system that tracks changes in any set of computer files, usually used for coordinating work among programmers collaboratively developing source code during software development.\n",
+    "\n",
+    "This notebook shows how to load text files from `Git` repository."
    ]
   },
   {
@@ -18,8 +20,21 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "!pip install GitPython"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "from git import Repo\n",
@@ -33,7 +48,9 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [],
    "source": [
     "from langchain.document_loaders import GitLoader"
@@ -184,9 +201,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.3"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }

docs/modules/indexes/document_loaders/examples/gitbook.ipynb

@@ -6,7 +6,10 @@
    "metadata": {},
    "source": [
     "# GitBook\n",
-    "How to pull page data from any GitBook."
+    "\n",
+    ">[GitBook](https://docs.gitbook.com/) is a modern documentation platform where teams can document everything from products to internal knowledge bases and APIs.\n",
+    "\n",
+    "This notebook shows how to pull page data from any `GitBook`."
    ]
   },
   {
@@ -19,6 +22,14 @@
     "from langchain.document_loaders import GitbookLoader"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "65d5ddce",
+   "metadata": {},
+   "source": [
+    "### Load from single GitBook page"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 2,
@@ -29,14 +40,6 @@
     "loader = GitbookLoader(\"https://docs.gitbook.com\")"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "65d5ddce",
-   "metadata": {},
-   "source": [
-    "### Load from single GitBook page"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 3,
@@ -178,7 +181,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.6"
   },
   "vscode": {
    "interpreter": {