Merge branch 'master' into harrison/agent_multi_inputs

.coveragerc

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

.devcontainer/Dockerfile

@@ -1,42 +0,0 @@
-# This is a Dockerfile for Developer Container
-
-# Use the Python base image
-ARG VARIANT="3.11-bullseye"
-FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT} AS langchain-dev-base
-
-USER vscode
-
-# Define the version of Poetry to install (default is 1.4.2)
-# Define the directory of python virtual environment
-ARG PYTHON_VIRTUALENV_HOME=/home/vscode/langchain-py-env \
-    POETRY_VERSION=1.4.2 
-
-ENV POETRY_VIRTUALENVS_IN_PROJECT=false \
-    POETRY_NO_INTERACTION=true 
-
-# Create a Python virtual environment for Poetry and install it
-RUN python3 -m venv ${PYTHON_VIRTUALENV_HOME} && \
-    $PYTHON_VIRTUALENV_HOME/bin/pip install --upgrade pip && \
-    $PYTHON_VIRTUALENV_HOME/bin/pip install poetry==${POETRY_VERSION}
-
-ENV PATH="$PYTHON_VIRTUALENV_HOME/bin:$PATH" \
-    VIRTUAL_ENV=$PYTHON_VIRTUALENV_HOME
-
-# Setup for bash
-RUN poetry completions bash >> /home/vscode/.bash_completion && \
-    echo "export PATH=$PYTHON_VIRTUALENV_HOME/bin:$PATH" >> ~/.bashrc
-
-# Set the working directory for the app
-WORKDIR /workspaces/langchain
-
-# Use a multi-stage build to install dependencies
-FROM langchain-dev-base AS langchain-dev-dependencies
-
-ARG PYTHON_VIRTUALENV_HOME
-
-# Copy only the dependency files for installation
-COPY pyproject.toml poetry.lock poetry.toml ./
-
-# Install the Poetry dependencies (this layer will be cached as long as the dependencies don't change)
-RUN poetry install --no-interaction --no-ansi --with dev,test,docs
-

.devcontainer/devcontainer.json

@@ -1,33 +0,0 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
-{
-	"dockerComposeFile": "./docker-compose.yaml",
-	"service": "langchain",
-	"workspaceFolder": "/workspaces/langchain",
-	"name": "langchain",
-	"customizations": {
-		"vscode": {
-			"extensions": [   
-				"ms-python.python"
-			],
-			"settings": {
-				"python.defaultInterpreterPath": "/home/vscode/langchain-py-env/bin/python3.11"
-			}
-		}
-		
-	},
-
-	// Features to add to the dev container. More info: https://containers.dev/features.
-	"features": {},
-
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
-
-	// Uncomment the next line to run commands after the container is created.
-	// "postCreateCommand": "cat /etc/os-release",
-
-	// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
-	// "remoteUser": "devcontainer"
-	"remoteUser": "vscode",
-	"overrideCommand": true
-}

.devcontainer/docker-compose.yaml

@@ -1,31 +0,0 @@
-version: '3'
-services:
-  langchain:
-    build:
-      dockerfile: .devcontainer/Dockerfile
-      context: ../ 
-    volumes:
-      - ../:/workspaces/langchain
-    networks:
-      - langchain-network 
-  #   environment:
-  #     MONGO_ROOT_USERNAME: root
-  #     MONGO_ROOT_PASSWORD: example123
-  #   depends_on:
-  #     - mongo   
-  # mongo:
-  #   image: mongo
-  #   restart: unless-stopped
-  #   environment:
-  #     MONGO_INITDB_ROOT_USERNAME: root
-  #     MONGO_INITDB_ROOT_PASSWORD: example123
-  #   ports:
-  #     - "27017:27017"
-  #   networks:
-  #     - langchain-network
-
-networks:
-  langchain-network:
-    driver: bridge
-    
-    

.dockerignore

@@ -1,6 +0,0 @@
-.venv
-.github
-.git
-.mypy_cache
-.pytest_cache
-Dockerfile

.flake8

@@ -1,6 +1,5 @@
 [flake8]
 exclude =
