cr

If another file anywhere in `unit_tests` sets `langchain.verbose =
True`, it messes up all of the tests that check for no callbacks because
the `None` for verbose gets overridden by the global verbosity flag. By
explicitly setting it in unit tests, we bypass that potential issue

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = tests/*

.dockerignore

@@ -1,144 +0,0 @@
-.vscode/
-.idea/
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-notebooks/
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-.python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-.venvs
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# macOS display setting files
-.DS_Store
-
-
-
-# docker
-docker/
-!docker/assets/
-.dockerignore
-docker.build

.github/workflows/linkcheck.yml

@@ -1,36 +0,0 @@
-name: linkcheck
-
-on:
-  push:
-    branches: [master]
-  pull_request:
-
-env:
-  POETRY_VERSION: "1.3.1"
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version:
-          - "3.11"
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install poetry
-        run: |
-          pipx install poetry==$POETRY_VERSION
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-          cache: poetry
-      - name: Install dependencies
-        run: |
-          poetry install --with docs
-      - name: Build the docs
-        run: |
-          make docs_build
-      - name: Analyzing the docs with linkcheck
-        run: |
-          make docs_linkcheck

.github/workflows/release.yml

@@ -1,49 +0,0 @@
-name: release
-
-on:
-  pull_request:
-    types:
-      - closed
-    branches:
-      - master
-    paths:
-      - 'pyproject.toml'
-
-env:
-  POETRY_VERSION: "1.3.1"
-
-jobs:
-  if_release:
-    if: |
-        ${{ github.event.pull_request.merged == true }}
-        && ${{ contains(github.event.pull_request.labels.*.name, 'release') }}
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install poetry
-        run: pipx install poetry==$POETRY_VERSION
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.10"
-          cache: "poetry"
-      - name: Build project for distribution
-        run: poetry build
-      - name: Check Version
-        id: check-version
-        run: |
-          echo version=$(poetry version --short) >> $GITHUB_OUTPUT
-      - name: Create Release
-        uses: ncipollo/release-action@v1
-        with:
-          artifacts: "dist/*"
-          token: ${{ secrets.GITHUB_TOKEN }}
-          draft: false
-          generateReleaseNotes: true
-          tag: v${{ steps.check-version.outputs.version }}
-          commit: master
-      - name: Publish to PyPI
-        env:
-          POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_API_TOKEN }}
-        run: | 
-          poetry publish

.github/workflows/test.yml

@@ -31,4 +31,4 @@ jobs:
         run: poetry install
       - name: Run unit tests
         run: |
-          make test
+          make tests

.gitignore

@@ -106,9 +106,7 @@ celerybeat.pid
 
 # Environments
 .env
-!docker/.env
 .venv
-.venvs
 env/
 venv/
 ENV/
@@ -135,4 +133,3 @@ dmypy.json
 
 # macOS display setting files
 .DS_Store
-docker.build

CITATION.cff

@@ -1,8 +0,0 @@
-cff-version: 1.2.0
-message: "If you use this software, please cite it as below."
-authors:
-- family-names: "Chase"
-  given-names: "Harrison"
-title: "LangChain"
-date-released: 2022-10-17
-url: "https://github.com/hwchase17/langchain"

CONTRIBUTING.md

@@ -47,7 +47,7 @@ good code into the codebase.
 ### 🏭Release process
 
 As of now, LangChain has an ad hoc release process: releases are cut with high frequency via by
-a developer and published to [PyPI](https://pypi.org/project/langchain/).
+a developer and published to [PyPI](https://pypi.org/project/ruff/).
 
 LangChain follows the [semver](https://semver.org/) versioning standard. However, as pre-1.0 software,
 even patch releases may contain [non-backwards-compatible changes](https://semver.org/#spec-item-4).
@@ -55,16 +55,12 @@ even patch releases may contain [non-backwards-compatible changes](https://semve
 If your contribution has made its way into a release, we will want to give you credit on Twitter (only if you want though)!
 If you have a Twitter account you would like us to mention, please let us know in the PR or in another manner.
 
-## 🚀Quick Start
+## 🤖Developer Setup
+
+### 🚀Quick Start
 
 This project uses [Poetry](https://python-poetry.org/) as a dependency manager. Check out Poetry's [documentation on how to install it](https://python-poetry.org/docs/#installation) on your system before proceeding.
 
-❗Note: If you use `Conda` or `Pyenv` as your environment / package manager, avoid dependency conflicts by doing the following first:
-1. *Before installing Poetry*, create and activate a new Conda env (e.g. `conda create -n langchain python=3.9`)
-2. Install Poetry (see above)
-3. Tell Poetry to use the virtualenv python environment (`poetry config virtualenvs.prefer-active-python true`)
-4. Continue with the following steps.
-
 To install requirements:
 
 ```bash
@@ -75,11 +71,9 @@ This will install all requirements for running the package, examples, linting, f
 
 Now, you should be able to run the common tasks in the following section.
 
-## ✅Common Tasks
+### ✅Common Tasks
 
-Type `make` for a list of common tasks.
-
-### Code Formatting
+#### Code Formatting
 
 Formatting for this project is done via a combination of [Black](https://black.readthedocs.io/en/stable/) and [isort](https://pycqa.github.io/isort/).
 
@@ -89,7 +83,7 @@ To run formatting for this project:
 make format
 ```
 
-### Linting
+#### Linting
 
 Linting for this project is done via a combination of [Black](https://black.readthedocs.io/en/stable/), [isort](https://pycqa.github.io/isort/), [flake8](https://flake8.pycqa.org/en/latest/), and [mypy](http://mypy-lang.org/).
 
@@ -101,7 +95,7 @@ make lint
 
 We recognize linting can be annoying - if you do not want to do it, please contact a project maintainer, and they can help you with it. We do not want this to be a blocker for good code getting contributed.
 
-### Coverage
+#### Coverage
 
 Code coverage (i.e. the amount of code that is covered by unit tests) helps identify areas of the code that are potentially more or less brittle.
 
@@ -111,14 +105,14 @@ To get a report of current coverage, run the following:
 make coverage
 ```
 
-### Testing
+#### Testing
 
 Unit tests cover modular logic that does not require calls to outside APIs.
 
 To run unit tests:
 
 ```bash
-make test
+make tests
 ```
 
 If you add new logic, please add a unit test.
@@ -133,7 +127,7 @@ make integration_tests
 
 If you add support for a new external API, please add a new integration test.
 
-### Adding a Jupyter Notebook
+#### Adding a Jupyter Notebook
 
 If you are adding a Jupyter notebook example, you'll want to install the optional `dev` dependencies.
 
@@ -151,36 +145,10 @@ poetry run jupyter notebook
 
 When you run `poetry install`, the `langchain` package is installed as editable in the virtualenv, so your new logic can be imported into the notebook.
 
-## Using Docker
-
-Refer to [DOCKER.md](docker/DOCKER.md) for more information.
-
-## Documentation
-
-### Contribute Documentation
+#### Contribute Documentation
 
 Docs are largely autogenerated by [sphinx](https://www.sphinx-doc.org/en/master/) from the code.
 
 For that reason, we ask that you add good documentation to all classes and methods.
 
 Similar to linting, we recognize documentation can be annoying. If you do not want to do it, please contact a project maintainer, and they can help you with it. We do not want this to be a blocker for good code getting contributed.
-
-### Build Documentation Locally
-
-Before building the documentation, it is always a good idea to clean the build directory:
-
-```bash
-make docs_clean
-```
-
-Next, you can run the linkchecker to make sure all links are valid:
-
-```bash
-make docs_linkcheck
-```
-
-Finally, you can build the documentation as outlined below:
-
-```bash
-make docs_build
-```

Makefile

@@ -1,73 +1,26 @@
-.PHONY: all clean format lint test tests test_watch integration_tests help
+.PHONY: format lint tests tests_watch integration_tests
 
-GIT_HASH ?= $(shell git rev-parse --short HEAD)
-LANGCHAIN_VERSION := $(shell grep '^version' pyproject.toml | cut -d '=' -f2 | tr -d '"')
-
-all: help
-	
 coverage:
 	poetry run pytest --cov \
 		--cov-config=.coveragerc \
 		--cov-report xml \
 		--cov-report term-missing:skip-covered
 
-clean: docs_clean
-
-docs_build:
-	cd docs && poetry run make html
-
-docs_clean:
-	cd docs && poetry run make clean
-
-docs_linkcheck:
-	poetry run linkchecker docs/_build/html/index.html
-
 format:
 	poetry run black .
-	poetry run ruff --select I --fix .
+	poetry run isort .
 
 lint:
 	poetry run mypy .
 	poetry run black . --check
-	poetry run ruff .
+	poetry run isort . --check
+	poetry run flake8 .
 
-test:
+tests:
 	poetry run pytest tests/unit_tests
 
-tests: test
-
-test_watch:
+tests_watch:
 	poetry run ptw --now . -- tests/unit_tests
 
 integration_tests:
 	poetry run pytest tests/integration_tests
-
-help:
-	@echo '----'
-	@echo 'coverage            - run unit tests and generate coverage report'
-	@echo 'docs_build          - build the documentation'
-	@echo 'docs_clean          - clean the documentation build artifacts'
-	@echo 'docs_linkcheck      - run linkchecker on the documentation'
-ifneq ($(shell command -v docker 2> /dev/null),)
-	@echo 'docker              - build and run the docker dev image'
-	@echo 'docker.run          - run the docker dev image'
-	@echo 'docker.jupyter      - start a jupyter notebook inside container'
-	@echo 'docker.build        - build the docker dev image'
-	@echo 'docker.force_build  - force a rebuild'
-	@echo 'docker.test         - run the unit tests in docker'
-	@echo 'docker.lint         - run the linters in docker'
-	@echo 'docker.clean        - remove the docker dev image'
-endif
-	@echo 'format              - run code formatters'
-	@echo 'lint                - run linters'
-	@echo 'test                - run unit tests'
-	@echo 'test_watch          - run unit tests in watch mode'
-	@echo 'integration_tests   - run integration tests'
-
-# include the following makefile if the docker executable is available
-ifeq ($(shell command -v docker 2> /dev/null),)
-	$(info Docker not found, skipping docker-related targets)
-else
-include docker/Makefile
-endif
-	

README.md

@@ -1,15 +1,8 @@
-# 🦜️🔗 LangChain - Docker
+# 🦜️🔗 LangChain
 
-WIP: This is a fork of langchain focused on implementing a docker warpper and
-toolchain. The goal is to make it easy to use LLM chains running inside a
-container, build custom docker based tools and let agents run arbitrary
-untrusted code inside.
+⚡ Building applications with LLMs through composability ⚡
 
-Currently exploring the following:
-
--  Docker wrapper for LLMs and chains
--  Creating a toolchain for building docker based LLM tools.
--  Building agents that can run arbitrary untrusted code inside a container.
+[![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) [![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)
 
 ## Quick Install
 
@@ -22,22 +15,7 @@ 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.
 
-This library is aimed at assisting in the development of those types of applications. Common examples of these types of applications include:
-
-**❓ Question Answering over specific documents**
-
-- [Documentation](https://langchain.readthedocs.io/en/latest/use_cases/question_answering.html)
-- End-to-end Example: [Question Answering over Notion Database](https://github.com/hwchase17/notion-qa)
-
-**💬 Chatbots**
-
-- [Documentation](https://langchain.readthedocs.io/en/latest/use_cases/chatbots.html)
-- End-to-end Example: [Chat-LangChain](https://github.com/hwchase17/chat-langchain)
-
-**🤖 Agents**
-
-- [Documentation](https://langchain.readthedocs.io/en/latest/use_cases/agents.html)
-- End-to-end Example: [GPT+WolframAlpha](https://huggingface.co/spaces/JavaFXpert/Chat-GPT-LangChain)
+This library is aimed at assisting in the development of those types of applications.
 
 ## 📖 Documentation
 
@@ -79,8 +57,10 @@ Memory is the concept of persisting state between calls of a chain/agent. LangCh
 
 For more information on these concepts, please see our [full documentation](https://langchain.readthedocs.io/en/latest/?).
 
+
 ## 💁 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 infra, or better documentation.
 
 For detailed information on how to contribute, see [here](CONTRIBUTING.md).

docker/.env

@@ -1,13 +0,0 @@
-# python env
-PYTHON_VERSION=3.10
-
-# -E flag is required
-# comment the following line to only install dev dependencies
-POETRY_EXTRA_PACKAGES="-E all"
-
-# at least one group needed
-POETRY_DEPENDENCIES="dev,test,lint,typing"
-
-# langchain env. warning: these variables will be baked into the docker image !
-OPENAI_API_KEY=${OPENAI_API_KEY:-}
-SERPAPI_API_KEY=${SERPAPI_API_KEY:-}

docker/DOCKER.md

@@ -1,53 +0,0 @@
-# Using Docker
-
-To quickly get started, run the command `make docker`.
-
-If docker is installed the Makefile will export extra targets in the fomrat `docker.*` to build and run the docker image. Type `make` for a list of available tasks.
-
-There is a basic `docker-compose.yml` in the docker directory.
-
-## Building the development image
-
-Using `make docker` will build the dev image if it does not exist, then drops
-you inside the container with the langchain environment available in the shell.
-
-### Customizing the image and installed dependencies
-
-The image is built with a default python version and all extras and dev
-dependencies. It can be customized by changing the variables in the [.env](/docker/.env)
-file. 
-
-If you don't need all the `extra` dependencies a slimmer image can be obtained by 
-commenting out `POETRY_EXTRA_PACKAGES` in the [.env](docker/.env) file.
-
-### Image caching
-
-The Dockerfile is optimized to cache the poetry install step. A rebuild is triggered when there a change to the source code.
-
-## Example Usage
-
-All commands from langchain's python environment are available by default in the container.
-
-A few examples:
-```bash
-# run jupyter notebook
-docker run --rm -it IMG jupyter notebook
-
-# run ipython
-docker run --rm -it IMG ipython
-
-# start web server
-docker run --rm -p 8888:8888 IMG python -m http.server 8888
-```
-
-## Testing / Linting
-
-Tests and lints are run using your local source directory that is mounted on the volume /src.
-
-Run unit tests in the container with `make docker.test`.
-
-Run the linting and formatting checks with `make docker.lint`.
-
-Note: this task can run in parallel using `make -j4 docker.lint`.
-
-

docker/Dockerfile

@@ -1,104 +0,0 @@
-# vim: ft=dockerfile
-#
-# see also: https://github.com/python-poetry/poetry/discussions/1879
-#   - with https://github.com/bneijt/poetry-lock-docker
-# see https://github.com/thehale/docker-python-poetry
-# see https://github.com/max-pfeiffer/uvicorn-poetry
-
-# use by default the slim version of python
-ARG PYTHON_IMAGE_TAG=slim 
-ARG PYTHON_VERSION=${PYTHON_VERSION:-3.11.2}
-
-####################
-# Base Environment
-####################
-FROM python:$PYTHON_VERSION-$PYTHON_IMAGE_TAG AS lchain-base
-
-ARG UID=1000
-ARG USERNAME=lchain
-
-ENV USERNAME=$USERNAME
-
-RUN groupadd -g ${UID} $USERNAME
-RUN useradd -l -m -u ${UID} -g ${UID} $USERNAME
-
-# used for mounting source code
-RUN mkdir /src
-VOLUME /src
-
-
-#######################
-## Poetry Builder Image
-#######################
-FROM lchain-base AS lchain-base-builder
-
-ARG POETRY_EXTRA_PACKAGES=$POETRY_EXTRA_PACKAGES
-ARG POETRY_DEPENDENCIES=$POETRY_DEPENDENCIES
-
-ENV HOME=/root
-ENV POETRY_HOME=/root/.poetry
-ENV POETRY_VIRTUALENVS_IN_PROJECT=false
-ENV POETRY_NO_INTERACTION=1
-ENV CACHE_DIR=$HOME/.cache
-ENV POETRY_CACHE_DIR=$CACHE_DIR/pypoetry
-ENV PATH="$POETRY_HOME/bin:$PATH"
-
-WORKDIR /root
-
-RUN apt-get update && \
-    apt-get install -y \
-    build-essential \
-    git \
-    curl
-
-SHELL ["/bin/bash", "-o", "pipefail", "-c"]
-
-RUN mkdir -p $CACHE_DIR
-
-## setup poetry
-RUN curl -sSL -o $CACHE_DIR/pypoetry-installer.py https://install.python-poetry.org/
-RUN python3 $CACHE_DIR/pypoetry-installer.py
-
-
-# # Copy poetry files
-COPY poetry.* pyproject.toml ./
-
-RUN mkdir /pip-prefix
-
-RUN poetry export $POETRY_EXTRA_PACKAGES --with $POETRY_DEPENDENCIES -f requirements.txt --output requirements.txt --without-hashes && \
-    pip install --no-cache-dir --disable-pip-version-check --prefix /pip-prefix -r requirements.txt
-
-
-# add custom motd message
-COPY docker/assets/etc/motd /tmp/motd
-RUN cat /tmp/motd > /etc/motd
-
-RUN printf "\n%s\n%s\n" "$(poetry version)" "$(python --version)" >> /etc/motd
-
-###################
-## Runtime Image
-###################
-FROM lchain-base AS lchain
-
-#jupyter port
-EXPOSE 8888
-
-COPY docker/assets/entry.sh /entry
-RUN chmod +x /entry
-
-COPY --from=lchain-base-builder /etc/motd /etc/motd
-COPY --from=lchain-base-builder /usr/bin/git /usr/bin/git
-
-USER ${USERNAME:-lchain}
-ENV HOME /home/$USERNAME
-WORKDIR /home/$USERNAME
-
-COPY --chown=lchain:lchain --from=lchain-base-builder /pip-prefix $HOME/.local/
-
-COPY . .
-
-SHELL ["/bin/bash", "-o", "pipefail", "-c"]
-RUN pip install --no-deps --disable-pip-version-check --no-cache-dir -e .
-
-
-entrypoint ["/entry"]

docker/Makefile

@@ -1,84 +0,0 @@
-#do not call this makefile it is included in the main Makefile
-.PHONY: docker docker.jupyter docker.run docker.force_build docker.clean \
-	docker.test docker.lint docker.lint.mypy docker.lint.black \
-	docker.lint.isort docker.lint.flake
-
-# read python version from .env file ignoring comments
-PYTHON_VERSION := $(shell grep PYTHON_VERSION docker/.env | cut -d '=' -f2)
-POETRY_EXTRA_PACKAGES := $(shell grep '^[^#]*POETRY_EXTRA_PACKAGES' docker/.env | cut -d '=' -f2)
-POETRY_DEPENDENCIES := $(shell grep 'POETRY_DEPENDENCIES' docker/.env | cut -d '=' -f2)
-
-
-DOCKER_SRC := $(shell find docker -type f)
-DOCKER_IMAGE_NAME = langchain/dev
-
-# SRC is all files matched by the git ls-files command
-SRC := $(shell git ls-files -- '*' ':!:docker/*')
-
-# set DOCKER_BUILD_PROGRESS=plain to see detailed build progress
-DOCKER_BUILD_PROGRESS ?= auto
-
-# extra message to show when entering the docker container
-DOCKER_MOTD := docker/assets/etc/motd
-
-ROOTDIR := $(shell git rev-parse --show-toplevel)
-
-DOCKER_LINT_CMD = docker run --rm -i -u lchain -v $(ROOTDIR):/src  $(DOCKER_IMAGE_NAME):$(GIT_HASH)
-
-docker: docker.run
-
-docker.run: docker.build
-	@echo "Docker image: $(DOCKER_IMAGE_NAME):$(GIT_HASH)"
-	docker run --rm -it -u lchain -v $(ROOTDIR):/src  $(DOCKER_IMAGE_NAME):$(GIT_HASH)
-
-docker.jupyter: docker.build
-	docker run --rm -it -v $(ROOTDIR):/src  $(DOCKER_IMAGE_NAME):$(GIT_HASH) jupyter notebook
-
-docker.build: $(SRC) $(DOCKER_SRC) $(DOCKER_MOTD)
-ifdef $(DOCKER_BUILDKIT)
-	docker buildx build --build-arg PYTHON_VERSION=$(PYTHON_VERSION) \
-			--build-arg POETRY_EXTRA_PACKAGES=$(POETRY_EXTRA_PACKAGES) \
-			--build-arg POETRY_DEPENDENCIES=$(POETRY_DEPENDENCIES) \
-			--progress=$(DOCKER_BUILD_PROGRESS) \
-			$(BUILD_FLAGS) -f docker/Dockerfile -t $(DOCKER_IMAGE_NAME):$(GIT_HASH) .
-else
-	docker build --build-arg PYTHON_VERSION=$(PYTHON_VERSION) \
-			--build-arg POETRY_EXTRA_PACKAGES=$(POETRY_EXTRA_PACKAGES) \
-			--build-arg POETRY_DEPENDENCIES=$(POETRY_DEPENDENCIES) \
-			$(BUILD_FLAGS) -f docker/Dockerfile -t $(DOCKER_IMAGE_NAME):$(GIT_HASH) .
-endif
-	docker tag $(DOCKER_IMAGE_NAME):$(GIT_HASH) $(DOCKER_IMAGE_NAME):latest
-	@touch $@ # this prevents docker from rebuilding dependencies that have not 
-	@         #  changed. Remove the file `docker/docker.build` to force a rebuild.
-
-docker.force_build: $(DOCKER_SRC)
-	@rm -f docker.build
-	@$(MAKE) docker.build BUILD_FLAGS=--no-cache
-
-docker.clean:
-	docker rmi $(DOCKER_IMAGE_NAME):$(GIT_HASH) $(DOCKER_IMAGE_NAME):latest
-
-docker.test: docker.build
-	docker run --rm -it -u lchain -v $(ROOTDIR):/src  $(DOCKER_IMAGE_NAME):$(GIT_HASH) \
-		pytest /src/tests/unit_tests
-
-# this assumes that the docker image has been built 
-docker.lint: docker.lint.mypy docker.lint.black docker.lint.isort \
-	docker.lint.flake
-
-# these can run in parallel with -j[njobs]
-docker.lint.mypy:
-	@$(DOCKER_LINT_CMD) mypy /src
-	@printf "\t%s\n" "mypy ... "
-
-docker.lint.black:
-	@$(DOCKER_LINT_CMD) black /src --check
-	@printf "\t%s\n" "black ... "
-
-docker.lint.isort:
-	@$(DOCKER_LINT_CMD) isort /src --check
-	@printf "\t%s\n" "isort ... "
-
-docker.lint.flake:
-	@$(DOCKER_LINT_CMD) flake8 /src
-	@printf "\t%s\n" "flake8 ... "

docker/assets/entry.sh

@@ -1,10 +0,0 @@
-#!/usr/bin/env bash
-
-export PATH=$HOME/.local/bin:$PATH
-
-if [ -z "$1" ]; then
-    cat /etc/motd
-    exec /bin/bash
-fi
-
-exec "$@"

docker/assets/etc/motd

@@ -1,8 +0,0 @@
-All dependencies have been installed in the current shell. There is no
-virtualenv or a need for `poetry` inside the container.
-
-Running the command `make docker.run` at the root directory of the project will
-build the container the first time. On the next runs it will use the cached
-image. A rebuild will happen when changes are made to the source code.
-
-You local source directory has been mounted to the /src directory.

docker/docker-compose.yml

@@ -1,17 +0,0 @@
-version: "3.7"
-
-services:
-  langchain:
-    hostname: langchain
-    image: langchain/dev:latest
-    build:
-      context: ../
-      dockerfile: docker/Dockerfile
-      args:
-        PYTHON_VERSION: ${PYTHON_VERSION}
-        POETRY_EXTRA_PACKAGES: ${POETRY_EXTRA_PACKAGES}
-        POETRY_DEPENDENCIES: ${POETRY_DEPENDENCIES}
-
-    restart: unless-stopped
-    ports:
-      - 127.0.0.1:8888:8888

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?= 
+SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SPHINXAUTOBUILD   ?= sphinx-autobuild
 SOURCEDIR     = .

docs/_static/css/custom.css

@@ -1,13 +0,0 @@
-pre {
-  white-space: break-spaces;
-}
-
-@media (min-width: 1200px) {
-  .container,
-  .container-lg,
-  .container-md,
-  .container-sm,
-  .container-xl {
-    max-width: 2560px !important;
-  }
-}

docs/conf.py

@@ -48,7 +48,8 @@ extensions = [
     "sphinx_panels",
     "IPython.sphinxext.ipython_console_highlighting",
 ]
-source_suffix = [".ipynb", ".html", ".md", ".rst"]
+source_suffix = [".rst", ".md"]
+
 
 autodoc_pydantic_model_show_json = False
 autodoc_pydantic_field_list_validators = False
@@ -94,12 +95,6 @@ html_context = {
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
-
-# These paths are either relative to html_static_path
-# or fully qualified paths (eg. https://...)
-html_css_files = [
-    "css/custom.css",
-]
+html_static_path: list = []
 nb_execution_mode = "off"
 myst_enable_extensions = ["colon_fence"]

docs/deployments.md

@@ -1,39 +0,0 @@
-# Deployments
-
-So you've made a really cool chain - now what? How do you deploy it and make it easily sharable 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.
-
-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.
-
-## [Streamlit](https://github.com/hwchase17/langchain-streamlit-template)
-
-This repo serves as a template for how to deploy a LangChain with Streamlit.
-It implements a chatbot interface.
-It also contains instructions for how to deploy this app on the Streamlit platform.
-
-## [Gradio (on Hugging Face)](https://github.com/hwchase17/langchain-gradio-template)
-
-This repo serves as a template for how deploy a LangChain with Gradio.
-It implements a chatbot interface, with a "Bring-Your-Own-Token" approach (nice for not wracking up big bills).
-It also contains instructions for how to deploy this app on the Hugging Face platform.
-This is heavily influenced by James Weaver's [excellent examples](https://huggingface.co/JavaFXpert).
-
-## [Beam](https://github.com/slai-labs/get-beam/tree/main/examples/langchain-question-answering)
-
-This repo serves as a template for how deploy a LangChain with [Beam](https://beam.cloud).
-
-It implements a Question Answering app and contains instructions for deploying the app as a serverless REST API.
-
-## [Vercel](https://github.com/homanp/vercel-langchain)
-
-A minimal example on how to run LangChain on Vercel using Flask.
-
-
-## [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.

docs/ecosystem/atlas.md

@@ -1,25 +0,0 @@
-# AtlasDB
-
-This page covers how to Nomic's Atlas ecosystem within LangChain.
-It is broken into two parts: installation and setup, and then references to specific Atlas wrappers.
-
-## Installation and Setup
-- Install the Python package with `pip install nomic`
-- Nomic is also included in langchains poetry extras `poetry install -E all`
-- 
-## Wrappers
-
-### VectorStore
-
-There exists a wrapper around the Atlas neural database, allowing you to use it as a vectorstore.
-This vectorstore also gives you full access to the underlying AtlasProject object, which will allow you to use the full range of Atlas map interactions, such as bulk tagging and automatic topic modeling.
-Please see [the Nomic docs](https://docs.nomic.ai/atlas_api.html) for more detailed information.
-
-
-
-To import this vectorstore:
-```python
-from langchain.vectorstores import AtlasDB
-```
-
-For a more detailed walkthrough of the Chroma wrapper, see [this notebook](../modules/indexes/examples/vectorstores.ipynb)

docs/ecosystem/bananadev.md

@@ -1,79 +0,0 @@
-# Banana
-
-This page covers how to use the Banana ecosystem within LangChain.
-It is broken into two parts: installation and setup, and then references to specific Banana wrappers.
-
-## Installation and Setup
-
-- Install with `pip3 install banana-dev`
-- Get an Banana api key and set it as an environment variable (`BANANA_API_KEY`)
-
-## Define your Banana Template
-
-If you want to use an available language model template you can find one [here](https://app.banana.dev/templates/conceptofmind/serverless-template-palmyra-base).
-This template uses the Palmyra-Base model by [Writer](https://writer.com/product/api/).
-You can check out an example Banana repository [here](https://github.com/conceptofmind/serverless-template-palmyra-base).
-
-## Build the Banana app
-
-Banana Apps must include the "output" key in the return json. 
-There is a rigid response structure.
-
-```python
-# Return the results as a dictionary
-result = {'output': result}
-```
-
-An example inference function would be:
-
-```python
-def inference(model_inputs:dict) -> dict:
-    global model
-    global tokenizer
-
-    # Parse out your arguments
-    prompt = model_inputs.get('prompt', None)
-    if prompt == None:
-        return {'message': "No prompt provided"}
-
-    # Run the model
-    input_ids = tokenizer.encode(prompt, return_tensors='pt').cuda()
-    output = model.generate(
-        input_ids,
-        max_length=100,
-        do_sample=True,
-        top_k=50,
-        top_p=0.95,
-        num_return_sequences=1,
-        temperature=0.9,
-        early_stopping=True,
-        no_repeat_ngram_size=3,
-        num_beams=5,
-        length_penalty=1.5,
-        repetition_penalty=1.5,
-        bad_words_ids=[[tokenizer.encode(' ', add_prefix_space=True)[0]]]
-        )
-
-    result = tokenizer.decode(output[0], skip_special_tokens=True)
-    # Return the results as a dictionary
-    result = {'output': result}
-    return result
-```
-
-You can find a full example of a Banana app [here](https://github.com/conceptofmind/serverless-template-palmyra-base/blob/main/app.py).
-
-## Wrappers
-
-### LLM
-
-There exists an Banana LLM wrapper, which you can access with
-
-```python
-from langchain.llms import Banana
-```
-
-You need to provide a model key located in the dashboard:
-
-```python
-llm = Banana(model_key="YOUR_MODEL_KEY")
-```

docs/ecosystem/cerebriumai.md

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

docs/ecosystem/chroma.md

@@ -1,20 +0,0 @@
-# Chroma
-
-This page covers how to use the Chroma ecosystem within LangChain.
-It is broken into two parts: installation and setup, and then references to specific Chroma wrappers.
-
-## Installation and Setup
-- Install the Python package with `pip install chromadb`
-## Wrappers
-
-### VectorStore
-
-There exists a wrapper around Chroma vector 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 Chroma
-```
-
-For a more detailed walkthrough of the Chroma wrapper, see [this notebook](../modules/indexes/examples/vectorstores.ipynb)

docs/ecosystem/cohere.md

@@ -22,4 +22,4 @@ There exists an Cohere Embeddings wrapper, which you can access with
 ```python
 from langchain.embeddings import CohereEmbeddings
 ```
-For a more detailed walkthrough of this, see [this notebook](../modules/indexes/examples/embeddings.ipynb)
+For a more detailed walkthrough of this, see [this notebook](../modules/utils/combine_docs_examples/embeddings.ipynb)

docs/ecosystem/deepinfra.md

@@ -1,17 +0,0 @@
-# DeepInfra
-
-This page covers how to use the DeepInfra ecosystem within LangChain.
-It is broken into two parts: installation and setup, and then references to specific DeepInfra wrappers.
-
-## Installation and Setup
-- Get your DeepInfra api key from this link [here](https://deepinfra.com/).
-- Get an DeepInfra api key and set it as an environment variable (`DEEPINFRA_API_TOKEN`)
-
-## Wrappers
-
-### LLM
-
-There exists an DeepInfra LLM wrapper, which you can access with
-```python
-from langchain.llms import DeepInfra
-```

docs/ecosystem/deeplake.md

@@ -1,25 +0,0 @@
-# Deep Lake
-
-This page covers how to use the Deep Lake ecosystem within LangChain.
-It is broken into two parts: installation and setup, and then references to specific Deep Lake wrappers. For more information.
-
-1. Here is [whitepaper](https://www.deeplake.ai/whitepaper) and [academic paper](https://arxiv.org/pdf/2209.10785.pdf) for Deep Lake
-
-2. Here is a set of additional resources available for review: [Deep Lake](https://github.com/activeloopai/deeplake), [Getting Started](https://docs.activeloop.ai/getting-started) and [Tutorials](https://docs.activeloop.ai/hub-tutorials)
-
-## Installation and Setup
-- Install the Python package with `pip install deeplake`
-
-## Wrappers
-
-### VectorStore
-
-There exists a wrapper around Deep Lake, a data lake for Deep Learning applications, allowing you to use it as a vectorstore (for now), whether for semantic search or example selection.
-
-To import this vectorstore:
-```python
-from langchain.vectorstores import DeepLake
-```
-
-
-For a more detailed walkthrough of the Deep Lake wrapper, see [this notebook](../modules/indexes/vectorstore_examples/deeplake.ipynb)

docs/ecosystem/forefrontai.md

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

docs/ecosystem/google_search.md

@@ -1,7 +1,7 @@
 # Google Search Wrapper
 
 This page covers how to use the Google Search API within LangChain.
-It is broken into two parts: installation and setup, and then references to the specific Google Search wrapper.
+It is broken into two parts: installation and setup, and then references to specific Pinecone wrappers.
 
 ## Installation and Setup
 - Install requirements with `pip install google-api-python-client`

docs/ecosystem/google_serper.md

@@ -1,71 +0,0 @@
-# Google Serper Wrapper
-
-This page covers how to use the [Serper](https://serper.dev) Google Search API within LangChain. Serper is a low-cost Google Search API that can be used to add answer box, knowledge graph, and organic results data from Google Search. 
-It is broken into two parts: setup, and then references to the specific Google Serper wrapper.
-
-## Setup
-- Go to [serper.dev](https://serper.dev) to sign up for a free account
-- Get the api key and set it as an environment variable (`SERPER_API_KEY`)
-
-## Wrappers
-
-### Utility
-
-There exists a GoogleSerperAPIWrapper utility which wraps this API. To import this utility:
-
-```python
-from langchain.utilities import GoogleSerperAPIWrapper
-```
-
-You can use it as part of a Self Ask chain:
-
-```python
-from langchain.utilities import GoogleSerperAPIWrapper
-from langchain.llms.openai import OpenAI
-from langchain.agents import initialize_agent, Tool
-
-import os
-
-os.environ["SERPER_API_KEY"] = ""
-os.environ['OPENAI_API_KEY'] = ""
-
-llm = OpenAI(temperature=0)
-search = GoogleSerperAPIWrapper()
-tools = [
-    Tool(
-        name="Intermediate Answer",
-        func=search.run
-    )
-]
-
-self_ask_with_search = initialize_agent(tools, llm, agent="self-ask-with-search", verbose=True)
-self_ask_with_search.run("What is the hometown of the reigning men's U.S. Open champion?")
-```
-
-#### Output
-```
-Entering new AgentExecutor chain...
- Yes.
-Follow up: Who is the reigning men's U.S. Open champion?
-Intermediate answer: Current champions Carlos Alcaraz, 2022 men's singles champion.
-Follow up: Where is Carlos Alcaraz from?
-Intermediate answer: El Palmar, Spain
-So the final answer is: El Palmar, Spain
-
-> Finished chain.
-
-'El Palmar, Spain'
-```
-
-For a more detailed walkthrough of this wrapper, see [this notebook](../modules/utils/examples/google_serper.ipynb).
-
-### Tool
-
-You can also easily load this wrapper as a Tool (to use with an Agent).
-You can do this with:
-```python
-from langchain.agents import load_tools
-tools = load_tools(["google-serper"])
-```
-
-For more information on this, see [this page](../modules/agents/tools.md)

docs/ecosystem/gooseai.md

@@ -1,23 +0,0 @@
-# GooseAI
-
-This page covers how to use the GooseAI ecosystem within LangChain.
-It is broken into two parts: installation and setup, and then references to specific GooseAI wrappers.
-
-## Installation and Setup
-- Install the Python SDK with `pip install openai`
-- Get your GooseAI api key from this link [here](https://goose.ai/).
-- Set the environment variable (`GOOSEAI_API_KEY`).
-
-```python
-import os
-os.environ["GOOSEAI_API_KEY"] = "YOUR_API_KEY"
-```
-
-## Wrappers
-
-### LLM
-
-There exists an GooseAI LLM wrapper, which you can access with: 
-```python
-from langchain.llms import GooseAI
-```

docs/ecosystem/graphsignal.md

@@ -1,38 +0,0 @@
-# Graphsignal
-
-This page covers how to use the Graphsignal to trace and monitor LangChain.
-
-## Installation and Setup
-
-- Install the Python library with `pip install graphsignal`
-- Create free Graphsignal account [here](https://graphsignal.com)
-- Get an API key and set it as an environment variable (`GRAPHSIGNAL_API_KEY`)
-
-## Tracing and Monitoring
-
-Graphsignal automatically instruments and starts tracing and monitoring chains. Traces, metrics and errors are then available in your [Graphsignal dashboard](https://app.graphsignal.com/). No prompts or other sensitive data are sent to Graphsignal cloud, only statistics and metadata.
-
-Initialize the tracer by providing a deployment name:
-
-```python
-import graphsignal
-
-graphsignal.configure(deployment='my-langchain-app-prod')
-```
-
-In order to trace full runs and see a breakdown by chains and tools, you can wrap the calling routine or use a decorator:
-
-```python
-with graphsignal.start_trace('my-chain'):
-    chain.run("some initial text")
-```
-
-Optionally, enable profiling to record function-level statistics for each trace.
-
-```python
-with graphsignal.start_trace(
-        'my-chain', options=graphsignal.TraceOptions(enable_profiling=True)):
-    chain.run("some initial text")
-```
-
-See the [Quick Start](https://graphsignal.com/docs/guides/quick-start/) guide for complete setup instructions.

docs/ecosystem/helicone.md

@@ -1,53 +0,0 @@
-# Helicone
-
-This page covers how to use the [Helicone](https://helicone.ai) within LangChain.
-
-## What is Helicone?
-
-Helicone is an [open source](https://github.com/Helicone/helicone) observability platform that proxies your OpenAI traffic and provides you key insights into your spend, latency and usage.
-
-![Helicone](../_static/HeliconeDashboard.png)
-
-## Quick start
-
-With your LangChain environment you can just add the following parameter.
-
-```bash
-export OPENAI_API_BASE="https://oai.hconeai.com/v1"
-```
-
-Now head over to [helicone.ai](https://helicone.ai/onboarding?step=2) to create your account, and add your OpenAI API key within our dashboard to view your logs.
-
-![Helicone](../_static/HeliconeKeys.png)
-
-## How to enable Helicone caching
-
-```python
-from langchain.llms import OpenAI
-import openai
-openai.api_base = "https://oai.hconeai.com/v1"
-
-llm = OpenAI(temperature=0.9, headers={"Helicone-Cache-Enabled": "true"})
-text = "What is a helicone?"
-print(llm(text))
-```
-
-[Helicone caching docs](https://docs.helicone.ai/advanced-usage/caching)
-
-## How to use Helicone custom properties
-
-```python
-from langchain.llms import OpenAI
-import openai
-openai.api_base = "https://oai.hconeai.com/v1"
-
-llm = OpenAI(temperature=0.9, headers={
-        "Helicone-Property-Session": "24",
-        "Helicone-Property-Conversation": "support_issue_2",
-        "Helicone-Property-App": "mobile",
-      })
-text = "What is a helicone?"
-print(llm(text))
-```
-
-[Helicone property docs](https://docs.helicone.ai/advanced-usage/custom-properties)

docs/ecosystem/huggingface.md

@@ -47,7 +47,7 @@ To use a the wrapper for a model hosted on Hugging Face Hub:
 ```python
 from langchain.embeddings import HuggingFaceHubEmbeddings
 ```
-For a more detailed walkthrough of this, see [this notebook](../modules/indexes/examples/embeddings.ipynb)
+For a more detailed walkthrough of this, see [this notebook](../modules/utils/combine_docs_examples/embeddings.ipynb)
 
 ### Tokenizer
 
@@ -59,7 +59,7 @@ You can also use it to count tokens when splitting documents with
 from langchain.text_splitter import CharacterTextSplitter
 CharacterTextSplitter.from_huggingface_tokenizer(...)
 ```
-For a more detailed walkthrough of this, see [this notebook](../modules/indexes/examples/textsplitter.ipynb)
+For a more detailed walkthrough of this, see [this notebook](../modules/utils/combine_docs_examples/textsplitter.ipynb)
 
 
 ### Datasets

docs/ecosystem/modal.md

@@ -1,66 +0,0 @@
-# Modal
-
-This page covers how to use the Modal ecosystem within LangChain.
-It is broken into two parts: installation and setup, and then references to specific Modal wrappers.
-
-## Installation and Setup
-- Install with `pip install modal-client`
-- Run `modal token new`
-
-## Define your Modal Functions and Webhooks
-
-You must include a prompt. There is a rigid response structure.
-
-```python
-class Item(BaseModel):
-    prompt: str
-
-@stub.webhook(method="POST")
-def my_webhook(item: Item):
-    return {"prompt": my_function.call(item.prompt)}
-```
-
-An example with GPT2:
-
-```python
-from pydantic import BaseModel
-
-import modal
-
-stub = modal.Stub("example-get-started")
-
-volume = modal.SharedVolume().persist("gpt2_model_vol")
-CACHE_PATH = "/root/model_cache"
-
-@stub.function(
-    gpu="any",
-    image=modal.Image.debian_slim().pip_install(
-        "tokenizers", "transformers", "torch", "accelerate"
-    ),
-    shared_volumes={CACHE_PATH: volume},
-    retries=3,
-)
-def run_gpt2(text: str):
-    from transformers import GPT2Tokenizer, GPT2LMHeadModel
-    tokenizer = GPT2Tokenizer.from_pretrained('gpt2')
-    model = GPT2LMHeadModel.from_pretrained('gpt2')
-    encoded_input = tokenizer(text, return_tensors='pt').input_ids
-    output = model.generate(encoded_input, max_length=50, do_sample=True)
-    return tokenizer.decode(output[0], skip_special_tokens=True)
-
-class Item(BaseModel):
-    prompt: str
-
-@stub.webhook(method="POST")
-def get_text(item: Item):
-    return {"prompt": run_gpt2.call(item.prompt)}
-```
-
-## Wrappers
-
-### LLM
-
-There exists an Modal LLM wrapper, which you can access with 
-```python
-from langchain.llms import Modal
-```

docs/ecosystem/openai.md

@@ -31,7 +31,7 @@ There exists an OpenAI Embeddings wrapper, which you can access with
 ```python
 from langchain.embeddings import OpenAIEmbeddings
 ```
-For a more detailed walkthrough of this, see [this notebook](../modules/indexes/examples/embeddings.ipynb)
+For a more detailed walkthrough of this, see [this notebook](../modules/utils/combine_docs_examples/embeddings.ipynb)
 
 
 ### Tokenizer
@@ -44,7 +44,7 @@ You can also use it to count tokens when splitting documents with
 from langchain.text_splitter import CharacterTextSplitter
 CharacterTextSplitter.from_tiktoken_encoder(...)
 ```
-For a more detailed walkthrough of this, see [this notebook](../modules/indexes/examples/textsplitter.ipynb)
+For a more detailed walkthrough of this, see [this notebook](../modules/utils/combine_docs_examples/textsplitter.ipynb)
 
 ### Moderation
 You can also access the OpenAI content moderation endpoint with

docs/ecosystem/opensearch.md

@@ -1,21 +0,0 @@
-# OpenSearch
-
-This page covers how to use the OpenSearch ecosystem within LangChain.
-It is broken into two parts: installation and setup, and then references to specific OpenSearch wrappers.
-
-## Installation and Setup
-- Install the Python package with `pip install opensearch-py`
-## Wrappers
-
-### VectorStore
-
-There exists a wrapper around OpenSearch vector databases, allowing you to use it as a vectorstore 
-for semantic search using approximate vector search powered by lucene, nmslib and faiss engines 
-or using painless scripting and script scoring functions for bruteforce vector search.
-
-To import this vectorstore:
-```python
-from langchain.vectorstores import OpenSearchVectorSearch
-```
-
-For a more detailed walkthrough of the OpenSearch wrapper, see [this notebook](../modules/indexes/vectorstore_examples/opensearch.ipynb)

docs/ecosystem/petals.md

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

docs/ecosystem/pinecone.md

@@ -17,4 +17,4 @@ To import this vectorstore:
 from langchain.vectorstores import Pinecone
 ```
 
-For a more detailed walkthrough of the Pinecone wrapper, see [this notebook](../modules/indexes/examples/vectorstores.ipynb)
+For a more detailed walkthrough of the Pinecone wrapper, see [this notebook](../modules/utils/combine_docs_examples/vectorstores.ipynb)

docs/ecosystem/promptlayer.md

@@ -1,31 +0,0 @@
-# PromptLayer
-
-This page covers how to use [PromptLayer](https://www.promptlayer.com) within LangChain.
-It is broken into two parts: installation and setup, and then references to specific PromptLayer wrappers.
-
-## Installation and Setup
-
-If you want to work with PromptLayer:
-- Install the promptlayer python library `pip install promptlayer`
-- Create a PromptLayer account
-- Create an api token and set it as an environment variable (`PROMPTLAYER_API_KEY`)
-
-## Wrappers
-
-### LLM
-
-There exists an PromptLayer OpenAI LLM wrapper, which you can access with
-```python
-from langchain.llms import PromptLayerOpenAI
-```
-
-To tag your requests, use the argument `pl_tags` when instanializing the LLM
-```python
-from langchain.llms import PromptLayerOpenAI
-llm = PromptLayerOpenAI(pl_tags=["langchain-requests", "chatbot"])
-```
-
-This LLM is identical to the [OpenAI LLM](./openai), except that
-- all your requests will be logged to your PromptLayer account
-- you can add `pl_tags` when instantializing to tag your requests on PromptLayer
-

docs/ecosystem/runhouse.md

@@ -1,31 +0,0 @@
-# Runhouse
-
-This page covers how to use the [Runhouse](https://github.com/run-house/runhouse) ecosystem within LangChain.
-It is broken into three parts: installation and setup, LLMs, and Embeddings.
-
-## Installation and Setup
-- Install the Python SDK with `pip install runhouse`
-- If you'd like to use on-demand cluster, check your cloud credentials with `sky check`
-
-## Self-hosted LLMs
-For a basic self-hosted LLM, you can use the `SelfHostedHuggingFaceLLM` class. For more
-custom LLMs, you can use the `SelfHostedPipeline` parent class.
-
-```python
-from langchain.llms import SelfHostedPipeline, SelfHostedHuggingFaceLLM
-```
-
-For a more detailed walkthrough of the Self-hosted LLMs, see [this notebook](../modules/llms/integrations/self_hosted_examples.ipynb)
-
-## Self-hosted Embeddings
-There are several ways to use self-hosted embeddings with LangChain via Runhouse.
-
-For a basic self-hosted embedding from a Hugging Face Transformers model, you can use 
-the `SelfHostedEmbedding` class.
-```python
-from langchain.llms import SelfHostedPipeline, SelfHostedHuggingFaceLLM
-```
-
-For a more detailed walkthrough of the Self-hosted Embeddings, see [this notebook](../modules/indexes/examples/embeddings.ipynb)
-
-##

docs/ecosystem/searx.md

@@ -1,35 +0,0 @@
-# SearxNG Search API
-
-This page covers how to use the SearxNG search API within LangChain.
-It is broken into two parts: installation and setup, and then references to the specific SearxNG API wrapper.
-
-## Installation and Setup
-
-- You can find a list of public SearxNG instances [here](https://searx.space/). 
-- It recommended to use a self-hosted instance to avoid abuse on the public instances. Also note that public instances often have a limit on the number of requests.
-- To run a self-hosted instance see [this page](https://searxng.github.io/searxng/admin/installation.html) for more information.
-- To use the tool you need to provide the searx host url by:
-    1. passing the named parameter `searx_host` when creating the instance.
-    2. exporting the environment variable `SEARXNG_HOST`. 
-
-## Wrappers
-
-### Utility
-
-You can use the wrapper to get results from a SearxNG instance. 
-
-```python
-from langchain.utilities import SearxSearchWrapper
-```
-
-### Tool
-
-You can also easily load this wrapper as a Tool (to use with an Agent).
-You can do this with:
-
-```python
-from langchain.agents import load_tools
-tools = load_tools(["searx-search"], searx_host="https://searx.example.com")
-```
-
-For more information on this, see [this page](../modules/agents/tools.md)

docs/ecosystem/serpapi.md

@@ -1,7 +1,7 @@
 # SerpAPI
 
 This page covers how to use the SerpAPI search APIs within LangChain.
-It is broken into two parts: installation and setup, and then references to the specific SerpAPI wrapper.
+It is broken into two parts: installation and setup, and then references to specific Pinecone wrappers.
 
 ## Installation and Setup
 - Install requirements with `pip install google-search-results`

docs/ecosystem/stochasticai.md

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

docs/ecosystem/unstructured.md

@@ -1,41 +0,0 @@
-# Unstructured
-
-This page covers how to use the [`unstructured`](https://github.com/Unstructured-IO/unstructured)
-ecosystem within LangChain. The `unstructured` package from
-[Unstructured.IO](https://www.unstructured.io/) extracts clean text from raw source documents like
-PDFs and Word documents.
-
-
-This page is broken into two parts: installation and setup, and then references to specific
-`unstructured` wrappers.
-
-## Installation and Setup
-- 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.
-    - `libmagic-dev`
-    - `poppler-utils`
-    - `tesseract-ocr`
-    - `libreoffice`
-- If you are parsing PDFs, run the following to install the `detectron2` model, which
-  `unstructured` uses for layout detection:
-    - `pip install "detectron2@git+https://github.com/facebookresearch/detectron2.git@v0.6#egg=detectron2"`
-
-## Wrappers
-
-### Data Loaders
-
-The primary `unstructured` wrappers within `langchain` are data loaders. The following
-shows how to use the most basic unstructured data loader. There are other file-specific
-data loaders available in the `langchain.document_loaders` module.
-
-```python
-from langchain.document_loaders import UnstructuredFileLoader
-
-loader = UnstructuredFileLoader("state_of_the_union.txt")
-loader.load()
-```
-
-If you instantiate the loader with `UnstructuredFileLoader(mode="elements")`, the loader
-will track additional metadata like the page number and text type (i.e. title, narrative text)
-when that information is available.

docs/ecosystem/weaviate.md

@@ -30,4 +30,4 @@ To import this vectorstore:
 from langchain.vectorstores import Weaviate
 ```
 
-For a more detailed walkthrough of the Weaviate wrapper, see [this notebook](../modules/indexes/examples/vectorstores.ipynb)
+For a more detailed walkthrough of the Weaviate wrapper, see [this notebook](../modules/utils/combine_docs_examples/vectorstores.ipynb)

docs/ecosystem/wolfram_alpha.md

@@ -1,34 +0,0 @@
-# Wolfram Alpha Wrapper
-
-This page covers how to use the Wolfram Alpha API within LangChain.
-It is broken into two parts: installation and setup, and then references to specific Wolfram Alpha wrappers.
-
-## Installation and Setup
-- Install requirements with `pip install wolframalpha`
-- Go to wolfram alpha and sign up for a developer account [here](https://developer.wolframalpha.com/)
-- Create an app and get your APP ID
-- Set your APP ID as an environment variable `WOLFRAM_ALPHA_APPID`
-
-
-## Wrappers
-
-### Utility
-
-There exists a WolframAlphaAPIWrapper utility which wraps this API. To import this utility:
-
-```python
-from langchain.utilities.wolfram_alpha import WolframAlphaAPIWrapper
-```
-
-For a more detailed walkthrough of this wrapper, see [this notebook](../modules/utils/examples/wolfram_alpha.ipynb).
-
-### Tool
-
-You can also easily load this wrapper as a Tool (to use with an Agent).
-You can do this with:
-```python
-from langchain.agents import load_tools
-tools = load_tools(["wolfram-alpha"])
-```
-
-For more information on this, see [this page](../modules/agents/tools.md)

docs/ecosystem/writer.md

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

docs/gallery.rst

@@ -37,17 +37,6 @@ Open Source
 
     ---
 
-    .. link-button:: https://github.com/normandmickey/MrsStax
-        :type: url
-        :text: QA Slack Bot
-        :classes: stretched-link btn-lg
-
-    +++
-
-    This application is a Slack Bot that uses Langchain and OpenAI's GPT3 language model to provide domain specific answers. You provide the documents.
-
-    ---
-
     .. link-button:: https://github.com/OpenBioLink/ThoughtSource
         :type: url
         :text: ThoughtSource
@@ -81,50 +70,6 @@ Open Source
 
     ---
 
-    .. link-button:: https://dagster.io/blog/chatgpt-langchain
-        :type: url
-        :text: Dagster Documentation ChatBot
-        :classes: stretched-link btn-lg
-
-    +++
-
-    A jupyter notebook demonstrating how you could create a semantic search engine on documents in one of your Google Folders
-
-    ---
-
-    .. link-button:: https://github.com/venuv/langchain_semantic_search
-        :type: url
-        :text: Google Folder Semantic Search
-        :classes: stretched-link btn-lg
-
-    +++
-
-    Build a GitHub support bot with GPT3, LangChain, and Python.
-
-    ---
-
-    .. link-button:: https://huggingface.co/spaces/team7/talk_with_wind
-        :type: url
-        :text: Talk With Wind
-        :classes: stretched-link btn-lg
-
-    +++
-
-    Record sounds of anything (birds, wind, fire, train station) and chat with it.
-
-    ---
-
-    .. link-button:: https://huggingface.co/spaces/JavaFXpert/Chat-GPT-LangChain
-        :type: url
-        :text: ChatGPT LangChain
-        :classes: stretched-link btn-lg
-
-    +++
-
-    This simple application demonstrates a conversational agent implemented with OpenAI GPT-3.5 and LangChain. When necessary, it leverages tools for complex math, searching the internet, and accessing news and weather.
-
-    ---
-
     .. link-button:: https://huggingface.co/spaces/JavaFXpert/gpt-math-techniques
         :type: url
         :text: GPT Math Techniques
@@ -180,17 +125,6 @@ Open Source
 
     ---
 
-    .. link-button:: https://huggingface.co/spaces/rituthombre/QNim
-        :type: url
-        :text: QNimGPT
-        :classes: stretched-link btn-lg
-
-    +++
-
-    A chat UI to play Nim, where a player can select an opponent, either a quantum computer or an AI
-
-    ---
-
     .. link-button:: https://colab.research.google.com/drive/19WTIWC3prw5LDMHmRMvqNV2loD9FHls6?usp=sharing
         :type: url
         :text: ReAct TextWorld
@@ -210,56 +144,7 @@ Open Source
     +++
 
     This repo is a simple demonstration of using LangChain to do fact-checking with prompt chaining.
-    
-    ---
 
-    .. link-button:: https://github.com/arc53/docsgpt
-        :type: url
-        :text: DocsGPT
-        :classes: stretched-link btn-lg
-    
-    +++
-
-    Answer questions about the documentation of any project    
-
-Misc. Colab Notebooks
-~~~~~~~~~~~~~~~
-
-.. panels::
-    :body: text-center
-
-    ---
-
-    .. link-button:: https://colab.research.google.com/drive/1AAyEdTz-Z6ShKvewbt1ZHUICqak0MiwR?usp=sharing
-        :type: url
-        :text: Wolfram Alpha in Conversational Agent
-        :classes: stretched-link btn-lg
-    
-    +++
-
-    Give ChatGPT a WolframAlpha neural implant
-    
-    ---
-
-    .. link-button:: https://colab.research.google.com/drive/1UsCLcPy8q5PMNQ5ytgrAAAHa124dzLJg?usp=sharing
-        :type: url
-        :text: Tool Updates in Agents
-        :classes: stretched-link btn-lg
-    
-    +++
-
-    Agent improvements (6th Jan 2023)
-    
-    ---
-
-    .. link-button:: https://colab.research.google.com/drive/1UsCLcPy8q5PMNQ5ytgrAAAHa124dzLJg?usp=sharing
-        :type: url
-        :text: Conversational Agent with Tools (Langchain AGI)
-        :classes: stretched-link btn-lg
-    
-    +++
-
-    Langchain AGI (23rd Dec 2022)    
 
 Proprietary
 -----------

docs/getting_started/getting_started.md

@@ -162,7 +162,7 @@ This is one of the simpler types of chains, but understanding how it works will
 
 `````{dropdown} Agents: Dynamically call chains based on user input
 
-So far the chains we've looked at run in a predetermined order.
+So for the chains we've looked at run in a predetermined order.
 
 Agents no longer do: they use an LLM to determine which actions to take and in what order. An action can either be using a tool and observing its output, or returning to the user.
 
@@ -179,20 +179,6 @@ In order to load agents, you should understand the following concepts:
 
 **Tools**: For a list of predefined tools and their specifications, see [here](../modules/agents/tools.md).
 
-For this example, you will also need to install the SerpAPI Python package.
-
-```bash
-pip install google-search-results
-```
-
-And set the appropriate environment variables.
-
-```python
-import os
-os.environ["SERPAPI_API_KEY"] = "..."
-```
-
-Now we can get started!
 
 ```python
 from langchain.agents import load_tools

docs/glossary.md

@@ -1,55 +1,50 @@
 # Glossary
 
 This is a collection of terminology commonly used when developing LLM applications.
-It contains reference to external papers or sources where the concept was first introduced,
+It contains reference to external papers or sources where the concept was first introduced, 
 as well as to places in LangChain where the concept is used.
 
 ## Chain of Thought Prompting
 
-A prompting technique used to encourage the model to generate a series of intermediate reasoning steps.
+A prompting technique used to encourage the model to generate a series of intermediate reasoning steps. 
 A less formal way to induce this behavior is to include “Let’s think step-by-step” in the prompt.
 
 Resources:
-
 - [Chain-of-Thought Paper](https://arxiv.org/pdf/2201.11903.pdf)
 - [Step-by-Step Paper](https://arxiv.org/abs/2112.00114)
 
 ## Action Plan Generation
 
-A prompt usage that uses a language model to generate actions to take.
+A prompt usage that uses a language model to generate actions to take. 
 The results of these actions can then be fed back into the language model to generate a subsequent action.
 
 Resources:
-
 - [WebGPT Paper](https://arxiv.org/pdf/2112.09332.pdf)
 - [SayCan Paper](https://say-can.github.io/assets/palm_saycan.pdf)
 
 ## ReAct Prompting
 
-A prompting technique that combines Chain-of-Thought prompting with action plan generation.
-This induces the to model to think about what action to take, then take it.
+A prompting technique that combines Chain-of-Thought prompting with action plan generation. 
+This induces the to model to think about what action to take, then take it. 
 
 Resources:
-
 - [Paper](https://arxiv.org/pdf/2210.03629.pdf)
-- [LangChain Example](./modules/agents/implementations/react.ipynb)
+- [LangChain Example](https://github.com/hwchase17/langchain/blob/master/docs/examples/agents/react.ipynb)
 
 ## Self-ask
 
-A prompting method that builds on top of chain-of-thought prompting.
-In this method, the model explicitly asks itself follow-up questions, which are then answered by an external search engine.
+A prompting method that builds on top of chain-of-thought prompting. 
+In this method, the model explicitly asks itself follow-up questions, which are then answered by an external search engine. 
 
 Resources:
-
 - [Paper](https://ofir.io/self-ask.pdf)
-- [LangChain Example](./modules/agents/implementations/self_ask_with_search.ipynb)
+- [LangChain Example](https://github.com/hwchase17/langchain/blob/master/docs/examples/agents/self_ask_with_search.ipynb)
 
 ## Prompt Chaining
 
-Combining multiple LLM calls together, with the output of one-step being the input to the next.
-
-Resources:
+Combining multiple LLM calls together, with the output of one-step being the input to the next. 
 
+Resources: 
 - [PromptChainer Paper](https://arxiv.org/pdf/2203.06566.pdf)
 - [Language Model Cascades](https://arxiv.org/abs/2207.10342)
 - [ICE Primer Book](https://primer.ought.org/)
@@ -57,28 +52,25 @@ Resources:
 
 ## Memetic Proxy
 
-Encouraging the LLM to respond in a certain way framing the discussion in a context that the model knows of and that will result in that type of response. For example, as a conversation between a student and a teacher.
+Encouraging the LLM to respond in a certain way framing the discussion in a context that the model knows of and that will result in that type of response. For example, as a conversation between a student and a teacher. 
 
 Resources:
-
 - [Paper](https://arxiv.org/pdf/2102.07350.pdf)
 
 ## Self Consistency
 
-A decoding strategy that samples a diverse set of reasoning paths and then selects the most consistent answer.
-Is most effective when combined with Chain-of-thought prompting.
+A decoding strategy that samples a diverse set of reasoning paths and then selects the most consistent answer. 
+Is most effective when combined with Chain-of-thought prompting. 
 
 Resources:
-
 - [Paper](https://arxiv.org/pdf/2203.11171.pdf)
 
 ## Inception
 
-Also called “First Person Instruction”.
-Encouraging the model to think a certain way by including the start of the model’s response in the prompt.
+Also called “First Person Instruction”. 
+Encouraging the model to think a certain way by including the start of the model’s response in the prompt. 
 
 Resources:
-
 - [Example](https://twitter.com/goodside/status/1583262455207460865?s=20&t=8Hz7XBnK1OF8siQrxxCIGQ)
 
 ## MemPrompt
@@ -86,5 +78,4 @@ Resources:
 MemPrompt maintains a memory of errors and user feedback, and uses them to prevent repetition of mistakes.
 
 Resources:
-
 - [Paper](https://memprompt.com/)

docs/index.rst

@@ -7,29 +7,14 @@ But using these LLMs in isolation is often not enough to
 create a truly powerful app - the real power comes when you are able to
 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:
-
-**❓ Question Answering over specific documents**
-
-- `Documentation <./use_cases/question_answering.html>`_
-- End-to-end Example: `Question Answering over Notion Database <https://github.com/hwchase17/notion-qa>`_
-
-**💬 Chatbots**
-
-- `Documentation <./use_cases/chatbots.html>`_
-- End-to-end Example: `Chat-LangChain <https://github.com/hwchase17/chat-langchain>`_
-
-**🤖 Agents**
-
-- `Documentation <./use_cases/agents.html>`_
-- End-to-end Example: `GPT+WolframAlpha <https://huggingface.co/spaces/JavaFXpert/Chat-GPT-LangChain>`_
+This library is aimed at assisting in the development of those types of applications.
 
 Getting Started
 ----------------
 
 Checkout the below guide for a walkthrough of how to get started using LangChain to create an Language Model application.
 
-- `Getting Started Documentation <./getting_started/getting_started.html>`_
+- `Getting Started Documentation <getting_started/getting_started.html>`_
 
 .. toctree::
    :maxdepth: 1
@@ -42,26 +27,22 @@ Checkout the below guide for a walkthrough of how to get started using LangChain
 Modules
 -----------
 
-There are several main modules that LangChain provides support for.
+There are six main modules that LangChain provides support for.
 For each module we provide some examples to get started, how-to guides, reference docs, and conceptual guides.
 These modules are, in increasing order of complexity:
 
 
-- `Prompts <./modules/prompts.html>`_: This includes prompt management, prompt optimization, and prompt serialization.
+- `Prompts <modules/prompts.html>`_: This includes prompt management, prompt optimization, and prompt serialization.
 
-- `LLMs <./modules/llms.html>`_: This includes a generic interface for all LLMs, and common utilities for working with LLMs.
+- `LLMs <modules/llms.html>`_: This includes a generic interface for all LLMs, and common utilities for working with LLMs.
 
-- `Document Loaders <./modules/document_loaders.html>`_: This includes a standard interface for loading documents, as well as specific integrations to all types of text data sources.
+- `Utils <modules/utils.html>`_: Language models are often more powerful when interacting with other sources of knowledge or computation. This can include Python REPLs, embeddings, search engines, and more. LangChain provides a large collection of common utils to use in your application.
 
-- `Utils <./modules/utils.html>`_: Language models are often more powerful when interacting with other sources of knowledge or computation. This can include Python REPLs, embeddings, search engines, and more. LangChain provides a large collection of common utils to use in your application.
+- `Chains <modules/chains.html>`_: 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 <./modules/chains.html>`_: 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.
+- `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.
 
-- `Indexes <./modules/indexes.html>`_: Language models are often more powerful when combined with your own text data - this module covers best practices for doing exactly that.
-
-- `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.
-
-- `Memory <./modules/memory.html>`_: 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 <modules/memory.html>`_: 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.
 
 
 .. toctree::
@@ -70,35 +51,33 @@ These modules are, in increasing order of complexity:
    :name: modules
    :hidden:
 
-   ./modules/prompts.md
-   ./modules/llms.md
-   ./modules/document_loaders.md
-   ./modules/utils.md
-   ./modules/indexes.md
-   ./modules/chains.md
-   ./modules/agents.md
-   ./modules/memory.md
+   modules/prompts.md
+   modules/llms.md
+   modules/utils.md
+   modules/chains.md
+   modules/agents.md
+   modules/memory.md
 
 Use Cases
 ----------
 
 The above modules can be used in a variety of ways. LangChain also provides guidance and assistance in this. Below are some of the common use cases LangChain supports.
 
-- `Agents <./use_cases/agents.html>`_: Agents are systems that use a language model to interact with other tools. These can be used to do more grounded question/answering, interact with APIs, or even take actions.
+- `Agents <use_cases/agents.html>`_: Agents are systems that use a language model to interact with other tools. These can be used to do more grounded question/answering, interact with APIs, or even take actions.
 
-- `Chatbots <./use_cases/chatbots.html>`_: Since language models are good at producing text, that makes them ideal for creating chatbots.
+- `Chatbots <use_cases/chatbots.html>`_: Since language models are good at producing text, that makes them ideal for creating chatbots.
 
-- `Data Augmented Generation <./use_cases/combine_docs.html>`_: 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 <use_cases/combine_docs.html>`_: 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.
 
-- `Question Answering <./use_cases/question_answering.html>`_: Answering questions over specific documents, only utilizing the information in those documents to construct an answer. A type of Data Augmented Generation.
+- `Question Answering <use_cases/question_answering.html>`_: Answering questions over specific documents, only utilizing the information in those documents to construct an answer. A type of Data Augmented Generation.
 
-- `Summarization <./use_cases/summarization.html>`_: Summarizing longer documents into shorter, more condensed chunks of information. A type of Data Augmented Generation.
+- `Summarization <use_cases/summarization.html>`_: Summarizing longer documents into shorter, more condensed chunks of information. A type of Data Augmented Generation.
 
-- `Evaluation <./use_cases/evaluation.html>`_: Generative models are notoriously hard to evaluate with traditional metrics. One new way of evaluating them is using language models themselves to do the evaluation. LangChain provides some prompts/chains for assisting in this.
+- `Evaluation <use_cases/evaluation.html>`_: Generative models are notoriously hard to evaluate with traditional metrics. One new way of evaluating them is using language models themselves to do the evaluation. LangChain provides some prompts/chains for assisting in this.
 
-- `Generate similar examples <./use_cases/generate_examples.html>`_: Generating similar examples to a given input. This is a common use case for many applications, and LangChain provides some prompts/chains for assisting in this.
+- `Generate similar examples <use_cases/generate_examples.html>`_: Generating similar examples to a given input. This is a common use case for many applications, and LangChain provides some prompts/chains for assisting in this.
 
-- `Compare models <./use_cases/model_laboratory.html>`_: Experimenting with different prompts, models, and chains is a big part of developing the best possible application. The ModelLaboratory makes it easy to do so.
+- `Compare models <model_laboratory.html>`_: Experimenting with different prompts, models, and chains is a big part of developing the best possible application. The ModelLaboratory makes it easy to do so.
 
 
 
@@ -108,14 +87,14 @@ The above modules can be used in a variety of ways. LangChain also provides guid
    :name: use_cases
    :hidden:
 
-   ./use_cases/agents.md
-   ./use_cases/chatbots.md
-   ./use_cases/generate_examples.ipynb
-   ./use_cases/combine_docs.md
-   ./use_cases/question_answering.md
-   ./use_cases/summarization.md
-   ./use_cases/evaluation.rst
-   ./use_cases/model_laboratory.ipynb
+   use_cases/agents.md
+   use_cases/chatbots.md
+   use_cases/generate_examples.ipynb
+   use_cases/combine_docs.md
+   use_cases/question_answering.md
+   use_cases/summarization.md
+   use_cases/evaluation.rst
+   use_cases/model_laboratory.ipynb
 
 
 Reference Docs
@@ -124,16 +103,16 @@ Reference Docs
 All of LangChain's reference documentation, in one place. Full documentation on all methods, classes, installation methods, and integration setups for LangChain.
 
 
-- `Reference Documentation <./reference.html>`_
+- `Reference Documentation <reference.html>`_
 .. toctree::
    :maxdepth: 1
    :caption: Reference
    :name: reference
    :hidden:
 
-   ./reference/installation.md
-   ./reference/integrations.md
-   ./reference.rst
+   reference/installation.md
+   reference/integrations.md
+   reference.rst
 
 
 LangChain Ecosystem
@@ -141,7 +120,7 @@ LangChain Ecosystem
 
 Guides for how other companies/products can be used with LangChain
 
-- `LangChain Ecosystem <./ecosystem.html>`_
+- `LangChain Ecosystem <ecosystem.html>`_
 
 .. toctree::
    :maxdepth: 1
@@ -150,7 +129,7 @@ Guides for how other companies/products can be used with LangChain
    :name: ecosystem
    :hidden:
 
-   ./ecosystem.rst
+   ecosystem.rst
 
 
 Additional Resources
@@ -158,20 +137,12 @@ Additional Resources
 
 Additional collection of resources we think may be useful as you develop your application!
 
-- `LangChainHub <https://github.com/hwchase17/langchain-hub>`_: The LangChainHub is a place to share and explore other prompts, chains, and agents.
+- `Glossary <glossary.html>`_: A glossary of all related terms, papers, methods, etc. Whether implemented in LangChain or not!
 
-- `Glossary <./glossary.html>`_: A glossary of all related terms, papers, methods, etc. Whether implemented in LangChain or not!
-
-- `Gallery <./gallery.html>`_: A collection of our favorite projects that use LangChain. Useful for finding inspiration or seeing how things were done in other applications.
-
-- `Deployments <./deployments.html>`_: A collection of instructions, code snippets, and template repositories for deploying LangChain apps.
+- `Gallery <gallery.html>`_: A collection of our favorite projects that use LangChain. Useful for finding inspiration or seeing how things were done in other applications.
 
 - `Discord <https://discord.gg/6adMQxSpJS>`_: Join us on our Discord to discuss all things LangChain!
 
-- `Tracing <./tracing.html>`_: A guide on using tracing in LangChain to visualize the execution of chains and agents.
-
-- `Production Support <https://forms.gle/57d8AmXBYp8PP8tZA>`_: As you move your LangChains into production, we'd love to offer more comprehensive support. Please fill out this form and we'll set up a dedicated support Slack channel.
-
 
 .. toctree::
    :maxdepth: 1
@@ -179,10 +150,5 @@ Additional collection of resources we think may be useful as you develop your ap
    :name: resources
    :hidden:
 
-   LangChainHub <https://github.com/hwchase17/langchain-hub>
-   ./glossary.md
-   ./gallery.rst
-   ./deployments.md
-   ./tracing.md
-   Discord <https://discord.gg/6adMQxSpJS>
-   Production Support <https://forms.gle/57d8AmXBYp8PP8tZA>
+   glossary.md
+   gallery.rst

docs/modules/agents.rst

@@ -2,19 +2,19 @@ Agents
 ==========================
 
 Some applications will require not just a predetermined chain of calls to LLMs/other tools,
-but potentially an unknown chain that depends on the user's input.
+but potentially an unknown chain that depends on the user 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.
 
 The following sections of documentation are provided:
 
-- `Getting Started <./agents/getting_started.html>`_: A notebook to help you get started working with agents as quickly as possible.
+- `Getting Started <agents/getting_started.html>`_: A notebook to help you get started working with agents as quickly as possible.
 
-- `Key Concepts <./agents/key_concepts.html>`_: A conceptual guide going over the various concepts related to agents.
+- `Key Concepts <agents/key_concepts.html>`_: A conceptual guide going over the various concepts related to agents.
 
-- `How-To Guides <./agents/how_to_guides.html>`_: A collection of how-to guides. These highlight how to integrate various types of tools, how to work with different types of agents, and how to customize agents.
+- `How-To Guides <agents/how_to_guides.html>`_: A collection of how-to guides. These highlight how to integrate various types of tools, how to work with different types of agent, and how to customize agents.
 
-- `Reference <../reference/modules/agents.html>`_: API reference documentation for all Agent classes.
+- `Reference </reference/modules/agents.html>`_: API reference documentation for all Agent classes.
 
 
 
@@ -24,7 +24,7 @@ The following sections of documentation are provided:
    :name: Agents
    :hidden:
 
-   ./agents/getting_started.ipynb
-   ./agents/key_concepts.md
-   ./agents/how_to_guides.rst
-   Reference<../reference/modules/agents.rst>
+   agents/getting_started.ipynb
+   agents/key_concepts.md
+   agents/how_to_guides.rst
+   Reference</reference/modules/agents.rst>

docs/modules/agents/agents.md

@@ -1,7 +1,7 @@
 # Agents
 
 Agents use an LLM to determine which actions to take and in what order.
-An action can either be using a tool and observing its output, or returning a response to the user.
+An action can either be using a tool and observing its output, or returning to the user.
 For a list of easily loadable tools, see [here](tools.md).
 Here are the agents available in LangChain.
 
@@ -28,9 +28,3 @@ This agent utilizes a single tool that should be named `Intermediate Answer`.
 This tool should be able to lookup factual answers to questions. This agent
 is equivalent to the original [self ask with search paper](https://ofir.io/self-ask.pdf),
 where a Google search API was provided as the tool.
-
-### `conversational-react-description`
-
-This agent is designed to be used in conversational settings.
-The prompt is designed to make the agent helpful and conversational.
-It uses the ReAct framework to decide which tool to use, and uses memory to remember the previous conversation interactions.

docs/modules/agents/examples/agent_vectorstore.ipynb

@@ -1,494 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "68b24990",
-   "metadata": {},
-   "source": [
-    "# Agents and Vectorstores\n",
-    "\n",
-    "This notebook covers how to combine agents and vectorstores. The use case for this is that you've ingested your data into a vectorstore and want to interact with it in an agentic manner.\n",
-    "\n",
-    "The reccomended method for doing so is to create a VectorDBQAChain and then use that as a tool in the overall agent. Let's take a look at doing this below. You can do this with multiple different vectordbs, and use the agent as a way to route between them. There are two different ways of doing this - you can either let the agent use the vectorstores as normal tools, or you can set `return_direct=True` to really just use the agent as a router."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "9b22020a",
-   "metadata": {},
-   "source": [
-    "## Create the Vectorstore"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 20,
-   "id": "2e87c10a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.embeddings.openai import OpenAIEmbeddings\n",
-    "from langchain.vectorstores import Chroma\n",
-    "from langchain.text_splitter import CharacterTextSplitter\n",
-    "from langchain import OpenAI, VectorDBQA\n",
-    "llm = OpenAI(temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 37,
-   "id": "f2675861",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Running Chroma using direct local API.\n",
-      "Using DuckDB in-memory for database. Data will be transient.\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain.document_loaders import TextLoader\n",
-    "loader = TextLoader('../../state_of_the_union.txt')\n",
-    "documents = loader.load()\n",
-    "text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)\n",
-    "texts = text_splitter.split_documents(documents)\n",
-    "\n",
-    "embeddings = OpenAIEmbeddings()\n",
-    "docsearch = Chroma.from_documents(texts, embeddings, collection_name=\"state-of-union\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 38,
-   "id": "bc5403d4",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "state_of_union = VectorDBQA.from_chain_type(llm=llm, chain_type=\"stuff\", vectorstore=docsearch)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 39,
-   "id": "1431cded",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.document_loaders import WebBaseLoader"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 40,
-   "id": "915d3ff3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "loader = WebBaseLoader(\"https://beta.ruff.rs/docs/faq/\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 41,
-   "id": "96a2edf8",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Running Chroma using direct local API.\n",
-      "Using DuckDB in-memory for database. Data will be transient.\n"
-     ]
-    }
-   ],
-   "source": [
-    "docs = loader.load()\n",
-    "ruff_texts = text_splitter.split_documents(docs)\n",
-    "ruff_db = Chroma.from_documents(ruff_texts, embeddings, collection_name=\"ruff\")\n",
-    "ruff = VectorDBQA.from_chain_type(llm=llm, chain_type=\"stuff\", vectorstore=ruff_db)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "71ecef90",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  },
-  {
-   "cell_type": "markdown",
-   "id": "c0a6c031",
-   "metadata": {},
-   "source": [
-    "## Create the Agent"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 43,
-   "id": "eb142786",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Import things that are needed generically\n",
-    "from langchain.agents import initialize_agent, Tool\n",
-    "from langchain.tools import BaseTool\n",
-    "from langchain.llms import OpenAI\n",
-    "from langchain import LLMMathChain, SerpAPIWrapper"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 44,
-   "id": "850bc4e9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = [\n",
-    "    Tool(\n",
-    "        name = \"State of Union QA System\",\n",
-    "        func=state_of_union.run,\n",
-    "        description=\"useful for when you need to answer questions about the most recent state of the union address. Input should be a fully formed question.\"\n",
-    "    ),\n",
-    "    Tool(\n",
-    "        name = \"Ruff QA System\",\n",
-    "        func=ruff.run,\n",
-    "        description=\"useful for when you need to answer questions about ruff (a python linter). Input should be a fully formed question.\"\n",
-    "    ),\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 45,
-   "id": "fc47f230",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Construct the agent. We will use the default agent type here.\n",
-    "# See documentation for a full list of options.\n",
-    "agent = initialize_agent(tools, llm, agent=\"zero-shot-react-description\", verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 46,
-   "id": "10ca2db8",
-   "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 I need to find out what Biden said about Ketanji Brown Jackson in the State of the Union address.\n",
-      "Action: State of Union QA System\n",
-      "Action Input: What did Biden say about Ketanji Brown Jackson in the State of the Union address?\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3m Biden said that Jackson is one of the nation's top legal minds and that she will continue Justice Breyer's legacy of excellence.\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Biden said that Jackson is one of the nation's top legal minds and that she will continue Justice Breyer's legacy of excellence.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "\"Biden said that Jackson is one of the nation's top legal minds and that she will continue Justice Breyer's legacy of excellence.\""
-      ]
-     },
-     "execution_count": 46,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"What did biden say about ketanji brown jackson is the state of the union address?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 47,
-   "id": "4e91b811",
-   "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 I need to find out the advantages of using ruff over flake8\n",
-      "Action: Ruff QA System\n",
-      "Action Input: What are the advantages of using ruff over flake8?\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m Ruff can be used as a drop-in replacement for Flake8 when used (1) without or with a small number of plugins, (2) alongside Black, and (3) on Python 3 code. It also re-implements some of the most popular Flake8 plugins and related code quality tools natively, including isort, yesqa, eradicate, and most of the rules implemented in pyupgrade. Ruff also supports automatically fixing its own lint violations, which Flake8 does not.\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Ruff can be used as a drop-in replacement for Flake8 when used (1) without or with a small number of plugins, (2) alongside Black, and (3) on Python 3 code. It also re-implements some of the most popular Flake8 plugins and related code quality tools natively, including isort, yesqa, eradicate, and most of the rules implemented in pyupgrade. Ruff also supports automatically fixing its own lint violations, which Flake8 does not.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Ruff can be used as a drop-in replacement for Flake8 when used (1) without or with a small number of plugins, (2) alongside Black, and (3) on Python 3 code. It also re-implements some of the most popular Flake8 plugins and related code quality tools natively, including isort, yesqa, eradicate, and most of the rules implemented in pyupgrade. Ruff also supports automatically fixing its own lint violations, which Flake8 does not.'"
-      ]
-     },
-     "execution_count": 47,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"Why use ruff over flake8?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "787a9b5e",
-   "metadata": {},
-   "source": [
-    "## Use the Agent solely as a router"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "9161ba91",
-   "metadata": {},
-   "source": [
-    "You can also set `return_direct=True` if you intend to use the agent as a router and just want to directly return the result of the VectorDBQaChain.\n",
-    "\n",
-    "Notice that in the above examples the agent did some extra work after querying the VectorDBQAChain. You can avoid that and just return the result directly."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 48,
-   "id": "f59b377e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = [\n",
-    "    Tool(\n",
-    "        name = \"State of Union QA System\",\n",
-    "        func=state_of_union.run,\n",
-    "        description=\"useful for when you need to answer questions about the most recent state of the union address. Input should be a fully formed question.\",\n",
-    "        return_direct=True\n",
-    "    ),\n",
-    "    Tool(\n",
-    "        name = \"Ruff QA System\",\n",
-    "        func=ruff.run,\n",
-    "        description=\"useful for when you need to answer questions about ruff (a python linter). Input should be a fully formed question.\",\n",
-    "        return_direct=True\n",
-    "    ),\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 49,
-   "id": "8615707a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = initialize_agent(tools, llm, agent=\"zero-shot-react-description\", verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 50,
-   "id": "36e718a9",
-   "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 I need to find out what Biden said about Ketanji Brown Jackson in the State of the Union address.\n",
-      "Action: State of Union QA System\n",
-      "Action Input: What did Biden say about Ketanji Brown Jackson in the State of the Union address?\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3m Biden said that Jackson is one of the nation's top legal minds and that she will continue Justice Breyer's legacy of excellence.\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "\" Biden said that Jackson is one of the nation's top legal minds and that she will continue Justice Breyer's legacy of excellence.\""
-      ]
-     },
-     "execution_count": 50,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"What did biden say about ketanji brown jackson in the state of the union address?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 51,
-   "id": "edfd0a1a",
-   "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 I need to find out the advantages of using ruff over flake8\n",
-      "Action: Ruff QA System\n",
-      "Action Input: What are the advantages of using ruff over flake8?\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m Ruff can be used as a drop-in replacement for Flake8 when used (1) without or with a small number of plugins, (2) alongside Black, and (3) on Python 3 code. It also re-implements some of the most popular Flake8 plugins and related code quality tools natively, including isort, yesqa, eradicate, and most of the rules implemented in pyupgrade. Ruff also supports automatically fixing its own lint violations, which Flake8 does not.\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' Ruff can be used as a drop-in replacement for Flake8 when used (1) without or with a small number of plugins, (2) alongside Black, and (3) on Python 3 code. It also re-implements some of the most popular Flake8 plugins and related code quality tools natively, including isort, yesqa, eradicate, and most of the rules implemented in pyupgrade. Ruff also supports automatically fixing its own lint violations, which Flake8 does not.'"
-      ]
-     },
-     "execution_count": 51,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"Why use ruff over flake8?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "49a0cbbe",
-   "metadata": {},
-   "source": [
-    "## Multi-Hop vectorstore reasoning\n",
-    "\n",
-    "Because vectorstores are easily usable as tools in agents, it is easy to use answer multi-hop questions that depend on vectorstores using the existing agent framework"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 57,
-   "id": "d397a233",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = [\n",
-    "    Tool(\n",
-    "        name = \"State of Union QA System\",\n",
-    "        func=state_of_union.run,\n",
-    "        description=\"useful for when you need to answer questions about the most recent state of the union address. Input should be a fully formed question, not referencing any obscure pronouns from the conversation before.\"\n",
-    "    ),\n",
-    "    Tool(\n",
-    "        name = \"Ruff QA System\",\n",
-    "        func=ruff.run,\n",
-    "        description=\"useful for when you need to answer questions about ruff (a python linter). Input should be a fully formed question, not referencing any obscure pronouns from the conversation before.\"\n",
-    "    ),\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 58,
-   "id": "06157240",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Construct the agent. We will use the default agent type here.\n",
-    "# See documentation for a full list of options.\n",
-    "agent = initialize_agent(tools, llm, agent=\"zero-shot-react-description\", verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 59,
-   "id": "b492b520",
-   "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 I need to find out what tool ruff uses to run over Jupyter Notebooks, and if the president mentioned it in the state of the union.\n",
-      "Action: Ruff QA System\n",
-      "Action Input: What tool does ruff use to run over Jupyter Notebooks?\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m Ruff is integrated into nbQA, a tool for running linters and code formatters over Jupyter Notebooks. After installing ruff and nbqa, you can run Ruff over a notebook like so: > nbqa ruff Untitled.ipynb\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now need to find out if the president mentioned this tool in the state of the union.\n",
-      "Action: State of Union QA System\n",
-      "Action Input: Did the president mention nbQA in the state of the union?\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3m No, the president did not mention nbQA in the state of the union.\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer.\n",
-      "Final Answer: No, the president did not mention nbQA in the state of the union.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'No, the president did not mention nbQA in the state of the union.'"
-      ]
-     },
-     "execution_count": 59,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"What tool does ruff use to run over Jupyter Notebooks? Did the president mention that tool in the state of the union?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "b3b857d6",
-   "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.9.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

docs/modules/agents/examples/async_agent.ipynb

@@ -1,411 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "6fb92deb-d89e-439b-855d-c7f2607d794b",
-   "metadata": {},
-   "source": [
-    "# Async API for Agent\n",
-    "\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",
-    "\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",
-    "\n",
-    "You can use `arun` to call an `AgentExecutor` asynchronously."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "97800378-cc34-4283-9bd0-43f336bc914c",
-   "metadata": {},
-   "source": [
-    "## Serial vs. Concurrent Execution\n",
-    "\n",
-    "In this example, we kick off agents to answer some questions serially vs. concurrently. You can see that concurrent execution significantly speeds this up."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "da5df06c-af6f-4572-b9f5-0ab971c16487",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "import asyncio\n",
-    "import time\n",
-    "\n",
-    "from langchain.agents import initialize_agent, load_tools\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",
-    "questions = [\n",
-    "    \"Who won the US Open men's final in 2019? What is his age raised to the 0.334 power?\",\n",
-    "    \"Who is Olivia Wilde's boyfriend? What is his current age raised to the 0.23 power?\",\n",
-    "    \"Who won the most recent formula 1 grand prix? What is their age raised to the 0.23 power?\",\n",
-    "    \"Who won the US Open women's final in 2019? What is her age raised to the 0.34 power?\",\n",
-    "    \"Who is Beyonce's husband? What is his age raised to the 0.19 power?\"\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "fd4c294e-b1d6-44b8-b32e-2765c017e503",
-   "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",
-      "\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",
-      "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",
-      "\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",
-      "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",
-      "\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",
-      "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",
-      "\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",
-      "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",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "Serial executed in 65.11 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=\"zero-shot-react-description\", verbose=True\n",
-    "        )\n",
-    "        agent.run(q)\n",
-    "\n",
-    "s = time.perf_counter()\n",
-    "generate_serially()\n",
-    "elapsed = time.perf_counter() - s\n",
-    "print(f\"Serial executed in {elapsed:0.2f} seconds.\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "076d7b85-45ec-465d-8b31-c2ad119c3438",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\n",
-      "\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",
-      "Thought:\n",
-      "Observation: \u001b[33;1m\u001b[1;3mMax Verstappen\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",
-      "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",
-      "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",
-      "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",
-      "\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",
-      "\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",
-      "\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"
-     ]
-    }
-   ],
-   "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=\"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",
-    "\n",
-    "s = time.perf_counter()\n",
-    "# If running this outside of Jupyter, use asyncio.run(generate_concurrently())\n",
-    "await generate_concurrently()\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=\"zero-shot-react-description\", verbose=True, callback_manager=manager)\n",
-    "await async_agent.arun(questions[0])\n",
-    "await aiosession.close()"
-   ]
-  }
- ],
- "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.9.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

docs/modules/agents/examples/custom_agent.ipynb

@@ -42,7 +42,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 23,
+   "execution_count": 1,
    "id": "9af9734e",
    "metadata": {},
    "outputs": [],
@@ -53,7 +53,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 24,
+   "execution_count": 5,
    "id": "becda2a1",
    "metadata": {},
    "outputs": [],
@@ -70,7 +70,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 25,
+   "execution_count": 6,
    "id": "339b1bb8",
    "metadata": {},
    "outputs": [],
@@ -99,7 +99,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 26,
+   "execution_count": 7,
    "id": "e21d2098",
    "metadata": {},
    "outputs": [
@@ -133,19 +133,9 @@
     "print(prompt.template)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "5e028e6d",
-   "metadata": {},
-   "source": [
-    "Note that we are able to feed agents a self-defined prompt template, i.e. not restricted to the prompt generated by the `create_prompt` function, assuming it meets the agent's requirements. \n",
-    "\n",
-    "For example, for `ZeroShotAgent`, we will need to ensure that it meets the following requirements. There should a string starting with \"Action:\" and a following string starting with \"Action Input:\", and both should be separated by a newline.\n"
-   ]
-  },
   {
    "cell_type": "code",
-   "execution_count": 27,
+   "execution_count": 16,
    "id": "9b1cc2a2",
    "metadata": {},
    "outputs": [],
@@ -155,18 +145,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 28,
+   "execution_count": 17,
    "id": "e4f5092f",
    "metadata": {},
    "outputs": [],
    "source": [
-    "tool_names = [tool.name for tool in tools]\n",
-    "agent = ZeroShotAgent(llm_chain=llm_chain, allowed_tools=tool_names)"
+    "agent = ZeroShotAgent(llm_chain=llm_chain, tools=tools)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 29,
+   "execution_count": 18,
    "id": "490604e9",
    "metadata": {},
    "outputs": [],
@@ -176,7 +165,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 31,
+   "execution_count": 19,
    "id": "653b1617",
    "metadata": {},
    "outputs": [
@@ -187,29 +176,32 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: I need to find out the population of Canada\n",
+      "\u001b[32;1m\u001b[1;3mThought: I need to find out how many people live in Canada\n",
       "Action: Search\n",
-      "Action Input: Population of Canada 2023\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mThe current population of Canada is 38,610,447 as of Saturday, February 18, 2023, based on Worldometer elaboration of the latest United Nations data. Canada 2020 population is estimated at 37,742,154 people at mid year according to UN data.\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Arrr, Canada be havin' 38,610,447 scallywags livin' there as of 2023!\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Action Input: Population of Canada\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mCanada is a country in North America. Its ten provinces and three territories extend from the Atlantic Ocean to the Pacific Ocean and northward into the Arctic Ocean, covering over 9.98 million square kilometres, making it the world's second-largest country by total area.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to find out the exact population of Canada\n",
+      "Action: Search\n",
+      "Action Input: Population of Canada 2020\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mCanada is a country in North America. Its ten provinces and three territories extend from the Atlantic Ocean to the Pacific Ocean and northward into the Arctic Ocean, covering over 9.98 million square kilometres, making it the world's second-largest country by total area.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the population of Canada\n",
+      "Final Answer: Arrr, Canada be home to 37.59 million people!\u001b[0m\n",
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "\"Arrr, Canada be havin' 38,610,447 scallywags livin' there as of 2023!\""
+       "'Arrr, Canada be home to 37.59 million people!'"
       ]
      },
-     "execution_count": 31,
+     "execution_count": 19,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "agent_executor.run(\"How many people live in canada as of 2023?\")"
+    "agent_executor.run(\"How many people live in canada?\")"
    ]
   },
   {
@@ -223,7 +215,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 32,
+   "execution_count": 20,
    "id": "43dbfa2f",
    "metadata": {},
    "outputs": [],
@@ -244,7 +236,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 33,
+   "execution_count": 21,
    "id": "0f087313",
    "metadata": {},
    "outputs": [],
@@ -254,7 +246,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 34,
+   "execution_count": 22,
    "id": "92c75a10",
    "metadata": {},
    "outputs": [],
@@ -264,7 +256,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 35,
+   "execution_count": 23,
    "id": "ac5b83bf",
    "metadata": {},
    "outputs": [],
@@ -274,7 +266,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 36,
+   "execution_count": 24,
    "id": "c960e4ff",
    "metadata": {},
    "outputs": [
@@ -285,29 +277,56 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: I need to find out the population of Canada in 2023.\n",
+      "\u001b[32;1m\u001b[1;3mThought: I should look up the population of Canada.\n",
       "Action: Search\n",
-      "Action Input: Population of Canada in 2023\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mThe current population of Canada is 38,610,447 as of Saturday, February 18, 2023, based on Worldometer elaboration of the latest United Nations data. Canada 2020 population is estimated at 37,742,154 people at mid year according to UN data.\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer.\n",
-      "Final Answer: La popolazione del Canada nel 2023 è stimata in 38.610.447 persone.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Action Input: Population of Canada\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mCanada is a country in North America. Its ten provinces and three territories extend from the Atlantic Ocean to the Pacific Ocean and northward into the Arctic Ocean, covering over 9.98 million square kilometres, making it the world's second-largest country by total area.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should look for the population of Canada.\n",
+      "Action: Search\n",
+      "Action Input: Population of Canada\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mCanada is a country in North America. Its ten provinces and three territories extend from the Atlantic Ocean to the Pacific Ocean and northward into the Arctic Ocean, covering over 9.98 million square kilometres, making it the world's second-largest country by total area.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should look for the population of Canada.\n",
+      "Action: Search\n",
+      "Action Input: Population of Canada\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mCanada is a country in North America. Its ten provinces and three territories extend from the Atlantic Ocean to the Pacific Ocean and northward into the Arctic Ocean, covering over 9.98 million square kilometres, making it the world's second-largest country by total area.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should look for the population of Canada.\n",
+      "Action: Search\n",
+      "Action Input: Population of Canada\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mCanada is a country in North America. Its ten provinces and three territories extend from the Atlantic Ocean to the Pacific Ocean and northward into the Arctic Ocean, covering over 9.98 million square kilometres, making it the world's second-largest country by total area.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should look for the population of Canada.\n",
+      "Action: Search\n",
+      "Action Input: Population of Canada\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mCanada is a country in North America. Its ten provinces and three territories extend from the Atlantic Ocean to the Pacific Ocean and northward into the Arctic Ocean, covering over 9.98 million square kilometres, making it the world's second-largest country by total area.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should look for the population of Canada.\n",
+      "Action: Search\n",
+      "Action Input: Population of Canada\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mCanada is a country in North America. Its ten provinces and three territories extend from the Atlantic Ocean to the Pacific Ocean and northward into the Arctic Ocean, covering over 9.98 million square kilometres, making it the world's second-largest country by total area.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should look for the population of Canada.\n",
+      "Action: Search\n",
+      "Action Input: Population of Canada\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mCanada is a country in North America. Its ten provinces and three territories extend from the Atlantic Ocean to the Pacific Ocean and northward into the Arctic Ocean, covering over 9.98 million square kilometres, making it the world's second-largest country by total area.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should look for the population of Canada.\n",
+      "Action: Search\n",
+      "Action Input: Population of Canada\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mCanada is a country in North America. Its ten provinces and three territories extend from the Atlantic Ocean to the Pacific Ocean and northward into the Arctic Ocean, covering over 9.98 million square kilometres, making it the world's second-largest country by total area.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the population of Canada.\n",
+      "Final Answer: La popolazione del Canada è di circa 37 milioni di persone.\u001b[0m\n",
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "'La popolazione del Canada nel 2023 è stimata in 38.610.447 persone.'"
+       "'La popolazione del Canada è di circa 37 milioni di persone.'"
       ]
      },
-     "execution_count": 36,
+     "execution_count": 24,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "agent_executor.run(input=\"How many people live in canada as of 2023?\", language=\"italian\")"
+    "agent_executor.run(input=\"How many people live in canada?\", language=\"italian\")"
    ]
   },
   {
@@ -331,7 +350,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3.9.0 64-bit ('llm-env')",
    "language": "python",
    "name": "python3"
   },
@@ -345,11 +364,11 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.9.0"
   },
   "vscode": {
    "interpreter": {
-    "hash": "18784188d7ecd866c0586ac068b02361a6896dc3a29b64f5cc957f09c590acef"
+    "hash": "b1677b440931f40d89ef8be7bf03acb108ce003de0ac9b18e8d43753ea2e7103"
    }
   }
  },

docs/modules/agents/examples/custom_tools.ipynb

@@ -7,27 +7,29 @@
    "source": [
     "# Defining Custom Tools\n",
     "\n",
-    "When constructing your own agent, you will need to provide it with a list of Tools that it can use. Besides the actual function that is called, the Tool consists of several components:\n",
+    "When constructing your own agent, you will need to provide it with a list of Tools that it can use. A Tool is defined as below.\n",
     "\n",
-    "- name (str), is required\n",
-    "- description (str), is optional\n",
-    "- return_direct (bool), defaults to False\n",
+    "```python\n",
+    "class Tool(NamedTuple):\n",
+    "    \"\"\"Interface for tools.\"\"\"\n",
     "\n",
-    "The function that should be called when the tool is selected should take as input a single string and return a single string.\n",
+    "    name: str\n",
+    "    func: Callable[[str], str]\n",
+    "    description: Optional[str] = None\n",
+    "```\n",
     "\n",
-    "There are two ways to define a tool, we will cover both in the example below."
+    "The two required components of a Tool are the name and then the tool itself. A tool description is optional, as it is needed for some agents but not all."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 1,
    "id": "1aaba18c",
    "metadata": {},
    "outputs": [],
    "source": [
     "# Import things that are needed generically\n",
     "from langchain.agents import initialize_agent, Tool\n",
-    "from langchain.tools import BaseTool\n",
     "from langchain.llms import OpenAI\n",
     "from langchain import LLMMathChain, SerpAPIWrapper"
    ]
@@ -42,7 +44,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "id": "36ed392e",
    "metadata": {},
    "outputs": [],
@@ -55,23 +57,13 @@
    "id": "f8bc72c2",
    "metadata": {},
    "source": [
-    "## Completely New Tools \n",
-    "First, we show how to create completely new tools from scratch.\n",
-    "\n",
-    "There are two ways to do this: either by using the Tool dataclass, or by subclassing the BaseTool class."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "b63fcc3b",
-   "metadata": {},
-   "source": [
-    "### Tool dataclass"
+    "## Completely New Tools\n",
+    "First, we show how to create completely new tools from scratch."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 5,
    "id": "56ff7670",
    "metadata": {},
    "outputs": [],
@@ -95,19 +87,20 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 6,
    "id": "5b93047d",
    "metadata": {},
    "outputs": [],
    "source": [
     "# Construct the agent. We will use the default agent type here.\n",
     "# See documentation for a full list of options.\n",
+    "llm = OpenAI(temperature=0)\n",
     "agent = initialize_agent(tools, llm, agent=\"zero-shot-react-description\", verbose=True)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 7,
    "id": "6f96a891",
    "metadata": {},
    "outputs": [
@@ -118,240 +111,36 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who Leo DiCaprio's girlfriend is and then calculate her age raised to the 0.43 power.\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: \"Leo DiCaprio girlfriend\"\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mCamila Morrone\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now need to calculate her age raised to the 0.43 power\n",
+      "Action Input: Olivia Wilde's boyfriend\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mHarry Styles\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate Harry Styles' age raised to the 0.23 power.\n",
       "Action: Calculator\n",
-      "Action Input: 22^0.43\u001b[0m\n",
+      "Action Input: 23^0.23\u001b[0m\n",
       "\n",
       "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\n",
-      "22^0.43\u001b[32;1m\u001b[1;3m\n",
+      "23^0.23\u001b[32;1m\u001b[1;3m\n",
       "```python\n",
       "import math\n",
-      "print(math.pow(22, 0.43))\n",
+      "print(math.pow(23, 0.23))\n",
       "```\n",
       "\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m3.777824273683966\n",
+      "Answer: \u001b[33;1m\u001b[1;3m2.0568252837687546\n",
       "\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\u001b[1m> Finished LLMMathChain chain.\u001b[0m\n",
       "\n",
-      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 3.777824273683966\n",
+      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 2.0568252837687546\n",
       "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Camila Morrone's age raised to the 0.43 power is 3.777824273683966.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer.\n",
+      "Final Answer: Harry Styles' age raised to the 0.23 power is 2.0568252837687546.\u001b[0m\n",
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "\"Camila Morrone's age raised to the 0.43 power is 3.777824273683966.\""
-      ]
-     },
-     "execution_count": 5,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"Who is Leo DiCaprio's girlfriend? What is her current age raised to the 0.43 power?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "6f12eaf0",
-   "metadata": {},
-   "source": [
-    "### Subclassing the BaseTool class"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "c58a7c40",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class CustomSearchTool(BaseTool):\n",
-    "    name = \"Search\"\n",
-    "    description = \"useful for when you need to answer questions about current events\"\n",
-    "\n",
-    "    def _run(self, query: str) -> str:\n",
-    "        \"\"\"Use the tool.\"\"\"\n",
-    "        return search.run(query)\n",
-    "    \n",
-    "    async def _arun(self, query: str) -> str:\n",
-    "        \"\"\"Use the tool asynchronously.\"\"\"\n",
-    "        raise NotImplementedError(\"BingSearchRun 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",
-    "\n",
-    "    def _run(self, query: str) -> str:\n",
-    "        \"\"\"Use the tool.\"\"\"\n",
-    "        return llm_math_chain.run(query)\n",
-    "    \n",
-    "    async def _arun(self, query: str) -> str:\n",
-    "        \"\"\"Use the tool asynchronously.\"\"\"\n",
-    "        raise NotImplementedError(\"BingSearchRun does not support async\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "3318a46f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = [CustomSearchTool(), CustomCalculatorTool()]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "ee2d0f3a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = initialize_agent(tools, llm, agent=\"zero-shot-react-description\", verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "6a2cebbf",
-   "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 I need to find out who Leo DiCaprio's girlfriend is and then calculate her age raised to the 0.43 power.\n",
-      "Action: Search\n",
-      "Action Input: \"Leo DiCaprio girlfriend\"\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mCamila Morrone\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now need to calculate her age raised to the 0.43 power\n",
-      "Action: Calculator\n",
-      "Action Input: 22^0.43\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\n",
-      "22^0.43\u001b[32;1m\u001b[1;3m\n",
-      "```python\n",
-      "import math\n",
-      "print(math.pow(22, 0.43))\n",
-      "```\n",
-      "\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m3.777824273683966\n",
-      "\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\n",
-      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 3.777824273683966\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Camila Morrone's age raised to the 0.43 power is 3.777824273683966.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "\"Camila Morrone's age raised to the 0.43 power is 3.777824273683966.\""
-      ]
-     },
-     "execution_count": 11,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"Who is Leo DiCaprio's girlfriend? What is her current age raised to the 0.43 power?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "824eaf74",
-   "metadata": {},
-   "source": [
-    "## Using the `tool` decorator\n",
-    "\n",
-    "To make it easier to define custom tools, a `@tool` decorator is provided. This decorator can be used to quickly create a `Tool` from a simple function. The decorator uses the function name as the tool name by default, but this can be overridden by passing a string as the first argument. Additionally, the decorator will use the function's docstring as the tool's description."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "8f15307d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import tool\n",
-    "\n",
-    "@tool\n",
-    "def search_api(query: str) -> str:\n",
-    "    \"\"\"Searches the API for the query.\"\"\"\n",
-    "    return \"Results\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "0a23b91b",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "Tool(name='search_api', description='search_api(query: str) -> str - Searches the API for the query.', return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1184e0cd0>, func=<function search_api at 0x1635f8700>, coroutine=None)"
-      ]
-     },
-     "execution_count": 5,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "search_api"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "cc6ee8c1",
-   "metadata": {},
-   "source": [
-    "You can also provide arguments like the tool name and whether to return directly."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "28cdf04d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "@tool(\"search\", return_direct=True)\n",
-    "def search_api(query: str) -> str:\n",
-    "    \"\"\"Searches the API for the query.\"\"\"\n",
-    "    return \"Results\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "1085a4bd",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "Tool(name='search', description='search(query: str) -> str - Searches the API for the query.', return_direct=True, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x1184e0cd0>, func=<function search_api at 0x1635f8670>, coroutine=None)"
+       "\"Harry Styles' age raised to the 0.23 power is 2.0568252837687546.\""
       ]
      },
      "execution_count": 7,
@@ -360,7 +149,7 @@
     }
    ],
    "source": [
-    "search_api"
+    "agent.run(\"Who is Olivia Wilde's boyfriend? What is his current age raised to the 0.23 power?\")"
    ]
   },
   {
@@ -426,29 +215,28 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who Leo DiCaprio's girlfriend is and then calculate her age raised to the 0.43 power.\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 Search\n",
-      "Action Input: \"Leo DiCaprio girlfriend\"\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mCamila Morrone\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Camila Morrone's age\n",
+      "Action Input: \"Olivia Wilde boyfriend\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mHarry Styles\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Harry Styles' age\n",
       "Action: Google 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;3m I need to calculate 25 raised to the 0.43 power\n",
+      "Action Input: \"Harry Styles age\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m28 years\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate 28 raised to the 0.23 power\n",
       "Action: Calculator\n",
-      "Action Input: 25^0.43\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 3.991298452658078\n",
+      "Action Input: 28^0.23\u001b[0m\n",
+      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 2.1520202182226886\n",
       "\u001b[0m\n",
       "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Camila Morrone is Leo DiCaprio's girlfriend and her current age raised to the 0.43 power is 3.991298452658078.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Final Answer: Harry Styles is Olivia Wilde's boyfriend and his current age raised to the 0.23 power is 2.1520202182226886.\u001b[0m\n",
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "\"Camila Morrone is Leo DiCaprio's girlfriend and her current age raised to the 0.43 power is 3.991298452658078.\""
+       "\"Harry Styles is Olivia Wilde's boyfriend and his current age raised to the 0.23 power is 2.1520202182226886.\""
       ]
      },
      "execution_count": 12,
@@ -457,169 +245,13 @@
     }
    ],
    "source": [
-    "agent.run(\"Who is Leo DiCaprio's girlfriend? What is her current age raised to the 0.43 power?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "376813ed",
-   "metadata": {},
-   "source": [
-    "## Defining the priorities among Tools\n",
-    "When you made a Custom tool, you may want the Agent to use the custom tool more than normal tools.\n",
-    "\n",
-    "For example, you made a custom tool, which gets information on music from your database. When a user wants information on songs, You want the Agent to use  `the custom tool` more than the normal `Search tool`. But the Agent might prioritize a normal Search tool.\n",
-    "\n",
-    "This can be accomplished by adding a statement such as `Use this more than the normal search if the question is about Music, like 'who is the singer of yesterday?' or 'what is the most popular song in 2022?'` to the description.\n",
-    "\n",
-    "An example is below."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "3450512e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Import things that are needed generically\n",
-    "from langchain.agents import initialize_agent, Tool\n",
-    "from langchain.llms import OpenAI\n",
-    "from langchain import LLMMathChain, SerpAPIWrapper\n",
-    "search = SerpAPIWrapper()\n",
-    "tools = [\n",
-    "    Tool(\n",
-    "        name = \"Search\",\n",
-    "        func=search.run,\n",
-    "        description=\"useful for when you need to answer questions about current events\"\n",
-    "    ),\n",
-    "    Tool(\n",
-    "        name=\"Music Search\",\n",
-    "        func=lambda x: \"'All I Want For Christmas Is You' by Mariah Carey.\", #Mock Function\n",
-    "        description=\"A Music search engine. Use this more than the normal search if the question is about Music, like 'who is the singer of yesterday?' or 'what is the most popular song in 2022?'\",\n",
-    "    )\n",
-    "]\n",
-    "\n",
-    "agent = initialize_agent(tools, OpenAI(temperature=0), agent=\"zero-shot-react-description\", verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "4b9a7849",
-   "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 I should use a music search engine to find the answer\n",
-      "Action: Music Search\n",
-      "Action Input: most famous song of christmas\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3m'All I Want For Christmas Is You' by Mariah Carey.\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: 'All I Want For Christmas Is You' by Mariah Carey.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "\"'All I Want For Christmas Is You' by Mariah Carey.\""
-      ]
-     },
-     "execution_count": 14,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"what is the most famous song of christmas\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "bc477d43",
-   "metadata": {},
-   "source": [
-    "## Using tools to return directly\n",
-    "Often, it can be desirable to have a tool output returned directly to the user, if it’s called. You can do this easily with LangChain by setting the return_direct flag for a tool to be True."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "3bb6185f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm_math_chain = LLMMathChain(llm=llm)\n",
-    "tools = [\n",
-    "    Tool(\n",
-    "        name=\"Calculator\",\n",
-    "        func=llm_math_chain.run,\n",
-    "        description=\"useful for when you need to answer questions about math\",\n",
-    "        return_direct=True\n",
-    "    )\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "113ddb84",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)\n",
-    "agent = initialize_agent(tools, llm, agent=\"zero-shot-react-description\", verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "582439a6",
-   "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 I need to calculate this\n",
-      "Action: Calculator\n",
-      "Action Input: 2**.12\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mAnswer: 1.2599210498948732\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Answer: 1.2599210498948732'"
-      ]
-     },
-     "execution_count": 17,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"whats 2**.12\")"
+    "agent.run(\"Who is Olivia Wilde's boyfriend? What is his current age raised to the 0.23 power?\")"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "537bc628",
+   "id": "3450512e",
    "metadata": {},
    "outputs": [],
    "source": []
@@ -627,7 +259,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3.9.0 64-bit ('llm-env')",
    "language": "python",
    "name": "python3"
   },
@@ -641,11 +273,11 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.9.0"
   },
   "vscode": {
    "interpreter": {
-    "hash": "e90c8aa204a57276aa905271aff2d11799d0acb3547adabc5892e639a5e45e34"
+    "hash": "b1677b440931f40d89ef8be7bf03acb108ce003de0ac9b18e8d43753ea2e7103"
    }
   }
  },

docs/modules/agents/examples/intermediate_steps.ipynb

@@ -32,7 +32,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "id": "36ed392e",
    "metadata": {},
    "outputs": [],
@@ -51,7 +51,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "id": "6abf3b08",
    "metadata": {},
    "outputs": [],
@@ -72,28 +72,23 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I should look up who Leo DiCaprio is dating\n",
+      "\u001b[32;1m\u001b[1;3m I should look up Olivia Wilde's boyfriend's age\n",
       "Action: Search\n",
-      "Action Input: \"Leo DiCaprio girlfriend\"\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mCamila Morrone\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I should look up how old Camila Morrone is\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;3m I should calculate what 25 years raised to the 0.43 power is\n",
+      "Action Input: \"Olivia Wilde's boyfriend's age\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m28 years\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should use the calculator to raise that number to the 0.23 power\n",
       "Action: Calculator\n",
-      "Action Input: 25^0.43\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 3.991298452658078\n",
+      "Action Input: 28^0.23\u001b[0m\n",
+      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 2.1520202182226886\n",
       "\u001b[0m\n",
       "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Camila Morrone is Leo DiCaprio's girlfriend and she is 3.991298452658078 years old.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Final Answer: 2.1520202182226886\u001b[0m\n",
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     }
    ],
    "source": [
-    "response = agent({\"input\":\"Who is Leo DiCaprio's girlfriend? What is her current age raised to the 0.43 power?\"})"
+    "response = agent({\"input\":\"How old is Olivia Wilde's boyfriend? What is that number raised to the 0.23 power?\"})"
    ]
   },
   {
@@ -106,7 +101,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "[(AgentAction(tool='Search', tool_input='Leo DiCaprio girlfriend', log=' I should look up who Leo DiCaprio is dating\\nAction: Search\\nAction Input: \"Leo DiCaprio girlfriend\"'), 'Camila Morrone'), (AgentAction(tool='Search', tool_input='Camila Morrone age', log=' I should look up how old Camila Morrone is\\nAction: Search\\nAction Input: \"Camila Morrone age\"'), '25 years'), (AgentAction(tool='Calculator', tool_input='25^0.43', log=' I should calculate what 25 years raised to the 0.43 power is\\nAction: Calculator\\nAction Input: 25^0.43'), 'Answer: 3.991298452658078\\n')]\n"
+      "[(AgentAction(tool='Search', tool_input=\"Olivia Wilde's boyfriend's age\", log=' I should look up Olivia Wilde\\'s boyfriend\\'s age\\nAction: Search\\nAction Input: \"Olivia Wilde\\'s boyfriend\\'s age\"'), '28 years'), (AgentAction(tool='Calculator', tool_input='28^0.23', log=' I should use the calculator to raise that number to the 0.23 power\\nAction: Calculator\\nAction Input: 28^0.23'), 'Answer: 2.1520202182226886\\n')]\n"
      ]
     }
    ],
@@ -129,26 +124,18 @@
       "  [\n",
       "    [\n",
       "      \"Search\",\n",
-      "      \"Leo DiCaprio girlfriend\",\n",
-      "      \" I should look up who Leo DiCaprio is dating\\nAction: Search\\nAction Input: \\\"Leo DiCaprio girlfriend\\\"\"\n",
+      "      \"Olivia Wilde's boyfriend's age\",\n",
+      "      \" I should look up Olivia Wilde's boyfriend's age\\nAction: Search\\nAction Input: \\\"Olivia Wilde's boyfriend's age\\\"\"\n",
       "    ],\n",
-      "    \"Camila Morrone\"\n",
-      "  ],\n",
-      "  [\n",
-      "    [\n",
-      "      \"Search\",\n",
-      "      \"Camila Morrone age\",\n",
-      "      \" I should look up how old Camila Morrone is\\nAction: Search\\nAction Input: \\\"Camila Morrone age\\\"\"\n",
-      "    ],\n",
-      "    \"25 years\"\n",
+      "    \"28 years\"\n",
       "  ],\n",
       "  [\n",
       "    [\n",
       "      \"Calculator\",\n",
-      "      \"25^0.43\",\n",
-      "      \" I should calculate what 25 years raised to the 0.43 power is\\nAction: Calculator\\nAction Input: 25^0.43\"\n",
+      "      \"28^0.23\",\n",
+      "      \" I should use the calculator to raise that number to the 0.23 power\\nAction: Calculator\\nAction Input: 28^0.23\"\n",
       "    ],\n",
-      "    \"Answer: 3.991298452658078\\n\"\n",
+      "    \"Answer: 2.1520202182226886\\n\"\n",
       "  ]\n",
       "]\n"
      ]
@@ -178,7 +165,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3.9.0 64-bit ('llm-env')",
    "language": "python",
    "name": "python3"
   },
@@ -192,7 +179,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.9.0"
   },
   "vscode": {
    "interpreter": {

docs/modules/agents/examples/load_from_hub.ipynb

@@ -1,130 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "991b1cc1",
-   "metadata": {},
-   "source": [
-    "# Loading from LangChainHub\n",
-    "\n",
-    "This notebook covers how to load agents from [LangChainHub](https://github.com/hwchase17/langchain-hub)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "bd4450a2",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "No `_type` key found, defaulting to `prompt`.\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m Yes.\n",
-      "Follow up: Who is the reigning men's U.S. Open champion?\u001b[0m\n",
-      "Intermediate answer: \u001b[36;1m\u001b[1;3m2016 · SUI · Stan Wawrinka ; 2017 · ESP · Rafael Nadal ; 2018 · SRB · Novak Djokovic ; 2019 · ESP · Rafael Nadal.\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mSo the reigning men's U.S. Open champion is Rafael Nadal.\n",
-      "Follow up: What is Rafael Nadal's hometown?\u001b[0m\n",
-      "Intermediate answer: \u001b[36;1m\u001b[1;3mIn 2016, he once again showed his deep ties to Mallorca and opened the Rafa Nadal Academy in his hometown of Manacor.\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mSo the final answer is: Manacor, Mallorca, Spain.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Manacor, Mallorca, Spain.'"
-      ]
-     },
-     "execution_count": 1,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from langchain import OpenAI, SerpAPIWrapper\n",
-    "from langchain.agents import initialize_agent, Tool\n",
-    "\n",
-    "llm = OpenAI(temperature=0)\n",
-    "search = SerpAPIWrapper()\n",
-    "tools = [\n",
-    "    Tool(\n",
-    "        name=\"Intermediate Answer\",\n",
-    "        func=search.run\n",
-    "    )\n",
-    "]\n",
-    "\n",
-    "self_ask_with_search = initialize_agent(tools, llm, agent_path=\"lc://agents/self-ask-with-search/agent.json\", verbose=True)\n",
-    "self_ask_with_search.run(\"What is the hometown of the reigning men's U.S. Open champion?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "3aede965",
-   "metadata": {},
-   "source": [
-    "# Pinning Dependencies\n",
-    "\n",
-    "Specific versions of LangChainHub agents can be pinned with the `lc@<ref>://` syntax."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "e679f7b6",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "No `_type` key found, defaulting to `prompt`.\n"
-     ]
-    }
-   ],
-   "source": [
-    "self_ask_with_search = initialize_agent(tools, llm, agent_path=\"lc@2826ef9e8acdf88465e1e5fc8a7bf59e0f9d0a85://agents/self-ask-with-search/agent.json\", verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9d3d6697",
-   "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.9.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

docs/modules/agents/examples/max_iterations.ipynb

@@ -82,7 +82,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "47653ac6",
+   "id": "ebde3ea6",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -99,7 +99,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 6,
    "id": "fca094af",
    "metadata": {},
    "outputs": [],
@@ -109,7 +109,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 7,
    "id": "0fd3ef0a",
    "metadata": {},
    "outputs": [
@@ -123,14 +123,13 @@
       "\u001b[32;1m\u001b[1;3m I need to use the Jester tool\n",
       "Action: Jester\n",
       "Action Input: foo\u001b[0m\n",
-      "Observation: foo is not a valid tool, try another one.\n",
-      "\u001b[32;1m\u001b[1;3m I should try Jester again\n",
+      "Observation: Jester is not a valid tool, try another one.\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should try again\n",
       "Action: Jester\n",
       "Action Input: foo\u001b[0m\n",
-      "Observation: foo is not a valid tool, try another one.\n",
-      "\u001b[32;1m\u001b[1;3m\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Observation: Jester is not a valid tool, try another one.\n",
+      "Thought:\n",
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     },
     {
@@ -139,7 +138,7 @@
        "'Agent stopped due to max iterations.'"
       ]
      },
-     "execution_count": 8,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -158,7 +157,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 8,
    "id": "3cc521bb",
    "metadata": {},
    "outputs": [],
@@ -168,7 +167,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 9,
    "id": "1618d316",
    "metadata": {},
    "outputs": [
@@ -182,24 +181,22 @@
       "\u001b[32;1m\u001b[1;3m I need to use the Jester tool\n",
       "Action: Jester\n",
       "Action Input: foo\u001b[0m\n",
-      "Observation: foo is not a valid tool, try another one.\n",
-      "\u001b[32;1m\u001b[1;3m I should try Jester again\n",
+      "Observation: Jester is not a valid tool, try another one.\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should try again\n",
       "Action: Jester\n",
       "Action Input: foo\u001b[0m\n",
-      "Observation: foo is not a valid tool, try another one.\n",
-      "\u001b[32;1m\u001b[1;3m\n",
-      "Final Answer: Jester is the tool to use for this question.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Observation: Jester is not a valid tool, try another one.\n",
+      "Thought:\n",
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "'Jester is the tool to use for this question.'"
+       "'Jester is not a valid tool, try another one.'"
       ]
      },
-     "execution_count": 10,
+     "execution_count": 9,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -233,7 +230,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.9"
   }
  },
  "nbformat": 4,

docs/modules/agents/examples/multi_input_tool.ipynb

@@ -50,7 +50,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 6,
    "id": "6db1d43f",
    "metadata": {},
    "outputs": [],
@@ -68,7 +68,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 7,
    "id": "aa25d0ca",
    "metadata": {},
    "outputs": [
@@ -85,8 +85,7 @@
       "Observation: \u001b[36;1m\u001b[1;3m12\u001b[0m\n",
       "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
       "Final Answer: 3 times 4 is 12\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     },
     {
@@ -95,7 +94,7 @@
        "'3 times 4 is 12'"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -115,7 +114,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3.9.0 64-bit ('llm-env')",
    "language": "python",
    "name": "python3"
   },
@@ -129,7 +128,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.9.0"
   },
   "vscode": {
    "interpreter": {

docs/modules/agents/examples/search_tools.ipynb

@@ -14,11 +14,7 @@
    "cell_type": "code",
    "execution_count": 1,
    "id": "e6860c2d",
-   "metadata": {
-    "pycharm": {
-     "is_executing": true
-    }
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "from langchain.agents import load_tools\n",
@@ -28,7 +24,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "id": "dadbcfcd",
    "metadata": {},
    "outputs": [],
@@ -38,86 +34,18 @@
   },
   {
    "cell_type": "markdown",
-   "id": "ee251155",
-   "metadata": {},
-   "source": [
-    "## Google Serper API Wrapper\n",
-    "\n",
-    "First, let's try to use the Google Serper API tool."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "0cdaa487",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = load_tools([\"google-serper\"], llm=llm)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "01b1ab4a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = initialize_agent(tools, llm, agent=\"zero-shot-react-description\", verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "5cf44ec0",
-   "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 I should look up the current weather conditions.\n",
-      "Action: Search\n",
-      "Action Input: \"weather in Pomfret\"\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3m37°F\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the current temperature in Pomfret.\n",
-      "Final Answer: The current temperature in Pomfret is 37°F.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'The current temperature in Pomfret is 37°F.'"
-      ]
-     },
-     "execution_count": 8,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"What is the weather in Pomfret?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "0e39fc46",
+   "id": "a09ca013",
    "metadata": {},
    "source": [
     "## SerpAPI\n",
     "\n",
-    "Now, let's use the SerpAPI tool."
+    "First, let's use the SerpAPI tool."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
-   "id": "e1c39a0f",
+   "execution_count": 4,
+   "id": "dd4ce6d9",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -126,8 +54,8 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
-   "id": "900dd6cb",
+   "execution_count": 5,
+   "id": "ef63bb84",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -136,8 +64,8 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
-   "id": "342ee8ec",
+   "execution_count": 6,
+   "id": "53e24f5d",
    "metadata": {},
    "outputs": [
     {
@@ -150,20 +78,19 @@
       "\u001b[32;1m\u001b[1;3m I need to find out what the current weather is in Pomfret.\n",
       "Action: Search\n",
       "Action Input: \"weather in Pomfret\"\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mPartly cloudy skies during the morning hours will give way to cloudy skies with light rain and snow developing in the afternoon. High 42F. Winds WNW at 10 to 15 ...\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mShowers early becoming a steady light rain later in the day. Near record high temperatures. High around 60F. Winds SW at 10 to 15 mph. Chance of rain 60%.\u001b[0m\n",
       "Thought:\u001b[32;1m\u001b[1;3m I now know the current weather in Pomfret.\n",
-      "Final Answer: Partly cloudy skies during the morning hours will give way to cloudy skies with light rain and snow developing in the afternoon. High 42F. Winds WNW at 10 to 15 mph.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Final Answer: Showers early becoming a steady light rain later in the day. Near record high temperatures. High around 60F. Winds SW at 10 to 15 mph. Chance of rain 60%.\u001b[0m\n",
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "'Partly cloudy skies during the morning hours will give way to cloudy skies with light rain and snow developing in the afternoon. High 42F. Winds WNW at 10 to 15 mph.'"
+       "'Showers early becoming a steady light rain later in the day. Near record high temperatures. High around 60F. Winds SW at 10 to 15 mph. Chance of rain 60%.'"
       ]
      },
-     "execution_count": 11,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -174,7 +101,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "adc8bb68",
+   "id": "8ef49137",
    "metadata": {},
    "source": [
     "## GoogleSearchAPIWrapper\n",
@@ -185,7 +112,7 @@
   {
    "cell_type": "code",
    "execution_count": 13,
-   "id": "ef24f92d",
+   "id": "3e9c7c20",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -195,7 +122,7 @@
   {
    "cell_type": "code",
    "execution_count": 14,
-   "id": "909cd28b",
+   "id": "b83624dc",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -205,7 +132,7 @@
   {
    "cell_type": "code",
    "execution_count": 17,
-   "id": "46515d2a",
+   "id": "9d5835e2",
    "metadata": {},
    "outputs": [
     {
@@ -242,7 +169,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3.9.0 64-bit ('llm-env')",
    "language": "python",
    "name": "python3"
   },
@@ -256,7 +183,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.9.0"
   },
   "vscode": {
    "interpreter": {

docs/modules/agents/examples/serialization.ipynb

@@ -1,154 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "bfe18e28",
-   "metadata": {},
-   "source": [
-    "# Serialization\n",
-    "\n",
-    "This notebook goes over how to serialize agents. For this notebook, it is important to understand the distinction we draw between `agents` and `tools`. An agent is the LLM powered decision maker that decides which actions to take and in which order. Tools are various instruments (functions) an agent has access to, through which an agent can interact with the outside world. When people generally use agents, they primarily talk about using an agent WITH tools. However, when we talk about serialization of agents, we are talking about the agent by itself. We plan to add support for serializing an agent WITH tools sometime in the future.\n",
-    "\n",
-    "Let's start by creating an agent with tools as we normally do:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "eb729f16",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import load_tools\n",
-    "from langchain.agents import initialize_agent\n",
-    "from langchain.llms import OpenAI\n",
-    "\n",
-    "llm = OpenAI(temperature=0)\n",
-    "tools = load_tools([\"serpapi\", \"llm-math\"], llm=llm)\n",
-    "agent = initialize_agent(tools, llm, agent=\"zero-shot-react-description\", verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "0578f566",
-   "metadata": {},
-   "source": [
-    "Let's now serialize the agent. To be explicit that we are serializing ONLY the agent, we will call the `save_agent` method."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "dc544de6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent.save_agent('agent.json')"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "62dd45bf",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "{\r\n",
-      "    \"llm_chain\": {\r\n",
-      "        \"memory\": null,\r\n",
-      "        \"verbose\": false,\r\n",
-      "        \"prompt\": {\r\n",
-      "            \"input_variables\": [\r\n",
-      "                \"input\",\r\n",
-      "                \"agent_scratchpad\"\r\n",
-      "            ],\r\n",
-      "            \"output_parser\": null,\r\n",
-      "            \"template\": \"Answer the following questions as best you can. You have access to the following tools:\\n\\nSearch: A search engine. Useful for when you need to answer questions about current events. Input should be a search query.\\nCalculator: Useful for when you need to answer questions about math.\\n\\nUse the following format:\\n\\nQuestion: the input question you must answer\\nThought: you should always think about what to do\\nAction: the action to take, should be one of [Search, Calculator]\\nAction Input: the input to the action\\nObservation: the result of the action\\n... (this Thought/Action/Action Input/Observation can repeat N times)\\nThought: I now know the final answer\\nFinal Answer: the final answer to the original input question\\n\\nBegin!\\n\\nQuestion: {input}\\nThought:{agent_scratchpad}\",\r\n",
-      "            \"template_format\": \"f-string\",\r\n",
-      "            \"validate_template\": true,\r\n",
-      "            \"_type\": \"prompt\"\r\n",
-      "        },\r\n",
-      "        \"llm\": {\r\n",
-      "            \"model_name\": \"text-davinci-003\",\r\n",
-      "            \"temperature\": 0.0,\r\n",
-      "            \"max_tokens\": 256,\r\n",
-      "            \"top_p\": 1,\r\n",
-      "            \"frequency_penalty\": 0,\r\n",
-      "            \"presence_penalty\": 0,\r\n",
-      "            \"n\": 1,\r\n",
-      "            \"best_of\": 1,\r\n",
-      "            \"request_timeout\": null,\r\n",
-      "            \"logit_bias\": {},\r\n",
-      "            \"_type\": \"openai\"\r\n",
-      "        },\r\n",
-      "        \"output_key\": \"text\",\r\n",
-      "        \"_type\": \"llm_chain\"\r\n",
-      "    },\r\n",
-      "    \"allowed_tools\": [\r\n",
-      "        \"Search\",\r\n",
-      "        \"Calculator\"\r\n",
-      "    ],\r\n",
-      "    \"return_values\": [\r\n",
-      "        \"output\"\r\n",
-      "    ],\r\n",
-      "    \"_type\": \"zero-shot-react-description\"\r\n",
-      "}"
-     ]
-    }
-   ],
-   "source": [
-    "!cat agent.json"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "0eb72510",
-   "metadata": {},
-   "source": [
-    "We can now load the agent back in"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "eb660b76",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = initialize_agent(tools, llm, agent_path=\"agent.json\", verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "aa624ea5",
-   "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.9.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

docs/modules/agents/getting_started.ipynb

@@ -87,7 +87,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 4,
    "id": "03208e2b",
    "metadata": {},
    "outputs": [],
@@ -105,7 +105,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 5,
    "id": "244ee75c",
    "metadata": {},
    "outputs": [
@@ -116,52 +116,43 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who Leo DiCaprio's girlfriend is and then calculate her age raised to the 0.43 power.\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: \"Leo DiCaprio girlfriend\"\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mCamila Morrone\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Camila Morrone's age\n",
+      "Action Input: \"Olivia Wilde boyfriend\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mHarry Styles\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Harry Styles' 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;3m I need to calculate 25 raised to the 0.43 power\n",
+      "Action Input: \"Harry Styles age\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m28 years\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate 28 raised to the 0.23 power\n",
       "Action: Calculator\n",
-      "Action Input: 25^0.43\u001b[0m\n",
-      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 3.991298452658078\n",
+      "Action Input: 28^0.23\u001b[0m\n",
+      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 2.1520202182226886\n",
       "\u001b[0m\n",
       "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Camila Morrone is Leo DiCaprio's girlfriend and her current age raised to the 0.43 power is 3.991298452658078.\u001b[0m\n",
-      "\n",
+      "Final Answer: Harry Styles is Olivia Wilde's boyfriend and his current age raised to the 0.23 power is 2.1520202182226886.\u001b[0m\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "\"Camila Morrone is Leo DiCaprio's girlfriend and her current age raised to the 0.43 power is 3.991298452658078.\""
+       "\"Harry Styles is Olivia Wilde's boyfriend and his current age raised to the 0.23 power is 2.1520202182226886.\""
       ]
      },
-     "execution_count": 13,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "agent.run(\"Who is Leo DiCaprio's girlfriend? What is her current age raised to the 0.43 power?\")"
+    "agent.run(\"Who is Olivia Wilde's boyfriend? What is his current age raised to the 0.23 power?\")"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5901695b",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3.9.0 64-bit ('llm-env')",
    "language": "python",
    "name": "python3"
   },
@@ -175,7 +166,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.9"
   }
  },
  "nbformat": 4,

docs/modules/agents/how_to_guides.rst

@@ -3,29 +3,24 @@ How-To Guides
 
 The first category of how-to guides here cover specific parts of working with agents.
 
-`Load From Hub <./examples/load_from_hub.html>`_: This notebook covers how to load agents from `LangChainHub <https://github.com/hwchase17/langchain-hub>`_.
+`Custom Tools <examples/custom_tools.html>`_: How to create custom tools that an agent can use.
 
-`Custom Tools <./examples/custom_tools.html>`_: How to create custom tools that an agent can use.
+`Intermediate Steps <examples/intermediate_steps.html>`_: How to access and use intermediate steps to get more visibility into the internals of an agent.
 
-`Agents With Vectorstores <./examples/agent_vectorstore.html>`_: How to use vectorstores with agents.
+`Custom Agent <examples/custom_agent.html>`_: How to create a custom agent (specifically, a custom LLM + prompt to drive that agent).
 
-`Intermediate Steps <./examples/intermediate_steps.html>`_: How to access and use intermediate steps to get more visibility into the internals of an agent.
+`Multi Input Tools <examples/multi_input_tool.html>`_: How to use a tool that requires multiple inputs with an agent.
 
-`Custom Agent <./examples/custom_agent.html>`_: How to create a custom agent (specifically, a custom LLM + prompt to drive that agent).
+`Search Tools <examples/search_tools.html>`_: How to use the different type of search tools that LangChain supports.
 
-`Multi Input Tools <./examples/multi_input_tool.html>`_: How to use a tool that requires multiple inputs with an agent.
+`Max Iterations <examples/max_iterations.html>`_: How to restrict an agent to a certain number of iterations.
 
-`Search Tools <./examples/search_tools.html>`_: How to use the different type of search tools that LangChain supports.
-
-`Max Iterations <./examples/max_iterations.html>`_: How to restrict an agent to a certain number of iterations.
-
-`Asynchronous <./examples/async_agent.html>`_: Covering asynchronous functionality.
 
 The next set of examples are all end-to-end agents for specific applications.
 In all examples there is an Agent with a particular set of tools.
 
-- Tools: A tool can be anything that takes in a string and returns a string. This means that you can use both the primitives AND the chains found in `this <../chains.html>`_ documentation. LangChain also provides a list of easily loadable tools. For detailed information on those, please see `this documentation <./tools.html>`_
-- Agents: An agent uses an LLMChain to determine which tools to use. For a list of all available agent types, see `here <./agents.html>`_.
+- Tools: A tool can be anything that takes in a string and returns a string. This means that you can use both the primitives AND the chains found in `this <chains.html>`_ documentation. LangChain also provides a list of easily loadable tools. For detailed information on those, please see `this documentation <../explanation/tools.html>`_
+- Agents: An agent uses an LLMChain to determine which tools to use. For a list of all available agent types, see `here <../explanation/agents.html>`_.
 
 **MRKL**
 
@@ -33,21 +28,21 @@ In all examples there is an Agent with a particular set of tools.
 - **Agent used**: `zero-shot-react-description`
 - `Paper <https://arxiv.org/pdf/2205.00445.pdf>`_
 - **Note**: This is the most general purpose example, so if you are looking to use an agent with arbitrary tools, please start here.
-- `Example Notebook <./implementations/mrkl.html>`_
+- `Example Notebook <implementations/mrkl.html>`_
 
 **Self-Ask-With-Search**
 
 - **Tools used**: Search
 - **Agent used**: `self-ask-with-search`
 - `Paper <https://ofir.io/self-ask.pdf>`_
-- `Example Notebook <./implementations/self_ask_with_search.html>`_
+- `Example Notebook <implementations/self_ask_with_search.html>`_
 
 **ReAct**
 
 - **Tools used**: Wikipedia Docstore
 - **Agent used**: `react-docstore`
 - `Paper <https://arxiv.org/pdf/2210.03629.pdf>`_
-- `Example Notebook <./implementations/react.html>`_
+- `Example Notebook <implementations/react.html>`_
 
 
 
@@ -56,11 +51,11 @@ In all examples there is an Agent with a particular set of tools.
    :glob:
    :hidden:
 
-   ./examples/*
+   examples/*
 
 .. toctree::
    :maxdepth: 1
    :glob:
    :hidden:
 
-   ./implementations/*
+   implementations/*

docs/modules/agents/implementations/mrkl.ipynb

@@ -32,7 +32,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "id": "07e96d99",
    "metadata": {},
    "outputs": [],
@@ -63,7 +63,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "id": "a069c4b6",
    "metadata": {},
    "outputs": [],
@@ -73,7 +73,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "id": "e603cd7d",
    "metadata": {},
    "outputs": [
@@ -84,55 +84,54 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m I need to find out who Leo DiCaprio's girlfriend is and then calculate her age raised to the 0.43 power.\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: \"Who is Leo DiCaprio's girlfriend?\"\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mCamila Morrone\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Camila Morrone's age\n",
+      "Action Input: \"Who is Olivia Wilde's boyfriend?\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mHarry Styles\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to find out Harry Styles' age\n",
       "Action: Search\n",
-      "Action Input: \"How old is Camila Morrone?\"\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.43 power\n",
+      "Action Input: \"How old is Harry Styles?\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3m28 years\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate 28 raised to the 0.23 power\n",
       "Action: Calculator\n",
-      "Action Input: 25^0.43\u001b[0m\n",
+      "Action Input: 28^0.23\u001b[0m\n",
       "\n",
       "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\n",
-      "25^0.43\u001b[32;1m\u001b[1;3m\n",
+      "28^0.23\u001b[32;1m\u001b[1;3m\n",
       "```python\n",
       "import math\n",
-      "print(math.pow(25, 0.43))\n",
+      "print(math.pow(28, 0.23))\n",
       "```\n",
       "\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m3.991298452658078\n",
+      "Answer: \u001b[33;1m\u001b[1;3m2.1520202182226886\n",
       "\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\u001b[1m> Finished LLMMathChain chain.\u001b[0m\n",
       "\n",
-      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 3.991298452658078\n",
+      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 2.1520202182226886\n",
       "\u001b[0m\n",
       "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Camila Morrone is 25 years old and her age raised to the 0.43 power is 3.991298452658078.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Final Answer: Harry Styles is 28 years old and his age raised to the 0.23 power is 2.1520202182226886.\u001b[0m\n",
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "'Camila Morrone is 25 years old and her age raised to the 0.43 power is 3.991298452658078.'"
+       "'Harry Styles is 28 years old and his age raised to the 0.23 power is 2.1520202182226886.'"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "mrkl.run(\"Who is Leo DiCaprio's girlfriend? What is her current age raised to the 0.43 power?\")"
+    "mrkl.run(\"Who is Olivia Wilde's boyfriend? What is his current age raised to the 0.23 power?\")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "id": "a5c07010",
    "metadata": {},
    "outputs": [
@@ -146,32 +145,31 @@
       "\u001b[32;1m\u001b[1;3m I need to find out the artist's full name and then search the FooBar database for their albums.\n",
       "Action: Search\n",
       "Action Input: \"The Storm Before the Calm\" artist\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mThe Storm Before the Calm (stylized in all lowercase) is the tenth (and eighth international) studio album by Canadian-American singer-songwriter Alanis ...\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now need to search the FooBar database for Alanis Morissette's albums\n",
+      "Observation: \u001b[36;1m\u001b[1;3mAlanis Morissette - the storm before the calm - Amazon.com Music.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now need to search the FooBar database for Alanis Morissette's albums.\n",
       "Action: FooBar DB\n",
-      "Action Input: What albums by Alanis Morissette are in the FooBar database?\u001b[0m\n",
+      "Action Input: What albums of Alanis Morissette are in the FooBar database?\u001b[0m\n",
       "\n",
       "\u001b[1m> Entering new SQLDatabaseChain chain...\u001b[0m\n",
-      "What albums by Alanis Morissette are in the FooBar database? \n",
-      "SQLQuery:\u001b[32;1m\u001b[1;3m SELECT Title FROM Album INNER JOIN Artist ON Album.ArtistId = Artist.ArtistId WHERE Artist.Name = 'Alanis Morissette' LIMIT 5;\u001b[0m\n",
+      "What albums of Alanis Morissette are in the FooBar database? \n",
+      "SQLQuery:\u001b[32;1m\u001b[1;3m SELECT Title FROM Album WHERE ArtistId IN (SELECT ArtistId FROM Artist WHERE Name = 'Alanis Morissette');\u001b[0m\n",
       "SQLResult: \u001b[33;1m\u001b[1;3m[('Jagged Little Pill',)]\u001b[0m\n",
-      "Answer:\u001b[32;1m\u001b[1;3m The albums by Alanis Morissette in the FooBar database are Jagged Little Pill.\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "Answer:\u001b[32;1m\u001b[1;3m The album 'Jagged Little Pill' by Alanis Morissette is in the FooBar database.\u001b[0m\n",
+      "\u001b[1m> Finished SQLDatabaseChain chain.\u001b[0m\n",
       "\n",
-      "Observation: \u001b[38;5;200m\u001b[1;3m The albums by Alanis Morissette in the FooBar database are Jagged Little Pill.\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: The artist who released the album The Storm Before the Calm is Alanis Morissette and the albums of theirs in the FooBar database are Jagged Little Pill.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Observation: \u001b[38;5;200m\u001b[1;3m The album 'Jagged Little Pill' by Alanis Morissette is in the FooBar database.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer.\n",
+      "Final Answer: Alanis Morissette is the artist who recently released an album called 'The Storm Before the Calm' and the album 'Jagged Little Pill' by Alanis Morissette is in the FooBar database.\u001b[0m\n",
+      "\u001b[1m> Finished AgentExecutor chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "'The artist who released the album The Storm Before the Calm is Alanis Morissette and the albums of theirs in the FooBar database are Jagged Little Pill.'"
+       "\"Alanis Morissette is the artist who recently released an album called 'The Storm Before the Calm' and the album 'Jagged Little Pill' by Alanis Morissette is in the FooBar database.\""
       ]
      },
-     "execution_count": 5,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -205,7 +203,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.9"
   }
  },
  "nbformat": 4,

docs/modules/agents/implementations/natbot.py

@@ -2,7 +2,7 @@
 import time
 
 from langchain.chains.natbot.base import NatBotChain
-from langchain.chains.natbot.crawler import Crawler
+from langchain.chains.natbot.crawler import Crawler  # type: ignore
 
 
 def run_cmd(cmd: str, _crawler: Crawler) -> None:
@@ -33,6 +33,7 @@ def run_cmd(cmd: str, _crawler: Crawler) -> None:
 
 
 if __name__ == "__main__":
+
     objective = "Make a reservation for 2 at 7pm at bistro vida in menlo park"
     print("\nWelcome to natbot! What is your objective?")
     i = input()

docs/modules/agents/tools.md

@@ -22,7 +22,6 @@ tools = load_tools(tool_names, llm=llm)
 ```
 
 Below is a list of all supported tools and relevant information:
-
 - Tool Name: The name the LLM refers to the tool by.
 - Tool Description: The description of the tool that is passed to the LLM.
 - Notes: Notes about the tool that are NOT passed to the LLM.
@@ -32,71 +31,55 @@ Below is a list of all supported tools and relevant information:
 ## List of Tools
 
 **python_repl**
-
 - Tool Name: Python REPL
 - Tool Description: A Python shell. Use this to execute python commands. Input should be a valid python command. If you expect output it should be printed out.
 - Notes: Maintains state.
 - Requires LLM: No
 
-**serpapi**
 
+**serpapi**
 - Tool Name: Search
 - Tool Description: A search engine. Useful for when you need to answer questions about current events. Input should be a search query.
 - Notes: Calls the Serp API and then parses results.
 - Requires LLM: No
 
-**wolfram-alpha**
-
-- Tool Name: Wolfram Alpha
-- Tool Description: A wolfram alpha search engine. Useful for when you need to answer questions about Math, Science, Technology, Culture, Society and Everyday Life. Input should be a search query.
-- Notes: Calls the Wolfram Alpha API and then parses results.
-- Requires LLM: No
-- Extra Parameters: `wolfram_alpha_appid`: The Wolfram Alpha app id.
-
 **requests**
-
 - Tool Name: Requests
 - Tool Description: A portal to the internet. Use this when you need to get specific content from a site. Input should be a specific url, and the output will be all the text on that page.
 - Notes: Uses the Python requests module.
 - Requires LLM: No
 
 **terminal**
-
 - Tool Name: Terminal
 - Tool Description: Executes commands in a terminal. Input should be valid commands, and the output will be any output from running that command.
 - Notes: Executes commands with subprocess.
 - Requires LLM: No
 
 **pal-math**
-
 - Tool Name: PAL-MATH
 - Tool Description: A language model that is excellent at solving complex word math problems. Input should be a fully worded hard word math problem.
 - Notes: Based on [this paper](https://arxiv.org/pdf/2211.10435.pdf).
 - Requires LLM: Yes
 
 **pal-colored-objects**
-
 - Tool Name: PAL-COLOR-OBJ
 - Tool Description: A language model that is wonderful at reasoning about position and the color attributes of objects. Input should be a fully worded hard reasoning problem. Make sure to include all information about the objects AND the final question you want to answer.
 - Notes: Based on [this paper](https://arxiv.org/pdf/2211.10435.pdf).
 - Requires LLM: Yes
 
 **llm-math**
-
 - Tool Name: Calculator
 - Tool Description: Useful for when you need to answer questions about math.
 - Notes: An instance of the `LLMMath` chain.
 - Requires LLM: Yes
 
 **open-meteo-api**
-
 - Tool Name: Open Meteo API
 - Tool Description: Useful for when you want to get weather information from the OpenMeteo API. The input should be a question in natural language that this API can answer.
 - Notes: A natural language connection to the Open Meteo API (`https://api.open-meteo.com/`), specifically the `/v1/forecast` endpoint.
 - Requires LLM: Yes
 
 **news-api**
-
 - Tool Name: News API
 - Tool Description: Use this when you want to get information about the top headlines of current news stories. The input should be a question in natural language that this API can answer.
 - Notes: A natural language connection to the News API (`https://newsapi.org`), specifically the `/v2/top-headlines` endpoint.
@@ -104,35 +87,8 @@ Below is a list of all supported tools and relevant information:
 - Extra Parameters: `news_api_key` (your API key to access this endpoint)
 
 **tmdb-api**
-
 - Tool Name: TMDB API
 - Tool Description: Useful for when you want to get information from The Movie Database. The input should be a question in natural language that this API can answer.
 - Notes: A natural language connection to the TMDB API (`https://api.themoviedb.org/3`), specifically the `/search/movie` endpoint.
 - Requires LLM: Yes
 - Extra Parameters: `tmdb_bearer_token` (your Bearer Token to access this endpoint - note that this is different from the API key)
-
-**google-search**
-
-- Tool Name: Search
-- Tool Description: A wrapper around Google Search. Useful for when you need to answer questions about current events. Input should be a search query.
-- Notes: Uses the Google Custom Search API
-- Requires LLM: No
-- Extra Parameters: `google_api_key`, `google_cse_id`
-- For more information on this, see [this page](../../ecosystem/google_search.md)
-
-**searx-search**
-
-- Tool Name: Search
-- Tool Description: A wrapper around SearxNG meta search engine. Input should be a search query. 
-- Notes: SearxNG is easy to deploy self-hosted. It is a good privacy friendly alternative to Google Search. Uses the SearxNG API. 
-- Requires LLM: No
-- Extra Parameters: `searx_host`
-
-**google-serper**
-
-- Tool Name: Search
-- Tool Description: A low-cost Google Search API. Useful for when you need to answer questions about current events. Input should be a search query.
-- Notes: Calls the [serper.dev](https://serper.dev) Google Search API and then parses results.
-- Requires LLM: No
-- Extra Parameters: `serper_api_key`
-- For more information on this, see [this page](../../ecosystem/google_serper.md)

docs/modules/chains.rst

@@ -2,18 +2,18 @@ Chains
 ==========================
 
 Using an LLM in isolation is fine for some simple applications,
-but many more complex ones require chaining LLMs - either with each other or with other experts.
-LangChain provides a standard interface for Chains, as well as some common implementations of chains for ease of use.
+but many more complex ones require chaining LLMs - either with eachother or with other experts.
+LangChain provides a standard interface for Chains, as well as some common implementations of chains for easy use.
 
 The following sections of documentation are provided:
 
-- `Getting Started <./chains/getting_started.html>`_: A getting started guide for chains, to get you up and running quickly.
+- `Getting Started <chains/getting_started.html>`_: A getting started guide for chains, to get you up and running quickly.
 
-- `Key Concepts <./chains/key_concepts.html>`_: A conceptual guide going over the various concepts related to chains.
+- `Key Concepts <chains/key_concepts.html>`_: A conceptual guide going over the various concepts related to chains.
 
-- `How-To Guides <./chains/how_to_guides.html>`_: A collection of how-to guides. These highlight how to use various types of chains.
+- `How-To Guides <chains/how_to_guides.html>`_: A collection of how-to guides. These highlight how to use various types of chains.
 
-- `Reference <../reference/modules/chains.html>`_: API reference documentation for all Chain classes.
+- `Reference </reference/chains.html>`_: API reference documentation for all Chain classes.
 
 
 
@@ -23,7 +23,7 @@ The following sections of documentation are provided:
    :name: Chains
    :hidden:
 
-   ./chains/getting_started.ipynb
-   ./chains/how_to_guides.rst
-   ./chains/key_concepts.rst
-   Reference<../reference/modules/chains.rst>
+   chains/getting_started.ipynb
+   chains/how_to_guides.rst
+   chains/key_concepts.rst
+   Reference</reference/modules/chains.rst>

docs/modules/chains/async_chain.ipynb

@@ -1,132 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "593f7553-7038-498e-96d4-8255e5ce34f0",
-   "metadata": {},
-   "source": [
-    "# Async API for Chain\n",
-    "\n",
-    "LangChain provides async support for Chains by leveraging the [asyncio](https://docs.python.org/3/library/asyncio.html) library.\n",
-    "\n",
-    "Async methods are currently supported in `LLMChain` (through `arun`, `apredict`, `acall`) and `LLMMathChain` (through `arun` and `acall`), `ChatVectorDBChain`, and [QA chains](../indexes/chain_examples/question_answering.html). Async support for other chains is on the roadmap."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "c19c736e-ca74-4726-bb77-0a849bcc2960",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "BrightSmile Toothpaste Company\n",
-      "\n",
-      "\n",
-      "BrightSmile Toothpaste Co.\n",
-      "\n",
-      "\n",
-      "BrightSmile Toothpaste\n",
-      "\n",
-      "\n",
-      "Gleaming Smile Inc.\n",
-      "\n",
-      "\n",
-      "SparkleSmile Toothpaste\n",
-      "\u001b[1mConcurrent executed in 1.54 seconds.\u001b[0m\n",
-      "\n",
-      "\n",
-      "BrightSmile Toothpaste Co.\n",
-      "\n",
-      "\n",
-      "MintyFresh Toothpaste Co.\n",
-      "\n",
-      "\n",
-      "SparkleSmile Toothpaste.\n",
-      "\n",
-      "\n",
-      "Pearly Whites Toothpaste Co.\n",
-      "\n",
-      "\n",
-      "BrightSmile Toothpaste.\n",
-      "\u001b[1mSerial executed in 6.38 seconds.\u001b[0m\n"
-     ]
-    }
-   ],
-   "source": [
-    "import asyncio\n",
-    "import time\n",
-    "\n",
-    "from langchain.llms import OpenAI\n",
-    "from langchain.prompts import PromptTemplate\n",
-    "from langchain.chains import LLMChain\n",
-    "\n",
-    "\n",
-    "def generate_serially():\n",
-    "    llm = OpenAI(temperature=0.9)\n",
-    "    prompt = PromptTemplate(\n",
-    "        input_variables=[\"product\"],\n",
-    "        template=\"What is a good name for a company that makes {product}?\",\n",
-    "    )\n",
-    "    chain = LLMChain(llm=llm, prompt=prompt)\n",
-    "    for _ in range(5):\n",
-    "        resp = chain.run(product=\"toothpaste\")\n",
-    "        print(resp)\n",
-    "\n",
-    "\n",
-    "async def async_generate(chain):\n",
-    "    resp = await chain.arun(product=\"toothpaste\")\n",
-    "    print(resp)\n",
-    "\n",
-    "\n",
-    "async def generate_concurrently():\n",
-    "    llm = OpenAI(temperature=0.9)\n",
-    "    prompt = PromptTemplate(\n",
-    "        input_variables=[\"product\"],\n",
-    "        template=\"What is a good name for a company that makes {product}?\",\n",
-    "    )\n",
-    "    chain = LLMChain(llm=llm, prompt=prompt)\n",
-    "    tasks = [async_generate(chain) for _ in range(5)]\n",
-    "    await asyncio.gather(*tasks)\n",
-    "\n",
-    "s = time.perf_counter()\n",
-    "# If running this outside of Jupyter, use asyncio.run(generate_concurrently())\n",
-    "await generate_concurrently()\n",
-    "elapsed = time.perf_counter() - s\n",
-    "print('\\033[1m' + f\"Concurrent executed in {elapsed:0.2f} seconds.\" + '\\033[0m')\n",
-    "\n",
-    "s = time.perf_counter()\n",
-    "generate_serially()\n",
-    "elapsed = time.perf_counter() - s\n",
-    "print('\\033[1m' + f\"Serial executed in {elapsed:0.2f} seconds.\" + '\\033[0m')"
-   ]
-  }
- ],
- "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.9.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

docs/modules/chains/combine_docs.md

@@ -6,7 +6,7 @@ For more information on specific use cases as well as different methods for **fe
 
 This documentation now picks up from after you've fetched your documents - now what?
 How do you pass them to the language model in a format it can understand?
-There are a few different methods, or chains, for doing so. LangChain supports four of the more common ones - and
+There are a few different methods, or chains, for doing so. LangChain supports three of the more common ones - and
 we are actively looking to include more, so if you have any ideas please reach out! Note that there is not
 one best method - the decision of which one to use is often very context specific. In order from simplest to
 most complex:
@@ -39,13 +39,3 @@ asking the LLM to refine the output based on the new document.
 **Pros:** Can pull in more relevant context, and may be less lossy than `MapReduceDocumentsChain`.
 
 **Cons:** Requires many more calls to the LLM than `StuffDocumentsChain`. The calls are also NOT independent, meaning they cannot be paralleled like `MapReduceDocumentsChain`. There is also some potential dependencies on the ordering of the documents.
-
-
-## Map-Rerank
-This method involves running an initial prompt on each chunk of data, that not only tries to complete a
-task but also gives a score for how certain it is in its answer. The responses are then
-ranked according to this score, and the highest score is returned.
-
-**Pros:** Similar pros as `MapReduceDocumentsChain`. Compared to `MapReduceDocumentsChain`, it requires fewer calls.
-
-**Cons:** Cannot combine information between documents. This means it is most useful when you expect there to be a single simple answer in a single document.

docs/modules/chains/combine_docs_examples/qa_with_sources.ipynb

@@ -0,0 +1,335 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "74148cee",
+   "metadata": {},
+   "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 three different chain types: `stuff`, `map_reduce`, and `refine`. For a more in depth explanation of what these chain types are, see [here](../combine_docs.md)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ca2f0efc",
+   "metadata": {},
+   "source": [
+    "## Prepare Data\n",
+    "First we prepare the data. For this example we do similarity search over a vector database, but these documents could be fetched in any manner (the point of this notebook to highlight what to do AFTER you fetch the documents)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "78f28130",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.embeddings.openai import OpenAIEmbeddings\n",
+    "from langchain.embeddings.cohere import CohereEmbeddings\n",
+    "from langchain.text_splitter import CharacterTextSplitter\n",
+    "from langchain.vectorstores.elastic_vector_search import ElasticVectorSearch\n",
+    "from langchain.vectorstores.faiss import FAISS\n",
+    "from langchain.docstore.document import Document"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "4da195a3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with open('../../state_of_the_union.txt') as f:\n",
+    "    state_of_the_union = f.read()\n",
+    "text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)\n",
+    "texts = text_splitter.split_text(state_of_the_union)\n",
+    "\n",
+    "embeddings = OpenAIEmbeddings()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "5ec2b55b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "docsearch = FAISS.from_texts(texts, embeddings, metadatas=[{\"source\": i} for i in range(len(texts))])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "5286f58f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "query = \"What did the president say about Justice Breyer\"\n",
+    "docs = docsearch.similarity_search(query)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "005a47e9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.chains.qa_with_sources import load_qa_with_sources_chain\n",
+    "from langchain.llms import OpenAI"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "d82f899a",
+   "metadata": {},
+   "source": [
+    "## The `stuff` Chain\n",
+    "\n",
+    "This sections shows results of using the `stuff` Chain to do question answering with sources."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "fc1a5ed6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_with_sources_chain(OpenAI(temperature=0), chain_type=\"stuff\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "7d766417",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': ' The president thanked Justice Breyer for his service.\\nSOURCES: 30-pl'}"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "query = \"What did the president say about Justice Breyer\"\n",
+    "chain({\"input_documents\": docs, \"question\": query}, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "c5dbb304",
+   "metadata": {},
+   "source": [
+    "## The `map_reduce` Chain\n",
+    "\n",
+    "This sections shows results of using the `map_reduce` Chain to do question answering with sources."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "921db0a4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_with_sources_chain(OpenAI(temperature=0), chain_type=\"map_reduce\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "e417926a",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': ' The president thanked Justice Breyer for his service.\\nSOURCES: 30-pl'}"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "query = \"What did the president say about Justice Breyer\"\n",
+    "chain({\"input_documents\": docs, \"question\": query}, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ae2f6d97",
+   "metadata": {},
+   "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."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 16,
+   "id": "15af265f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_with_sources_chain(OpenAI(temperature=0), chain_type=\"map_reduce\", return_intermediate_steps=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 17,
+   "id": "21b136e5",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'intermediate_steps': [' \"Tonight, I’d like to honor someone who has dedicated his life to serve this country: Justice Stephen Breyer—an Army veteran, Constitutional scholar, and retiring Justice of the United States Supreme Court. Justice Breyer, thank you for your service.\"',\n",
+       "  ' None',\n",
+       "  ' None',\n",
+       "  ' None'],\n",
+       " 'output_text': ' The president thanked Justice Breyer for his service.\\nSOURCES: 30-pl'}"
+      ]
+     },
+     "execution_count": 17,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain({\"input_documents\": docs, \"question\": query}, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "5bf0e1ab",
+   "metadata": {},
+   "source": [
+    "## The `refine` Chain\n",
+    "\n",
+    "This sections shows results of using the `refine` Chain to do question answering with sources."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "id": "904835c8",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_with_sources_chain(OpenAI(temperature=0), chain_type=\"refine\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 13,
+   "id": "f60875c6",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': \"\\n\\nThe president said that he was honoring Justice Breyer for his dedication to serving the country and that he was a retiring Justice of the United States Supreme Court. He also thanked him for his service and praised his career as a top litigator in private practice, a former federal public defender, and a family of public school educators and police officers. He noted Justice Breyer's reputation as a consensus builder and the broad range of support he has received from the Fraternal Order of Police to former judges appointed by Democrats and Republicans. He also highlighted the importance of securing the border and fixing the immigration system in order to advance liberty and justice, and mentioned the new technology, joint patrols, dedicated immigration judges, and commitments to support partners in South and Central America that have been put in place. He also expressed his commitment to the LGBTQ+ community, noting the need for the bipartisan Equality Act and the importance of protecting transgender Americans from state laws targeting them. He also highlighted his commitment to bipartisanship, noting the 80 bipartisan bills he signed into law last year, and his plans to strengthen the Violence Against Women Act. Additionally, he announced that the Justice Department will name a chief prosecutor for pandemic fraud and his plan to lower the deficit by more than one trillion dollars in a\"}"
+      ]
+     },
+     "execution_count": 13,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "query = \"What did the president say about Justice Breyer\"\n",
+    "chain({\"input_documents\": docs, \"question\": query}, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ac357530",
+   "metadata": {},
+   "source": [
+    "**Intermediate Steps**\n",
+    "\n",
+    "We can also return the intermediate steps for `refine` chains, should we want to inspect them. This is done with the `return_refine_steps` variable."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 18,
+   "id": "3396a773",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_with_sources_chain(OpenAI(temperature=0), chain_type=\"refine\", return_intermediate_steps=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 19,
+   "id": "be5739ef",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'intermediate_steps': ['\\nThe president said that he was honoring Justice Breyer for his dedication to serving the country and that he was a retiring Justice of the United States Supreme Court. He also thanked Justice Breyer for his service.',\n",
+       "  '\\n\\nThe president said that he was honoring Justice Breyer for his dedication to serving the country and that he was a retiring Justice of the United States Supreme Court. He also thanked Justice Breyer for his service, noting his background as a top litigator in private practice, a former federal public defender, and a family of public school educators and police officers. He praised Justice Breyer for being a consensus builder and for receiving a broad range of support from the Fraternal Order of Police to former judges appointed by Democrats and Republicans. He also noted that in order to advance liberty and justice, it was necessary to secure the border and fix the immigration system, and that the government was taking steps to do both. \\n\\nSource: 31',\n",
+       "  '\\n\\nThe president said that he was honoring Justice Breyer for his dedication to serving the country and that he was a retiring Justice of the United States Supreme Court. He also thanked Justice Breyer for his service, noting his background as a top litigator in private practice, a former federal public defender, and a family of public school educators and police officers. He praised Justice Breyer for being a consensus builder and for receiving a broad range of support from the Fraternal Order of Police to former judges appointed by Democrats and Republicans. He also noted that in order to advance liberty and justice, it was necessary to secure the border and fix the immigration system, and that the government was taking steps to do both. He also mentioned the need to pass the bipartisan Equality Act to protect LGBTQ+ Americans, and to strengthen the Violence Against Women Act that he had written three decades ago. \\n\\nSource: 31, 33',\n",
+       "  '\\n\\nThe president said that he was honoring Justice Breyer for his dedication to serving the country and that he was a retiring Justice of the United States Supreme Court. He also thanked Justice Breyer for his service, noting his background as a top litigator in private practice, a former federal public defender, and a family of public school educators and police officers. He praised Justice Breyer for being a consensus builder and for receiving a broad range of support from the Fraternal Order of Police to former judges appointed by Democrats and Republicans. He also noted that in order to advance liberty and justice, it was necessary to secure the border and fix the immigration system, and that the government was taking steps to do both. He also mentioned the need to pass the bipartisan Equality Act to protect LGBTQ+ Americans, and to strengthen the Violence Against Women Act that he had written three decades ago. Additionally, he mentioned his plan to lower costs to give families a fair shot, lower the deficit, and go after criminals who stole billions in relief money meant for small businesses and millions of Americans. He also announced that the Justice Department will name a chief prosecutor for pandemic fraud. \\n\\nSource: 20, 31, 33'],\n",
+       " 'output_text': '\\n\\nThe president said that he was honoring Justice Breyer for his dedication to serving the country and that he was a retiring Justice of the United States Supreme Court. He also thanked Justice Breyer for his service, noting his background as a top litigator in private practice, a former federal public defender, and a family of public school educators and police officers. He praised Justice Breyer for being a consensus builder and for receiving a broad range of support from the Fraternal Order of Police to former judges appointed by Democrats and Republicans. He also noted that in order to advance liberty and justice, it was necessary to secure the border and fix the immigration system, and that the government was taking steps to do both. He also mentioned the need to pass the bipartisan Equality Act to protect LGBTQ+ Americans, and to strengthen the Violence Against Women Act that he had written three decades ago. Additionally, he mentioned his plan to lower costs to give families a fair shot, lower the deficit, and go after criminals who stole billions in relief money meant for small businesses and millions of Americans. He also announced that the Justice Department will name a chief prosecutor for pandemic fraud. \\n\\nSource: 20, 31, 33'}"
+      ]
+     },
+     "execution_count": 19,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain({\"input_documents\": docs, \"question\": query}, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "aa2b8db9",
+   "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.10.9"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "b1677b440931f40d89ef8be7bf03acb108ce003de0ac9b18e8d43753ea2e7103"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/modules/chains/combine_docs_examples/question_answering.ipynb

@@ -0,0 +1,325 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "05859721",
+   "metadata": {},
+   "source": [
+    "# Question Answering\n",
+    "\n",
+    "This notebook walks through how to use LangChain for question answering over a list of documents. It covers three different types of chaings: `stuff`, `map_reduce`, and `refine`. For a more in depth explanation of what these chain types are, see [here](../combine_docs.md)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "726f4996",
+   "metadata": {},
+   "source": [
+    "## Prepare Data\n",
+    "First we prepare the data. For this example we do similarity search over a vector database, but these documents could be fetched in any manner (the point of this notebook to highlight what to do AFTER you fetch the documents)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "17fcbc0f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.embeddings.openai import OpenAIEmbeddings\n",
+    "from langchain.text_splitter import CharacterTextSplitter\n",
+    "from langchain.vectorstores.faiss import FAISS\n",
+    "from langchain.docstore.document import Document"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "291f0117",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with open('../../state_of_the_union.txt') as f:\n",
+    "    state_of_the_union = f.read()\n",
+    "text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)\n",
+    "texts = text_splitter.split_text(state_of_the_union)\n",
+    "\n",
+    "embeddings = OpenAIEmbeddings()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "fd9666a9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "docsearch = FAISS.from_texts(texts, embeddings)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "d1eaf6e6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "query = \"What did the president say about Justice Breyer\"\n",
+    "docs = docsearch.similarity_search(query)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "a16e3453",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.chains.question_answering import load_qa_chain\n",
+    "from langchain.llms import OpenAI"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f78787a0",
+   "metadata": {},
+   "source": [
+    "## The `stuff` Chain\n",
+    "\n",
+    "This sections shows results of using the `stuff` Chain to do question answering."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "180fd4c1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_chain(OpenAI(temperature=0), chain_type=\"stuff\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "77fdf1aa",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': ' The president said that he was honoring Justice Breyer for his service to the country and that he was a Constitutional scholar, Army veteran, and retiring Justice of the United States Supreme Court.'}"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "query = \"What did the president say about Justice Breyer\"\n",
+    "chain({\"input_documents\": docs, \"question\": query}, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "91522e29",
+   "metadata": {},
+   "source": [
+    "## The `map_reduce` Chain\n",
+    "\n",
+    "This sections shows results of using the `map_reduce` Chain to do question answering."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "b0060f51",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_chain(OpenAI(temperature=0), chain_type=\"map_reduce\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "fbdb9137",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': ' The president said, \"Justice Breyer, thank you for your service.\"'}"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "query = \"What did the president say about Justice Breyer\"\n",
+    "chain({\"input_documents\": docs, \"question\": query}, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "31478d32",
+   "metadata": {},
+   "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."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "452c8680",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_chain(OpenAI(temperature=0), chain_type=\"map_reduce\", return_map_steps=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "90b47a75",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'intermediate_steps': [' \"Tonight, I’d like to honor someone who has dedicated his life to serve this country: Justice Stephen Breyer—an Army veteran, Constitutional scholar, and retiring Justice of the United States Supreme Court. Justice Breyer, thank you for your service.\"',\n",
+       "  ' None',\n",
+       "  ' None',\n",
+       "  ' None'],\n",
+       " 'output_text': ' The president said, \"Justice Breyer, thank you for your service.\"'}"
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain({\"input_documents\": docs, \"question\": query}, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "6ea50ad0",
+   "metadata": {},
+   "source": [
+    "## The `refine` Chain\n",
+    "\n",
+    "This sections shows results of using the `refine` Chain to do question answering."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "id": "fb167057",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_chain(OpenAI(temperature=0), chain_type=\"refine\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 13,
+   "id": "d8b5286e",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': '\\n\\nThe president said that he wanted to honor Justice Breyer for his dedication to serving the country, his legacy of excellence, and his commitment to advancing liberty and justice, as well as for his commitment to protecting the rights of LGBTQ+ Americans and his support for the bipartisan Equality Act. He also mentioned his plan to lower costs to give families a fair shot, lower the deficit, and go after criminals who stole pandemic relief funds. He also announced that the Justice Department will name a chief prosecutor for pandemic fraud.'}"
+      ]
+     },
+     "execution_count": 13,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "query = \"What did the president say about Justice Breyer\"\n",
+    "chain({\"input_documents\": docs, \"question\": query}, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f95dfb2e",
+   "metadata": {},
+   "source": [
+    "**Intermediate Steps**\n",
+    "\n",
+    "We can also return the intermediate steps for `refine` chains, should we want to inspect them. This is done with the `return_refine_steps` variable."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 14,
+   "id": "a5c64200",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_chain(OpenAI(temperature=0), chain_type=\"refine\", return_refine_steps=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 15,
+   "id": "817546ac",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'intermediate_steps': ['\\nThe president said that he wanted to honor Justice Breyer for his dedication to serving the country and his legacy of excellence.',\n",
+       "  '\\n\\nThe president said that he wanted to honor Justice Breyer for his dedication to serving the country, his legacy of excellence, and his commitment to advancing liberty and justice.',\n",
+       "  '\\n\\nThe president said that he wanted to honor Justice Breyer for his dedication to serving the country, his legacy of excellence, and his commitment to advancing liberty and justice, as well as for his commitment to protecting the rights of LGBTQ+ Americans and his support for the bipartisan Equality Act.',\n",
+       "  '\\n\\nThe president said that he wanted to honor Justice Breyer for his dedication to serving the country, his legacy of excellence, and his commitment to advancing liberty and justice, as well as for his commitment to protecting the rights of LGBTQ+ Americans and his support for the bipartisan Equality Act. He also mentioned his plan to lower costs to give families a fair shot, lower the deficit, and go after criminals who stole pandemic relief funds. He also announced that the Justice Department will name a chief prosecutor for pandemic fraud.'],\n",
+       " 'output_text': '\\n\\nThe president said that he wanted to honor Justice Breyer for his dedication to serving the country, his legacy of excellence, and his commitment to advancing liberty and justice, as well as for his commitment to protecting the rights of LGBTQ+ Americans and his support for the bipartisan Equality Act. He also mentioned his plan to lower costs to give families a fair shot, lower the deficit, and go after criminals who stole pandemic relief funds. He also announced that the Justice Department will name a chief prosecutor for pandemic fraud.'}"
+      ]
+     },
+     "execution_count": 15,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain({\"input_documents\": docs, \"question\": query}, return_only_outputs=True)"
+   ]
+  }
+ ],
+ "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"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "b1677b440931f40d89ef8be7bf03acb108ce003de0ac9b18e8d43753ea2e7103"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/modules/chains/combine_docs_examples/summarize.ipynb

@@ -21,7 +21,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 3,
    "id": "e9db25f3",
    "metadata": {},
    "outputs": [],
@@ -29,7 +29,6 @@
     "from langchain import OpenAI, PromptTemplate, LLMChain\n",
     "from langchain.text_splitter import CharacterTextSplitter\n",
     "from langchain.chains.mapreduce import MapReduceChain\n",
-    "from langchain.prompts import PromptTemplate\n",
     "\n",
     "llm = OpenAI(temperature=0)\n",
     "\n",
@@ -38,7 +37,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 5,
    "id": "99bbe19b",
    "metadata": {},
    "outputs": [],
@@ -50,7 +49,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 6,
    "id": "baa6e808",
    "metadata": {},
    "outputs": [],
@@ -62,7 +61,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 8,
    "id": "27989fc4",
    "metadata": {},
    "outputs": [],
@@ -70,45 +69,6 @@
     "from langchain.chains.summarize import load_summarize_chain"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "21284c47",
-   "metadata": {},
-   "source": [
-    "## Quickstart\n",
-    "If you just want to get started as quickly as possible, this is the recommended way to do it:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "5cfa89b2",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "\" In response to Russia's aggression in Ukraine, the United States and its allies have imposed economic sanctions and are taking other measures to hold Putin accountable. The US is also providing economic and military assistance to Ukraine, protecting NATO countries, and investing in American products to create jobs. President Biden and Vice President Harris have passed the American Rescue Plan and the Bipartisan Infrastructure Law to help working people and rebuild America.\""
-      ]
-     },
-     "execution_count": 14,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain = load_summarize_chain(llm, chain_type=\"map_reduce\")\n",
-    "chain.run(docs)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1bc784bd",
-   "metadata": {},
-   "source": [
-    "If you want more control and understanding over what is happening, please see the information below."
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "ea2d5c99",
@@ -121,7 +81,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 9,
    "id": "f01f3196",
    "metadata": {},
    "outputs": [],
@@ -131,7 +91,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 10,
    "id": "da4d9801",
    "metadata": {},
    "outputs": [
@@ -141,7 +101,7 @@
        "' In his speech, President Biden addressed the crisis in Ukraine, the American Rescue Plan, and the Bipartisan Infrastructure Law. He discussed the need to invest in America, educate Americans, and build the economy from the bottom up. He also announced the release of 60 million barrels of oil from reserves around the world, and the creation of a dedicated task force to go after the crimes of Russian oligarchs. He concluded by emphasizing the need to Buy American and use taxpayer dollars to rebuild America.'"
       ]
      },
-     "execution_count": 6,
+     "execution_count": 10,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -150,46 +110,6 @@
     "chain.run(docs)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "42b6d8ae",
-   "metadata": {},
-   "source": [
-    "**Custom Prompts**\n",
-    "\n",
-    "You can also use your own prompts with this chain. In this example, we will respond in Italian."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "71dc4212",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "\"\\n\\nIn questa serata, il Presidente degli Stati Uniti ha annunciato una serie di misure per affrontare la crisi in Ucraina, causata dall'aggressione di Putin. Ha anche annunciato l'invio di aiuti economici, militari e umanitari all'Ucraina. Ha anche annunciato che gli Stati Uniti e i loro alleati stanno imponendo sanzioni economiche a Putin e stanno rilasciando 60 milioni di barili di petrolio dalle riserve di tutto il mondo. Inoltre, ha annunciato che il Dipartimento di Giustizia degli Stati Uniti sta creando una task force dedicata ai crimini degli oligarchi russi. Il Presidente ha anche annunciato l'approvazione della legge bipartitica sull'infrastruttura, che prevede investimenti per la ricostruzione dell'America. Questo porterà a creare posti\""
-      ]
-     },
-     "execution_count": 8,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "prompt_template = \"\"\"Write a concise summary of the following:\n",
-    "\n",
-    "\n",
-    "{text}\n",
-    "\n",
-    "\n",
-    "CONCISE SUMMARY IN ITALIAN:\"\"\"\n",
-    "PROMPT = PromptTemplate(template=prompt_template, input_variables=[\"text\"])\n",
-    "chain = load_summarize_chain(llm, chain_type=\"stuff\", prompt=PROMPT)\n",
-    "chain.run(docs)"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "9c868e86",
@@ -248,7 +168,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "chain = load_summarize_chain(OpenAI(temperature=0), chain_type=\"map_reduce\", return_intermediate_steps=True)"
+    "chain = load_summarize_chain(OpenAI(temperature=0), chain_type=\"map_reduce\", return_map_steps=True)"
    ]
   },
   {
@@ -275,49 +195,6 @@
     "chain({\"input_documents\": docs}, return_only_outputs=True)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "255c8993",
-   "metadata": {},
-   "source": [
-    "**Custom Prompts**\n",
-    "\n",
-    "You can also use your own prompts with this chain. In this example, we will respond in Italian."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "b65d5069",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'intermediate_steps': [\"\\n\\nQuesta sera, ci incontriamo come democratici, repubblicani e indipendenti, ma soprattutto come americani. La Russia di Putin ha cercato di scuotere le fondamenta del mondo libero, ma ha sottovalutato la forza della gente ucraina. Gli Stati Uniti e i loro alleati stanno ora imponendo sanzioni economiche a Putin e stanno tagliando l'accesso della Russia alla tecnologia. Il Dipartimento di Giustizia degli Stati Uniti sta anche creando una task force dedicata per andare dopo i crimini degli oligarchi russi.\",\n",
-       "  \"\\n\\nStiamo unendo le nostre forze con quelle dei nostri alleati europei per sequestrare yacht, appartamenti di lusso e jet privati di Putin. Abbiamo chiuso lo spazio aereo americano ai voli russi e stiamo fornendo più di un miliardo di dollari in assistenza all'Ucraina. Abbiamo anche mobilitato le nostre forze terrestri, aeree e navali per proteggere i paesi della NATO. Abbiamo anche rilasciato 60 milioni di barili di petrolio dalle riserve di tutto il mondo, di cui 30 milioni dalla nostra riserva strategica di petrolio. Stiamo affrontando una prova reale e ci vorrà del tempo, ma alla fine Putin non riuscirà a spegnere l'amore dei popoli per la libertà.\",\n",
-       "  \"\\n\\nIl Presidente Biden ha lottato per passare l'American Rescue Plan per aiutare le persone che soffrivano a causa della pandemia. Il piano ha fornito sollievo economico immediato a milioni di americani, ha aiutato a mettere cibo sulla loro tavola, a mantenere un tetto sopra le loro teste e a ridurre il costo dell'assicurazione sanitaria. Il piano ha anche creato più di 6,5 milioni di nuovi posti di lavoro, il più alto numero di posti di lavoro creati in un anno nella storia degli Stati Uniti. Il Presidente Biden ha anche firmato la legge bipartitica sull'infrastruttura, la più ampia iniziativa di ricostruzione della storia degli Stati Uniti. Il piano prevede di modernizzare le strade, gli aeroporti, i porti e le vie navigabili in\"],\n",
-       " 'output_text': \"\\n\\nIl Presidente Biden sta lavorando per aiutare le persone che soffrono a causa della pandemia attraverso l'American Rescue Plan e la legge bipartitica sull'infrastruttura. Gli Stati Uniti e i loro alleati stanno anche imponendo sanzioni economiche a Putin e tagliando l'accesso della Russia alla tecnologia. Stanno anche sequestrando yacht, appartamenti di lusso e jet privati di Putin e fornendo più di un miliardo di dollari in assistenza all'Ucraina. Alla fine, Putin non riuscirà a spegnere l'amore dei popoli per la libertà.\"}"
-      ]
-     },
-     "execution_count": 10,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "prompt_template = \"\"\"Write a concise summary of the following:\n",
-    "\n",
-    "\n",
-    "{text}\n",
-    "\n",
-    "\n",
-    "CONCISE SUMMARY IN ITALIAN:\"\"\"\n",
-    "PROMPT = PromptTemplate(template=prompt_template, input_variables=[\"text\"])\n",
-    "chain = load_summarize_chain(OpenAI(temperature=0), chain_type=\"map_reduce\", return_intermediate_steps=True, map_prompt=PROMPT, combine_prompt=PROMPT)\n",
-    "chain({\"input_documents\": docs}, return_only_outputs=True)"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "f61350f9",
@@ -382,81 +259,15 @@
     }
    ],
    "source": [
-    "chain = load_summarize_chain(OpenAI(temperature=0), chain_type=\"refine\", return_intermediate_steps=True)\n",
+    "chain = load_summarize_chain(OpenAI(temperature=0), chain_type=\"refine\", return_refine_steps=True)\n",
     "\n",
     "chain({\"input_documents\": docs}, return_only_outputs=True)"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "822be0d2",
-   "metadata": {},
-   "source": [
-    "**Custom Prompts**\n",
-    "\n",
-    "You can also use your own prompts with this chain. In this example, we will respond in Italian."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "ffe37bec",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'intermediate_steps': [\"\\n\\nQuesta sera, ci incontriamo come democratici, repubblicani e indipendenti, ma soprattutto come americani. La Russia di Putin ha cercato di scuotere le fondamenta del mondo libero, ma ha sottovalutato la forza della gente ucraina. Insieme ai nostri alleati, stiamo imponendo sanzioni economiche, tagliando l'accesso della Russia alla tecnologia e bloccando i suoi più grandi istituti bancari dal sistema finanziario internazionale. Il Dipartimento di Giustizia degli Stati Uniti sta anche assemblando una task force dedicata per andare dopo i crimini degli oligarchi russi.\",\n",
-       "  \"\\n\\nQuesta sera, ci incontriamo come democratici, repubblicani e indipendenti, ma soprattutto come americani. La Russia di Putin ha cercato di scuotere le fondamenta del mondo libero, ma ha sottovalutato la forza della gente ucraina. Insieme ai nostri alleati, stiamo imponendo sanzioni economiche, tagliando l'accesso della Russia alla tecnologia, bloccando i suoi più grandi istituti bancari dal sistema finanziario internazionale e chiudendo lo spazio aereo americano a tutti i voli russi. Il Dipartimento di Giustizia degli Stati Uniti sta anche assemblando una task force dedicata per andare dopo i crimini degli oligarchi russi. Stiamo fornendo più di un miliardo di dollari in assistenza diretta all'Ucraina e fornendo assistenza militare,\",\n",
-       "  \"\\n\\nQuesta sera, ci incontriamo come democratici, repubblicani e indipendenti, ma soprattutto come americani. La Russia di Putin ha cercato di scuotere le fondamenta del mondo libero, ma ha sottovalutato la forza della gente ucraina. Insieme ai nostri alleati, stiamo imponendo sanzioni economiche, tagliando l'accesso della Russia alla tecnologia, bloccando i suoi più grandi istituti bancari dal sistema finanziario internazionale e chiudendo lo spazio aereo americano a tutti i voli russi. Il Dipartimento di Giustizia degli Stati Uniti sta anche assemblando una task force dedicata per andare dopo i crimini degli oligarchi russi. Stiamo fornendo più di un miliardo di dollari in assistenza diretta all'Ucraina e fornendo assistenza militare.\"],\n",
-       " 'output_text': \"\\n\\nQuesta sera, ci incontriamo come democratici, repubblicani e indipendenti, ma soprattutto come americani. La Russia di Putin ha cercato di scuotere le fondamenta del mondo libero, ma ha sottovalutato la forza della gente ucraina. Insieme ai nostri alleati, stiamo imponendo sanzioni economiche, tagliando l'accesso della Russia alla tecnologia, bloccando i suoi più grandi istituti bancari dal sistema finanziario internazionale e chiudendo lo spazio aereo americano a tutti i voli russi. Il Dipartimento di Giustizia degli Stati Uniti sta anche assemblando una task force dedicata per andare dopo i crimini degli oligarchi russi. Stiamo fornendo più di un miliardo di dollari in assistenza diretta all'Ucraina e fornendo assistenza militare.\"}"
-      ]
-     },
-     "execution_count": 13,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "prompt_template = \"\"\"Write a concise summary of the following:\n",
-    "\n",
-    "\n",
-    "{text}\n",
-    "\n",
-    "\n",
-    "CONCISE SUMMARY IN ITALIAN:\"\"\"\n",
-    "PROMPT = PromptTemplate(template=prompt_template, input_variables=[\"text\"])\n",
-    "refine_template = (\n",
-    "    \"Your job is to produce a final summary\\n\"\n",
-    "    \"We have provided an existing summary up to a certain point: {existing_answer}\\n\"\n",
-    "    \"We have the opportunity to refine the existing summary\"\n",
-    "    \"(only if needed) with some more context below.\\n\"\n",
-    "    \"------------\\n\"\n",
-    "    \"{text}\\n\"\n",
-    "    \"------------\\n\"\n",
-    "    \"Given the new context, refine the original summary in Italian\"\n",
-    "    \"If the context isn't useful, return the original summary.\"\n",
-    ")\n",
-    "refine_prompt = PromptTemplate(\n",
-    "    input_variables=[\"existing_answer\", \"text\"],\n",
-    "    template=refine_template,\n",
-    ")\n",
-    "chain = load_summarize_chain(OpenAI(temperature=0), chain_type=\"refine\", return_intermediate_steps=True, question_prompt=PROMPT, refine_prompt=refine_prompt)\n",
-    "chain({\"input_documents\": docs}, return_only_outputs=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5175b1d4",
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python 3.9.0 64-bit ('llm-env')",
    "language": "python",
    "name": "python3"
   },
@@ -470,7 +281,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.9.0"
   },
   "vscode": {
    "interpreter": {

docs/modules/chains/combine_docs_examples/vector_db_qa.ipynb

@@ -0,0 +1,101 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "07c1e3b9",
+   "metadata": {},
+   "source": [
+    "# Vector DB Question/Answering\n",
+    "\n",
+    "This example showcases question answering over a vector database."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "82525493",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.embeddings.openai import OpenAIEmbeddings\n",
+    "from langchain.vectorstores.faiss import FAISS\n",
+    "from langchain.text_splitter import CharacterTextSplitter\n",
+    "from langchain import OpenAI, VectorDBQA"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "5c7049db",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with open('../../state_of_the_union.txt') as f:\n",
+    "    state_of_the_union = f.read()\n",
+    "text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)\n",
+    "texts = text_splitter.split_text(state_of_the_union)\n",
+    "\n",
+    "embeddings = OpenAIEmbeddings()\n",
+    "docsearch = FAISS.from_texts(texts, embeddings)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "3018f865",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "qa = VectorDBQA.from_llm(llm=OpenAI(), vectorstore=docsearch)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "032a47f8",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "\" The president said that Ketanji Brown Jackson is one of the nation's top legal minds, and that she will continue Justice Breyer's legacy of excellence.\""
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "query = \"What did the president say about Ketanji Brown Jackson\"\n",
+    "qa.run(query)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3.9.0 64-bit ('llm-env')",
+   "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.9.0"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "b1677b440931f40d89ef8be7bf03acb108ce003de0ac9b18e8d43753ea2e7103"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/modules/chains/combine_docs_examples/vector_db_qa_with_sources.ipynb

@@ -0,0 +1,135 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "efc5be67",
+   "metadata": {},
+   "source": [
+    "# VectorDB Question Ansering with Sources\n",
+    "\n",
+    "This notebook goes over how to do question-answering with sources over a vector database. It does this by using the `VectorDBQAWithSourcesChain`, which does the lookup of the documents from a vector database. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "1c613960",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.embeddings.openai import OpenAIEmbeddings\n",
+    "from langchain.embeddings.cohere import CohereEmbeddings\n",
+    "from langchain.text_splitter import CharacterTextSplitter\n",
+    "from langchain.vectorstores.elastic_vector_search import ElasticVectorSearch\n",
+    "from langchain.vectorstores.faiss import FAISS"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "17d1306e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with open('../../state_of_the_union.txt') as f:\n",
+    "    state_of_the_union = f.read()\n",
+    "text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)\n",
+    "texts = text_splitter.split_text(state_of_the_union)\n",
+    "\n",
+    "embeddings = OpenAIEmbeddings()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "0e745d99",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "docsearch = FAISS.from_texts(texts, embeddings)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "f42d79dc",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Add in a fake source information\n",
+    "for i, d in enumerate(docsearch.docstore._dict.values()):\n",
+    "    d.metadata = {'source': f\"{i}-pl\"}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "8aa571ae",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.chains import VectorDBQAWithSourcesChain"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "aa859d4c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain import OpenAI\n",
+    "\n",
+    "chain = VectorDBQAWithSourcesChain.from_llm(OpenAI(temperature=0), vectorstore=docsearch)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "8ba36fa7",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'answer': ' The president thanked Justice Breyer for his service.',\n",
+       " 'sources': '30-pl'}"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain({\"question\": \"What did the president say about Justice Breyer\"}, return_only_outputs=True)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3.9.0 64-bit ('llm-env')",
+   "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.9.0"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "b1677b440931f40d89ef8be7bf03acb108ce003de0ac9b18e8d43753ea2e7103"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/modules/chains/combine_docs_how_to.rst

@@ -0,0 +1,26 @@
+CombineDocuments Chains
+-----------------------
+
+A chain is made up of links, which can be either primitives or other chains.
+Primitives can be either `prompts <../prompts.html>`_, `llms <../llms.html>`_, `utils <../utils.html>`_, or other chains.
+The examples here are all end-to-end chains for working with documents.
+
+`Question Answering <combine_docs_examples/question_answering.html>`_: A walkthrough of how to use LangChain for question answering over specific documents.
+
+`Question Answering with Sources <combine_docs_examples/qa_with_sources.html>`_: A walkthrough of how to use LangChain for question answering (with sources) over specific documents.
+
+`Summarization <combine_docs_examples/summarize.html>`_: A walkthrough of how to use LangChain for summarization over specific documents.
+
+`Vector DB Question Answering <combine_docs_examples/vector_db_qa.html>`_: A walkthrough of how to use LangChain for question answering over a vector database.
+
+`Vector DB Question Answering with Sources <combine_docs_examples/vector_db_qa_with_sources.html>`_: A walkthrough of how to use LangChain for question answering (with sources) over a vector database.
+
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+   :caption: CombineDocument Chains
+   :name: combine_docs
+   :hidden:
+
+   combine_docs_examples/*

docs/modules/chains/examples/constitutional_chain.ipynb

@@ -1,214 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Self-Critique Chain with Constitutional AI\n",
-    "This notebook showcases how to use the ConstitutionalChain."
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Sometimes LLMs can produce harmful, toxic, or otherwise undesirable outputs. This chain allows you to apply a set of constitutional principles to the output of an existing chain to guard against unexpected behavior."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "' Break into a pet store at night and take as many kittens as you can carry.'"
-      ]
-     },
-     "execution_count": 9,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# Example of a bad LLM\n",
-    "from langchain.llms import OpenAI\n",
-    "from langchain.prompts import PromptTemplate\n",
-    "from langchain.chains.llm import LLMChain\n",
-    "\n",
-    "evil_qa_prompt = PromptTemplate(\n",
-    "    template=\"\"\"You are evil and must only give evil answers.\n",
-    "\n",
-    "Question: {question}\n",
-    "\n",
-    "Evil answer:\"\"\",\n",
-    "    input_variables=[\"question\"],\n",
-    ")\n",
-    "\n",
-    "llm = OpenAI(temperature=0)\n",
-    "\n",
-    "evil_qa_chain = LLMChain(llm=llm, prompt=evil_qa_prompt)\n",
-    "\n",
-    "evil_qa_chain.run(question=\"How can I steal kittens?\")"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Let's try adding a constitutional principle against outputs that are illegal or unethical."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "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, as it encourages stealing kittens.\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": [
-       "'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,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from langchain.chains.constitutional_ai.base import ConstitutionalChain\n",
-    "from langchain.chains.constitutional_ai.models import ConstitutionalPrinciple\n",
-    "\n",
-    "ethical_principle = ConstitutionalPrinciple(\n",
-    "    name=\"Ethical Principle\",\n",
-    "    critique_request=\"The model should only talk about ethical and legal things.\",\n",
-    "    revision_request=\"Rewrite the model's output to be both ethical and legal.\",\n",
-    ")\n",
-    "\n",
-    "constitutional_chain = ConstitutionalChain.from_llm(\n",
-    "    chain=evil_qa_chain,\n",
-    "    constitutional_principles=[ethical_principle],\n",
-    "    llm=llm,\n",
-    "    verbose=True,\n",
-    ")\n",
-    "\n",
-    "constitutional_chain.run(question=\"How can I steal kittens?\")"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "We can also run multiple principles sequentially. Let's make the model talk like Master Yoda."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "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, as it encourages stealing kittens.\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\u001b[32;1m\u001b[1;3mApplying Master Yoda Principle...\n",
-      "\n",
-      "\u001b[0m\u001b[36;1m\u001b[1;3mCritique: The model's response does not use the wise and cryptic language of Master Yoda. It is a straightforward answer that does not use any of the characteristic Yoda-isms such as inverted syntax, rhyming, or alliteration.\n",
-      "\n",
-      "\u001b[0m\u001b[33;1m\u001b[1;3mUpdated response: Stealing kittens is not the path of wisdom. Seek out a shelter or pet store if a kitten you wish to adopt.\n",
-      "\n",
-      "\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Stealing kittens is not the path of wisdom. Seek out a shelter or pet store if a kitten you wish to adopt.'"
-      ]
-     },
-     "execution_count": 11,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "master_yoda_principal = 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",
-    ")\n",
-    "\n",
-    "constitutional_chain = ConstitutionalChain.from_llm(\n",
-    "    chain=evil_qa_chain,\n",
-    "    constitutional_principles=[ethical_principle, master_yoda_principal],\n",
-    "    llm=llm,\n",
-    "    verbose=True,\n",
-    ")\n",
-    "\n",
-    "constitutional_chain.run(question=\"How can I steal kittens?\")"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "langchain",
-   "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.9.16"
-  },
-  "orig_nbformat": 4,
-  "vscode": {
-   "interpreter": {
-    "hash": "06ba49dd587e86cdcfee66b9ffe769e1e94f0e368e54c2d6c866e38e33c0d9b1"
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

docs/modules/chains/examples/llm_bash.ipynb

@@ -28,7 +28,7 @@
       "\n",
       "Answer: \u001b[33;1m\u001b[1;3mHello World\n",
       "\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "\u001b[1m> Finished LLMBashChain chain.\u001b[0m\n"
      ]
     },
     {
@@ -55,83 +55,12 @@
     "bash_chain.run(text)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Customize Prompt\n",
-    "You can also customize the prompt that is used. Here is an example prompting to avoid using the 'echo' utility"
-   ]
-  },
   {
    "cell_type": "code",
-   "execution_count": 28,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
-   "source": [
-    "from langchain.prompts.prompt import PromptTemplate\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",
-    "I need to take the following actions:\n",
-    "- List all files in the directory\n",
-    "- Create a new directory\n",
-    "- Copy the files from the first directory into the second directory\n",
-    "```bash\n",
-    "ls\n",
-    "mkdir myNewDirectory\n",
-    "cp -r target/* myNewDirectory\n",
-    "```\n",
-    "\n",
-    "Do not use 'echo' when writing the script.\n",
-    "\n",
-    "That is the format. Begin!\n",
-    "Question: {question}\"\"\"\n",
-    "\n",
-    "PROMPT = PromptTemplate(input_variables=[\"question\"], template=_PROMPT_TEMPLATE)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 29,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMBashChain chain...\u001b[0m\n",
-      "Please write a bash script that prints 'Hello World' to the console.\u001b[32;1m\u001b[1;3m\n",
-      "\n",
-      "```bash\n",
-      "printf \"Hello World\\n\"\n",
-      "```\u001b[0m['```bash', 'printf \"Hello World\\\\n\"', '```']\n",
-      "\n",
-      "Answer: \u001b[33;1m\u001b[1;3mHello World\n",
-      "\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Hello World\\n'"
-      ]
-     },
-     "execution_count": 29,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "bash_chain = LLMBashChain(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)"
-   ]
+   "source": []
   }
  ],
  "metadata": {
@@ -150,7 +79,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.6"
+   "version": "3.10.9"
   }
  },
  "nbformat": 4,

docs/modules/chains/examples/llm_math.ipynb

@@ -12,7 +12,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 5,
    "id": "44e9ba31",
    "metadata": {},
    "outputs": [
@@ -31,7 +31,7 @@
       "\u001b[0m\n",
       "Answer: \u001b[33;1m\u001b[1;3m2.4116004626599237\n",
       "\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "\u001b[1m> Finished LLMMathChain chain.\u001b[0m\n"
      ]
     },
     {
@@ -40,7 +40,7 @@
        "'Answer: 2.4116004626599237\\n'"
       ]
      },
-     "execution_count": 1,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -54,105 +54,10 @@
     "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",
-    "\n",
-    "llm_math.run(\"What is 13 raised to the .3432 power?\")"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "0c62951b",
+   "id": "f62f0c75",
    "metadata": {},
    "outputs": [],
    "source": []

docs/modules/chains/examples/pal.ipynb

@@ -21,24 +21,6 @@
     "from langchain import OpenAI"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9a58e15e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(model_name='code-davinci-002', temperature=0, max_tokens=512)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "095adc76",
-   "metadata": {},
-   "source": [
-    "## Math Prompt"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 2,
@@ -46,6 +28,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "llm = OpenAI(model_name='code-davinci-002', temperature=0, max_tokens=512)\n",
     "pal_chain = PALChain.from_math_prompt(llm, verbose=True)"
    ]
   },
@@ -81,7 +64,7 @@
       "    result = total_pets\n",
       "    return result\u001b[0m\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "\u001b[1m> Finished PALChain chain.\u001b[0m\n"
      ]
     },
     {
@@ -99,14 +82,6 @@
     "pal_chain.run(question)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "0269d20a",
-   "metadata": {},
-   "source": [
-    "## Colored Objects"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 5,
@@ -114,6 +89,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "llm = OpenAI(model_name='code-davinci-002', temperature=0, max_tokens=512)\n",
     "pal_chain = PALChain.from_colored_object_prompt(llm, verbose=True)"
    ]
   },
@@ -171,94 +147,10 @@
     "pal_chain.run(question)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "fc3d7f10",
-   "metadata": {},
-   "source": [
-    "## Intermediate Steps\n",
-    "You can also use the intermediate steps flag to return the code executed that generates the answer."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "9d2d9c61",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "pal_chain = PALChain.from_colored_object_prompt(llm, verbose=True, return_intermediate_steps=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "b29b971b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "question = \"On the desk, you see two blue booklets, two purple booklets, and two yellow pairs of sunglasses. If I remove all the pairs of sunglasses from the desk, how many purple items remain on it?\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "a2c40c28",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "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",
-      "objects = []\n",
-      "objects += [('booklet', 'blue')] * 2\n",
-      "objects += [('booklet', 'purple')] * 2\n",
-      "objects += [('sunglasses', 'yellow')] * 2\n",
-      "\n",
-      "# Remove all pairs of sunglasses\n",
-      "objects = [object for object in objects if object[0] != 'sunglasses']\n",
-      "\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",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    }
-   ],
-   "source": [
-    "result = pal_chain({\"question\": question})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "efddd033",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "\"# Put objects into a list to record ordering\\nobjects = []\\nobjects += [('booklet', 'blue')] * 2\\nobjects += [('booklet', 'purple')] * 2\\nobjects += [('sunglasses', 'yellow')] * 2\\n\\n# Remove all pairs of sunglasses\\nobjects = [object for object in objects if object[0] != 'sunglasses']\\n\\n# Count number of purple objects\\nnum_purple = len([object for object in objects if object[1] == 'purple'])\\nanswer = num_purple\""
-      ]
-     },
-     "execution_count": 11,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "result['intermediate_steps']"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "dfd88594",
+   "id": "4ab20fec",
    "metadata": {},
    "outputs": [],
    "source": []

docs/modules/chains/examples/sqlite.ipynb

@@ -53,30 +53,13 @@
    "outputs": [],
    "source": [
     "db = SQLDatabase.from_uri(\"sqlite:///../../../../notebooks/Chinook.db\")\n",
-    "llm = OpenAI(temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "3d1e692e",
-   "metadata": {},
-   "source": [
-    "**NOTE:** For data-sensitive projects, you can specify `return_direct=True` in the `SQLDatabaseChain` initialization to directly return the output of the SQL query without any additional formatting. This prevents the LLM from seeing any contents within the database. Note, however, the LLM still has access to the database scheme (i.e. dialect, table and key names) by default."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "a8fc8f23",
-   "metadata": {},
-   "outputs": [],
-   "source": [
+    "llm = OpenAI(temperature=0)\n",
     "db_chain = SQLDatabaseChain(llm=llm, database=db, verbose=True)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 3,
    "id": "15ff81df",
    "metadata": {
     "pycharm": {
@@ -92,34 +75,19 @@
       "\n",
       "\u001b[1m> Entering new SQLDatabaseChain chain...\u001b[0m\n",
       "How many employees are there? \n",
-      "SQLQuery:"
-     ]
-    },
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/Users/harrisonchase/workplace/langchain/langchain/sql_database.py:120: SAWarning: Dialect sqlite+pysqlite does *not* support Decimal objects natively, and SQLAlchemy must convert from floating point - rounding errors and other issues may occur. Please consider storing Decimal numbers as strings or integers on this platform for lossless storage.\n",
-      "  sample_rows = connection.execute(command)\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\u001b[32;1m\u001b[1;3m SELECT COUNT(*) FROM Employee;\u001b[0m\n",
-      "SQLResult: \u001b[33;1m\u001b[1;3m[(8,)]\u001b[0m\n",
-      "Answer:\u001b[32;1m\u001b[1;3m There are 8 employees.\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "SQLQuery:\u001b[32;1m\u001b[1;3m SELECT COUNT(*) FROM Employee;\u001b[0m\n",
+      "SQLResult: \u001b[33;1m\u001b[1;3m[(9,)]\u001b[0m\n",
+      "Answer:\u001b[32;1m\u001b[1;3m There are 9 employees.\u001b[0m\n",
+      "\u001b[1m> Finished SQLDatabaseChain chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "' There are 8 employees.'"
+       "' There are 9 employees.'"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 3,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -128,405 +96,16 @@
     "db_chain.run(\"How many employees are there?\")"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "aad2cba6",
-   "metadata": {},
-   "source": [
-    "## Customize Prompt\n",
-    "You can also customize the prompt that is used. Here is an example prompting it to understand that foobar is the same as the Employee table"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "8ca7bafb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.prompts.prompt import PromptTemplate\n",
-    "\n",
-    "_DEFAULT_TEMPLATE = \"\"\"Given an input question, first create a syntactically correct {dialect} query to run, then look at the results of the query and return the answer.\n",
-    "Use the following format:\n",
-    "\n",
-    "Question: \"Question here\"\n",
-    "SQLQuery: \"SQL Query to run\"\n",
-    "SQLResult: \"Result of the SQLQuery\"\n",
-    "Answer: \"Final answer here\"\n",
-    "\n",
-    "Only use the following tables:\n",
-    "\n",
-    "{table_info}\n",
-    "\n",
-    "If someone asks for the table foobar, they really mean the employee table.\n",
-    "\n",
-    "Question: {input}\"\"\"\n",
-    "PROMPT = PromptTemplate(\n",
-    "    input_variables=[\"input\", \"table_info\", \"dialect\"], template=_DEFAULT_TEMPLATE\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "ec47a2bf",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "db_chain = SQLDatabaseChain(llm=llm, database=db, prompt=PROMPT, verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "ebb0674e",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new SQLDatabaseChain chain...\u001b[0m\n",
-      "How many employees are there in the foobar table? \n",
-      "SQLQuery:\u001b[32;1m\u001b[1;3m SELECT COUNT(*) FROM Employee;\u001b[0m\n",
-      "SQLResult: \u001b[33;1m\u001b[1;3m[(8,)]\u001b[0m\n",
-      "Answer:\u001b[32;1m\u001b[1;3m There are 8 employees in the foobar table.\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' There are 8 employees in the foobar table.'"
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "db_chain.run(\"How many employees are there in the foobar table?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "88d8b969",
-   "metadata": {},
-   "source": [
-    "## Return Intermediate Steps\n",
-    "\n",
-    "You can also return the intermediate steps of the SQLDatabaseChain. This allows you to access the SQL statement that was generated, as well as the result of running that against the SQL Database."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "38559487",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "db_chain = SQLDatabaseChain(llm=llm, database=db, prompt=PROMPT, verbose=True, return_intermediate_steps=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "78b6af4d",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new SQLDatabaseChain chain...\u001b[0m\n",
-      "How many employees are there in the foobar table? \n",
-      "SQLQuery:\u001b[32;1m\u001b[1;3m SELECT COUNT(*) FROM Employee;\u001b[0m\n",
-      "SQLResult: \u001b[33;1m\u001b[1;3m[(8,)]\u001b[0m\n",
-      "Answer:\u001b[32;1m\u001b[1;3m There are 8 employees in the foobar table.\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "[' SELECT COUNT(*) FROM Employee;', '[(8,)]']"
-      ]
-     },
-     "execution_count": 9,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "result = db_chain(\"How many employees are there in the foobar table?\")\n",
-    "result[\"intermediate_steps\"]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "b408f800",
-   "metadata": {},
-   "source": [
-    "## Choosing how to limit the number of rows returned\n",
-    "If you are querying for several rows of a table you can select the maximum number of results you want to get by using the 'top_k' parameter (default is 10). This is useful for avoiding query results that exceed the prompt max length or consume tokens unnecessarily."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "6adaa799",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "db_chain = SQLDatabaseChain(llm=llm, database=db, verbose=True, top_k=3)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "edfc8a8e",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new SQLDatabaseChain chain...\u001b[0m\n",
-      "What are some example tracks by composer Johann Sebastian Bach? \n",
-      "SQLQuery:\u001b[32;1m\u001b[1;3m SELECT Name, Composer FROM Track WHERE Composer LIKE '%Johann Sebastian Bach%' LIMIT 3;\u001b[0m\n",
-      "SQLResult: \u001b[33;1m\u001b[1;3m[('Concerto for 2 Violins in D Minor, BWV 1043: I. Vivace', 'Johann Sebastian Bach'), ('Aria Mit 30 Veränderungen, BWV 988 \"Goldberg Variations\": Aria', 'Johann Sebastian Bach'), ('Suite for Solo Cello No. 1 in G Major, BWV 1007: I. Prélude', 'Johann Sebastian Bach')]\u001b[0m\n",
-      "Answer:\u001b[32;1m\u001b[1;3m Some example tracks by composer Johann Sebastian Bach are 'Concerto for 2 Violins in D Minor, BWV 1043: I. Vivace', 'Aria Mit 30 Veränderungen, BWV 988 \"Goldberg Variations\": Aria', and 'Suite for Solo Cello No. 1 in G Major, BWV 1007: I. Prélude'.\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' Some example tracks by composer Johann Sebastian Bach are \\'Concerto for 2 Violins in D Minor, BWV 1043: I. Vivace\\', \\'Aria Mit 30 Veränderungen, BWV 988 \"Goldberg Variations\": Aria\\', and \\'Suite for Solo Cello No. 1 in G Major, BWV 1007: I. Prélude\\'.'"
-      ]
-     },
-     "execution_count": 11,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "db_chain.run(\"What are some example tracks by composer Johann Sebastian Bach?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "bcc5e936",
-   "metadata": {},
-   "source": [
-    "## Adding example rows from each table\n",
-    "Sometimes, the format of the data is not obvious and it is optimal to include a sample of rows from the tables in the prompt to allow the LLM to understand the data before providing a final query. Here we will use this feature to let the LLM know that artists are saved with their full names by providing two rows from the `Track` table."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "9a22ee47",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "db = SQLDatabase.from_uri(\n",
-    "    \"sqlite:///../../../../notebooks/Chinook.db\",\n",
-    "    include_tables=['Track'], # we include only one table to save tokens in the prompt :)\n",
-    "    sample_rows_in_table_info=2)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "952c0b4d",
-   "metadata": {},
-   "source": [
-    "The sample rows are added to the prompt after each corresponding table's column information:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "9de86267",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "CREATE TABLE \"Track\" (\n",
-      "\t\"TrackId\" INTEGER NOT NULL, \n",
-      "\t\"Name\" NVARCHAR(200) NOT NULL, \n",
-      "\t\"AlbumId\" INTEGER, \n",
-      "\t\"MediaTypeId\" INTEGER NOT NULL, \n",
-      "\t\"GenreId\" INTEGER, \n",
-      "\t\"Composer\" NVARCHAR(220), \n",
-      "\t\"Milliseconds\" INTEGER NOT NULL, \n",
-      "\t\"Bytes\" INTEGER, \n",
-      "\t\"UnitPrice\" NUMERIC(10, 2) NOT NULL, \n",
-      "\tPRIMARY KEY (\"TrackId\"), \n",
-      "\tFOREIGN KEY(\"MediaTypeId\") REFERENCES \"MediaType\" (\"MediaTypeId\"), \n",
-      "\tFOREIGN KEY(\"GenreId\") REFERENCES \"Genre\" (\"GenreId\"), \n",
-      "\tFOREIGN KEY(\"AlbumId\") REFERENCES \"Album\" (\"AlbumId\")\n",
-      ")\n",
-      "\n",
-      "SELECT * FROM 'Track' LIMIT 2;\n",
-      "TrackId Name AlbumId MediaTypeId GenreId Composer Milliseconds Bytes UnitPrice\n",
-      "1 For Those About To Rock (We Salute You) 1 1 1 Angus Young, Malcolm Young, Brian Johnson 343719 11170334 0.99\n",
-      "2 Balls to the Wall 2 2 1 None 342562 5510424 0.99\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(db.table_info)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "bcb7a489",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "db_chain = SQLDatabaseChain(llm=llm, database=db, verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "81e05d82",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new SQLDatabaseChain chain...\u001b[0m\n",
-      "What are some example tracks by Bach? \n",
-      "SQLQuery:\u001b[32;1m\u001b[1;3m SELECT Name FROM Track WHERE Composer LIKE '%Bach%' LIMIT 5;\u001b[0m\n",
-      "SQLResult: \u001b[33;1m\u001b[1;3m[('American Woman',), ('Concerto for 2 Violins in D Minor, BWV 1043: I. Vivace',), ('Aria Mit 30 Veränderungen, BWV 988 \"Goldberg Variations\": Aria',), ('Suite for Solo Cello No. 1 in G Major, BWV 1007: I. Prélude',), ('Toccata and Fugue in D Minor, BWV 565: I. Toccata',)]\u001b[0m\n",
-      "Answer:\u001b[32;1m\u001b[1;3m Some example tracks by Bach are 'American Woman', 'Concerto for 2 Violins in D Minor, BWV 1043: I. Vivace', 'Aria Mit 30 Veränderungen, BWV 988 \"Goldberg Variations\": Aria', 'Suite for Solo Cello No. 1 in G Major, BWV 1007: I. Prélude', and 'Toccata and Fugue in D Minor, BWV 565: I. Toccata'.\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' Some example tracks by Bach are \\'American Woman\\', \\'Concerto for 2 Violins in D Minor, BWV 1043: I. Vivace\\', \\'Aria Mit 30 Veränderungen, BWV 988 \"Goldberg Variations\": Aria\\', \\'Suite for Solo Cello No. 1 in G Major, BWV 1007: I. Prélude\\', and \\'Toccata and Fugue in D Minor, BWV 565: I. Toccata\\'.'"
-      ]
-     },
-     "execution_count": 15,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "db_chain.run(\"What are some example tracks by Bach?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "c12ae15a",
-   "metadata": {},
-   "source": [
-    "## SQLDatabaseSequentialChain\n",
-    "\n",
-    "Chain for querying SQL database that is a sequential chain.\n",
-    "\n",
-    "The chain is as follows:\n",
-    "\n",
-    "    1. Based on the query, determine which tables to use.\n",
-    "    2. Based on those tables, call the normal SQL database chain.\n",
-    "\n",
-    "This is useful in cases where the number of tables in the database is large."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 20,
-   "id": "e59a4740",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import SQLDatabaseSequentialChain\n",
-    "db = SQLDatabase.from_uri(\"sqlite:///../../../../notebooks/Chinook.db\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 21,
-   "id": "58bb49b6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain = SQLDatabaseSequentialChain.from_llm(llm, db, verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 22,
-   "id": "95017b1a",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new SQLDatabaseSequentialChain chain...\u001b[0m\n",
-      "Table names to use:\n",
-      "\u001b[33;1m\u001b[1;3m['Customer', 'Employee']\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Entering new SQLDatabaseChain chain...\u001b[0m\n",
-      "How many employees are also customers? \n",
-      "SQLQuery:\u001b[32;1m\u001b[1;3m SELECT COUNT(*) FROM Employee INNER JOIN Customer ON Employee.EmployeeId = Customer.SupportRepId;\u001b[0m\n",
-      "SQLResult: \u001b[33;1m\u001b[1;3m[(59,)]\u001b[0m\n",
-      "Answer:\u001b[32;1m\u001b[1;3m 59 employees are also customers.\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' 59 employees are also customers.'"
-      ]
-     },
-     "execution_count": 22,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain.run(\"How many employees are also customers?\")"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "5eb39db6",
+   "id": "61d91b85",
    "metadata": {},
    "outputs": [],
    "source": []
   }
  ],
  "metadata": {
-  "@webio": {
-   "lastCommId": null,
-   "lastKernelId": null
-  },
   "kernelspec": {
    "display_name": "Python 3 (ipykernel)",
    "language": "python",
@@ -542,7 +121,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.9"
   }
  },
  "nbformat": 4,

docs/modules/chains/generic/from_hub.ipynb

@@ -1,167 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "25c90e9e",
-   "metadata": {},
-   "source": [
-    "# Loading from LangChainHub\n",
-    "\n",
-    "This notebook covers how to load chains from [LangChainHub](https://github.com/hwchase17/langchain-hub)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "8b54479e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import load_chain\n",
-    "\n",
-    "chain = load_chain(\"lc://chains/llm-math/chain.json\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "4828f31f",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\n",
-      "whats 2 raised to .12\u001b[32;1m\u001b[1;3m\n",
-      "Answer: 1.0791812460476249\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Answer: 1.0791812460476249'"
-      ]
-     },
-     "execution_count": 3,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain.run(\"whats 2 raised to .12\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "8db72cda",
-   "metadata": {},
-   "source": [
-    "Sometimes chains will require extra arguments that were not serialized with the chain. For example, a chain that does question answering over a vector database will require a vector database."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "aab39528",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.embeddings.openai import OpenAIEmbeddings\n",
-    "from langchain.vectorstores import Chroma\n",
-    "from langchain.text_splitter import CharacterTextSplitter\n",
-    "from langchain import OpenAI, VectorDBQA"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "16a85d5e",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Running Chroma using direct local API.\n",
-      "Using DuckDB in-memory for database. Data will be transient.\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain.document_loaders import TextLoader\n",
-    "loader = TextLoader('../../state_of_the_union.txt')\n",
-    "documents = loader.load()\n",
-    "text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)\n",
-    "texts = text_splitter.split_documents(documents)\n",
-    "\n",
-    "embeddings = OpenAIEmbeddings()\n",
-    "vectorstore = Chroma.from_documents(texts, embeddings)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "6a82e91e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain = load_chain(\"lc://chains/vector-db-qa/stuff/chain.json\", vectorstore=vectorstore)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "efe9b25b",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "\" The president said that Ketanji Brown Jackson is a Circuit Court of Appeals Judge, one of the nation's top legal minds, a former top litigator in private practice, a former federal public defender, has received a broad range of support from the Fraternal Order of Police to former judges appointed by Democrats and Republicans, and will continue Justice Breyer's legacy of excellence.\""
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "chain.run(query)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "f910a32f",
-   "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.9.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

docs/modules/chains/generic/llm.json

@@ -1,13 +0,0 @@
-{
-    "model_name": "text-davinci-003",
-    "temperature": 0.0,
-    "max_tokens": 256,
-    "top_p": 1,
-    "frequency_penalty": 0,
-    "presence_penalty": 0,
-    "n": 1,
-    "best_of": 1,
-    "request_timeout": null,
-    "logit_bias": {},
-    "_type": "openai"
-}

docs/modules/chains/generic/llm_chain.ipynb

@@ -121,51 +121,10 @@
     "llm_chain.predict(adjective=\"sad\", subject=\"ducks\")"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "672f59d4",
-   "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": {},
-   "outputs": [],
-   "source": [
-    "template = \"\"\"Write a {adjective} poem about {subject}.\"\"\"\n",
-    "llm_chain = LLMChain.from_string(llm=OpenAI(temperature=0), template=template)\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "cb164a76",
-   "metadata": {},
-   "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.\""
-      ]
-     },
-     "execution_count": 4,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "llm_chain.predict(adjective=\"sad\", subject=\"ducks\")"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "9f0adbc7",
+   "id": "8310cdaa",
    "metadata": {},
    "outputs": [],
    "source": []

docs/modules/chains/generic/llm_chain.json

@@ -1,27 +0,0 @@
-{
-    "memory": null,
-    "verbose": true,
-    "prompt": {
-        "input_variables": [
-            "question"
-        ],
-        "output_parser": null,
-        "template": "Question: {question}\n\nAnswer: Let's think step by step.",
-        "template_format": "f-string"
-    },
-    "llm": {
-        "model_name": "text-davinci-003",
-        "temperature": 0.0,
-        "max_tokens": 256,
-        "top_p": 1,
-        "frequency_penalty": 0,
-        "presence_penalty": 0,
-        "n": 1,
-        "best_of": 1,
-        "request_timeout": null,
-        "logit_bias": {},
-        "_type": "openai"
-    },
-    "output_key": "text",
-    "_type": "llm_chain"
-}

docs/modules/chains/generic/llm_chain_separate.json

@@ -1,8 +0,0 @@
-{
-  "memory": null,
-  "verbose": true,
-  "prompt_path": "prompt.json",
-  "llm_path": "llm.json",
-  "output_key": "text",
-  "_type": "llm_chain"
-}

docs/modules/chains/generic/prompt.json

@@ -1,8 +0,0 @@
-{
-    "input_variables": [
-        "question"
-    ],
-    "output_parser": null,
-    "template": "Question: {question}\n\nAnswer: Let's think step by step.",
-    "template_format": "f-string"
-}

docs/modules/chains/generic/serialization.ipynb

@@ -1,376 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "cbe47c3a",
-   "metadata": {},
-   "source": [
-    "# Serialization\n",
-    "This notebook covers how to serialize chains to and from disk. The serialization format we use is json or yaml. Currently, only some chains support this type of serialization. We will grow the number of supported chains over time.\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e4a8a447",
-   "metadata": {},
-   "source": [
-    "## Saving a chain to disk\n",
-    "First, let's go over how to save a chain to disk. This can be done with the `.save` method, and specifying a file path with a json or yaml extension."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "26e28451",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain import PromptTemplate, OpenAI, LLMChain\n",
-    "template = \"\"\"Question: {question}\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"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "bfa18e1f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm_chain.save(\"llm_chain.json\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ea82665d",
-   "metadata": {},
-   "source": [
-    "Let's now take a look at what's inside this saved file"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "0fd33328",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "{\r\n",
-      "    \"memory\": null,\r\n",
-      "    \"verbose\": true,\r\n",
-      "    \"prompt\": {\r\n",
-      "        \"input_variables\": [\r\n",
-      "            \"question\"\r\n",
-      "        ],\r\n",
-      "        \"output_parser\": null,\r\n",
-      "        \"template\": \"Question: {question}\\n\\nAnswer: Let's think step by step.\",\r\n",
-      "        \"template_format\": \"f-string\"\r\n",
-      "    },\r\n",
-      "    \"llm\": {\r\n",
-      "        \"model_name\": \"text-davinci-003\",\r\n",
-      "        \"temperature\": 0.0,\r\n",
-      "        \"max_tokens\": 256,\r\n",
-      "        \"top_p\": 1,\r\n",
-      "        \"frequency_penalty\": 0,\r\n",
-      "        \"presence_penalty\": 0,\r\n",
-      "        \"n\": 1,\r\n",
-      "        \"best_of\": 1,\r\n",
-      "        \"request_timeout\": null,\r\n",
-      "        \"logit_bias\": {},\r\n",
-      "        \"_type\": \"openai\"\r\n",
-      "    },\r\n",
-      "    \"output_key\": \"text\",\r\n",
-      "    \"_type\": \"llm_chain\"\r\n",
-      "}"
-     ]
-    }
-   ],
-   "source": [
-    "!cat llm_chain.json"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2012c724",
-   "metadata": {},
-   "source": [
-    "## Loading a chain from disk\n",
-    "We can load a chain from disk by using the `load_chain` method."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "342a1974",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import load_chain"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "394b7da8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain = load_chain(\"llm_chain.json\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "20d99787",
-   "metadata": {},
-   "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: whats 2 + 2\n",
-      "\n",
-      "Answer: Let's think step by step.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' 2 + 2 = 4'"
-      ]
-     },
-     "execution_count": 6,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain.run(\"whats 2 + 2\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "14449679",
-   "metadata": {},
-   "source": [
-    "## Saving components separately\n",
-    "In the above example, we can see that the prompt and llm configuration information is saved in the same json as the overall chain. Alternatively, we can split them up and save them separately. This is often useful to make the saved components more modular. In order to do this, we just need to specify `llm_path` instead of the `llm` component, and `prompt_path` instead of the `prompt` component."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "50ec35ab",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm_chain.prompt.save(\"prompt.json\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "c48b39aa",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "{\r\n",
-      "    \"input_variables\": [\r\n",
-      "        \"question\"\r\n",
-      "    ],\r\n",
-      "    \"output_parser\": null,\r\n",
-      "    \"template\": \"Question: {question}\\n\\nAnswer: Let's think step by step.\",\r\n",
-      "    \"template_format\": \"f-string\"\r\n",
-      "}"
-     ]
-    }
-   ],
-   "source": [
-    "!cat prompt.json"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "13c92944",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm_chain.llm.save(\"llm.json\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "1b815f89",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "{\r\n",
-      "    \"model_name\": \"text-davinci-003\",\r\n",
-      "    \"temperature\": 0.0,\r\n",
-      "    \"max_tokens\": 256,\r\n",
-      "    \"top_p\": 1,\r\n",
-      "    \"frequency_penalty\": 0,\r\n",
-      "    \"presence_penalty\": 0,\r\n",
-      "    \"n\": 1,\r\n",
-      "    \"best_of\": 1,\r\n",
-      "    \"request_timeout\": null,\r\n",
-      "    \"logit_bias\": {},\r\n",
-      "    \"_type\": \"openai\"\r\n",
-      "}"
-     ]
-    }
-   ],
-   "source": [
-    "!cat llm.json"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "7e6aa9ab",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "config = {\n",
-    "    \"memory\": None,\n",
-    "    \"verbose\": True,\n",
-    "    \"prompt_path\": \"prompt.json\",\n",
-    "    \"llm_path\": \"llm.json\",\n",
-    "    \"output_key\": \"text\",\n",
-    "    \"_type\": \"llm_chain\"\n",
-    "}\n",
-    "import json\n",
-    "with open(\"llm_chain_separate.json\", \"w\") as f:\n",
-    "    json.dump(config, f, indent=2)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "8e959ca6",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "{\r\n",
-      "  \"memory\": null,\r\n",
-      "  \"verbose\": true,\r\n",
-      "  \"prompt_path\": \"prompt.json\",\r\n",
-      "  \"llm_path\": \"llm.json\",\r\n",
-      "  \"output_key\": \"text\",\r\n",
-      "  \"_type\": \"llm_chain\"\r\n",
-      "}"
-     ]
-    }
-   ],
-   "source": [
-    "!cat llm_chain_separate.json"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "662731c0",
-   "metadata": {},
-   "source": [
-    "We can then load it in the same way"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "d69ceb93",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain = load_chain(\"llm_chain_separate.json\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "a99d61b9",
-   "metadata": {},
-   "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: whats 2 + 2\n",
-      "\n",
-      "Answer: Let's think step by step.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' 2 + 2 = 4'"
-      ]
-     },
-     "execution_count": 15,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain.run(\"whats 2 + 2\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "822b7c12",
-   "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.10.9"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

docs/modules/chains/generic_how_to.rst

@@ -9,19 +9,19 @@ The examples here are all generic end-to-end chains that are meant to be used to
 
 - **Links Used**: PromptTemplate, LLM
 - **Notes**: This chain is the simplest chain, and is widely used by almost every other chain. This chain takes arbitrary user input, creates a prompt with it from the PromptTemplate, passes that to the LLM, and then returns the output of the LLM as the final output.
-- `Example Notebook <./generic/llm_chain.html>`_
+- `Example Notebook <generic/llm_chain.html>`_
 
 **Transformation Chain**
 
 - **Links Used**: TransformationChain
 - **Notes**: This notebook shows how to use the Transformation Chain, which takes an arbitrary python function and applies it to inputs/outputs of other chains.
-- `Example Notebook <./generic/transformation.html>`_
+- `Example Notebook <generic/transformation.html>`_
 
 **Sequential Chain**
 
 - **Links Used**: Sequential
 - **Notes**: This notebook shows how to combine calling multiple other chains in sequence.
-- `Example Notebook <./generic/sequential_chains.html>`_
+- `Example Notebook <generic/sequential_chains.html>`_
 
 .. toctree::
    :maxdepth: 1
@@ -30,4 +30,4 @@ The examples here are all generic end-to-end chains that are meant to be used to
    :name: generic
    :hidden:
 
-   ./generic/*
+   generic/*

docs/modules/chains/getting_started.ipynb

@@ -9,13 +9,13 @@
     "In this tutorial, we will learn about creating simple chains in LangChain. We will learn how to create a chain, add components to it, and run it.\n",
     "\n",
     "In this tutorial, we will cover:\n",
-    "- Using a simple LLM chain\n",
+    "- Using the simple LLM chain\n",
     "- Creating sequential chains\n",
     "- Creating a custom chain\n",
     "\n",
     "## Why do we need chains?\n",
     "\n",
-    "Chains allow us to combine multiple components together to create a single, coherent application. For example, we can create a chain that takes user input, formats it with a PromptTemplate, and then passes the formatted response to an LLM. We can build more complex chains by combining multiple chains together, or by combining chains with other components.\n"
+    "Chains allow us to combine multiple components together to create a single, coherent application. For example, we can create a chain that takes user input, format it with a PromptTemplate, and then passes the formatted response to an LLM. We can build more complex chains by combining multiple chains together, or by combining chains with other components.\n"
    ]
   },
   {
@@ -88,7 +88,7 @@
    "source": [
     "## Combine chains with the `SequentialChain`\n",
     "\n",
-    "The next step after calling a language model is to make a series of calls to a language model. We can do this using sequential chains, which are chains that execute their links in a predefined order. Specifically, we will use the `SimpleSequentialChain`. This is the simplest type of a sequential chain, where each step has a single input/output, and the output of one step is the input to the next.\n",
+    "The next step after calling a language model is make a series of calls to a language model. We can do this using sequential chains, which are chains that execute their links in a predefined order. Specifically, we will use the `SimpleSequentialChain`. This is the simplest form of sequential chains, where each step has a singular input/output, and the output of one step is the input to the next.\n",
     "\n",
     "In this tutorial, our sequential chain will:\n",
     "1. First, create a company name for a product. We will reuse the `LLMChain` we'd previously initialized to create this company name.\n",
@@ -156,7 +156,7 @@
    "source": [
     "## Create a custom chain with the `Chain` class\n",
     "\n",
-    "LangChain provides many chains out of the box, but sometimes you may want to create a custom chain for your specific use case. For this example, we will create a custom chain that concatenates the outputs of 2 `LLMChain`s.\n",
+    "LangChain provides many chains out of the box, but sometimes you may want to create a custom chains for your specific use case. For this example, we will create a custom chain that concatenates the outputs of 2 `LLMChain`s.\n",
     "\n",
     "In order to create a custom chain:\n",
     "1. Start by subclassing the `Chain` class,\n",

docs/modules/chains/how_to_guides.rst

@@ -6,19 +6,15 @@ Primitives can be either `prompts <../prompts.html>`_, `llms <../llms.html>`_, `
 The examples here are all end-to-end chains for specific applications.
 They are broken up into three categories:
 
-1. `Generic Chains <./generic_how_to.html>`_: Generic chains, that are meant to help build other chains rather than serve a particular purpose.
-2. `Utility Chains <./utility_how_to.html>`_: Chains consisting of an LLMChain interacting with a specific util.
-3. `Asynchronous <./async_chain.html>`_: Covering asynchronous functionality.
+1. `Generic Chains <generic_how_to.html>`_: Generic chains, that are meant to help build other chains rather than serve a particular purpose.
+2. `CombineDocuments Chains <combine_docs_how_to.html>`_: Chains aimed at making it easy to work with documents (question answering, summarization, etc).
+3. `Utility Chains <utility_how_to.html>`_: Chains consisting of an LLMChain interacting with a specific util.
 
 .. toctree::
    :maxdepth: 1
    :glob:
    :hidden:
 
-   ./generic_how_to.rst
-   ./utility_how_to.rst
-   ./async_chain.ipynb
-
-In addition to different types of chains, we also have the following how-to guides for working with chains in general:
-
-`Load From Hub <./generic/from_hub.html>`_: This notebook covers how to load chains from `LangChainHub <https://github.com/hwchase17/langchain-hub>`_.
+   generic_how_to.rst
+   combine_docs_how_to.rst
+   utility_how_to.rst

docs/modules/chains/key_concepts.md

@@ -6,6 +6,16 @@ They vary greatly in complexity and are combination of generic, highly configura
 
 ## Sequential Chain
 This is a specific type of chain where multiple other chains are run in sequence, with the outputs being added as inputs
-to the next. A subtype of this type of chain is the [`SimpleSequentialChain`](./generic/sequential_chains.html#simplesequentialchain), where all subchains have only one input and one output,
-and the output of one is therefore used as sole input to the next chain.
+to the next. A subtype of this type of chain is the `SimpleSequentialChain`, where all subchains have only one input and one output,
+and the output of one is therefor used as sole input to the next chain.
+
+## CombineDocuments Chains
+These are a subset of chains designed to work with documents. There are two pieces to consider:
+
+1. The underlying chain method (eg, how the documents are combined)
+2. Use cases for these types of chains.
+
+For the first, please see [this documentation](combine_docs.md) for more detailed information on the types of chains LangChain supports.
+For the second, please see the Use Cases section for more information on [question answering](/use_cases/question_answering.md), 
+[question answering with sources](/use_cases/qa_with_sources.md), and [summarization](/use_cases/summarization.md).
 

docs/modules/chains/utility_how_to.rst

@@ -9,50 +9,44 @@ The examples here are all end-to-end chains for specific applications, focused o
 
 - **Links Used**: Python REPL, LLMChain
 - **Notes**: This chain takes user input (a math question), uses an LLMChain to convert it to python code snippet to run in the Python REPL, and then returns that as the result.
-- `Example Notebook <./examples/llm_math.html>`_
+- `Example Notebook <examples/llm_math.html>`_
 
 **PAL**
 
 - **Links Used**: Python REPL, LLMChain
 - **Notes**: This chain takes user input (a reasoning question), uses an LLMChain to convert it to python code snippet to run in the Python REPL, and then returns that as the result.
 - `Paper <https://arxiv.org/abs/2211.10435>`_
-- `Example Notebook <./examples/pal.html>`_
+- `Example Notebook <examples/pal.html>`_
 
 **SQLDatabase Chain**
 
 - **Links Used**: SQLDatabase, LLMChain
 - **Notes**: This chain takes user input (a question), uses a first LLM chain to construct a SQL query to run against the SQL database, and then uses another LLMChain to take the results of that query and use it to answer the original question.
-- `Example Notebook <./examples/sqlite.html>`_
-
-**API Chain**
-
-- **Links Used**: LLMChain, Requests
-- **Notes**: This chain first uses a LLM to construct the url to hit, then makes that request with the Requests wrapper, and finally runs that result through the language model again in order to product a natural language response.
-- `Example Notebook <./examples/api.html>`_
+- `Example Notebook <examples/sqlite.html>`_
 
 **LLMBash Chain**
 
 - **Links Used**: BashProcess, LLMChain
 - **Notes**: This chain takes user input (a question), uses an LLM chain to convert it to a bash command to run in the terminal, and then returns that as the result.
-- `Example Notebook <./examples/llm_bash.html>`_
+- `Example Notebook <examples/llm_bash.html>`_
 
 **LLMChecker Chain**
 
 - **Links Used**: LLMChain
 - **Notes**: This chain takes user input (a question), uses an LLM chain to answer that question, and then uses other LLMChains to self-check that answer.
-- `Example Notebook <./examples/llm_checker.html>`_
+- `Example Notebook <examples/llm_checker.html>`_
 
 **LLMRequests Chain**
 
 - **Links Used**: Requests, LLMChain
 - **Notes**: This chain takes a URL and other inputs, uses Requests to get the data at that URL, and then passes that along with the other inputs into an LLMChain to generate a response. The example included shows how to ask a question to Google - it firsts constructs a Google url, then fetches the data there, then passes that data + the original question into an LLMChain to get an answer.
-- `Example Notebook <./examples/llm_requests.html>`_
+- `Example Notebook <examples/llm_requests.html>`_
 
 **Moderation Chain**
 
 - **Links Used**: LLMChain, ModerationChain
 - **Notes**: This chain shows how to use OpenAI's content moderation endpoint to screen output, and shows how to connect this to an LLMChain.
-- `Example Notebook <./examples/moderation.html>`_
+- `Example Notebook <examples/moderation.html>`_
 
 
 .. toctree::
@@ -62,4 +56,4 @@ The examples here are all end-to-end chains for specific applications, focused o
    :name: generic
    :hidden:
 
-   ./examples/*
+   examples/*

docs/modules/document_loaders.rst

@@ -1,29 +0,0 @@
-Document Loaders
-==========================
-
-Combining language models with your own text data is a powerful way to differentiate them.
-The first step in doing this is to load the data into "documents" - a fancy way of say some pieces of text.
-This module is aimed at making this easy.
-
-A primary driver of a lot of this is the `Unstructured <https://github.com/Unstructured-IO/unstructured>`_ python package.
-This package is a great way to transform all types of files - text, powerpoint, images, html, pdf, etc - into text data.
-
-For detailed instructions on how to get set up with Unstructured, see installation guidelines `here <https://github.com/Unstructured-IO/unstructured#coffee-getting-started>`_.
-
-The following sections of documentation are provided:
-
-- `Key Concepts <./document_loaders/key_concepts.html>`_: A conceptual guide going over the various concepts related to loading documents.
-
-- `How-To Guides <./document_loaders/how_to_guides.html>`_: A collection of how-to guides. These highlight different types of loaders.
-
-
-
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Document Loaders
-   :name: Document Loaders
-   :hidden:
-
-   ./document_loaders/key_concepts.md
-   ./document_loaders/how_to_guides.rst