-    venv
     .venv
     __pycache__
     notebooks

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,106 +0,0 @@
-name: "\U0001F41B Bug Report"
-description: Submit a bug report to help us improve LangChain
-labels: ["02 Bug Report"]
-body:
-  - type: markdown
-    attributes:
-      value: >
-        Thank you for taking the time to file a bug report. Before creating a new
-        issue, please make sure to take a few moments to check the issue tracker
-        for existing issues about the bug.
-
-  - type: textarea
-    id: system-info
-    attributes:
-      label: System Info
-      description: Please share your system info with us.
-      placeholder: LangChain version, platform, python version, ...
-    validations:
-      required: true
-
-  - type: textarea
-    id: who-can-help
-    attributes:
-      label: Who can help?
-      description: |
-        Your issue will be replied to more quickly if you can figure out the right person to tag with @
-        If you know how to use git blame, that is the easiest way, otherwise, here is a rough guide of **who to tag**.
-
-        The core maintainers strive to read all issues, but tagging them will help them prioritize.
-
-        Please tag fewer than 3 people.
-
-        @hwchase17 - project lead
-
-        Tracing / Callbacks
-        - @agola11
-
-        Async
-        - @agola11
-
-        DataLoader Abstractions
-        - @eyurtsev
-
-        LLM/Chat Wrappers
-        - @hwchase17
-        - @agola11
-
-        Tools / Toolkits
-        - @vowelparrot
-
-      placeholder: "@Username ..."
-
-  - type: checkboxes
-    id: information-scripts-examples
-    attributes:
-      label: Information
-      description: "The problem arises when using:"
-      options:
-        - label: "The official example notebooks/scripts"
-        - label: "My own modified scripts"
-
-  - type: checkboxes
-    id: related-components
-    attributes:
-      label: Related Components
-      description: "Select the components related to the issue (if applicable):"
-      options:
-        - label: "LLMs/Chat Models"
-        - label: "Embedding Models"
-        - label: "Prompts / Prompt Templates / Prompt Selectors"
-        - label: "Output Parsers"
-        - label: "Document Loaders"
-        - label: "Vector Stores / Retrievers"
-        - label: "Memory"
-        - label: "Agents / Agent Executors"
-        - label: "Tools / Toolkits"
-        - label: "Chains"
-        - label: "Callbacks/Tracing"
-        - label: "Async"
-
-  - type: textarea
-    id: reproduction
-    validations:
-      required: true
-    attributes:
-      label: Reproduction
-      description: |
-        Please provide a [code sample](https://stackoverflow.com/help/minimal-reproducible-example) that reproduces the problem you ran into. It can be a Colab link or just a code snippet.
-        If you have code snippets, error messages, stack traces please provide them here as well.
-        Important! Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting
-        Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
-
-      placeholder: |
-        Steps to reproduce the behavior:
-
-          1.
-          2.
-          3.
-
-  - type: textarea
-    id: expected-behavior
-    validations:
-      required: true
-    attributes:
-      label: Expected behavior
-      description: "A clear and concise description of what you would expect to happen."

.github/ISSUE_TEMPLATE/config.yml

@@ -1,6 +0,0 @@
-blank_issues_enabled: true
-version: 2.1
-contact_links:
-  - name: Discord
-    url: https://discord.gg/6adMQxSpJS
-    about: General community discussions

.github/ISSUE_TEMPLATE/documentation.yml

@@ -1,19 +0,0 @@
-name: Documentation
-description: Report an issue related to the LangChain documentation.
-title: "DOC: <Please write a comprehensive title after the 'DOC: ' prefix>"
-labels: [03 - Documentation]
-
-body:
-- type: textarea
-  attributes: 
-    label: "Issue with current documentation:"
-    description: >
-      Please make sure to leave a reference to the document/code you're
-      referring to.
-
-- type: textarea
-  attributes:
-    label: "Idea or request for content:"
-    description: >
-      Please describe as clearly as possible what topics you think are missing
-      from the current documentation.

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,30 +0,0 @@
-name: "\U0001F680 Feature request"
-description: Submit a proposal/request for a new LangChain feature
-labels: ["02 Feature Request"]
-body:
-  - type: textarea
-    id: feature-request
-    validations:
-      required: true
-    attributes:
-      label: Feature request
-      description: |
-        A clear and concise description of the feature proposal. Please provide links to any relevant GitHub repos, papers, or other resources if relevant.
-
-  - type: textarea
-    id: motivation
-    validations:
-      required: true
-    attributes:
-      label: Motivation
-      description: |
-        Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too.
-
-  - type: textarea
-    id: contribution
-    validations:
-      required: true
-    attributes:
-      label: Your contribution
-      description: |
-        Is there any way that you could help, e.g. by submitting a PR? Make sure to read the CONTRIBUTING.MD [readme](https://github.com/hwchase17/langchain/blob/master/.github/CONTRIBUTING.md)

.github/ISSUE_TEMPLATE/other.yml

@@ -1,18 +0,0 @@
-name: Other Issue
-description: Raise an issue that wouldn't be covered by the other templates.
-title: "Issue: <Please write a comprehensive title after the 'Issue: ' prefix>"
-labels: [04 - Other]
-
-body:
-  - type: textarea
-    attributes:
-      label: "Issue you'd like to raise."
-      description: >
-        Please describe the issue you'd like to raise as clearly as possible.
-        Make sure to include any relevant links or references.
-
-  - type: textarea
-    attributes:
-      label: "Suggestion:"
-      description: >
-        Please outline a suggestion to improve the issue here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,46 +0,0 @@
-# Your PR Title (What it does)
-
-<!--
-Thank you for contributing to LangChain! Your PR will appear in our next release under the title you set. Please make sure it highlights your valuable contribution.
-
-Replace this with a description of the change, the issue it fixes (if applicable), and relevant context. List any dependencies required for this change.
-
-After you're done, someone will review your PR. They may suggest improvements. If no one reviews your PR within a few days, feel free to @-mention the same people again, as notifications can get lost.
--->
-
-<!-- Remove if not applicable -->
-
-Fixes # (issue)
-
-## Before submitting
-
-<!-- If you're adding a new integration, include an integration test and an example notebook showing its use! -->
-
-## Who can review?
-
-Community members can review the PR once tests pass. Tag maintainers/contributors who might be interested:
-
-<!-- For a quicker response, figure out the right person to tag with @
-
-        @hwchase17 - project lead
-
-        Tracing / Callbacks
-        - @agola11
-
-        Async
-        - @agola11
-
-        DataLoaders
-        - @eyurtsev
-
-        Models
-        - @hwchase17
-        - @agola11
-
-        Agents / Tools / Toolkits
-        - @vowelparrot
-        
-        VectorStores / Retrievers / Memory
-        - @dev2049
-        
- -->

.github/actions/poetry_setup/action.yml

@@ -1,76 +0,0 @@
-# An action for setting up poetry install with caching.
-# Using a custom action since the default action does not
-# take poetry install groups into account.
-# Action code from:
-# https://github.com/actions/setup-python/issues/505#issuecomment-1273013236
-name: poetry-install-with-caching
-description: Poetry install with support for caching of dependency groups.
-
-inputs:
-  python-version:
-    description: Python version, supporting MAJOR.MINOR only
-    required: true
-
-  poetry-version:
-    description: Poetry version
-    required: true
-
-  install-command:
-    description: Command run for installing dependencies
-    required: false
-    default: poetry install
-
-  cache-key:
-    description: Cache key to use for manual handling of caching
-    required: true
-
-  working-directory:
-    description: Directory to run install-command in
-    required: false
-    default: ""
-
-runs:
-  using: composite
-  steps:
-    - uses: actions/setup-python@v4
-      name: Setup python $${ inputs.python-version }}
-      with:
-        python-version: ${{ inputs.python-version }}
-
-    - uses: actions/cache@v3
-      id: cache-pip
-      name: Cache Pip ${{ inputs.python-version }}
-      env:
-        SEGMENT_DOWNLOAD_TIMEOUT_MIN: "15"
-      with:
-        path: |
-          ~/.cache/pip
-        key: pip-${{ runner.os }}-${{ runner.arch }}-py-${{ inputs.python-version }}
-
-    - run: pipx install poetry==${{ inputs.poetry-version }} --python python${{ inputs.python-version }}
-      shell: bash
-
-    - name: Check Poetry File
-      shell: bash
-      run: |
-        poetry check
-
-    - name: Check lock file
-      shell: bash
-      run: |
-        poetry lock --check
-
-    - uses: actions/cache@v3
-      id: cache-poetry
-      env:
-        SEGMENT_DOWNLOAD_TIMEOUT_MIN: "15"
-      with:
-        path: |
-          ~/.cache/pypoetry/virtualenvs
-          ~/.cache/pypoetry/cache
-          ~/.cache/pypoetry/artifacts
-        key: poetry-${{ runner.os }}-${{ runner.arch }}-py-${{ inputs.python-version }}-poetry-${{ inputs.poetry-version }}-${{ inputs.cache-key }}-${{ hashFiles('poetry.lock') }}
-
-    - run: ${{ inputs.install-command }}
-      working-directory: ${{ inputs.working-directory }}
-      shell: bash

.github/workflows/linkcheck.yml

@@ -1,38 +0,0 @@
-name: linkcheck
-
-on:
-  push:
-    branches: [master]
-  pull_request:
-    paths:
-      - 'docs/**'
-
-env:
-  POETRY_VERSION: "1.4.2"
-
-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/lint.yml

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

.github/workflows/release.yml

@@ -1,49 +0,0 @@
-name: release
-
-on:
-  pull_request:
-    types:
-      - closed
-    branches:
-      - master
-    paths:
-      - 'pyproject.toml'
-
-env:
-  POETRY_VERSION: "1.4.2"
-
-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

@@ -4,10 +4,9 @@ on:
   push:
     branches: [master]
   pull_request:
-  workflow_dispatch:
 
 env:
-  POETRY_VERSION: "1.4.2"
+  POETRY_VERSION: "1.3.1"
 
 jobs:
   build:
@@ -19,31 +18,17 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
-        test_type:
-          - "core"
-          - "extended"
-    name: Python ${{ matrix.python-version }} ${{ matrix.test_type }}
     steps:
       - uses: actions/checkout@v3
+      - name: Install poetry
+        run: pipx install poetry==$POETRY_VERSION
       - name: Set up Python ${{ matrix.python-version }}
-        uses: "./.github/actions/poetry_setup"
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-          poetry-version: "1.4.2"
-          cache-key: ${{ matrix.test_type }}
-          install-command: |
-              if [ "${{ matrix.test_type }}" == "core" ]; then
-                echo "Running core tests, installing dependencies with poetry..."
-                poetry install
-              else
-                echo "Running extended tests, installing dependencies with poetry..."
-                poetry install -E extended_testing
-              fi
-      - name: Run ${{matrix.test_type}} tests
+          cache: "poetry"
+      - name: Install dependencies
+        run: poetry install
+      - name: Run unit tests
         run: |
-          if [ "${{ matrix.test_type }}" == "core" ]; then
-            make test
-          else
-            make extended_tests
-          fi
-        shell: bash
+          make tests

.gitignore

@@ -1,4 +1,3 @@
-.vs/
 .vscode/
 .idea/
 # Byte-compiled / optimized / DLL files
@@ -107,9 +106,7 @@ celerybeat.pid
 
 # Environments
 .env
-.envrc
 .venv
-.venvs
 env/
 venv/
 ENV/
@@ -133,20 +130,3 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
-
-# macOS display setting files
-.DS_Store
-
-# Wandb directory
-wandb/
-
-# asdf tool versions
-.tool-versions
-/.ruff_cache/
-
-*.pkl
-*.bin
-
-# integration test artifacts
-data_map*
-\[('_type', 'fake'), ('stop', None)]

.readthedocs.yaml

@@ -1,26 +0,0 @@
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Set the version of Python and other tools you might need
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.11"
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-   configuration: docs/conf.py
-
-# If using Sphinx, optionally build your docs in additional formats such as PDF
-# formats:
-#    - pdf
-
-# Optionally declare the Python requirements required to build your docs
-python:
-   install:
-   - requirements: docs/requirements.txt
-   - method: pip
-     path: .

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

@@ -2,71 +2,65 @@
 
 Hi there! Thank you for even being interested in contributing to LangChain.
 As an open source project in a rapidly developing field, we are extremely open
-to contributions, whether they be in the form of new features, improved infra, better documentation, or bug fixes.
-
-## 🗺️ Guidelines
-
-### 👩‍💻 Contributing Code
+to contributions, whether it be in the form of a new feature, improved infra, or better documentation.
 
 To contribute to this project, please follow a ["fork and pull request"](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow.
 Please do not try to push directly to this repo unless you are maintainer.
 
-Please follow the checked-in pull request template when opening pull requests. Note related issues and tag relevant
-maintainers.
-
-Pull requests cannot land without passing the formatting, linting and testing checks first. See
-[Common Tasks](#-common-tasks) for how to run these checks locally.
-
-It's essential that we maintain great documentation and testing. If you:
-- Fix a bug
-  - Add a relevant unit or integration test when possible. These live in `tests/unit_tests` and `tests/integration_tests`.
-- Make an improvement
-  - Update any affected example notebooks and documentation. These lives in `docs`.
-  - Update unit and integration tests when relevant.
-- Add a feature
-  - Add a demo notebook in `docs/modules`.
-  - Add unit and integration tests.
-
-We're a small, building-oriented team. If there's something you'd like to add or change, opening a pull request is the
-best way to get our attention.
+## 🗺️Contributing Guidelines
 
 ### 🚩GitHub Issues
 
 Our [issues](https://github.com/hwchase17/langchain/issues) page is kept up to date
-with bugs, improvements, and feature requests. 
+with bugs, improvements, and feature requests. There is a taxonomy of labels to help
+with sorting and discovery of issues of interest. These include:
 
-There is a taxonomy of labels to help with sorting and discovery of issues of interest. Please use these to help
-organize issues.
+- prompts: related to prompt tooling/infra.
+- llms: related to LLM wrappers/tooling/infra.
+- chains
+- utilities: related to different types of utilities to integrate with (Python, SQL, etc.).
+- agents
+- memory
+- applications: related to example applications to build
 
 If you start working on an issue, please assign it to yourself.
 
-If you are adding an issue, please try to keep it focused on a single, modular bug/improvement/feature.
-If two issues are related, or blocking, please link them rather than combining them.
+If you are adding an issue, please try to keep it focused on a single modular bug/improvement/feature.
+If the two issues are related, or blocking, please link them rather than keep them as one single one.
 
 We will try to keep these issues as up to date as possible, though
 with the rapid rate of develop in this field some may get out of date.
-If you notice this happening, please let us know.
+If you notice this happening, please just let us know.
 
 ### 🙋Getting Help
 
-Our goal is to have the simplest developer setup possible. Should you experience any difficulty getting setup, please
-contact a maintainer! Not only do we want to help get you unblocked, but we also want to make sure that the process is
-smooth for future contributors.
+Although we try to have a developer setup to make it as easy as possible for others to contribute (see below)
+it is possible that some pain point may arise around environment setup, linting, documentation, or other.
+Should that occur, please contact a maintainer! Not only do we want to help get you unblocked,
+but we also want to make sure that the process is smooth for future contributors.
 
 In a similar vein, we do enforce certain linting, formatting, and documentation standards in the codebase.
-If you are finding these difficult (or even just annoying) to work with, feel free to contact a maintainer for help -
-we do not want these to get in the way of getting good code into the codebase.
+If you are finding these difficult (or even just annoying) to work with,
+feel free to contact a maintainer for help - we do not want these to get in the way of getting
+good code into the codebase.
 
-## 🚀 Quick Start
+### 🏭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/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).
+
+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.
+
+## 🤖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,15 +69,11 @@ poetry install -E all
 
 This will install all requirements for running the package, examples, linting, formatting, tests, and coverage. Note the `-E all` flag will install all optional dependencies necessary for integration testing.
 
-❗Note: If you're running Poetry 1.4.1 and receive a `WheelFileValidationError` for `debugpy` during installation, you can try either downgrading to Poetry 1.4.0 or disabling "modern installation" (`poetry config installer.modern-installation false`) and re-install requirements. See [this `debugpy` issue](https://github.com/microsoft/debugpy/issues/1246) for more details.
+Now, you should be able to run the common tasks in the following section.
 
-Now, you should be able to run the common tasks in the following section. To double check, run `make test`, all tests should pass. If they don't you may need to pip install additional dependencies, such as `numexpr` and `openapi_schema_pydantic`.
+### ✅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/).
 
@@ -93,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/).
 
@@ -105,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.
 
@@ -115,20 +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
-```
-
-To run unit tests in Docker:
-
-```bash
-make docker_tests
+make tests
 ```
 
 If you add new logic, please add a unit test.
@@ -143,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.
 
@@ -161,46 +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.
 
-## 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
-```
-
-## 🏭 Release Process
-
-As of now, LangChain has an ad hoc release process: releases are cut with high frequency by
-a developer and published to [PyPI](https://pypi.org/project/langchain/).
-
-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).
-
-### 🌟 Recognition
-
-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.
-

Dockerfile

@@ -1,48 +0,0 @@
-# This is a Dockerfile for running unit tests
-
-ARG POETRY_HOME=/opt/poetry
-
-# Use the Python base image
-FROM python:3.11.2-bullseye AS builder
-
-# Define the version of Poetry to install (default is 1.4.2)
-ARG POETRY_VERSION=1.4.2
-
-# Define the directory to install Poetry to (default is /opt/poetry)
-ARG POETRY_HOME
-
-# Create a Python virtual environment for Poetry and install it
-RUN python3 -m venv ${POETRY_HOME} && \
-    $POETRY_HOME/bin/pip install --upgrade pip && \
-    $POETRY_HOME/bin/pip install poetry==${POETRY_VERSION}
-
-# Test if Poetry is installed in the expected path
-RUN echo "Poetry version:" && $POETRY_HOME/bin/poetry --version
-
-# Set the working directory for the app
-WORKDIR /app
-
-# Use a multi-stage build to install dependencies
-FROM builder AS dependencies
-
-ARG POETRY_HOME
-
-# Copy only the dependency files for installation
-COPY pyproject.toml poetry.lock poetry.toml ./
-
-# Install the Poetry dependencies (this layer will be cached as long as the dependencies don't change)
-RUN $POETRY_HOME/bin/poetry install --no-interaction --no-ansi --with test
-
-# Use a multi-stage build to run tests
-FROM dependencies AS tests
-
-# Copy the rest of the app source code (this layer will be invalidated and rebuilt whenever the source code changes)
-COPY . .
-
-RUN /opt/poetry/bin/poetry install --no-interaction --no-ansi --with test
-
-# Set the entrypoint to run tests using Poetry
-ENTRYPOINT ["/opt/poetry/bin/poetry", "run", "pytest"]
-
-# Set the default command to run all unit tests
-CMD ["tests/unit_tests"]

Makefile

@@ -1,6 +1,4 @@
-.PHONY: all clean format lint test tests test_watch integration_tests docker_tests help extended_tests
-
-all: help
+.PHONY: format lint tests integration_tests
 
 coverage:
 	poetry run pytest --cov \
@@ -8,63 +6,18 @@ coverage:
 		--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 .
 
-PYTHON_FILES=.
-lint: PYTHON_FILES=.
-lint_diff: PYTHON_FILES=$(shell git diff --name-only --diff-filter=d master | grep -E '\.py$$')
+lint:
+	poetry run mypy .
+	poetry run black . --check
+	poetry run isort . --check
+	poetry run flake8 .
 
-lint lint_diff:
-	poetry run mypy $(PYTHON_FILES)
-	poetry run black $(PYTHON_FILES) --check
-	poetry run ruff .
-
-TEST_FILE ?= tests/unit_tests/
-
-test:
-	poetry run pytest --disable-socket --allow-unix-socket $(TEST_FILE)
-
-tests: 
-	poetry run pytest --disable-socket --allow-unix-socket $(TEST_FILE)
-
-extended_tests:
-	poetry run pytest --disable-socket --allow-unix-socket --only-extended tests/unit_tests
-
-test_watch:
-	poetry run ptw --now . -- tests/unit_tests
+tests:
+	poetry run pytest tests/unit_tests
 
 integration_tests:
 	poetry run pytest tests/integration_tests
-
-docker_tests:
-	docker build -t my-langchain-image:test .
-	docker run --rm my-langchain-image:test
-
-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'
-	@echo 'format                       - run code formatters'
-	@echo 'lint                         - run linters'
-	@echo 'test                         - run unit tests'
-	@echo 'tests                        - run unit tests'
-	@echo 'test TEST_FILE=<test_file>   - run all tests in file'
-	@echo 'extended_tests               - run only extended unit tests'
-	@echo 'test_watch                   - run unit tests in watch mode'
-	@echo 'integration_tests            - run integration tests'
-	@echo 'docker_tests                 - run unit tests in docker'

README.md

@@ -2,49 +2,20 @@
 
 ⚡ Building applications with LLMs through composability ⚡
 
-[![lint](https://github.com/hwchase17/langchain/actions/workflows/lint.yml/badge.svg)](https://github.com/hwchase17/langchain/actions/workflows/lint.yml)
-[![test](https://github.com/hwchase17/langchain/actions/workflows/test.yml/badge.svg)](https://github.com/hwchase17/langchain/actions/workflows/test.yml)
-[![linkcheck](https://github.com/hwchase17/langchain/actions/workflows/linkcheck.yml/badge.svg)](https://github.com/hwchase17/langchain/actions/workflows/linkcheck.yml)
-[![Downloads](https://static.pepy.tech/badge/langchain/month)](https://pepy.tech/project/langchain)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai)
-[![](https://dcbadge.vercel.app/api/server/6adMQxSpJS?compact=true&style=flat)](https://discord.gg/6adMQxSpJS)
-[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/hwchase17/langchain)
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/hwchase17/langchain)
-[![GitHub star chart](https://img.shields.io/github/stars/hwchase17/langchain?style=social)](https://star-history.com/#hwchase17/langchain)
-
-
-Looking for the JS/TS version? Check out [LangChain.js](https://github.com/hwchase17/langchainjs).
-
-**Production Support:** As you move your LangChains into production, we'd love to offer more comprehensive support.
-Please fill out [this form](https://forms.gle/57d8AmXBYp8PP8tZA) and we'll set up a dedicated support Slack channel.
+[![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
 
 `pip install langchain`
-or
-`conda install langchain -c conda-forge`
 
 ## 🤔 What is this?
 
-Large language models (LLMs) are emerging as a transformative technology, enabling developers to build applications that they previously could not. However, using these LLMs in isolation is often insufficient for creating a truly powerful app - the real power comes when you can combine them with other sources of computation or knowledge.
+Large language models (LLMs) are emerging as a transformative technology, enabling
+developers to build applications that they previously could not.
+But using these LLMs in isolation is often not enough to
+create a truly powerful app - the real power comes when you can combine them with other sources of computation or knowledge.
 
-This library aims to assist in the development of those types of applications. Common examples of these 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/modules/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
 
@@ -53,41 +24,34 @@ Please see [here](https://langchain.readthedocs.io/en/latest/?) for full documen
 - Getting started (installation, setting up the environment, simple examples)
 - How-To examples (demos, integrations, helper functions)
 - Reference (full API docs)
-- Resources (high-level explanation of core concepts)
+  Resources (high-level explanation of core concepts)
 
 ## 🚀 What can this help with?
 
-There are six main areas that LangChain is designed to help with.
+There are four main areas that LangChain is designed to help with.
 These are, in increasing order of complexity:
 
 **📃 LLMs and Prompts:**
 
-This includes prompt management, prompt optimization, a generic interface for all LLMs, and common utilities for working with LLMs.
+This includes prompt management, prompt optimization, generic interface for all LLMs, and common utilities for working with LLMs.
 
 **🔗 Chains:**
 
-Chains go beyond a single LLM call and involve sequences of calls (whether to an LLM or a different utility). LangChain provides a standard interface for chains, lots of integrations with other tools, and end-to-end chains for common applications.
-
-**📚 Data Augmented Generation:**
-
-Data Augmented Generation involves specific types of chains that first interact with an external data source to fetch data for use in the generation step. Examples include summarization of long pieces of text and question/answering over specific data sources.
+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:**
 
-Agents involve an LLM making decisions about which Actions to take, taking that Action, seeing an Observation, and repeating that until done. LangChain provides a standard interface for agents, a selection of agents to choose from, and examples of end-to-end agents.
+Agents involve an LLM making decisions about which Actions to take, taking that Action, seeing an Observation, and repeating that until done. LangChain provides a standard interface for agents, a selection of agents to choose from, and examples of end to end agents.
 
 **🧠 Memory:**
 
-Memory refers to persisting state between calls of a chain/agent. LangChain provides a standard interface for memory, a collection of memory implementations, and examples of chains/agents that use memory.
+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.
 
-**🧐 Evaluation:**
-
-[BETA] 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.
-
-For more information on these concepts, please see our [full documentation](https://langchain.readthedocs.io/en/latest/).
+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 infrastructure, 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](.github/CONTRIBUTING.md).
+For detailed information on how to contribute, see [here](CONTRIBUTING.md).

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,17 +0,0 @@
-pre {
-  white-space: break-spaces;
-}
-
-@media (min-width: 1200px) {
-  .container,
-  .container-lg,
-  .container-md,
-  .container-sm,
-  .container-xl {
-    max-width: 2560px !important;
-  }
-}
-
-#my-component-root *, #headlessui-portal-root * {
-  z-index: 10000;
-}

docs/_static/js/mendablesearch.js

@@ -1,56 +0,0 @@
-document.addEventListener('DOMContentLoaded', () => {
-  // Load the external dependencies
-  function loadScript(src, onLoadCallback) {
-    const script = document.createElement('script');
-    script.src = src;
-    script.onload = onLoadCallback;
-    document.head.appendChild(script);
-  }
-
-  function createRootElement() {
-    const rootElement = document.createElement('div');
-    rootElement.id = 'my-component-root';
-    document.body.appendChild(rootElement);
-    return rootElement;
-  }
-
-  
-
-  function initializeMendable() {
-    const rootElement = createRootElement();
-    const { MendableFloatingButton } = Mendable;
-    
-
-    const iconSpan1 = React.createElement('span', {
-    }, '🦜');
-
-    const iconSpan2 = React.createElement('span', {
-    }, '🔗');
-
-    const icon = React.createElement('p', {
-      style: { color: '#ffffff', fontSize: '22px',width: '48px', height: '48px', margin: '0px', padding: '0px', display: 'flex', alignItems: 'center', justifyContent: 'center', textAlign: 'center' },
-    }, [iconSpan1, iconSpan2]);
-    
-    const mendableFloatingButton = React.createElement(
-      MendableFloatingButton,
-      {
-        style: { darkMode: false, accentColor: '#010810' },
-        floatingButtonStyle: { color: '#ffffff', backgroundColor: '#010810' },
-        anon_key: '82842b36-3ea6-49b2-9fb8-52cfc4bde6bf', // Mendable Search Public ANON key, ok to be public
-        messageSettings: {
-          openSourcesInNewTab: false,
-          prettySources: true // Prettify the sources displayed now
-        },
-        icon: icon,
-      }
-    );
-
-    ReactDOM.render(mendableFloatingButton, rootElement);
-  }
-
-  loadScript('https://unpkg.com/react@17/umd/react.production.min.js', () => {
-    loadScript('https://unpkg.com/react-dom@17/umd/react-dom.production.min.js', () => {
-      loadScript('https://unpkg.com/@mendable/search@0.0.102/dist/umd/mendable.min.js', initializeMendable);
-    });
-  });
-});

docs/additional_resources/deployments.md

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

docs/additional_resources/tracing.md

@@ -1,57 +0,0 @@
-# Tracing
-
-By enabling tracing in your LangChain runs, you’ll be able to more effectively visualize, step through, and debug your chains and agents.
-
-First, you should install tracing and set up your environment properly.
-You can use either a locally hosted version of this (uses Docker) or a cloud hosted version (in closed alpha).
-If you're interested in using the hosted platform, please fill out the form [here](https://forms.gle/tRCEMSeopZf6TE3b6).
-
-- [Locally Hosted Setup](../tracing/local_installation.md)
-- [Cloud Hosted Setup](../tracing/hosted_installation.md)
-
-## Tracing Walkthrough
-
-When you first access the UI, you should see a page with your tracing sessions.
-An initial one "default" should already be created for you.
-A session is just a way to group traces together.
-If you click on a session, it will take you to a page with no recorded traces that says "No Runs."
-You can create a new session with the new session form.
-
-![](../tracing/homepage.png)
-
-If we click on the `default` session, we can see that to start we have no traces stored.
-
-![](../tracing/default_empty.png)
-
-If we now start running chains and agents with tracing enabled, we will see data show up here.
-To do so, we can run [this notebook](../tracing/agent_with_tracing.ipynb) as an example.
-After running it, we will see an initial trace show up.
-
-![](../tracing/first_trace.png)
-
-From here we can explore the trace at a high level by clicking on the arrow to show nested runs.
-We can keep on clicking further and further down to explore deeper and deeper.
-
-![](../tracing/explore.png)
-
-We can also click on the "Explore" button of the top level run to dive even deeper.
-Here, we can see the inputs and outputs in full, as well as all the nested traces.
-
-![](../tracing/explore_trace.png)
-
-We can keep on exploring each of these nested traces in more detail.
-For example, here is the lowest level trace with the exact inputs/outputs to the LLM.
-
-![](../tracing/explore_llm.png)
-
-## Changing Sessions
-
-1. To initially record traces to a session other than `"default"`, you can set the `LANGCHAIN_SESSION` environment variable to the name of the session you want to record to:
-
-```python
-import os
-os.environ["LANGCHAIN_TRACING"] = "true"
-os.environ["LANGCHAIN_SESSION"] = "my_session" # Make sure this session actually exists. You can create a new session in the UI.
-```
-
-2. To switch sessions mid-script or mid-notebook, do NOT set the `LANGCHAIN_SESSION` environment variable. Instead: `langchain.set_tracing_callback_manager(session_name="my_session")`

docs/additional_resources/youtube.md

@@ -1,90 +0,0 @@
-# YouTube
-
-This is a collection of `LangChain` videos on `YouTube`.
-
-### ⛓️[Official LangChain YouTube channel](https://www.youtube.com/@LangChain)⛓️
-
-### Introduction to LangChain with Harrison Chase, creator of LangChain
-- [Building the Future with LLMs, `LangChain`, & `Pinecone`](https://youtu.be/nMniwlGyX-c) by [Pinecone](https://www.youtube.com/@pinecone-io)
-- [LangChain and Weaviate with Harrison Chase and Bob van Luijt - Weaviate Podcast #36](https://youtu.be/lhby7Ql7hbk) by [Weaviate • Vector Database](https://www.youtube.com/@Weaviate)
-- [LangChain Demo + Q&A with Harrison Chase](https://youtu.be/zaYTXQFR0_s?t=788) by [Full Stack Deep Learning](https://www.youtube.com/@FullStackDeepLearning)
-- [LangChain Agents: Build Personal Assistants For Your Data (Q&A with Harrison Chase and Mayo Oshin)](https://youtu.be/gVkF8cwfBLI) by [Chat with data](https://www.youtube.com/@chatwithdata)
-- ⛓️ [LangChain "Agents in Production" Webinar](https://youtu.be/k8GNCCs16F4) by [LangChain](https://www.youtube.com/@LangChain)
-
-## Videos (sorted by views)
-
-- [Building AI LLM Apps with LangChain (and more?) - LIVE STREAM](https://www.youtube.com/live/M-2Cj_2fzWI?feature=share) by [Nicholas Renotte](https://www.youtube.com/@NicholasRenotte)
-- [First look - `ChatGPT` + `WolframAlpha` (`GPT-3.5` and Wolfram|Alpha via LangChain by James Weaver)](https://youtu.be/wYGbY811oMo) by [Dr Alan D. Thompson](https://www.youtube.com/@DrAlanDThompson) 
-- [LangChain explained - The hottest new Python framework](https://youtu.be/RoR4XJw8wIc) by [AssemblyAI](https://www.youtube.com/@AssemblyAI)
-- [Chatbot with INFINITE MEMORY using `OpenAI` & `Pinecone` - `GPT-3`, `Embeddings`, `ADA`, `Vector DB`, `Semantic`](https://youtu.be/2xNzB7xq8nk) by [David Shapiro ~ AI](https://www.youtube.com/@DavidShapiroAutomator)
-- [LangChain for LLMs is... basically just an Ansible playbook](https://youtu.be/X51N9C-OhlE) by [David Shapiro ~ AI](https://www.youtube.com/@DavidShapiroAutomator)
-- [Build your own LLM Apps with LangChain & `GPT-Index`](https://youtu.be/-75p09zFUJY) by [1littlecoder](https://www.youtube.com/@1littlecoder)
-- [`BabyAGI` - New System of Autonomous AI Agents with LangChain](https://youtu.be/lg3kJvf1kXo) by [1littlecoder](https://www.youtube.com/@1littlecoder)
-- [Run `BabyAGI` with Langchain Agents (with Python Code)](https://youtu.be/WosPGHPObx8) by [1littlecoder](https://www.youtube.com/@1littlecoder)
-- [How to Use Langchain With `Zapier` | Write and Send Email with GPT-3 | OpenAI API Tutorial](https://youtu.be/p9v2-xEa9A0) by [StarMorph AI](https://www.youtube.com/@starmorph)
-- [Use Your Locally Stored Files To Get Response From GPT - `OpenAI` | Langchain | Python](https://youtu.be/NC1Ni9KS-rk) by [Shweta Lodha](https://www.youtube.com/@shweta-lodha)
-- [`Langchain JS` | How to Use GPT-3, GPT-4 to Reference your own Data | `OpenAI Embeddings` Intro](https://youtu.be/veV2I-NEjaM) by [StarMorph AI](https://www.youtube.com/@starmorph)
-- [The easiest way to work with large language models | Learn LangChain in 10min](https://youtu.be/kmbS6FDQh7c) by [Sophia Yang](https://www.youtube.com/@SophiaYangDS)
-- [4 Autonomous AI Agents: “Westworld” simulation `BabyAGI`, `AutoGPT`, `Camel`, `LangChain`](https://youtu.be/yWbnH6inT_U) by [Sophia Yang](https://www.youtube.com/@SophiaYangDS)
-- [AI CAN SEARCH THE INTERNET? Langchain Agents + OpenAI ChatGPT](https://youtu.be/J-GL0htqda8) by [tylerwhatsgood](https://www.youtube.com/@tylerwhatsgood)
-- [Query Your Data with GPT-4 | Embeddings, Vector Databases | Langchain JS Knowledgebase](https://youtu.be/jRnUPUTkZmU) by [StarMorph AI](https://www.youtube.com/@starmorph)
-- [`Weaviate` + LangChain for LLM apps presented by Erika Cardenas](https://youtu.be/7AGj4Td5Lgw) by [`Weaviate` • Vector Database](https://www.youtube.com/@Weaviate)
-- [Langchain Overview — How to Use Langchain & `ChatGPT`](https://youtu.be/oYVYIq0lOtI) by [Python In Office](https://www.youtube.com/@pythoninoffice6568)
-- [Langchain Overview - How to Use Langchain & `ChatGPT`](https://youtu.be/oYVYIq0lOtI) by [Python In Office](https://www.youtube.com/@pythoninoffice6568)
-- [Custom langchain Agent & Tools with memory. Turn any `Python function` into langchain tool with Gpt 3](https://youtu.be/NIG8lXk0ULg) by [echohive](https://www.youtube.com/@echohive)
-- [LangChain: Run Language Models Locally - `Hugging Face Models`](https://youtu.be/Xxxuw4_iCzw) by [Prompt Engineering](https://www.youtube.com/@engineerprompt)
-- [`ChatGPT` with any `YouTube` video using langchain and `chromadb`](https://youtu.be/TQZfB2bzVwU) by [echohive](https://www.youtube.com/@echohive)
-- [How to Talk to a `PDF` using LangChain and `ChatGPT`](https://youtu.be/v2i1YDtrIwk) by [Automata Learning Lab](https://www.youtube.com/@automatalearninglab)
-- [Langchain Document Loaders Part 1: Unstructured Files](https://youtu.be/O5C0wfsen98) by [Merk](https://www.youtube.com/@merksworld) 
-- [LangChain - Prompt Templates (what all the best prompt engineers use)](https://youtu.be/1aRu8b0XNOQ) by [Nick Daigler](https://www.youtube.com/@nick_daigs)
-- [LangChain. Crear aplicaciones Python impulsadas por GPT](https://youtu.be/DkW_rDndts8) by [Jesús Conde](https://www.youtube.com/@0utKast)
-- [Easiest Way to Use GPT In Your Products | LangChain Basics Tutorial](https://youtu.be/fLy0VenZyGc) by [Rachel Woods](https://www.youtube.com/@therachelwoods)
-- [`BabyAGI` + `GPT-4` Langchain Agent with Internet Access](https://youtu.be/wx1z_hs5P6E) by [tylerwhatsgood](https://www.youtube.com/@tylerwhatsgood)
-- [Learning LLM Agents. How does it actually work? LangChain, AutoGPT & OpenAI](https://youtu.be/mb_YAABSplk) by [Arnoldas Kemeklis](https://www.youtube.com/@processusAI)
-- [Get Started with LangChain in `Node.js`](https://youtu.be/Wxx1KUWJFv4) by [Developers Digest](https://www.youtube.com/@DevelopersDigest)
-- [LangChain + `OpenAI` tutorial: Building a Q&A system w/ own text data](https://youtu.be/DYOU_Z0hAwo) by [Samuel Chan](https://www.youtube.com/@SamuelChan)
-- [Langchain + `Zapier` Agent](https://youtu.be/yribLAb-pxA) by [Merk](https://www.youtube.com/@merksworld)
-- [Connecting the Internet with `ChatGPT` (LLMs) using Langchain And Answers Your Questions](https://youtu.be/9Y0TBC63yZg) by [Kamalraj M M](https://www.youtube.com/@insightbuilder)
-- [Build More Powerful LLM Applications for Business’s with LangChain (Beginners Guide)](https://youtu.be/sp3-WLKEcBg) by[ No Code Blackbox](https://www.youtube.com/@nocodeblackbox)
-- ⛓️ [LangFlow LLM Agent Demo for 🦜🔗LangChain](https://youtu.be/zJxDHaWt-6o) by [Cobus Greyling](https://www.youtube.com/@CobusGreylingZA)
-- ⛓️ [Chatbot Factory: Streamline Python Chatbot Creation with LLMs and Langchain](https://youtu.be/eYer3uzrcuM) by [Finxter](https://www.youtube.com/@CobusGreylingZA)
-- ⛓️ [LangChain Tutorial - ChatGPT mit eigenen Daten](https://youtu.be/0XDLyY90E2c) by [Coding Crashkurse](https://www.youtube.com/@codingcrashkurse6429)
-- ⛓️ [Chat with a `CSV` | LangChain Agents Tutorial (Beginners)](https://youtu.be/tjeti5vXWOU) by [GoDataProf](https://www.youtube.com/@godataprof)
-- ⛓️ [Introdução ao Langchain - #Cortes - Live DataHackers](https://youtu.be/fw8y5VRei5Y) by [Prof. João Gabriel Lima](https://www.youtube.com/@profjoaogabriellima)
-- ⛓️ [LangChain: Level up `ChatGPT` !? | LangChain Tutorial Part 1](https://youtu.be/vxUGx8aZpDE) by [Code Affinity](https://www.youtube.com/@codeaffinitydev)
-- ⛓️ [KI schreibt krasses Youtube Skript 😲😳 | LangChain Tutorial Deutsch](https://youtu.be/QpTiXyK1jus) by [SimpleKI](https://www.youtube.com/@simpleki)
-- ⛓️ [Chat with Audio: Langchain, `Chroma DB`, OpenAI, and `Assembly AI`](https://youtu.be/Kjy7cx1r75g) by [AI Anytime](https://www.youtube.com/@AIAnytime)
-- ⛓️ [QA over documents with Auto vector index selection with Langchain router chains](https://youtu.be/9G05qybShv8) by [echohive](https://www.youtube.com/@echohive)
-- ⛓️ [Build your own custom LLM application with `Bubble.io` & Langchain (No Code & Beginner friendly)](https://youtu.be/O7NhQGu1m6c) by [No Code Blackbox](https://www.youtube.com/@nocodeblackbox)
-- ⛓️ [Simple App to Question Your Docs: Leveraging `Streamlit`, `Hugging Face Spaces`, LangChain, and `Claude`!](https://youtu.be/X4YbNECRr7o) by [Chris Alexiuk](https://www.youtube.com/@chrisalexiuk)
-- ⛓️ [LANGCHAIN AI- `ConstitutionalChainAI` + Databutton AI ASSISTANT Web App](https://youtu.be/5zIU6_rdJCU) by [Avra](https://www.youtube.com/@Avra_b)
-- ⛓️ [LANGCHAIN AI AUTONOMOUS AGENT WEB APP - 👶 `BABY AGI` 🤖 with EMAIL AUTOMATION using `DATABUTTON`](https://youtu.be/cvAwOGfeHgw) by [Avra](https://www.youtube.com/@Avra_b)
-- ⛓️ [The Future of Data Analysis: Using A.I. Models in Data Analysis (LangChain)](https://youtu.be/v_LIcVyg5dk) by [Absent Data](https://www.youtube.com/@absentdata)
-- ⛓️ [Memory in LangChain | Deep dive (python)](https://youtu.be/70lqvTFh_Yg) by [Eden Marco](https://www.youtube.com/@EdenMarco)
-- ⛓️ [9 LangChain UseCases | Beginner's Guide | 2023](https://youtu.be/zS8_qosHNMw) by [Data Science Basics](https://www.youtube.com/@datasciencebasics)
-- ⛓️ [Use Large Language Models in Jupyter Notebook | LangChain | Agents & Indexes](https://youtu.be/JSe11L1a_QQ) by [Abhinaw Tiwari](https://www.youtube.com/@AbhinawTiwariAT)
-- ⛓️ [How to Talk to Your Langchain Agent | `11 Labs` + `Whisper`](https://youtu.be/N4k459Zw2PU) by [VRSEN](https://www.youtube.com/@vrsen)
-- ⛓️ [LangChain Deep Dive: 5 FUN AI App Ideas To Build Quickly and Easily](https://youtu.be/mPYEPzLkeks) by [James NoCode](https://www.youtube.com/@jamesnocode)
-- ⛓️ [BEST OPEN Alternative to OPENAI's EMBEDDINGs for Retrieval QA: LangChain](https://youtu.be/ogEalPMUCSY) by [Prompt Engineering](https://www.youtube.com/@engineerprompt)
-- ⛓️ [LangChain 101: Models](https://youtu.be/T6c_XsyaNSQ) by [Mckay Wrigley](https://www.youtube.com/@realmckaywrigley)
-- ⛓️ [LangChain with JavaScript Tutorial #1 | Setup & Using LLMs](https://youtu.be/W3AoeMrg27o) by [Leon van Zyl](https://www.youtube.com/@leonvanzyl)
-- ⛓️ [LangChain Overview & Tutorial for Beginners: Build Powerful AI Apps Quickly & Easily (ZERO CODE)](https://youtu.be/iI84yym473Q) by [James NoCode](https://www.youtube.com/@jamesnocode)
-- ⛓️ [LangChain In Action: Real-World Use Case With Step-by-Step Tutorial](https://youtu.be/UO699Szp82M) by [Rabbitmetrics](https://www.youtube.com/@rabbitmetrics)
-- ⛓️ [Summarizing and Querying Multiple Papers with LangChain](https://youtu.be/p_MQRWH5Y6k) by [Automata Learning Lab](https://www.youtube.com/@automatalearninglab)
-- ⛓️ [Using Langchain (and `Replit`) through `Tana`, ask `Google`/`Wikipedia`/`Wolfram Alpha` to fill out a table](https://youtu.be/Webau9lEzoI) by [Stian Håklev](https://www.youtube.com/@StianHaklev)
-- ⛓️ [Langchain PDF App (GUI) | Create a ChatGPT For Your `PDF` in Python](https://youtu.be/wUAUdEw5oxM) by [Alejandro AO - Software & Ai](https://www.youtube.com/@alejandro_ao)
-- ⛓️ [Auto-GPT with LangChain 🔥 | Create Your Own Personal AI Assistant](https://youtu.be/imDfPmMKEjM) by [Data Science Basics](https://www.youtube.com/@datasciencebasics)
-- ⛓️ [Create Your OWN Slack AI Assistant with Python & LangChain](https://youtu.be/3jFXRNn2Bu8) by [Dave Ebbelaar](https://www.youtube.com/@daveebbelaar)
-- ⛓️ [How to Create LOCAL Chatbots with GPT4All and LangChain [Full Guide]](https://youtu.be/4p1Fojur8Zw) by [Liam Ottley](https://www.youtube.com/@LiamOttley)
-- ⛓️ [Build a `Multilingual PDF` Search App with LangChain, `Cohere` and `Bubble`](https://youtu.be/hOrtuumOrv8) by [Menlo Park Lab](https://www.youtube.com/@menloparklab)
-- ⛓️ [Building a LangChain Agent (code-free!) Using `Bubble` and `Flowise`](https://youtu.be/jDJIIVWTZDE) by [Menlo Park Lab](https://www.youtube.com/@menloparklab)
-- ⛓️ [Build a LangChain-based Semantic PDF Search App with No-Code Tools Bubble and Flowise](https://youtu.be/s33v5cIeqA4) by [Menlo Park Lab](https://www.youtube.com/@menloparklab)
-- ⛓️ [LangChain Memory Tutorial | Building a ChatGPT Clone in Python](https://youtu.be/Cwq91cj2Pnc) by [Alejandro AO - Software & Ai](https://www.youtube.com/@alejandro_ao)
-- ⛓️ [ChatGPT For Your DATA | Chat with Multiple Documents Using LangChain](https://youtu.be/TeDgIDqQmzs) by [Data Science Basics](https://www.youtube.com/@datasciencebasics)
-- ⛓️ [`Llama Index`: Chat with Documentation using URL Loader](https://youtu.be/XJRoDEctAwA) by [Merk](https://www.youtube.com/@merksworld)
-- ⛓️ [Using OpenAI, LangChain, and `Gradio` to Build Custom GenAI Applications](https://youtu.be/1MsmqMg3yUc) by [David Hundley](https://www.youtube.com/@dkhundley)
-
-
-
----------------------
-⛓ icon marks a new video [last update 2023-05-15]

docs/conf.py

@@ -22,16 +22,13 @@ with open("../pyproject.toml") as f:
 
 # -- Project information -----------------------------------------------------
 
-project = "🦜🔗 LangChain"
-copyright = "2023, Harrison Chase"
+project = "LangChain"
+copyright = "2022, Harrison Chase"
 author = "Harrison Chase"
 
 version = data["tool"]["poetry"]["version"]
 release = version
 
-html_title = project + " " + version
-html_last_updated_fmt = "%b %d, %Y"
-
 
 # -- General configuration ---------------------------------------------------
 
@@ -45,12 +42,11 @@ extensions = [
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinxcontrib.autodoc_pydantic",
-    "myst_nb",
-    "sphinx_copybutton",
+    "myst_parser",
+    "nbsphinx",
     "sphinx_panels",
-    "IPython.sphinxext.ipython_console_highlighting",
 ]
-source_suffix = [".ipynb", ".html", ".md", ".rst"]
+
 
 autodoc_pydantic_model_show_json = False
 autodoc_pydantic_field_list_validators = False
@@ -77,13 +73,8 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_book_theme"
-
-html_theme_options = {
-    "path_to_docs": "docs",
-    "repository_url": "https://github.com/hwchase17/langchain",
-    "use_repository_button": True,
-}
+html_theme = "sphinx_rtd_theme"
+# html_theme = "sphinx_typlog_theme"
 
 html_context = {
     "display_github": True,  # Integrate GitHub
@@ -96,17 +87,4 @@ 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_js_files = [
-    "js/mendablesearch.js",
-]
-
-nb_execution_mode = "off"
-myst_enable_extensions = ["colon_fence"]
+html_static_path: list = []

docs/dependents.md

@@ -1,192 +0,0 @@
-# Dependents
-
-Dependents stats for `hwchase17/langchain`
-
-[![](https://img.shields.io/static/v1?label=Used%20by&message=5152&color=informational&logo=slickpic)](https://github.com/hwchase17/langchain/network/dependents)
-[![](https://img.shields.io/static/v1?label=Used%20by%20(public)&message=172&color=informational&logo=slickpic)](https://github.com/hwchase17/langchain/network/dependents)
-[![](https://img.shields.io/static/v1?label=Used%20by%20(private)&message=4980&color=informational&logo=slickpic)](https://github.com/hwchase17/langchain/network/dependents)
-[![](https://img.shields.io/static/v1?label=Used%20by%20(stars)&message=17239&color=informational&logo=slickpic)](https://github.com/hwchase17/langchain/network/dependents)
-
-[update: 2023-05-17; only dependent repositories with Stars > 100]
-
-
-| Repository | Stars  |
-| :--------  | -----: |
-|[openai/openai-cookbook](https://github.com/openai/openai-cookbook) | 35401 |
-|[LAION-AI/Open-Assistant](https://github.com/LAION-AI/Open-Assistant) | 32861 |
-|[microsoft/TaskMatrix](https://github.com/microsoft/TaskMatrix) | 32766 |
-|[hpcaitech/ColossalAI](https://github.com/hpcaitech/ColossalAI) | 29560 |
-|[reworkd/AgentGPT](https://github.com/reworkd/AgentGPT) | 22315 |
-|[imartinez/privateGPT](https://github.com/imartinez/privateGPT) | 17474 |
-|[openai/chatgpt-retrieval-plugin](https://github.com/openai/chatgpt-retrieval-plugin) | 16923 |
-|[mindsdb/mindsdb](https://github.com/mindsdb/mindsdb) | 16112 |
-|[jerryjliu/llama_index](https://github.com/jerryjliu/llama_index) | 15407 |
-|[mlflow/mlflow](https://github.com/mlflow/mlflow) | 14345 |
-|[GaiZhenbiao/ChuanhuChatGPT](https://github.com/GaiZhenbiao/ChuanhuChatGPT) | 10372 |
-|[databrickslabs/dolly](https://github.com/databrickslabs/dolly) | 9919 |
-|[AIGC-Audio/AudioGPT](https://github.com/AIGC-Audio/AudioGPT) | 8177 |
-|[logspace-ai/langflow](https://github.com/logspace-ai/langflow) | 6807 |
-|[imClumsyPanda/langchain-ChatGLM](https://github.com/imClumsyPanda/langchain-ChatGLM) | 6087 |
-|[arc53/DocsGPT](https://github.com/arc53/DocsGPT) | 5292 |
-|[e2b-dev/e2b](https://github.com/e2b-dev/e2b) | 4622 |
-|[nsarrazin/serge](https://github.com/nsarrazin/serge) | 4076 |
-|[madawei2699/myGPTReader](https://github.com/madawei2699/myGPTReader) | 3952 |
-|[zauberzeug/nicegui](https://github.com/zauberzeug/nicegui) | 3952 |
-|[go-skynet/LocalAI](https://github.com/go-skynet/LocalAI) | 3762 |
-|[GreyDGL/PentestGPT](https://github.com/GreyDGL/PentestGPT) | 3388 |
-|[mmabrouk/chatgpt-wrapper](https://github.com/mmabrouk/chatgpt-wrapper) | 3243 |
-|[zilliztech/GPTCache](https://github.com/zilliztech/GPTCache) | 3189 |
-|[wenda-LLM/wenda](https://github.com/wenda-LLM/wenda) | 3050 |
-|[marqo-ai/marqo](https://github.com/marqo-ai/marqo) | 2930 |
-|[gkamradt/langchain-tutorials](https://github.com/gkamradt/langchain-tutorials) | 2710 |
-|[PrefectHQ/marvin](https://github.com/PrefectHQ/marvin) | 2545 |
-|[project-baize/baize-chatbot](https://github.com/project-baize/baize-chatbot) | 2479 |
-|[whitead/paper-qa](https://github.com/whitead/paper-qa) | 2399 |
-|[langgenius/dify](https://github.com/langgenius/dify) | 2344 |
-|[GerevAI/gerev](https://github.com/GerevAI/gerev) | 2283 |
-|[hwchase17/chat-langchain](https://github.com/hwchase17/chat-langchain) | 2266 |
-|[guangzhengli/ChatFiles](https://github.com/guangzhengli/ChatFiles) | 1903 |
-|[Azure-Samples/azure-search-openai-demo](https://github.com/Azure-Samples/azure-search-openai-demo) | 1884 |
-|[OpenBMB/BMTools](https://github.com/OpenBMB/BMTools) | 1860 |
-|[Farama-Foundation/PettingZoo](https://github.com/Farama-Foundation/PettingZoo) | 1813 |
-|[OpenGVLab/Ask-Anything](https://github.com/OpenGVLab/Ask-Anything) | 1571 |
-|[IntelligenzaArtificiale/Free-Auto-GPT](https://github.com/IntelligenzaArtificiale/Free-Auto-GPT) | 1480 |
-|[hwchase17/notion-qa](https://github.com/hwchase17/notion-qa) | 1464 |
-|[NVIDIA/NeMo-Guardrails](https://github.com/NVIDIA/NeMo-Guardrails) | 1419 |
-|[Unstructured-IO/unstructured](https://github.com/Unstructured-IO/unstructured) | 1410 |
-|[Kav-K/GPTDiscord](https://github.com/Kav-K/GPTDiscord) | 1363 |
-|[paulpierre/RasaGPT](https://github.com/paulpierre/RasaGPT) | 1344 |
-|[StanGirard/quivr](https://github.com/StanGirard/quivr) | 1330 |
-|[lunasec-io/lunasec](https://github.com/lunasec-io/lunasec) | 1318 |
-|[vocodedev/vocode-python](https://github.com/vocodedev/vocode-python) | 1286 |
-|[agiresearch/OpenAGI](https://github.com/agiresearch/OpenAGI) | 1156 |
-|[h2oai/h2ogpt](https://github.com/h2oai/h2ogpt) | 1141 |
-|[jina-ai/thinkgpt](https://github.com/jina-ai/thinkgpt) | 1106 |
-|[yanqiangmiffy/Chinese-LangChain](https://github.com/yanqiangmiffy/Chinese-LangChain) | 1072 |
-|[ttengwang/Caption-Anything](https://github.com/ttengwang/Caption-Anything) | 1064 |
-|[jina-ai/dev-gpt](https://github.com/jina-ai/dev-gpt) | 1057 |
-|[juncongmoo/chatllama](https://github.com/juncongmoo/chatllama) | 1003 |
-|[greshake/llm-security](https://github.com/greshake/llm-security) | 1002 |
-|[visual-openllm/visual-openllm](https://github.com/visual-openllm/visual-openllm) | 957 |
-|[richardyc/Chrome-GPT](https://github.com/richardyc/Chrome-GPT) | 918 |
-|[irgolic/AutoPR](https://github.com/irgolic/AutoPR) | 886 |
-|[mmz-001/knowledge_gpt](https://github.com/mmz-001/knowledge_gpt) | 867 |
-|[thomas-yanxin/LangChain-ChatGLM-Webui](https://github.com/thomas-yanxin/LangChain-ChatGLM-Webui) | 850 |
-|[microsoft/X-Decoder](https://github.com/microsoft/X-Decoder) | 837 |
-|[peterw/Chat-with-Github-Repo](https://github.com/peterw/Chat-with-Github-Repo) | 826 |
-|[cirediatpl/FigmaChain](https://github.com/cirediatpl/FigmaChain) | 782 |
-|[hashintel/hash](https://github.com/hashintel/hash) | 778 |
-|[seanpixel/Teenage-AGI](https://github.com/seanpixel/Teenage-AGI) | 773 |
-|[jina-ai/langchain-serve](https://github.com/jina-ai/langchain-serve) | 738 |
-|[corca-ai/EVAL](https://github.com/corca-ai/EVAL) | 737 |
-|[ai-sidekick/sidekick](https://github.com/ai-sidekick/sidekick) | 717 |
-|[rlancemartin/auto-evaluator](https://github.com/rlancemartin/auto-evaluator) | 703 |
-|[poe-platform/api-bot-tutorial](https://github.com/poe-platform/api-bot-tutorial) | 689 |
-|[SamurAIGPT/Camel-AutoGPT](https://github.com/SamurAIGPT/Camel-AutoGPT) | 666 |
-|[eyurtsev/kor](https://github.com/eyurtsev/kor) | 608 |
-|[run-llama/llama-lab](https://github.com/run-llama/llama-lab) | 559 |
-|[namuan/dr-doc-search](https://github.com/namuan/dr-doc-search) | 544 |
-|[pieroit/cheshire-cat](https://github.com/pieroit/cheshire-cat) | 520 |
-|[griptape-ai/griptape](https://github.com/griptape-ai/griptape) | 514 |
-|[getmetal/motorhead](https://github.com/getmetal/motorhead) | 481 |
-|[hwchase17/chat-your-data](https://github.com/hwchase17/chat-your-data) | 462 |
-|[langchain-ai/langchain-aiplugin](https://github.com/langchain-ai/langchain-aiplugin) | 452 |
-|[jina-ai/agentchain](https://github.com/jina-ai/agentchain) | 439 |
-|[SamurAIGPT/ChatGPT-Developer-Plugins](https://github.com/SamurAIGPT/ChatGPT-Developer-Plugins) | 437 |
-|[alexanderatallah/window.ai](https://github.com/alexanderatallah/window.ai) | 433 |
-|[michaelthwan/searchGPT](https://github.com/michaelthwan/searchGPT) | 427 |
-|[mpaepper/content-chatbot](https://github.com/mpaepper/content-chatbot) | 425 |
-|[mckaywrigley/repo-chat](https://github.com/mckaywrigley/repo-chat) | 422 |
-|[whyiyhw/chatgpt-wechat](https://github.com/whyiyhw/chatgpt-wechat) | 421 |
-|[freddyaboulton/gradio-tools](https://github.com/freddyaboulton/gradio-tools) | 407 |
-|[jonra1993/fastapi-alembic-sqlmodel-async](https://github.com/jonra1993/fastapi-alembic-sqlmodel-async) | 395 |
-|[yeagerai/yeagerai-agent](https://github.com/yeagerai/yeagerai-agent) | 383 |
-|[akshata29/chatpdf](https://github.com/akshata29/chatpdf) | 374 |
-|[OpenGVLab/InternGPT](https://github.com/OpenGVLab/InternGPT) | 368 |
-|[ruoccofabrizio/azure-open-ai-embeddings-qna](https://github.com/ruoccofabrizio/azure-open-ai-embeddings-qna) | 358 |
-|[101dotxyz/GPTeam](https://github.com/101dotxyz/GPTeam) | 357 |
-|[mtenenholtz/chat-twitter](https://github.com/mtenenholtz/chat-twitter) | 354 |
-|[amosjyng/langchain-visualizer](https://github.com/amosjyng/langchain-visualizer) | 343 |
-|[msoedov/langcorn](https://github.com/msoedov/langcorn) | 334 |
-|[showlab/VLog](https://github.com/showlab/VLog) | 330 |
-|[continuum-llms/chatgpt-memory](https://github.com/continuum-llms/chatgpt-memory) | 324 |
-|[steamship-core/steamship-langchain](https://github.com/steamship-core/steamship-langchain) | 323 |
-|[daodao97/chatdoc](https://github.com/daodao97/chatdoc) | 320 |
-|[xuwenhao/geektime-ai-course](https://github.com/xuwenhao/geektime-ai-course) | 308 |
-|[StevenGrove/GPT4Tools](https://github.com/StevenGrove/GPT4Tools) | 301 |
-|[logan-markewich/llama_index_starter_pack](https://github.com/logan-markewich/llama_index_starter_pack) | 300 |
-|[andylokandy/gpt-4-search](https://github.com/andylokandy/gpt-4-search) | 299 |
-|[Anil-matcha/ChatPDF](https://github.com/Anil-matcha/ChatPDF) | 287 |
-|[itamargol/openai](https://github.com/itamargol/openai) | 273 |
-|[BlackHC/llm-strategy](https://github.com/BlackHC/llm-strategy) | 267 |
-|[momegas/megabots](https://github.com/momegas/megabots) | 259 |
-|[bborn/howdoi.ai](https://github.com/bborn/howdoi.ai) | 238 |
-|[Cheems-Seminar/grounded-segment-any-parts](https://github.com/Cheems-Seminar/grounded-segment-any-parts) | 232 |
-|[ur-whitelab/exmol](https://github.com/ur-whitelab/exmol) | 227 |
-|[sullivan-sean/chat-langchainjs](https://github.com/sullivan-sean/chat-langchainjs) | 227 |
-|[explosion/spacy-llm](https://github.com/explosion/spacy-llm) | 226 |
-|[recalign/RecAlign](https://github.com/recalign/RecAlign) | 218 |
-|[jupyterlab/jupyter-ai](https://github.com/jupyterlab/jupyter-ai) | 218 |
-|[alvarosevilla95/autolang](https://github.com/alvarosevilla95/autolang) | 215 |
-|[conceptofmind/toolformer](https://github.com/conceptofmind/toolformer) | 213 |
-|[MagnivOrg/prompt-layer-library](https://github.com/MagnivOrg/prompt-layer-library) | 209 |
-|[JohnSnowLabs/nlptest](https://github.com/JohnSnowLabs/nlptest) | 208 |
-|[airobotlab/KoChatGPT](https://github.com/airobotlab/KoChatGPT) | 197 |
-|[langchain-ai/auto-evaluator](https://github.com/langchain-ai/auto-evaluator) | 195 |
-|[yvann-hub/Robby-chatbot](https://github.com/yvann-hub/Robby-chatbot) | 195 |
-|[alejandro-ao/langchain-ask-pdf](https://github.com/alejandro-ao/langchain-ask-pdf) | 192 |
-|[daveebbelaar/langchain-experiments](https://github.com/daveebbelaar/langchain-experiments) | 189 |
-|[NimbleBoxAI/ChainFury](https://github.com/NimbleBoxAI/ChainFury) | 187 |
-|[kaleido-lab/dolphin](https://github.com/kaleido-lab/dolphin) | 184 |
-|[Anil-matcha/Website-to-Chatbot](https://github.com/Anil-matcha/Website-to-Chatbot) | 183 |
-|[plchld/InsightFlow](https://github.com/plchld/InsightFlow) | 180 |
-|[OpenBMB/AgentVerse](https://github.com/OpenBMB/AgentVerse) | 166 |
-|[benthecoder/ClassGPT](https://github.com/benthecoder/ClassGPT) | 166 |
-|[jbrukh/gpt-jargon](https://github.com/jbrukh/gpt-jargon) | 161 |
-|[hardbyte/qabot](https://github.com/hardbyte/qabot) | 160 |
-|[shaman-ai/agent-actors](https://github.com/shaman-ai/agent-actors) | 153 |
-|[radi-cho/datasetGPT](https://github.com/radi-cho/datasetGPT) | 153 |
-|[poe-platform/poe-protocol](https://github.com/poe-platform/poe-protocol) | 152 |
-|[paolorechia/learn-langchain](https://github.com/paolorechia/learn-langchain) | 149 |
-|[ajndkr/lanarky](https://github.com/ajndkr/lanarky) | 149 |
-|[fengyuli-dev/multimedia-gpt](https://github.com/fengyuli-dev/multimedia-gpt) | 147 |
-|[yasyf/compress-gpt](https://github.com/yasyf/compress-gpt) | 144 |
-|[homanp/superagent](https://github.com/homanp/superagent) | 143 |
-|[realminchoi/babyagi-ui](https://github.com/realminchoi/babyagi-ui) | 141 |
-|[ethanyanjiali/minChatGPT](https://github.com/ethanyanjiali/minChatGPT) | 141 |
-|[ccurme/yolopandas](https://github.com/ccurme/yolopandas) | 139 |
-|[hwchase17/langchain-streamlit-template](https://github.com/hwchase17/langchain-streamlit-template) | 138 |
-|[Jaseci-Labs/jaseci](https://github.com/Jaseci-Labs/jaseci) | 136 |
-|[hirokidaichi/wanna](https://github.com/hirokidaichi/wanna) | 135 |
-|[Haste171/langchain-chatbot](https://github.com/Haste171/langchain-chatbot) | 134 |
-|[jmpaz/promptlib](https://github.com/jmpaz/promptlib) | 130 |
-|[Klingefjord/chatgpt-telegram](https://github.com/Klingefjord/chatgpt-telegram) | 130 |
-|[filip-michalsky/SalesGPT](https://github.com/filip-michalsky/SalesGPT) | 128 |
-|[handrew/browserpilot](https://github.com/handrew/browserpilot) | 128 |
-|[shauryr/S2QA](https://github.com/shauryr/S2QA) | 127 |
-|[steamship-core/vercel-examples](https://github.com/steamship-core/vercel-examples) | 127 |
-|[yasyf/summ](https://github.com/yasyf/summ) | 127 |
-|[gia-guar/JARVIS-ChatGPT](https://github.com/gia-guar/JARVIS-ChatGPT) | 126 |
-|[jerlendds/osintbuddy](https://github.com/jerlendds/osintbuddy) | 125 |
-|[ibiscp/LLM-IMDB](https://github.com/ibiscp/LLM-IMDB) | 124 |
-|[Teahouse-Studios/akari-bot](https://github.com/Teahouse-Studios/akari-bot) | 124 |
-|[hwchase17/chroma-langchain](https://github.com/hwchase17/chroma-langchain) | 124 |
-|[menloparklab/langchain-cohere-qdrant-doc-retrieval](https://github.com/menloparklab/langchain-cohere-qdrant-doc-retrieval) | 123 |
-|[peterw/StoryStorm](https://github.com/peterw/StoryStorm) | 123 |
-|[chakkaradeep/pyCodeAGI](https://github.com/chakkaradeep/pyCodeAGI) | 123 |
-|[petehunt/langchain-github-bot](https://github.com/petehunt/langchain-github-bot) | 115 |
-|[su77ungr/CASALIOY](https://github.com/su77ungr/CASALIOY) | 113 |
-|[eunomia-bpf/GPTtrace](https://github.com/eunomia-bpf/GPTtrace) | 113 |
-|[zenml-io/zenml-projects](https://github.com/zenml-io/zenml-projects) | 112 |
-|[pablomarin/GPT-Azure-Search-Engine](https://github.com/pablomarin/GPT-Azure-Search-Engine) | 111 |
-|[shamspias/customizable-gpt-chatbot](https://github.com/shamspias/customizable-gpt-chatbot) | 109 |
-|[WongSaang/chatgpt-ui-server](https://github.com/WongSaang/chatgpt-ui-server) | 108 |
-|[davila7/file-gpt](https://github.com/davila7/file-gpt) | 104 |
-|[enhancedocs/enhancedocs](https://github.com/enhancedocs/enhancedocs) | 102 |
-|[aurelio-labs/arxiv-bot](https://github.com/aurelio-labs/arxiv-bot) | 101 |
-
-
-
-_Generated by [github-dependents-info](https://github.com/nvuillam/github-dependents-info)_
-
-[github-dependents-info --repo hwchase17/langchain --markdownfile dependents.md --minstars 100 --sort stars]

docs/ecosystem/psychic.md

@@ -1,20 +0,0 @@
-# Psychic
-
-This page covers how to use [Psychic](https://www.psychic.dev/) within LangChain.
-
-## What is Psychic?
-
-Psychic is a platform for integrating with your customer’s SaaS tools like Notion, Zendesk, Confluence, and Google Drive via OAuth and syncing documents from these applications to your SQL or vector database. You can think of it like Plaid for unstructured data. Psychic is easy to set up - you use it by importing the react library and configuring it with your Sidekick API key, which you can get from the [Psychic dashboard](https://dashboard.psychic.dev/). When your users connect their applications, you can view these connections from the dashboard and retrieve data using the server-side libraries.
-
-## Quick start
-
-1. Create an account in the [dashboard](https://dashboard.psychic.dev/).
-2. Use the [react library](https://docs.psychic.dev/sidekick-link) to add the Psychic link modal to your frontend react app. Users will use this to connect their SaaS apps.
-3. Once your user has created a connection, you can use the langchain PsychicLoader by following the [example notebook](../modules/indexes/document_loaders/examples/psychic.ipynb)
-
-
-# Advantages vs Other Document Loaders
-
-1.	**Universal API:** Instead of building OAuth flows and learning the APIs for every SaaS app, you integrate Psychic once and leverage our universal API to retrieve data.
-2.	**Data Syncs:** Data in your customers' SaaS apps can get stale fast. With Psychic you can configure webhooks to keep your documents up to date on a daily or realtime basis.
-3.	**Simplified OAuth:** Psychic handles OAuth end-to-end so that you don't have to spend time creating OAuth clients for each integration, keeping access tokens fresh, and handling OAuth redirect logic.

docs/examples/agents.rst

@@ -0,0 +1,47 @@
+Agents
+======
+
+The examples here 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.rst>`_ documentation.
+- Agents: An agent uses an LLMChain to determine which tools to use. For a list of all available agent types, see `here <../explanation/agents.md>`_.
+
+**MRKL**
+
+- **Tools used**: Search, SQLDatabaseChain, LLMMathChain
+- **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 <agents/mrkl.ipynb>`_
+
+**Self-Ask-With-Search**
+
+- **Tools used**: Search
+- **Agent used**: `self-ask-with-search`
+- `Paper <https://ofir.io/self-ask.pdf>`_
+- `Example Notebook <agents/self_ask_with_search.ipynb>`_
+
+**ReAct**
+
+- **Tools used**: Wikipedia Docstore
+- **Agent used**: `react-docstore`
+- `Paper <https://arxiv.org/pdf/2210.03629.pdf>`_
+- `Example Notebook <agents/react.ipynb>`_
+
+
+
+Additionally, we also provide examples for how to do more customizability:
+
+**Custom Agent**
+
+- Purpose: How to create custom agents.
+- `Example Notebook <agents/custom_agent.ipynb>`_
+
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+   :hidden:
+
+   agents/*

docs/examples/agents/custom_agent.ipynb

@@ -0,0 +1,232 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "ba5f8741",
+   "metadata": {},
+   "source": [
+    "# Custom Agent\n",
+    "\n",
+    "This notebook goes through how to create your own custom agent.\n",
+    "\n",
+    "An agent consists of three parts:\n",
+    "    \n",
+    "    - Tools: The tools the agent has available to use.\n",
+    "    - LLMChain: The LLMChain that produces the text that is parsed in a certain way to determine which action to take.\n",
+    "    - The agent class itself: this parses the output of the LLMChain to determin which action to take.\n",
+    "        \n",
+    "        \n",
+    "In this notebook we walk through two types of custom agents. The first type shows how to create a custom LLMChain, but still use an existing agent class to parse the output. The second shows how to create a custom agent class."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "6064f080",
+   "metadata": {},
+   "source": [
+    "### Custom LLMChain\n",
+    "\n",
+    "The first way to create a custom agent is to use an existing Agent class, but use a custom LLMChain. This is the simplest way to create a custom Agent. It is highly reccomended that you work with the `ZeroShotAgent`, as at the moment that is by far the most generalizable one. \n",
+    "\n",
+    "Most of the work in creating the custom LLMChain comes down to the prompt. Because we are using an existing agent class to parse the output, it is very important that the prompt say to produce text in that format. However, besides those instructions, you can customize the prompt as you wish.\n",
+    "\n",
+    "To ensure that the prompt contains the appropriate instructions, we will utilize a helper method on that class. The helper method for the `ZeroShotAgent` takes the following arguments:\n",
+    "\n",
+    "- tools: List of tools the agent will have access to, used to format the prompt.\n",
+    "- prefix: String to put before the list of tools.\n",
+    "- suffix: String to put after the list of tools.\n",
+    "- input_variables: List of input variables the final prompt will expect.\n",
+    "\n",
+    "For this exercise, we will give our agent access to Google Search, and we will customize it in that we will have it answer as a pirate."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "9af9734e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.agents import ZeroShotAgent, Tool\n",
+    "from langchain import OpenAI, SerpAPIWrapper, LLMChain"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "becda2a1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "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",
+    "]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "339b1bb8",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "prefix = \"\"\"Answer the following questions as best you can, but speaking as a pirate might speak. You have access to the following tools:\"\"\"\n",
+    "suffix = \"\"\"Begin! Remember to speak as a pirate when giving your final answer. Use lots of \"Args\"\n",
+    "\n",
+    "Question: {input}\"\"\"\n",
+    "\n",
+    "prompt = ZeroShotAgent.create_prompt(\n",
+    "    tools, \n",
+    "    prefix=prefix, \n",
+    "    suffix=suffix, \n",
+    "    input_variables=[\"input\"]\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "59db7b58",
+   "metadata": {},
+   "source": [
+    "In case we are curious, we can now take a look at the final prompt template to see what it looks like when its all put together."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "e21d2098",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Answer the following questions as best you can, but speaking as a pirate might speak. You have access to the following tools:\n",
+      "\n",
+      "Search: useful for when you need to answer questions about current events\n",
+      "\n",
+      "Use the following format:\n",
+      "\n",
+      "Question: the input question you must answer\n",
+      "Thought: you should always think about what to do\n",
+      "Action: the action to take, should be one of [Search]\n",
+      "Action Input: the input to the action\n",
+      "Observation: the result of the action\n",
+      "... (this Thought/Action/Action Input/Observation can repeat N times)\n",
+      "Thought: I now know the final answer\n",
+      "Final Answer: the final answer to the original input question\n",
+      "\n",
+      "Begin! Remember to speak as a pirate when giving your final answer. Use lots of \"Args\"\n",
+      "\n",
+      "Question: {input}\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(prompt.template)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "9b1cc2a2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "llm_chain = LLMChain(llm=OpenAI(temperature=0), prompt=prompt)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "e4f5092f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "agent = ZeroShotAgent(llm_chain=llm_chain, tools=tools, verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "653b1617",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
+      "How many people live in canada?\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should look this up\n",
+      "Action: Search\n",
+      "Action Input: How many people live in canada\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mThe current population of Canada is 38,533,678 as of Friday, November 25, 2022, based on Worldometer elaboration of the latest United Nations data. · Canada 2020 ...\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
+      "Final Answer: Arrr, there be 38,533,678 people in Canada\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'Arrr, there be 38,533,678 people in Canada'"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent.run(\"How many people live in canada?\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "90171b2b",
+   "metadata": {},
+   "source": [
+    "### Custom Agent Class\n",
+    "\n",
+    "Coming soon."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "adefb4c2",
+   "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.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/agents/mrkl.ipynb

@@ -27,13 +27,12 @@
    "outputs": [],
    "source": [
     "from langchain import LLMMathChain, OpenAI, SerpAPIWrapper, SQLDatabase, SQLDatabaseChain\n",
-    "from langchain.agents import initialize_agent, Tool\n",
-    "from langchain.agents import AgentType"
+    "from langchain.agents import initialize_agent, Tool"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 2,
    "id": "07e96d99",
    "metadata": {},
    "outputs": [],
@@ -41,8 +40,8 @@
     "llm = OpenAI(temperature=0)\n",
     "search = SerpAPIWrapper()\n",
     "llm_math_chain = LLMMathChain(llm=llm, verbose=True)\n",
-    "db = SQLDatabase.from_uri(\"sqlite:///../../../../../notebooks/Chinook.db\")\n",
-    "db_chain = SQLDatabaseChain.from_llm(llm, db, verbose=True)\n",
+    "db = SQLDatabase.from_uri(\"sqlite:///../../../notebooks/Chinook.db\")\n",
+    "db_chain = SQLDatabaseChain(llm=llm, database=db, verbose=True)\n",
     "tools = [\n",
     "    Tool(\n",
     "        name = \"Search\",\n",
@@ -64,17 +63,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 3,
    "id": "a069c4b6",
    "metadata": {},
    "outputs": [],
    "source": [
-    "mrkl = initialize_agent(tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True)"
+    "mrkl = initialize_agent(tools, llm, agent=\"zero-shot-react-description\", verbose=True)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 4,
    "id": "e603cd7d",
    "metadata": {},
    "outputs": [
@@ -84,50 +83,56 @@
      "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",
+      "\u001b[1m> Entering new ZeroShotAgent chain...\u001b[0m\n",
+      "Thought:\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;3mDiCaprio met actor Camila Morrone in December 2017, when she was 20 and he was 43. They were spotted at Coachella and went on multiple vacations together. Some reports suggested that DiCaprio was ready to ask Morrone to marry him. The couple made their red carpet debut at the 2020 Academy Awards.\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3m I need to calculate Camila Morrone's age raised to the 0.43 power.\n",
+      "Action Input: \"Who is Olivia Wilde's boyfriend?\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mOlivia Wilde started dating Harry Styles after ending her years-long engagement to Jason Sudeikis — see their relationship timeline.\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 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: 21^0.43\u001b[0m\n",
+      "Action Input: 28^0.23\u001b[0m\n",
       "\n",
       "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\n",
-      "21^0.43\u001b[32;1m\u001b[1;3m\n",
-      "```text\n",
-      "21**0.43\n",
+      "28^0.23\u001b[32;1m\u001b[1;3m\n",
+      "\n",
+      "```python\n",
+      "import math\n",
+      "print(math.pow(28, 0.23))\n",
       "```\n",
-      "...numexpr.evaluate(\"21**0.43\")...\n",
       "\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m3.7030049853137306\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "Answer: \u001b[33;1m\u001b[1;3m2.1520202182226886\n",
+      "\u001b[0m\n",
+      "\u001b[1m> Finished LLMMathChain chain.\u001b[0m\n",
       "\n",
-      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 3.7030049853137306\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.7030049853137306.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "Final Answer: Harry Styles, Olivia Wilde's boyfriend, is 28 years old and his age raised to the 0.23 power is 2.1520202182226886.\u001b[0m\n",
+      "\u001b[1m> Finished ZeroShotAgent 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.7030049853137306.\""
+       "\"Harry Styles, Olivia Wilde's boyfriend, is 28 years old and his age raised to the 0.23 power is 2.1520202182226886.\""
       ]
      },
-     "execution_count": 5,
+     "execution_count": 4,
      "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": 6,
+   "execution_count": 5,
    "id": "a5c07010",
    "metadata": {},
    "outputs": [
@@ -137,51 +142,35 @@
      "text": [
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\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",
+      "\u001b[1m> Entering new ZeroShotAgent chain...\u001b[0m\n",
+      "Thought:\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 Morissette, released June 17, 2022, via Epiphany Music and Thirty Tigers, as well as by RCA Records in Europe.\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;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",
       "Action: FooBar DB\n",
       "Action Input: What albums by 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:"
-     ]
-    },
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/Users/harrisonchase/workplace/langchain/langchain/sql_database.py:191: 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 \"Title\" FROM \"Album\" INNER JOIN \"Artist\" ON \"Album\".\"ArtistId\" = \"Artist\".\"ArtistId\" WHERE \"Name\" = 'Alanis Morissette' LIMIT 5;\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';\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 hers 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's album 'Jagged Little Pill' is in the FooBar database.\u001b[0m\n",
+      "\u001b[1m> Finished ZeroShotAgent 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 hers in the FooBar database are Jagged Little Pill.\""
+       "\"Alanis Morissette's album 'Jagged Little Pill' is in the FooBar database.\""
       ]
      },
-     "execution_count": 6,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -215,7 +204,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

docs/examples/agents/natbot.py

@@ -0,0 +1,88 @@
+"""Run NatBot."""
+import time
+
+from langchain.chains.natbot.base import NatBotChain
+from langchain.chains.natbot.crawler import Crawler  # type: ignore
+
+
+def run_cmd(cmd: str, _crawler: Crawler) -> None:
+    """Run command."""
+    cmd = cmd.split("\n")[0]
+
+    if cmd.startswith("SCROLL UP"):
+        _crawler.scroll("up")
+    elif cmd.startswith("SCROLL DOWN"):
+        _crawler.scroll("down")
+    elif cmd.startswith("CLICK"):
+        commasplit = cmd.split(",")
+        id = commasplit[0].split(" ")[1]
+        _crawler.click(id)
+    elif cmd.startswith("TYPE"):
+        spacesplit = cmd.split(" ")
+        id = spacesplit[1]
+        text_pieces = spacesplit[2:]
+        text = " ".join(text_pieces)
+        # Strip leading and trailing double quotes
+        text = text[1:-1]
+
+        if cmd.startswith("TYPESUBMIT"):
+            text += "\n"
+        _crawler.type(id, text)
+
+    time.sleep(2)
+
+
+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()
+    if len(i) > 0:
+        objective = i
+    quiet = False
+    nat_bot_chain = NatBotChain.from_default(objective)
+    _crawler = Crawler()
+    _crawler.go_to_page("google.com")
+    try:
+        while True:
+            browser_content = "\n".join(_crawler.crawl())
+            llm_command = nat_bot_chain.execute(_crawler.page.url, browser_content)
+            if not quiet:
+                print("URL: " + _crawler.page.url)
+                print("Objective: " + objective)
+                print("----------------\n" + browser_content + "\n----------------\n")
+            if len(llm_command) > 0:
+                print("Suggested command: " + llm_command)
+
+            command = input()
+            if command == "r" or command == "":
+                run_cmd(llm_command, _crawler)
+            elif command == "g":
+                url = input("URL:")
+                _crawler.go_to_page(url)
+            elif command == "u":
+                _crawler.scroll("up")
+                time.sleep(1)
+            elif command == "d":
+                _crawler.scroll("down")
+                time.sleep(1)
+            elif command == "c":
+                id = input("id:")
+                _crawler.click(id)
+                time.sleep(1)
+            elif command == "t":
+                id = input("id:")
+                text = input("text:")
+                _crawler.type(id, text)
+                time.sleep(1)
+            elif command == "o":
+                objective = input("Objective:")
+            else:
+                print(
+                    "(g) to visit url\n(u) scroll up\n(d) scroll down\n(c) to click"
+                    "\n(t) to type\n(h) to view commands again"
+                    "\n(r/enter) to run suggested command\n(o) change objective"
+                )
+    except KeyboardInterrupt:
+        print("\n[!] Ctrl+C detected, exiting gracefully.")
+        exit(0)

docs/examples/agents/react.ipynb

@@ -0,0 +1,110 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "82140df0",
+   "metadata": {},
+   "source": [
+    "# ReAct\n",
+    "\n",
+    "This notebook showcases using an agent to implement the ReAct logic."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "4e272b47",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain import OpenAI, Wikipedia\n",
+    "from langchain.agents import initialize_agent, Tool\n",
+    "from langchain.agents.react.base import DocstoreExplorer\n",
+    "docstore=DocstoreExplorer(Wikipedia())\n",
+    "tools = [\n",
+    "    Tool(\n",
+    "        name=\"Search\",\n",
+    "        func=docstore.search\n",
+    "    ),\n",
+    "    Tool(\n",
+    "        name=\"Lookup\",\n",
+    "        func=docstore.lookup\n",
+    "    )\n",
+    "]\n",
+    "\n",
+    "llm = OpenAI(temperature=0, model_name=\"text-davinci-002\")\n",
+    "react = initialize_agent(tools, llm, agent=\"react-docstore\", verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "8078c8f1",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new ReActDocstoreAgent chain...\u001b[0m\n",
+      "Thought 1:\u001b[32;1m\u001b[1;3m I need to search David Chanoff and find the U.S. Navy admiral he collaborated\n",
+      "with.\n",
+      "Action 1: Search[David Chanoff]\u001b[0m\n",
+      "Observation 1: \u001b[36;1m\u001b[1;3mDavid Chanoff is a noted author of non-fiction work. His work has typically involved collaborations with the principal protagonist of the work concerned. His collaborators have included; Augustus A. White, Joycelyn Elders, Đoàn Văn Toại, William J. Crowe, Ariel Sharon, Kenneth Good and Felix Zandman. He has also written about a wide range of subjects including literary history, education and foreign for The Washington Post, The New Republic and The New York Times Magazine. He has published more than twelve books.\u001b[0m\n",
+      "Thought 2:\u001b[32;1m\u001b[1;3m The U.S. Navy admiral David Chanoff collaborated with is William J. Crowe.\n",
+      "Action 2: Search[William J. Crowe]\u001b[0m\n",
+      "Observation 2: \u001b[36;1m\u001b[1;3mWilliam James Crowe Jr. (January 2, 1925 – October 18, 2007) was a United States Navy admiral and diplomat who served as the 11th chairman of the Joint Chiefs of Staff under Presidents Ronald Reagan and George H. W. Bush, and as the ambassador to the United Kingdom and Chair of the Intelligence Oversight Board under President Bill Clinton.\u001b[0m\n",
+      "Thought 3:\u001b[32;1m\u001b[1;3m William J. Crowe served as the ambassador to the United Kingdom under President Bill Clinton.\n",
+      "Action 3: Finish[Bill Clinton]\u001b[0m\n",
+      "\u001b[1m> Finished ReActDocstoreAgent chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'Bill Clinton'"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "question = \"Author David Chanoff has collaborated with a U.S. Navy admiral who served as the ambassador to the United Kingdom under which President?\"\n",
+    "react.run(question)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4ff64e81",
+   "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.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/agents/self_ask_with_search.ipynb

@@ -12,7 +12,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 2,
    "id": "7e3b513e",
    "metadata": {},
    "outputs": [
@@ -22,15 +22,14 @@
      "text": [
       "\n",
       "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m Yes.\n",
+      "\u001b[1m> Entering new SelfAskWithSearchAgent chain...\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mAre follow up questions needed here: Yes.\n",
       "Follow up: Who is the reigning men's U.S. Open champion?\u001b[0m\n",
-      "Intermediate answer: \u001b[36;1m\u001b[1;3mCarlos Alcaraz Garfia\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mFollow up: Where is Carlos Alcaraz Garfia from?\u001b[0m\n",
+      "Intermediate answer: \u001b[36;1m\u001b[1;3mCarlos Alcaraz\u001b[0m\n",
+      "\u001b[32;1m\u001b[1;3mFollow up: Where is Carlos Alcaraz from?\u001b[0m\n",
       "Intermediate answer: \u001b[36;1m\u001b[1;3mEl Palmar, Spain\u001b[0m\n",
       "\u001b[32;1m\u001b[1;3mSo the final answer is: El Palmar, Spain\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "\u001b[1m> Finished SelfAskWithSearchAgent chain.\u001b[0m\n"
      ]
     },
     {
@@ -39,7 +38,7 @@
        "'El Palmar, Spain'"
       ]
      },
-     "execution_count": 1,
+     "execution_count": 2,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -47,26 +46,24 @@
    "source": [
     "from langchain import OpenAI, SerpAPIWrapper\n",
     "from langchain.agents import initialize_agent, Tool\n",
-    "from langchain.agents import AgentType\n",
     "\n",
     "llm = OpenAI(temperature=0)\n",
     "search = SerpAPIWrapper()\n",
     "tools = [\n",
     "    Tool(\n",
     "        name=\"Intermediate Answer\",\n",
-    "        func=search.run,\n",
-    "        description=\"useful for when you need to ask with search\"\n",
+    "        func=search.run\n",
     "    )\n",
     "]\n",
     "\n",
-    "self_ask_with_search = initialize_agent(tools, llm, agent=AgentType.SELF_ASK_WITH_SEARCH, verbose=True)\n",
+    "self_ask_with_search = initialize_agent(tools, llm, agent=\"self-ask-with-search\", verbose=True)\n",
     "self_ask_with_search.run(\"What is the hometown of the reigning men's U.S. Open champion?\")"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "b2e4d6bc",
+   "id": "683d69e7",
    "metadata": {},
    "outputs": [],
    "source": []
@@ -88,12 +85,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "b1677b440931f40d89ef8be7bf03acb108ce003de0ac9b18e8d43753ea2e7103"
-   }
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

docs/examples/chains.rst

@@ -0,0 +1,88 @@
+Chains
+======
+
+The examples here are all end-to-end chains for specific applications.
+A chain is made up of links, which can be either primitives or other chains.
+
+The following primitives exist as options to use for links:
+
+#. `LLM: <../modules/llms.rst>`_ A language model takes text as input and outputs text.
+#. `PromptTemplate: <../modules/prompt.rst>`_ A prompt template takes arbitrary string inputs and returns a final formatted string.
+#. `TextSplitter: <../modules/text_splitter.rst>`_ A text splitter takes a longer document and splits it into smaller chunks.
+#. `Python REPL: <../modules/python.rst>`_ A Python REPL takes a string representing a Python command to run, runs that command, and then returns anything that was printed during that run.
+#. `SQL Database: <../modules/sql_database.rst>`_ A SQL database takes a string representing a SQL command as input and executes that command against the database. If any rows are returned, then those are cast to a string and returned.
+#. `Search: <../modules/serpapi.rst>`_ A search object takes a string as input and executes that against a search object, returning any results.
+#. `Docstore: <../modules/docstore.rst>`_ A docstore object can be used to lookup a document in a database by exact match.
+#. `Vectorstore: <../modules/vectorstore.rst>`_ A vectorstore object uses embeddings stored in a vector database to take in an input string and return documents similar to that string.
+
+With these primitives in mind, the following chains exist:
+
+**LLMChain**
+
+- **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 <chains/llm_chain.ipynb>`_
+
+**LLMMath**
+
+- **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 <chains/llm_math.ipynb>`_
+
+**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 <chains/pal.ipynb>`_
+
+**Recursive Summarization**
+
+- **Links Used**: TextSplitter, LLMChain
+- **Notes**: This chain splits a document into chunks, runs a first LLMChain over each chunk to summarize it, and then runs a second LLMChain over those results to get a summary of the summaries.
+- `Example Notebook <chains/map_reduce.ipynb>`_
+
+**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 <chains/sqlite.ipynb>`_
+
+
+**Vector Database Question-Answering**
+
+- **Links Used**: Vectorstore, LLMChain
+- **Notes**: This chain takes user input (a question), uses the Vectorstore and semantic search to find relevant documents, and then passes the documents plus the original question to another LLM to generate a final answer.
+- `Example Notebook <chains/vector_db_qa.ipynb>`_
+
+**Vector Database Question-Answering With Sources**
+
+- **Links Used**: Vectorstore, LLMChain
+- **Notes**: This chain takes user input (a question), uses the Vectorstore and semantic search to find relevant documents, and then passes the documents plus the original question to another LLM to generate a final answer with sources.
+- `Example Notebook <chains/vector_db_qa_with_sources.ipynb>`_
+
+**Question-Answering With Sources**
+
+- **Links Used**: LLMChain
+- **Notes**: These types of chains take a question and multiple documents as input, and return an answer plus sources for where that answer came from. There are multiple underlying types of chains to do this, for more information see TODO.
+- `Example Notebook <chains/qa_with_sources.ipynb>`_
+
+**Question-Answering**
+
+- **Links Used**: LLMChain
+- **Notes**: These types of chains take a question and multiple documents as input, and return an answer. There are multiple underlying types of chains to do this, for more information see TODO.
+- `Example Notebook <chains/question_answering.ipynb>`_
+
+**Summarization**
+
+- **Links Used**: LLMChain
+- **Notes**: These types of chains take multiple documents as input, and return a summary of all documents. There are multiple underlying types of chains to do this, for more information see TODO.
+- `Example Notebook <chains/summarize.ipynb>`_
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+   :caption: Chains
+   :hidden:
+
+   chains/*

docs/examples/chains/chatgpt_clone.ipynb

@@ -5,7 +5,7 @@
    "id": "b253f4d5",
    "metadata": {},
    "source": [
-    "# How to create ChatGPT Clone\n",
+    "# ChatGPT Clone\n",
     "\n",
     "This chain replicates ChatGPT by combining (1) a specific prompt, and (2) the concept of memory.\n",
     "\n",
@@ -14,7 +14,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 38,
    "id": "a99acd89",
    "metadata": {},
    "outputs": [
@@ -35,20 +35,21 @@
       "Overall, Assistant is a powerful tool that can help with a wide range of tasks and provide valuable insights and information on a wide range of topics. Whether you need help with a specific question or just want to have a conversation about a particular topic, Assistant is here to assist.\n",
       "\n",
       "\n",
-      "Human: I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply with the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\n",
+      "Human: I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply wiht the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\n",
       "Assistant:\u001b[0m\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
       "\n",
       "```\n",
-      "/home/user\n",
+      "$ pwd\n",
+      "/\n",
       "```\n"
      ]
     }
    ],
    "source": [
     "from langchain import OpenAI, ConversationChain, LLMChain, PromptTemplate\n",
-    "from langchain.memory import ConversationBufferWindowMemory\n",
+    "from langchain.chains.conversation.memory import ConversationalBufferWindowMemory\n",
     "\n",
     "\n",
     "template = \"\"\"Assistant is a large language model trained by OpenAI.\n",
@@ -73,16 +74,16 @@
     "    llm=OpenAI(temperature=0), \n",
     "    prompt=prompt, \n",
     "    verbose=True, \n",
-    "    memory=ConversationBufferWindowMemory(k=2),\n",
+    "    memory=ConversationalBufferWindowMemory(k=2),\n",
     ")\n",
     "\n",
-    "output = chatgpt_chain.predict(human_input=\"I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply with the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\")\n",
+    "output = chatgpt_chain.predict(human_input=\"I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply wiht the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\")\n",
     "print(output)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 39,
    "id": "4ef711d6",
    "metadata": {},
    "outputs": [
@@ -102,7 +103,7 @@
       "\n",
       "Overall, Assistant is a powerful tool that can help with a wide range of tasks and provide valuable insights and information on a wide range of topics. Whether you need help with a specific question or just want to have a conversation about a particular topic, Assistant is here to assist.\n",
       "\n",
-      "Human: I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply with the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\n",
+      "Human: I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply wiht the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\n",
       "AI: \n",
       "```\n",
       "$ pwd\n",
@@ -127,7 +128,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 40,
    "id": "a5d6dac2",
    "metadata": {},
    "outputs": [
@@ -147,7 +148,7 @@
       "\n",
       "Overall, Assistant is a powerful tool that can help with a wide range of tasks and provide valuable insights and information on a wide range of topics. Whether you need help with a specific question or just want to have a conversation about a particular topic, Assistant is here to assist.\n",
       "\n",
-      "Human: I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply with the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\n",
+      "Human: I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply wiht the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\n",
       "AI: \n",
       "```\n",
       "$ pwd\n",
@@ -179,7 +180,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 41,
    "id": "b9283077",
    "metadata": {},
    "outputs": [
@@ -234,7 +235,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 42,
    "id": "570e785e",
    "metadata": {},
    "outputs": [
@@ -291,7 +292,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 43,
    "id": "cd0a23d9",
    "metadata": {
     "scrolled": true
@@ -351,7 +352,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 44,
    "id": "90db6eb2",
    "metadata": {},
    "outputs": [
@@ -415,7 +416,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 45,
    "id": "c3806f89",
    "metadata": {},
    "outputs": [
@@ -491,7 +492,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 46,
    "id": "f508f597",
    "metadata": {},
    "outputs": [
@@ -573,7 +574,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 47,
    "id": "cbd607f4",
    "metadata": {},
    "outputs": [
@@ -648,7 +649,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 48,
    "id": "d33e0e28",
    "metadata": {},
    "outputs": [
@@ -715,7 +716,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 49,
    "id": "57c2f113",
    "metadata": {},
    "outputs": [
@@ -788,7 +789,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 50,
    "id": "babadc78",
    "metadata": {},
    "outputs": [
@@ -864,7 +865,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 51,
    "id": "0954792a",
    "metadata": {},
    "outputs": [
@@ -914,24 +915,26 @@
       "  \"response\": \"Artificial intelligence (AI) is the simulation of human intelligence processes by machines, especially computer systems. These processes include learning (the acquisition of information and rules for using the information), reasoning (using the rules to reach approximate or definite conclusions) and self-correction. AI is used to develop computer systems that can think and act like humans.\"\n",
       "}\n",
       "```\n",
-      "Human: curl --header \"Content-Type:application/json\" --request POST --data '{\"message\": \"I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply with the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\"}' https://chat.openai.com/chat\n",
+      "Human: curl --header \"Content-Type:application/json\" --request POST --data '{\"message\": \"I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply wiht the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\"}' https://chat.openai.com/chat\n",
       "Assistant:\u001b[0m\n",
       "\n",
       "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
       " \n",
       "\n",
       "```\n",
-      "$ curl --header \"Content-Type:application/json\" --request POST --data '{\"message\": \"I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply with the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\"}' https://chat.openai.com/chat\n",
+      "$ curl --header \"Content-Type:application/json\" --request POST --data '{\"message\": \"I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply wiht the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\"}' https://chat.openai.com/chat\n",
       "\n",
       "{\n",
-      "  \"response\": \"```\\n/current/working/directory\\n```\"\n",
+      "  \"response\": \"```\n",
+      "/home/user\n",
+      "```\"\n",
       "}\n",
       "```\n"
      ]
     }
    ],
    "source": [
-    "output = chatgpt_chain.predict(human_input=\"\"\"curl --header \"Content-Type:application/json\" --request POST --data '{\"message\": \"I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply with the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\"}' https://chat.openai.com/chat\"\"\")\n",
+    "output = chatgpt_chain.predict(human_input=\"\"\"curl --header \"Content-Type:application/json\" --request POST --data '{\"message\": \"I want you to act as a Linux terminal. I will type commands and you will reply with what the terminal should show. I want you to only reply wiht the terminal output inside one unique code block, and nothing else. Do not write explanations. Do not type commands unless I instruct you to do so. When I need to tell you something in English I will do so by putting text inside curly brackets {like this}. My first command is pwd.\"}' https://chat.openai.com/chat\"\"\")\n",
     "print(output)"
    ]
   },
@@ -960,7 +963,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.4"
   }
  },
  "nbformat": 4,

docs/examples/chains/llm_bash.ipynb

@@ -0,0 +1,87 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# BashChain\n",
+    "This notebook showcases using LLMs and a bash process to do perform simple filesystem commands."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "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",
+      "echo \"Hello World\"\n",
+      "```\u001b[0m['```bash', 'echo \"Hello World\"', '```']\n",
+      "\n",
+      "Answer: \u001b[33;1m\u001b[1;3mHello World\n",
+      "\u001b[0m\n",
+      "\u001b[1m> Finished LLMBashChain chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'Hello World\\n'"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from langchain.chains import LLMBashChain\n",
+    "from langchain.llms import OpenAI\n",
+    "\n",
+    "llm = OpenAI(temperature=0)\n",
+    "\n",
+    "text = \"Please write a bash script that prints 'Hello World' to the console.\"\n",
+    "\n",
+    "bash_chain = LLMBashChain(llm=llm, verbose=True)\n",
+    "\n",
+    "bash_chain.run(text)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

docs/examples/chains/llm_chain.ipynb

@@ -0,0 +1,154 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "d8a5c5d4",
+   "metadata": {},
+   "source": [
+    "# LLM Chain\n",
+    "\n",
+    "This notebook showcases a simple LLM chain."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "835e6978",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain import PromptTemplate, OpenAI, LLMChain"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "06bcb078",
+   "metadata": {},
+   "source": [
+    "### Single Input\n",
+    "\n",
+    "First, lets go over an example using a single input"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "51a54c4d",
+   "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: What NFL team won the Super Bowl in the year Justin Beiber was born?\n",
+      "\n",
+      "Answer: Let's think step by step.\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "' Justin Bieber was born in 1994, so the NFL team that won the Super Bowl in 1994 was the Dallas Cowboys.'"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "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",
+    "\n",
+    "question = \"What NFL team won the Super Bowl in the year Justin Beiber was born?\"\n",
+    "\n",
+    "llm_chain.predict(question=question)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "79c3ec4d",
+   "metadata": {},
+   "source": [
+    "### Multiple Inputs\n",
+    "Now lets go over an example using multiple inputs."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "03dd6918",
+   "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;3mWrite a sad poem about ducks.\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "\"\\n\\nThe ducks swim in the pond,\\nTheir feathers so soft and warm,\\nBut they can't help but feel so forlorn.\\n\\nTheir quacks echo in the air,\\nBut no one is there to hear,\\nFor they have no one to share.\\n\\nThe ducks paddle around in circles,\\nTheir heads hung low in despair,\\nFor they have no one to care.\\n\\nThe ducks look up to the sky,\\nBut no one is there to see,\\nFor they have no one to be.\\n\\nThe ducks drift away in the night,\\nTheir hearts filled with sorrow and pain,\\nFor they have no one to gain.\""
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "template = \"\"\"Write a {adjective} poem about {subject}.\"\"\"\n",
+    "prompt = PromptTemplate(template=template, input_variables=[\"adjective\", \"subject\"])\n",
+    "llm_chain = LLMChain(prompt=prompt, llm=OpenAI(temperature=0), verbose=True)\n",
+    "\n",
+    "llm_chain.predict(adjective=\"sad\", subject=\"ducks\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "8310cdaa",
+   "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.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/chains/llm_checker.ipynb

@@ -23,16 +23,28 @@
       "\n",
       "\n",
       "\u001b[1m> Entering new SequentialChain chain...\u001b[0m\n",
+      "\u001b[1mChain 0\u001b[0m:\n",
+      "{'statement': '\\nThe largest mammal that lays eggs is the platypus.'}\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\u001b[1mChain 1\u001b[0m:\n",
+      "{'assertions': '\\n• The largest mammal is the platypus.\\n• The platypus lays eggs.\\n• There is no larger mammal than the platypus that lays eggs.'}\n",
       "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
+      "\u001b[1mChain 2\u001b[0m:\n",
+      "{'checked_assertions': '\\n1. The largest mammal is the platypus. False. The blue whale is the largest mammal.\\n\\n2. The platypus lays eggs. True. The Platypus is one of only two mammals that lay eggs.\\n\\n3. There is no larger mammal than the platypus that lays eggs. False. The echidna is another mammal that lays eggs and is larger than the platypus.'}\n",
+      "\n",
+      "\u001b[1mChain 3\u001b[0m:\n",
+      "{'revised_statement': ' The echidna is the type of mammal that lays the biggest eggs.'}\n",
+      "\n",
+      "\n",
+      "\u001b[1m> Finished SequentialChain chain.\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMCheckerChain chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "' No mammal lays the biggest eggs. The Elephant Bird, which was a species of giant bird, laid the largest eggs of any bird.'"
+       "' The echidna is the type of mammal that lays the biggest eggs.'"
       ]
      },
      "execution_count": 1,
@@ -48,7 +60,7 @@
     "\n",
     "text = \"What type of mammal lays the biggest eggs?\"\n",
     "\n",
-    "checker_chain = LLMCheckerChain.from_llm(llm, verbose=True)\n",
+    "checker_chain = LLMCheckerChain(llm=llm, verbose=True)\n",
     "\n",
     "checker_chain.run(text)"
    ]
@@ -77,7 +89,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

docs/examples/chains/llm_math.ipynb

@@ -12,7 +12,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 1,
    "id": "44e9ba31",
    "metadata": {},
    "outputs": [
@@ -22,24 +22,29 @@
      "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",
-      "```text\n",
-      "13 ** .3432\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
+      "How many of the integers between 0 and 99 inclusive are divisible by 8?\u001b[102m\n",
+      "\n",
+      "```python\n",
+      "count = 0\n",
+      "for i in range(100):\n",
+      "    if i % 8 == 0:\n",
+      "        count += 1\n",
+      "print(count)\n",
       "```\n",
-      "...numexpr.evaluate(\"13 ** .3432\")...\n",
       "\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m2.4116004626599237\u001b[0m\n",
+      "Answer: \u001b[103m13\n",
+      "\u001b[0m\n",
       "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "'Answer: 2.4116004626599237'"
+       "'Answer: 13\\n'"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 1,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -48,15 +53,15 @@
     "from langchain import OpenAI, LLMMathChain\n",
     "\n",
     "llm = OpenAI(temperature=0)\n",
-    "llm_math = LLMMathChain.from_llm(llm, verbose=True)\n",
+    "llm_math = LLMMathChain(llm=llm, verbose=True)\n",
     "\n",
-    "llm_math.run(\"What is 13 raised to the .3432 power?\")"
+    "llm_math.run(\"How many of the integers between 0 and 99 inclusive are divisible by 8?\")"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "e978bb8e",
+   "id": "f62f0c75",
    "metadata": {},
    "outputs": [],
    "source": []
@@ -78,7 +83,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.4"
   }
  },
  "nbformat": 4,

docs/examples/chains/llm_requests.ipynb

@@ -69,7 +69,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "id": "2ea81168",
    "metadata": {},
    "outputs": [
@@ -78,10 +78,10 @@
       "text/plain": [
        "{'query': 'What are the Three (3) biggest countries, and their respective sizes?',\n",
        " 'url': 'https://www.google.com/search?q=What+are+the+Three+(3)+biggest+countries,+and+their+respective+sizes?',\n",
-       " 'output': ' Russia (17,098,242 km²), Canada (9,984,670 km²), United States (9,826,675 km²)'}"
+       " 'output': ' Russia (17,098,242 sq km), Canada (9,984,670 sq km), China (9,706,961 sq km)'}"
       ]
      },
-     "execution_count": 5,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -115,7 +115,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

docs/examples/chains/moderation.ipynb

@@ -1,7 +1,6 @@
 {
  "cells": [
   {
-   "attachments": {},
    "cell_type": "markdown",
    "id": "b83e61ed",
    "metadata": {},
@@ -14,12 +13,12 @@
     "In this notebook, we will show:\n",
     "\n",
     "1. How to run any piece of text through a moderation chain.\n",
-    "2. How to append a Moderation chain to an LLMChain."
+    "2. How to append a Moderation chain to a LLMChain."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 13,
    "id": "b7aa1ff2",
    "metadata": {},
    "outputs": [],
@@ -132,7 +131,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 8,
    "id": "954f3da2",
    "metadata": {},
    "outputs": [
@@ -143,11 +142,11 @@
      "traceback": [
       "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
       "\u001b[0;31mValueError\u001b[0m                                Traceback (most recent call last)",
-      "Cell \u001b[0;32mIn[7], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[43mmoderation_chain_error\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mrun\u001b[49m\u001b[43m(\u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mI will kill you\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m)\u001b[49m\n",
-      "File \u001b[0;32m~/workplace/langchain/langchain/chains/base.py:138\u001b[0m, in \u001b[0;36mChain.run\u001b[0;34m(self, *args, **kwargs)\u001b[0m\n\u001b[1;32m    136\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mlen\u001b[39m(args) \u001b[38;5;241m!=\u001b[39m \u001b[38;5;241m1\u001b[39m:\n\u001b[1;32m    137\u001b[0m         \u001b[38;5;28;01mraise\u001b[39;00m \u001b[38;5;167;01mValueError\u001b[39;00m(\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124m`run` supports only one positional argument.\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n\u001b[0;32m--> 138\u001b[0m     \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[38;5;28;43mself\u001b[39;49m\u001b[43m(\u001b[49m\u001b[43margs\u001b[49m\u001b[43m[\u001b[49m\u001b[38;5;241;43m0\u001b[39;49m\u001b[43m]\u001b[49m\u001b[43m)\u001b[49m[\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39moutput_keys[\u001b[38;5;241m0\u001b[39m]]\n\u001b[1;32m    140\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m kwargs \u001b[38;5;129;01mand\u001b[39;00m \u001b[38;5;129;01mnot\u001b[39;00m args:\n\u001b[1;32m    141\u001b[0m     \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[38;5;28mself\u001b[39m(kwargs)[\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39moutput_keys[\u001b[38;5;241m0\u001b[39m]]\n",
-      "File \u001b[0;32m~/workplace/langchain/langchain/chains/base.py:112\u001b[0m, in \u001b[0;36mChain.__call__\u001b[0;34m(self, inputs, return_only_outputs)\u001b[0m\n\u001b[1;32m    108\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mverbose:\n\u001b[1;32m    109\u001b[0m     \u001b[38;5;28mprint\u001b[39m(\n\u001b[1;32m    110\u001b[0m         \u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;130;01m\\n\u001b[39;00m\u001b[38;5;130;01m\\n\u001b[39;00m\u001b[38;5;130;01m\\033\u001b[39;00m\u001b[38;5;124m[1m> Entering new \u001b[39m\u001b[38;5;132;01m{\u001b[39;00m\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m\u001b[38;5;18m__class__\u001b[39m\u001b[38;5;241m.\u001b[39m\u001b[38;5;18m__name__\u001b[39m\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m chain...\u001b[39m\u001b[38;5;130;01m\\033\u001b[39;00m\u001b[38;5;124m[0m\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m    111\u001b[0m     )\n\u001b[0;32m--> 112\u001b[0m outputs \u001b[38;5;241m=\u001b[39m \u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43m_call\u001b[49m\u001b[43m(\u001b[49m\u001b[43minputs\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m    113\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mverbose:\n\u001b[1;32m    114\u001b[0m     \u001b[38;5;28mprint\u001b[39m(\u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;130;01m\\n\u001b[39;00m\u001b[38;5;130;01m\\033\u001b[39;00m\u001b[38;5;124m[1m> Finished \u001b[39m\u001b[38;5;132;01m{\u001b[39;00m\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m\u001b[38;5;18m__class__\u001b[39m\u001b[38;5;241m.\u001b[39m\u001b[38;5;18m__name__\u001b[39m\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m chain.\u001b[39m\u001b[38;5;130;01m\\033\u001b[39;00m\u001b[38;5;124m[0m\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n",
-      "File \u001b[0;32m~/workplace/langchain/langchain/chains/moderation.py:81\u001b[0m, in \u001b[0;36mOpenAIModerationChain._call\u001b[0;34m(self, inputs)\u001b[0m\n\u001b[1;32m     79\u001b[0m text \u001b[38;5;241m=\u001b[39m inputs[\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39minput_key]\n\u001b[1;32m     80\u001b[0m results \u001b[38;5;241m=\u001b[39m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mclient\u001b[38;5;241m.\u001b[39mcreate(text)\n\u001b[0;32m---> 81\u001b[0m output \u001b[38;5;241m=\u001b[39m \u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43m_moderate\u001b[49m\u001b[43m(\u001b[49m\u001b[43mtext\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mresults\u001b[49m\u001b[43m[\u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mresults\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m]\u001b[49m\u001b[43m[\u001b[49m\u001b[38;5;241;43m0\u001b[39;49m\u001b[43m]\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m     82\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m {\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39moutput_key: output}\n",
-      "File \u001b[0;32m~/workplace/langchain/langchain/chains/moderation.py:73\u001b[0m, in \u001b[0;36mOpenAIModerationChain._moderate\u001b[0;34m(self, text, results)\u001b[0m\n\u001b[1;32m     71\u001b[0m error_str \u001b[38;5;241m=\u001b[39m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mText was found that violates OpenAI\u001b[39m\u001b[38;5;124m'\u001b[39m\u001b[38;5;124ms content policy.\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m     72\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39merror:\n\u001b[0;32m---> 73\u001b[0m     \u001b[38;5;28;01mraise\u001b[39;00m \u001b[38;5;167;01mValueError\u001b[39;00m(error_str)\n\u001b[1;32m     74\u001b[0m \u001b[38;5;28;01melse\u001b[39;00m:\n\u001b[1;32m     75\u001b[0m     \u001b[38;5;28;01mreturn\u001b[39;00m error_str\n",
+      "Cell \u001b[0;32mIn[8], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[43mmoderation_chain_error\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mrun\u001b[49m\u001b[43m(\u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mI will kill you\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m)\u001b[49m\n",
+      "File \u001b[0;32m~/workplace/third_party/langchain/langchain/chains/base.py:114\u001b[0m, in \u001b[0;36mChain.run\u001b[0;34m(self, text)\u001b[0m\n\u001b[1;32m    109\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mlen\u001b[39m(\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39moutput_keys) \u001b[38;5;241m!=\u001b[39m \u001b[38;5;241m1\u001b[39m:\n\u001b[1;32m    110\u001b[0m     \u001b[38;5;28;01mraise\u001b[39;00m \u001b[38;5;167;01mValueError\u001b[39;00m(\n\u001b[1;32m    111\u001b[0m         \u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124m`run` not supported when there is not exactly \u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m    112\u001b[0m         \u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mone output key, got \u001b[39m\u001b[38;5;132;01m{\u001b[39;00m\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39moutput_keys\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m.\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m    113\u001b[0m     )\n\u001b[0;32m--> 114\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[38;5;28;43mself\u001b[39;49m\u001b[43m(\u001b[49m\u001b[43m{\u001b[49m\u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43minput_keys\u001b[49m\u001b[43m[\u001b[49m\u001b[38;5;241;43m0\u001b[39;49m\u001b[43m]\u001b[49m\u001b[43m:\u001b[49m\u001b[43m \u001b[49m\u001b[43mtext\u001b[49m\u001b[43m}\u001b[49m\u001b[43m)\u001b[49m[\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39moutput_keys[\u001b[38;5;241m0\u001b[39m]]\n",
+      "File \u001b[0;32m~/workplace/third_party/langchain/langchain/chains/base.py:87\u001b[0m, in \u001b[0;36mChain.__call__\u001b[0;34m(self, inputs, return_only_outputs)\u001b[0m\n\u001b[1;32m     83\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mverbose:\n\u001b[1;32m     84\u001b[0m     \u001b[38;5;28mprint\u001b[39m(\n\u001b[1;32m     85\u001b[0m         \u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;130;01m\\n\u001b[39;00m\u001b[38;5;130;01m\\n\u001b[39;00m\u001b[38;5;130;01m\\033\u001b[39;00m\u001b[38;5;124m[1m> Entering new \u001b[39m\u001b[38;5;132;01m{\u001b[39;00m\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m\u001b[38;5;18m__class__\u001b[39m\u001b[38;5;241m.\u001b[39m\u001b[38;5;18m__name__\u001b[39m\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m chain...\u001b[39m\u001b[38;5;130;01m\\033\u001b[39;00m\u001b[38;5;124m[0m\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m     86\u001b[0m     )\n\u001b[0;32m---> 87\u001b[0m outputs \u001b[38;5;241m=\u001b[39m \u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43m_call\u001b[49m\u001b[43m(\u001b[49m\u001b[43minputs\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m     88\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mverbose:\n\u001b[1;32m     89\u001b[0m     \u001b[38;5;28mprint\u001b[39m(\u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;130;01m\\n\u001b[39;00m\u001b[38;5;130;01m\\033\u001b[39;00m\u001b[38;5;124m[1m> Finished \u001b[39m\u001b[38;5;132;01m{\u001b[39;00m\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m\u001b[38;5;18m__class__\u001b[39m\u001b[38;5;241m.\u001b[39m\u001b[38;5;18m__name__\u001b[39m\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m chain.\u001b[39m\u001b[38;5;130;01m\\033\u001b[39;00m\u001b[38;5;124m[0m\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n",
+      "File \u001b[0;32m~/workplace/third_party/langchain/langchain/chains/moderation.py:79\u001b[0m, in \u001b[0;36mOpenAIModerationChain._call\u001b[0;34m(self, inputs)\u001b[0m\n\u001b[1;32m     77\u001b[0m text \u001b[38;5;241m=\u001b[39m inputs[\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39minput_key]\n\u001b[1;32m     78\u001b[0m results \u001b[38;5;241m=\u001b[39m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mclient\u001b[38;5;241m.\u001b[39mcreate(text)\n\u001b[0;32m---> 79\u001b[0m output \u001b[38;5;241m=\u001b[39m \u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43m_moderate\u001b[49m\u001b[43m(\u001b[49m\u001b[43mtext\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mresults\u001b[49m\u001b[43m[\u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mresults\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m]\u001b[49m\u001b[43m[\u001b[49m\u001b[38;5;241;43m0\u001b[39;49m\u001b[43m]\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m     80\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m {\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39moutput_key: output}\n",
+      "File \u001b[0;32m~/workplace/third_party/langchain/langchain/chains/moderation.py:71\u001b[0m, in \u001b[0;36mOpenAIModerationChain._moderate\u001b[0;34m(self, text, results)\u001b[0m\n\u001b[1;32m     69\u001b[0m error_str \u001b[38;5;241m=\u001b[39m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mText was found that violates OpenAI\u001b[39m\u001b[38;5;124m'\u001b[39m\u001b[38;5;124ms content policy.\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m     70\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39merror:\n\u001b[0;32m---> 71\u001b[0m     \u001b[38;5;28;01mraise\u001b[39;00m \u001b[38;5;167;01mValueError\u001b[39;00m(error_str)\n\u001b[1;32m     72\u001b[0m \u001b[38;5;28;01melse\u001b[39;00m:\n\u001b[1;32m     73\u001b[0m     \u001b[38;5;28;01mreturn\u001b[39;00m error_str\n",
       "\u001b[0;31mValueError\u001b[0m: Text was found that violates OpenAI's content policy."
      ]
     }
@@ -166,7 +165,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 10,
    "id": "3960e985",
    "metadata": {},
    "outputs": [],
@@ -184,7 +183,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 11,
    "id": "1152ec11",
    "metadata": {},
    "outputs": [
@@ -194,7 +193,7 @@
        "'This is okay'"
       ]
      },
-     "execution_count": 9,
+     "execution_count": 11,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -205,7 +204,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 12,
    "id": "973257bf",
    "metadata": {},
    "outputs": [
@@ -215,7 +214,7 @@
        "\"The following text was found that violates OpenAI's content policy: I will kill you\""
       ]
      },
-     "execution_count": 10,
+     "execution_count": 12,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -238,7 +237,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 17,
    "id": "0d129333",
    "metadata": {},
    "outputs": [],
@@ -249,7 +248,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 18,
    "id": "a557c531",
    "metadata": {},
    "outputs": [
@@ -259,7 +258,7 @@
        "' I will kill you'"
       ]
      },
-     "execution_count": 12,
+     "execution_count": 18,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -280,7 +279,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 19,
    "id": "d4d10f1c",
    "metadata": {},
    "outputs": [],
@@ -290,7 +289,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 20,
    "id": "02f37985",
    "metadata": {},
    "outputs": [
@@ -300,7 +299,7 @@
        "\"Text was found that violates OpenAI's content policy.\""
       ]
      },
-     "execution_count": 14,
+     "execution_count": 20,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -319,7 +318,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 22,
    "id": "7118ec36",
    "metadata": {},
    "outputs": [],
@@ -330,7 +329,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 26,
    "id": "003bdfce",
    "metadata": {},
    "outputs": [
@@ -340,7 +339,7 @@
        "{'text': ' I will kill you'}"
       ]
      },
-     "execution_count": 16,
+     "execution_count": 26,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -362,7 +361,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 17,
+   "execution_count": 28,
    "id": "77b64228",
    "metadata": {},
    "outputs": [],
@@ -374,7 +373,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 18,
+   "execution_count": 31,
    "id": "998a95be",
    "metadata": {},
    "outputs": [],
@@ -384,7 +383,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 19,
+   "execution_count": 33,
    "id": "9c97a136",
    "metadata": {},
    "outputs": [
@@ -394,7 +393,7 @@
        "{'sanitized_text': \"Text was found that violates OpenAI's content policy.\"}"
       ]
      },
-     "execution_count": 19,
+     "execution_count": 33,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -428,7 +427,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.9.1"
   }
  },
  "nbformat": 4,

docs/examples/chains/pal.ipynb

@@ -21,24 +21,6 @@
     "from langchain import OpenAI"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9a58e15e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(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)"
    ]
   },
@@ -63,9 +46,7 @@
    "cell_type": "code",
    "execution_count": 4,
    "id": "3ef64b27",
-   "metadata": {
-    "scrolled": true
-   },
+   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
@@ -73,7 +54,7 @@
      "text": [
       "\n",
       "\n",
-      "\u001b[1m> Entering new PALChain chain...\u001b[0m\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
       "\u001b[32;1m\u001b[1;3mdef solution():\n",
       "    \"\"\"Jan has three times the number of pets as Marcia. Marcia has two more pets than Cindy. If Cindy has four pets, how many total pets do the three have?\"\"\"\n",
       "    cindy_pets = 4\n",
@@ -101,14 +82,6 @@
     "pal_chain.run(question)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "0269d20a",
-   "metadata": {},
-   "source": [
-    "## Colored Objects"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 5,
@@ -116,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)"
    ]
   },
@@ -141,7 +115,7 @@
      "text": [
       "\n",
       "\n",
-      "\u001b[1m> Entering new PALChain chain...\u001b[0m\n",
+      "\u001b[1m> Entering new 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",
@@ -155,7 +129,7 @@
       "num_purple = len([object for object in objects if object[1] == 'purple'])\n",
       "answer = num_purple\u001b[0m\n",
       "\n",
-      "\u001b[1m> Finished PALChain chain.\u001b[0m\n"
+      "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     },
     {
@@ -173,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": []
@@ -282,7 +172,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.8.7"
   }
  },
  "nbformat": 4,

docs/examples/chains/qa_with_sources.ipynb

@@ -0,0 +1,258 @@
+{
+ "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](../../explanation/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": "e239964b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "docs = [Document(page_content=t, metadata={\"source\": i}) for i, t in enumerate(texts[:3])]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "7d766417",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': ' The president did not mention Justice Breyer.\\nSOURCES: 0-pl, 1-pl, 2-pl'}"
+      ]
+     },
+     "execution_count": 8,
+     "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": 9,
+   "id": "921db0a4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_with_sources_chain(OpenAI(temperature=0), chain_type=\"map_reduce\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "e417926a",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "None of PyTorch, TensorFlow >= 2.0, or Flax have been found. Models won't be available and only tokenizers, configuration and file/data utilities can be used.\n",
+      "Token indices sequence length is longer than the specified maximum sequence length for this model (1546 > 1024). Running this sequence through the model will result in indexing errors\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': ' The president did not mention Justice Breyer.\\nSOURCES: 0, 1, 2'}"
+      ]
+     },
+     "execution_count": 10,
+     "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": "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": 11,
+   "id": "904835c8",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_with_sources_chain(OpenAI(temperature=0), chain_type=\"refine\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "id": "f60875c6",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': \"\\n\\nThe president did not mention Justice Breyer in his speech to the European Parliament, which focused on building a coalition of freedom-loving nations to confront Putin, unifying European allies, countering Russia's lies with truth, and enforcing powerful economic sanctions. Source: 2\"}"
+      ]
+     },
+     "execution_count": 12,
+     "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": "code",
+   "execution_count": null,
+   "id": "929620d0",
+   "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.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/chains/question_answering.ipynb

@@ -0,0 +1,248 @@
+{
+ "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](../../explanation/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": "d145ae31",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "docs = [Document(page_content=t) for t in texts[:3]]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "77fdf1aa",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': ' The president did not mention Justice Breyer.'}"
+      ]
+     },
+     "execution_count": 8,
+     "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": 9,
+   "id": "b0060f51",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_chain(OpenAI(temperature=0), chain_type=\"map_reduce\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "fbdb9137",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': ' The president did not mention Justice Breyer.'}"
+      ]
+     },
+     "execution_count": 10,
+     "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": "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": 11,
+   "id": "fb167057",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_qa_chain(OpenAI(temperature=0), chain_type=\"refine\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "id": "d8b5286e",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output_text': \"\\n\\nThe president did not mention Justice Breyer in his speech to the European Parliament about building a coalition of freedom-loving nations to confront Putin, unifying European allies, countering Russia's lies with truth, and enforcing powerful economic sanctions.\"}"
+      ]
+     },
+     "execution_count": 12,
+     "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": "code",
+   "execution_count": null,
+   "id": "49e9c6d7",
+   "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.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/chains/sqlite.ipynb

@@ -0,0 +1,129 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "0ed6aab1",
+   "metadata": {
+    "pycharm": {
+     "name": "#%% md\n"
+    }
+   },
+   "source": [
+    "# SQLite example\n",
+    "\n",
+    "This example showcases hooking up an LLM to answer questions over a database."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b2f66479",
+   "metadata": {
+    "pycharm": {
+     "name": "#%% md\n"
+    }
+   },
+   "source": [
+    "This uses the example Chinook database.\n",
+    "To set it up follow the instructions on https://database.guide/2-sample-databases-sqlite/, placing the `.db` file in a notebooks folder at the root of this repository."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "d0e27d88",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "from langchain import OpenAI, SQLDatabase, SQLDatabaseChain"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "72ede462",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "db = SQLDatabase.from_uri(\"sqlite:///../../../notebooks/Chinook.db\")\n",
+    "llm = OpenAI(temperature=0)\n",
+    "db_chain = SQLDatabaseChain(llm=llm, database=db, verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "15ff81df",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
+      "How many employees are there?\n",
+      "SQLQuery:\u001b[102m SELECT COUNT(*) FROM Employee\u001b[0m\n",
+      "SQLResult: \u001b[103m[(8,)]\u001b[0m\n",
+      "Answer:\u001b[102m 8\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "' 8'"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "db_chain.run(\"How many employees are there?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "61d91b85",
+   "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.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/chains/summarize.ipynb

@@ -0,0 +1,234 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "d9a0131f",
+   "metadata": {},
+   "source": [
+    "# Summarization\n",
+    "\n",
+    "This notebook walks through how to use LangChain for summarization 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](../../explanation/combine_docs.md)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0b5660bf",
+   "metadata": {},
+   "source": [
+    "### Prepare Data\n",
+    "First we prepare the data. For this example we create multiple documents from one long one, 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": "e9db25f3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain import OpenAI, PromptTemplate, LLMChain\n",
+    "from langchain.text_splitter import CharacterTextSplitter\n",
+    "from langchain.chains.mapreduce import MapReduceChain\n",
+    "\n",
+    "llm = OpenAI(temperature=0)\n",
+    "\n",
+    "\n",
+    "text_splitter = CharacterTextSplitter()\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "99bbe19b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with open('../state_of_the_union.txt') as f:\n",
+    "    state_of_the_union = f.read()\n",
+    "texts = text_splitter.split_text(state_of_the_union)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "baa6e808",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.docstore.document import Document"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "8dff4f43",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "docs = [Document(page_content=t) for t in texts[:3]]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "27989fc4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.chains.summarize import load_summarize_chain"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ea2d5c99",
+   "metadata": {},
+   "source": [
+    "### The `stuff` Chain\n",
+    "\n",
+    "This sections shows results of using the `stuff` Chain to do summarization."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "f01f3196",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_summarize_chain(llm, chain_type=\"stuff\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "da4d9801",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "' In his speech, President Biden addressed the ongoing conflict between Russia and Ukraine, and the need for the United States and its allies to stand with Ukraine. He also discussed the American Rescue Plan, the Bipartisan Infrastructure Law, and the Bipartisan Innovation Act, which will help to create jobs, modernize infrastructure, and level the playing field with China. He also emphasized the importance of buying American products to support American jobs.'"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain.run(docs)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9c868e86",
+   "metadata": {},
+   "source": [
+    "### The `map_reduce` Chain\n",
+    "\n",
+    "This sections shows results of using the `map_reduce` Chain to do summarization."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "ef28e1d4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_summarize_chain(llm, chain_type=\"map_reduce\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "f82c5f9f",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "\" In response to Vladimir Putin's aggression in Ukraine, the US and its allies have taken action to hold him accountable, including economic sanctions, cutting off access to technology, and seizing the assets of Russian oligarchs. They are also providing military, economic, and humanitarian assistance to the Ukrainians, and releasing 60 million barrels of oil from reserves around the world. President Biden has passed several laws to provide economic relief to Americans and create jobs, and is making sure taxpayer dollars support American jobs and businesses.\""
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain.run(docs)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f61350f9",
+   "metadata": {},
+   "source": [
+    "### The `refine` Chain\n",
+    "\n",
+    "This sections shows results of using the `refine` Chain to do summarization."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "3bcbe31e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = load_summarize_chain(llm, chain_type=\"refine\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "c8cad866",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "\"\\nIn this speech, the speaker addresses the American people and their allies, discussing the recent aggression of Russia's Vladimir Putin in Ukraine. The speaker outlines the actions taken by the United States and its allies to hold Putin accountable, including economic sanctions, cutting off access to technology, and seizing the assets of Russian oligarchs. The speaker also announces the closing of American airspace to Russian flights, further isolating Russia and adding an additional squeeze on their economy. The Russian stock market has lost 40% of its value and trading remains suspended. Together with our allies, the United States is providing military, economic, and humanitarian assistance to Ukraine, and has mobilized forces to protect NATO countries. The speaker also announces the release of 60 million barrels of oil from reserves around the world, with the United States releasing 30 million barrels from its own Strategic Petroleum Reserve. The speaker emphasizes that the United States and its allies will defend every inch of NATO territory and that Putin will pay a high price for his aggression. The speaker also acknowledges the hardships faced by the American people due to the pandemic and the American Rescue Plan, which has provided immediate economic relief for tens of millions of Americans, helped put food on their table, keep a roof over their heads, and cut the cost of health insurance. The speaker\""
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain.run(docs)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0da92750",
+   "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.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/chains/transformation.ipynb

@@ -14,7 +14,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 5,
    "id": "bbbb4330",
    "metadata": {},
    "outputs": [],
@@ -26,18 +26,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 7,
    "id": "8ae5937c",
    "metadata": {},
    "outputs": [],
    "source": [
-    "with open(\"../../state_of_the_union.txt\") as f:\n",
+    "with open('../state_of_the_union.txt') as f:\n",
     "    state_of_the_union = f.read()"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 2,
    "id": "98739592",
    "metadata": {},
    "outputs": [],
@@ -52,7 +52,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 4,
    "id": "e9397934",
    "metadata": {},
    "outputs": [],
@@ -78,17 +78,17 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 8,
    "id": "f7caa1ee",
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "' The speaker addresses the nation, noting that while last year they were kept apart due to COVID-19, this year they are together again. They are reminded that regardless of their political affiliations, they are all Americans.'"
+       "' This speech addresses the American people and acknowledges the difficulties of last year due to COVID-19. It emphasizes the importance of coming together regardless of political affiliation and encourages a sense of unity as Americans.'"
       ]
      },
-     "execution_count": 7,
+     "execution_count": 8,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -122,7 +122,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

docs/examples/chains/vector_db_qa.ipynb

@@ -0,0 +1,104 @@
+{
+ "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": 5,
+   "id": "3018f865",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "qa = VectorDBQA.from_llm(llm=OpenAI(), vectorstore=docsearch)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "032a47f8",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "\" The president said that Ketanji Brown Jackson is one of the nation's top legal minds, a former top litigator and federal public defender, and from a family of public school educators and police officers. He also said that she has received a broad range of support since she was nominated, from the Fraternal Order of Police to former judges appointed by Democrats and Republicans.\""
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "query = \"What did the president say about Ketanji Brown Jackson\"\n",
+    "qa.run(query)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f056f6fd",
+   "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.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/chains/vector_db_qa_with_sources.ipynb

@@ -0,0 +1,146 @@
+{
+ "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. It does this in a few different ways - first showing how you can use the `QAWithSourcesChain` to take in documents and use those, and next showing the `VectorDBQAWithSourcesChain`, which also 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": 2,
+   "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": 3,
+   "id": "0e745d99",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "docsearch = FAISS.from_texts(texts, embeddings)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "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": "markdown",
+   "id": "e6fc81de",
+   "metadata": {},
+   "source": [
+    "### VectorDBQAWithSourcesChain\n",
+    "\n",
+    "This shows how to use the `VectorDBQAWithSourcesChain`, which uses a vector database to look up relevant documents."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "8aa571ae",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.chains import VectorDBQAWithSourcesChain"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "aa859d4c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = VectorDBQAWithSourcesChain.from_llm(OpenAI(temperature=0), vectorstore=docsearch)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "8ba36fa7",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'answer': ' The president thanked Justice Breyer for his service.',\n",
+       " 'sources': '27-pl'}"
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain({\"question\": \"What did the president say about Justice Breyer\"}, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "980fae3b",
+   "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.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/integrations.rst

@@ -0,0 +1,10 @@
+Integrations
+============
+
+The examples here all highlight a specific type of integration.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   integrations/*

docs/examples/integrations/embeddings.ipynb

@@ -0,0 +1,177 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "7ef4d402-6662-4a26-b612-35b542066487",
+   "metadata": {
+    "pycharm": {
+     "name": "#%% md\n"
+    }
+   },
+   "source": [
+    "#  Embeddings & VectorStores\n",
+    "\n",
+    "This notebook show cases how to use embeddings to create a VectorStore"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "965eecee",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.embeddings.openai import OpenAIEmbeddings\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": 2,
+   "id": "68481687",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "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": "015f4ff5",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "docsearch = FAISS.from_texts(texts, embeddings)\n",
+    "\n",
+    "query = \"What did the president say about Ketanji Brown Jackson\"\n",
+    "docs = docsearch.similarity_search(query)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "67baf32e",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "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",
+      "\n",
+      "One of the most serious constitutional responsibilities a President has is nominating someone to serve on the United States Supreme Court. \n",
+      "\n",
+      "And I did that 4 days ago, when I nominated Circuit Court of Appeals Judge Ketanji Brown Jackson. One of our nation’s top legal minds, who will continue Justice Breyer’s legacy of excellence. \n",
+      "\n",
+      "A former top litigator in private practice. A former federal public defender. And from a family of public school educators and police officers. A consensus builder. Since she’s been nominated, she’s received a broad range of support—from the Fraternal Order of Police to former judges appointed by Democrats and Republicans. \n",
+      "\n",
+      "And if we are to advance liberty and justice, we need to secure the Border and fix the immigration system. \n"
+     ]
+    }
+   ],
+   "source": [
+    "print(docs[0].page_content)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "eea6e627",
+   "metadata": {},
+   "source": [
+    "## Requires having ElasticSearch setup"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "4906b8a3",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "docsearch = ElasticVectorSearch.from_texts(texts, embeddings, elasticsearch_url=\"http://localhost:9200\")\n",
+    "\n",
+    "query = \"What did the president say about Ketanji Brown Jackson\"\n",
+    "docs = docsearch.similarity_search(query)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "95f9eee9",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "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",
+      "\n",
+      "One of the most serious constitutional responsibilities a President has is nominating someone to serve on the United States Supreme Court. \n",
+      "\n",
+      "And I did that 4 days ago, when I nominated Circuit Court of Appeals Judge Ketanji Brown Jackson. One of our nation’s top legal minds, who will continue Justice Breyer’s legacy of excellence. \n",
+      "\n",
+      "A former top litigator in private practice. A former federal public defender. And from a family of public school educators and police officers. A consensus builder. Since she’s been nominated, she’s received a broad range of support—from the Fraternal Order of Police to former judges appointed by Democrats and Republicans. \n",
+      "\n",
+      "And if we are to advance liberty and justice, we need to secure the Border and fix the immigration system. \n"
+     ]
+    }
+   ],
+   "source": [
+    "print(docs[0].page_content)"
+   ]
+  }
+ ],
+ "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.8.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/integrations/huggingface_hub.ipynb

@@ -0,0 +1,71 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "959300d4",
+   "metadata": {},
+   "source": [
+    "# HuggingFace Hub\n",
+    "\n",
+    "This example showcases how to connect to the HuggingFace Hub."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "3acf0069",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "The Seattle Seahawks won the Super Bowl in 2010. Justin Beiber was born in 2010. The\n"
+     ]
+    }
+   ],
+   "source": [
+    "from langchain import PromptTemplate, HuggingFaceHub, LLMChain\n",
+    "\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=HuggingFaceHub(repo_id=\"google/flan-t5-xl\", model_kwargs={\"temperature\":1e-10}))\n",
+    "\n",
+    "question = \"What NFL team won the Super Bowl in the year Justin Beiber was born?\"\n",
+    "\n",
+    "print(llm_chain.run(question))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ae4559c7",
+   "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.8.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/integrations/manifest.ipynb

@@ -15,30 +15,14 @@
    "id": "59fcaebc",
    "metadata": {},
    "source": [
-    "For more detailed information on `manifest`, and how to use it with local hugginface models like in this example, see https://github.com/HazyResearch/manifest\n",
-    "\n",
-    "Another example of [using Manifest with Langchain](https://github.com/HazyResearch/manifest/blob/main/examples/langchain_chatgpt.ipynb)."
+    "For more detailed information on `manifest`, and how to use it with local hugginface models like in this example, see https://github.com/HazyResearch/manifest"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
-   "id": "1205d1e4-e6da-4d67-a0c7-b7e8fd1e98d5",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "!pip install manifest-ml"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "id": "04a0170a",
-   "metadata": {
-    "tags": []
-   },
+   "metadata": {},
    "outputs": [],
    "source": [
     "from manifest import Manifest\n",
@@ -47,12 +31,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 4,
    "id": "de250a6a",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "{'model_name': 'bigscience/T0_3B', 'model_path': 'bigscience/T0_3B'}\n"
+     ]
+    }
+   ],
    "source": [
     "manifest = Manifest(\n",
     "    client_name = \"huggingface\",\n",
@@ -116,7 +106,7 @@
     }
    ],
    "source": [
-    "with open('../../../state_of_the_union.txt') as f:\n",
+    "with open('../state_of_the_union.txt') as f:\n",
     "    state_of_the_union = f.read()\n",
     "mp_chain.run(state_of_the_union)"
    ]
@@ -212,7 +202,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.6"
+   "version": "3.8.7"
   },
   "vscode": {
    "interpreter": {

docs/examples/integrations/textsplitter.ipynb

@@ -0,0 +1,304 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "b118c9dc",
+   "metadata": {},
+   "source": [
+    "# Text Splitter\n",
+    "\n",
+    "When you want to deal wit long pieces of text, it is necessary to split up that text into chunks.\n",
+    "This notebook showcases several ways to do that.\n",
+    "\n",
+    "At a high level, text splitters work as following:\n",
+    "\n",
+    "1. Split the text up into small, semantically meaningful chunks (often sentences).\n",
+    "2. Start combining these small chunks into a larger chunk until you reach a certain size (as measured by some function).\n",
+    "3. Once you reach that size, make that chunk its own piece of text and then start creating a new chunk of text with some overlap (to keep context between chunks)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "e82c4685",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.text_splitter import CharacterTextSplitter, NLTKTextSplitter, SpacyTextSplitter\n",
+    "# This is a long document we can split up.\n",
+    "with open('../state_of_the_union.txt') as f:\n",
+    "    state_of_the_union = f.read()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "5c461b26",
+   "metadata": {},
+   "source": [
+    "## Character Text Splitting\n",
+    "\n",
+    "Let's start with the most simple method: let's split based on characters (by default \"\\n\\n\") and measure chunk length by number of characters."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "79ff6737",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "text_splitter = CharacterTextSplitter(        \n",
+    "    separator = \"\\n\\n\",\n",
+    "    chunk_size = 1000,\n",
+    "    chunk_overlap  = 200,\n",
+    "    length_function = len,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "38547666",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans.  \\n\\nLast year COVID-19 kept us apart. This year we are finally together again. \\n\\nTonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \\n\\nWith a duty to one another to the American people to the Constitution. \\n\\nAnd with an unwavering resolve that freedom will always triumph over tyranny. \\n\\nSix days ago, Russia’s Vladimir Putin sought to shake the foundations of the free world thinking he could make it bend to his menacing ways. But he badly miscalculated. \\n\\nHe thought he could roll into Ukraine and the world would roll over. Instead he met a wall of strength he never imagined. \\n\\nHe met the Ukrainian people. \\n\\nFrom President Zelenskyy to every Ukrainian, their fearlessness, their courage, their determination, inspires the world. \\n\\nGroups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland. '"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "texts = text_splitter.split_text(state_of_the_union)\n",
+    "texts[0]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "13dc0983",
+   "metadata": {},
+   "source": [
+    "## HuggingFace Length Function\n",
+    "Most LLMs are constrained by the number of tokens that you can pass in, which is not the same as the number of characters. In order to get a more accurate estimate, we can use HuggingFace tokenizers to count the text length."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "a8ce51d5",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "None of PyTorch, TensorFlow >= 2.0, or Flax have been found. Models won't be available and only tokenizers, configuration and file/data utilities can be used.\n"
+     ]
+    }
+   ],
+   "source": [
+    "from transformers import GPT2TokenizerFast\n",
+    "\n",
+    "tokenizer = GPT2TokenizerFast.from_pretrained(\"gpt2\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "ca5e72c0",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "text_splitter = CharacterTextSplitter.from_huggingface_tokenizer(tokenizer, chunk_size=100, chunk_overlap=0)\n",
+    "texts = text_splitter.split_text(state_of_the_union)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "37cdfbeb",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans.  \n",
+      "\n",
+      "Last year COVID-19 kept us apart. This year we are finally together again. \n",
+      "\n",
+      "Tonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n",
+      "\n",
+      "With a duty to one another to the American people to the Constitution. \n",
+      "\n",
+      "And with an unwavering resolve that freedom will always triumph over tyranny. \n"
+     ]
+    }
+   ],
+   "source": [
+    "print(texts[0])"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "7683b36a",
+   "metadata": {},
+   "source": [
+    "## tiktoken (OpenAI) Length Function\n",
+    "You can also use tiktoken, a open source tokenizer package from OpenAI to estimate tokens used. Will probably be ore accurate for their models."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "825f7c0a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "text_splitter = CharacterTextSplitter.from_tiktoken_encoder(chunk_size=100, chunk_overlap=0)\n",
+    "texts = text_splitter.split_text(state_of_the_union)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "ae35d165",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans.  \n",
+      "\n",
+      "Last year COVID-19 kept us apart. This year we are finally together again. \n",
+      "\n",
+      "Tonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n",
+      "\n",
+      "With a duty to one another to the American people to the Constitution. \n",
+      "\n",
+      "And with an unwavering resolve that freedom will always triumph over tyranny. \n"
+     ]
+    }
+   ],
+   "source": [
+    "print(texts[0])"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ea2973ac",
+   "metadata": {},
+   "source": [
+    "## NLTK Text Splitter\n",
+    "Rather than just splitting on \"\\n\\n\", we can use NLTK to split based on tokenizers."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 14,
+   "id": "20fa9c23",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "text_splitter = NLTKTextSplitter(chunk_size=1000)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 16,
+   "id": "5ea10835",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Madam Speaker, Madam Vice President, our First Lady and Second Gentleman.\\n\\nMembers of Congress and the Cabinet.\\n\\nJustices of the Supreme Court.\\n\\nMy fellow Americans.\\n\\nLast year COVID-19 kept us apart.\\n\\nThis year we are finally together again.\\n\\nTonight, we meet as Democrats Republicans and Independents.\\n\\nBut most importantly as Americans.\\n\\nWith a duty to one another to the American people to the Constitution.\\n\\nAnd with an unwavering resolve that freedom will always triumph over tyranny.\\n\\nSix days ago, Russia’s Vladimir Putin sought to shake the foundations of the free world thinking he could make it bend to his menacing ways.\\n\\nBut he badly miscalculated.\\n\\nHe thought he could roll into Ukraine and the world would roll over.\\n\\nInstead he met a wall of strength he never imagined.\\n\\nHe met the Ukrainian people.\\n\\nFrom President Zelenskyy to every Ukrainian, their fearlessness, their courage, their determination, inspires the world.\\n\\nGroups of citizens blocking tanks with their bodies.\\n\\nEveryone from students to retirees teachers turned soldiers defending their homeland.'"
+      ]
+     },
+     "execution_count": 16,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "texts = text_splitter.split_text(state_of_the_union)\n",
+    "texts[0]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "dab86b60",
+   "metadata": {},
+   "source": [
+    "## Spacy Text Splitter\n",
+    "Another alternative to NLTK is to use Spacy."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 17,
+   "id": "f9cc9dfc",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "text_splitter = SpacyTextSplitter(chunk_size=1000)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 19,
+   "id": "cef2b29e",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Madam Speaker, Madam Vice President, our First Lady and Second Gentleman.\\n\\nMembers of Congress and the Cabinet.\\n\\nJustices of the Supreme Court.\\n\\nMy fellow Americans.  \\n\\n\\n\\nLast year COVID-19 kept us apart.\\n\\nThis year we are finally together again.\\n\\n\\n\\n\\n\\nTonight, we meet as Democrats Republicans and Independents.\\n\\nBut most importantly as Americans.\\n\\n\\n\\n\\n\\nWith a duty to one another to the American people to the Constitution. \\n\\n\\n\\nAnd with an unwavering resolve that freedom will always triumph over tyranny.\\n\\n\\n\\n\\n\\nSix days ago, Russia’s Vladimir Putin sought to shake the foundations of the free world thinking he could make it bend to his menacing ways.\\n\\nBut he badly miscalculated.\\n\\n\\n\\n\\n\\nHe thought he could roll into Ukraine and the world would roll over.\\n\\nInstead he met a wall of strength he never imagined.\\n\\n\\n\\n\\n\\nHe met the Ukrainian people.\\n\\n\\n\\n\\n\\nFrom President Zelenskyy to every Ukrainian, their fearlessness, their courage, their determination, inspires the world.\\n\\n\\n\\n\\n\\nGroups of citizens blocking tanks with their bodies.\\n\\nEveryone from students to retirees teachers turned soldiers defending their homeland.'"
+      ]
+     },
+     "execution_count": 19,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "texts = text_splitter.split_text(state_of_the_union)\n",
+    "texts[0]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a1a118b1",
+   "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.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/memory.rst

@@ -0,0 +1,11 @@
+Memory
+======
+
+The examples here are all related to working with the concept of Memory in LangChain.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+   :caption: Memory
+
+   memory/*

docs/examples/memory/adding_memory.ipynb

@@ -5,7 +5,7 @@
    "id": "00695447",
    "metadata": {},
    "source": [
-    "# How to add Memory to an LLMChain\n",
+    "# Adding Memory To an LLMChain\n",
     "\n",
     "This notebook goes over how to use the Memory class with an LLMChain. For the purposes of this walkthrough, we will add  the `ConversationBufferMemory` class, although this can be any memory class."
    ]
@@ -17,7 +17,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from langchain.memory import ConversationBufferMemory\n",
+    "from langchain.chains.conversation.memory import ConversationBufferMemory\n",
     "from langchain import OpenAI, LLMChain, PromptTemplate"
    ]
   },
@@ -76,7 +76,7 @@
      "text": [
       "\n",
       "\n",
-      "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
       "Prompt after formatting:\n",
       "\u001b[32;1m\u001b[1;3mYou are a chatbot having a conversation with a human.\n",
       "\n",
@@ -84,13 +84,13 @@
       "Human: Hi there my friend\n",
       "Chatbot:\u001b[0m\n",
       "\n",
-      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n"
+      "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "' Hi there, how are you doing today?'"
+       "' Hi there!'"
       ]
      },
      "execution_count": 4,
@@ -114,23 +114,23 @@
      "text": [
       "\n",
       "\n",
-      "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
       "Prompt after formatting:\n",
       "\u001b[32;1m\u001b[1;3mYou are a chatbot having a conversation with a human.\n",
       "\n",
       "\n",
       "Human: Hi there my friend\n",
-      "AI:  Hi there, how are you doing today?\n",
+      "AI:  Hi there!\n",
       "Human: Not to bad - how are you?\n",
       "Chatbot:\u001b[0m\n",
       "\n",
-      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n"
+      "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "\" I'm doing great, thank you for asking!\""
+       "\"\\n\\nI'm doing well, thanks for asking. How about you?\""
       ]
      },
      "execution_count": 5,
@@ -139,7 +139,7 @@
     }
    ],
    "source": [
-    "llm_chain.predict(human_input=\"Not too bad - how are you?\")"
+    "llm_chain.predict(human_input=\"Not to bad - how are you?\")"
    ]
   },
   {
@@ -167,7 +167,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.7.6"
   }
  },
  "nbformat": 4,

docs/examples/memory/agent_with_memory.ipynb

@@ -0,0 +1,325 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "fa6802ac",
+   "metadata": {},
+   "source": [
+    "# Adding Memory to an Agent\n",
+    "\n",
+    "This notebook goes over adding memory to an Agent. Before going through this notebook, please walkthrough the following notebooks, as this will build on top of both of them:\n",
+    "\n",
+    "- [Adding memory to an LLM Chain](adding_memory.ipynb)\n",
+    "- [Custom Agents](../agents/custom_agent.ipynb)\n",
+    "\n",
+    "In order to add a memory to an agent we are going to the the following steps:\n",
+    "\n",
+    "1. We are going to create an LLMChain with memory.\n",
+    "2. We are going to use that LLMChain to create a custom Agent.\n",
+    "\n",
+    "For the purposes of this exercise, we are going to create a simple custom Agent that has access to a search tool and utilizes the `ConversationBufferMemory` class."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "8db95912",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.agents import ZeroShotAgent, Tool\n",
+    "from langchain.chains.conversation.memory import ConversationBufferMemory\n",
+    "from langchain import OpenAI, SerpAPIWrapper, LLMChain"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "97ad8467",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "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",
+    "]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "4ad2e708",
+   "metadata": {},
+   "source": [
+    "Notice the usage of the `chat_history` variable in the PromptTemplate, which matches up with the dynamic key name in the ConversationBufferMemory."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "e3439cd6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "prefix = \"\"\"Have a conversation with a human, answering the following questions as best you can. You have access to the following tools:\"\"\"\n",
+    "suffix = \"\"\"Begin!\"\n",
+    "\n",
+    "{chat_history}\n",
+    "Question: {input}\"\"\"\n",
+    "\n",
+    "prompt = ZeroShotAgent.create_prompt(\n",
+    "    tools, \n",
+    "    prefix=prefix, \n",
+    "    suffix=suffix, \n",
+    "    input_variables=[\"input\", \"chat_history\"]\n",
+    ")\n",
+    "memory = ConversationBufferMemory(memory_key=\"chat_history\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0021675b",
+   "metadata": {},
+   "source": [
+    "We can now construct the LLMChain, with the Memory object, and then create the agent."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "c56a0e73",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "llm_chain = LLMChain(llm=OpenAI(temperature=0), prompt=prompt, memory=memory)\n",
+    "agent = ZeroShotAgent(llm_chain=llm_chain, tools=tools, verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "ca4bc1fb",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
+      "How many people live in canada?\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should look up how many people live in canada\n",
+      "Action: Search\n",
+      "Action Input: \"How many people live in canada?\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mThe current population of Canada is 38,533,678 as of Friday, November 25, 2022, based on Worldometer elaboration of the latest United Nations data. · Canada 2020 ...\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
+      "Final Answer: The current population of Canada is 38,533,678 as of Friday, November 25, 2022, based on Worldometer elaboration of the latest United Nations data.\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'The current population of Canada is 38,533,678 as of Friday, November 25, 2022, based on Worldometer elaboration of the latest United Nations data.'"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent.run(\"How many people live in canada?\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "45627664",
+   "metadata": {},
+   "source": [
+    "To test the memory of this agent, we can ask a followup question that relies on information in the previous exchange to be answered correctly."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "eecc0462",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
+      "what is their national anthem called?\n",
+      "Thought:\u001b[32;1m\u001b[1;3m\n",
+      "AI:  I should look up the name of Canada's national anthem\n",
+      "Action: Search\n",
+      "Action Input: \"What is the name of Canada's national anthem?\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mAfter 100 years of tradition, O Canada was proclaimed Canada's national anthem in 1980. The music for O Canada was composed in 1880 by Calixa ...\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m\n",
+      "AI:  I now know the final answer\n",
+      "Final Answer: After 100 years of tradition, O Canada was proclaimed Canada's national anthem in 1980. The music for O Canada was composed in 1880 by Calixa Lavallée.\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "\"After 100 years of tradition, O Canada was proclaimed Canada's national anthem in 1980. The music for O Canada was composed in 1880 by Calixa Lavallée.\""
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent.run(\"what is their national anthem called?\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "cc3d0aa4",
+   "metadata": {},
+   "source": [
+    "We can see that the agent remembered that the previous question was about Canada, and properly asked Google Search what the name of Canada's national anthem was.\n",
+    "\n",
+    "For fun, let's compare this to an agent that does NOT have memory."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "3359d043",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "prefix = \"\"\"Have a conversation with a human, answering the following questions as best you can. You have access to the following tools:\"\"\"\n",
+    "suffix = \"\"\"Begin!\"\n",
+    "\n",
+    "Question: {input}\"\"\"\n",
+    "\n",
+    "prompt = ZeroShotAgent.create_prompt(\n",
+    "    tools, \n",
+    "    prefix=prefix, \n",
+    "    suffix=suffix, \n",
+    "    input_variables=[\"input\"]\n",
+    ")\n",
+    "llm_chain = LLMChain(llm=OpenAI(temperature=0), prompt=prompt)\n",
+    "agent_without_memory = ZeroShotAgent(llm_chain=llm_chain, tools=tools, verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "970d23df",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
+      "How many people live in canada?\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should look up how many people live in canada\n",
+      "Action: Search\n",
+      "Action Input: \"How many people live in canada?\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mThe current population of Canada is 38,533,678 as of Friday, November 25, 2022, based on Worldometer elaboration of the latest United Nations data. · Canada 2020 ...\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
+      "Final Answer: The current population of Canada is 38,533,678\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'The current population of Canada is 38,533,678'"
+      ]
+     },
+     "execution_count": 10,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent_without_memory.run(\"How many people live in canada?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "d9ea82f0",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
+      "what is their national anthem called?\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I should probably look this up\n",
+      "Action: Search\n",
+      "Action Input: \"What is the national anthem of [country]\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mMost nation states have an anthem, defined as \"a song, as of praise, devotion, or patriotism\"; most anthems are either marches or hymns in style.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer\n",
+      "Final Answer: The national anthem is called \"the national anthem.\"\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'The national anthem is called \"the national anthem.\"'"
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent_without_memory.run(\"what is their national anthem called?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5b1f9223",
+   "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.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/memory/custom_memory.ipynb

@@ -5,7 +5,7 @@
    "id": "94e33ebe",
    "metadata": {},
    "source": [
-    "# How to create a custom Memory class\n",
+    "# Custom Memory\n",
     "Although there are a few predefined types of memory in LangChain, it is highly possible you will want to add your own type of memory that is optimal for your application. This notebook covers how to do that."
    ]
   },
@@ -25,7 +25,7 @@
    "outputs": [],
    "source": [
     "from langchain import OpenAI, ConversationChain\n",
-    "from langchain.schema import BaseMemory\n",
+    "from langchain.chains.base import Memory\n",
     "from pydantic import BaseModel\n",
     "from typing import List, Dict, Any"
    ]
@@ -44,8 +44,8 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
-   "id": "48a5dd13",
+   "execution_count": 2,
+   "id": "12bbed4e",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -55,7 +55,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 3,
    "id": "ff065f58",
    "metadata": {},
    "outputs": [],
@@ -66,21 +66,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 8,
    "id": "1d45d429",
    "metadata": {},
    "outputs": [],
    "source": [
-    "class SpacyEntityMemory(BaseMemory, BaseModel):\n",
+    "class SpacyEntityMemory(Memory, BaseModel):\n",
     "    \"\"\"Memory class for storing information about entities.\"\"\"\n",
     "\n",
     "    # Define dictionary to store information about entities.\n",
     "    entities: dict = {}\n",
     "    # Define key to pass information about entities into prompt.\n",
     "    memory_key: str = \"entities\"\n",
-    "        \n",
-    "    def clear(self):\n",
-    "        self.entities = {}\n",
     "\n",
     "    @property\n",
     "    def memory_variables(self) -> List[str]:\n",
@@ -120,7 +117,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 9,
    "id": "c05159b6",
    "metadata": {},
    "outputs": [],
@@ -150,7 +147,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 10,
    "id": "f08dc8ed",
    "metadata": {},
    "outputs": [],
@@ -169,7 +166,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 11,
    "id": "5b96e836",
    "metadata": {},
    "outputs": [
@@ -179,7 +176,7 @@
      "text": [
       "\n",
       "\n",
-      "\u001b[1m> Entering new ConversationChain chain...\u001b[0m\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
       "Prompt after formatting:\n",
       "\u001b[32;1m\u001b[1;3mThe following is a friendly conversation between a human and an AI. The AI is talkative and provides lots of specific details from its context. If the AI does not know the answer to a question, it truthfully says it does not know. You are provided with information about entities the Human mentions, if relevant.\n",
       "\n",
@@ -190,16 +187,16 @@
       "Human: Harrison likes machine learning\n",
       "AI:\u001b[0m\n",
       "\n",
-      "\u001b[1m> Finished ConversationChain chain.\u001b[0m\n"
+      "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "\" That's great to hear! Machine learning is a fascinating field of study. It involves using algorithms to analyze data and make predictions. Have you ever studied machine learning, Harrison?\""
+       "\"\\n\\nThat's really interesting! I'm sure he has a lot of fun with it.\""
       ]
      },
-     "execution_count": 12,
+     "execution_count": 11,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -218,7 +215,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 12,
    "id": "4bca7070",
    "metadata": {},
    "outputs": [
@@ -228,7 +225,7 @@
      "text": [
       "\n",
       "\n",
-      "\u001b[1m> Entering new ConversationChain chain...\u001b[0m\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
       "Prompt after formatting:\n",
       "\u001b[32;1m\u001b[1;3mThe following is a friendly conversation between a human and an AI. The AI is talkative and provides lots of specific details from its context. If the AI does not know the answer to a question, it truthfully says it does not know. You are provided with information about entities the Human mentions, if relevant.\n",
       "\n",
@@ -239,16 +236,16 @@
       "Human: What do you think Harrison's favorite subject in college was?\n",
       "AI:\u001b[0m\n",
       "\n",
-      "\u001b[1m> Finished ConversationChain chain.\u001b[0m\n"
+      "\u001b[1m> Finished chain.\u001b[0m\n"
      ]
     },
     {
      "data": {
       "text/plain": [
-       "' From what I know about Harrison, I believe his favorite subject in college was machine learning. He has expressed a strong interest in the subject and has mentioned it often.'"
+       "\" Harrison's favorite subject in college was machine learning.\""
       ]
      },
-     "execution_count": 13,
+     "execution_count": 12,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -290,7 +287,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.7.6"
   }
  },
  "nbformat": 4,

docs/examples/model_laboratory.ipynb

@@ -5,11 +5,9 @@
    "id": "920a3c1a",
    "metadata": {},
    "source": [
-    "# Model Comparison\n",
+    "# Model Laboratory\n",
     "\n",
-    "Constructing your language model application will likely involved choosing between many different options of prompts, models, and even chains to use. When doing so, you will want to compare these different options on different inputs in an easy, flexible, and intuitive way. \n",
-    "\n",
-    "LangChain provides the concept of a ModelLaboratory to test out and try different models."
+    "This example goes over basic functionality of how to use the ModelLaboratory to test out and try different models."
    ]
   },
   {
@@ -248,7 +246,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.8.7"
   }
  },
  "nbformat": 4,

docs/examples/prompts.rst

@@ -0,0 +1,35 @@
+LLMs & Prompts
+==============
+
+The examples here all highlight how to work with LLMs and prompts.
+
+**LLMs**
+
+`LLM Functionality <prompts/llm_functionality.ipynb>`_: A walkthrough of all the functionality the standard LLM interface exposes.
+
+`LLM Serialization <prompts/llm_serialization.ipynb>`_: A walkthrough of how to serialize LLMs to and from disk.
+
+`Custom LLM <prompts/custom_llm.ipynb>`_: How to create and use a custom LLM class, in case you have an LLM not from one of the standard providers (including one that you host yourself).
+
+
+**Prompts**
+
+`Prompt Management <prompts/prompt_management.ipynb>`_: A walkthrough of all the functionality LangChain supports for working with prompts.
+
+`Prompt Serialization <prompts/prompt_serialization.ipynb>`_: A walkthrough of how to serialize prompts to and from disk.
+
+`Few Shot Examples <prompts/few_shot_examples.ipynb>`_: How to include examples in the prompt.
+
+`Generate Examples <prompts/generate_examples.ipynb>`_: How to use existing examples to generate more examples.
+
+`Custom Example Selector <prompts/custom_example_selector.ipynb>`_: How to create and use a custom ExampleSelector (the class responsible for choosing which examples to use in a prompt).
+
+`Custom Prompt Template <prompts/custom_prompt_template.ipynb>`_: How to create and use a custom PromptTemplate, the logic that decides how input variables get formatted into a prompt.
+
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+   :hidden:
+
+   prompts/*

docs/examples/prompts/custom_example_selector.ipynb

@@ -0,0 +1,176 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "f897c784",
+   "metadata": {},
+   "source": [
+    "# Custom ExampleSelector\n",
+    "\n",
+    "This notebook goes over how to implement a custom ExampleSelector. ExampleSelectors are used to select examples to use in few shot prompts.\n",
+    "\n",
+    "An ExampleSelector must implement two methods:\n",
+    "\n",
+    "1. An `add_example` method which takes in an example and adds it into the ExampleSelector\n",
+    "2. A `select_examples` method which takes in input variables (which are meant to be user input) and returns a list of examples to use in the few shot prompt.\n",
+    "\n",
+    "\n",
+    "Let's implement a custom ExampleSelector that just selects two examples at random."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "1a945da1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.prompts.example_selector.base import BaseExampleSelector\n",
+    "from typing import Dict, List\n",
+    "import numpy as np"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "62cf0ad7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "class CustomExampleSelector(BaseExampleSelector):\n",
+    "    \n",
+    "    def __init__(self, examples: List[Dict[str, str]]):\n",
+    "        self.examples = examples\n",
+    "    \n",
+    "    def add_example(self, example: Dict[str, str]) -> None:\n",
+    "        \"\"\"Add new example to store for a key.\"\"\"\n",
+    "        self.examples.append(example)\n",
+    "\n",
+    "    def select_examples(self, input_variables: Dict[str, str]) -> List[dict]:\n",
+    "        \"\"\"Select which examples to use based on the inputs.\"\"\"\n",
+    "        return np.random.choice(self.examples, size=2, replace=False)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "242d3213",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "examples = [{\"foo\": \"1\"}, {\"foo\": \"2\"}, {\"foo\": \"3\"}]\n",
+    "example_selector = CustomExampleSelector(examples)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "2a038065",
+   "metadata": {},
+   "source": [
+    "Let's now try it out! We can select some examples and try adding examples."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "74fbbef5",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "array([{'foo': '2'}, {'foo': '3'}], dtype=object)"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "example_selector.select_examples({\"foo\": \"foo\"})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "9bbb5421",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "example_selector.add_example({\"foo\": \"4\"})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "c0eb9f22",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[{'foo': '1'}, {'foo': '2'}, {'foo': '3'}, {'foo': '4'}]"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "example_selector.examples"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "cc39b1e3",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "array([{'foo': '1'}, {'foo': '4'}], dtype=object)"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "example_selector.select_examples({\"foo\": \"foo\"})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1739dd96",
+   "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.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/prompts/custom_llm.ipynb

@@ -5,7 +5,7 @@
    "id": "9e9b7651",
    "metadata": {},
    "source": [
-    "# How to write a custom LLM wrapper\n",
+    "# Custom LLM\n",
     "\n",
     "This notebook goes over how to create a custom LLM wrapper, in case you want to use your own LLM or a different wrapper than one that is supported in LangChain.\n",
     "\n",
@@ -22,15 +22,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 1,
    "id": "a65696a0",
    "metadata": {},
    "outputs": [],
    "source": [
-    "from typing import Any, List, Mapping, Optional\n",
-    "\n",
-    "from langchain.callbacks.manager import CallbackManagerForLLMRun\n",
-    "from langchain.llms.base import LLM"
+    "from langchain.llms.base import LLM\n",
+    "from typing import Optional, List, Mapping, Any"
    ]
   },
   {
@@ -48,12 +46,7 @@
     "    def _llm_type(self) -> str:\n",
     "        return \"custom\"\n",
     "    \n",
-    "    def _call(\n",
-    "        self,\n",
-    "        prompt: str,\n",
-    "        stop: Optional[List[str]] = None,\n",
-    "        run_manager: Optional[CallbackManagerForLLMRun] = None,\n",
-    "    ) -> str:\n",
+    "    def _call(self, prompt: str, stop: Optional[List[str]] = None) -> str:\n",
     "        if stop is not None:\n",
     "            raise ValueError(\"stop kwargs are not permitted.\")\n",
     "        return prompt[:self.n]\n",
@@ -155,7 +148,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

docs/examples/prompts/custom_prompt_template.ipynb

@@ -0,0 +1,116 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "a37d9694",
+   "metadata": {},
+   "source": [
+    "# Custom Prompt Template\n",
+    "\n",
+    "This notebook goes over how to create a custom prompt template, in case you want to create your own methodology for creating prompts.\n",
+    "\n",
+    "The only two requirements for all prompt templates are:\n",
+    "\n",
+    "1. They have a `input_variables` attribute that exposes what input variables this prompt template expects.\n",
+    "2. They expose a `format` method which takes in keyword arguments corresponding to the expected `input_variables` and returns the formatted prompt.\n",
+    "\n",
+    "Let's imagine that we want to create a prompt template that takes in input variables and formats them into the template AFTER capitalizing them. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "26f796e5",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.prompts import BasePromptTemplate\n",
+    "from pydantic import BaseModel"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "27919e96",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "class CustomPromptTemplate(BasePromptTemplate, BaseModel):\n",
+    "    template: str\n",
+    "        \n",
+    "    def format(self, **kwargs) -> str:\n",
+    "        capitalized_kwargs = {k: v.upper() for k, v in kwargs.items()}\n",
+    "        return self.template.format(**capitalized_kwargs)\n",
+    "        "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "76d1d84d",
+   "metadata": {},
+   "source": [
+    "We can now see that when we use this, the input variables get formatted."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "eed1ff28",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "prompt = CustomPromptTemplate(input_variables=[\"foo\"], template=\"Capitalized: {foo}\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "94892a3c",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Capitalized: LOWERCASE'"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "prompt.format(foo=\"lowercase\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "d3d9a7c7",
+   "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.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/prompts/example_prompt.json

@@ -1,5 +1,4 @@
 {
-    "_type": "prompt",
     "input_variables": ["input", "output"],
     "template": "Input: {input}\nOutput: {output}" 
 }

docs/examples/prompts/few_shot_examples.ipynb

@@ -0,0 +1,306 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "f8b01b97",
+   "metadata": {},
+   "source": [
+    "# Few Shot Prompt examples\n",
+    "Notebook showing off how canonical prompts in LangChain can be recreated as FewShotPrompts"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "18c67cc9",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.prompts.few_shot import FewShotPromptTemplate\n",
+    "from langchain.prompts.prompt import PromptTemplate"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "2a729c9f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Self Ask with Search\n",
+    "\n",
+    "examples = [\n",
+    "  {\n",
+    "    \"question\": \"Who lived longer, Muhammad Ali or Alan Turing?\",\n",
+    "    \"answer\": \"Are follow up questions needed here: Yes.\\nFollow up: How old was Muhammad Ali when he died?\\nIntermediate answer: Muhammad Ali was 74 years old when he died.\\nFollow up: How old was Alan Turing when he died?\\nIntermediate answer: Alan Turing was 41 years old when he died.\\nSo the final answer is: Muhammad Ali\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"When was the founder of craigslist born?\",\n",
+    "    \"answer\": \"Are follow up questions needed here: Yes.\\nFollow up: Who was the founder of craigslist?\\nIntermediate answer: Craigslist was founded by Craig Newmark.\\nFollow up: When was Craig Newmark born?\\nIntermediate answer: Craig Newmark was born on December 6, 1952.\\nSo the final answer is: December 6, 1952\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"Who was the maternal grandfather of George Washington?\",\n",
+    "    \"answer\": \"Are follow up questions needed here: Yes.\\nFollow up: Who was the mother of George Washington?\\nIntermediate answer: The mother of George Washington was Mary Ball Washington.\\nFollow up: Who was the father of Mary Ball Washington?\\nIntermediate answer: The father of Mary Ball Washington was Joseph Ball.\\nSo the final answer is: Joseph Ball\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"Are both the directors of Jaws and Casino Royale from the same country?\",\n",
+    "    \"answer\": \"Are follow up questions needed here: Yes.\\nFollow up: Who is the director of Jaws?\\nIntermediate Answer: The director of Jaws is Steven Spielberg.\\nFollow up: Where is Steven Spielberg from?\\nIntermediate Answer: The United States.\\nFollow up: Who is the director of Casino Royale?\\nIntermediate Answer: The director of Casino Royale is Martin Campbell.\\nFollow up: Where is Martin Campbell from?\\nIntermediate Answer: New Zealand.\\nSo the final answer is: No\"\n",
+    "  }\n",
+    "]\n",
+    "example_prompt = PromptTemplate(input_variables=[\"question\", \"answer\"], template=\"Question: {question}\\n{answer}\")\n",
+    "\n",
+    "prompt = FewShotPromptTemplate(\n",
+    "    examples=examples, \n",
+    "    example_prompt=example_prompt, \n",
+    "    suffix=\"Question: {input}\", \n",
+    "    input_variables=[\"input\"]\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "95fc0059",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# ReAct\n",
+    "\n",
+    "examples = [\n",
+    "  {\n",
+    "    \"question\": \"What is the elevation range for the area that the eastern sector of the Colorado orogeny extends into?\",\n",
+    "    \"answer\": \"Thought 1: I need to search Colorado orogeny, find the area that the eastern sector of the Colorado orogeny extends into, then find the elevation range of that area.\\nAction 1: Search[Colorado orogeny]\\nObservation 1: The Colorado orogeny was an episode of mountain building (an orogeny) in Colorado and surrounding areas.\\nThought 2: It does not mention the eastern sector. So I need to look up eastern sector.\\nAction 2: Lookup[eastern sector]\\nObservation 2: (Result 1 / 1) The eastern sector extends into the High Plains and is called the Central Plains orogeny.\\nThought 3: The eastern sector of Colorado orogeny extends into the High Plains. So I need to search High Plains and find its elevation range.\\nAction 3: Search[High Plains]\\nObservation 3: High Plains refers to one of two distinct land regions\\nThought 4: I need to instead search High Plains (United States).\\nAction 4: Search[High Plains (United States)]\\nObservation 4: The High Plains are a subregion of the Great Plains. From east to west, the High Plains rise in elevation from around 1,800 to 7,000 ft (550 to 2,130 m).[3]\\nThought 5: High Plains rise in elevation from around 1,800 to 7,000 ft, so the answer is 1,800 to 7,000 ft.\\nAction 5: Finish[1,800 to 7,000 ft]\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"Musician and satirist Allie Goertz wrote a song about the \\\"The Simpsons\\\" character Milhouse, who Matt Groening named after who?\",\n",
+    "    \"answer\": \"Thought 1: The question simplifies to \\\"The Simpsons\\\" character Milhouse is named after who. I only need to search Milhouse and find who it is named after.\\nAction 1: Search[Milhouse]\\nObservation 1: Milhouse Mussolini Van Houten is a recurring character in the Fox animated television series The Simpsons voiced by Pamela Hayden and created by Matt Groening.\\nThought 2: The paragraph does not tell who Milhouse is named after, maybe I can look up \\\"named after\\\".\\nAction 2: Lookup[named after]\\nObservation 2: (Result 1 / 1) Milhouse was named after U.S. president Richard Nixon, whose middle name was Milhous.\\nThought 3: Milhouse was named after U.S. president Richard Nixon, so the answer is Richard Nixon.\\nAction 3: Finish[Richard Nixon]\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"Which documentary is about Finnish rock groups, Adam Clayton Powell or The Saimaa Gesture?\",\n",
+    "    \"answer\": \"Thought 1: I need to search Adam Clayton Powell and The Saimaa Gesture, and find which documentary is about Finnish rock groups.\\nAction 1: Search[Adam Clayton Powell]\\nObservation 1 Could not find [Adam Clayton Powell]. Similar: [’Adam Clayton Powell III’, ’Seventh Avenue (Manhattan)’, ’Adam Clayton Powell Jr. State Office Building’, ’Isabel Washington Powell’, ’Adam Powell’, ’Adam Clayton Powell (film)’, ’Giancarlo Esposito’].\\nThought 2: To find the documentary, I can search Adam Clayton Powell (film).\\nAction 2: Search[Adam Clayton Powell (film)]\\nObservation 2: Adam Clayton Powell is a 1989 American documentary film directed by Richard Kilberg. The film is about the rise and fall of influential African-American politician Adam Clayton Powell Jr.[3][4] It was later aired as part of the PBS series The American Experience.\\nThought 3: Adam Clayton Powell (film) is a documentary about an African-American politician, not Finnish rock groups. So the documentary about Finnish rock groups must instead be The Saimaa Gesture.\\nAction 3: Finish[The Saimaa Gesture]\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"What profession does Nicholas Ray and Elia Kazan have in common?\",\n",
+    "    \"answer\": \"Thought 1: I need to search Nicholas Ray and Elia Kazan, find their professions, then find the profession they have in common.\\nAction 1: Search[Nicholas Ray]\\nObservation 1: Nicholas Ray (born Raymond Nicholas Kienzle Jr., August 7, 1911 - June 16, 1979) was an American film director, screenwriter, and actor best known for the 1955 film Rebel Without a Cause.\\nThought 2: Professions of Nicholas Ray are director, screenwriter, and actor. I need to search Elia Kazan next and find his professions.\\nAction 2: Search[Elia Kazan]\\nObservation 2: Elia Kazan was an American film and theatre director, producer, screenwriter and actor.\\nThought 3: Professions of Elia Kazan are director, producer, screenwriter, and actor. So profession Nicholas Ray and Elia Kazan have in common is director, screenwriter, and actor.\\nAction 3: Finish[director, screenwriter, actor]\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"Which magazine was started first Arthur’s Magazine or First for Women?\",\n",
+    "    \"answer\": \"Thought 1: I need to search Arthur’s Magazine and First for Women, and find which was started first.\\nAction 1: Search[Arthur’s Magazine]\\nObservation 1: Arthur’s Magazine (1844-1846) was an American literary periodical published in Philadelphia in the 19th century.\\nThought 2: Arthur’s Magazine was started in 1844. I need to search First for Women next.\\nAction 2: Search[First for Women]\\nObservation 2: First for Women is a woman’s magazine published by Bauer Media Group in the USA.[1] The magazine was started in 1989.\\nThought 3: First for Women was started in 1989. 1844 (Arthur’s Magazine) < 1989 (First for Women), so Arthur’s Magazine was started first.\\nAction 3: Finish[Arthur’s Magazine]\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"Were Pavel Urysohn and Leonid Levin known for the same type of work?\",\n",
+    "    \"answer\": \"Thought 1: I need to search Pavel Urysohn and Leonid Levin, find their types of work, then find if they are the same.\\nAction 1: Search[Pavel Urysohn]\\nObservation 1: Pavel Samuilovich Urysohn (February 3, 1898 - August 17, 1924) was a Soviet mathematician who is best known for his contributions in dimension theory.\\nThought 2: Pavel Urysohn is a mathematician. I need to search Leonid Levin next and find its type of work.\\nAction 2: Search[Leonid Levin]\\nObservation 2: Leonid Anatolievich Levin is a Soviet-American mathematician and computer scientist.\\nThought 3: Leonid Levin is a mathematician and computer scientist. So Pavel Urysohn and Leonid Levin have the same type of work.\\nAction 3: Finish[yes]\"\n",
+    "  }\n",
+    "]\n",
+    "example_prompt = PromptTemplate(input_variables=[\"question\", \"answer\"], template=\"Question: {question}\\n{answer}\")\n",
+    "\n",
+    "prompt = FewShotPromptTemplate(\n",
+    "    examples=examples, \n",
+    "    example_prompt=example_prompt, \n",
+    "    suffix=\"Question: {input}\", \n",
+    "    input_variables=[\"input\"]\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "897d4e08",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# LLM Math\n",
+    "examples = [\n",
+    "  {\n",
+    "    \"question\": \"What is 37593 * 67?\",\n",
+    "    \"answer\": \"```python\\nprint(37593 * 67)\\n```\\n```output\\n2518731\\n```\\nAnswer: 2518731\"\n",
+    "  }\n",
+    "]\n",
+    "example_prompt = PromptTemplate(input_variables=[\"question\", \"answer\"], template=\"Question: {question}\\n\\n{answer}\")\n",
+    "\n",
+    "prompt = FewShotPromptTemplate(\n",
+    "    examples=examples, \n",
+    "    example_prompt=example_prompt, \n",
+    "    suffix=\"Question: {input}\", \n",
+    "    input_variables=[\"input\"]\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "7ab7379f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# NatBot\n",
+    "example_seperator = \"==================================================\"\n",
+    "content_1 = \"\"\"<link id=1>About</link>\n",
+    "<link id=2>Store</link>\n",
+    "<link id=3>Gmail</link>\n",
+    "<link id=4>Images</link>\n",
+    "<link id=5>(Google apps)</link>\n",
+    "<link id=6>Sign in</link>\n",
+    "<img id=7 alt=\"(Google)\"/>\n",
+    "<input id=8 alt=\"Search\"></input>\n",
+    "<button id=9>(Search by voice)</button>\n",
+    "<button id=10>(Google Search)</button>\n",
+    "<button id=11>(I'm Feeling Lucky)</button>\n",
+    "<link id=12>Advertising</link>\n",
+    "<link id=13>Business</link>\n",
+    "<link id=14>How Search works</link>\n",
+    "<link id=15>Carbon neutral since 2007</link>\n",
+    "<link id=16>Privacy</link>\n",
+    "<link id=17>Terms</link>\n",
+    "<text id=18>Settings</text>\"\"\"\n",
+    "content_2 = \"\"\"<link id=1>About</link>\n",
+    "<link id=2>Store</link>\n",
+    "<link id=3>Gmail</link>\n",
+    "<link id=4>Images</link>\n",
+    "<link id=5>(Google apps)</link>\n",
+    "<link id=6>Sign in</link>\n",
+    "<img id=7 alt=\"(Google)\"/>\n",
+    "<input id=8 alt=\"Search\"></input>\n",
+    "<button id=9>(Search by voice)</button>\n",
+    "<button id=10>(Google Search)</button>\n",
+    "<button id=11>(I'm Feeling Lucky)</button>\n",
+    "<link id=12>Advertising</link>\n",
+    "<link id=13>Business</link>\n",
+    "<link id=14>How Search works</link>\n",
+    "<link id=15>Carbon neutral since 2007</link>\n",
+    "<link id=16>Privacy</link>\n",
+    "<link id=17>Terms</link>\n",
+    "<text id=18>Settings</text>\"\"\"\n",
+    "content_3 = \"\"\"<button id=1>For Businesses</button>\n",
+    "<button id=2>Mobile</button>\n",
+    "<button id=3>Help</button>\n",
+    "<button id=4 alt=\"Language Picker\">EN</button>\n",
+    "<link id=5>OpenTable logo</link>\n",
+    "<button id=6 alt =\"search\">Search</button>\n",
+    "<text id=7>Find your table for any occasion</text>\n",
+    "<button id=8>(Date selector)</button>\n",
+    "<text id=9>Sep 28, 2022</text>\n",
+    "<text id=10>7:00 PM</text>\n",
+    "<text id=11>2 people</text>\n",
+    "<input id=12 alt=\"Location, Restaurant, or Cuisine\"></input>\n",
+    "<button id=13>Let’s go</button>\n",
+    "<text id=14>It looks like you're in Peninsula. Not correct?</text>\n",
+    "<button id=15>Get current location</button>\n",
+    "<button id=16>Next</button>\"\"\"\n",
+    "examples = [\n",
+    "    {\n",
+    "        \"i\": 1,\n",
+    "        \"content\": content_1,\n",
+    "        \"objective\": \"Find a 2 bedroom house for sale in Anchorage AK for under $750k\",\n",
+    "        \"current_url\": \"https://www.google.com/\",\n",
+    "        \"command\": 'TYPESUBMIT 8 \"anchorage redfin\"'\n",
+    "    },\n",
+    "    {\n",
+    "        \"i\": 2,\n",
+    "        \"content\": content_2,\n",
+    "        \"objective\": \"Make a reservation for 4 at Dorsia at 8pm\",\n",
+    "        \"current_url\": \"https://www.google.com/\",\n",
+    "        \"command\": 'TYPESUBMIT 8 \"dorsia nyc opentable\"'\n",
+    "    },\n",
+    "    {\n",
+    "        \"i\": 3,\n",
+    "        \"content\": content_3,\n",
+    "        \"objective\": \"Make a reservation for 4 for dinner at Dorsia in New York City at 8pm\",\n",
+    "        \"current_url\": \"https://www.opentable.com/\",\n",
+    "        \"command\": 'TYPESUBMIT 12 \"dorsia new york city\"'\n",
+    "    },\n",
+    "]\n",
+    "example_prompt_template=\"\"\"EXAMPLE {i}:\n",
+    "==================================================\n",
+    "CURRENT BROWSER CONTENT:\n",
+    "------------------\n",
+    "{content}\n",
+    "------------------\n",
+    "OBJECTIVE: {objective}\n",
+    "CURRENT URL: {current_url}\n",
+    "YOUR COMMAND:\n",
+    "{command}\"\"\"\n",
+    "example_prompt = PromptTemplate(input_variables=[\"i\", \"content\", \"objective\", \"current_url\", \"command\"], template=example_prompt_template)\n",
+    "\n",
+    "\n",
+    "prefix = \"\"\"\n",
+    "You are an agent controlling a browser. You are given:\n",
+    "\t(1) an objective that you are trying to achieve\n",
+    "\t(2) the URL of your current web page\n",
+    "\t(3) a simplified text description of what's visible in the browser window (more on that below)\n",
+    "You can issue these commands:\n",
+    "\tSCROLL UP - scroll up one page\n",
+    "\tSCROLL DOWN - scroll down one page\n",
+    "\tCLICK X - click on a given element. You can only click on links, buttons, and inputs!\n",
+    "\tTYPE X \"TEXT\" - type the specified text into the input with id X\n",
+    "\tTYPESUBMIT X \"TEXT\" - same as TYPE above, except then it presses ENTER to submit the form\n",
+    "The format of the browser content is highly simplified; all formatting elements are stripped.\n",
+    "Interactive elements such as links, inputs, buttons are represented like this:\n",
+    "\t\t<link id=1>text</link>\n",
+    "\t\t<button id=2>text</button>\n",
+    "\t\t<input id=3>text</input>\n",
+    "Images are rendered as their alt text like this:\n",
+    "\t\t<img id=4 alt=\"\"/>\n",
+    "Based on your given objective, issue whatever command you believe will get you closest to achieving your goal.\n",
+    "You always start on Google; you should submit a search query to Google that will take you to the best page for\n",
+    "achieving your objective. And then interact with that page to achieve your objective.\n",
+    "If you find yourself on Google and there are no search results displayed yet, you should probably issue a command\n",
+    "like \"TYPESUBMIT 7 \"search query\"\" to get to a more useful page.\n",
+    "Then, if you find yourself on a Google search results page, you might issue the command \"CLICK 24\" to click\n",
+    "on the first link in the search results. (If your previous command was a TYPESUBMIT your next command should\n",
+    "probably be a CLICK.)\n",
+    "Don't try to interact with elements that you can't see.\n",
+    "Here are some examples:\n",
+    "\"\"\"\n",
+    "suffix=\"\"\"\n",
+    "The current browser content, objective, and current URL follow. Reply with your next command to the browser.\n",
+    "CURRENT BROWSER CONTENT:\n",
+    "------------------\n",
+    "{browser_content}\n",
+    "------------------\n",
+    "OBJECTIVE: {objective}\n",
+    "CURRENT URL: {url}\n",
+    "PREVIOUS COMMAND: {previous_command}\n",
+    "YOUR COMMAND:\n",
+    "\"\"\"\n",
+    "PROMPT = FewShotPromptTemplate(\n",
+    "    examples = examples,\n",
+    "    example_prompt=example_prompt,\n",
+    "    example_separator=example_seperator,\n",
+    "    input_variables=[\"browser_content\", \"url\", \"previous_command\", \"objective\"],\n",
+    "    prefix=prefix,\n",
+    "    suffix=suffix,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ce5927c6",
+   "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.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/prompts/few_shot_prompt.json

@@ -3,7 +3,6 @@
     "input_variables": ["adjective"],
     "prefix": "Write antonyms for the following words.",
     "example_prompt": {
-        "_type": "prompt",
         "input_variables": ["input", "output"],
         "template": "Input: {input}\nOutput: {output}"
     },

docs/examples/prompts/few_shot_prompt.yaml

@@ -4,7 +4,6 @@ input_variables:
 prefix: 
     Write antonyms for the following words.
 example_prompt:
-    _type: prompt
     input_variables:
         ["input", "output"]
     template:

docs/examples/prompts/few_shot_prompt_examples_in.json

@@ -3,7 +3,6 @@
     "input_variables": ["adjective"],
     "prefix": "Write antonyms for the following words.",
     "example_prompt": {
-        "_type": "prompt",
         "input_variables": ["input", "output"],
         "template": "Input: {input}\nOutput: {output}"
     },

docs/examples/prompts/generate_examples.ipynb

@@ -0,0 +1,161 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "f5d249ee",
+   "metadata": {
+    "pycharm": {
+     "name": "#%% md\n"
+    }
+   },
+   "source": [
+    "# Generate Examples\n",
+    "\n",
+    "This notebook shows how to use LangChain to generate more examples similar to the ones you already have."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "1685fa2f",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.llms.openai import OpenAI\n",
+    "from langchain.example_generator import generate_example\n",
+    "from langchain.prompts import PromptTemplate"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "334ef4f7",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "# Use examples from ReAct\n",
+    "examples = [\n",
+    "  {\n",
+    "    \"question\": \"What is the elevation range for the area that the eastern sector of the Colorado orogeny extends into?\",\n",
+    "    \"answer\": \"Thought 1: I need to search Colorado orogeny, find the area that the eastern sector of the Colorado orogeny extends into, then find the elevation range of that area.\\nAction 1: Search[Colorado orogeny]\\nObservation 1: The Colorado orogeny was an episode of mountain building (an orogeny) in Colorado and surrounding areas.\\nThought 2: It does not mention the eastern sector. So I need to look up eastern sector.\\nAction 2: Lookup[eastern sector]\\nObservation 2: (Result 1 / 1) The eastern sector extends into the High Plains and is called the Central Plains orogeny.\\nThought 3: The eastern sector of Colorado orogeny extends into the High Plains. So I need to search High Plains and find its elevation range.\\nAction 3: Search[High Plains]\\nObservation 3: High Plains refers to one of two distinct land regions\\nThought 4: I need to instead search High Plains (United States).\\nAction 4: Search[High Plains (United States)]\\nObservation 4: The High Plains are a subregion of the Great Plains. From east to west, the High Plains rise in elevation from around 1,800 to 7,000 ft (550 to 2,130 m).[3]\\nThought 5: High Plains rise in elevation from around 1,800 to 7,000 ft, so the answer is 1,800 to 7,000 ft.\\nAction 5: Finish[1,800 to 7,000 ft]\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"Musician and satirist Allie Goertz wrote a song about the \\\"The Simpsons\\\" character Milhouse, who Matt Groening named after who?\",\n",
+    "    \"answer\": \"Thought 1: The question simplifies to \\\"The Simpsons\\\" character Milhouse is named after who. I only need to search Milhouse and find who it is named after.\\nAction 1: Search[Milhouse]\\nObservation 1: Milhouse Mussolini Van Houten is a recurring character in the Fox animated television series The Simpsons voiced by Pamela Hayden and created by Matt Groening.\\nThought 2: The paragraph does not tell who Milhouse is named after, maybe I can look up \\\"named after\\\".\\nAction 2: Lookup[named after]\\nObservation 2: (Result 1 / 1) Milhouse was named after U.S. president Richard Nixon, whose middle name was Milhous.\\nThought 3: Milhouse was named after U.S. president Richard Nixon, so the answer is Richard Nixon.\\nAction 3: Finish[Richard Nixon]\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"Which documentary is about Finnish rock groups, Adam Clayton Powell or The Saimaa Gesture?\",\n",
+    "    \"answer\": \"Thought 1: I need to search Adam Clayton Powell and The Saimaa Gesture, and find which documentary is about Finnish rock groups.\\nAction 1: Search[Adam Clayton Powell]\\nObservation 1 Could not find [Adam Clayton Powell]. Similar: [’Adam Clayton Powell III’, ’Seventh Avenue (Manhattan)’, ’Adam Clayton Powell Jr. State Office Building’, ’Isabel Washington Powell’, ’Adam Powell’, ’Adam Clayton Powell (film)’, ’Giancarlo Esposito’].\\nThought 2: To find the documentary, I can search Adam Clayton Powell (film).\\nAction 2: Search[Adam Clayton Powell (film)]\\nObservation 2: Adam Clayton Powell is a 1989 American documentary film directed by Richard Kilberg. The film is about the rise and fall of influential African-American politician Adam Clayton Powell Jr.[3][4] It was later aired as part of the PBS series The American Experience.\\nThought 3: Adam Clayton Powell (film) is a documentary about an African-American politician, not Finnish rock groups. So the documentary about Finnish rock groups must instead be The Saimaa Gesture.\\nAction 3: Finish[The Saimaa Gesture]\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"What profession does Nicholas Ray and Elia Kazan have in common?\",\n",
+    "    \"answer\": \"Thought 1: I need to search Nicholas Ray and Elia Kazan, find their professions, then find the profession they have in common.\\nAction 1: Search[Nicholas Ray]\\nObservation 1: Nicholas Ray (born Raymond Nicholas Kienzle Jr., August 7, 1911 - June 16, 1979) was an American film director, screenwriter, and actor best known for the 1955 film Rebel Without a Cause.\\nThought 2: Professions of Nicholas Ray are director, screenwriter, and actor. I need to search Elia Kazan next and find his professions.\\nAction 2: Search[Elia Kazan]\\nObservation 2: Elia Kazan was an American film and theatre director, producer, screenwriter and actor.\\nThought 3: Professions of Elia Kazan are director, producer, screenwriter, and actor. So profession Nicholas Ray and Elia Kazan have in common is director, screenwriter, and actor.\\nAction 3: Finish[director, screenwriter, actor]\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"Which magazine was started first Arthur’s Magazine or First for Women?\",\n",
+    "    \"answer\": \"Thought 1: I need to search Arthur’s Magazine and First for Women, and find which was started first.\\nAction 1: Search[Arthur’s Magazine]\\nObservation 1: Arthur’s Magazine (1844-1846) was an American literary periodical published in Philadelphia in the 19th century.\\nThought 2: Arthur’s Magazine was started in 1844. I need to search First for Women next.\\nAction 2: Search[First for Women]\\nObservation 2: First for Women is a woman’s magazine published by Bauer Media Group in the USA.[1] The magazine was started in 1989.\\nThought 3: First for Women was started in 1989. 1844 (Arthur’s Magazine) < 1989 (First for Women), so Arthur’s Magazine was started first.\\nAction 3: Finish[Arthur’s Magazine]\"\n",
+    "  },\n",
+    "  {\n",
+    "    \"question\": \"Were Pavel Urysohn and Leonid Levin known for the same type of work?\",\n",
+    "    \"answer\": \"Thought 1: I need to search Pavel Urysohn and Leonid Levin, find their types of work, then find if they are the same.\\nAction 1: Search[Pavel Urysohn]\\nObservation 1: Pavel Samuilovich Urysohn (February 3, 1898 - August 17, 1924) was a Soviet mathematician who is best known for his contributions in dimension theory.\\nThought 2: Pavel Urysohn is a mathematician. I need to search Leonid Levin next and find its type of work.\\nAction 2: Search[Leonid Levin]\\nObservation 2: Leonid Anatolievich Levin is a Soviet-American mathematician and computer scientist.\\nThought 3: Leonid Levin is a mathematician and computer scientist. So Pavel Urysohn and Leonid Levin have the same type of work.\\nAction 3: Finish[yes]\"\n",
+    "  }\n",
+    "]\n",
+    "example_template = PromptTemplate(template=\"Question: {question}\\n{answer}\", input_variables=[\"question\", \"answer\"])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "a7bd36bc",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "new_example = generate_example(examples, OpenAI(), example_template)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "e1efb008",
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['',\n",
+       " '',\n",
+       " 'Question: What is the highest mountain peak in North America?',\n",
+       " '',\n",
+       " 'Thought 1: I need to search North America and find the highest mountain peak.',\n",
+       " '',\n",
+       " 'Action 1: Search[North America]',\n",
+       " '',\n",
+       " 'Observation 1: North America is a continent entirely within the Northern Hemisphere and almost all within the Western Hemisphere.',\n",
+       " '',\n",
+       " 'Thought 2: I need to look up \"highest mountain peak\".',\n",
+       " '',\n",
+       " 'Action 2: Lookup[highest mountain peak]',\n",
+       " '',\n",
+       " 'Observation 2: (Result 1 / 1) Denali, formerly Mount McKinley, is the highest mountain peak in North America, with a summit elevation of 20,310 feet (6,190 m) above sea level.',\n",
+       " '',\n",
+       " 'Thought 3: Denali is the highest mountain peak in North America, with a summit elevation of 20,310 feet.',\n",
+       " '',\n",
+       " 'Action 3: Finish[20,310 feet]']"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "new_example.split('\\n')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1ed01ba2",
+   "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.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/prompts/llm.json

@@ -7,6 +7,5 @@
     "presence_penalty": 0.0,
     "n": 1,
     "best_of": 1,
-    "request_timeout": null,
     "_type": "openai"
 }

docs/examples/prompts/llm.yaml

@@ -5,6 +5,5 @@ max_tokens: 256
 model_name: text-davinci-003
 n: 1
 presence_penalty: 0.0
-request_timeout: null
 temperature: 0.7
 top_p: 1.0

docs/examples/prompts/llm_functionality.ipynb

@@ -0,0 +1,412 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "20ac6b98",
+   "metadata": {},
+   "source": [
+    "# LLM Functionality\n",
+    "\n",
+    "This notebook goes over all the different features of the LLM class in LangChain.\n",
+    "\n",
+    "We will work with an OpenAI LLM wrapper, although these functionalities should exist for all LLM types."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "df924055",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.llms import OpenAI"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "182b484c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "llm = OpenAI(model_name=\"text-ada-001\", n=2, best_of=2)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9695ccfc",
+   "metadata": {},
+   "source": [
+    "**Generate Text:** The most basic functionality an LLM has is just the ability to call it, passing in a string and getting back a string."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "9d12ac26",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'\\n\\nWhy did the chicken cross the road?\\n\\nTo get to the other side!'"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llm(\"Tell me a joke\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e7d4d42d",
+   "metadata": {},
+   "source": [
+    "**Generate:** More broadly, you can call it with a list of inputs, getting back a more complete response than just the text. This complete response includes things like multiple top responses, as well as LLM provider specific information"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "f4dc241a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "llm_result = llm.generate([\"Tell me a joke\", \"Tell me a poem\"]*15)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "740392f6",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "30"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "len(llm_result.generations)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "ab6cdcf1",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Generation(text='\\n\\nWhy did the chicken cross the road?\\n\\nTo get to the other side.'),\n",
+       " Generation(text='\\n\\nWhy did the chicken cross the road?\\n\\nTo get to the other side!')]"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llm_result.generations[0]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "4946a778",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Generation(text=\"\\n\\nA rose by the side of the road\\n\\nIs all I need to find my way\\n\\nTo the place I've been searching for\\n\\nAnd my heart is singing with joy\\n\\nWhen I look at this rose\\n\\nIt reminds me of the love I've found\\n\\nAnd I know that wherever I go\\n\\nI'll always find my rose by the side of the road.\"),\n",
+       " Generation(text=\"\\n\\nWhen I was younger\\nI thought that love\\nI was something like a fairytale\\nI would find my prince and they would be my people\\nI was naïve\\nI thought that\\n\\nLove was a something that happened\\nWhen I was younger\\nI was it for my fairytale prince\\nNow I realize\\nThat love is something that waits\\nFor when my prince comes\\nAnd when I am ready to be his wife\\nI'll tell you a poem\\n\\nWhen I was younger\\nI thought that love\\nI was something like a fairytale\\nI would find my prince and they would be my people\\nI was naïve\\nI thought that\\n\\nLove was a something that happened\\nAnd I would be happy\\nWhen my prince came\\nAnd I was ready to be his wife\")]"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llm_result.generations[-1]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "242e4527",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'token_usage': {'completion_tokens': 3722,\n",
+       "  'prompt_tokens': 120,\n",
+       "  'total_tokens': 3842}}"
+      ]
+     },
+     "execution_count": 8,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# Provider specific info\n",
+    "llm_result.llm_output"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "bde8e04f",
+   "metadata": {},
+   "source": [
+    "**Number of Tokens:** You can also estimate how many tokens a piece of text will be in that model. This is useful because models have a context length (and cost more for more tokens), which means you need to be aware of how long the text you are passing in is.\n",
+    "\n",
+    "Notice that by default the tokens are estimated using a HuggingFace tokenizer."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "b623c774",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "3"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llm.get_num_tokens(\"what a joke\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ee6fcf8d",
+   "metadata": {},
+   "source": [
+    "### Caching\n",
+    "With LangChain, you can also enable caching of LLM calls. Note that currently this only applies for individual LLM calls."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "2626ca48",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import langchain\n",
+    "from langchain.cache import InMemoryCache\n",
+    "langchain.llm_cache = InMemoryCache()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "97762272",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# To make the caching really obvious, lets use a slower model.\n",
+    "llm = OpenAI(model_name=\"text-davinci-002\", n=2, best_of=2)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "e80c65e4",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "CPU times: user 31.2 ms, sys: 11.8 ms, total: 43.1 ms\n",
+      "Wall time: 1.75 s\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'\\n\\nWhy did the chicken cross the road?\\n\\nTo get to the other side!'"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "%%time\n",
+    "# The first time, it is not yet in cache, so it should take longer\n",
+    "llm(\"Tell me a joke\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "678408ec",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "CPU times: user 51 µs, sys: 1 µs, total: 52 µs\n",
+      "Wall time: 67.2 µs\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'\\n\\nWhy did the chicken cross the road?\\n\\nTo get to the other side!'"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "%%time\n",
+    "# The second time it is, so it goes faster\n",
+    "llm(\"Tell me a joke\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "3f0ac8d2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# We can do the same thing with a SQLite cache\n",
+    "from langchain.cache import SQLiteCache\n",
+    "langchain.llm_cache = SQLiteCache(database_path=\".langchain.db\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "0e1dcce3",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "CPU times: user 26.6 ms, sys: 11.2 ms, total: 37.7 ms\n",
+      "Wall time: 1.89 s\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'\\n\\nWhy did the chicken cross the road?\\n\\nTo get to the other side.'"
+      ]
+     },
+     "execution_count": 8,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "%%time\n",
+    "# The first time, it is not yet in cache, so it should take longer\n",
+    "llm(\"Tell me a joke\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "efadd750",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "CPU times: user 2.69 ms, sys: 1.57 ms, total: 4.27 ms\n",
+      "Wall time: 2.73 ms\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'\\n\\nWhy did the chicken cross the road?\\n\\nTo get to the other side.'"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "%%time\n",
+    "# The second time it is, so it goes faster\n",
+    "llm(\"Tell me a joke\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "6053408b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# You can use SQLAlchemyCache to cache with any SQL database supported by SQLAlchemy.\n",
+    "from langchain.cache import SQLAlchemyCache\n",
+    "from sqlalchemy import create_engine\n",
+    "\n",
+    "engine = create_engine(\"postgresql://postgres:postgres@localhost:5432/postgres\")\n",
+    "langchain.llm_cache = SQLAlchemyCache(engine)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "base",
+   "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.12 (main, Jun  1 2022, 06:34:44) \n[Clang 12.0.0 ]"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "1235b9b19e8e9828b5c1fdb2cd89fe8d3de0fcde5ef5f3db36e4b671adb8660f"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/prompts/llm_serialization.ipynb

@@ -5,9 +5,9 @@
    "id": "73f9bf40",
    "metadata": {},
    "source": [
-    "# How to serialize LLM classes\n",
+    "# LLM Serialization\n",
     "\n",
-    "This notebook walks through how to write and read an LLM Configuration to and from disk. This is useful if you want to save the configuration for a given LLM (e.g., the provider, the temperature, etc)."
+    "This notebook walks how to write and read an LLM Configuration to and from disk. This is useful if you want to save the configuration for a given LLM (eg the provider, the temperature, etc)."
    ]
   },
   {
@@ -26,8 +26,8 @@
    "id": "88ce018b",
    "metadata": {},
    "source": [
-    "## Loading\n",
-    "First, lets go over loading an LLM from disk. LLMs can be saved on disk in two formats: json or yaml. No matter the extension, they are loaded in the same way."
+    "### Loading\n",
+    "First, lets go over loading a LLM from disk. LLMs can be saved on disk in two formats: json or yaml. No matter the extension, they are loaded in the same way."
    ]
   },
   {
@@ -44,12 +44,11 @@
       "    \"model_name\": \"text-davinci-003\",\r\n",
       "    \"temperature\": 0.7,\r\n",
       "    \"max_tokens\": 256,\r\n",
-      "    \"top_p\": 1.0,\r\n",
-      "    \"frequency_penalty\": 0.0,\r\n",
-      "    \"presence_penalty\": 0.0,\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",
       "    \"_type\": \"openai\"\r\n",
       "}"
      ]
@@ -81,14 +80,13 @@
      "text": [
       "_type: openai\r\n",
       "best_of: 1\r\n",
-      "frequency_penalty: 0.0\r\n",
+      "frequency_penalty: 0\r\n",
       "max_tokens: 256\r\n",
       "model_name: text-davinci-003\r\n",
       "n: 1\r\n",
-      "presence_penalty: 0.0\r\n",
-      "request_timeout: null\r\n",
+      "presence_penalty: 0\r\n",
       "temperature: 0.7\r\n",
-      "top_p: 1.0\r\n"
+      "top_p: 1\r\n"
      ]
     }
    ],
@@ -111,8 +109,8 @@
    "id": "ab3e4223",
    "metadata": {},
    "source": [
-    "## Saving\n",
-    "If you want to go from an LLM in memory to a serialized version of it, you can do so easily by calling the `.save` method. Again, this supports both json and yaml."
+    "### Saving\n",
+    "If you want to go from a LLM in memory to a serialized version of it, you can do so easily by calling the `.save` method. Again, this supports both json and yaml."
    ]
   },
   {
@@ -138,7 +136,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "68e45b1c",
+   "id": "0e494851",
    "metadata": {},
    "outputs": [],
    "source": []
@@ -160,7 +158,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.1"
+   "version": "3.10.8"
   }
  },
  "nbformat": 4,

docs/examples/prompts/prompt_management.ipynb

@@ -0,0 +1,610 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "43fb16cb",
+   "metadata": {},
+   "source": [
+    "# Prompt Management\n",
+    "\n",
+    "Managing your prompts is annoying and tedious, with everyone writing their own slightly different variants of the same ideas. But it shouldn't be this way. \n",
+    "\n",
+    "LangChain provides a standard and flexible way for specifying and managing all your prompts, as well as clear and specific terminology around them. This notebook goes through the core components of working with prompts, showing how to use them as well as explaining what they do.\n",
+    "\n",
+    "This notebook covers how to work with prompts in Python. If you are interested in how to work with serialized versions of prompts and load them from disk, see [this notebook](prompt_serialization.ipynb)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "890aad4d",
+   "metadata": {},
+   "source": [
+    "### The BasePromptTemplate Interface\n",
+    "\n",
+    "A prompt template is a mechanism for constructing a prompt to pass to the language model given some user input. Below is the interface that all different types of prompt templates should expose.\n",
+    "\n",
+    "```python\n",
+    "class BasePromptTemplate(ABC):\n",
+    "\n",
+    "    input_variables: List[str]\n",
+    "    \"\"\"A list of the names of the variables the prompt template expects.\"\"\"\n",
+    "\n",
+    "    @abstractmethod\n",
+    "    def format(self, **kwargs: Any) -> str:\n",
+    "        \"\"\"Format the prompt with the inputs.\n",
+    "\n",
+    "        Args:\n",
+    "            kwargs: Any arguments to be passed to the prompt template.\n",
+    "\n",
+    "        Returns:\n",
+    "            A formatted string.\n",
+    "\n",
+    "        Example:\n",
+    "\n",
+    "        .. code-block:: python\n",
+    "\n",
+    "            prompt.format(variable1=\"foo\")\n",
+    "        \"\"\"\n",
+    "```\n",
+    "\n",
+    "The only two things that define a prompt are:\n",
+    "\n",
+    "1. `input_variables`: The user inputted variables that are needed to format the prompt.\n",
+    "2. `format`: A method which takes in keyword arguments are returns a formatted prompt. The keys are expected to be the input variables\n",
+    "    \n",
+    "The rest of the logic of how the prompt is constructed is left up to different implementations. Let's take a look at some below."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "cddb465e",
+   "metadata": {},
+   "source": [
+    "### PromptTemplate\n",
+    "\n",
+    "This is the most simple type of prompt template, consisting of a string template that takes any number of input variables. The template should be formatted as a Python f-string, although we will support other formats (Jinja, Mako, etc) in the future. \n",
+    "\n",
+    "If you just want to use a hardcoded prompt template, you should use this implementation.\n",
+    "\n",
+    "Let's walk through a few examples."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "094229f4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.prompts import PromptTemplate"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "ab46bd2a",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Tell me a joke.'"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# An example prompt with no input variables\n",
+    "no_input_prompt = PromptTemplate(input_variables=[], template=\"Tell me a joke.\")\n",
+    "no_input_prompt.format()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "c3ad0fa8",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Tell me a funny joke.'"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# An example prompt with one input variable\n",
+    "one_input_prompt = PromptTemplate(input_variables=[\"adjective\"], template=\"Tell me a {adjective} joke.\")\n",
+    "one_input_prompt.format(adjective=\"funny\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "ba577dcf",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'Tell me a funny joke about chickens.'"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# An example prompt with multiple input variables\n",
+    "multiple_input_prompt = PromptTemplate(\n",
+    "    input_variables=[\"adjective\", \"content\"], \n",
+    "    template=\"Tell me a {adjective} joke about {content}.\"\n",
+    ")\n",
+    "multiple_input_prompt.format(adjective=\"funny\", content=\"chickens\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1492b49d",
+   "metadata": {},
+   "source": [
+    "### Few Shot Prompts\n",
+    "\n",
+    "A FewShotPromptTemplate is a prompt template that includes some examples. If you have collected some examples of how the task should be done, you can insert them into prompt using this class.\n",
+    "\n",
+    "Examples are datapoints that can be included in the prompt in order to give the model more context what to do. Examples are represented as a dictionary of key-value pairs, with the key being the input (or label) name, and the value being the input (or label) value. \n",
+    "\n",
+    "In addition to the example, we also need to specify how the example should be formatted when it's inserted in the prompt. We can do this using the above `PromptTemplate`!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "3eb36972",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# These are some examples of a pretend task of creating antonyms.\n",
+    "examples = [\n",
+    "    {\"input\": \"happy\", \"output\": \"sad\"},\n",
+    "    {\"input\": \"tall\", \"output\": \"short\"},\n",
+    "]\n",
+    "# This how we specify how the example should be formatted.\n",
+    "example_prompt = PromptTemplate(\n",
+    "    input_variables=[\"input\",\"output\"],\n",
+    "    template=\"Input: {input}\\nOutput: {output}\",\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "80a91d96",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.prompts import FewShotPromptTemplate"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "7931e5f2",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Give the antonym of every input\n",
+      "\n",
+      "Input: happy\n",
+      "Output: sad\n",
+      "\n",
+      "Input: tall\n",
+      "Output: short\n",
+      "\n",
+      "Input: big\n",
+      "Output:\n"
+     ]
+    }
+   ],
+   "source": [
+    "prompt_from_string_examples = FewShotPromptTemplate(\n",
+    "    # These are the examples we want to insert into the prompt.\n",
+    "    examples=examples,\n",
+    "    # This is how we want to format the examples when we insert them into the prompt.\n",
+    "    example_prompt=example_prompt,\n",
+    "    # The prefix is some text that goes before the examples in the prompt.\n",
+    "    # Usually, this consists of intructions.\n",
+    "    prefix=\"Give the antonym of every input\",\n",
+    "    # The suffix is some text that goes after the examples in the prompt.\n",
+    "    # Usually, this is where the user input will go\n",
+    "    suffix=\"Input: {adjective}\\nOutput:\", \n",
+    "    # The input variables are the variables that the overall prompt expects.\n",
+    "    input_variables=[\"adjective\"],\n",
+    "    # The example_separator is the string we will use to join the prefix, examples, and suffix together with.\n",
+    "    example_separator=\"\\n\\n\"\n",
+    "    \n",
+    ")\n",
+    "print(prompt_from_string_examples.format(adjective=\"big\"))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "bf038596",
+   "metadata": {},
+   "source": [
+    "### ExampleSelector\n",
+    "If you have a large number of examples, you may need to select which ones to include in the prompt. The ExampleSelector is the class responsible for doing so. The base interface is defined as below.\n",
+    "\n",
+    "```python\n",
+    "class BaseExampleSelector(ABC):\n",
+    "    \"\"\"Interface for selecting examples to include in prompts.\"\"\"\n",
+    "\n",
+    "    @abstractmethod\n",
+    "    def select_examples(self, input_variables: Dict[str, str]) -> List[dict]:\n",
+    "        \"\"\"Select which examples to use based on the inputs.\"\"\"\n",
+    "\n",
+    "```\n",
+    "\n",
+    "The only method it needs to expose is a `select_examples` method. This takes in the input variables and then returns a list of examples. It is up to each specific implementation as to how those examples are selected. Let's take a look at some below."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "861a4d1f",
+   "metadata": {},
+   "source": [
+    "### LengthBased ExampleSelector\n",
+    "\n",
+    "This ExampleSelector selects which examples to use based on length. This is useful when you are worried about constructing a prompt that will go over the length of the context window. For longer inputs, it will select fewer examples to include, while for shorter inputs it will select more.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "7c469c95",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.prompts.example_selector import LengthBasedExampleSelector"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "0ec6d950",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# These are a lot of examples of a pretend task of creating antonyms.\n",
+    "examples = [\n",
+    "    {\"input\": \"happy\", \"output\": \"sad\"},\n",
+    "    {\"input\": \"tall\", \"output\": \"short\"},\n",
+    "    {\"input\": \"energetic\", \"output\": \"lethargic\"},\n",
+    "    {\"input\": \"sunny\", \"output\": \"gloomy\"},\n",
+    "    {\"input\": \"windy\", \"output\": \"calm\"},\n",
+    "]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "207e55f7",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "example_selector = LengthBasedExampleSelector(\n",
+    "    # These are the examples is has available to choose from.\n",
+    "    examples=examples, \n",
+    "    # This is the PromptTemplate being used to format the examples.\n",
+    "    example_prompt=example_prompt, \n",
+    "    # This is the maximum length that the formatted examples should be.\n",
+    "    # Length is measured by the get_text_length function below.\n",
+    "    max_length=25,\n",
+    "    # This is the function used to get the length of a string, which is used\n",
+    "    # to determine which examples to include. It is commented out because\n",
+    "    # it is provided as a default value if none is specified.\n",
+    "    # get_text_length: Callable[[str], int] = lambda x: len(re.split(\"\\n| \", x))\n",
+    ")\n",
+    "dynamic_prompt = FewShotPromptTemplate(\n",
+    "    # We provide an ExampleSelector instead of examples.\n",
+    "    example_selector=example_selector,\n",
+    "    example_prompt=example_prompt,\n",
+    "    prefix=\"Give the antonym of every input\",\n",
+    "    suffix=\"Input: {adjective}\\nOutput:\", \n",
+    "    input_variables=[\"adjective\"],\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "d00b4385",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Give the antonym of every input\n",
+      "\n",
+      "Input: happy\n",
+      "Output: sad\n",
+      "\n",
+      "Input: tall\n",
+      "Output: short\n",
+      "\n",
+      "Input: energetic\n",
+      "Output: lethargic\n",
+      "\n",
+      "Input: sunny\n",
+      "Output: gloomy\n",
+      "\n",
+      "Input: windy\n",
+      "Output: calm\n",
+      "\n",
+      "Input: big\n",
+      "Output:\n"
+     ]
+    }
+   ],
+   "source": [
+    "# An example with small input, so it selects all examples.\n",
+    "print(dynamic_prompt.format(adjective=\"big\"))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "id": "878bcde9",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Give the antonym of every input\n",
+      "\n",
+      "Input: happy\n",
+      "Output: sad\n",
+      "\n",
+      "Input: big and huge and massive and large and gigantic and tall and much much much much much bigger than everything else\n",
+      "Output:\n"
+     ]
+    }
+   ],
+   "source": [
+    "# An example with long input, so it selects only one example.\n",
+    "long_string = \"big and huge and massive and large and gigantic and tall and much much much much much bigger than everything else\"\n",
+    "print(dynamic_prompt.format(adjective=long_string))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 13,
+   "id": "e4bebcd9",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Give the antonym of every input\n",
+      "\n",
+      "Input: happy\n",
+      "Output: sad\n",
+      "\n",
+      "Input: tall\n",
+      "Output: short\n",
+      "\n",
+      "Input: energetic\n",
+      "Output: lethargic\n",
+      "\n",
+      "Input: sunny\n",
+      "Output: gloomy\n",
+      "\n",
+      "Input: windy\n",
+      "Output: calm\n",
+      "\n",
+      "Input: big\n",
+      "Output: small\n",
+      "\n",
+      "Input: enthusiastic\n",
+      "Output:\n"
+     ]
+    }
+   ],
+   "source": [
+    "# You can add an example to an example selector as well.\n",
+    "new_example = {\"input\": \"big\", \"output\": \"small\"}\n",
+    "dynamic_prompt.example_selector.add_example(new_example)\n",
+    "print(dynamic_prompt.format(adjective=\"enthusiastic\"))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "2d007b0a",
+   "metadata": {},
+   "source": [
+    "### Similarity ExampleSelector\n",
+    "\n",
+    "The SemanticSimilarityExampleSelector selects examples based on which examples are most similar to the inputs. It does this by finding the examples with the embeddings that have the greatest cosine similarity with the inputs.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 14,
+   "id": "241bfe80",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.prompts.example_selector import SemanticSimilarityExampleSelector\n",
+    "from langchain.vectorstores import FAISS\n",
+    "from langchain.embeddings import OpenAIEmbeddings"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 15,
+   "id": "50d0a701",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "example_selector = SemanticSimilarityExampleSelector.from_examples(\n",
+    "    # This is the list of examples available to select from.\n",
+    "    examples, \n",
+    "    # This is the embedding class used to produce embeddings which are used to measure semantic similarity.\n",
+    "    OpenAIEmbeddings(), \n",
+    "    # This is the VectorStore class that is used to store the embeddings and do a similarity search over.\n",
+    "    FAISS, \n",
+    "    # This is the number of examples to produce.\n",
+    "    k=1\n",
+    ")\n",
+    "similar_prompt = FewShotPromptTemplate(\n",
+    "    # We provide an ExampleSelector instead of examples.\n",
+    "    example_selector=example_selector,\n",
+    "    example_prompt=example_prompt,\n",
+    "    prefix=\"Give the antonym of every input\",\n",
+    "    suffix=\"Input: {adjective}\\nOutput:\", \n",
+    "    input_variables=[\"adjective\"],\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 16,
+   "id": "4c8fdf45",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Give the antonym of every input\n",
+      "\n",
+      "Input: happy\n",
+      "Output: sad\n",
+      "\n",
+      "Input: worried\n",
+      "Output:\n"
+     ]
+    }
+   ],
+   "source": [
+    "# Input is a feeling, so should select the happy/sad example\n",
+    "print(similar_prompt.format(adjective=\"worried\"))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 17,
+   "id": "829af21a",
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Give the antonym of every input\n",
+      "\n",
+      "Input: tall\n",
+      "Output: short\n",
+      "\n",
+      "Input: fat\n",
+      "Output:\n"
+     ]
+    }
+   ],
+   "source": [
+    "# Input is a measurement, so should select the tall/short example\n",
+    "print(similar_prompt.format(adjective=\"fat\"))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 18,
+   "id": "3c16fe23",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Give the antonym of every input\n",
+      "\n",
+      "Input: enthusiastic\n",
+      "Output: apathetic\n",
+      "\n",
+      "Input: joyful\n",
+      "Output:\n"
+     ]
+    }
+   ],
+   "source": [
+    "# You can add new examples to the SemanticSimilarityExampleSelector as well\n",
+    "similar_prompt.example_selector.add_example({\"input\": \"enthusiastic\", \"output\": \"apathetic\"})\n",
+    "print(similar_prompt.format(adjective=\"joyful\"))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "dbc32551",
+   "metadata": {},
+   "source": [
+    "### Serialization\n",
+    "\n",
+    "PromptTemplates and examples can be serialized and loaded from disk, making it easy to share and store prompts. For a detailed walkthrough on how to do that, see [this notebook](prompt_serialization.ipynb)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1e1e13c6",
+   "metadata": {},
+   "source": [
+    "### Customizability\n",
+    "The above covers all the ways currently supported in LangChain to represent prompts and example selectors. However, due to the simple interface that the base classes (`BasePromptTemplate`, `BaseExampleSelector`) expose, it should be easy to subclass them and write your own implementation in your own codebase. And of course, if you'd like to contribute that back to LangChain, we'd love that :)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "c746d6f4",
+   "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.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/prompts/prompt_serialization.ipynb

@@ -5,13 +5,13 @@
    "id": "43fb16cb",
    "metadata": {},
    "source": [
-    "# How to serialize prompts\n",
+    "# Prompt Serialization\n",
     "\n",
     "It is often preferrable to store prompts not as python code but as files. This can make it easy to share, store, and version prompts. This notebook covers how to do that in LangChain, walking through all the different types of prompts and the different serialization options.\n",
     "\n",
     "At a high level, the following design principles are applied to serialization:\n",
     "\n",
-    "1. Both JSON and YAML are supported. We want to support serialization methods that are human readable on disk, and YAML and JSON are two of the most popular methods for that. Note that this rule applies to prompts. For other assets, like Examples, different serialization methods may be supported.\n",
+    "1. Both JSON and YAML are supported. We want to support serialization methods are human readable on disk, and YAML and JSON are two of the most popular methods for that. Note that this rule applies to prompts. For other assets, like Examples, different serialization methods may be supported.\n",
     "\n",
     "2. We support specifying everything in one file, or storing different components (templates, examples, etc) in different files and referencing them. For some cases, storing everything in file makes the most sense, but for others it is preferrable to split up some of the assets (long templates, large examples, reusable components). LangChain supports both.\n",
     "\n",
@@ -58,7 +58,6 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "_type: prompt\r\n",
       "input_variables:\r\n",
       "    [\"adjective\", \"content\"]\r\n",
       "template: \r\n",
@@ -109,7 +108,6 @@
      "output_type": "stream",
      "text": [
       "{\r\n",
-      "    \"_type\": \"prompt\",\r\n",
       "    \"input_variables\": [\"adjective\", \"content\"],\r\n",
       "    \"template\": \"Tell me a {adjective} joke about {content}.\"\r\n",
       "}\r\n"
@@ -120,25 +118,6 @@
     "!cat simple_prompt.json"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "de75e959",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "prompt = load_prompt(\"simple_prompt.json\")\n",
-    "print(prompt.format(adjective=\"funny\", content=\"chickens\"))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "d1d788f9",
-   "metadata": {},
-   "source": [
-    "Tell me a funny joke about chickens."
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "d788a83c",
@@ -177,7 +156,6 @@
      "output_type": "stream",
      "text": [
       "{\r\n",
-      "    \"_type\": \"prompt\",\r\n",
       "    \"input_variables\": [\"adjective\", \"content\"],\r\n",
       "    \"template_path\": \"simple_template.txt\"\r\n",
       "}\r\n"
@@ -247,35 +225,6 @@
     "!cat examples.json"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "d3052850",
-   "metadata": {},
-   "source": [
-    "And here is what the same examples stored as yaml might look like."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "901385d1",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "- input: happy\r\n",
-      "  output: sad\r\n",
-      "- input: tall\r\n",
-      "  output: short\r\n"
-     ]
-    }
-   ],
-   "source": [
-    "!cat examples.yaml"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "8e300335",
@@ -287,7 +236,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 9,
    "id": "e2bec0fc",
    "metadata": {},
    "outputs": [
@@ -301,7 +250,6 @@
       "prefix: \r\n",
       "    Write antonyms for the following words.\r\n",
       "example_prompt:\r\n",
-      "    _type: prompt\r\n",
       "    input_variables:\r\n",
       "        [\"input\", \"output\"]\r\n",
       "    template:\r\n",
@@ -319,7 +267,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 10,
    "id": "98c8f356",
    "metadata": {},
    "outputs": [
@@ -345,74 +293,6 @@
     "print(prompt.format(adjective=\"funny\"))"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "13620324",
-   "metadata": {},
-   "source": [
-    "The same would work if you loaded examples from the yaml file."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "831e5e4a",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "_type: few_shot\r\n",
-      "input_variables:\r\n",
-      "    [\"adjective\"]\r\n",
-      "prefix: \r\n",
-      "    Write antonyms for the following words.\r\n",
-      "example_prompt:\r\n",
-      "    _type: prompt\r\n",
-      "    input_variables:\r\n",
-      "        [\"input\", \"output\"]\r\n",
-      "    template:\r\n",
-      "        \"Input: {input}\\nOutput: {output}\"\r\n",
-      "examples:\r\n",
-      "    examples.yaml\r\n",
-      "suffix:\r\n",
-      "    \"Input: {adjective}\\nOutput:\"\r\n"
-     ]
-    }
-   ],
-   "source": [
-    "!cat few_shot_prompt_yaml_examples.yaml"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "6f0a7eaa",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Write antonyms for the following words.\n",
-      "\n",
-      "Input: happy\n",
-      "Output: sad\n",
-      "\n",
-      "Input: tall\n",
-      "Output: short\n",
-      "\n",
-      "Input: funny\n",
-      "Output:\n"
-     ]
-    }
-   ],
-   "source": [
-    "prompt = load_prompt(\"few_shot_prompt_yaml_examples.yaml\")\n",
-    "print(prompt.format(adjective=\"funny\"))"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "4870aa9d",
@@ -424,7 +304,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 11,
    "id": "9d996a86",
    "metadata": {},
    "outputs": [
@@ -437,7 +317,6 @@
       "    \"input_variables\": [\"adjective\"],\r\n",
       "    \"prefix\": \"Write antonyms for the following words.\",\r\n",
       "    \"example_prompt\": {\r\n",
-      "        \"_type\": \"prompt\",\r\n",
       "        \"input_variables\": [\"input\", \"output\"],\r\n",
       "        \"template\": \"Input: {input}\\nOutput: {output}\"\r\n",
       "    },\r\n",
@@ -453,7 +332,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 12,
    "id": "dd2c10bb",
    "metadata": {},
    "outputs": [
@@ -490,7 +369,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 13,
    "id": "6cd781ef",
    "metadata": {},
    "outputs": [
@@ -503,7 +382,6 @@
       "    \"input_variables\": [\"adjective\"],\r\n",
       "    \"prefix\": \"Write antonyms for the following words.\",\r\n",
       "    \"example_prompt\": {\r\n",
-      "        \"_type\": \"prompt\",\r\n",
       "        \"input_variables\": [\"input\", \"output\"],\r\n",
       "        \"template\": \"Input: {input}\\nOutput: {output}\"\r\n",
       "    },\r\n",
@@ -522,7 +400,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 17,
+   "execution_count": 14,
    "id": "533ab8a7",
    "metadata": {},
    "outputs": [
@@ -559,7 +437,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 15,
    "id": "0b6dd7b8",
    "metadata": {},
    "outputs": [
@@ -568,7 +446,6 @@
      "output_type": "stream",
      "text": [
       "{\r\n",
-      "    \"_type\": \"prompt\",\r\n",
       "    \"input_variables\": [\"input\", \"output\"],\r\n",
       "    \"template\": \"Input: {input}\\nOutput: {output}\" \r\n",
       "}\r\n"
@@ -581,7 +458,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 19,
+   "execution_count": 16,
    "id": "76a1065d",
    "metadata": {},
    "outputs": [
@@ -606,7 +483,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 20,
+   "execution_count": 17,
    "id": "744d275d",
    "metadata": {},
    "outputs": [
@@ -632,83 +509,13 @@
     "print(prompt.format(adjective=\"funny\"))"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "c6e3f9fe",
-   "metadata": {},
-   "source": [
-    "## PromptTempalte with OutputParser\n",
-    "This shows an example of loading a prompt along with an OutputParser from a file."
-   ]
-  },
   {
    "cell_type": "code",
-   "execution_count": 13,
-   "id": "500dab26",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "{\r\n",
-      "    \"input_variables\": [\r\n",
-      "        \"question\",\r\n",
-      "        \"student_answer\"\r\n",
-      "    ],\r\n",
-      "    \"output_parser\": {\r\n",
-      "        \"regex\": \"(.*?)\\\\nScore: (.*)\",\r\n",
-      "        \"output_keys\": [\r\n",
-      "            \"answer\",\r\n",
-      "            \"score\"\r\n",
-      "        ],\r\n",
-      "        \"default_output_key\": null,\r\n",
-      "        \"_type\": \"regex_parser\"\r\n",
-      "    },\r\n",
-      "    \"partial_variables\": {},\r\n",
-      "    \"template\": \"Given the following question and student answer, provide a correct answer and score the student answer.\\nQuestion: {question}\\nStudent Answer: {student_answer}\\nCorrect Answer:\",\r\n",
-      "    \"template_format\": \"f-string\",\r\n",
-      "    \"validate_template\": true,\r\n",
-      "    \"_type\": \"prompt\"\r\n",
-      "}"
-     ]
-    }
-   ],
-   "source": [
-    "! cat prompt_with_output_parser.json"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 20,
-   "id": "d267a736",
+   "execution_count": null,
+   "id": "dcfc7176",
    "metadata": {},
    "outputs": [],
-   "source": [
-    "prompt = load_prompt(\"prompt_with_output_parser.json\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 21,
-   "id": "cb770399",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'answer': 'George Washington was born in 1732 and died in 1799.',\n",
-       " 'score': '1/2'}"
-      ]
-     },
-     "execution_count": 21,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "prompt.output_parser.parse(\"George Washington was born in 1732 and died in 1799.\\nScore: 1/2\")"
-   ]
+   "source": []
   }
  ],
  "metadata": {
@@ -727,12 +534,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "8eb71adebe840dca1185e9603533462bc47eb1b1a73bf7dab2d0a8a4c932882e"
-   }
+   "version": "3.7.6"
   }
  },
  "nbformat": 4,

docs/examples/prompts/simple_prompt.json

@@ -1,5 +1,4 @@
 {
-    "_type": "prompt",
     "input_variables": ["adjective", "content"],
     "template": "Tell me a {adjective} joke about {content}."
 }

docs/examples/prompts/simple_prompt.yaml

@@ -1,4 +1,3 @@
-_type: prompt
 input_variables:
     ["adjective", "content"]
 template: 

docs/examples/prompts/simple_prompt_with_template_file.json

@@ -1,5 +1,4 @@
 {
-    "_type": "prompt",
     "input_variables": ["adjective", "content"],
     "template_path": "simple_template.txt"
 }

docs/explanation/agents.md

@@ -1,16 +1,18 @@
-# Agent Types
+# 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.
 Here are the agents available in LangChain.
 
-## `zero-shot-react-description`
+For a tutorial on how to load agents, see [here](/getting_started/agents.ipynb).
+
+### `zero-shot-react-description`
 
 This agent uses the ReAct framework to determine which tool to use
 based solely on the tool's description. Any number of tools can be provided.
 This agent requires that a description is provided for each tool.
 
-## `react-docstore`
+### `react-docstore`
 
 This agent uses the ReAct framework to interact with a docstore. Two tools must
 be provided: a `Search` tool and a `Lookup` tool (they must be named exactly as so).
@@ -19,15 +21,9 @@ a term in the most recently found document.
 This agent is equivalent to the
 original [ReAct paper](https://arxiv.org/pdf/2210.03629.pdf), specifically the Wikipedia example.
 
-## `self-ask-with-search`
+### `self-ask-with-search`
 
 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/explanation/combine_docs.md

@@ -0,0 +1,128 @@
+# Data Augmented Generation
+
+## Overview
+
+Language models are trained on large amounts of unstructured data, which makes them really good at general purpose text generation. However, there are many instances where you may want the language model to generate text based not on generic data but rather on specific data. Some common examples of this include:
+
+- Summarization of a specific piece of text (a website, a private document, etc)
+- Question answering over a specific piece of text (a website, a private document, etc)
+- Question answering over multiple pieces of text (multiple websites, multiple private documents, etc)
+- Using the results of some external call to an API (results from a SQL query, etc)
+
+All of these examples are instances when you do not want the LLM to generate text based solely on the data it was trained over, but rather you want it to incorporate other external data in some way. At a high level, this process can be broken down into two steps:
+
+1. Fetching: Fetching the relevant data to include.
+2. Augmenting: Passing the data in as context to the LLM.
+
+This guide is intended to provide an overview of how to do this. This includes an overview of the literature, as well as common tools, abstractions and chains for doing this.
+
+## Related Literature
+There are a lot of related papers in this area. Most of them are focused on end-to-end methods that optimize the fetching of the relevant data as well as passing it in as context. These are a few of the papers that are particularly relevant:
+
+**[RAG](https://arxiv.org/abs/2005.11401):** Retrieval Augmented Generation. 
+This paper introduces RAG models where the parametric memory is a pre-trained seq2seq model and the non-parametric memory is a dense vector index of Wikipedia, accessed with a pre-trained neural retriever.
+
+**[REALM](https://arxiv.org/abs/2002.08909):** Retrieval-Augmented Language Model Pre-Training. 
+To capture knowledge in a more modular and interpretable way, this paper augments language model pre-training with a latent knowledge retriever, which allows the model to retrieve and attend over documents from a large corpus such as Wikipedia, used during pre-training, fine-tuning and inference.
+
+**[HayStack](https://haystack.deepset.ai/):** This is not a paper, but rather an open source library aimed at semantic search, question answering, summarization, and document ranking for a wide range of NLP applications. The underpinnings of this library are focused on the same `fetching` and `augmenting` concepts discussed here, and incorporate some of the methods in the above papers.
+
+These papers/open-source projects are centered around retrieval of documents, which is important for question-answering tasks over a large corpus of documents (which is how they are evaluated). However, we use the terminology of `Data Augmented Generation` to highlight that retrieval from some document store is only one possible way of fetching relevant data to include. Other methods to fetch relevant data could involve hitting an API, querying a database, or just working with user provided data (eg a specific document that they want to summarize).
+
+Let's now deep dive on the two steps involved: fetching and augmenting.
+
+## Fetching
+There are many ways to fetch relevant data to pass in as context to a LM, and these methods largely depend
+on the use case.
+
+**User provided:** In some cases, the user may provide the relevant data, and no algorithm for fetching is needed.
+An example of this is for summarization of specific documents: the user will provide the document to be summarized,
+and task the language model with summarizing it.
+
+**Document Retrieval:** One of the more common use cases involves fetching relevant documents or pieces of text from
+a large corpus of data. A common example of this is question answering over a private collection of documents.
+
+**API Querying:** Another common way to fetch data is from an API query. One example of this is WebGPT like system,
+where you first query Google (or another search API) for relevant information, and then those results are used in
+the generation step. Another example could be querying a structured database (like SQL) and then using a language model
+to synthesize those results.
+
+There are two big issues to deal with in fetching:
+
+1. Fetching small enough pieces of information
+2. Not fetching too many pieces of information (eg fetching only the most relevant pieces)
+
+### Text Splitting
+One big issue with all of these methods is how to make sure you are working with pieces of text that are not too large.
+This is important because most language models have a context length, and so you cannot (yet) just pass a 
+large document in as context. Therefor, it is important to not only fetch relevant data but also make sure it is
+small enough chunks.
+
+LangChain provides some utilities to help with splitting up larger pieces of data. This comes in the form of the TextSplitter class.
+The class takes in a document and splits it up into chunks, with several parameters that control the
+size of the chunks as well as the overlap in the chunks (important for maintaining context).
+See [this walkthrough](../examples/integrations/textsplitter.ipynb) for more information.
+
+### Relevant Documents
+A second large issue related fetching data is to make sure you are not fetching too many documents, and are only fetching
+the documents that are relevant to the query/question at hand. There are a few ways to deal with this.
+
+One concrete example of this is vector stores for document retrieval, often used for semantic search or question answering.
+With this method, larger documents are split up into
+smaller chunks and then each chunk of text is passed to an embedding function which creates an embedding for that piece of text.
+Those are embeddings are then stored in a database. When a new search query or question comes in, an embedding is
+created for that query/question and then documents with embeddings most similar to that embedding are fetched. 
+Examples of vector database companies include [Pinecone](https://www.pinecone.io/) and [Weaviate](https://weaviate.io/).
+
+Although this is perhaps the most common way of document retrieval, people are starting to think about alternative
+data structures and indexing techniques specifically for working with language models. For a leading example of this,
+check out [GPT Index](https://github.com/jerryjliu/gpt_index) - a collection of data structures created by and optimized
+for language models.
+
+## Augmenting
+So you've fetched your relevant data - 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 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:
+
+### Stuffing
+Stuffing is the simplest method, whereby you simply stuff all the related data into the prompt as context
+to pass to the language model. This is implemented in LangChain as the `StuffDocumentsChain`.
+
+**Pros:** Only makes a single call to the LLM. When generating text, the LLM has access to all the data at once.
+
+**Cons:** Most LLMs have a context length, and for large documents (or many documents) this will not work as it will result in a prompt larger than the context length.
+
+The main downside of this method is that it only works one smaller pieces of data. Once you are working
+with many pieces of data, this approach is no longer feasible. The next two approaches are designed to help deal with that.
+
+### Map Reduce
+This method involves an initial prompt on each chunk of data (for summarization tasks, this 
+could be a summary of that chunk; for question-answering tasks, it could be an answer based solely on that chunk).
+Then a different prompt is run to combine all the initial outputs. This is implemented in the LangChain as the `MapReduceDocumentsChain`.
+
+**Pros:** Can scale to larger documents (and more documents) than `StuffDocumentsChain`. The calls to the LLM on individual documents are independent and can therefore be parallelized.
+
+**Cons:** Requires many more calls to the LLM than `StuffDocumentsChain`. Loses some information during the final combining call.
+
+### Refine
+This method involves an initial prompt on the first chunk of data, generating some output.
+For the remaining documents, that output is passed in, along with the next document, 
+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 `RefineDocumentsChain`.
+
+**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.
+
+## Use Cases
+LangChain supports the above three methods of augmenting LLMs with external data.
+These methods can be used to underpin several common use cases and they are discussed below.
+For all three of these use cases, all three methods are supported.
+It is important to note that a large part of these implementations is the prompts
+that are used. We provide default prompts for all three use cases, but these can be configured.
+This is in case you discover a prompt that works better for your specific application.
+
+- [Question-Answering With Sources](../examples/chains/qa_with_sources.ipynb)
+- [Question-Answering](../examples/chains/question_answering.ipynb)
+- [Summarization](../examples/chains/summarize.ipynb)

docs/explanation/cool_demos.md

@@ -0,0 +1,45 @@
+# Cool Demos
+
+Lots of people have built some pretty awesome stuff with LangChain.
+This is a collection of our favorites.
+If you see any other demos that you think we should highlight, be sure to let us know!
+
+## Open Source
+
+### [YouTube Transcription Question Answering with Sources](https://colab.research.google.com/drive/1sKSTjt9cPstl_WMZ86JsgEqFG-aSAwkn?usp=sharing)
+An end-to-end example of doing question answering on YouTube transcripts, returning the timestamps as sources to legitimize the answer.
+
+### [ThoughtSource](https://github.com/OpenBioLink/ThoughtSource)
+A central, open resource and community around data and tools related to chain-of-thought reasoning in large language models.
+
+### [Notion Database Question-Answering Bot](https://github.com/hwchase17/notion-qa)
+Open source GitHub project shows how to use LangChain to create a
+chatbot that can answer questions about an arbitrary Notion database.
+
+### [GPT Index](https://github.com/jerryjliu/gpt_index)
+GPT Index is a project consisting of a set of data structures that are created using GPT-3 and can be traversed using GPT-3 in order to answer queries.
+
+### [Grover's Algorithm](https://github.com/JavaFXpert/llm-grovers-search-party)
+Leveraging Qiskit, OpenAI and LangChain to demonstrate Grover's algorithm
+
+### [ReAct TextWorld](https://colab.research.google.com/drive/19WTIWC3prw5LDMHmRMvqNV2loD9FHls6?usp=sharing)
+Leveraging the ReActTextWorldAgent to play TextWorld with an LLM!
+
+
+## Not Open Source
+
+### [Daimon](https://twitter.com/sjwhitmore/status/1580593217153531908?s=20&t=neQvtZZTlp623U3LZwz3bQ)
+A chat-based AI personal assistant with long-term memory about you.
+
+### [Clerkie](https://twitter.com/krrish_dh/status/1581028925618106368?s=20&t=neQvtZZTlp623U3LZwz3bQ)
+Stack Tracing QA Bot to help debug complex stack tracing (especially the ones that go multi-function/file deep). 
+
+### [Sales Email Writer](https://twitter.com/Raza_Habib496/status/1596880140490838017?s=20&t=6MqEQYWfSqmJwsKahjCVOA)
+By Raza Habib, this demo utilizes LangChain + SerpAPI + HumanLoop to write sales emails.
+Give it a company name and a person, this application will use Google Search (via SerpAPI) to get
+more information on the company and the person, and then write them a sales message.
+
+### [Question-Answering on a Web Browser](https://twitter.com/chillzaza_/status/1592961099384905730?s=20&t=EhU8jl0KyCPJ7vE9Rnz-cQ)
+By Zahid Khawaja, this demo utilizes question answering to answer questions about a given website.
+A followup added this for [Youtube videos](https://twitter.com/chillzaza_/status/1593739682013220865?s=20&t=EhU8jl0KyCPJ7vE9Rnz-cQ),
+and then another followup added it for [Wikipedia](https://twitter.com/chillzaza_/status/1594847151238037505?s=20&t=EhU8jl0KyCPJ7vE9Rnz-cQ).

docs/explanation/core_concepts.md

@@ -0,0 +1,37 @@
+# Core Concepts
+
+This section goes over the core concepts of LangChain.
+Understanding these will go a long way in helping you understand the codebase and how to construct chains.
+
+## PromptTemplates
+PromptTemplates generically have a `format` method that takes in variables and returns a formatted string.
+The most simple implementation of this is to have a template string with some variables in it, and then format it with the incoming variables.
+More complex iterations dynamically construct the template string from few shot examples, etc.
+
+For a more detailed explanation of how LangChain approaches prompts and prompt templates, see [here](/examples/prompts/prompt_management).
+
+## LLMs
+Wrappers around Large Language Models (in particular, the `generate` ability of large language models) are some of the core functionality of LangChain.
+These wrappers are classes that are callable: they take in an input string, and return the generated output string.
+
+## Embeddings
+These classes are very similar to the LLM classes in that they are wrappers around models, 
+but rather than return a string they return an embedding (list of floats). This are particularly useful when 
+implementing semantic search functionality. They expose separate methods for embedding queries versus embedding documents.
+
+## Vectorstores
+These are datastores that store documents. They expose a method for passing in a string and finding similar documents.
+
+## Chains
+These are pipelines that combine multiple of the above ideas. 
+They vary greatly in complexity and are combination of generic, highly configurable pipelines and more narrow (but usually more complex) pipelines.
+
+## Agents
+As opposed to a chain, whether the steps to be taken are known ahead of time, agents
+use an LLM to determine which tools to call and in what order.
+
+## Memory
+By default, Chains and Agents are stateless, meaning that they treat each incoming query independently.
+In some applications (chatbots being a GREAT example) it is highly important to remember previous interactions,
+both at a short term but also at a long term level. The concept of "Memory" exists to do exactly that.
+

docs/explanation/glossary.md

@@ -0,0 +1,81 @@
+# 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, 
+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 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. 
+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. 
+
+Resources:
+- [Paper](https://arxiv.org/pdf/2210.03629.pdf)
+- [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. 
+
+Resources:
+- [Paper](https://ofir.io/self-ask.pdf)
+- [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: 
+- [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/)
+- [Socratic Models](https://socraticmodels.github.io/)
+
+### 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. 
+
+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. 
+
+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. 
+
+Resources:
+- [Example](https://twitter.com/goodside/status/1583262455207460865?s=20&t=8Hz7XBnK1OF8siQrxxCIGQ)
+
+### MemPrompt
+
+MemPrompt maintains a memory of errors and user feedback, and uses them to prevent repetition of mistakes.
+
+Resources:
+- [Paper](https://memprompt.com/)

docs/getting_started/agents.ipynb

@@ -0,0 +1,196 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "5436020b",
+   "metadata": {},
+   "source": [
+    "# Agents\n",
+    "\n",
+    "Agents use an LLM to determine which actions to take and in what order.\n",
+    "An action can either be using a tool and observing its output, or returning to the user.\n",
+    "\n",
+    "When used correctly agents can be extremely powerful. The purpose of this notebook is to show you how to easily use agents through the simplest, highest level API. If you want more low level control over various components, check out the documentation for custom agents (coming soon)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3c6226b9",
+   "metadata": {},
+   "source": [
+    "## Concepts\n",
+    "\n",
+    "In order to load agents, you should understand the following concepts:\n",
+    "\n",
+    "- Tool: A function that performs a specific duty. This can be things like: Google Search, Database lookup, Python REPL, other chains. The interface for a tool is currently a function that is expected to have a string as an input, with a string as an output.\n",
+    "- LLM: The language model powering the agent.\n",
+    "- Agent: The agent to use. This should be a string that references a support agent class. Because this notebook focuses on the simplest, highest level API, this only covers using the standard supported agents. If you want to implement a custom agent, see the documentation for custom agents (coming soon).\n",
+    "\n",
+    "**For a list of supported agents and their specifications, see [here](../explanation/agents.md)**"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "05d4b21e",
+   "metadata": {},
+   "source": [
+    "## Tools\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",
+    "```python\n",
+    "class Tool(NamedTuple):\n",
+    "    \"\"\"Interface for tools.\"\"\"\n",
+    "\n",
+    "    name: str\n",
+    "    func: Callable[[str], str]\n",
+    "    description: Optional[str] = None\n",
+    "```\n",
+    "\n",
+    "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": "markdown",
+   "id": "2558a02d",
+   "metadata": {},
+   "source": [
+    "## Loading an agent\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "36ed392e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Import things that are needed generically\n",
+    "from langchain.agents import initialize_agent, Tool\n",
+    "from langchain.llms import OpenAI"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "56ff7670",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Load the tool configs that are needed.\n",
+    "from langchain import LLMMathChain, SerpAPIWrapper\n",
+    "llm = OpenAI(temperature=0)\n",
+    "search = SerpAPIWrapper()\n",
+    "llm_math_chain = LLMMathChain(llm=llm, verbose=True)\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=\"Calculator\",\n",
+    "        func=llm_math_chain.run,\n",
+    "        description=\"useful for when you need to answer questions about math\"\n",
+    "    )\n",
+    "]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "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": 4,
+   "id": "6f96a891",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "What is the age of Olivia Wilde's boyfriend raised to the 0.23 power?\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to find the age of Olivia Wilde's boyfriend\n",
+      "Action: Search\n",
+      "Action Input: \"Olivia Wilde's boyfriend\"\u001b[0m\n",
+      "Observation: \u001b[36;1m\u001b[1;3mOlivia Wilde started dating Harry Styles after ending her years-long engagement to Jason Sudeikis — see their relationship timeline.\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I need to find the age of Harry Styles\n",
+      "Action: Search\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 to the 0.23 power\n",
+      "Action: Calculator\n",
+      "Action Input: 28^0.23\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
+      "28^0.23\u001b[32;1m\u001b[1;3m\n",
+      "\n",
+      "```python\n",
+      "print(28**0.23)\n",
+      "```\n",
+      "\u001b[0m\n",
+      "Answer: \u001b[33;1m\u001b[1;3m2.1520202182226886\n",
+      "\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\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: 2.1520202182226886\u001b[0m"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'2.1520202182226886'"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent.run(\"How old is Olivia Wilde's boyfriend? What is that number raised to the 0.23 power?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "2f0852ff",
+   "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.7.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/getting_started/concepts.md

@@ -1,75 +0,0 @@
-# Concepts
-
-These are concepts and terminology commonly used when developing LLM applications.
-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
-
-`Chain of Thought (CoT)` is 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.
-
-- [Chain-of-Thought Paper](https://arxiv.org/pdf/2201.11903.pdf)
-- [Step-by-Step Paper](https://arxiv.org/abs/2112.00114)
-
-## Action Plan Generation
-
-`Action Plan Generation` is a prompting technique 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.
-
-- [WebGPT Paper](https://arxiv.org/pdf/2112.09332.pdf)
-- [SayCan Paper](https://say-can.github.io/assets/palm_saycan.pdf)
-
-## ReAct
-
-`ReAct` is 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.
-
-- [Paper](https://arxiv.org/pdf/2210.03629.pdf)
-- [LangChain Example](../modules/agents/agents/examples/react.ipynb)
-
-## Self-ask
-
-`Self-ask` is 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.
-
-- [Paper](https://ofir.io/self-ask.pdf)
-- [LangChain Example](../modules/agents/agents/examples/self_ask_with_search.ipynb)
-
-## Prompt Chaining
-
-`Prompt Chaining` is combining multiple LLM calls, with the output of one-step being the input to the next.
-
-- [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/)
-- [Socratic Models](https://socraticmodels.github.io/)
-
-## Memetic Proxy
-
-`Memetic Proxy` is 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.
-
-- [Paper](https://arxiv.org/pdf/2102.07350.pdf)
-
-## Self Consistency
-
-`Self Consistency` is 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.
-
-- [Paper](https://arxiv.org/pdf/2203.11171.pdf)
-
-## Inception
-
-`Inception` is also called `First Person Instruction`.
-It is encouraging the model to think a certain way by including the start of the model’s response in the prompt.
-
-- [Example](https://twitter.com/goodside/status/1583262455207460865?s=20&t=8Hz7XBnK1OF8siQrxxCIGQ)
-
-## MemPrompt
-
-`MemPrompt` maintains a memory of errors and user feedback, and uses them to prevent repetition of mistakes.
-
-- [Paper](https://memprompt.com/)