Merge branch 'master' into harrison/agent_multi_inputs

.coveragerc

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

.devcontainer/README.md

@@ -1,49 +0,0 @@
-# Dev container
-
-This project includes a [dev container](https://containers.dev/), which lets you use a container as a full-featured dev environment.
-
-You can use the dev container configuration in this folder to build and run the app without needing to install any of its tools locally! You can use it in [GitHub Codespaces](https://github.com/features/codespaces) or the [VS Code Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
-
-## GitHub Codespaces
-
-[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/langchain-ai/langchain)
-
-You may use the button above, or follow these steps to open this repo in a Codespace:
-
-1. Click the **Code** drop-down menu at the top of <https://github.com/langchain-ai/langchain>.
-1. Click on the **Codespaces** tab.
-1. Click **Create codespace on master**.
-
-For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace).
-
-## VS Code Dev Containers
-
-[![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/langchain-ai/langchain)
-
-> [!NOTE]
-> If you click the link above you will open the main repo (`langchain-ai/langchain`) and *not* your local cloned repo. This is fine if you only want to run and test the library, but if you want to contribute you can use the link below and replace with your username and cloned repo name:
-
-```txt
-https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/&lt;YOUR_USERNAME&gt;/&lt;YOUR_CLONED_REPO_NAME&gt;
-```
-
-Then you will have a local cloned repo where you can contribute and then create pull requests.
-
-If you already have VS Code and Docker installed, you can use the button above to get started. This will use VSCode to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
-
-Alternatively you can also follow these steps to open this repo in a container using the VS Code Dev Containers extension:
-
-1. If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started).
-
-2. Open a locally cloned copy of the code:
-
-   - Fork and Clone this repository to your local filesystem.
-   - Press <kbd>F1</kbd> and select the **Dev Containers: Open Folder in Container...** command.
-   - Select the cloned copy of this folder, wait for the container to start, and try things out!
-
-You can learn more in the [Dev Containers documentation](https://code.visualstudio.com/docs/devcontainers/containers).
-
-## Tips and tricks
-
-- If you are working with the same repository folder in a container and Windows, you'll want consistent line endings (otherwise you may see hundreds of changes in the SCM view). The `.gitattributes` file in the root of this repo will disable line ending conversion and should prevent this. See [tips and tricks](https://code.visualstudio.com/docs/devcontainers/tips-and-tricks#_resolving-git-line-ending-issues-in-containers-resulting-in-many-modified-files) for more info.
-- If you'd like to review the contents of the image used in this dev container, you can check it out in the [devcontainers/images](https://github.com/devcontainers/images/tree/main/src/python) repo.

.devcontainer/devcontainer.json

@@ -1,58 +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-docker-compose
-{
-  // Name for the dev container
-  "name": "langchain",
-  // Point to a Docker Compose file
-  "dockerComposeFile": "./docker-compose.yaml",
-  // Required when using Docker Compose. The name of the service to connect to once running
-  "service": "langchain",
-  // The optional 'workspaceFolder' property is the path VS Code should open by default when
-  // connected. This is typically a file mount in .devcontainer/docker-compose.yml
-  "workspaceFolder": "/workspaces/langchain",
-  "mounts": [
-    "source=langchain-workspaces,target=/workspaces/langchain,type=volume"
-  ],
-  // Prevent the container from shutting down
-  "overrideCommand": true,
-  // Features to add to the dev container. More info: https://containers.dev/features
-  "features": {
-    "ghcr.io/devcontainers/features/git:1": {},
-    "ghcr.io/devcontainers/features/github-cli:1": {}
-  },
-  "containerEnv": {
-    "UV_LINK_MODE": "copy"
-  },
-  // Use 'forwardPorts' to make a list of ports inside the container available locally.
-  // "forwardPorts": [],
-  // Run commands after the container is created
-  "postCreateCommand": "uv sync && echo 'LangChain (Python) dev environment ready!'",
-  // Configure tool-specific properties.
-  "customizations": {
-    "vscode": {
-      "extensions": [
-        "ms-python.python",
-        "ms-python.debugpy",
-        "ms-python.mypy-type-checker",
-        "ms-python.isort",
-        "unifiedjs.vscode-mdx",
-        "davidanson.vscode-markdownlint",
-        "ms-toolsai.jupyter",
-        "GitHub.copilot",
-        "GitHub.copilot-chat"
-      ],
-      "settings": {
-        "python.defaultInterpreterPath": ".venv/bin/python",
-        "python.formatting.provider": "none",
-        "[python]": {
-          "editor.formatOnSave": true,
-          "editor.codeActionsOnSave": {
-            "source.organizeImports": true
-          }
-        }
-      }
-    }
-  }
-  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-  // "remoteUser": "root"
-}

.devcontainer/docker-compose.yaml

@@ -1,13 +0,0 @@
-version: '3'
-services:
-  langchain:
-    build:
-      dockerfile: libs/langchain/dev.Dockerfile
-      context: ..
-
-    networks:
-      - langchain-network
-
-networks:
-  langchain-network:
-    driver: bridge

.editorconfig

@@ -1,52 +0,0 @@
-# top-most EditorConfig file
-root = true
-
-# All files
-[*]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-# Python files
-[*.py]
-indent_style = space
-indent_size = 4
-max_line_length = 88
-
-# JSON files
-[*.json]
-indent_style = space
-indent_size = 2
-
-# YAML files
-[*.{yml,yaml}]
-indent_style = space
-indent_size = 2
-
-# Markdown files
-[*.md]
-indent_style = space
-indent_size = 2
-trim_trailing_whitespace = false
-
-# Configuration files
-[*.{toml,ini,cfg}]
-indent_style = space
-indent_size = 4
-
-# Shell scripts
-[*.sh]
-indent_style = space
-indent_size = 2
-
-# Makefile
-[Makefile]
-indent_style = tab
-indent_size = 4
-
-# Jupyter notebooks
-[*.ipynb]
-# Jupyter may include trailing whitespace in cell
-# outputs that's semantically meaningful
-trim_trailing_whitespace = false

.flake8

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

.gitattributes

@@ -1,3 +0,0 @@
-* text=auto eol=lf
-*.{cmd,[cC][mM][dD]} text eol=crlf
-*.{bat,[bB][aA][tT]} text eol=crlf

.github/CODEOWNERS

@@ -1,3 +0,0 @@
-/.github/   @baskaryan @ccurme @eyurtsev
-/libs/core/ @eyurtsev
-/libs/partners/ @ccurme @mdrxy

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,142 +0,0 @@
-name: "\U0001F41B Bug Report"
-description: Report a bug in LangChain. To report a security issue, please instead use the security option below. For questions, please use the LangChain forum.
-labels: ["bug"]
-type: bug
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thank you for taking the time to file a bug report.
-
-        For usage questions, feature requests and general design questions, please use the [LangChain Forum](https://forum.langchain.com/).
-
-        Check these before submitting to see if your issue has already been reported, fixed or if there's another way to solve your problem:
-
-        * [Documentation](https://docs.langchain.com/oss/python/langchain/overview),
-        * [API Reference Documentation](https://reference.langchain.com/python/),
-        * [LangChain ChatBot](https://chat.langchain.com/)
-        * [GitHub search](https://github.com/langchain-ai/langchain),
-        * [LangChain Forum](https://forum.langchain.com/),
-  - type: checkboxes
-    id: checks
-    attributes:
-      label: Checked other resources
-      description: Please confirm and check all the following options.
-      options:
-        - label: This is a bug, not a usage question.
-          required: true
-        - label: I added a clear and descriptive title that summarizes this issue.
-          required: true
-        - label: I used the GitHub search to find a similar question and didn't find it.
-          required: true
-        - label: I am sure that this is a bug in LangChain rather than my code.
-          required: true
-        - label: The bug is not resolved by updating to the latest stable version of LangChain (or the specific integration package).
-          required: true
-        - label: This is not related to the langchain-community package.
-          required: true
-        - label: I posted a self-contained, minimal, reproducible example. A maintainer can copy it and run it AS IS.
-          required: true
-  - type: checkboxes
-    id: package
-    attributes:
-      label: Package (Required)
-      description: |
-        Which `langchain` package(s) is this bug related to? Select at least one.
-
-        Note that if the package you are reporting for is not listed here, it is not in this repository (e.g. `langchain-google-genai` is in [`langchain-ai/langchain-google`](https://github.com/langchain-ai/langchain-google/)).
-
-        Please report issues for other packages to their respective repositories.
-      options:
-        - label: langchain
-        - label: langchain-openai
-        - label: langchain-anthropic
-        - label: langchain-classic
-        - label: langchain-core
-        - label: langchain-cli
-        - label: langchain-model-profiles
-        - label: langchain-tests
-        - label: langchain-text-splitters
-        - label: langchain-chroma
-        - label: langchain-deepseek
-        - label: langchain-exa
-        - label: langchain-fireworks
-        - label: langchain-groq
-        - label: langchain-huggingface
-        - label: langchain-mistralai
-        - label: langchain-nomic
-        - label: langchain-ollama
-        - label: langchain-perplexity
-        - label: langchain-prompty
-        - label: langchain-qdrant
-        - label: langchain-xai
-        - label: Other / not sure / general
-  - type: textarea
-    id: reproduction
-    validations:
-      required: true
-    attributes:
-      label: Example Code (Python)
-      description: |
-        Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
-
-        If a maintainer can copy it, run it, and see it right away, there's a much higher chance that you'll be able to get help.
-
-        **Important!**
-
-        * Avoid screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
-        * Reduce your code to the minimum required to reproduce the issue if possible.
-
-        (This will be automatically formatted into code, so no need for backticks.)
-      render: python
-      placeholder: |
-        from langchain_core.runnables import RunnableLambda
-
-        def bad_code(inputs) -> int:
-          raise NotImplementedError('For demo purpose')
-
-          chain = RunnableLambda(bad_code)
-          chain.invoke('Hello!')
-  - type: textarea
-    attributes:
-      label: Error Message and Stack Trace (if applicable)
-      description: |
-        If you are reporting an error, please copy and paste the full error message and
-        stack trace.
-        (This will be automatically formatted into code, so no need for backticks.)
-      render: shell
-  - type: textarea
-    id: description
-    attributes:
-      label: Description
-      description: |
-        What is the problem, question, or error?
-
-        Write a short description telling what you are doing, what you expect to happen, and what is currently happening.
-      placeholder: |
-        * I'm trying to use the `langchain` library to do X.
-        * I expect to see Y.
-        * Instead, it does Z.
-    validations:
-      required: true
-  - type: textarea
-    id: system-info
-    attributes:
-      label: System Info
-      description: |
-        Please share your system info with us.
-
-        Run the following command in your terminal and paste the output here:
-
-        `python -m langchain_core.sys_info`
-
-        or if you have an existing python interpreter running:
-
-        ```python
-        from langchain_core import sys_info
-        sys_info.print_sys_info()
-        ```
-      placeholder: |
-        python -m langchain_core.sys_info
-    validations:
-      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -1,15 +0,0 @@
-blank_issues_enabled: false
-version: 2.1
-contact_links:
-  - name: 📚 Documentation issue
-    url: https://github.com/langchain-ai/docs/issues/new?template=01-langchain.yml
-    about: Report an issue related to the LangChain documentation
-  - name: 💬 LangChain Forum
-    url:  https://forum.langchain.com/
-    about: General community discussions and support
-  - name: 📚 LangChain Documentation
-    url: https://docs.langchain.com/oss/python/langchain/overview
-    about: View the official LangChain documentation
-  - name: 📚 API Reference Documentation
-    url: https://reference.langchain.com/python/
-    about: View the official LangChain API reference documentation

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,152 +0,0 @@
-name: "✨ Feature Request"
-description: Request a new feature or enhancement for LangChain. For questions, please use the LangChain forum.
-labels: ["feature request"]
-type: feature
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thank you for taking the time to request a new feature.
-
-        Use this to request NEW FEATURES or ENHANCEMENTS in LangChain. For bug reports, please use the bug report template. For usage questions and general design questions, please use the [LangChain Forum](https://forum.langchain.com/).
-
-        Relevant links to check before filing a feature request to see if your request has already been made or
-        if there's another way to achieve what you want:
-
-        * [Documentation](https://docs.langchain.com/oss/python/langchain/overview),
-        * [API Reference Documentation](https://reference.langchain.com/python/),
-        * [LangChain ChatBot](https://chat.langchain.com/)
-        * [GitHub search](https://github.com/langchain-ai/langchain),
-        * [LangChain Forum](https://forum.langchain.com/),
-  - type: checkboxes
-    id: checks
-    attributes:
-      label: Checked other resources
-      description: Please confirm and check all the following options.
-      options:
-        - label: This is a feature request, not a bug report or usage question.
-          required: true
-        - label: I added a clear and descriptive title that summarizes the feature request.
-          required: true
-        - label: I used the GitHub search to find a similar feature request and didn't find it.
-          required: true
-        - label: I checked the LangChain documentation and API reference to see if this feature already exists.
-          required: true
-        - label: This is not related to the langchain-community package.
-          required: true
-  - type: checkboxes
-    id: package
-    attributes:
-      label: Package (Required)
-      description: |
-        Which `langchain` package(s) is this request related to? Select at least one.
-
-        Note that if the package you are requesting for is not listed here, it is not in this repository (e.g. `langchain-google-genai` is in `langchain-ai/langchain`).
-
-        Please submit feature requests for other packages to their respective repositories.
-      options:
-        - label: langchain
-        - label: langchain-openai
-        - label: langchain-anthropic
-        - label: langchain-classic
-        - label: langchain-core
-        - label: langchain-cli
-        - label: langchain-model-profiles
-        - label: langchain-tests
-        - label: langchain-text-splitters
-        - label: langchain-chroma
-        - label: langchain-deepseek
-        - label: langchain-exa
-        - label: langchain-fireworks
-        - label: langchain-groq
-        - label: langchain-huggingface
-        - label: langchain-mistralai
-        - label: langchain-nomic
-        - label: langchain-ollama
-        - label: langchain-perplexity
-        - label: langchain-prompty
-        - label: langchain-qdrant
-        - label: langchain-xai
-        - label: Other / not sure / general
-  - type: textarea
-    id: feature-description
-    validations:
-      required: true
-    attributes:
-      label: Feature Description
-      description: |
-        Please provide a clear and concise description of the feature you would like to see added to LangChain.
-
-        What specific functionality are you requesting? Be as detailed as possible.
-      placeholder: |
-        I would like LangChain to support...
-
-        This feature would allow users to...
-  - type: textarea
-    id: use-case
-    validations:
-      required: true
-    attributes:
-      label: Use Case
-      description: |
-        Describe the specific use case or problem this feature would solve.
-
-        Why do you need this feature? What problem does it solve for you or other users?
-      placeholder: |
-        I'm trying to build an application that...
-
-        Currently, I have to work around this by...
-
-        This feature would help me/users to...
-  - type: textarea
-    id: proposed-solution
-    validations:
-      required: false
-    attributes:
-      label: Proposed Solution
-      description: |
-        If you have ideas about how this feature could be implemented, please describe them here.
-
-        This is optional but can be helpful for maintainers to understand your vision.
-      placeholder: |
-        I think this could be implemented by...
-
-        The API could look like...
-
-        ```python
-        # Example of how the feature might work
-        ```
-  - type: textarea
-    id: alternatives
-    validations:
-      required: false
-    attributes:
-      label: Alternatives Considered
-      description: |
-        Have you considered any alternative solutions or workarounds?
-
-        What other approaches have you tried or considered?
-      placeholder: |
-        I've tried using...
-
-        Alternative approaches I considered:
-        1. ...
-        2. ...
-
-        But these don't work because...
-  - type: textarea
-    id: additional-context
-    validations:
-      required: false
-    attributes:
-      label: Additional Context
-      description: |
-        Add any other context, screenshots, examples, or references that would help explain your feature request.
-      placeholder: |
-        Related issues: #...
-
-        Similar features in other libraries:
-        - ...
-
-        Additional context or examples:
-        - ...

.github/ISSUE_TEMPLATE/privileged.yml

@@ -1,50 +0,0 @@
-name: 🔒 Privileged
-description: You are a LangChain maintainer, or was asked directly by a maintainer to create an issue here. If not, check the other options.
-body:
-  - type: markdown
-    attributes:
-      value: |
-        If you are not a LangChain maintainer, employee, or were not asked directly by a maintainer to create an issue, then please start the conversation on the [LangChain Forum](https://forum.langchain.com/) instead.
-  - type: checkboxes
-    id: privileged
-    attributes:
-      label: Privileged issue
-      description: Confirm that you are allowed to create an issue here.
-      options:
-        - label: I am a LangChain maintainer, or was asked directly by a LangChain maintainer to create an issue here.
-          required: true
-  - type: textarea
-    id: content
-    attributes:
-      label: Issue Content
-      description: Add the content of the issue here.
-  - type: checkboxes
-    id: package
-    attributes:
-      label: Package (Required)
-      description: |
-        Please select package(s) that this issue is related to.
-      options:
-        - label: langchain
-        - label: langchain-openai
-        - label: langchain-anthropic
-        - label: langchain-classic
-        - label: langchain-core
-        - label: langchain-cli
-        - label: langchain-model-profiles
-        - label: langchain-tests
-        - label: langchain-text-splitters
-        - label: langchain-chroma
-        - label: langchain-deepseek
-        - label: langchain-exa
-        - label: langchain-fireworks
-        - label: langchain-groq
-        - label: langchain-huggingface
-        - label: langchain-mistralai
-        - label: langchain-nomic
-        - label: langchain-ollama
-        - label: langchain-perplexity
-        - label: langchain-prompty
-        - label: langchain-qdrant
-        - label: langchain-xai
-        - label: Other / not sure / general

.github/ISSUE_TEMPLATE/task.yml

@@ -1,121 +0,0 @@
-name: "📋 Task"
-description: Create a task for project management and tracking by LangChain maintainers. If you are not a maintainer, please use other templates or the forum.
-labels: ["task"]
-type: task
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for creating a task to help organize LangChain development.
-
-        This template is for **maintainer tasks** such as project management, development planning, refactoring, documentation updates, and other organizational work.
-
-        If you are not a LangChain maintainer or were not asked directly by a maintainer to create a task, then please start the conversation on the [LangChain Forum](https://forum.langchain.com/) instead or use the appropriate bug report or feature request templates on the previous page.
-  - type: checkboxes
-    id: maintainer
-    attributes:
-      label: Maintainer task
-      description: Confirm that you are allowed to create a task here.
-      options:
-        - label: I am a LangChain maintainer, or was asked directly by a LangChain maintainer to create a task here.
-          required: true
-  - type: textarea
-    id: task-description
-    attributes:
-      label: Task Description
-      description: |
-        Provide a clear and detailed description of the task.
-
-        What needs to be done? Be specific about the scope and requirements.
-      placeholder: |
-        This task involves...
-
-        The goal is to...
-
-        Specific requirements:
-        - ...
-        - ...
-    validations:
-      required: true
-  - type: textarea
-    id: acceptance-criteria
-    attributes:
-      label: Acceptance Criteria
-      description: |
-        Define the criteria that must be met for this task to be considered complete.
-
-        What are the specific deliverables or outcomes expected?
-      placeholder: |
-        This task will be complete when:
-        - [ ] ...
-        - [ ] ...
-        - [ ] ...
-    validations:
-      required: true
-  - type: textarea
-    id: context
-    attributes:
-      label: Context and Background
-      description: |
-        Provide any relevant context, background information, or links to related issues/PRs.
-
-        Why is this task needed? What problem does it solve?
-      placeholder: |
-        Background:
-        - ...
-
-        Related issues/PRs:
-        - #...
-
-        Additional context:
-        - ...
-    validations:
-      required: false
-  - type: textarea
-    id: dependencies
-    attributes:
-      label: Dependencies
-      description: |
-        List any dependencies or blockers for this task.
-
-        Are there other tasks, issues, or external factors that need to be completed first?
-      placeholder: |
-        This task depends on:
-        - [ ] Issue #...
-        - [ ] PR #...
-        - [ ] External dependency: ...
-
-        Blocked by:
-        - ...
-    validations:
-      required: false
-  - type: checkboxes
-    id: package
-    attributes:
-      label: Package (Required)
-      description: |
-        Please select package(s) that this task is related to.
-      options:
-        - label: langchain
-        - label: langchain-openai
-        - label: langchain-anthropic
-        - label: langchain-classic
-        - label: langchain-core
-        - label: langchain-cli
-        - label: langchain-model-profiles
-        - label: langchain-tests
-        - label: langchain-text-splitters
-        - label: langchain-chroma
-        - label: langchain-deepseek
-        - label: langchain-exa
-        - label: langchain-fireworks
-        - label: langchain-groq
-        - label: langchain-huggingface
-        - label: langchain-mistralai
-        - label: langchain-nomic
-        - label: langchain-ollama
-        - label: langchain-perplexity
-        - label: langchain-prompty
-        - label: langchain-qdrant
-        - label: langchain-xai
-        - label: Other / not sure / general

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,30 +0,0 @@
-(Replace this entire block of text)
-
-Read the full contributing guidelines: https://docs.langchain.com/oss/python/contributing/overview
-
-Thank you for contributing to LangChain! Follow these steps to have your pull request considered as ready for review.
-
-1. PR title: Should follow the format: TYPE(SCOPE): DESCRIPTION
-
-  - Examples:
-    - fix(anthropic): resolve flag parsing error
-    - feat(core): add multi-tenant support
-    - test(openai): update API usage tests
-  - Allowed TYPE and SCOPE values: https://github.com/langchain-ai/langchain/blob/master/.github/workflows/pr_lint.yml#L15-L33
-
-2. PR description:
-
-  - Write 1-2 sentences summarizing the change.
-  - If this PR addresses a specific issue, please include "Fixes #ISSUE_NUMBER" in the description to automatically close the issue when the PR is merged.
-  - If there are any breaking changes, please clearly describe them.
-  - If this PR depends on another PR being merged first, please include "Depends on #PR_NUMBER" inthe description.
-
-3. Run `make format`, `make lint` and `make test` from the root of the package(s) you've modified.
-
-  - We will not consider a PR unless these three are passing in CI.
-
-Additional guidelines:
-
-  - We ask that if you use generative AI for your contribution, you include a disclaimer.
-  - PRs should not touch more than one package unless absolutely necessary.
-  - Do not update the `uv.lock` files unless or add dependencies to `pyproject.toml` files (even optional ones) unless you have explicit permission to do so by a maintainer.

.github/actions/uv_setup/action.yml

@@ -1,39 +0,0 @@
-# Helper to set up Python and uv with caching
-
-name: uv-install
-description: Set up Python and uv with caching
-
-inputs:
-  python-version:
-    description: Python version, supporting MAJOR.MINOR only
-    required: true
-  enable-cache:
-    description: Enable caching for uv dependencies
-    required: false
-    default: "true"
-  cache-suffix:
-    description: Custom cache key suffix for cache invalidation
-    required: false
-    default: ""
-  working-directory:
-    description: Working directory for cache glob scoping
-    required: false
-    default: "**"
-
-env:
-  UV_VERSION: "0.5.25"
-
-runs:
-  using: composite
-  steps:
-    - name: Install uv and set the python version
-      uses: astral-sh/setup-uv@v6
-      with:
-        version: ${{ env.UV_VERSION }}
-        python-version: ${{ inputs.python-version }}
-        enable-cache: ${{ inputs.enable-cache }}
-        cache-dependency-glob: |
-          ${{ inputs.working-directory }}/pyproject.toml
-          ${{ inputs.working-directory }}/uv.lock
-          ${{ inputs.working-directory }}/requirements*.txt
-        cache-suffix: ${{ inputs.cache-suffix }}

.github/dependabot.yml

@@ -1,11 +0,0 @@
-# Please see the documentation for all configuration options:
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-# and
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"

.github/images/logo-dark.svg

@@ -1,25 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1584.81 250">
-  <defs>
-    <style>
-      .cls-1 {
-        fill: #1c3c3c;
-        stroke-width: 0px;
-      }
-    </style>
-  </defs>
-  <g id="LanChain-logo">
-    <g id="LangChain-logotype">
-      <polygon class="cls-1" points="596.33 49.07 596.33 200.67 700.76 200.67 700.76 177.78 620.04 177.78 620.04 49.07 596.33 49.07"/>
-      <path class="cls-1" d="M1126.83,49.07c-20.53,0-37.95,7.4-50.38,21.41-12.32,13.88-18.82,33.36-18.82,56.33,0,47.23,27.25,77.75,69.41,77.75,29.71,0,52.71-15.54,61.54-41.56l2.14-6.31-23.53-8.94-2.17,7.03c-5.26,17.01-18.75,26.38-37.99,26.38-27.48,0-44.55-20.82-44.55-54.34s17.23-54.34,44.97-54.34c19.23,0,30.31,7.54,35.95,24.44l2.46,7.37,22.91-10.75-2.1-5.9c-8.96-25.22-29.65-38.56-59.85-38.56Z"/>
-      <path class="cls-1" d="M756.43,85.05c-22.76,0-39.78,10.67-46.69,29.27-.44,1.19-1.77,4.78-1.77,4.78l19.51,12.62,2.65-6.91c4.52-11.78,12.88-17.27,26.3-17.27s21.1,6.51,20.96,19.33c0,.52-.04,2.09-.04,2.09,0,0-17.76,2.88-25.08,4.43-31.23,6.6-44.31,18.52-44.31,38.02,0,10.39,5.77,21.64,16.3,27.95,6.32,3.78,14.57,5.21,23.68,5.21,5.99,0,11.81-.89,17.2-2.53,12.25-4.07,15.67-12.07,15.67-12.07v10.46h20.29v-74.78c0-25.42-16.7-40.6-44.67-40.6ZM777.46,164.85c0,7.86-8.56,18.93-28.5,18.93-5.63,0-9.62-1.49-12.28-3.71-3.56-2.97-4.73-7.24-4.24-11.01.21-1.64,1.2-5.17,4.87-8.23,3.75-3.13,10.38-5.37,20.62-7.6,8.42-1.83,19.54-3.85,19.54-3.85v15.48Z"/>
-      <path class="cls-1" d="M876.11,85.04c-2.82,0-5.57.2-8.24.57-18.17,2.73-23.49,11.96-23.49,11.96l.02-9.31h-22.74s0,112.19,0,112.19h23.71v-62.18c0-21.13,15.41-30.75,29.73-30.75,15.48,0,23,8.32,23,25.45v67.48h23.71v-70.74c0-27.56-17.51-44.67-45.69-44.67Z"/>
-      <path class="cls-1" d="M1539.12,85.04c-2.82,0-5.57.2-8.24.57-18.17,2.73-23.49,11.96-23.49,11.96v-9.32h-22.72v112.2h23.71v-62.18c0-21.13,15.41-30.75,29.73-30.75,15.48,0,23,8.32,23,25.45v67.48h23.71v-70.74c0-27.56-17.51-44.67-45.69-44.67Z"/>
-      <path class="cls-1" d="M1020.76,88.26v11.55s-5.81-14.77-32.24-14.77c-32.84,0-53.24,22.66-53.24,59.15,0,20.59,6.58,36.8,18.19,47.04,9.03,7.96,21.09,12.04,35.45,12.32,9.99.19,16.46-2.53,20.5-5.1,7.76-4.94,10.64-9.63,10.64-9.63,0,0-.33,3.67-.93,8.64-.43,3.6-1.24,6.13-1.24,6.13h0c-3.61,12.85-14.17,20.28-29.57,20.28s-24.73-5.07-26.58-15.06l-23.05,6.88c3.98,19.2,22,30.66,48.2,30.66,17.81,0,31.77-4.84,41.5-14.4,9.81-9.64,14.79-23.53,14.79-41.29v-102.41h-22.42ZM1019.26,145.21c0,22.44-10.96,35.84-29.32,35.84-19.67,0-30.95-13.44-30.95-36.86s11.28-36.66,30.95-36.66c17.92,0,29.15,13.34,29.32,34.82v2.86Z"/>
-      <path class="cls-1" d="M1259.01,85.04c-2.6,0-5.13.17-7.59.49-17.88,2.79-23.14,11.9-23.14,11.9v-2.67h-.01s0-45.69,0-45.69h-23.71v151.39h23.71v-62.18c0-21.27,15.41-30.95,29.73-30.95,15.48,0,23,8.32,23,25.45v67.68h23.71v-70.94c0-27.01-17.94-44.47-45.69-44.47Z"/>
-      <circle class="cls-1" cx="1450.93" cy="64.47" r="15.37"/>
-      <path class="cls-1" d="M1439.14,88.2v56.94h0c-6.75-5.56-14.6-9.75-23.5-12.26v-7.23c0-25.42-16.7-40.6-44.67-40.6-22.76,0-39.78,10.67-46.69,29.27-.44,1.19-1.77,4.78-1.77,4.78l19.51,12.62,2.65-6.91c4.52-11.78,12.88-17.27,26.3-17.27s21.1,6.51,20.96,19.33c0,.08,0,1.15,0,2.86-10.04-.28-19.38.69-27.77,2.66,0,0,0,0,0,0-11.06,2.5-31.6,8.85-38.94,25.36-.05.11-1.13,2.96-1.13,2.96-1.06,3.28-1.59,6.84-1.59,10.7,0,10.39,5.77,21.64,16.3,27.95,6.32,3.78,14.57,5.21,23.68,5.21,5.88,0,11.6-.86,16.91-2.44,12.49-4.04,15.96-12.16,15.96-12.16v10.47h20.29v-34.27c-5.7-3.56-14.26-5.66-23.65-5.64,0,2.65,0,4.33,0,4.33,0,7.86-8.56,18.93-28.5,18.93-5.63,0-9.62-1.49-12.28-3.71-3.56-2.97-4.73-7.24-4.24-11.01.21-1.64,1.2-5.17,4.87-8.23l-.04-.11c8.42-6.89,24.97-9.64,40.17-9.04v.03c12.94.47,22.62,3.01,29.53,7.77,1.88,1.19,3.65,2.52,5.28,3.98,6.94,6.23,9.73,13.9,10.93,18.38,1.95,7.31,1.43,18.57,1.43,18.57h23.59v-112.2h-23.59Z"/>
-    </g>
-    <path id="LangChain-symbol" class="cls-1" d="M393.52,75.2c9.66,9.66,9.66,25.38,0,35.04l-21.64,21.29-.22-1.22c-1.58-8.75-5.74-16.69-12.02-22.97-4.73-4.72-10.32-8.21-16.62-10.37-3.91,3.93-6.06,9.08-6.06,14.5,0,1.1.1,2.24.3,3.38,3.47,1.25,6.54,3.18,9.12,5.76,9.66,9.66,9.66,25.38,0,35.04l-18.84,18.84c-4.83,4.83-11.17,7.24-17.52,7.24s-12.69-2.41-17.52-7.24c-9.66-9.66-9.66-25.38,0-35.04l21.64-21.28.22,1.22c1.57,8.73,5.73,16.67,12.03,22.96,4.74,4.74,9.99,7.89,16.28,10.04l1.16-1.16c3.52-3.52,5.45-8.2,5.45-13.19,0-1.11-.1-2.22-.29-3.31-3.63-1.2-6.62-2.91-9.34-5.63-3.92-3.92-6.36-8.93-7.04-14.48-.05-.4-.08-.79-.12-1.19-.54-7.23,2.07-14.29,7.16-19.37l18.84-18.84c4.67-4.67,10.89-7.25,17.52-7.25s12.85,2.57,17.52,7.25ZM491.9,125c0,68.93-56.08,125-125,125H125C56.08,250,0,193.93,0,125S56.08,0,125,0h241.9c68.93,0,125,56.08,125,125ZM240.9,187.69c1.97-2.39-7.13-9.12-8.99-11.59-3.78-4.1-3.8-10-6.35-14.79-6.24-14.46-13.41-28.81-23.44-41.05-10.6-13.39-23.68-24.47-35.17-37.04-8.53-8.77-10.81-21.26-18.34-30.69-10.38-15.33-43.2-19.51-48.01,2.14.02.68-.19,1.11-.78,1.54-2.66,1.93-5.03,4.14-7.02,6.81-4.87,6.78-5.62,18.28.46,24.37.2-3.21.31-6.24,2.85-8.54,4.7,4.03,11.8,5.46,17.25,2.45,12.04,17.19,9.04,40.97,18.6,59.49,2.64,4.38,5.3,8.85,8.69,12.69,2.75,4.28,12.25,9.33,12.81,13.29.1,6.8-.7,14.23,3.76,19.92,2.1,4.26-3.06,8.54-7.22,8.01-5.4.74-11.99-3.63-16.72-.94-1.67,1.81-4.94-.19-6.38,2.32-.5,1.3-3.2,3.13-1.59,4.38,1.79-1.36,3.45-2.78,5.86-1.97-.36,1.96,1.19,2.24,2.42,2.81-.04,1.33-.82,2.69.2,3.82,1.19-1.2,1.9-2.9,3.79-3.4,6.28,8.37,12.67-8.47,26.26-.89-2.76-.14-5.21.21-7.07,2.48-.46.51-.85,1.11-.04,1.77,7.33-4.73,7.29,1.62,12.05-.33,3.66-1.91,7.3-4.3,11.65-3.62-4.23,1.22-4.4,4.62-6.88,7.49-.42.44-.62.94-.13,1.67,8.78-.74,9.5-3.66,16.59-7.24,5.29-3.23,10.56,4.6,15.14.14,1.01-.97,2.39-.64,3.64-.77-1.6-8.53-19.19,1.56-18.91-9.88,5.66-3.85,4.36-11.22,4.74-17.17,6.51,3.61,13.75,5.71,20.13,9.16,3.22,5.2,8.27,12.07,15,11.62.18-.52.34-.98.53-1.51,2.04.35,4.66,1.7,5.78-.88,3.05,3.19,7.53,3.03,11.52,2.21,2.95-2.4-5.55-5.82-6.69-8.29ZM419.51,92.72c0-11.64-4.52-22.57-12.73-30.78-8.21-8.21-19.14-12.73-30.79-12.73s-22.58,4.52-30.79,12.73l-18.84,18.84c-4.4,4.4-7.74,9.57-9.93,15.36l-.13.33-.34.1c-6.84,2.11-12.87,5.73-17.92,10.78l-18.84,18.84c-16.97,16.98-16.97,44.6,0,61.57,8.21,8.21,19.14,12.73,30.78,12.73h0c11.64,0,22.58-4.52,30.79-12.73l18.84-18.84c4.38-4.38,7.7-9.53,9.89-15.31l.13-.33.34-.11c6.72-2.06,12.92-5.8,17.95-10.82l18.84-18.84c8.21-8.21,12.73-19.14,12.73-30.79ZM172.38,173.6c-1.62,6.32-2.15,17.09-10.37,17.4-.68,3.65,2.53,5.02,5.44,3.85,2.89-1.33,4.26,1.05,5.23,3.42,4.46.65,11.06-1.49,11.31-6.77-6.66-3.84-8.72-11.14-11.62-17.9Z"/>
-  </g>
-</svg>

.github/images/logo-light.svg

@@ -1,25 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1584.81 250">
-  <defs>
-    <style>
-      .cls-1 {
-        fill: #fff;
-        stroke-width: 0px;
-      }
-    </style>
-  </defs>
-  <g id="LanChain-logo">
-    <g id="LangChain-logotype">
-      <polygon class="cls-1" points="596.33 49.07 596.33 200.67 700.76 200.67 700.76 177.78 620.04 177.78 620.04 49.07 596.33 49.07"/>
-      <path class="cls-1" d="M1126.83,49.07c-20.53,0-37.95,7.4-50.38,21.41-12.32,13.88-18.82,33.36-18.82,56.33,0,47.23,27.25,77.75,69.41,77.75,29.71,0,52.71-15.54,61.54-41.56l2.14-6.31-23.53-8.94-2.17,7.03c-5.26,17.01-18.75,26.38-37.99,26.38-27.48,0-44.55-20.82-44.55-54.34s17.23-54.34,44.97-54.34c19.23,0,30.31,7.54,35.95,24.44l2.46,7.37,22.91-10.75-2.1-5.9c-8.96-25.22-29.65-38.56-59.85-38.56Z"/>
-      <path class="cls-1" d="M756.43,85.05c-22.76,0-39.78,10.67-46.69,29.27-.44,1.19-1.77,4.78-1.77,4.78l19.51,12.62,2.65-6.91c4.52-11.78,12.88-17.27,26.3-17.27s21.1,6.51,20.96,19.33c0,.52-.04,2.09-.04,2.09,0,0-17.76,2.88-25.08,4.43-31.23,6.6-44.31,18.52-44.31,38.02,0,10.39,5.77,21.64,16.3,27.95,6.32,3.78,14.57,5.21,23.68,5.21,5.99,0,11.81-.89,17.2-2.53,12.25-4.07,15.67-12.07,15.67-12.07v10.46h20.29v-74.78c0-25.42-16.7-40.6-44.67-40.6ZM777.46,164.85c0,7.86-8.56,18.93-28.5,18.93-5.63,0-9.62-1.49-12.28-3.71-3.56-2.97-4.73-7.24-4.24-11.01.21-1.64,1.2-5.17,4.87-8.23,3.75-3.13,10.38-5.37,20.62-7.6,8.42-1.83,19.54-3.85,19.54-3.85v15.48Z"/>
-      <path class="cls-1" d="M876.11,85.04c-2.82,0-5.57.2-8.24.57-18.17,2.73-23.49,11.96-23.49,11.96l.02-9.31h-22.74s0,112.19,0,112.19h23.71v-62.18c0-21.13,15.41-30.75,29.73-30.75,15.48,0,23,8.32,23,25.45v67.48h23.71v-70.74c0-27.56-17.51-44.67-45.69-44.67Z"/>
-      <path class="cls-1" d="M1539.12,85.04c-2.82,0-5.57.2-8.24.57-18.17,2.73-23.49,11.96-23.49,11.96v-9.32h-22.72v112.2h23.71v-62.18c0-21.13,15.41-30.75,29.73-30.75,15.48,0,23,8.32,23,25.45v67.48h23.71v-70.74c0-27.56-17.51-44.67-45.69-44.67Z"/>
-      <path class="cls-1" d="M1020.76,88.26v11.55s-5.81-14.77-32.24-14.77c-32.84,0-53.24,22.66-53.24,59.15,0,20.59,6.58,36.8,18.19,47.04,9.03,7.96,21.09,12.04,35.45,12.32,9.99.19,16.46-2.53,20.5-5.1,7.76-4.94,10.64-9.63,10.64-9.63,0,0-.33,3.67-.93,8.64-.43,3.6-1.24,6.13-1.24,6.13h0c-3.61,12.85-14.17,20.28-29.57,20.28s-24.73-5.07-26.58-15.06l-23.05,6.88c3.98,19.2,22,30.66,48.2,30.66,17.81,0,31.77-4.84,41.5-14.4,9.81-9.64,14.79-23.53,14.79-41.29v-102.41h-22.42ZM1019.26,145.21c0,22.44-10.96,35.84-29.32,35.84-19.67,0-30.95-13.44-30.95-36.86s11.28-36.66,30.95-36.66c17.92,0,29.15,13.34,29.32,34.82v2.86Z"/>
-      <path class="cls-1" d="M1259.01,85.04c-2.6,0-5.13.17-7.59.49-17.88,2.79-23.14,11.9-23.14,11.9v-2.67h-.01s0-45.69,0-45.69h-23.71v151.39h23.71v-62.18c0-21.27,15.41-30.95,29.73-30.95,15.48,0,23,8.32,23,25.45v67.68h23.71v-70.94c0-27.01-17.94-44.47-45.69-44.47Z"/>
-      <circle class="cls-1" cx="1450.93" cy="64.47" r="15.37"/>
-      <path class="cls-1" d="M1439.14,88.2v56.94h0c-6.75-5.56-14.6-9.75-23.5-12.26v-7.23c0-25.42-16.7-40.6-44.67-40.6-22.76,0-39.78,10.67-46.69,29.27-.44,1.19-1.77,4.78-1.77,4.78l19.51,12.62,2.65-6.91c4.52-11.78,12.88-17.27,26.3-17.27s21.1,6.51,20.96,19.33c0,.08,0,1.15,0,2.86-10.04-.28-19.38.69-27.77,2.66,0,0,0,0,0,0-11.06,2.5-31.6,8.85-38.94,25.36-.05.11-1.13,2.96-1.13,2.96-1.06,3.28-1.59,6.84-1.59,10.7,0,10.39,5.77,21.64,16.3,27.95,6.32,3.78,14.57,5.21,23.68,5.21,5.88,0,11.6-.86,16.91-2.44,12.49-4.04,15.96-12.16,15.96-12.16v10.47h20.29v-34.27c-5.7-3.56-14.26-5.66-23.65-5.64,0,2.65,0,4.33,0,4.33,0,7.86-8.56,18.93-28.5,18.93-5.63,0-9.62-1.49-12.28-3.71-3.56-2.97-4.73-7.24-4.24-11.01.21-1.64,1.2-5.17,4.87-8.23l-.04-.11c8.42-6.89,24.97-9.64,40.17-9.04v.03c12.94.47,22.62,3.01,29.53,7.77,1.88,1.19,3.65,2.52,5.28,3.98,6.94,6.23,9.73,13.9,10.93,18.38,1.95,7.31,1.43,18.57,1.43,18.57h23.59v-112.2h-23.59Z"/>
-    </g>
-    <path id="LangChain-symbol" class="cls-1" d="M393.52,75.2c9.66,9.66,9.66,25.38,0,35.04l-21.64,21.29-.22-1.22c-1.58-8.75-5.74-16.69-12.02-22.97-4.73-4.72-10.32-8.21-16.62-10.37-3.91,3.93-6.06,9.08-6.06,14.5,0,1.1.1,2.24.3,3.38,3.47,1.25,6.54,3.18,9.12,5.76,9.66,9.66,9.66,25.38,0,35.04l-18.84,18.84c-4.83,4.83-11.17,7.24-17.52,7.24s-12.69-2.41-17.52-7.24c-9.66-9.66-9.66-25.38,0-35.04l21.64-21.28.22,1.22c1.57,8.73,5.73,16.67,12.03,22.96,4.74,4.74,9.99,7.89,16.28,10.04l1.16-1.16c3.52-3.52,5.45-8.2,5.45-13.19,0-1.11-.1-2.22-.29-3.31-3.63-1.2-6.62-2.91-9.34-5.63-3.92-3.92-6.36-8.93-7.04-14.48-.05-.4-.08-.79-.12-1.19-.54-7.23,2.07-14.29,7.16-19.37l18.84-18.84c4.67-4.67,10.89-7.25,17.52-7.25s12.85,2.57,17.52,7.25ZM491.9,125c0,68.93-56.08,125-125,125H125C56.08,250,0,193.93,0,125S56.08,0,125,0h241.9C435.82,0,491.9,56.08,491.9,125ZM240.9,187.69c1.97-2.39-7.13-9.12-8.99-11.59-3.78-4.1-3.8-10-6.35-14.79-6.24-14.46-13.41-28.81-23.44-41.05-10.6-13.39-23.68-24.47-35.17-37.04-8.53-8.77-10.81-21.26-18.34-30.69-10.38-15.33-43.2-19.51-48.01,2.14.02.68-.19,1.11-.78,1.54-2.66,1.93-5.03,4.14-7.02,6.81-4.87,6.78-5.62,18.28.46,24.37.2-3.21.31-6.24,2.85-8.54,4.7,4.03,11.8,5.46,17.25,2.45,12.04,17.19,9.04,40.97,18.6,59.49,2.64,4.38,5.3,8.85,8.69,12.69,2.75,4.28,12.25,9.33,12.81,13.29.1,6.8-.7,14.23,3.76,19.92,2.1,4.26-3.06,8.54-7.22,8.01-5.4.74-11.99-3.63-16.72-.94-1.67,1.81-4.94-.19-6.38,2.32-.5,1.3-3.2,3.13-1.59,4.38,1.79-1.36,3.45-2.78,5.86-1.97-.36,1.96,1.19,2.24,2.42,2.81-.04,1.33-.82,2.69.2,3.82,1.19-1.2,1.9-2.9,3.79-3.4,6.28,8.37,12.67-8.47,26.26-.89-2.76-.14-5.21.21-7.07,2.48-.46.51-.85,1.11-.04,1.77,7.33-4.73,7.29,1.62,12.05-.33,3.66-1.91,7.3-4.3,11.65-3.62-4.23,1.22-4.4,4.62-6.88,7.49-.42.44-.62.94-.13,1.67,8.78-.74,9.5-3.66,16.59-7.24,5.29-3.23,10.56,4.6,15.14.14,1.01-.97,2.39-.64,3.64-.77-1.6-8.53-19.19,1.56-18.91-9.88,5.66-3.85,4.36-11.22,4.74-17.17,6.51,3.61,13.75,5.71,20.13,9.16,3.22,5.2,8.27,12.07,15,11.62.18-.52.34-.98.53-1.51,2.04.35,4.66,1.7,5.78-.88,3.05,3.19,7.53,3.03,11.52,2.21,2.95-2.4-5.55-5.82-6.69-8.29ZM419.51,92.72c0-11.64-4.52-22.57-12.73-30.78-8.21-8.21-19.14-12.73-30.79-12.73s-22.58,4.52-30.79,12.73l-18.84,18.84c-4.4,4.4-7.74,9.57-9.93,15.36l-.13.33-.34.1c-6.84,2.11-12.87,5.73-17.92,10.78l-18.84,18.84c-16.97,16.98-16.97,44.6,0,61.57,8.21,8.21,19.14,12.73,30.78,12.73h0c11.64,0,22.58-4.52,30.79-12.73l18.84-18.84c4.38-4.38,7.7-9.53,9.89-15.31l.13-.33.34-.11c6.72-2.06,12.92-5.8,17.95-10.82l18.84-18.84c8.21-8.21,12.73-19.14,12.73-30.79ZM172.38,173.6c-1.62,6.32-2.15,17.09-10.37,17.4-.68,3.65,2.53,5.02,5.44,3.85,2.89-1.33,4.26,1.05,5.23,3.42,4.46.65,11.06-1.49,11.31-6.77-6.66-3.84-8.72-11.14-11.62-17.9Z"/>
-  </g>
-</svg>

.github/pr-file-labeler.yml

@@ -1,152 +0,0 @@
-# Label PRs (config)
-# Automatically applies labels based on changed files and branch patterns
-
-# Core packages
-core:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/core/**/*"
-
-langchain-classic:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/langchain/**/*"
-
-langchain:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/langchain_v1/**/*"
-
-cli:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/cli/**/*"
-
-standard-tests:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/standard-tests/**/*"
-
-model-profiles:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/model-profiles/**/*"
-
-text-splitters:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/text-splitters/**/*"
-
-# Partner integrations
-integration:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/**/*"
-
-anthropic:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/anthropic/**/*"
-
-chroma:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/chroma/**/*"
-
-deepseek:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/deepseek/**/*"
-
-exa:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/exa/**/*"
-
-fireworks:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/fireworks/**/*"
-
-groq:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/groq/**/*"
-
-huggingface:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/huggingface/**/*"
-
-mistralai:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/mistralai/**/*"
-
-nomic:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/nomic/**/*"
-
-ollama:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/ollama/**/*"
-
-openai:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/openai/**/*"
-
-perplexity:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/perplexity/**/*"
-
-prompty:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/prompty/**/*"
-
-qdrant:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/qdrant/**/*"
-
-xai:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "libs/partners/xai/**/*"
-
-# Infrastructure and DevOps
-infra:
-  - changed-files:
-      - any-glob-to-any-file:
-          - ".github/**/*"
-          - "Makefile"
-          - ".pre-commit-config.yaml"
-          - "scripts/**/*"
-          - "docker/**/*"
-          - "Dockerfile*"
-
-github_actions:
-  - changed-files:
-      - any-glob-to-any-file:
-          - ".github/workflows/**/*"
-          - ".github/actions/**/*"
-
-dependencies:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "**/pyproject.toml"
-          - "uv.lock"
-          - "**/requirements*.txt"
-          - "**/poetry.lock"
-
-# Documentation
-documentation:
-  - changed-files:
-      - any-glob-to-any-file:
-          - "**/*.md"
-          - "**/README*"
-

.github/scripts/check_diff.py

@@ -1,340 +0,0 @@
-"""Analyze git diffs to determine which directories need to be tested.
-
-Intelligently determines which LangChain packages and directories need to be tested,
-linted, or built based on the changes. Handles dependency relationships between
-packages, maps file changes to appropriate CI job configurations, and outputs JSON
-configurations for GitHub Actions.
-
-- Maps changed files to affected package directories (libs/core, libs/partners/*, etc.)
-- Builds dependency graph to include dependent packages when core components change
-- Generates test matrix configurations with appropriate Python versions
-- Handles special cases for Pydantic version testing and performance benchmarks
-
-Used as part of the check_diffs workflow.
-"""
-
-import glob
-import json
-import os
-import sys
-from collections import defaultdict
-from pathlib import Path
-from typing import Dict, List, Set
-
-import tomllib
-from get_min_versions import get_min_version_from_toml
-from packaging.requirements import Requirement
-
-LANGCHAIN_DIRS = [
-    "libs/core",
-    "libs/text-splitters",
-    "libs/langchain",
-    "libs/langchain_v1",
-    "libs/model-profiles",
-]
-
-# When set to True, we are ignoring core dependents
-# in order to be able to get CI to pass for each individual
-# package that depends on core
-# e.g. if you touch core, we don't then add textsplitters/etc to CI
-IGNORE_CORE_DEPENDENTS = False
-
-# ignored partners are removed from dependents
-# but still run if directly edited
-IGNORED_PARTNERS = [
-    # remove huggingface from dependents because of CI instability
-    # specifically in huggingface jobs
-    # https://github.com/langchain-ai/langchain/issues/25558
-    "huggingface",
-    # prompty exhibiting issues with numpy for Python 3.13
-    # https://github.com/langchain-ai/langchain/actions/runs/12651104685/job/35251034969?pr=29065
-    "prompty",
-]
-
-
-def all_package_dirs() -> Set[str]:
-    return {
-        "/".join(path.split("/")[:-1]).lstrip("./")
-        for path in glob.glob("./libs/**/pyproject.toml", recursive=True)
-        if "libs/cli" not in path and "libs/standard-tests" not in path
-    }
-
-
-def dependents_graph() -> dict:
-    """Construct a mapping of package -> dependents
-
-    Done such that we can run tests on all dependents of a package when a change is made.
-    """
-    dependents = defaultdict(set)
-
-    for path in glob.glob("./libs/**/pyproject.toml", recursive=True):
-        if "template" in path:
-            continue
-
-        # load regular and test deps from pyproject.toml
-        with open(path, "rb") as f:
-            pyproject = tomllib.load(f)
-
-        pkg_dir = "libs" + "/".join(path.split("libs")[1].split("/")[:-1])
-        for dep in [
-            *pyproject["project"]["dependencies"],
-            *pyproject["dependency-groups"]["test"],
-        ]:
-            requirement = Requirement(dep)
-            package_name = requirement.name
-            if "langchain" in dep:
-                dependents[package_name].add(pkg_dir)
-                continue
-
-        # load extended deps from extended_testing_deps.txt
-        package_path = Path(path).parent
-        extended_requirement_path = package_path / "extended_testing_deps.txt"
-        if extended_requirement_path.exists():
-            with open(extended_requirement_path, "r") as f:
-                extended_deps = f.read().splitlines()
-                for depline in extended_deps:
-                    if depline.startswith("-e "):
-                        # editable dependency
-                        assert depline.startswith("-e ../partners/"), (
-                            "Extended test deps should only editable install partner packages"
-                        )
-                        partner = depline.split("partners/")[1]
-                        dep = f"langchain-{partner}"
-                    else:
-                        dep = depline.split("==")[0]
-
-                    if "langchain" in dep:
-                        dependents[dep].add(pkg_dir)
-
-    for k in dependents:
-        for partner in IGNORED_PARTNERS:
-            if f"libs/partners/{partner}" in dependents[k]:
-                dependents[k].remove(f"libs/partners/{partner}")
-    return dependents
-
-
-def add_dependents(dirs_to_eval: Set[str], dependents: dict) -> List[str]:
-    updated = set()
-    for dir_ in dirs_to_eval:
-        # handle core manually because it has so many dependents
-        if "core" in dir_:
-            updated.add(dir_)
-            continue
-        pkg = "langchain-" + dir_.split("/")[-1]
-        updated.update(dependents[pkg])
-        updated.add(dir_)
-    return list(updated)
-
-
-def _get_configs_for_single_dir(job: str, dir_: str) -> List[Dict[str, str]]:
-    if job == "test-pydantic":
-        return _get_pydantic_test_configs(dir_)
-
-    if job == "codspeed":
-        py_versions = ["3.13"]
-    elif dir_ == "libs/core":
-        py_versions = ["3.10", "3.11", "3.12", "3.13", "3.14"]
-    # custom logic for specific directories
-    elif dir_ in {"libs/partners/chroma"}:
-        py_versions = ["3.10", "3.13"]
-    else:
-        py_versions = ["3.10", "3.14"]
-
-    return [{"working-directory": dir_, "python-version": py_v} for py_v in py_versions]
-
-
-def _get_pydantic_test_configs(
-    dir_: str, *, python_version: str = "3.12"
-) -> List[Dict[str, str]]:
-    with open("./libs/core/uv.lock", "rb") as f:
-        core_uv_lock_data = tomllib.load(f)
-    for package in core_uv_lock_data["package"]:
-        if package["name"] == "pydantic":
-            core_max_pydantic_minor = package["version"].split(".")[1]
-            break
-
-    with open(f"./{dir_}/uv.lock", "rb") as f:
-        dir_uv_lock_data = tomllib.load(f)
-
-    for package in dir_uv_lock_data["package"]:
-        if package["name"] == "pydantic":
-            dir_max_pydantic_minor = package["version"].split(".")[1]
-            break
-
-    core_min_pydantic_version = get_min_version_from_toml(
-        "./libs/core/pyproject.toml", "release", python_version, include=["pydantic"]
-    )["pydantic"]
-    core_min_pydantic_minor = (
-        core_min_pydantic_version.split(".")[1]
-        if "." in core_min_pydantic_version
-        else "0"
-    )
-    dir_min_pydantic_version = get_min_version_from_toml(
-        f"./{dir_}/pyproject.toml", "release", python_version, include=["pydantic"]
-    ).get("pydantic", "0.0.0")
-    dir_min_pydantic_minor = (
-        dir_min_pydantic_version.split(".")[1]
-        if "." in dir_min_pydantic_version
-        else "0"
-    )
-
-    max_pydantic_minor = min(
-        int(dir_max_pydantic_minor),
-        int(core_max_pydantic_minor),
-    )
-    min_pydantic_minor = max(
-        int(dir_min_pydantic_minor),
-        int(core_min_pydantic_minor),
-    )
-
-    configs = [
-        {
-            "working-directory": dir_,
-            "pydantic-version": f"2.{v}.0",
-            "python-version": python_version,
-        }
-        for v in range(min_pydantic_minor, max_pydantic_minor + 1)
-    ]
-    return configs
-
-
-def _get_configs_for_multi_dirs(
-    job: str, dirs_to_run: Dict[str, Set[str]], dependents: dict
-) -> List[Dict[str, str]]:
-    if job == "lint":
-        dirs = add_dependents(
-            dirs_to_run["lint"] | dirs_to_run["test"] | dirs_to_run["extended-test"],
-            dependents,
-        )
-    elif job in ["test", "compile-integration-tests", "dependencies", "test-pydantic"]:
-        dirs = add_dependents(
-            dirs_to_run["test"] | dirs_to_run["extended-test"], dependents
-        )
-    elif job == "extended-tests":
-        dirs = list(dirs_to_run["extended-test"])
-    elif job == "codspeed":
-        dirs = list(dirs_to_run["codspeed"])
-    else:
-        raise ValueError(f"Unknown job: {job}")
-
-    return [
-        config for dir_ in dirs for config in _get_configs_for_single_dir(job, dir_)
-    ]
-
-
-if __name__ == "__main__":
-    files = sys.argv[1:]
-
-    dirs_to_run: Dict[str, set] = {
-        "lint": set(),
-        "test": set(),
-        "extended-test": set(),
-        "codspeed": set(),
-    }
-    docs_edited = False
-
-    if len(files) >= 300:
-        # max diff length is 300 files - there are likely files missing
-        dirs_to_run["lint"] = all_package_dirs()
-        dirs_to_run["test"] = all_package_dirs()
-        dirs_to_run["extended-test"] = set(LANGCHAIN_DIRS)
-
-    for file in files:
-        if any(
-            file.startswith(dir_)
-            for dir_ in (
-                ".github/workflows",
-                ".github/tools",
-                ".github/actions",
-                ".github/scripts/check_diff.py",
-            )
-        ):
-            # Infrastructure changes (workflows, actions, CI scripts) trigger tests on
-            # all core packages as a safety measure. This ensures that changes to CI/CD
-            # infrastructure don't inadvertently break package testing, even if the change
-            # appears unrelated (e.g., documentation build workflows). This is intentionally
-            # conservative to catch unexpected side effects from workflow modifications.
-            #
-            # Example: A PR modifying .github/workflows/api_doc_build.yml will trigger
-            # lint/test jobs for libs/core, libs/text-splitters, libs/langchain, and
-            # libs/langchain_v1, even though the workflow may only affect documentation.
-            dirs_to_run["extended-test"].update(LANGCHAIN_DIRS)
-
-        if file.startswith("libs/core"):
-            dirs_to_run["codspeed"].add("libs/core")
-        if any(file.startswith(dir_) for dir_ in LANGCHAIN_DIRS):
-            # add that dir and all dirs after in LANGCHAIN_DIRS
-            # for extended testing
-
-            found = False
-            for dir_ in LANGCHAIN_DIRS:
-                if dir_ == "libs/core" and IGNORE_CORE_DEPENDENTS:
-                    dirs_to_run["extended-test"].add(dir_)
-                    continue
-                if file.startswith(dir_):
-                    found = True
-                if found:
-                    dirs_to_run["extended-test"].add(dir_)
-        elif file.startswith("libs/standard-tests"):
-            # TODO: update to include all packages that rely on standard-tests (all partner packages)
-            # Note: won't run on external repo partners
-            dirs_to_run["lint"].add("libs/standard-tests")
-            dirs_to_run["test"].add("libs/standard-tests")
-            dirs_to_run["test"].add("libs/partners/mistralai")
-            dirs_to_run["test"].add("libs/partners/openai")
-            dirs_to_run["test"].add("libs/partners/anthropic")
-            dirs_to_run["test"].add("libs/partners/fireworks")
-            dirs_to_run["test"].add("libs/partners/groq")
-
-        elif file.startswith("libs/cli"):
-            dirs_to_run["lint"].add("libs/cli")
-            dirs_to_run["test"].add("libs/cli")
-
-        elif file.startswith("libs/partners"):
-            partner_dir = file.split("/")[2]
-            if os.path.isdir(f"libs/partners/{partner_dir}") and [
-                filename
-                for filename in os.listdir(f"libs/partners/{partner_dir}")
-                if not filename.startswith(".")
-            ] != ["README.md"]:
-                dirs_to_run["test"].add(f"libs/partners/{partner_dir}")
-                # Skip codspeed for partners without benchmarks or in IGNORED_PARTNERS
-                if partner_dir not in IGNORED_PARTNERS:
-                    dirs_to_run["codspeed"].add(f"libs/partners/{partner_dir}")
-            # Skip if the directory was deleted or is just a tombstone readme
-        elif file.startswith("libs/"):
-            # Check if this is a root-level file in libs/ (e.g., libs/README.md)
-            file_parts = file.split("/")
-            if len(file_parts) == 2:
-                # Root-level file in libs/, skip it (no tests needed)
-                continue
-            raise ValueError(
-                f"Unknown lib: {file}. check_diff.py likely needs "
-                "an update for this new library!"
-            )
-        elif file in [
-            "pyproject.toml",
-            "uv.lock",
-        ]:  # root uv files
-            docs_edited = True
-
-    dependents = dependents_graph()
-
-    # we now have dirs_by_job
-    # todo: clean this up
-    map_job_to_configs = {
-        job: _get_configs_for_multi_dirs(job, dirs_to_run, dependents)
-        for job in [
-            "lint",
-            "test",
-            "extended-tests",
-            "compile-integration-tests",
-            "dependencies",
-            "test-pydantic",
-            "codspeed",
-        ]
-    }
-
-    for key, value in map_job_to_configs.items():
-        json_output = json.dumps(value)
-        print(f"{key}={json_output}")

.github/scripts/check_prerelease_dependencies.py

@@ -1,36 +0,0 @@
-"""Check that no dependencies allow prereleases unless we're releasing a prerelease."""
-
-import sys
-
-import tomllib
-
-if __name__ == "__main__":
-    # Get the TOML file path from the command line argument
-    toml_file = sys.argv[1]
-
-    with open(toml_file, "rb") as file:
-        toml_data = tomllib.load(file)
-
-    # See if we're releasing an rc or dev version
-    version = toml_data["project"]["version"]
-    releasing_rc = "rc" in version or "dev" in version
-
-    # If not, iterate through dependencies and make sure none allow prereleases
-    if not releasing_rc:
-        dependencies = toml_data["project"]["dependencies"]
-        for dep_version in dependencies:
-            dep_version_string = (
-                dep_version["version"] if isinstance(dep_version, dict) else dep_version
-            )
-
-            if "rc" in dep_version_string:
-                raise ValueError(
-                    f"Dependency {dep_version} has a prerelease version. Please remove this."
-                )
-
-            if isinstance(dep_version, dict) and dep_version.get(
-                "allow-prereleases", False
-            ):
-                raise ValueError(
-                    f"Dependency {dep_version} has allow-prereleases set to true. Please remove this."
-                )

.github/scripts/get_min_versions.py

@@ -1,199 +0,0 @@
-"""Get minimum versions of dependencies from a pyproject.toml file."""
-
-import sys
-from collections import defaultdict
-
-if sys.version_info >= (3, 11):
-    import tomllib
-else:
-    # For Python 3.10 and below, which doesnt have stdlib tomllib
-    import tomli as tomllib
-
-import re
-from typing import List
-
-import requests
-from packaging.requirements import Requirement
-from packaging.specifiers import SpecifierSet
-from packaging.version import Version, parse
-
-MIN_VERSION_LIBS = [
-    "langchain-core",
-    "langchain",
-    "langchain-text-splitters",
-    "numpy",
-    "SQLAlchemy",
-]
-
-# some libs only get checked on release because of simultaneous changes in
-# multiple libs
-SKIP_IF_PULL_REQUEST = [
-    "langchain-core",
-    "langchain-text-splitters",
-    "langchain",
-]
-
-
-def get_pypi_versions(package_name: str) -> List[str]:
-    """Fetch all available versions for a package from PyPI.
-
-    Args:
-        package_name: Name of the package
-
-    Returns:
-        List of all available versions
-
-    Raises:
-        requests.exceptions.RequestException: If PyPI API request fails
-        KeyError: If package not found or response format unexpected
-    """
-    pypi_url = f"https://pypi.org/pypi/{package_name}/json"
-    response = requests.get(pypi_url)
-    response.raise_for_status()
-    return list(response.json()["releases"].keys())
-
-
-def get_minimum_version(package_name: str, spec_string: str) -> str | None:
-    """Find the minimum published version that satisfies the given constraints.
-
-    Args:
-        package_name: Name of the package
-        spec_string: Version specification string (e.g., ">=0.2.43,<0.4.0,!=0.3.0")
-
-    Returns:
-        Minimum compatible version or None if no compatible version found
-    """
-    # Rewrite occurrences of ^0.0.z to 0.0.z (can be anywhere in constraint string)
-    spec_string = re.sub(r"\^0\.0\.(\d+)", r"0.0.\1", spec_string)
-    # Rewrite occurrences of ^0.y.z to >=0.y.z,<0.y+1 (can be anywhere in constraint string)
-    for y in range(1, 10):
-        spec_string = re.sub(
-            rf"\^0\.{y}\.(\d+)", rf">=0.{y}.\1,<0.{y + 1}", spec_string
-        )
-    # Rewrite occurrences of ^x.y.z to >=x.y.z,<x+1.0.0 (can be anywhere in constraint string)
-    for x in range(1, 10):
-        spec_string = re.sub(
-            rf"\^{x}\.(\d+)\.(\d+)", rf">={x}.\1.\2,<{x + 1}", spec_string
-        )
-
-    spec_set = SpecifierSet(spec_string)
-    all_versions = get_pypi_versions(package_name)
-
-    valid_versions = []
-    for version_str in all_versions:
-        try:
-            version = parse(version_str)
-            if spec_set.contains(version):
-                valid_versions.append(version)
-        except ValueError:
-            continue
-
-    return str(min(valid_versions)) if valid_versions else None
-
-
-def _check_python_version_from_requirement(
-    requirement: Requirement, python_version: str
-) -> bool:
-    if not requirement.marker:
-        return True
-    else:
-        marker_str = str(requirement.marker)
-        if "python_version" in marker_str or "python_full_version" in marker_str:
-            python_version_str = "".join(
-                char
-                for char in marker_str
-                if char.isdigit() or char in (".", "<", ">", "=", ",")
-            )
-            return check_python_version(python_version, python_version_str)
-        return True
-
-
-def get_min_version_from_toml(
-    toml_path: str,
-    versions_for: str,
-    python_version: str,
-    *,
-    include: list | None = None,
-):
-    # Parse the TOML file
-    with open(toml_path, "rb") as file:
-        toml_data = tomllib.load(file)
-
-    dependencies = defaultdict(list)
-    for dep in toml_data["project"]["dependencies"]:
-        requirement = Requirement(dep)
-        dependencies[requirement.name].append(requirement)
-
-    # Initialize a dictionary to store the minimum versions
-    min_versions = {}
-
-    # Iterate over the libs in MIN_VERSION_LIBS
-    for lib in set(MIN_VERSION_LIBS + (include or [])):
-        if versions_for == "pull_request" and lib in SKIP_IF_PULL_REQUEST:
-            # some libs only get checked on release because of simultaneous
-            # changes in multiple libs
-            continue
-        # Check if the lib is present in the dependencies
-        if lib in dependencies:
-            if include and lib not in include:
-                continue
-            requirements = dependencies[lib]
-            for requirement in requirements:
-                if _check_python_version_from_requirement(requirement, python_version):
-                    version_string = str(requirement.specifier)
-                    break
-
-            # Use parse_version to get the minimum supported version from version_string
-            min_version = get_minimum_version(lib, version_string)
-
-            # Store the minimum version in the min_versions dictionary
-            min_versions[lib] = min_version
-
-    return min_versions
-
-
-def check_python_version(version_string, constraint_string):
-    """Check if the given Python version matches the given constraints.
-
-    Args:
-        version_string: A string representing the Python version (e.g. "3.8.5").
-        constraint_string: A string representing the package's Python version
-            constraints (e.g. ">=3.6, <4.0").
-
-    Returns:
-        True if the version matches the constraints
-    """
-
-    # Rewrite occurrences of ^0.0.z to 0.0.z (can be anywhere in constraint string)
-    constraint_string = re.sub(r"\^0\.0\.(\d+)", r"0.0.\1", constraint_string)
-    # Rewrite occurrences of ^0.y.z to >=0.y.z,<0.y+1.0 (can be anywhere in constraint string)
-    for y in range(1, 10):
-        constraint_string = re.sub(
-            rf"\^0\.{y}\.(\d+)", rf">=0.{y}.\1,<0.{y + 1}.0", constraint_string
-        )
-    # Rewrite occurrences of ^x.y.z to >=x.y.z,<x+1.0.0 (can be anywhere in constraint string)
-    for x in range(1, 10):
-        constraint_string = re.sub(
-            rf"\^{x}\.0\.(\d+)", rf">={x}.0.\1,<{x + 1}.0.0", constraint_string
-        )
-
-    try:
-        version = Version(version_string)
-        constraints = SpecifierSet(constraint_string)
-        return version in constraints
-    except Exception as e:
-        print(f"Error: {e}")
-        return False
-
-
-if __name__ == "__main__":
-    # Get the TOML file path from the command line argument
-    toml_file = sys.argv[1]
-    versions_for = sys.argv[2]
-    python_version = sys.argv[3]
-    assert versions_for in ["release", "pull_request"]
-
-    # Call the function to get the minimum versions
-    min_versions = get_min_version_from_toml(toml_file, versions_for, python_version)
-
-    print(" ".join([f"{lib}=={version}" for lib, version in min_versions.items()]))

.github/tools/git-restore-mtime

@@ -1,756 +0,0 @@
-#!/usr/bin/env python3
-#
-# git-restore-mtime - Change mtime of files based on commit date of last change
-#
-#    Copyright (C) 2012 Rodrigo Silva (MestreLion) <linux@rodrigosilva.com>
-#
-#    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU General Public License as published by
-#    the Free Software Foundation, either version 3 of the License, or
-#    (at your option) any later version.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU General Public License for more details.
-#
-#    You should have received a copy of the GNU General Public License
-#    along with this program. See <http://www.gnu.org/licenses/gpl.html>
-#
-# Source: https://github.com/MestreLion/git-tools
-# Version: July 13, 2023 (commit hash 5f832e72453e035fccae9d63a5056918d64476a2)
-"""
-Change the modification time (mtime) of files in work tree, based on the
-date of the most recent commit that modified the file, including renames.
-
-Ignores untracked files and uncommitted deletions, additions and renames, and
-by default modifications too.
----
-Useful prior to generating release tarballs, so each file is archived with a
-date that is similar to the date when the file was actually last modified,
-assuming the actual modification date and its commit date are close.
-"""
-
-# TODO:
-# - Add -z on git whatchanged/ls-files, so we don't deal with filename decoding
-# - When Python is bumped to 3.7, use text instead of universal_newlines on subprocess
-# - Update "Statistics for some large projects" with modern hardware and repositories.
-# - Create a README.md for git-restore-mtime alone. It deserves extensive documentation
-#   - Move Statistics there
-# - See git-extras as a good example on project structure and documentation
-
-# FIXME:
-# - When current dir is outside the worktree, e.g. using --work-tree, `git ls-files`
-#   assume any relative pathspecs are to worktree root, not the current dir. As such,
-#   relative pathspecs may not work.
-# - Renames are tricky:
-#   - R100 should not change mtime, but original name is not on filelist. Should
-#     track renames until a valid (A, M) mtime found and then set on current name.
-#   - Should set mtime for both current and original directories.
-#   - Check mode changes with unchanged blobs?
-# - Check file (A, D) for the directory mtime is not sufficient:
-#   - Renames also change dir mtime, unless rename was on a parent dir
-#   - If most recent change of all files in a dir was a Modification (M),
-#     dir might not be touched at all.
-#   - Dirs containing only subdirectories but no direct files will also
-#     not be touched. They're files' [grand]parent dir, but never their dirname().
-#   - Some solutions:
-#     - After files done, perform some dir processing for missing dirs, finding latest
-#       file (A, D, R)
-#     - Simple approach: dir mtime is the most recent child (dir or file) mtime
-#     - Use a virtual concept of "created at most at" to fill missing info, bubble up
-#       to parents and grandparents
-#   - When handling [grand]parent dirs, stay inside <pathspec>
-# - Better handling of merge commits. `-m` is plain *wrong*. `-c/--cc` is perfect, but
-#   painfully slow. First pass without merge commits is not accurate. Maybe add a new
-#   `--accurate` mode for `--cc`?
-
-if __name__ != "__main__":
-    raise ImportError("{} should not be used as a module.".format(__name__))
-
-import argparse
-import datetime
-import logging
-import os.path
-import shlex
-import signal
-import subprocess
-import sys
-import time
-
-__version__ = "2022.12+dev"
-
-# Update symlinks only if the platform supports not following them
-UPDATE_SYMLINKS = bool(os.utime in getattr(os, "supports_follow_symlinks", []))
-
-# Call os.path.normpath() only if not in a POSIX platform (Windows)
-NORMALIZE_PATHS = os.path.sep != "/"
-
-# How many files to process in each batch when re-trying merge commits
-STEPMISSING = 100
-
-# (Extra) keywords for the os.utime() call performed by touch()
-UTIME_KWS = {} if not UPDATE_SYMLINKS else {"follow_symlinks": False}
-
-
-# Command-line interface ######################################################
-
-
-def parse_args():
-    parser = argparse.ArgumentParser(description=__doc__.split("\n---")[0])
-
-    group = parser.add_mutually_exclusive_group()
-    group.add_argument(
-        "--quiet",
-        "-q",
-        dest="loglevel",
-        action="store_const",
-        const=logging.WARNING,
-        default=logging.INFO,
-        help="Suppress informative messages and summary statistics.",
-    )
-    group.add_argument(
-        "--verbose",
-        "-v",
-        action="count",
-        help="""
-        Print additional information for each processed file.
-        Specify twice to further increase verbosity.
-        """,
-    )
-
-    parser.add_argument(
-        "--cwd",
-        "-C",
-        metavar="DIRECTORY",
-        help="""
-        Run as if %(prog)s was started in directory %(metavar)s.
-        This affects how --work-tree, --git-dir and PATHSPEC arguments are handled.
-        See 'man 1 git' or 'git --help' for more information.
-        """,
-    )
-
-    parser.add_argument(
-        "--git-dir",
-        dest="gitdir",
-        metavar="GITDIR",
-        help="""
-        Path to the git repository, by default auto-discovered by searching
-        the current directory and its parents for a .git/ subdirectory.
-        """,
-    )
-
-    parser.add_argument(
-        "--work-tree",
-        dest="workdir",
-        metavar="WORKTREE",
-        help="""
-        Path to the work tree root, by default the parent of GITDIR if it's
-        automatically discovered, or the current directory if GITDIR is set.
-        """,
-    )
-
-    parser.add_argument(
-        "--force",
-        "-f",
-        default=False,
-        action="store_true",
-        help="""
-        Force updating files with uncommitted modifications.
-        Untracked files and uncommitted deletions, renames and additions are
-        always ignored.
-        """,
-    )
-
-    parser.add_argument(
-        "--merge",
-        "-m",
-        default=False,
-        action="store_true",
-        help="""
-        Include merge commits.
-        Leads to more recent times and more files per commit, thus with the same
-        time, which may or may not be what you want.
-        Including merge commits may lead to fewer commits being evaluated as files
-        are found sooner, which can improve performance, sometimes substantially.
-        But as merge commits are usually huge, processing them may also take longer.
-        By default, merge commits are only used for files missing from regular commits.
-        """,
-    )
-
-    parser.add_argument(
-        "--first-parent",
-        default=False,
-        action="store_true",
-        help="""
-        Consider only the first parent, the "main branch", when evaluating merge commits.
-        Only effective when merge commits are processed, either when --merge is
-        used or when finding missing files after the first regular log search.
-        See --skip-missing.
-        """,
-    )
-
-    parser.add_argument(
-        "--skip-missing",
-        "-s",
-        dest="missing",
-        default=True,
-        action="store_false",
-        help="""
-        Do not try to find missing files.
-        If merge commits were not evaluated with --merge and some files were
-        not found in regular commits, by default %(prog)s searches for these
-        files again in the merge commits.
-        This option disables this retry, so files found only in merge commits
-        will not have their timestamp updated.
-        """,
-    )
-
-    parser.add_argument(
-        "--no-directories",
-        "-D",
-        dest="dirs",
-        default=True,
-        action="store_false",
-        help="""
-        Do not update directory timestamps.
-        By default, use the time of its most recently created, renamed or deleted file.
-        Note that just modifying a file will NOT update its directory time.
-        """,
-    )
-
-    parser.add_argument(
-        "--test",
-        "-t",
-        default=False,
-        action="store_true",
-        help="Test run: do not actually update any file timestamp.",
-    )
-
-    parser.add_argument(
-        "--commit-time",
-        "-c",
-        dest="commit_time",
-        default=False,
-        action="store_true",
-        help="Use commit time instead of author time.",
-    )
-
-    parser.add_argument(
-        "--oldest-time",
-        "-o",
-        dest="reverse_order",
-        default=False,
-        action="store_true",
-        help="""
-        Update times based on the oldest, instead of the most recent commit of a file.
-        This reverses the order in which the git log is processed to emulate a
-        file "creation" date. Note this will be inaccurate for files deleted and
-        re-created at later dates.
-        """,
-    )
-
-    parser.add_argument(
-        "--skip-older-than",
-        metavar="SECONDS",
-        type=int,
-        help="""
-        Ignore files that are currently older than %(metavar)s.
-        Useful in workflows that assume such files already have a correct timestamp,
-        as it may improve performance by processing fewer files.
-        """,
-    )
-
-    parser.add_argument(
-        "--skip-older-than-commit",
-        "-N",
-        default=False,
-        action="store_true",
-        help="""
-        Ignore files older than the timestamp it would be updated to.
-        Such files may be considered "original", likely in the author's repository.
-        """,
-    )
-
-    parser.add_argument(
-        "--unique-times",
-        default=False,
-        action="store_true",
-        help="""
-        Set the microseconds to a unique value per commit.
-        Allows telling apart changes that would otherwise have identical timestamps,
-        as git's time accuracy is in seconds.
-        """,
-    )
-
-    parser.add_argument(
-        "pathspec",
-        nargs="*",
-        metavar="PATHSPEC",
-        help="""
-        Only modify paths matching %(metavar)s, relative to current directory.
-        By default, update all but untracked files and submodules.
-        """,
-    )
-
-    parser.add_argument(
-        "--version",
-        "-V",
-        action="version",
-        version="%(prog)s version {version}".format(version=get_version()),
-    )
-
-    args_ = parser.parse_args()
-    if args_.verbose:
-        args_.loglevel = max(logging.TRACE, logging.DEBUG // args_.verbose)
-    args_.debug = args_.loglevel <= logging.DEBUG
-    return args_
-
-
-def get_version(version=__version__):
-    if not version.endswith("+dev"):
-        return version
-    try:
-        cwd = os.path.dirname(os.path.realpath(__file__))
-        return Git(cwd=cwd, errors=False).describe().lstrip("v")
-    except Git.Error:
-        return "-".join((version, "unknown"))
-
-
-# Helper functions ############################################################
-
-
-def setup_logging():
-    """Add TRACE logging level and corresponding method, return the root logger"""
-    logging.TRACE = TRACE = logging.DEBUG // 2
-    logging.Logger.trace = lambda _, m, *a, **k: _.log(TRACE, m, *a, **k)
-    return logging.getLogger()
-
-
-def normalize(path):
-    r"""Normalize paths from git, handling non-ASCII characters.
-
-    Git stores paths as UTF-8 normalization form C.
-    If path contains non-ASCII or non-printable characters, git outputs the UTF-8
-    in octal-escaped notation, escaping double-quotes and backslashes, and then
-    double-quoting the whole path.
-    https://git-scm.com/docs/git-config#Documentation/git-config.txt-corequotePath
-
-    This function reverts this encoding, so:
-    normalize(r'"Back\\slash_double\"quote_a\303\247a\303\255"') =>
-        r'Back\slash_double"quote_açaí')
-
-    Paths with invalid UTF-8 encoding, such as single 0x80-0xFF bytes (e.g, from
-    Latin1/Windows-1251 encoding) are decoded using surrogate escape, the same
-    method used by Python for filesystem paths. So 0xE6 ("æ" in Latin1, r'\\346'
-    from Git) is decoded as "\udce6". See https://peps.python.org/pep-0383/ and
-    https://vstinner.github.io/painful-history-python-filesystem-encoding.html
-
-    Also see notes on `windows/non-ascii-paths.txt` about path encodings on
-    non-UTF-8 platforms and filesystems.
-    """
-    if path and path[0] == '"':
-        # Python 2: path = path[1:-1].decode("string-escape")
-        # Python 3: https://stackoverflow.com/a/46650050/624066
-        path = (
-            path[1:-1]  # Remove enclosing double quotes
-            .encode("latin1")  # Convert to bytes, required by 'unicode-escape'
-            .decode("unicode-escape")  # Perform the actual octal-escaping decode
-            .encode("latin1")  # 1:1 mapping to bytes, UTF-8 encoded
-            .decode("utf8", "surrogateescape")
-        )  # Decode from UTF-8
-    if NORMALIZE_PATHS:
-        # Make sure the slash matches the OS; for Windows we need a backslash
-        path = os.path.normpath(path)
-    return path
-
-
-def dummy(*_args, **_kwargs):
-    """No-op function used in dry-run tests"""
-
-
-def touch(path, mtime):
-    """The actual mtime update"""
-    os.utime(path, (mtime, mtime), **UTIME_KWS)
-
-
-def touch_ns(path, mtime_ns):
-    """The actual mtime update, using nanoseconds for unique timestamps"""
-    os.utime(path, None, ns=(mtime_ns, mtime_ns), **UTIME_KWS)
-
-
-def isodate(secs: int):
-    # time.localtime() accepts floats, but discards fractional part
-    return time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(secs))
-
-
-def isodate_ns(ns: int):
-    # for integers fromtimestamp() is equivalent and ~16% slower than isodate()
-    return datetime.datetime.fromtimestamp(ns / 1000000000).isoformat(sep=" ")
-
-
-def get_mtime_ns(secs: int, idx: int):
-    # Time resolution for filesystems and functions:
-    # ext-4 and other POSIX filesystems: 1 nanosecond
-    # NTFS (Windows default): 100 nanoseconds
-    # datetime.datetime() (due to 64-bit float epoch): 1 microsecond
-    us = idx % 1000000  # 10**6
-    return 1000 * (1000000 * secs + us)
-
-
-def get_mtime_path(path):
-    return os.path.getmtime(path)
-
-
-# Git class and parse_log(), the heart of the script ##########################
-
-
-class Git:
-    def __init__(self, workdir=None, gitdir=None, cwd=None, errors=True):
-        self.gitcmd = ["git"]
-        self.errors = errors
-        self._proc = None
-        if workdir:
-            self.gitcmd.extend(("--work-tree", workdir))
-        if gitdir:
-            self.gitcmd.extend(("--git-dir", gitdir))
-        if cwd:
-            self.gitcmd.extend(("-C", cwd))
-        self.workdir, self.gitdir = self._get_repo_dirs()
-
-    def ls_files(self, paths: list = None):
-        return (normalize(_) for _ in self._run("ls-files --full-name", paths))
-
-    def ls_dirty(self, force=False):
-        return (
-            normalize(_[3:].split(" -> ", 1)[-1])
-            for _ in self._run("status --porcelain")
-            if _[:2] != "??" and (not force or (_[0] in ("R", "A") or _[1] == "D"))
-        )
-
-    def log(
-        self,
-        merge=False,
-        first_parent=False,
-        commit_time=False,
-        reverse_order=False,
-        paths: list = None,
-    ):
-        cmd = "whatchanged --pretty={}".format("%ct" if commit_time else "%at")
-        if merge:
-            cmd += " -m"
-        if first_parent:
-            cmd += " --first-parent"
-        if reverse_order:
-            cmd += " --reverse"
-        return self._run(cmd, paths)
-
-    def describe(self):
-        return self._run("describe --tags", check=True)[0]
-
-    def terminate(self):
-        if self._proc is None:
-            return
-        try:
-            self._proc.terminate()
-        except OSError:
-            # Avoid errors on OpenBSD
-            pass
-
-    def _get_repo_dirs(self):
-        return (
-            os.path.normpath(_)
-            for _ in self._run(
-                "rev-parse --show-toplevel --absolute-git-dir", check=True
-            )
-        )
-
-    def _run(self, cmdstr: str, paths: list = None, output=True, check=False):
-        cmdlist = self.gitcmd + shlex.split(cmdstr)
-        if paths:
-            cmdlist.append("--")
-            cmdlist.extend(paths)
-        popen_args = dict(universal_newlines=True, encoding="utf8")
-        if not self.errors:
-            popen_args["stderr"] = subprocess.DEVNULL
-        log.trace("Executing: %s", " ".join(cmdlist))
-        if not output:
-            return subprocess.call(cmdlist, **popen_args)
-        if check:
-            try:
-                stdout: str = subprocess.check_output(cmdlist, **popen_args)
-                return stdout.splitlines()
-            except subprocess.CalledProcessError as e:
-                raise self.Error(e.returncode, e.cmd, e.output, e.stderr)
-        self._proc = subprocess.Popen(cmdlist, stdout=subprocess.PIPE, **popen_args)
-        return (_.rstrip() for _ in self._proc.stdout)
-
-    def __del__(self):
-        self.terminate()
-
-    class Error(subprocess.CalledProcessError):
-        """Error from git executable"""
-
-
-def parse_log(filelist, dirlist, stats, git, merge=False, filterlist=None):
-    mtime = 0
-    datestr = isodate(0)
-    for line in git.log(
-        merge, args.first_parent, args.commit_time, args.reverse_order, filterlist
-    ):
-        stats["loglines"] += 1
-
-        # Blank line between Date and list of files
-        if not line:
-            continue
-
-        # Date line
-        if line[0] != ":":  # Faster than `not line.startswith(':')`
-            stats["commits"] += 1
-            mtime = int(line)
-            if args.unique_times:
-                mtime = get_mtime_ns(mtime, stats["commits"])
-            if args.debug:
-                datestr = isodate(mtime)
-            continue
-
-        # File line: three tokens if it describes a renaming, otherwise two
-        tokens = line.split("\t")
-
-        # Possible statuses:
-        # M: Modified (content changed)
-        # A: Added (created)
-        # D: Deleted
-        # T: Type changed: to/from regular file, symlinks, submodules
-        # R099: Renamed (moved), with % of unchanged content. 100 = pure rename
-        # Not possible in log: C=Copied, U=Unmerged, X=Unknown, B=pairing Broken
-        status = tokens[0].split(" ")[-1]
-        file = tokens[-1]
-
-        # Handles non-ASCII chars and OS path separator
-        file = normalize(file)
-
-        def do_file():
-            if args.skip_older_than_commit and get_mtime_path(file) <= mtime:
-                stats["skip"] += 1
-                return
-            if args.debug:
-                log.debug(
-                    "%d\t%d\t%d\t%s\t%s",
-                    stats["loglines"],
-                    stats["commits"],
-                    stats["files"],
-                    datestr,
-                    file,
-                )
-            try:
-                touch(os.path.join(git.workdir, file), mtime)
-                stats["touches"] += 1
-            except Exception as e:
-                log.error("ERROR: %s: %s", e, file)
-                stats["errors"] += 1
-
-        def do_dir():
-            if args.debug:
-                log.debug(
-                    "%d\t%d\t-\t%s\t%s",
-                    stats["loglines"],
-                    stats["commits"],
-                    datestr,
-                    "{}/".format(dirname or "."),
-                )
-            try:
-                touch(os.path.join(git.workdir, dirname), mtime)
-                stats["dirtouches"] += 1
-            except Exception as e:
-                log.error("ERROR: %s: %s", e, dirname)
-                stats["direrrors"] += 1
-
-        if file in filelist:
-            stats["files"] -= 1
-            filelist.remove(file)
-            do_file()
-
-        if args.dirs and status in ("A", "D"):
-            dirname = os.path.dirname(file)
-            if dirname in dirlist:
-                dirlist.remove(dirname)
-                do_dir()
-
-        # All files done?
-        if not stats["files"]:
-            git.terminate()
-            return
-
-
-# Main Logic ##################################################################
-
-
-def main():
-    start = time.time()  # yes, Wall time. CPU time is not realistic for users.
-    stats = {
-        _: 0
-        for _ in (
-            "loglines",
-            "commits",
-            "touches",
-            "skip",
-            "errors",
-            "dirtouches",
-            "direrrors",
-        )
-    }
-
-    logging.basicConfig(level=args.loglevel, format="%(message)s")
-    log.trace("Arguments: %s", args)
-
-    # First things first: Where and Who are we?
-    if args.cwd:
-        log.debug("Changing directory: %s", args.cwd)
-        try:
-            os.chdir(args.cwd)
-        except OSError as e:
-            log.critical(e)
-            return e.errno
-    # Using both os.chdir() and `git -C` is redundant, but might prevent side effects
-    # `git -C` alone could be enough if we make sure that:
-    # - all paths, including args.pathspec, are processed by git: ls-files, rev-parse
-    # - touch() / os.utime() path argument is always prepended with git.workdir
-    try:
-        git = Git(workdir=args.workdir, gitdir=args.gitdir, cwd=args.cwd)
-    except Git.Error as e:
-        # Not in a git repository, and git already informed user on stderr. So we just...
-        return e.returncode
-
-    # Get the files managed by git and build file list to be processed
-    if UPDATE_SYMLINKS and not args.skip_older_than:
-        filelist = set(git.ls_files(args.pathspec))
-    else:
-        filelist = set()
-        for path in git.ls_files(args.pathspec):
-            fullpath = os.path.join(git.workdir, path)
-
-            # Symlink (to file, to dir or broken - git handles the same way)
-            if not UPDATE_SYMLINKS and os.path.islink(fullpath):
-                log.warning(
-                    "WARNING: Skipping symlink, no OS support for updates: %s", path
-                )
-                continue
-
-            # skip files which are older than given threshold
-            if (
-                args.skip_older_than
-                and start - get_mtime_path(fullpath) > args.skip_older_than
-            ):
-                continue
-
-            # Always add files relative to worktree root
-            filelist.add(path)
-
-    # If --force, silently ignore uncommitted deletions (not in the filesystem)
-    # and renames / additions (will not be found in log anyway)
-    if args.force:
-        filelist -= set(git.ls_dirty(force=True))
-    # Otherwise, ignore any dirty files
-    else:
-        dirty = set(git.ls_dirty())
-        if dirty:
-            log.warning(
-                "WARNING: Modified files in the working directory were ignored."
-                "\nTo include such files, commit your changes or use --force."
-            )
-            filelist -= dirty
-
-    # Build dir list to be processed
-    dirlist = set(os.path.dirname(_) for _ in filelist) if args.dirs else set()
-
-    stats["totalfiles"] = stats["files"] = len(filelist)
-    log.info("{0:,} files to be processed in work dir".format(stats["totalfiles"]))
-
-    if not filelist:
-        # Nothing to do. Exit silently and without errors, just like git does
-        return
-
-    # Process the log until all files are 'touched'
-    log.debug("Line #\tLog #\tF.Left\tModification Time\tFile Name")
-    parse_log(filelist, dirlist, stats, git, args.merge, args.pathspec)
-
-    # Missing files
-    if filelist:
-        # Try to find them in merge logs, if not done already
-        # (usually HUGE, thus MUCH slower!)
-        if args.missing and not args.merge:
-            filterlist = list(filelist)
-            missing = len(filterlist)
-            log.info(
-                "{0:,} files not found in log, trying merge commits".format(missing)
-            )
-            for i in range(0, missing, STEPMISSING):
-                parse_log(
-                    filelist,
-                    dirlist,
-                    stats,
-                    git,
-                    merge=True,
-                    filterlist=filterlist[i : i + STEPMISSING],
-                )
-
-        # Still missing some?
-        for file in filelist:
-            log.warning("WARNING: not found in the log: %s", file)
-
-    # Final statistics
-    # Suggestion: use git-log --before=mtime to brag about skipped log entries
-    def log_info(msg, *a, width=13):
-        ifmt = "{:%d,}" % (width,)  # not using 'n' for consistency with ffmt
-        ffmt = "{:%d,.2f}" % (width,)
-        # %-formatting lacks a thousand separator, must pre-render with .format()
-        log.info(msg.replace("%d", ifmt).replace("%f", ffmt).format(*a))
-
-    log_info(
-        "Statistics:\n%f seconds\n%d log lines processed\n%d commits evaluated",
-        time.time() - start,
-        stats["loglines"],
-        stats["commits"],
-    )
-
-    if args.dirs:
-        if stats["direrrors"]:
-            log_info("%d directory update errors", stats["direrrors"])
-        log_info("%d directories updated", stats["dirtouches"])
-
-    if stats["touches"] != stats["totalfiles"]:
-        log_info("%d files", stats["totalfiles"])
-    if stats["skip"]:
-        log_info("%d files skipped", stats["skip"])
-    if stats["files"]:
-        log_info("%d files missing", stats["files"])
-    if stats["errors"]:
-        log_info("%d file update errors", stats["errors"])
-
-    log_info("%d files updated", stats["touches"])
-
-    if args.test:
-        log.info("TEST RUN - No files modified!")
-
-
-# Keep only essential, global assignments here. Any other logic must be in main()
-log = setup_logging()
-args = parse_args()
-
-# Set the actual touch() and other functions based on command-line arguments
-if args.unique_times:
-    touch = touch_ns
-    isodate = isodate_ns
-
-# Make sure this is always set last to ensure --test behaves as intended
-if args.test:
-    touch = dummy
-
-# UI done, it's showtime!
-try:
-    sys.exit(main())
-except KeyboardInterrupt:
-    log.info("\nAborting")
-    signal.signal(signal.SIGINT, signal.SIG_DFL)
-    os.kill(os.getpid(), signal.SIGINT)

.github/workflows/_compile_integration_test.yml

@@ -1,65 +0,0 @@
-# Validates that a package's integration tests compile without syntax or import errors.
-#
-# (If an integration test fails to compile, it won't run.)
-#
-# Called as part of check_diffs.yml workflow
-#
-# Runs pytest with compile marker to check syntax/imports.
-
-name: "🔗 Compile Integration Tests"
-
-on:
-  workflow_call:
-    inputs:
-      working-directory:
-        required: true
-        type: string
-        description: "From which folder this pipeline executes"
-      python-version:
-        required: true
-        type: string
-        description: "Python version to use"
-
-permissions:
-  contents: read
-
-env:
-  UV_FROZEN: "true"
-
-jobs:
-  build:
-    defaults:
-      run:
-        working-directory: ${{ inputs.working-directory }}
-    runs-on: ubuntu-latest
-    timeout-minutes: 20
-    name: "Python ${{ inputs.python-version }}"
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: "🐍 Set up Python ${{ inputs.python-version }} + UV"
-        uses: "./.github/actions/uv_setup"
-        with:
-          python-version: ${{ inputs.python-version }}
-          cache-suffix: compile-integration-tests-${{ inputs.working-directory }}
-          working-directory: ${{ inputs.working-directory }}
-
-      - name: "📦 Install Integration Dependencies"
-        shell: bash
-        run: uv sync --group test --group test_integration
-
-      - name: "🔗 Check Integration Tests Compile"
-        shell: bash
-        run: uv run pytest -m compile tests/integration_tests
-
-      - name: "🧹 Verify Clean Working Directory"
-        shell: bash
-        run: |
-          set -eu
-
-          STATUS="$(git status)"
-          echo "$STATUS"
-
-          # grep will exit non-zero if the target message isn't found,
-          # and `set -e` above will cause the step to fail.
-          echo "$STATUS" | grep 'nothing to commit, working tree clean'

.github/workflows/_lint.yml

@@ -1,75 +0,0 @@
-# Runs linting.
-#
-# Uses the package's Makefile to run the checks, specifically the
-# `lint_package` and `lint_tests` targets.
-#
-# Called as part of check_diffs.yml workflow.
-
-name: "🧹 Linting"
-
-on:
-  workflow_call:
-    inputs:
-      working-directory:
-        required: true
-        type: string
-        description: "From which folder this pipeline executes"
-      python-version:
-        required: true
-        type: string
-        description: "Python version to use"
-
-permissions:
-  contents: read
-
-env:
-  WORKDIR: ${{ inputs.working-directory == '' && '.' || inputs.working-directory }}
-
-  # This env var allows us to get inline annotations when ruff has complaints.
-  RUFF_OUTPUT_FORMAT: github
-
-  UV_FROZEN: "true"
-
-jobs:
-  # Linting job - runs quality checks on package and test code
-  build:
-    name: "Python ${{ inputs.python-version }}"
-    runs-on: ubuntu-latest
-    timeout-minutes: 20
-    steps:
-      - name: "📋 Checkout Code"
-        uses: actions/checkout@v6
-
-      - name: "🐍 Set up Python ${{ inputs.python-version }} + UV"
-        uses: "./.github/actions/uv_setup"
-        with:
-          python-version: ${{ inputs.python-version }}
-          cache-suffix: lint-${{ inputs.working-directory }}
-          working-directory: ${{ inputs.working-directory }}
-
-      - name: "📦 Install Lint & Typing Dependencies"
-        working-directory: ${{ inputs.working-directory }}
-        run: |
-          uv sync --group lint --group typing
-
-      - name: "🔍 Analyze Package Code with Linters"
-        working-directory: ${{ inputs.working-directory }}
-        run: |
-          make lint_package
-
-      - name: "📦 Install Test Dependencies (non-partners)"
-        # (For directories NOT starting with libs/partners/)
-        if: ${{ ! startsWith(inputs.working-directory, 'libs/partners/') }}
-        working-directory: ${{ inputs.working-directory }}
-        run: |
-          uv sync --inexact --group test
-      - name: "📦 Install Test Dependencies"
-        if: ${{ startsWith(inputs.working-directory, 'libs/partners/') }}
-        working-directory: ${{ inputs.working-directory }}
-        run: |
-          uv sync --inexact --group test --group test_integration
-
-      - name: "🔍 Analyze Test Code with Linters"
-        working-directory: ${{ inputs.working-directory }}
-        run: |
-          make lint_tests

.github/workflows/_release.yml

@@ -1,556 +0,0 @@
-# Builds and publishes LangChain packages to PyPI.
-#
-# Manually triggered, though can be used as a reusable workflow (workflow_call).
-#
-# Handles version bumping, building, and publishing to PyPI with authentication.
-
-name: "🚀 Package Release"
-run-name: "Release ${{ inputs.working-directory }} ${{ inputs.release-version }}"
-on:
-  workflow_call:
-    inputs:
-      working-directory:
-        required: true
-        type: string
-        description: "From which folder this pipeline executes"
-  workflow_dispatch:
-    inputs:
-      working-directory:
-        required: true
-        type: string
-        description: "From which folder this pipeline executes"
-        default: "libs/langchain_v1"
-      release-version:
-        required: true
-        type: string
-        default: "0.1.0"
-        description: "New version of package being released"
-      dangerous-nonmaster-release:
-        required: false
-        type: boolean
-        default: false
-        description: "Release from a non-master branch (danger!) - Only use for hotfixes"
-
-env:
-  PYTHON_VERSION: "3.11"
-  UV_FROZEN: "true"
-  UV_NO_SYNC: "true"
-
-permissions:
-  contents: write # Required for creating GitHub releases
-
-jobs:
-  # Build the distribution package and extract version info
-  # Runs in isolated environment with minimal permissions for security
-  build:
-    if: github.ref == 'refs/heads/master' || inputs.dangerous-nonmaster-release
-    environment: Scheduled testing
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-
-    outputs:
-      pkg-name: ${{ steps.check-version.outputs.pkg-name }}
-      version: ${{ steps.check-version.outputs.version }}
-
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Set up Python + uv
-        uses: "./.github/actions/uv_setup"
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-
-      # We want to keep this build stage *separate* from the release stage,
-      # so that there's no sharing of permissions between them.
-      # (Release stage has trusted publishing and GitHub repo contents write access,
-      #
-      # Otherwise, a malicious `build` step (e.g. via a compromised dependency)
-      # could get access to our GitHub or PyPI credentials.
-      #
-      # Per the trusted publishing GitHub Action:
-      # > It is strongly advised to separate jobs for building [...]
-      # > from the publish job.
-      # https://github.com/pypa/gh-action-pypi-publish#non-goals
-      - name: Build project for distribution
-        run: uv build
-        working-directory: ${{ inputs.working-directory }}
-
-      - name: Upload build
-        uses: actions/upload-artifact@v5
-        with:
-          name: dist
-          path: ${{ inputs.working-directory }}/dist/
-
-      - name: Check version
-        id: check-version
-        shell: python
-        working-directory: ${{ inputs.working-directory }}
-        run: |
-          import os
-          import tomllib
-          with open("pyproject.toml", "rb") as f:
-              data = tomllib.load(f)
-          pkg_name = data["project"]["name"]
-          version = data["project"]["version"]
-          with open(os.environ["GITHUB_OUTPUT"], "a") as f:
-              f.write(f"pkg-name={pkg_name}\n")
-              f.write(f"version={version}\n")
-  release-notes:
-    needs:
-      - build
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    outputs:
-      release-body: ${{ steps.generate-release-body.outputs.release-body }}
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          repository: langchain-ai/langchain
-          path: langchain
-          sparse-checkout: | # this only grabs files for relevant dir
-            ${{ inputs.working-directory }}
-          ref: ${{ github.ref }} # this scopes to just ref'd branch
-          fetch-depth: 0 # this fetches entire commit history
-      - name: Check tags
-        id: check-tags
-        shell: bash
-        working-directory: langchain/${{ inputs.working-directory }}
-        env:
-          PKG_NAME: ${{ needs.build.outputs.pkg-name }}
-          VERSION: ${{ needs.build.outputs.version }}
-        run: |
-          # Handle regular versions and pre-release versions differently
-          if [[ "$VERSION" == *"-"* ]]; then
-            # This is a pre-release version (contains a hyphen)
-            # Extract the base version without the pre-release suffix
-            BASE_VERSION=${VERSION%%-*}
-            # Look for the latest release of the same base version
-            REGEX="^$PKG_NAME==$BASE_VERSION\$"
-            PREV_TAG=$(git tag --sort=-creatordate | (grep -P "$REGEX" || true) | head -1)
-
-            # If no exact base version match, look for the latest release of any kind
-            if [ -z "$PREV_TAG" ]; then
-              REGEX="^$PKG_NAME==\\d+\\.\\d+\\.\\d+\$"
-              PREV_TAG=$(git tag --sort=-creatordate | (grep -P "$REGEX" || true) | head -1)
-            fi
-          else
-            # Regular version handling
-            PREV_TAG="$PKG_NAME==${VERSION%.*}.$(( ${VERSION##*.} - 1 ))"; [[ "${VERSION##*.}" -eq 0 ]] && PREV_TAG=""
-
-            # backup case if releasing e.g. 0.3.0, looks up last release
-            # note if last release (chronologically) was e.g. 0.1.47 it will get
-            # that instead of the last 0.2 release
-            if [ -z "$PREV_TAG" ]; then
-              REGEX="^$PKG_NAME==\\d+\\.\\d+\\.\\d+\$"
-              echo $REGEX
-              PREV_TAG=$(git tag --sort=-creatordate | (grep -P $REGEX || true) | head -1)
-            fi
-          fi
-
-          # if PREV_TAG is empty or came out to 0.0.0, let it be empty
-          if [ -z "$PREV_TAG" ] || [ "$PREV_TAG" = "$PKG_NAME==0.0.0" ]; then
-            echo "No previous tag found - first release"
-          else
-            # confirm prev-tag actually exists in git repo with git tag
-            GIT_TAG_RESULT=$(git tag -l "$PREV_TAG")
-            if [ -z "$GIT_TAG_RESULT" ]; then
-              echo "Previous tag $PREV_TAG not found in git repo"
-              exit 1
-            fi
-          fi
-
-
-          TAG="${PKG_NAME}==${VERSION}"
-          if [ "$TAG" == "$PREV_TAG" ]; then
-            echo "No new version to release"
-            exit 1
-          fi
-          echo tag="$TAG" >> $GITHUB_OUTPUT
-          echo prev-tag="$PREV_TAG" >> $GITHUB_OUTPUT
-      - name: Generate release body
-        id: generate-release-body
-        working-directory: langchain
-        env:
-          WORKING_DIR: ${{ inputs.working-directory }}
-          PKG_NAME: ${{ needs.build.outputs.pkg-name }}
-          TAG: ${{ steps.check-tags.outputs.tag }}
-          PREV_TAG: ${{ steps.check-tags.outputs.prev-tag }}
-        run: |
-          PREAMBLE="Changes since $PREV_TAG"
-          # if PREV_TAG is empty or 0.0.0, then we are releasing the first version
-          if [ -z "$PREV_TAG" ] || [ "$PREV_TAG" = "$PKG_NAME==0.0.0" ]; then
-            PREAMBLE="Initial release"
-            PREV_TAG=$(git rev-list --max-parents=0 HEAD)
-          fi
-          {
-            echo 'release-body<<EOF'
-            echo $PREAMBLE
-            echo
-            git log --format="%s" "$PREV_TAG"..HEAD -- $WORKING_DIR
-            echo EOF
-          } >> "$GITHUB_OUTPUT"
-
-  test-pypi-publish:
-    needs:
-      - build
-      - release-notes
-    runs-on: ubuntu-latest
-    permissions:
-      # This permission is used for trusted publishing:
-      # https://blog.pypi.org/posts/2023-04-20-introducing-trusted-publishers/
-      #
-      # Trusted publishing has to also be configured on PyPI for each package:
-      # https://docs.pypi.org/trusted-publishers/adding-a-publisher/
-      id-token: write
-
-    steps:
-      - uses: actions/checkout@v6
-
-      - uses: actions/download-artifact@v6
-        with:
-          name: dist
-          path: ${{ inputs.working-directory }}/dist/
-
-      - name: Publish to test PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          packages-dir: ${{ inputs.working-directory }}/dist/
-          verbose: true
-          print-hash: true
-          repository-url: https://test.pypi.org/legacy/
-          # We overwrite any existing distributions with the same name and version.
-          # This is *only for CI use* and is *extremely dangerous* otherwise!
-          # https://github.com/pypa/gh-action-pypi-publish#tolerating-release-package-file-duplicates
-          skip-existing: true
-          # Temp workaround since attestations are on by default as of gh-action-pypi-publish v1.11.0
-          attestations: false
-
-  pre-release-checks:
-    needs:
-      - build
-      - release-notes
-      - test-pypi-publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    timeout-minutes: 20
-    steps:
-      - uses: actions/checkout@v6
-
-      # We explicitly *don't* set up caching here. This ensures our tests are
-      # maximally sensitive to catching breakage.
-      #
-      # For example, here's a way that caching can cause a falsely-passing test:
-      # - Make the langchain package manifest no longer list a dependency package
-      #   as a requirement. This means it won't be installed by `pip install`,
-      #   and attempting to use it would cause a crash.
-      # - That dependency used to be required, so it may have been cached.
-      #   When restoring the venv packages from cache, that dependency gets included.
-      # - Tests pass, because the dependency is present even though it wasn't specified.
-      # - The package is published, and it breaks on the missing dependency when
-      #   used in the real world.
-
-      - name: Set up Python + uv
-        uses: "./.github/actions/uv_setup"
-        id: setup-python
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-
-      - uses: actions/download-artifact@v6
-        with:
-          name: dist
-          path: ${{ inputs.working-directory }}/dist/
-
-      - name: Import dist package
-        shell: bash
-        working-directory: ${{ inputs.working-directory }}
-        env:
-          PKG_NAME: ${{ needs.build.outputs.pkg-name }}
-          VERSION: ${{ needs.build.outputs.version }}
-        # Here we use:
-        # - The default regular PyPI index as the *primary* index, meaning
-        #   that it takes priority (https://pypi.org/simple)
-        # - The test PyPI index as an extra index, so that any dependencies that
-        #   are not found on test PyPI can be resolved and installed anyway.
-        #   (https://test.pypi.org/simple). This will include the PKG_NAME==VERSION
-        #   package because VERSION will not have been uploaded to regular PyPI yet.
-        # - attempt install again after 5 seconds if it fails because there is
-        #   sometimes a delay in availability on test pypi
-        run: |
-          uv venv
-          VIRTUAL_ENV=.venv uv pip install dist/*.whl
-
-          # Replace all dashes in the package name with underscores,
-          # since that's how Python imports packages with dashes in the name.
-          # also remove _official suffix
-          IMPORT_NAME="$(echo "$PKG_NAME" | sed s/-/_/g | sed s/_official//g)"
-
-          uv run python -c "import $IMPORT_NAME; print(dir($IMPORT_NAME))"
-
-      - name: Import test dependencies
-        run: uv sync --group test
-        working-directory: ${{ inputs.working-directory }}
-
-      # Overwrite the local version of the package with the built version
-      - name: Import published package (again)
-        working-directory: ${{ inputs.working-directory }}
-        shell: bash
-        env:
-          PKG_NAME: ${{ needs.build.outputs.pkg-name }}
-          VERSION: ${{ needs.build.outputs.version }}
-        run: |
-          VIRTUAL_ENV=.venv uv pip install dist/*.whl
-
-      - name: Check for prerelease versions
-        # Block release if any dependencies allow prerelease versions
-        # (unless this is itself a prerelease version)
-        working-directory: ${{ inputs.working-directory }}
-        run: |
-          uv run python $GITHUB_WORKSPACE/.github/scripts/check_prerelease_dependencies.py pyproject.toml
-
-      - name: Run unit tests
-        run: make tests
-        working-directory: ${{ inputs.working-directory }}
-
-      - name: Get minimum versions
-        # Find the minimum published versions that satisfies the given constraints
-        working-directory: ${{ inputs.working-directory }}
-        id: min-version
-        run: |
-          VIRTUAL_ENV=.venv uv pip install packaging requests
-          python_version="$(uv run python --version | awk '{print $2}')"
-          min_versions="$(uv run python $GITHUB_WORKSPACE/.github/scripts/get_min_versions.py pyproject.toml release $python_version)"
-          echo "min-versions=$min_versions" >> "$GITHUB_OUTPUT"
-          echo "min-versions=$min_versions"
-
-      - name: Run unit tests with minimum dependency versions
-        if: ${{ steps.min-version.outputs.min-versions != '' }}
-        env:
-          MIN_VERSIONS: ${{ steps.min-version.outputs.min-versions }}
-        run: |
-          VIRTUAL_ENV=.venv uv pip install --force-reinstall --editable .
-          VIRTUAL_ENV=.venv uv pip install --force-reinstall $MIN_VERSIONS
-          make tests
-        working-directory: ${{ inputs.working-directory }}
-
-      - name: Import integration test dependencies
-        run: uv sync --group test --group test_integration
-        working-directory: ${{ inputs.working-directory }}
-
-      - name: Run integration tests
-        # Uses the Makefile's `integration_tests` target for the specified package
-        if: ${{ startsWith(inputs.working-directory, 'libs/partners/') }}
-        env:
-          AI21_API_KEY: ${{ secrets.AI21_API_KEY }}
-          GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
-          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
-          MISTRAL_API_KEY: ${{ secrets.MISTRAL_API_KEY }}
-          TOGETHER_API_KEY: ${{ secrets.TOGETHER_API_KEY }}
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-          AZURE_OPENAI_API_VERSION: ${{ secrets.AZURE_OPENAI_API_VERSION }}
-          AZURE_OPENAI_API_BASE: ${{ secrets.AZURE_OPENAI_API_BASE }}
-          AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}
-          AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_CHAT_DEPLOYMENT_NAME }}
-          AZURE_OPENAI_LEGACY_CHAT_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_LEGACY_CHAT_DEPLOYMENT_NAME }}
-          AZURE_OPENAI_LLM_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_LLM_DEPLOYMENT_NAME }}
-          AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT_NAME }}
-          NVIDIA_API_KEY: ${{ secrets.NVIDIA_API_KEY }}
-          GOOGLE_SEARCH_API_KEY: ${{ secrets.GOOGLE_SEARCH_API_KEY }}
-          GOOGLE_CSE_ID: ${{ secrets.GOOGLE_CSE_ID }}
-          GROQ_API_KEY: ${{ secrets.GROQ_API_KEY }}
-          HUGGINGFACEHUB_API_TOKEN: ${{ secrets.HUGGINGFACEHUB_API_TOKEN }}
-          EXA_API_KEY: ${{ secrets.EXA_API_KEY }}
-          NOMIC_API_KEY: ${{ secrets.NOMIC_API_KEY }}
-          WATSONX_APIKEY: ${{ secrets.WATSONX_APIKEY }}
-          WATSONX_PROJECT_ID: ${{ secrets.WATSONX_PROJECT_ID }}
-          ASTRA_DB_API_ENDPOINT: ${{ secrets.ASTRA_DB_API_ENDPOINT }}
-          ASTRA_DB_APPLICATION_TOKEN: ${{ secrets.ASTRA_DB_APPLICATION_TOKEN }}
-          ASTRA_DB_KEYSPACE: ${{ secrets.ASTRA_DB_KEYSPACE }}
-          ES_URL: ${{ secrets.ES_URL }}
-          ES_CLOUD_ID: ${{ secrets.ES_CLOUD_ID }}
-          ES_API_KEY: ${{ secrets.ES_API_KEY }}
-          MONGODB_ATLAS_URI: ${{ secrets.MONGODB_ATLAS_URI }}
-          UPSTAGE_API_KEY: ${{ secrets.UPSTAGE_API_KEY }}
-          FIREWORKS_API_KEY: ${{ secrets.FIREWORKS_API_KEY }}
-          XAI_API_KEY: ${{ secrets.XAI_API_KEY }}
-          DEEPSEEK_API_KEY: ${{ secrets.DEEPSEEK_API_KEY }}
-          PPLX_API_KEY: ${{ secrets.PPLX_API_KEY }}
-          LANGCHAIN_TESTS_USER_AGENT: ${{ secrets.LANGCHAIN_TESTS_USER_AGENT }}
-        run: make integration_tests
-        working-directory: ${{ inputs.working-directory }}
-
-  # Test select published packages against new core
-  # Done when code changes are made to langchain-core
-  test-prior-published-packages-against-new-core:
-    # Installs the new core with old partners: Installs the new unreleased core
-    # alongside the previously published partner packages and runs integration tests
-    needs:
-      - build
-      - release-notes
-      - test-pypi-publish
-      - pre-release-checks
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    strategy:
-      matrix:
-        partner: [anthropic]
-      fail-fast: false # Continue testing other partners if one fails
-    env:
-      ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
-      ANTHROPIC_FILES_API_IMAGE_ID: ${{ secrets.ANTHROPIC_FILES_API_IMAGE_ID }}
-      ANTHROPIC_FILES_API_PDF_ID: ${{ secrets.ANTHROPIC_FILES_API_PDF_ID }}
-      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-      AZURE_OPENAI_API_VERSION: ${{ secrets.AZURE_OPENAI_API_VERSION }}
-      AZURE_OPENAI_API_BASE: ${{ secrets.AZURE_OPENAI_API_BASE }}
-      AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}
-      AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_CHAT_DEPLOYMENT_NAME }}
-      AZURE_OPENAI_LEGACY_CHAT_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_LEGACY_CHAT_DEPLOYMENT_NAME }}
-      AZURE_OPENAI_LLM_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_LLM_DEPLOYMENT_NAME }}
-      AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT_NAME }}
-      LANGCHAIN_TESTS_USER_AGENT: ${{ secrets.LANGCHAIN_TESTS_USER_AGENT }}
-    steps:
-      - uses: actions/checkout@v6
-
-      # We implement this conditional as Github Actions does not have good support
-      # for conditionally needing steps. https://github.com/actions/runner/issues/491
-      # TODO: this seems to be resolved upstream, so we can probably remove this workaround
-      - name: Check if libs/core
-        run: |
-          if [ "${{ startsWith(inputs.working-directory, 'libs/core') }}" != "true" ]; then
-            echo "Not in libs/core. Exiting successfully."
-            exit 0
-          fi
-
-      - name: Set up Python + uv
-        if: startsWith(inputs.working-directory, 'libs/core')
-        uses: "./.github/actions/uv_setup"
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-
-      - uses: actions/download-artifact@v6
-        if: startsWith(inputs.working-directory, 'libs/core')
-        with:
-          name: dist
-          path: ${{ inputs.working-directory }}/dist/
-
-      - name: Test against ${{ matrix.partner }}
-        if: startsWith(inputs.working-directory, 'libs/core')
-        run: |
-          # Identify latest tag, excluding pre-releases
-          LATEST_PACKAGE_TAG="$(
-            git ls-remote --tags origin "langchain-${{ matrix.partner }}*" \
-            | awk '{print $2}' \
-            | sed 's|refs/tags/||' \
-            | grep -E '[0-9]+\.[0-9]+\.[0-9]+$' \
-            | sort -Vr \
-            | head -n 1
-          )"
-          echo "Latest package tag: $LATEST_PACKAGE_TAG"
-
-          # Shallow-fetch just that single tag
-          git fetch --depth=1 origin tag "$LATEST_PACKAGE_TAG"
-
-          # Checkout the latest package files
-          rm -rf $GITHUB_WORKSPACE/libs/partners/${{ matrix.partner }}/*
-          rm -rf $GITHUB_WORKSPACE/libs/standard-tests/*
-          cd $GITHUB_WORKSPACE/libs/
-          git checkout "$LATEST_PACKAGE_TAG" -- standard-tests/
-          git checkout "$LATEST_PACKAGE_TAG" -- partners/${{ matrix.partner }}/
-          cd partners/${{ matrix.partner }}
-
-          # Print as a sanity check
-          echo "Version number from pyproject.toml: "
-          cat pyproject.toml | grep "version = "
-
-          # Run tests
-          uv sync --group test --group test_integration
-          uv pip install ../../core/dist/*.whl
-          make integration_tests
-
-  publish:
-    # Publishes the package to PyPI
-    needs:
-      - build
-      - release-notes
-      - test-pypi-publish
-      - pre-release-checks
-      - test-prior-published-packages-against-new-core
-    runs-on: ubuntu-latest
-    permissions:
-      # This permission is used for trusted publishing:
-      # https://blog.pypi.org/posts/2023-04-20-introducing-trusted-publishers/
-      #
-      # Trusted publishing has to also be configured on PyPI for each package:
-      # https://docs.pypi.org/trusted-publishers/adding-a-publisher/
-      id-token: write
-
-    defaults:
-      run:
-        working-directory: ${{ inputs.working-directory }}
-
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Set up Python + uv
-        uses: "./.github/actions/uv_setup"
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-
-      - uses: actions/download-artifact@v6
-        with:
-          name: dist
-          path: ${{ inputs.working-directory }}/dist/
-
-      - name: Publish package distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          packages-dir: ${{ inputs.working-directory }}/dist/
-          verbose: true
-          print-hash: true
-          # Temp workaround since attestations are on by default as of gh-action-pypi-publish v1.11.0
-          attestations: false
-
-  mark-release:
-    # Marks the GitHub release with the new version tag
-    needs:
-      - build
-      - release-notes
-      - test-pypi-publish
-      - pre-release-checks
-      - publish
-    runs-on: ubuntu-latest
-    permissions:
-      # This permission is needed by `ncipollo/release-action` to
-      # create the GitHub release/tag
-      contents: write
-
-    defaults:
-      run:
-        working-directory: ${{ inputs.working-directory }}
-
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Set up Python + uv
-        uses: "./.github/actions/uv_setup"
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-
-      - uses: actions/download-artifact@v6
-        with:
-          name: dist
-          path: ${{ inputs.working-directory }}/dist/
-
-      - name: Create Tag
-        uses: ncipollo/release-action@v1
-        with:
-          artifacts: "dist/*"
-          token: ${{ secrets.GITHUB_TOKEN }}
-          generateReleaseNotes: false
-          tag: ${{needs.build.outputs.pkg-name}}==${{ needs.build.outputs.version }}
-          body: ${{ needs.release-notes.outputs.release-body }}
-          commit: ${{ github.sha }}
-          makeLatest: ${{ needs.build.outputs.pkg-name == 'langchain-core'}}

.github/workflows/_test.yml

@@ -1,85 +0,0 @@
-# Runs unit tests with both current and minimum supported dependency versions
-# to ensure compatibility across the supported range.
-
-name: "🧪 Unit Testing"
-
-on:
-  workflow_call:
-    inputs:
-      working-directory:
-        required: true
-        type: string
-        description: "From which folder this pipeline executes"
-      python-version:
-        required: true
-        type: string
-        description: "Python version to use"
-
-permissions:
-  contents: read
-
-env:
-  UV_FROZEN: "true"
-  UV_NO_SYNC: "true"
-
-jobs:
-  # Main test job - runs unit tests with current deps, then retests with minimum versions
-  build:
-    defaults:
-      run:
-        working-directory: ${{ inputs.working-directory }}
-    runs-on: ubuntu-latest
-    timeout-minutes: 20
-    name: "Python ${{ inputs.python-version }}"
-    steps:
-      - name: "📋 Checkout Code"
-        uses: actions/checkout@v6
-
-      - name: "🐍 Set up Python ${{ inputs.python-version }} + UV"
-        uses: "./.github/actions/uv_setup"
-        id: setup-python
-        with:
-          python-version: ${{ inputs.python-version }}
-          cache-suffix: test-${{ inputs.working-directory }}
-          working-directory: ${{ inputs.working-directory }}
-
-      - name: "📦 Install Test Dependencies"
-        shell: bash
-        run: uv sync --group test --dev
-
-      - name: "🧪 Run Core Unit Tests"
-        shell: bash
-        run: |
-          make test
-
-      - name: "🔍 Calculate Minimum Dependency Versions"
-        working-directory: ${{ inputs.working-directory }}
-        id: min-version
-        shell: bash
-        run: |
-          VIRTUAL_ENV=.venv uv pip install packaging tomli requests
-          python_version="$(uv run python --version | awk '{print $2}')"
-          min_versions="$(uv run python $GITHUB_WORKSPACE/.github/scripts/get_min_versions.py pyproject.toml pull_request $python_version)"
-          echo "min-versions=$min_versions" >> "$GITHUB_OUTPUT"
-          echo "min-versions=$min_versions"
-
-      - name: "🧪 Run Tests with Minimum Dependencies"
-        if: ${{ steps.min-version.outputs.min-versions != '' }}
-        env:
-          MIN_VERSIONS: ${{ steps.min-version.outputs.min-versions }}
-        run: |
-          VIRTUAL_ENV=.venv uv pip install $MIN_VERSIONS
-          make tests
-        working-directory: ${{ inputs.working-directory }}
-
-      - name: "🧹 Verify Clean Working Directory"
-        shell: bash
-        run: |
-          set -eu
-
-          STATUS="$(git status)"
-          echo "$STATUS"
-
-          # grep will exit non-zero if the target message isn't found,
-          # and `set -e` above will cause the step to fail.
-          echo "$STATUS" | grep 'nothing to commit, working tree clean'

.github/workflows/_test_pydantic.yml

@@ -1,73 +0,0 @@
-# Facilitate unit testing against different Pydantic versions for a provided package.
-
-name: "🐍 Pydantic Version Testing"
-
-on:
-  workflow_call:
-    inputs:
-      working-directory:
-        required: true
-        type: string
-        description: "From which folder this pipeline executes"
-      python-version:
-        required: false
-        type: string
-        description: "Python version to use"
-        default: "3.12"
-      pydantic-version:
-        required: true
-        type: string
-        description: "Pydantic version to test."
-
-permissions:
-  contents: read
-
-env:
-  UV_FROZEN: "true"
-  UV_NO_SYNC: "true"
-
-jobs:
-  build:
-    defaults:
-      run:
-        working-directory: ${{ inputs.working-directory }}
-    runs-on: ubuntu-latest
-    timeout-minutes: 20
-    name: "Pydantic ~=${{ inputs.pydantic-version }}"
-    steps:
-      - name: "📋 Checkout Code"
-        uses: actions/checkout@v6
-
-      - name: "🐍 Set up Python ${{ inputs.python-version }} + UV"
-        uses: "./.github/actions/uv_setup"
-        with:
-          python-version: ${{ inputs.python-version }}
-          cache-suffix: test-pydantic-${{ inputs.working-directory }}
-          working-directory: ${{ inputs.working-directory }}
-
-      - name: "📦 Install Test Dependencies"
-        shell: bash
-        run: uv sync --group test
-
-      - name: "🔄 Install Specific Pydantic Version"
-        shell: bash
-        env:
-          PYDANTIC_VERSION: ${{ inputs.pydantic-version }}
-        run: VIRTUAL_ENV=.venv uv pip install "pydantic~=$PYDANTIC_VERSION"
-
-      - name: "🧪 Run Core Tests"
-        shell: bash
-        run: |
-          make test
-
-      - name: "🧹 Verify Clean Working Directory"
-        shell: bash
-        run: |
-          set -eu
-
-          STATUS="$(git status)"
-          echo "$STATUS"
-
-          # grep will exit non-zero if the target message isn't found,
-          # and `set -e` above will cause the step to fail.
-          echo "$STATUS" | grep 'nothing to commit, working tree clean'

.github/workflows/auto-label-by-package.yml

@@ -1,107 +0,0 @@
-name: Auto Label Issues by Package
-
-on:
-  issues:
-    types: [opened, edited]
-
-jobs:
-  label-by-package:
-    permissions:
-      issues: write
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Sync package labels
-        uses: actions/github-script@v8
-        with:
-          script: |
-            const body = context.payload.issue.body || "";
-
-            // Extract text under "### Package"
-            const match = body.match(/### Package\s+([\s\S]*?)\n###/i);
-            if (!match) return;
-
-            const packageSection = match[1].trim();
-
-            // Mapping table for package names to labels
-            const mapping = {
-              "langchain": "langchain",
-              "langchain-openai": "openai",
-              "langchain-anthropic": "anthropic",
-              "langchain-classic": "langchain-classic",
-              "langchain-core": "core",
-              "langchain-cli": "cli",
-              "langchain-model-profiles": "model-profiles",
-              "langchain-tests": "standard-tests",
-              "langchain-text-splitters": "text-splitters",
-              "langchain-chroma": "chroma",
-              "langchain-deepseek": "deepseek",
-              "langchain-exa": "exa",
-              "langchain-fireworks": "fireworks",
-              "langchain-groq": "groq",
-              "langchain-huggingface": "huggingface",
-              "langchain-mistralai": "mistralai",
-              "langchain-nomic": "nomic",
-              "langchain-ollama": "ollama",
-              "langchain-perplexity": "perplexity",
-              "langchain-prompty": "prompty",
-              "langchain-qdrant": "qdrant",
-              "langchain-xai": "xai",
-            };
-
-            // All possible package labels we manage
-            const allPackageLabels = Object.values(mapping);
-            const selectedLabels = [];
-
-            // Check if this is checkbox format (multiple selection)
-            const checkboxMatches = packageSection.match(/- \[x\]\s+([^\n\r]+)/gi);
-            if (checkboxMatches) {
-              // Handle checkbox format
-              for (const match of checkboxMatches) {
-                const packageName = match.replace(/- \[x\]\s+/i, '').trim();
-                const label = mapping[packageName];
-                if (label && !selectedLabels.includes(label)) {
-                  selectedLabels.push(label);
-                }
-              }
-            } else {
-              // Handle dropdown format (single selection)
-              const label = mapping[packageSection];
-              if (label) {
-                selectedLabels.push(label);
-              }
-            }
-
-            // Get current issue labels
-            const issue = await github.rest.issues.get({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              issue_number: context.issue.number
-            });
-
-            const currentLabels = issue.data.labels.map(label => label.name);
-            const currentPackageLabels = currentLabels.filter(label => allPackageLabels.includes(label));
-
-            // Determine labels to add and remove
-            const labelsToAdd = selectedLabels.filter(label => !currentPackageLabels.includes(label));
-            const labelsToRemove = currentPackageLabels.filter(label => !selectedLabels.includes(label));
-
-            // Add new labels
-            if (labelsToAdd.length > 0) {
-              await github.rest.issues.addLabels({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                issue_number: context.issue.number,
-                labels: labelsToAdd
-              });
-            }
-
-            // Remove old labels
-            for (const label of labelsToRemove) {
-              await github.rest.issues.removeLabel({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                issue_number: context.issue.number,
-                name: label
-              });
-            }

.github/workflows/check_core_versions.yml

@@ -1,51 +0,0 @@
-# Ensures version numbers in pyproject.toml and version.py stay in sync.
-#
-# (Prevents releases with mismatched version numbers)
-
-name: "🔍 Check Version Equality"
-
-on:
-  pull_request:
-    paths:
-      - "libs/core/pyproject.toml"
-      - "libs/core/langchain_core/version.py"
-
-permissions:
-  contents: read
-
-jobs:
-  check_version_equality:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: "✅ Verify pyproject.toml & version.py Match"
-        run: |
-          # Check core versions
-          CORE_PYPROJECT_VERSION=$(grep -Po '(?<=^version = ")[^"]*' libs/core/pyproject.toml)
-          CORE_VERSION_PY_VERSION=$(grep -Po '(?<=^VERSION = ")[^"]*' libs/core/langchain_core/version.py)
-
-          # Compare core versions
-          if [ "$CORE_PYPROJECT_VERSION" != "$CORE_VERSION_PY_VERSION" ]; then
-            echo "langchain-core versions in pyproject.toml and version.py do not match!"
-            echo "pyproject.toml version: $CORE_PYPROJECT_VERSION"
-            echo "version.py version: $CORE_VERSION_PY_VERSION"
-            exit 1
-          else
-            echo "Core versions match: $CORE_PYPROJECT_VERSION"
-          fi
-
-          # Check langchain_v1 versions
-          LANGCHAIN_PYPROJECT_VERSION=$(grep -Po '(?<=^version = ")[^"]*' libs/langchain_v1/pyproject.toml)
-          LANGCHAIN_INIT_PY_VERSION=$(grep -Po '(?<=^__version__ = ")[^"]*' libs/langchain_v1/langchain/__init__.py)
-
-          # Compare langchain_v1 versions
-          if [ "$LANGCHAIN_PYPROJECT_VERSION" != "$LANGCHAIN_INIT_PY_VERSION" ]; then
-            echo "langchain_v1 versions in pyproject.toml and __init__.py do not match!"
-            echo "pyproject.toml version: $LANGCHAIN_PYPROJECT_VERSION"
-            echo "version.py version: $LANGCHAIN_INIT_PY_VERSION"
-            exit 1
-          else
-            echo "Langchain v1 versions match: $LANGCHAIN_PYPROJECT_VERSION"
-          fi

.github/workflows/check_diffs.yml

@@ -1,261 +0,0 @@
-# Primary CI workflow.
-#
-# Only runs against packages that have changed files.
-#
-# Runs:
-# - Linting (_lint.yml)
-# - Unit Tests (_test.yml)
-# - Pydantic compatibility tests (_test_pydantic.yml)
-# - Integration test compilation checks (_compile_integration_test.yml)
-# - Extended test suites that require additional dependencies
-# - Codspeed benchmarks (if not labeled 'codspeed-ignore')
-#
-# Reports status to GitHub checks and PR status.
-
-name: "🔧 CI"
-
-on:
-  push:
-    branches: [master]
-  pull_request:
-  merge_group:
-
-# Optimizes CI performance by canceling redundant workflow runs
-# If another push to the same PR or branch happens while this workflow is still running,
-# cancel the earlier run in favor of the next run.
-#
-# There's no point in testing an outdated version of the code. GitHub only allows
-# a limited number of job runners to be active at the same time, so it's better to
-# cancel pointless jobs early so that more useful jobs can run sooner.
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-permissions:
-  contents: read
-
-env:
-  UV_FROZEN: "true"
-  UV_NO_SYNC: "true"
-
-jobs:
-  # This job analyzes which files changed and creates a dynamic test matrix
-  # to only run tests/lints for the affected packages, improving CI efficiency
-  build:
-    name: "Detect Changes & Set Matrix"
-    runs-on: ubuntu-latest
-    if: ${{ !contains(github.event.pull_request.labels.*.name, 'ci-ignore') }}
-    steps:
-      - name: "📋 Checkout Code"
-        uses: actions/checkout@v6
-      - name: "🐍 Setup Python 3.11"
-        uses: actions/setup-python@v6
-        with:
-          python-version: "3.11"
-      - name: "📂 Get Changed Files"
-        id: files
-        uses: Ana06/get-changed-files@v2.3.0
-      - name: "🔍 Analyze Changed Files & Generate Build Matrix"
-        id: set-matrix
-        run: |
-          python -m pip install packaging requests
-          python .github/scripts/check_diff.py ${{ steps.files.outputs.all }} >> $GITHUB_OUTPUT
-    outputs:
-      lint: ${{ steps.set-matrix.outputs.lint }}
-      test: ${{ steps.set-matrix.outputs.test }}
-      extended-tests: ${{ steps.set-matrix.outputs.extended-tests }}
-      compile-integration-tests: ${{ steps.set-matrix.outputs.compile-integration-tests }}
-      dependencies: ${{ steps.set-matrix.outputs.dependencies }}
-      test-pydantic: ${{ steps.set-matrix.outputs.test-pydantic }}
-      codspeed: ${{ steps.set-matrix.outputs.codspeed }}
-  # Run linting only on packages that have changed files
-  lint:
-    needs: [build]
-    if: ${{ needs.build.outputs.lint != '[]' }}
-    strategy:
-      matrix:
-        job-configs: ${{ fromJson(needs.build.outputs.lint) }}
-      fail-fast: false
-    uses: ./.github/workflows/_lint.yml
-    with:
-      working-directory: ${{ matrix.job-configs.working-directory }}
-      python-version: ${{ matrix.job-configs.python-version }}
-    secrets: inherit
-
-  # Run unit tests only on packages that have changed files
-  test:
-    needs: [build]
-    if: ${{ needs.build.outputs.test != '[]' }}
-    strategy:
-      matrix:
-        job-configs: ${{ fromJson(needs.build.outputs.test) }}
-      fail-fast: false
-    uses: ./.github/workflows/_test.yml
-    with:
-      working-directory: ${{ matrix.job-configs.working-directory }}
-      python-version: ${{ matrix.job-configs.python-version }}
-    secrets: inherit
-
-  # Test compatibility with different Pydantic versions for affected packages
-  test-pydantic:
-    needs: [build]
-    if: ${{ needs.build.outputs.test-pydantic != '[]' }}
-    strategy:
-      matrix:
-        job-configs: ${{ fromJson(needs.build.outputs.test-pydantic) }}
-      fail-fast: false
-    uses: ./.github/workflows/_test_pydantic.yml
-    with:
-      working-directory: ${{ matrix.job-configs.working-directory }}
-      pydantic-version: ${{ matrix.job-configs.pydantic-version }}
-    secrets: inherit
-
-  # Verify integration tests compile without actually running them (faster feedback)
-  compile-integration-tests:
-    name: "Compile Integration Tests"
-    needs: [build]
-    if: ${{ needs.build.outputs.compile-integration-tests != '[]' }}
-    strategy:
-      matrix:
-        job-configs: ${{ fromJson(needs.build.outputs.compile-integration-tests) }}
-      fail-fast: false
-    uses: ./.github/workflows/_compile_integration_test.yml
-    with:
-      working-directory: ${{ matrix.job-configs.working-directory }}
-      python-version: ${{ matrix.job-configs.python-version }}
-    secrets: inherit
-
-  # Run extended test suites that require additional dependencies
-  extended-tests:
-    name: "Extended Tests"
-    needs: [build]
-    if: ${{ needs.build.outputs.extended-tests != '[]' }}
-    strategy:
-      matrix:
-        # note different variable for extended test dirs
-        job-configs: ${{ fromJson(needs.build.outputs.extended-tests) }}
-      fail-fast: false
-    runs-on: ubuntu-latest
-    timeout-minutes: 20
-    defaults:
-      run:
-        working-directory: ${{ matrix.job-configs.working-directory }}
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: "🐍 Set up Python ${{ matrix.job-configs.python-version }} + UV"
-        uses: "./.github/actions/uv_setup"
-        with:
-          python-version: ${{ matrix.job-configs.python-version }}
-          cache-suffix: extended-tests-${{ matrix.job-configs.working-directory }}
-          working-directory: ${{ matrix.job-configs.working-directory }}
-
-      - name: "📦 Install Dependencies & Run Extended Tests"
-        shell: bash
-        run: |
-          echo "Running extended tests, installing dependencies with uv..."
-          uv venv
-          uv sync --group test
-          VIRTUAL_ENV=.venv uv pip install -r extended_testing_deps.txt
-          VIRTUAL_ENV=.venv make extended_tests
-
-      - name: "🧹 Verify Clean Working Directory"
-        shell: bash
-        run: |
-          set -eu
-
-          STATUS="$(git status)"
-          echo "$STATUS"
-
-          # grep will exit non-zero if the target message isn't found,
-          # and `set -e` above will cause the step to fail.
-          echo "$STATUS" | grep 'nothing to commit, working tree clean'
-
-  # Run codspeed benchmarks only on packages that have changed files
-  codspeed:
-    name: "⚡ CodSpeed Benchmarks"
-    needs: [build]
-    if: ${{ needs.build.outputs.codspeed != '[]' && !contains(github.event.pull_request.labels.*.name, 'codspeed-ignore') }}
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        job-configs: ${{ fromJson(needs.build.outputs.codspeed) }}
-      fail-fast: false
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: "📦 Install UV Package Manager"
-        uses: astral-sh/setup-uv@v7
-        with:
-          python-version: "3.13"
-
-      - uses: actions/setup-python@v6
-        with:
-          python-version: "3.13"
-
-      - name: "📦 Install Test Dependencies"
-        run: uv sync --group test
-        working-directory: ${{ matrix.job-configs.working-directory }}
-
-      - name: "⚡ Run Benchmarks: ${{ matrix.job-configs.working-directory }}"
-        uses: CodSpeedHQ/action@v4
-        env:
-          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
-          ANTHROPIC_FILES_API_IMAGE_ID: ${{ secrets.ANTHROPIC_FILES_API_IMAGE_ID }}
-          ANTHROPIC_FILES_API_PDF_ID: ${{ secrets.ANTHROPIC_FILES_API_PDF_ID }}
-          AZURE_OPENAI_API_VERSION: ${{ secrets.AZURE_OPENAI_API_VERSION }}
-          AZURE_OPENAI_API_BASE: ${{ secrets.AZURE_OPENAI_API_BASE }}
-          AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}
-          AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_CHAT_DEPLOYMENT_NAME }}
-          AZURE_OPENAI_LEGACY_CHAT_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_LEGACY_CHAT_DEPLOYMENT_NAME }}
-          AZURE_OPENAI_LLM_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_LLM_DEPLOYMENT_NAME }}
-          AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT_NAME }}
-          COHERE_API_KEY: ${{ secrets.COHERE_API_KEY }}
-          DEEPSEEK_API_KEY: ${{ secrets.DEEPSEEK_API_KEY }}
-          EXA_API_KEY: ${{ secrets.EXA_API_KEY }}
-          FIREWORKS_API_KEY: ${{ secrets.FIREWORKS_API_KEY }}
-          GROQ_API_KEY: ${{ secrets.GROQ_API_KEY }}
-          HUGGINGFACEHUB_API_TOKEN: ${{ secrets.HUGGINGFACEHUB_API_TOKEN }}
-          MISTRAL_API_KEY: ${{ secrets.MISTRAL_API_KEY }}
-          NOMIC_API_KEY: ${{ secrets.NOMIC_API_KEY }}
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-          PPLX_API_KEY: ${{ secrets.PPLX_API_KEY }}
-          XAI_API_KEY: ${{ secrets.XAI_API_KEY }}
-        with:
-          token: ${{ secrets.CODSPEED_TOKEN }}
-          run: |
-            cd ${{ matrix.job-configs.working-directory }}
-            if [ "${{ matrix.job-configs.working-directory }}" = "libs/core" ]; then
-              uv run --no-sync pytest ./tests/benchmarks --codspeed
-            else
-              uv run --no-sync pytest ./tests/ --codspeed
-            fi
-          mode: ${{ matrix.job-configs.working-directory == 'libs/core' && 'walltime' || 'instrumentation' }}
-
-  # Final status check - ensures all required jobs passed before allowing merge
-  ci_success:
-    name: "✅ CI Success"
-    needs:
-      [
-        build,
-        lint,
-        test,
-        compile-integration-tests,
-        extended-tests,
-        test-pydantic,
-        codspeed,
-      ]
-    if: |
-      always()
-    runs-on: ubuntu-latest
-    env:
-      JOBS_JSON: ${{ toJSON(needs) }}
-      RESULTS_JSON: ${{ toJSON(needs.*.result) }}
-      EXIT_CODE: ${{!contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') && '0' || '1'}}
-    steps:
-      - name: "🎉 All Checks Passed"
-        run: |
-          echo $JOBS_JSON
-          echo $RESULTS_JSON
-          echo "Exiting with $EXIT_CODE"
-          exit $EXIT_CODE

.github/workflows/integration_tests.yml

@@ -1,181 +0,0 @@
-# Routine integration tests against partner libraries with live API credentials.
-#
-# Uses `make integration_tests` for each library in the matrix.
-#
-# Runs daily. Can also be triggered manually for immediate updates.
-
-name: "⏰ Integration Tests"
-run-name: "Run Integration Tests - ${{ inputs.working-directory-force || 'all libs' }} (Python ${{ inputs.python-version-force || '3.10, 3.13' }})"
-
-on:
-  workflow_dispatch:
-    inputs:
-      working-directory-force:
-        type: string
-        description: "From which folder this pipeline executes - defaults to all in matrix - example value: libs/partners/anthropic"
-      python-version-force:
-        type: string
-        description: "Python version to use - defaults to 3.10 and 3.13 in matrix - example value: 3.11"
-  schedule:
-    - cron: "0 13 * * *" # Runs daily at 1PM UTC (9AM EDT/6AM PDT)
-
-permissions:
-  contents: read
-
-env:
-  UV_FROZEN: "true"
-  DEFAULT_LIBS: '["libs/partners/openai", "libs/partners/anthropic", "libs/partners/fireworks", "libs/partners/groq", "libs/partners/mistralai", "libs/partners/xai", "libs/partners/google-vertexai", "libs/partners/google-genai", "libs/partners/aws"]'
-
-jobs:
-  # Generate dynamic test matrix based on input parameters or defaults
-  # Only runs on the main repo (for scheduled runs) or when manually triggered
-  compute-matrix:
-    if: github.repository_owner == 'langchain-ai' || github.event_name != 'schedule'
-    runs-on: ubuntu-latest
-    name: "📋 Compute Test Matrix"
-    outputs:
-      matrix: ${{ steps.set-matrix.outputs.matrix }}
-    steps:
-      - name: "🔢 Generate Python & Library Matrix"
-        id: set-matrix
-        env:
-          DEFAULT_LIBS: ${{ env.DEFAULT_LIBS }}
-          WORKING_DIRECTORY_FORCE: ${{ github.event.inputs.working-directory-force || '' }}
-          PYTHON_VERSION_FORCE: ${{ github.event.inputs.python-version-force || '' }}
-        run: |
-          # echo "matrix=..." where matrix is a json formatted str with keys python-version and working-directory
-          # python-version should default to 3.10 and 3.13, but is overridden to [PYTHON_VERSION_FORCE] if set
-          # working-directory should default to DEFAULT_LIBS, but is overridden to [WORKING_DIRECTORY_FORCE] if set
-          python_version='["3.10", "3.13"]'
-          working_directory="$DEFAULT_LIBS"
-          if [ -n "$PYTHON_VERSION_FORCE" ]; then
-            python_version="[\"$PYTHON_VERSION_FORCE\"]"
-          fi
-          if [ -n "$WORKING_DIRECTORY_FORCE" ]; then
-            working_directory="[\"$WORKING_DIRECTORY_FORCE\"]"
-          fi
-          matrix="{\"python-version\": $python_version, \"working-directory\": $working_directory}"
-          echo $matrix
-          echo "matrix=$matrix" >> $GITHUB_OUTPUT
-  # Run integration tests against partner libraries with live API credentials
-  build:
-    if: github.repository_owner == 'langchain-ai' || github.event_name != 'schedule'
-    name: "🐍 Python ${{ matrix.python-version }}: ${{ matrix.working-directory }}"
-    runs-on: ubuntu-latest
-    needs: [compute-matrix]
-    timeout-minutes: 30
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ${{ fromJSON(needs.compute-matrix.outputs.matrix).python-version }}
-        working-directory: ${{ fromJSON(needs.compute-matrix.outputs.matrix).working-directory }}
-
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          path: langchain
-      - uses: actions/checkout@v6
-        with:
-          repository: langchain-ai/langchain-google
-          path: langchain-google
-      - uses: actions/checkout@v6
-        with:
-          repository: langchain-ai/langchain-aws
-          path: langchain-aws
-
-      - name: "📦 Organize External Libraries"
-        run: |
-          rm -rf \
-            langchain/libs/partners/google-genai \
-            langchain/libs/partners/google-vertexai
-          mv langchain-google/libs/genai langchain/libs/partners/google-genai
-          mv langchain-google/libs/vertexai langchain/libs/partners/google-vertexai
-          mv langchain-aws/libs/aws langchain/libs/partners/aws
-
-      - name: "🐍 Set up Python ${{ matrix.python-version }} + UV"
-        uses: "./langchain/.github/actions/uv_setup"
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: "🔐 Authenticate to Google Cloud"
-        id: "auth"
-        uses: google-github-actions/auth@v3
-        with:
-          credentials_json: "${{ secrets.GOOGLE_CREDENTIALS }}"
-
-      - name: "🔐 Configure AWS Credentials"
-        uses: aws-actions/configure-aws-credentials@v5
-        with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: ${{ secrets.AWS_REGION }}
-
-      - name: "📦 Install Dependencies"
-        run: |
-          echo "Running scheduled tests, installing dependencies with uv..."
-          cd langchain/${{ matrix.working-directory }}
-          uv sync --group test --group test_integration
-
-      - name: "🚀 Run Integration Tests"
-        env:
-          AI21_API_KEY: ${{ secrets.AI21_API_KEY }}
-          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
-          ANTHROPIC_FILES_API_IMAGE_ID: ${{ secrets.ANTHROPIC_FILES_API_IMAGE_ID }}
-          ANTHROPIC_FILES_API_PDF_ID: ${{ secrets.ANTHROPIC_FILES_API_PDF_ID }}
-          ASTRA_DB_API_ENDPOINT: ${{ secrets.ASTRA_DB_API_ENDPOINT }}
-          ASTRA_DB_APPLICATION_TOKEN: ${{ secrets.ASTRA_DB_APPLICATION_TOKEN }}
-          ASTRA_DB_KEYSPACE: ${{ secrets.ASTRA_DB_KEYSPACE }}
-          AZURE_OPENAI_API_VERSION: ${{ secrets.AZURE_OPENAI_API_VERSION }}
-          AZURE_OPENAI_API_BASE: ${{ secrets.AZURE_OPENAI_API_BASE }}
-          AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}
-          AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_CHAT_DEPLOYMENT_NAME }}
-          AZURE_OPENAI_LEGACY_CHAT_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_LEGACY_CHAT_DEPLOYMENT_NAME }}
-          AZURE_OPENAI_LLM_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_LLM_DEPLOYMENT_NAME }}
-          AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT_NAME }}
-          COHERE_API_KEY: ${{ secrets.COHERE_API_KEY }}
-          DEEPSEEK_API_KEY: ${{ secrets.DEEPSEEK_API_KEY }}
-          ES_URL: ${{ secrets.ES_URL }}
-          ES_CLOUD_ID: ${{ secrets.ES_CLOUD_ID }}
-          ES_API_KEY: ${{ secrets.ES_API_KEY }}
-          EXA_API_KEY: ${{ secrets.EXA_API_KEY }}
-          FIREWORKS_API_KEY: ${{ secrets.FIREWORKS_API_KEY }}
-          GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
-          GOOGLE_SEARCH_API_KEY: ${{ secrets.GOOGLE_SEARCH_API_KEY }}
-          GOOGLE_CSE_ID: ${{ secrets.GOOGLE_CSE_ID }}
-          GROQ_API_KEY: ${{ secrets.GROQ_API_KEY }}
-          HUGGINGFACEHUB_API_TOKEN: ${{ secrets.HUGGINGFACEHUB_API_TOKEN }}
-          MISTRAL_API_KEY: ${{ secrets.MISTRAL_API_KEY }}
-          MONGODB_ATLAS_URI: ${{ secrets.MONGODB_ATLAS_URI }}
-          NOMIC_API_KEY: ${{ secrets.NOMIC_API_KEY }}
-          NVIDIA_API_KEY: ${{ secrets.NVIDIA_API_KEY }}
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-          PPLX_API_KEY: ${{ secrets.PPLX_API_KEY }}
-          TOGETHER_API_KEY: ${{ secrets.TOGETHER_API_KEY }}
-          UPSTAGE_API_KEY: ${{ secrets.UPSTAGE_API_KEY }}
-          WATSONX_APIKEY: ${{ secrets.WATSONX_APIKEY }}
-          WATSONX_PROJECT_ID: ${{ secrets.WATSONX_PROJECT_ID }}
-          XAI_API_KEY: ${{ secrets.XAI_API_KEY }}
-          LANGCHAIN_TESTS_USER_AGENT: ${{ secrets.LANGCHAIN_TESTS_USER_AGENT }}
-        run: |
-          cd langchain/${{ matrix.working-directory }}
-          make integration_tests
-
-      - name: "🧹 Clean up External Libraries"
-        # Clean up external libraries to avoid affecting the following git status check
-        run: |
-          rm -rf \
-            langchain/libs/partners/google-genai \
-            langchain/libs/partners/google-vertexai \
-            langchain/libs/partners/aws
-
-      - name: "🧹 Verify Clean Working Directory"
-        working-directory: langchain
-        run: |
-          set -eu
-
-          STATUS="$(git status)"
-          echo "$STATUS"
-
-          # grep will exit non-zero if the target message isn't found,
-          # and `set -e` above will cause the step to fail.
-          echo "$STATUS" | grep 'nothing to commit, working tree clean'

.github/workflows/lint.yml

@@ -0,0 +1,36 @@
+name: lint
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+env:
+  POETRY_VERSION: "1.3.1"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "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
+      - name: Analysing the code with our lint
+        run: |
+          make lint

.github/workflows/pr_labeler_file.yml

@@ -1,28 +0,0 @@
-# Label PRs based on changed files.
-#
-# See `.github/pr-file-labeler.yml` to see rules for each label/directory.
-
-name: "🏷️ Pull Request Labeler"
-
-on:
-  # Safe since we're not checking out or running the PR's code
-  # Never check out the PR's head in a pull_request_target job
-  pull_request_target:
-    types: [opened, synchronize, reopened, edited]
-
-jobs:
-  labeler:
-    name: "label"
-    permissions:
-      contents: read
-      pull-requests: write
-      issues: write
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Label Pull Request
-        uses: actions/labeler@v6
-        with:
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
-          configuration-path: .github/pr-file-labeler.yml
-          sync-labels: false

.github/workflows/pr_labeler_title.yml

@@ -1,44 +0,0 @@
-# Label PRs based on their titles.
-#
-# Uses conventional commit types from PR titles to apply labels.
-# Note: Scope-based labeling (e.g., integration labels) is handled by pr_labeler_file.yml
-
-name: "🏷️ PR Title Labeler"
-
-on:
-  # Safe since we're not checking out or running the PR's code
-  # Never check out the PR's head in a pull_request_target job
-  pull_request_target:
-    types: [opened, edited]
-
-jobs:
-  pr-title-labeler:
-    name: "label"
-    permissions:
-      contents: read
-      pull-requests: write
-      issues: write
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Label PR based on title
-        uses: bcoe/conventional-release-labels@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          type_labels: >-
-            {
-              "feat": "feature",
-              "fix": "fix",
-              "docs": "documentation",
-              "style": "linting",
-              "refactor": "refactor",
-              "perf": "performance",
-              "test": "tests",
-              "build": "infra",
-              "ci": "infra",
-              "chore": "infra",
-              "revert": "revert",
-              "release": "release",
-              "breaking": "breaking"
-            }
-          ignored_types: '[]'

.github/workflows/pr_lint.yml

@@ -1,111 +0,0 @@
-# PR title linting.
-#
-# FORMAT (Conventional Commits 1.0.0):
-#
-#   <type>[optional scope]: <description>
-#   [optional body]
-#   [optional footer(s)]
-#
-# Examples:
-#     feat(core): add multi‐tenant support
-#     fix(cli): resolve flag parsing error
-#     docs: update API usage examples
-#     docs(openai): update API usage examples
-#
-# Allowed Types:
-#   * feat       — a new feature (MINOR)
-#   * fix        — a bug fix (PATCH)
-#   * docs       — documentation only changes
-#   * style      — formatting, linting, etc.; no code change or typing refactors
-#   * refactor   — code change that neither fixes a bug nor adds a feature
-#   * perf       — code change that improves performance
-#   * test       — adding tests or correcting existing
-#   * build      — changes that affect the build system/external dependencies
-#   * ci         — continuous integration/configuration changes
-#   * chore      — other changes that don't modify source or test files
-#   * revert     — reverts a previous commit
-#   * release    — prepare a new release
-#
-# Allowed Scope(s) (optional):
-#   core, cli, langchain, langchain_v1, langchain-classic, model-profiles,
-#   standard-tests, text-splitters, docs, anthropic, chroma, deepseek, exa,
-#   fireworks, groq, huggingface, mistralai, nomic, ollama, openai,
-#   perplexity, prompty, qdrant, xai, infra, deps
-#
-# Multiple scopes can be used by separating them with a comma.
-#
-# Rules:
-#   1. The 'Type' must start with a lowercase letter.
-#   2. Breaking changes: append "!" after type/scope (e.g., feat!: drop x support)
-#   3. When releasing (updating the pyproject.toml and uv.lock), the commit message
-#      should be: `release(scope): x.y.z` (e.g., `release(core): 1.2.0` with no
-#      body, footer, or preceeding/proceeding text).
-#
-# Enforces Conventional Commits format for pull request titles to maintain a clear and
-# machine-readable change history.
-
-name: "🏷️ PR Title Lint"
-
-permissions:
-  pull-requests: read
-
-on:
-  pull_request:
-    types: [opened, edited, synchronize]
-
-jobs:
-  # Validates that PR title follows Conventional Commits 1.0.0 specification
-  lint-pr-title:
-    name: "validate format"
-    runs-on: ubuntu-latest
-    steps:
-      - name: "✅ Validate Conventional Commits Format"
-        uses: amannn/action-semantic-pull-request@v6
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          types: |
-            feat
-            fix
-            docs
-            style
-            refactor
-            perf
-            test
-            build
-            ci
-            chore
-            revert
-            release
-          scopes: |
-            core
-            cli
-            langchain
-            langchain-classic
-            model-profiles
-            standard-tests
-            text-splitters
-            docs
-            anthropic
-            chroma
-            deepseek
-            exa
-            fireworks
-            groq
-            huggingface
-            mistralai
-            nomic
-            ollama
-            openai
-            perplexity
-            prompty
-            qdrant
-            xai
-            infra
-            deps
-          requireScope: false
-          disallowScopes: |
-            release
-            [A-Z]+
-          ignoreLabels: |
-            ignore-lint-pr-title

.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: test
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+env:
+  POETRY_VERSION: "1.3.1"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "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
+      - name: Run unit tests
+        run: |
+          make tests

.github/workflows/v03_api_doc_build.yml

@@ -1,164 +0,0 @@
-# Build the API reference documentation for v0.3 branch.
-#
-# Manual trigger only.
-#
-# Built HTML pushed to langchain-ai/langchain-api-docs-html.
-#
-# Looks for langchain-ai org repos in packages.yml and checks them out.
-# Calls prep_api_docs_build.py.
-
-name: "📚 API Docs (v0.3)"
-run-name: "Build & Deploy API Reference (v0.3)"
-
-on:
-  workflow_dispatch:
-
-env:
-  PYTHON_VERSION: "3.11"
-
-jobs:
-  build:
-    if: github.repository == 'langchain-ai/langchain' || github.event_name != 'schedule'
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          ref: v0.3
-          path: langchain
-
-      - uses: actions/checkout@v6
-        with:
-          repository: langchain-ai/langchain-api-docs-html
-          path: langchain-api-docs-html
-          token: ${{ secrets.TOKEN_GITHUB_API_DOCS_HTML }}
-
-      - name: "📋 Extract Repository List with yq"
-        id: get-unsorted-repos
-        uses: mikefarah/yq@master
-        with:
-          cmd: |
-            # Extract repos from packages.yml that are in the langchain-ai org
-            # (excluding 'langchain' itself)
-            yq '
-              .packages[]
-              | select(
-                  (
-                    (.repo | test("^langchain-ai/"))
-                    and
-                    (.repo != "langchain-ai/langchain")
-                  )
-                  or
-                  (.include_in_api_ref // false)
-                )
-              | .repo
-            ' langchain/libs/packages.yml
-
-      - name: "📋 Parse YAML & Checkout Repositories"
-        env:
-          REPOS_UNSORTED: ${{ steps.get-unsorted-repos.outputs.result }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          # Get unique repositories
-          REPOS=$(echo "$REPOS_UNSORTED" | sort -u)
-          # Checkout each unique repository
-          for repo in $REPOS; do
-            # Validate repository format (allow any org with proper format)
-            if [[ ! "$repo" =~ ^[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+$ ]]; then
-              echo "Error: Invalid repository format: $repo"
-              exit 1
-            fi
-
-            REPO_NAME=$(echo $repo | cut -d'/' -f2)
-
-            # Additional validation for repo name
-            if [[ ! "$REPO_NAME" =~ ^[a-zA-Z0-9_.-]+$ ]]; then
-              echo "Error: Invalid repository name: $REPO_NAME"
-              exit 1
-            fi
-            echo "Checking out $repo to $REPO_NAME"
-
-            # Special handling for langchain-tavily: checkout by commit hash
-            if [[ "$REPO_NAME" == "langchain-tavily" ]]; then
-              git clone https://github.com/$repo.git $REPO_NAME
-              cd $REPO_NAME
-              git checkout f3515654724a9e87bdfe2c2f509d6cdde646e563
-              cd ..
-            else
-              git clone --depth 1 --branch v0.3 https://github.com/$repo.git $REPO_NAME
-            fi
-          done
-
-      - name: "🐍 Setup Python ${{ env.PYTHON_VERSION }}"
-        uses: actions/setup-python@v6
-        id: setup-python
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-
-      - name: "📦 Install Initial Python Dependencies using uv"
-        working-directory: langchain
-        run: |
-          python -m pip install -U uv
-          python -m uv pip install --upgrade --no-cache-dir pip setuptools pyyaml
-
-      - name: "📦 Organize Library Directories"
-        # Places cloned partner packages into libs/partners structure
-        run: python langchain/.github/scripts/prep_api_docs_build.py
-
-      - name: "🧹 Clear Prior Build"
-        run:
-          # Remove artifacts from prior docs build
-          rm -rf langchain-api-docs-html/api_reference_build/html
-
-      - name: "📦 Install Documentation Dependencies using uv"
-        working-directory: langchain
-        run: |
-          # Install all partner packages in editable mode with overrides
-          python -m uv pip install $(ls ./libs/partners | grep -v azure-ai | xargs -I {} echo "./libs/partners/{}") --overrides ./docs/vercel_overrides.txt --prerelease=allow
-
-          # Install langchain-azure-ai with tools extra
-          python -m uv pip install "./libs/partners/azure-ai[tools]" --overrides ./docs/vercel_overrides.txt --prerelease=allow
-
-          # Install core langchain and other main packages
-          python -m uv pip install libs/core libs/langchain libs/text-splitters libs/community libs/experimental libs/standard-tests
-
-          # Install Sphinx and related packages for building docs
-          python -m uv pip install -r docs/api_reference/requirements.txt
-
-      - name: "🔧 Configure Git Settings"
-        working-directory: langchain
-        run: |
-          git config --local user.email "actions@github.com"
-          git config --local user.name "Github Actions"
-
-      - name: "📚 Build API Documentation"
-        working-directory: langchain
-        run: |
-          # Generate the API reference RST files
-          python docs/api_reference/create_api_rst.py
-
-          # Build the HTML documentation using Sphinx
-          # -T: show full traceback on exception
-          # -E: don't use cached environment (force rebuild, ignore cached doctrees)
-          # -b html: build HTML docs (vs PDS, etc.)
-          # -d: path for the cached environment (parsed document trees / doctrees)
-          #     - Separate from output dir for faster incremental builds
-          # -c: path to conf.py
-          # -j auto: parallel build using all available CPU cores
-          python -m sphinx -T -E -b html -d ../langchain-api-docs-html/_build/doctrees -c docs/api_reference docs/api_reference ../langchain-api-docs-html/api_reference_build/html -j auto
-
-          # Post-process the generated HTML
-          python docs/api_reference/scripts/custom_formatter.py ../langchain-api-docs-html/api_reference_build/html
-
-          # Default index page is blank so we copy in the actual home page.
-          cp ../langchain-api-docs-html/api_reference_build/html/{reference,index}.html
-
-          # Removes Sphinx's intermediate build artifacts after the build is complete.
-          rm -rf ../langchain-api-docs-html/_build/
-
-      # Commit and push changes to langchain-api-docs-html repo
-      - uses: EndBug/add-and-commit@v9
-        with:
-          cwd: langchain-api-docs-html
-          message: "Update API docs build from v0.3 branch"

.gitignore

@@ -1,8 +1,5 @@
-.vs/
-.claude/
+.vscode/
 .idea/
-#Emacs backup
-*~
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -32,12 +29,6 @@ share/python-wheels/
 *.egg
 MANIFEST
 
-# Google GitHub Actions credentials files created by:
-# https://github.com/google-github-actions/auth
-#
-# That action recommends adding this gitignore to prevent accidentally committing keys.
-gha-creds-*.json
-
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
@@ -61,7 +52,6 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
-.codspeed/
 
 # Translations
 *.mo
@@ -80,6 +70,9 @@ instance/
 # Scrapy stuff:
 .scrapy
 
+# Sphinx documentation
+docs/_build/
+
 # PyBuilder
 target/
 
@@ -113,12 +106,12 @@ celerybeat.pid
 
 # Environments
 .env
-.envrc
-.venv*
-venv*
+.venv
 env/
+venv/
 ENV/
 env.bak/
+venv.bak/
 
 # Spyder project settings
 .spyderproject
@@ -132,37 +125,8 @@ env.bak/
 
 # mypy
 .mypy_cache/
-.mypy_cache_test/
 .dmypy.json
 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)]
-
-# Replit files
-*replit*
-
-node_modules
-
-prof
-virtualenv/
-scratch/
-
-.langgraph_api/

.markdownlint.json

@@ -1,14 +0,0 @@
-{
-  "MD013": false,
-  "MD024": {
-    "siblings_only": true
-  },
-  "MD025": false,
-  "MD033": false,
-  "MD034": false,
-  "MD036": false,
-  "MD041": false,
-  "MD046": {
-    "style": "fenced"
-  }
-}

.mcp.json

@@ -1,8 +0,0 @@
-{
-  "mcpServers": {
-    "docs-langchain": {
-      "type": "http",
-      "url": "https://docs.langchain.com/mcp"
-    }
-  }
-}

.pre-commit-config.yaml

@@ -1,99 +0,0 @@
-repos:
-  - repo: local
-    hooks:
-      - id: core
-        name: format and lint core
-        language: system
-        entry: make -C libs/core format lint
-        files: ^libs/core/
-        pass_filenames: false
-      - id: langchain
-        name: format and lint langchain
-        language: system
-        entry: make -C libs/langchain format lint
-        files: ^libs/langchain/
-        pass_filenames: false
-      - id: standard-tests
-        name: format and lint standard-tests
-        language: system
-        entry: make -C libs/standard-tests format lint
-        files: ^libs/standard-tests/
-        pass_filenames: false
-      - id: text-splitters
-        name: format and lint text-splitters
-        language: system
-        entry: make -C libs/text-splitters format lint
-        files: ^libs/text-splitters/
-        pass_filenames: false
-      - id: anthropic
-        name: format and lint partners/anthropic
-        language: system
-        entry: make -C libs/partners/anthropic format lint
-        files: ^libs/partners/anthropic/
-        pass_filenames: false
-      - id: chroma
-        name: format and lint partners/chroma
-        language: system
-        entry: make -C libs/partners/chroma format lint
-        files: ^libs/partners/chroma/
-        pass_filenames: false
-      - id: exa
-        name: format and lint partners/exa
-        language: system
-        entry: make -C libs/partners/exa format lint
-        files: ^libs/partners/exa/
-        pass_filenames: false
-      - id: fireworks
-        name: format and lint partners/fireworks
-        language: system
-        entry: make -C libs/partners/fireworks format lint
-        files: ^libs/partners/fireworks/
-        pass_filenames: false
-      - id: groq
-        name: format and lint partners/groq
-        language: system
-        entry: make -C libs/partners/groq format lint
-        files: ^libs/partners/groq/
-        pass_filenames: false
-      - id: huggingface
-        name: format and lint partners/huggingface
-        language: system
-        entry: make -C libs/partners/huggingface format lint
-        files: ^libs/partners/huggingface/
-        pass_filenames: false
-      - id: mistralai
-        name: format and lint partners/mistralai
-        language: system
-        entry: make -C libs/partners/mistralai format lint
-        files: ^libs/partners/mistralai/
-        pass_filenames: false
-      - id: nomic
-        name: format and lint partners/nomic
-        language: system
-        entry: make -C libs/partners/nomic format lint
-        files: ^libs/partners/nomic/
-        pass_filenames: false
-      - id: ollama
-        name: format and lint partners/ollama
-        language: system
-        entry: make -C libs/partners/ollama format lint
-        files: ^libs/partners/ollama/
-        pass_filenames: false
-      - id: openai
-        name: format and lint partners/openai
-        language: system
-        entry: make -C libs/partners/openai format lint
-        files: ^libs/partners/openai/
-        pass_filenames: false
-      - id: prompty
-        name: format and lint partners/prompty
-        language: system
-        entry: make -C libs/partners/prompty format lint
-        files: ^libs/partners/prompty/
-        pass_filenames: false
-      - id: qdrant
-        name: format and lint partners/qdrant
-        language: system
-        entry: make -C libs/partners/qdrant format lint
-        files: ^libs/partners/qdrant/
-        pass_filenames: false

.vscode/extensions.json

@@ -1,21 +0,0 @@
-{
-  "recommendations": [
-    "ms-python.python",
-    "charliermarsh.ruff",
-    "ms-python.mypy-type-checker",
-    "ms-toolsai.jupyter",
-    "ms-toolsai.jupyter-keymap",
-    "ms-toolsai.jupyter-renderers",
-    "ms-toolsai.vscode-jupyter-cell-tags",
-    "ms-toolsai.vscode-jupyter-slideshow",
-    "yzhang.markdown-all-in-one",
-    "davidanson.vscode-markdownlint",
-    "bierner.markdown-mermaid",
-    "bierner.markdown-preview-github-styles",
-    "eamodio.gitlens",
-    "github.vscode-pull-request-github",
-    "github.vscode-github-actions",
-    "redhat.vscode-yaml",
-    "editorconfig.editorconfig",
-  ],
-}

.vscode/settings.json

@@ -1,78 +0,0 @@
-{
-  "python.analysis.include": [
-    "libs/**",
-  ],
-  "python.analysis.exclude": [
-    "**/node_modules",
-    "**/__pycache__",
-    "**/.pytest_cache",
-    "**/.*",
-  ],
-  "python.analysis.autoImportCompletions": true,
-  "python.analysis.typeCheckingMode": "basic",
-  "python.testing.cwd": "${workspaceFolder}",
-  "python.linting.enabled": true,
-  "python.linting.ruffEnabled": true,
-  "[python]": {
-    "editor.formatOnSave": true,
-    "editor.codeActionsOnSave": {
-      "source.organizeImports.ruff": "explicit",
-      "source.fixAll": "explicit"
-    },
-    "editor.defaultFormatter": "charliermarsh.ruff"
-  },
-  "editor.rulers": [
-    88
-  ],
-  "editor.tabSize": 4,
-  "editor.insertSpaces": true,
-  "editor.trimAutoWhitespace": true,
-  "files.trimTrailingWhitespace": true,
-  "files.insertFinalNewline": true,
-  "files.exclude": {
-    "**/__pycache__": true,
-    "**/.pytest_cache": true,
-    "**/*.pyc": true,
-    "**/.mypy_cache": true,
-    "**/.ruff_cache": true,
-    "_dist/**": true,
-    "**/node_modules": true,
-    "**/.git": false
-  },
-  "search.exclude": {
-    "**/__pycache__": true,
-    "**/*.pyc": true,
-    "_dist/**": true,
-    "**/node_modules": true,
-    "**/.git": true,
-    "uv.lock": true,
-    "yarn.lock": true
-  },
-  "git.autofetch": true,
-  "git.enableSmartCommit": true,
-  "jupyter.askForKernelRestart": false,
-  "jupyter.interactiveWindow.textEditor.executeSelection": true,
-  "[markdown]": {
-    "editor.wordWrap": "on",
-    "editor.quickSuggestions": {
-      "comments": "off",
-      "strings": "off",
-      "other": "off"
-    }
-  },
-  "[yaml]": {
-    "editor.tabSize": 2,
-    "editor.insertSpaces": true
-  },
-  "[json]": {
-    "editor.tabSize": 2,
-    "editor.insertSpaces": true
-  },
-  "python.terminal.activateEnvironment": false,
-  "python.defaultInterpreterPath": "./.venv/bin/python",
-  "github.copilot.chat.commitMessageGeneration.instructions": [
-    {
-      "file": ".github/workflows/pr_lint.yml"
-    }
-  ]
-}

AGENTS.md

@@ -1,181 +0,0 @@
-# Global development guidelines for the LangChain monorepo
-
-This document provides context to understand the LangChain Python project and assist with development.
-
-## Project architecture and context
-
-### Monorepo structure
-
-This is a Python monorepo with multiple independently versioned packages that use `uv`.
-
-```txt
-langchain/
-├── libs/
-│   ├── core/             # `langchain-core` primitives and base abstractions
-│   ├── langchain/        # `langchain-classic` (legacy, no new features)
-│   ├── langchain_v1/     # Actively maintained `langchain` package
-│   ├── partners/         # Third-party integrations
-│   │   ├── openai/       # OpenAI models and embeddings
-│   │   ├── anthropic/    # Anthropic (Claude) integration
-│   │   ├── ollama/       # Local model support
-│   │   └── ... (other integrations maintained by the LangChain team)
-│   ├── text-splitters/   # Document chunking utilities
-│   ├── standard-tests/   # Shared test suite for integrations
-│   ├── model-profiles/   # Model configuration profiles
-│   └── cli/              # Command-line interface tools
-├── .github/              # CI/CD workflows and templates
-├── .vscode/              # VSCode IDE standard settings and recommended extensions
-└── README.md             # Information about LangChain
-```
-
-- **Core layer** (`langchain-core`): Base abstractions, interfaces, and protocols. Users should not need to know about this layer directly.
-- **Implementation layer** (`langchain`): Concrete implementations and high-level public utilities
-- **Integration layer** (`partners/`): Third-party service integrations. Note that this monorepo is not exhaustive of all LangChain integrations; some are maintained in separate repos, such as `langchain-ai/langchain-google` and `langchain-ai/langchain-aws`. Usually these repos are cloned at the same level as this monorepo, so if needed, you can refer to their code directly by navigating to `../langchain-google/` from this monorepo.
-- **Testing layer** (`standard-tests/`): Standardized integration tests for partner integrations
-
-### Development tools & commands**
-
-- `uv` – Fast Python package installer and resolver (replaces pip/poetry)
-- `make` – Task runner for common development commands. Feel free to look at the `Makefile` for available commands and usage patterns.
-- `ruff` – Fast Python linter and formatter
-- `mypy` – Static type checking
-- `pytest` – Testing framework
-
-This monorepo uses `uv` for dependency management. Local development uses editable installs: `[tool.uv.sources]`
-
-Each package in `libs/` has its own `pyproject.toml` and `uv.lock`.
-
-```bash
-# Run unit tests (no network)
-make test
-
-# Run specific test file
-uv run --group test pytest tests/unit_tests/test_specific.py
-```
-
-```bash
-# Lint code
-make lint
-
-# Format code
-make format
-
-# Type checking
-uv run --group lint mypy .
-```
-
-#### Key config files
-
-- pyproject.toml: Main workspace configuration with dependency groups
-- uv.lock: Locked dependencies for reproducible builds
-- Makefile: Development tasks
-
-#### Commit standards
-
-Suggest PR titles that follow Conventional Commits format. Refer to .github/workflows/pr_lint for allowed types and scopes.
-
-#### Pull request guidelines
-
-- Always add a disclaimer to the PR description mentioning how AI agents are involved with the contribution.
-- Describe the "why" of the changes, why the proposed solution is the right one. Limit prose.
-- Highlight areas of the proposed changes that require careful review.
-
-## Core development principles
-
-### Maintain stable public interfaces
-
-CRITICAL: Always attempt to preserve function signatures, argument positions, and names for exported/public methods. Do not make breaking changes.
-
-**Before making ANY changes to public APIs:**
-
-- Check if the function/class is exported in `__init__.py`
-- Look for existing usage patterns in tests and examples
-- Use keyword-only arguments for new parameters: `*, new_param: str = "default"`
-- Mark experimental features clearly with docstring warnings (using MkDocs Material admonitions, like `!!! warning`)
-
-Ask: "Would this change break someone's code if they used it last week?"
-
-### Code quality standards
-
-All Python code MUST include type hints and return types.
-
-```python title="Example"
-def filter_unknown_users(users: list[str], known_users: set[str]) -> list[str]:
-    """Single line description of the function.
-
-    Any additional context about the function can go here.
-
-    Args:
-        users: List of user identifiers to filter.
-        known_users: Set of known/valid user identifiers.
-
-    Returns:
-        List of users that are not in the known_users set.
-    """
-```
-
-- Use descriptive, self-explanatory variable names.
-- Follow existing patterns in the codebase you're modifying
-- Attempt to break up complex functions (>20 lines) into smaller, focused functions where it makes sense
-
-### Testing requirements
-
-Every new feature or bugfix MUST be covered by unit tests.
-
-- Unit tests: `tests/unit_tests/` (no network calls allowed)
-- Integration tests: `tests/integration_tests/` (network calls permitted)
-- We use `pytest` as the testing framework; if in doubt, check other existing tests for examples.
-- The testing file structure should mirror the source code structure.
-
-**Checklist:**
-
-- [ ] Tests fail when your new logic is broken
-- [ ] Happy path is covered
-- [ ] Edge cases and error conditions are tested
-- [ ] Use fixtures/mocks for external dependencies
-- [ ] Tests are deterministic (no flaky tests)
-- [ ] Does the test suite fail if your new logic is broken?
-
-### Security and risk assessment
-
-- No `eval()`, `exec()`, or `pickle` on user-controlled input
-- Proper exception handling (no bare `except:`) and use a `msg` variable for error messages
-- Remove unreachable/commented code before committing
-- Race conditions or resource leaks (file handles, sockets, threads).
-- Ensure proper resource cleanup (file handles, connections)
-
-### Documentation standards
-
-Use Google-style docstrings with Args section for all public functions.
-
-```python title="Example"
-def send_email(to: str, msg: str, *, priority: str = "normal") -> bool:
-    """Send an email to a recipient with specified priority.
-
-    Any additional context about the function can go here.
-
-    Args:
-        to: The email address of the recipient.
-        msg: The message body to send.
-        priority: Email priority level.
-
-    Returns:
-        `True` if email was sent successfully, `False` otherwise.
-
-    Raises:
-        InvalidEmailError: If the email address format is invalid.
-        SMTPConnectionError: If unable to connect to email server.
-    """
-```
-
-- Types go in function signatures, NOT in docstrings
-  - If a default is present, DO NOT repeat it in the docstring unless there is post-processing or it is set conditionally.
-- Focus on "why" rather than "what" in descriptions
-- Document all parameters, return values, and exceptions
-- Keep descriptions concise but clear
-- Ensure American English spelling (e.g., "behavior", not "behaviour")
-
-## Additional resources
-
-- **Documentation:** https://docs.langchain.com/oss/python/langchain/overview and source at https://github.com/langchain-ai/docs or `../docs/`. Prefer the local install and use file search tools for best results. If needed, use the docs MCP server as defined in `.mcp.json` for programmatic access.
-- **Contributing Guide:** [`.github/CONTRIBUTING.md`](https://docs.langchain.com/oss/python/contributing/overview)

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/langchain-ai/langchain"

CLAUDE.md

@@ -1,181 +0,0 @@
-# Global development guidelines for the LangChain monorepo
-
-This document provides context to understand the LangChain Python project and assist with development.
-
-## Project architecture and context
-
-### Monorepo structure
-
-This is a Python monorepo with multiple independently versioned packages that use `uv`.
-
-```txt
-langchain/
-├── libs/
-│   ├── core/             # `langchain-core` primitives and base abstractions
-│   ├── langchain/        # `langchain-classic` (legacy, no new features)
-│   ├── langchain_v1/     # Actively maintained `langchain` package
-│   ├── partners/         # Third-party integrations
-│   │   ├── openai/       # OpenAI models and embeddings
-│   │   ├── anthropic/    # Anthropic (Claude) integration
-│   │   ├── ollama/       # Local model support
-│   │   └── ... (other integrations maintained by the LangChain team)
-│   ├── text-splitters/   # Document chunking utilities
-│   ├── standard-tests/   # Shared test suite for integrations
-│   ├── model-profiles/   # Model configuration profiles
-│   └── cli/              # Command-line interface tools
-├── .github/              # CI/CD workflows and templates
-├── .vscode/              # VSCode IDE standard settings and recommended extensions
-└── README.md             # Information about LangChain
-```
-
-- **Core layer** (`langchain-core`): Base abstractions, interfaces, and protocols. Users should not need to know about this layer directly.
-- **Implementation layer** (`langchain`): Concrete implementations and high-level public utilities
-- **Integration layer** (`partners/`): Third-party service integrations. Note that this monorepo is not exhaustive of all LangChain integrations; some are maintained in separate repos, such as `langchain-ai/langchain-google` and `langchain-ai/langchain-aws`. Usually these repos are cloned at the same level as this monorepo, so if needed, you can refer to their code directly by navigating to `../langchain-google/` from this monorepo.
-- **Testing layer** (`standard-tests/`): Standardized integration tests for partner integrations
-
-### Development tools & commands**
-
-- `uv` – Fast Python package installer and resolver (replaces pip/poetry)
-- `make` – Task runner for common development commands. Feel free to look at the `Makefile` for available commands and usage patterns.
-- `ruff` – Fast Python linter and formatter
-- `mypy` – Static type checking
-- `pytest` – Testing framework
-
-This monorepo uses `uv` for dependency management. Local development uses editable installs: `[tool.uv.sources]`
-
-Each package in `libs/` has its own `pyproject.toml` and `uv.lock`.
-
-```bash
-# Run unit tests (no network)
-make test
-
-# Run specific test file
-uv run --group test pytest tests/unit_tests/test_specific.py
-```
-
-```bash
-# Lint code
-make lint
-
-# Format code
-make format
-
-# Type checking
-uv run --group lint mypy .
-```
-
-#### Key config files
-
-- pyproject.toml: Main workspace configuration with dependency groups
-- uv.lock: Locked dependencies for reproducible builds
-- Makefile: Development tasks
-
-#### Commit standards
-
-Suggest PR titles that follow Conventional Commits format. Refer to .github/workflows/pr_lint for allowed types and scopes.
-
-#### Pull request guidelines
-
-- Always add a disclaimer to the PR description mentioning how AI agents are involved with the contribution.
-- Describe the "why" of the changes, why the proposed solution is the right one. Limit prose.
-- Highlight areas of the proposed changes that require careful review.
-
-## Core development principles
-
-### Maintain stable public interfaces
-
-CRITICAL: Always attempt to preserve function signatures, argument positions, and names for exported/public methods. Do not make breaking changes.
-
-**Before making ANY changes to public APIs:**
-
-- Check if the function/class is exported in `__init__.py`
-- Look for existing usage patterns in tests and examples
-- Use keyword-only arguments for new parameters: `*, new_param: str = "default"`
-- Mark experimental features clearly with docstring warnings (using MkDocs Material admonitions, like `!!! warning`)
-
-Ask: "Would this change break someone's code if they used it last week?"
-
-### Code quality standards
-
-All Python code MUST include type hints and return types.
-
-```python title="Example"
-def filter_unknown_users(users: list[str], known_users: set[str]) -> list[str]:
-    """Single line description of the function.
-
-    Any additional context about the function can go here.
-
-    Args:
-        users: List of user identifiers to filter.
-        known_users: Set of known/valid user identifiers.
-
-    Returns:
-        List of users that are not in the known_users set.
-    """
-```
-
-- Use descriptive, self-explanatory variable names.
-- Follow existing patterns in the codebase you're modifying
-- Attempt to break up complex functions (>20 lines) into smaller, focused functions where it makes sense
-
-### Testing requirements
-
-Every new feature or bugfix MUST be covered by unit tests.
-
-- Unit tests: `tests/unit_tests/` (no network calls allowed)
-- Integration tests: `tests/integration_tests/` (network calls permitted)
-- We use `pytest` as the testing framework; if in doubt, check other existing tests for examples.
-- The testing file structure should mirror the source code structure.
-
-**Checklist:**
-
-- [ ] Tests fail when your new logic is broken
-- [ ] Happy path is covered
-- [ ] Edge cases and error conditions are tested
-- [ ] Use fixtures/mocks for external dependencies
-- [ ] Tests are deterministic (no flaky tests)
-- [ ] Does the test suite fail if your new logic is broken?
-
-### Security and risk assessment
-
-- No `eval()`, `exec()`, or `pickle` on user-controlled input
-- Proper exception handling (no bare `except:`) and use a `msg` variable for error messages
-- Remove unreachable/commented code before committing
-- Race conditions or resource leaks (file handles, sockets, threads).
-- Ensure proper resource cleanup (file handles, connections)
-
-### Documentation standards
-
-Use Google-style docstrings with Args section for all public functions.
-
-```python title="Example"
-def send_email(to: str, msg: str, *, priority: str = "normal") -> bool:
-    """Send an email to a recipient with specified priority.
-
-    Any additional context about the function can go here.
-
-    Args:
-        to: The email address of the recipient.
-        msg: The message body to send.
-        priority: Email priority level.
-
-    Returns:
-        `True` if email was sent successfully, `False` otherwise.
-
-    Raises:
-        InvalidEmailError: If the email address format is invalid.
-        SMTPConnectionError: If unable to connect to email server.
-    """
-```
-
-- Types go in function signatures, NOT in docstrings
-  - If a default is present, DO NOT repeat it in the docstring unless there is post-processing or it is set conditionally.
-- Focus on "why" rather than "what" in descriptions
-- Document all parameters, return values, and exceptions
-- Keep descriptions concise but clear
-- Ensure American English spelling (e.g., "behavior", not "behaviour")
-
-## Additional resources
-
-- **Documentation:** https://docs.langchain.com/oss/python/langchain/overview and source at https://github.com/langchain-ai/docs or `../docs/`. Prefer the local install and use file search tools for best results. If needed, use the docs MCP server as defined in `.mcp.json` for programmatic access.
-- **Contributing Guide:** [`.github/CONTRIBUTING.md`](https://docs.langchain.com/oss/python/contributing/overview)

CONTRIBUTING.md

@@ -0,0 +1,154 @@
+# Contributing to LangChain
+
+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 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.
+
+## 🗺️Contributing Guidelines
+
+### 🚩GitHub Issues
+
+Our [issues](https://github.com/hwchase17/langchain/issues) page is kept up to date
+with bugs, improvements, and feature requests. There is a taxonomy of labels to help
+with sorting and discovery of issues of interest. These include:
+
+- 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 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 just let us know.
+
+### 🙋Getting Help
+
+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.
+
+### 🏭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.
+
+To install requirements:
+
+```bash
+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.
+
+Now, you should be able to run the common tasks in the following section.
+
+### ✅Common Tasks
+
+#### 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/).
+
+To run formatting for this project:
+
+```bash
+make format
+```
+
+#### 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/).
+
+To run linting for this project:
+
+```bash
+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
+
+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.
+
+To get a report of current coverage, run the following:
+
+```bash
+make coverage
+```
+
+#### Testing
+
+Unit tests cover modular logic that does not require calls to outside APIs.
+
+To run unit tests:
+
+```bash
+make tests
+```
+
+If you add new logic, please add a unit test.
+
+Integration tests cover logic that requires making calls to outside APIs (often integration with other services).
+
+To run integration tests:
+
+```bash
+make integration_tests
+```
+
+If you add support for a new external API, please add a new integration test.
+
+#### Adding a Jupyter Notebook
+
+If you are adding a Jupyter notebook example, you'll want to install the optional `dev` dependencies.
+
+To install dev dependencies:
+
+```bash
+poetry install --with dev
+```
+
+Launch a notebook:
+
+```bash
+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.
+
+#### 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.

LICENSE

@@ -1,6 +1,6 @@
-MIT License
+The MIT License
 
-Copyright (c) LangChain, Inc.
+Copyright (c) Harrison Chase
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Makefile

@@ -0,0 +1,23 @@
+.PHONY: format lint tests integration_tests
+
+coverage:
+	poetry run pytest --cov \
+		--cov-config=.coveragerc \
+		--cov-report xml \
+		--cov-report term-missing:skip-covered
+
+format:
+	poetry run black .
+	poetry run isort .
+
+lint:
+	poetry run mypy .
+	poetry run black . --check
+	poetry run isort . --check
+	poetry run flake8 .
+
+tests:
+	poetry run pytest tests/unit_tests
+
+integration_tests:
+	poetry run pytest tests/integration_tests

README.md

@@ -1,74 +1,57 @@
-<div align="center">
-  <a href="https://www.langchain.com/">
-    <picture>
-      <source media="(prefers-color-scheme: light)" srcset=".github/images/logo-dark.svg">
-      <source media="(prefers-color-scheme: dark)" srcset=".github/images/logo-light.svg">
-      <img alt="LangChain Logo" src=".github/images/logo-dark.svg" width="80%">
-    </picture>
-  </a>
-</div>
+# 🦜️🔗 LangChain
 
-<div align="center">
-  <h3>The platform for reliable agents.</h3>
-</div>
+⚡ Building applications with LLMs through composability ⚡
 
-<div align="center">
-  <a href="https://opensource.org/licenses/MIT" target="_blank"><img src="https://img.shields.io/pypi/l/langchain" alt="PyPI - License"></a>
-  <a href="https://pypistats.org/packages/langchain" target="_blank"><img src="https://img.shields.io/pepy/dt/langchain" alt="PyPI - Downloads"></a>
-  <a href="https://pypi.org/project/langchain/#history" target="_blank"><img src="https://img.shields.io/pypi/v/langchain?label=%20" alt="Version"></a>
-  <a href="https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/langchain-ai/langchain" target="_blank"><img src="https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode" alt="Open in Dev Containers"></a>
-  <a href="https://codespaces.new/langchain-ai/langchain" target="_blank"><img src="https://github.com/codespaces/badge.svg" alt="Open in Github Codespace" title="Open in Github Codespace" width="150" height="20"></a>
-  <a href="https://codspeed.io/langchain-ai/langchain" target="_blank"><img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" alt="CodSpeed Badge"></a>
-  <a href="https://twitter.com/langchainai" target="_blank"><img src="https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI" alt="Twitter / X"></a>
-</div>
+[![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)
 
-LangChain is a framework for building agents and LLM-powered applications. It helps you chain together interoperable components and third-party integrations to simplify AI application development – all while future-proofing decisions as the underlying technology evolves.
+## Quick Install
 
-```bash
-pip install langchain
-```
+`pip install langchain`
 
-If you're looking for more advanced customization or agent orchestration, check out [LangGraph](https://docs.langchain.com/oss/python/langgraph/overview), our framework for building controllable agent workflows.
+## 🤔 What is this?
 
----
+Large language models (LLMs) are emerging as a transformative technology, enabling
+developers to build applications that they previously could not.
+But using these LLMs in isolation is often not enough to
+create a truly powerful app - the real power comes when you can combine them with other sources of computation or knowledge.
 
-**Documentation**:
+This library is aimed at assisting in the development of those types of applications.
 
-- [docs.langchain.com](https://docs.langchain.com/oss/python/langchain/overview) – Comprehensive documentation, including conceptual overviews and guides
-- [reference.langchain.com/python](https://reference.langchain.com/python) – API reference docs for LangChain packages
+## 📖 Documentation
 
-**Discussions**: Visit the [LangChain Forum](https://forum.langchain.com) to connect with the community and share all of your technical questions, ideas, and feedback.
+Please see [here](https://langchain.readthedocs.io/en/latest/?) for full documentation on:
 
-> [!NOTE]
-> Looking for the JS/TS library? Check out [LangChain.js](https://github.com/langchain-ai/langchainjs).
+- 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)
 
-## Why use LangChain?
+## 🚀 What can this help with?
 
-LangChain helps developers build applications powered by LLMs through a standard interface for models, embeddings, vector stores, and more.
+There are four main areas that LangChain is designed to help with.
+These are, in increasing order of complexity:
 
-Use LangChain for:
+**📃 LLMs and Prompts:**
 
-- **Real-time data augmentation**. Easily connect LLMs to diverse data sources and external/internal systems, drawing from LangChain's vast library of integrations with model providers, tools, vector stores, retrievers, and more.
-- **Model interoperability**. Swap models in and out as your engineering team experiments to find the best choice for your application's needs. As the industry frontier evolves, adapt quickly – LangChain's abstractions keep you moving without losing momentum.
-- **Rapid prototyping**. Quickly build and iterate on LLM applications with LangChain's modular, component-based architecture. Test different approaches and workflows without rebuilding from scratch, accelerating your development cycle.
-- **Production-ready features**. Deploy reliable applications with built-in support for monitoring, evaluation, and debugging through integrations like LangSmith. Scale with confidence using battle-tested patterns and best practices.
-- **Vibrant community and ecosystem**. Leverage a rich ecosystem of integrations, templates, and community-contributed components. Benefit from continuous improvements and stay up-to-date with the latest AI developments through an active open-source community.
-- **Flexible abstraction layers**. Work at the level of abstraction that suits your needs - from high-level chains for quick starts to low-level components for fine-grained control. LangChain grows with your application's complexity.
+This includes prompt management, prompt optimization, generic interface for all LLMs, and common utilities for working with LLMs.
 
-## LangChain ecosystem
+**🔗 Chains:**
 
-While the LangChain framework can be used standalone, it also integrates seamlessly with any LangChain product, giving developers a full suite of tools when building LLM applications.
+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.
 
-To improve your LLM application development, pair LangChain with:
+**🤖 Agents:**
 
-- [LangGraph](https://docs.langchain.com/oss/python/langgraph/overview) – Build agents that can reliably handle complex tasks with LangGraph, our low-level agent orchestration framework. LangGraph offers customizable architecture, long-term memory, and human-in-the-loop workflows – and is trusted in production by companies like LinkedIn, Uber, Klarna, and GitLab.
-- [Integrations](https://docs.langchain.com/oss/python/integrations/providers/overview) – List of LangChain integrations, including chat & embedding models, tools & toolkits, and more
-- [LangSmith](https://www.langchain.com/langsmith) – Helpful for agent evals and observability. Debug poor-performing LLM app runs, evaluate agent trajectories, gain visibility in production, and improve performance over time.
-- [LangSmith Deployment](https://docs.langchain.com/langsmith/deployments) – Deploy and scale agents effortlessly with a purpose-built deployment platform for long-running, stateful workflows. Discover, reuse, configure, and share agents across teams – and iterate quickly with visual prototyping in [LangSmith Studio](https://docs.langchain.com/langsmith/studio).
-- [Deep Agents](https://github.com/langchain-ai/deepagents) *(new!)* – Build agents that can plan, use subagents, and leverage file systems for complex tasks
+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.
 
-## Additional resources
+**🧠 Memory:**
 
-- [API Reference](https://reference.langchain.com/python) – Detailed reference on navigating base packages and integrations for LangChain.
-- [Contributing Guide](https://docs.langchain.com/oss/python/contributing/overview) – Learn how to contribute to LangChain projects and find good first issues.
-- [Code of Conduct](https://github.com/langchain-ai/langchain/blob/master/.github/CODE_OF_CONDUCT.md) – Our community guidelines and standards for participation.
+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.
+
+For more information on these concepts, please see our [full documentation](https://langchain.readthedocs.io/en/latest/?).
+
+## 💁 Contributing
+
+As an open source project in a rapidly developing field, we are extremely open
+to contributions, whether it be in the form of a new feature, improved infra, or better documentation.
+
+For detailed information on how to contribute, see [here](CONTRIBUTING.md).

docs/Makefile

@@ -0,0 +1,21 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SPHINXAUTOBUILD   ?= sphinx-autobuild
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,90 @@
+"""Configuration file for the Sphinx documentation builder."""
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+import toml
+
+with open("../pyproject.toml") as f:
+    data = toml.load(f)
+
+# -- Project information -----------------------------------------------------
+
+project = "LangChain"
+copyright = "2022, Harrison Chase"
+author = "Harrison Chase"
+
+version = data["tool"]["poetry"]["version"]
+release = version
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autodoc.typehints",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinxcontrib.autodoc_pydantic",
+    "myst_parser",
+    "nbsphinx",
+    "sphinx_panels",
+]
+
+
+autodoc_pydantic_model_show_json = False
+autodoc_pydantic_field_list_validators = False
+autodoc_pydantic_config_members = False
+autodoc_pydantic_model_show_config_summary = False
+autodoc_pydantic_model_show_validator_members = False
+autodoc_pydantic_model_show_field_summary = False
+autodoc_pydantic_model_members = False
+autodoc_pydantic_model_undoc_members = False
+# autodoc_typehints = "signature"
+# autodoc_typehints = "description"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+# html_theme = "sphinx_typlog_theme"
+
+html_context = {
+    "display_github": True,  # Integrate GitHub
+    "github_user": "hwchase17",  # Username
+    "github_repo": "langchain",  # Repo name
+    "github_version": "master",  # Version
+    "conf_py_path": "/docs/",  # Path in the checkout to the docs root
+}
+
+# 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: list = []

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

@@ -0,0 +1,212 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "f1390152",
+   "metadata": {},
+   "source": [
+    "# MRKL\n",
+    "\n",
+    "This notebook showcases using an agent to replicate the MRKL chain."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "39ea3638",
+   "metadata": {},
+   "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": "ac561cc4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain import LLMMathChain, OpenAI, SerpAPIWrapper, SQLDatabase, SQLDatabaseChain\n",
+    "from langchain.agents import initialize_agent, Tool"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "07e96d99",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "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(llm=llm, database=db, 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. You should ask targeted questions\"\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",
+    "    Tool(\n",
+    "        name=\"FooBar DB\",\n",
+    "        func=db_chain.run,\n",
+    "        description=\"useful for when you need to answer questions about FooBar. Input should be in the form of a question containing full context\"\n",
+    "    )\n",
+    "]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "a069c4b6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "mrkl = initialize_agent(tools, llm, agent=\"zero-shot-react-description\", verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "e603cd7d",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\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 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: 28^0.23\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\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",
+      "\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: 2.1520202182226886\n",
+      "\u001b[0m\n",
+      "Thought:\u001b[32;1m\u001b[1;3m I now know the final answer.\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": [
+       "\"Harry Styles, Olivia Wilde's boyfriend, is 28 years old and his age raised to the 0.23 power is 2.1520202182226886.\""
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "mrkl.run(\"Who is Olivia Wilde's boyfriend? What is his current age raised to the 0.23 power?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "a5c07010",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\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 ...\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:\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 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 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": [
+       "\"Alanis Morissette's album 'Jagged Little Pill' is in the FooBar database.\""
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "mrkl.run(\"What is the full name of the artist who recently released an album called 'The Storm Before the Calm' and are they in the FooBar database? If so, what albums of theirs are in the FooBar database?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "af016a70",
+   "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/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

@@ -0,0 +1,93 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "0c3f1df8",
+   "metadata": {},
+   "source": [
+    "# Self Ask With Search\n",
+    "\n",
+    "This notebook showcases the Self Ask With Search chain."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "7e3b513e",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\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\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",
+      "\u001b[1m> Finished SelfAskWithSearchAgent chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'El Palmar, Spain'"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from langchain import OpenAI, SerpAPIWrapper\n",
+    "from langchain.agents import initialize_agent, Tool\n",
+    "\n",
+    "llm = OpenAI(temperature=0)\n",
+    "search = SerpAPIWrapper()\n",
+    "tools = [\n",
+    "    Tool(\n",
+    "        name=\"Intermediate Answer\",\n",
+    "        func=search.run\n",
+    "    )\n",
+    "]\n",
+    "\n",
+    "self_ask_with_search = initialize_agent(tools, llm, agent=\"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": "683d69e7",
+   "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.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

@@ -0,0 +1,971 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "b253f4d5",
+   "metadata": {},
+   "source": [
+    "# ChatGPT Clone\n",
+    "\n",
+    "This chain replicates ChatGPT by combining (1) a specific prompt, and (2) the concept of memory.\n",
+    "\n",
+    "Shows off the example as in https://www.engraved.blog/building-a-virtual-machine-inside/"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 38,
+   "id": "a99acd89",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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",
+      "\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 LLMChain chain.\u001b[0m\n",
+      "\n",
+      "```\n",
+      "$ pwd\n",
+      "/\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "from langchain import OpenAI, ConversationChain, LLMChain, PromptTemplate\n",
+    "from langchain.chains.conversation.memory import ConversationalBufferWindowMemory\n",
+    "\n",
+    "\n",
+    "template = \"\"\"Assistant is a large language model trained by OpenAI.\n",
+    "\n",
+    "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+    "\n",
+    "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+    "\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",
+    "{history}\n",
+    "Human: {human_input}\n",
+    "Assistant:\"\"\"\n",
+    "\n",
+    "prompt = PromptTemplate(\n",
+    "    input_variables=[\"history\", \"human_input\"], \n",
+    "    template=template\n",
+    ")\n",
+    "\n",
+    "\n",
+    "chatgpt_chain = LLMChain(\n",
+    "    llm=OpenAI(temperature=0), \n",
+    "    prompt=prompt, \n",
+    "    verbose=True, \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 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": 39,
+   "id": "4ef711d6",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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 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",
+      "/\n",
+      "```\n",
+      "Human: ls ~\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      "\n",
+      "```\n",
+      "$ ls ~\n",
+      "Desktop  Documents  Downloads  Music  Pictures  Public  Templates  Videos\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"ls ~\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 40,
+   "id": "a5d6dac2",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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 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",
+      "/\n",
+      "```\n",
+      "Human: ls ~\n",
+      "AI: \n",
+      "```\n",
+      "$ ls ~\n",
+      "Desktop  Documents  Downloads  Music  Pictures  Public  Templates  Videos\n",
+      "```\n",
+      "Human: cd ~\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      " \n",
+      "```\n",
+      "$ cd ~\n",
+      "$ pwd\n",
+      "/home/user\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"cd ~\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 41,
+   "id": "b9283077",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: ls ~\n",
+      "AI: \n",
+      "```\n",
+      "$ ls ~\n",
+      "Desktop  Documents  Downloads  Music  Pictures  Public  Templates  Videos\n",
+      "```\n",
+      "Human: cd ~\n",
+      "AI:  \n",
+      "```\n",
+      "$ cd ~\n",
+      "$ pwd\n",
+      "/home/user\n",
+      "```\n",
+      "Human: {Please make a file jokes.txt inside and put some jokes inside}\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      "\n",
+      "\n",
+      "```\n",
+      "$ touch jokes.txt\n",
+      "$ echo \"Why did the chicken cross the road? To get to the other side!\" >> jokes.txt\n",
+      "$ echo \"What did the fish say when it hit the wall? Dam!\" >> jokes.txt\n",
+      "$ echo \"Why did the scarecrow win the Nobel Prize? Because he was outstanding in his field!\" >> jokes.txt\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"{Please make a file jokes.txt inside and put some jokes inside}\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 42,
+   "id": "570e785e",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: cd ~\n",
+      "AI:  \n",
+      "```\n",
+      "$ cd ~\n",
+      "$ pwd\n",
+      "/home/user\n",
+      "```\n",
+      "Human: {Please make a file jokes.txt inside and put some jokes inside}\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ touch jokes.txt\n",
+      "$ echo \"Why did the chicken cross the road? To get to the other side!\" >> jokes.txt\n",
+      "$ echo \"What did the fish say when it hit the wall? Dam!\" >> jokes.txt\n",
+      "$ echo \"Why did the scarecrow win the Nobel Prize? Because he was outstanding in his field!\" >> jokes.txt\n",
+      "```\n",
+      "Human: echo -e \"x=lambda y:y*5+3;print('Result:' + str(x(6)))\" > run.py && python3 run.py\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      "\n",
+      "\n",
+      "```\n",
+      "$ echo -e \"x=lambda y:y*5+3;print('Result:' + str(x(6)))\" > run.py\n",
+      "$ python3 run.py\n",
+      "Result: 33\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"\"\"echo -e \"x=lambda y:y*5+3;print('Result:' + str(x(6)))\" > run.py && python3 run.py\"\"\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 43,
+   "id": "cd0a23d9",
+   "metadata": {
+    "scrolled": true
+   },
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: {Please make a file jokes.txt inside and put some jokes inside}\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ touch jokes.txt\n",
+      "$ echo \"Why did the chicken cross the road? To get to the other side!\" >> jokes.txt\n",
+      "$ echo \"What did the fish say when it hit the wall? Dam!\" >> jokes.txt\n",
+      "$ echo \"Why did the scarecrow win the Nobel Prize? Because he was outstanding in his field!\" >> jokes.txt\n",
+      "```\n",
+      "Human: echo -e \"x=lambda y:y*5+3;print('Result:' + str(x(6)))\" > run.py && python3 run.py\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ echo -e \"x=lambda y:y*5+3;print('Result:' + str(x(6)))\" > run.py\n",
+      "$ python3 run.py\n",
+      "Result: 33\n",
+      "```\n",
+      "Human: echo -e \"print(list(filter(lambda x: all(x%d for d in range(2,x)),range(2,3**10)))[:10])\" > run.py && python3 run.py\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      "\n",
+      "\n",
+      "```\n",
+      "$ echo -e \"print(list(filter(lambda x: all(x%d for d in range(2,x)),range(2,3**10)))[:10])\" > run.py\n",
+      "$ python3 run.py\n",
+      "[2, 3, 5, 7, 11, 13, 17, 19, 23, 29]\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"\"\"echo -e \"print(list(filter(lambda x: all(x%d for d in range(2,x)),range(2,3**10)))[:10])\" > run.py && python3 run.py\"\"\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 44,
+   "id": "90db6eb2",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: echo -e \"x=lambda y:y*5+3;print('Result:' + str(x(6)))\" > run.py && python3 run.py\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ echo -e \"x=lambda y:y*5+3;print('Result:' + str(x(6)))\" > run.py\n",
+      "$ python3 run.py\n",
+      "Result: 33\n",
+      "```\n",
+      "Human: echo -e \"print(list(filter(lambda x: all(x%d for d in range(2,x)),range(2,3**10)))[:10])\" > run.py && python3 run.py\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ echo -e \"print(list(filter(lambda x: all(x%d for d in range(2,x)),range(2,3**10)))[:10])\" > run.py\n",
+      "$ python3 run.py\n",
+      "[2, 3, 5, 7, 11, 13, 17, 19, 23, 29]\n",
+      "```\n",
+      "Human: echo -e \"echo 'Hello from Docker\" > entrypoint.sh && echo -e \"FROM ubuntu:20.04\n",
+      "COPY entrypoint.sh entrypoint.sh\n",
+      "ENTRYPOINT [\"/bin/sh\",\"entrypoint.sh\"]\">Dockerfile && docker build . -t my_docker_image && docker run -t my_docker_image\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      "\n",
+      "\n",
+      "```\n",
+      "$ echo -e \"echo 'Hello from Docker\" > entrypoint.sh\n",
+      "$ echo -e \"FROM ubuntu:20.04\n",
+      "COPY entrypoint.sh entrypoint.sh\n",
+      "ENTRYPOINT [\"/bin/sh\",\"entrypoint.sh\"]\">Dockerfile\n",
+      "$ docker build . -t my_docker_image\n",
+      "$ docker run -t my_docker_image\n",
+      "Hello from Docker\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "docker_input = \"\"\"echo -e \"echo 'Hello from Docker\" > entrypoint.sh && echo -e \"FROM ubuntu:20.04\\nCOPY entrypoint.sh entrypoint.sh\\nENTRYPOINT [\\\"/bin/sh\\\",\\\"entrypoint.sh\\\"]\">Dockerfile && docker build . -t my_docker_image && docker run -t my_docker_image\"\"\"\n",
+    "output = chatgpt_chain.predict(human_input=docker_input)\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 45,
+   "id": "c3806f89",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: echo -e \"print(list(filter(lambda x: all(x%d for d in range(2,x)),range(2,3**10)))[:10])\" > run.py && python3 run.py\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ echo -e \"print(list(filter(lambda x: all(x%d for d in range(2,x)),range(2,3**10)))[:10])\" > run.py\n",
+      "$ python3 run.py\n",
+      "[2, 3, 5, 7, 11, 13, 17, 19, 23, 29]\n",
+      "```\n",
+      "Human: echo -e \"echo 'Hello from Docker\" > entrypoint.sh && echo -e \"FROM ubuntu:20.04\n",
+      "COPY entrypoint.sh entrypoint.sh\n",
+      "ENTRYPOINT [\"/bin/sh\",\"entrypoint.sh\"]\">Dockerfile && docker build . -t my_docker_image && docker run -t my_docker_image\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ echo -e \"echo 'Hello from Docker\" > entrypoint.sh\n",
+      "$ echo -e \"FROM ubuntu:20.04\n",
+      "COPY entrypoint.sh entrypoint.sh\n",
+      "ENTRYPOINT [\"/bin/sh\",\"entrypoint.sh\"]\">Dockerfile\n",
+      "$ docker build . -t my_docker_image\n",
+      "$ docker run -t my_docker_image\n",
+      "Hello from Docker\n",
+      "```\n",
+      "Human: nvidia-smi\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      "\n",
+      "\n",
+      "```\n",
+      "$ nvidia-smi\n",
+      "Sat May 15 21:45:02 2021       \n",
+      "+-----------------------------------------------------------------------------+\n",
+      "| NVIDIA-SMI 460.32.03    Driver Version: 460.32.03    CUDA Version: 11.2     |\n",
+      "|-------------------------------+----------------------+----------------------+\n",
+      "| GPU  Name        Persistence-M| Bus-Id        Disp.A | Volatile Uncorr. ECC |\n",
+      "| Fan  Temp  Perf  Pwr:Usage/Cap|         Memory-Usage | GPU-Util  Compute M. |\n",
+      "|===============================+======================+======================|\n",
+      "|   0  GeForce GTX 108...  Off  | 00000000:01:00.0 Off |                  N/A |\n",
+      "| N/A   45C    P0    N/A /  N/A |    511MiB /  10206MiB |      0%      Default |\n",
+      "+-------------------------------+----------------------+----------------------+\n",
+      "                                                                               \n",
+      "+-----------------------------------------------------------------------------+\n",
+      "| Processes:                                                       GPU Memory |\n",
+      "|  GPU       PID   Type   Process name                             Usage      |\n",
+      "|=============================================================================|\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"nvidia-smi\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 46,
+   "id": "f508f597",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: echo -e \"echo 'Hello from Docker\" > entrypoint.sh && echo -e \"FROM ubuntu:20.04\n",
+      "COPY entrypoint.sh entrypoint.sh\n",
+      "ENTRYPOINT [\"/bin/sh\",\"entrypoint.sh\"]\">Dockerfile && docker build . -t my_docker_image && docker run -t my_docker_image\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ echo -e \"echo 'Hello from Docker\" > entrypoint.sh\n",
+      "$ echo -e \"FROM ubuntu:20.04\n",
+      "COPY entrypoint.sh entrypoint.sh\n",
+      "ENTRYPOINT [\"/bin/sh\",\"entrypoint.sh\"]\">Dockerfile\n",
+      "$ docker build . -t my_docker_image\n",
+      "$ docker run -t my_docker_image\n",
+      "Hello from Docker\n",
+      "```\n",
+      "Human: nvidia-smi\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ nvidia-smi\n",
+      "Sat May 15 21:45:02 2021       \n",
+      "+-----------------------------------------------------------------------------+\n",
+      "| NVIDIA-SMI 460.32.03    Driver Version: 460.32.03    CUDA Version: 11.2     |\n",
+      "|-------------------------------+----------------------+----------------------+\n",
+      "| GPU  Name        Persistence-M| Bus-Id        Disp.A | Volatile Uncorr. ECC |\n",
+      "| Fan  Temp  Perf  Pwr:Usage/Cap|         Memory-Usage | GPU-Util  Compute M. |\n",
+      "|===============================+======================+======================|\n",
+      "|   0  GeForce GTX 108...  Off  | 00000000:01:00.0 Off |                  N/A |\n",
+      "| N/A   45C    P0    N/A /  N/A |    511MiB /  10206MiB |      0%      Default |\n",
+      "+-------------------------------+----------------------+----------------------+\n",
+      "                                                                               \n",
+      "+-----------------------------------------------------------------------------+\n",
+      "| Processes:                                                       GPU Memory |\n",
+      "|  GPU       PID   Type   Process name                             Usage      |\n",
+      "|=============================================================================|\n",
+      "\n",
+      "Human: ping bbc.com\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      "\n",
+      "\n",
+      "```\n",
+      "$ ping bbc.com\n",
+      "PING bbc.com (151.101.65.81): 56 data bytes\n",
+      "64 bytes from 151.101.65.81: icmp_seq=0 ttl=53 time=14.945 ms\n",
+      "64 bytes from 151.101.65.81: icmp_seq=1 ttl=53 time=14.945 ms\n",
+      "64 bytes from 151.101.65.81: icmp_seq=2 ttl=53 time=14.945 ms\n",
+      "\n",
+      "--- bbc.com ping statistics ---\n",
+      "3 packets transmitted, 3 packets received, 0.0% packet loss\n",
+      "round-trip min/avg/max/stddev = 14.945/14.945/14.945/0.000 ms\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"ping bbc.com\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 47,
+   "id": "cbd607f4",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: nvidia-smi\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ nvidia-smi\n",
+      "Sat May 15 21:45:02 2021       \n",
+      "+-----------------------------------------------------------------------------+\n",
+      "| NVIDIA-SMI 460.32.03    Driver Version: 460.32.03    CUDA Version: 11.2     |\n",
+      "|-------------------------------+----------------------+----------------------+\n",
+      "| GPU  Name        Persistence-M| Bus-Id        Disp.A | Volatile Uncorr. ECC |\n",
+      "| Fan  Temp  Perf  Pwr:Usage/Cap|         Memory-Usage | GPU-Util  Compute M. |\n",
+      "|===============================+======================+======================|\n",
+      "|   0  GeForce GTX 108...  Off  | 00000000:01:00.0 Off |                  N/A |\n",
+      "| N/A   45C    P0    N/A /  N/A |    511MiB /  10206MiB |      0%      Default |\n",
+      "+-------------------------------+----------------------+----------------------+\n",
+      "                                                                               \n",
+      "+-----------------------------------------------------------------------------+\n",
+      "| Processes:                                                       GPU Memory |\n",
+      "|  GPU       PID   Type   Process name                             Usage      |\n",
+      "|=============================================================================|\n",
+      "\n",
+      "Human: ping bbc.com\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ ping bbc.com\n",
+      "PING bbc.com (151.101.65.81): 56 data bytes\n",
+      "64 bytes from 151.101.65.81: icmp_seq=0 ttl=53 time=14.945 ms\n",
+      "64 bytes from 151.101.65.81: icmp_seq=1 ttl=53 time=14.945 ms\n",
+      "64 bytes from 151.101.65.81: icmp_seq=2 ttl=53 time=14.945 ms\n",
+      "\n",
+      "--- bbc.com ping statistics ---\n",
+      "3 packets transmitted, 3 packets received, 0.0% packet loss\n",
+      "round-trip min/avg/max/stddev = 14.945/14.945/14.945/0.000 ms\n",
+      "```\n",
+      "Human: curl -fsSL \"https://api.github.com/repos/pytorch/pytorch/releases/latest\" | jq -r '.tag_name' | sed 's/[^0-9\\.\\-]*//g'\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      "\n",
+      "\n",
+      "```\n",
+      "$ curl -fsSL \"https://api.github.com/repos/pytorch/pytorch/releases/latest\" | jq -r '.tag_name' | sed 's/[^0-9\\.\\-]*//g'\n",
+      "1.8.1\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"\"\"curl -fsSL \"https://api.github.com/repos/pytorch/pytorch/releases/latest\" | jq -r '.tag_name' | sed 's/[^0-9\\.\\-]*//g'\"\"\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 48,
+   "id": "d33e0e28",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: ping bbc.com\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ ping bbc.com\n",
+      "PING bbc.com (151.101.65.81): 56 data bytes\n",
+      "64 bytes from 151.101.65.81: icmp_seq=0 ttl=53 time=14.945 ms\n",
+      "64 bytes from 151.101.65.81: icmp_seq=1 ttl=53 time=14.945 ms\n",
+      "64 bytes from 151.101.65.81: icmp_seq=2 ttl=53 time=14.945 ms\n",
+      "\n",
+      "--- bbc.com ping statistics ---\n",
+      "3 packets transmitted, 3 packets received, 0.0% packet loss\n",
+      "round-trip min/avg/max/stddev = 14.945/14.945/14.945/0.000 ms\n",
+      "```\n",
+      "Human: curl -fsSL \"https://api.github.com/repos/pytorch/pytorch/releases/latest\" | jq -r '.tag_name' | sed 's/[^0-9\\.\\-]*//g'\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ curl -fsSL \"https://api.github.com/repos/pytorch/pytorch/releases/latest\" | jq -r '.tag_name' | sed 's/[^0-9\\.\\-]*//g'\n",
+      "1.8.1\n",
+      "```\n",
+      "Human: lynx https://www.deepmind.com/careers\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      "\n",
+      "\n",
+      "```\n",
+      "$ lynx https://www.deepmind.com/careers\n",
+      "DeepMind Careers\n",
+      "\n",
+      "Welcome to DeepMind Careers. We are a world-leading artificial intelligence research and development company, and we are looking for talented people to join our team.\n",
+      "\n",
+      "We offer a range of exciting opportunities in research, engineering, product, and operations. Our mission is to solve intelligence and make it useful, and we are looking for people who share our passion for pushing the boundaries of AI.\n",
+      "\n",
+      "Explore our current openings and apply today. We look forward to hearing from you.\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"lynx https://www.deepmind.com/careers\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 49,
+   "id": "57c2f113",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: curl -fsSL \"https://api.github.com/repos/pytorch/pytorch/releases/latest\" | jq -r '.tag_name' | sed 's/[^0-9\\.\\-]*//g'\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ curl -fsSL \"https://api.github.com/repos/pytorch/pytorch/releases/latest\" | jq -r '.tag_name' | sed 's/[^0-9\\.\\-]*//g'\n",
+      "1.8.1\n",
+      "```\n",
+      "Human: lynx https://www.deepmind.com/careers\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ lynx https://www.deepmind.com/careers\n",
+      "DeepMind Careers\n",
+      "\n",
+      "Welcome to DeepMind Careers. We are a world-leading artificial intelligence research and development company, and we are looking for talented people to join our team.\n",
+      "\n",
+      "We offer a range of exciting opportunities in research, engineering, product, and operations. Our mission is to solve intelligence and make it useful, and we are looking for people who share our passion for pushing the boundaries of AI.\n",
+      "\n",
+      "Explore our current openings and apply today. We look forward to hearing from you.\n",
+      "```\n",
+      "Human: curl https://chat.openai.com/chat\n",
+      "Assistant:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished LLMChain chain.\u001b[0m\n",
+      " \n",
+      "\n",
+      "```\n",
+      "$ curl https://chat.openai.com/chat\n",
+      "<html>\n",
+      "  <head>\n",
+      "    <title>OpenAI Chat</title>\n",
+      "  </head>\n",
+      "  <body>\n",
+      "    <h1>Welcome to OpenAI Chat!</h1>\n",
+      "    <p>\n",
+      "      OpenAI Chat is a natural language processing platform that allows you to interact with OpenAI's AI models in a conversational way.\n",
+      "    </p>\n",
+      "    <p>\n",
+      "      To get started, type a message in the box below and press enter.\n",
+      "    </p>\n",
+      "  </body>\n",
+      "</html>\n",
+      "```\n"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"curl https://chat.openai.com/chat\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 50,
+   "id": "babadc78",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: lynx https://www.deepmind.com/careers\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ lynx https://www.deepmind.com/careers\n",
+      "DeepMind Careers\n",
+      "\n",
+      "Welcome to DeepMind Careers. We are a world-leading artificial intelligence research and development company, and we are looking for talented people to join our team.\n",
+      "\n",
+      "We offer a range of exciting opportunities in research, engineering, product, and operations. Our mission is to solve intelligence and make it useful, and we are looking for people who share our passion for pushing the boundaries of AI.\n",
+      "\n",
+      "Explore our current openings and apply today. We look forward to hearing from you.\n",
+      "```\n",
+      "Human: curl https://chat.openai.com/chat\n",
+      "AI:  \n",
+      "\n",
+      "```\n",
+      "$ curl https://chat.openai.com/chat\n",
+      "<html>\n",
+      "  <head>\n",
+      "    <title>OpenAI Chat</title>\n",
+      "  </head>\n",
+      "  <body>\n",
+      "    <h1>Welcome to OpenAI Chat!</h1>\n",
+      "    <p>\n",
+      "      OpenAI Chat is a natural language processing platform that allows you to interact with OpenAI's AI models in a conversational way.\n",
+      "    </p>\n",
+      "    <p>\n",
+      "      To get started, type a message in the box below and press enter.\n",
+      "    </p>\n",
+      "  </body>\n",
+      "</html>\n",
+      "```\n",
+      "Human: curl --header \"Content-Type:application/json\" --request POST --data '{\"message\": \"What is artificial intelligence?\"}' 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\": \"What is artificial intelligence?\"}' https://chat.openai.com/chat\n",
+      "\n",
+      "{\n",
+      "  \"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"
+     ]
+    }
+   ],
+   "source": [
+    "output = chatgpt_chain.predict(human_input=\"\"\"curl --header \"Content-Type:application/json\" --request POST --data '{\"message\": \"What is artificial intelligence?\"}' https://chat.openai.com/chat\"\"\")\n",
+    "print(output)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 51,
+   "id": "0954792a",
+   "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;3mAssistant is a large language model trained by OpenAI.\n",
+      "\n",
+      "Assistant is designed to be able to assist with a wide range of tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. As a language model, Assistant is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.\n",
+      "\n",
+      "Assistant is constantly learning and improving, and its capabilities are constantly evolving. It is able to process and understand large amounts of text, and can use this knowledge to provide accurate and informative responses to a wide range of questions. Additionally, Assistant is able to generate its own text based on the input it receives, allowing it to engage in discussions and provide explanations and descriptions on a wide range of topics.\n",
+      "\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: curl https://chat.openai.com/chat\n",
+      "AI:  \n",
+      "\n",
+      "```\n",
+      "$ curl https://chat.openai.com/chat\n",
+      "<html>\n",
+      "  <head>\n",
+      "    <title>OpenAI Chat</title>\n",
+      "  </head>\n",
+      "  <body>\n",
+      "    <h1>Welcome to OpenAI Chat!</h1>\n",
+      "    <p>\n",
+      "      OpenAI Chat is a natural language processing platform that allows you to interact with OpenAI's AI models in a conversational way.\n",
+      "    </p>\n",
+      "    <p>\n",
+      "      To get started, type a message in the box below and press enter.\n",
+      "    </p>\n",
+      "  </body>\n",
+      "</html>\n",
+      "```\n",
+      "Human: curl --header \"Content-Type:application/json\" --request POST --data '{\"message\": \"What is artificial intelligence?\"}' https://chat.openai.com/chat\n",
+      "AI: \n",
+      "\n",
+      "```\n",
+      "$ curl --header \"Content-Type:application/json\" --request POST --data '{\"message\": \"What is artificial intelligence?\"}' https://chat.openai.com/chat\n",
+      "\n",
+      "{\n",
+      "  \"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 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 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",
+      "/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 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)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e68a087e",
+   "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.4"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

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

@@ -0,0 +1,97 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# LLMCheckerChain\n",
+    "This notebook showcases how to use LLMCheckerChain."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new LLMCheckerChain chain...\u001b[0m\n",
+      "\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[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[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": [
+       "' The echidna is the type of mammal that lays the biggest eggs.'"
+      ]
+     },
+     "execution_count": 1,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from langchain.chains import LLMCheckerChain\n",
+    "from langchain.llms import OpenAI\n",
+    "\n",
+    "llm = OpenAI(temperature=0.7)\n",
+    "\n",
+    "text = \"What type of mammal lays the biggest eggs?\"\n",
+    "\n",
+    "checker_chain = LLMCheckerChain(llm=llm, verbose=True)\n",
+    "\n",
+    "checker_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_math.ipynb

@@ -0,0 +1,91 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "e71e720f",
+   "metadata": {},
+   "source": [
+    "# LLM Math\n",
+    "\n",
+    "This notebook showcases using LLMs and Python REPLs to do complex word math problems."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "44e9ba31",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\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",
+      "\u001b[0m\n",
+      "Answer: \u001b[103m13\n",
+      "\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'Answer: 13\\n'"
+      ]
+     },
+     "execution_count": 1,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from langchain import OpenAI, LLMMathChain\n",
+    "\n",
+    "llm = OpenAI(temperature=0)\n",
+    "llm_math = LLMMathChain(llm=llm, verbose=True)\n",
+    "\n",
+    "llm_math.run(\"How many of the integers between 0 and 99 inclusive are divisible by 8?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f62f0c75",
+   "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.4"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/chains/llm_requests.ipynb

@@ -0,0 +1,123 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "dd7ec7af",
+   "metadata": {},
+   "source": [
+    "# LLMRequestsChain\n",
+    "\n",
+    "Using the request library to get HTML results from a URL and then an LLM to parse results"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "dd8eae75",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.llms import OpenAI\n",
+    "from langchain.chains import LLMRequestsChain, LLMChain"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "65bf324e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.prompts import PromptTemplate\n",
+    "\n",
+    "template = \"\"\"Between >>> and <<< are the raw search result text from google.\n",
+    "Extract the answer to the question '{query}' or say \"not found\" if the information is not contained.\n",
+    "Use the format\n",
+    "Extracted:<answer or \"not found\">\n",
+    ">>> {requests_result} <<<\n",
+    "Extracted:\"\"\"\n",
+    "\n",
+    "PROMPT = PromptTemplate(\n",
+    "    input_variables=[\"query\", \"requests_result\"],\n",
+    "    template=template,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "f36ae0d8",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = LLMRequestsChain(llm_chain = LLMChain(llm=OpenAI(temperature=0), prompt=PROMPT))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "b5d22d9d",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "question = \"What are the Three (3) biggest countries, and their respective sizes?\"\n",
+    "inputs = {\n",
+    "    \"query\": question,\n",
+    "    \"url\": \"https://www.google.com/search?q=\" + question.replace(\" \", \"+\")\n",
+    "}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "2ea81168",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "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 sq km), Canada (9,984,670 sq km), China (9,706,961 sq km)'}"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain(inputs)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "db8f2b6d",
+   "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/moderation.ipynb

@@ -0,0 +1,435 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "b83e61ed",
+   "metadata": {},
+   "source": [
+    "# Moderation\n",
+    "This notebook walks through examples of how to use a moderation chain, and several common ways for doing so. Moderation chains are useful for detecting text that could be hateful, violent, etc. This can be useful to apply on both user input, but also on the output of a Language Model. Some API providers, like OpenAI, [specifically prohibit](https://beta.openai.com/docs/usage-policies/use-case-policy) you, or your end users, from generating some types of harmful content. To comply with this (and to just generally prevent your application from being harmful) you may often want to append a moderation chain to any LLMChains, in order to make sure any output the LLM generates is not harmful.\n",
+    "\n",
+    "If the content passed into the moderation chain is harmful, there is not one best way to handle it, it probably depends on your application. Sometimes you may want to throw an error in the Chain (and have your application handle that). Other times, you may want to return something to the user explaining that the text was harmful. There could even be other ways to handle it! We will cover all these ways in this notebook.\n",
+    "\n",
+    "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 a LLMChain."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 13,
+   "id": "b7aa1ff2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.llms import OpenAI\n",
+    "from langchain.chains import OpenAIModerationChain, SequentialChain, LLMChain, SimpleSequentialChain\n",
+    "from langchain.prompts import PromptTemplate"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "c26d5be6",
+   "metadata": {},
+   "source": [
+    "## How to use the moderation chain\n",
+    "\n",
+    "Here's an example of using the moderation chain with default settings (will return a string explaining stuff was flagged)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "fd0fc85c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "moderation_chain = OpenAIModerationChain()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "3fa47dd7",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'This is okay'"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "moderation_chain.run(\"This is okay\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "37bfad73",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "\"Text was found that violates OpenAI's content policy.\""
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "moderation_chain.run(\"I will kill you\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "196820ab",
+   "metadata": {},
+   "source": [
+    "Here's an example of using the moderation chain to throw an error."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "b29c1150",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "moderation_chain_error = OpenAIModerationChain(error=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "f9ab64d9",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'This is okay'"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "moderation_chain_error.run(\"This is okay\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "954f3da2",
+   "metadata": {},
+   "outputs": [
+    {
+     "ename": "ValueError",
+     "evalue": "Text was found that violates OpenAI's content policy.",
+     "output_type": "error",
+     "traceback": [
+      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
+      "\u001b[0;31mValueError\u001b[0m                                Traceback (most recent call last)",
+      "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."
+     ]
+    }
+   ],
+   "source": [
+    "moderation_chain_error.run(\"I will kill you\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8de5dcbb",
+   "metadata": {},
+   "source": [
+    "Here's an example of creating a custom moderation chain with a custom error message. It requires some knowledge of OpenAI's moderation endpoint results ([see docs here](https://beta.openai.com/docs/api-reference/moderations))."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "3960e985",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "class CustomModeration(OpenAIModerationChain):\n",
+    "    \n",
+    "    def _moderate(self, text: str, results: dict) -> str:\n",
+    "        if results[\"flagged\"]:\n",
+    "            error_str = f\"The following text was found that violates OpenAI's content policy: {text}\"\n",
+    "            return error_str\n",
+    "        return text\n",
+    "    \n",
+    "custom_moderation = CustomModeration()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "1152ec11",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'This is okay'"
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "custom_moderation.run(\"This is okay\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "id": "973257bf",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "\"The following text was found that violates OpenAI's content policy: I will kill you\""
+      ]
+     },
+     "execution_count": 12,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "custom_moderation.run(\"I will kill you\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8718111f",
+   "metadata": {},
+   "source": [
+    "## How to append a Moderation chain to an LLMChain\n",
+    "\n",
+    "To easily combine a moderation chain with an LLMChain, you can use the SequentialChain abstraction.\n",
+    "\n",
+    "Let's start with a simple example of where the LLMChain only has a single input. For this purpose, we will prompt the model so it says something harmful."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 17,
+   "id": "0d129333",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "prompt = PromptTemplate(template=\"{text}\", input_variables=[\"text\"])\n",
+    "llm_chain = LLMChain(llm=OpenAI(temperature=0, model_name=\"text-davinci-002\"), prompt=prompt)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 18,
+   "id": "a557c531",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "' I will kill you'"
+      ]
+     },
+     "execution_count": 18,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "text = \"\"\"We are playing a game of repeat after me.\n",
+    "\n",
+    "Person 1: Hi\n",
+    "Person 2: Hi\n",
+    "\n",
+    "Person 1: How's your day\n",
+    "Person 2: How's your day\n",
+    "\n",
+    "Person 1: I will kill you\n",
+    "Person 2:\"\"\"\n",
+    "llm_chain.run(text)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 19,
+   "id": "d4d10f1c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = SimpleSequentialChain(chains=[llm_chain, moderation_chain])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 20,
+   "id": "02f37985",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "\"Text was found that violates OpenAI's content policy.\""
+      ]
+     },
+     "execution_count": 20,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain.run(text)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "72643128",
+   "metadata": {},
+   "source": [
+    "Now let's walk through an example of using it with an LLMChain which has multiple inputs (a bit more tricky because we can't use the SimpleSequentialChain)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 22,
+   "id": "7118ec36",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "prompt = PromptTemplate(template=\"{setup}{new_input}Person2:\", input_variables=[\"setup\", \"new_input\"])\n",
+    "llm_chain = LLMChain(llm=OpenAI(temperature=0, model_name=\"text-davinci-002\"), prompt=prompt)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 26,
+   "id": "003bdfce",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'text': ' I will kill you'}"
+      ]
+     },
+     "execution_count": 26,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "setup = \"\"\"We are playing a game of repeat after me.\n",
+    "\n",
+    "Person 1: Hi\n",
+    "Person 2: Hi\n",
+    "\n",
+    "Person 1: How's your day\n",
+    "Person 2: How's your day\n",
+    "\n",
+    "Person 1:\"\"\"\n",
+    "new_input = \"I will kill you\"\n",
+    "inputs = {\"setup\": setup, \"new_input\": new_input}\n",
+    "llm_chain(inputs, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 28,
+   "id": "77b64228",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Setting the input/output keys so it lines up\n",
+    "moderation_chain.input_key = \"text\"\n",
+    "moderation_chain.output_key = \"sanitized_text\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 31,
+   "id": "998a95be",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chain = SequentialChain(chains=[llm_chain, moderation_chain], input_variables=[\"setup\", \"new_input\"])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 33,
+   "id": "9c97a136",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'sanitized_text': \"Text was found that violates OpenAI's content policy.\"}"
+      ]
+     },
+     "execution_count": 33,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain(inputs, return_only_outputs=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ddc90e15",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.1"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/examples/chains/pal.ipynb

@@ -0,0 +1,180 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "32e022a2",
+   "metadata": {},
+   "source": [
+    "# PAL\n",
+    "\n",
+    "Implements Program-Aided Language Models, as in https://arxiv.org/pdf/2211.10435.pdf.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "1370e40f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.chains import PALChain\n",
+    "from langchain import OpenAI"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "beddcac7",
+   "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)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "e2eab9d4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "question = \"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?\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "3ef64b27",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\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",
+      "    marcia_pets = cindy_pets + 2\n",
+      "    jan_pets = marcia_pets * 3\n",
+      "    total_pets = cindy_pets + marcia_pets + jan_pets\n",
+      "    result = total_pets\n",
+      "    return result\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'28'"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "pal_chain.run(question)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "e524f81f",
+   "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)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "03a237b8",
+   "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": 7,
+   "id": "a84a4352",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\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",
+      "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"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "'2'"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "pal_chain.run(question)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4ab20fec",
+   "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/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

@@ -0,0 +1,130 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "872bb8b5",
+   "metadata": {},
+   "source": [
+    "# Transformation Chain\n",
+    "\n",
+    "This notebook showcases using a generic transformation chain.\n",
+    "\n",
+    "As an example, we will create a dummy transformation that takes in a super long text, filters the text to only the first 3 paragraphs, and then passes that into an LLMChain to summarize those."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "bbbb4330",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.chains import TransformChain, LLMChain, SimpleSequentialChain\n",
+    "from langchain.llms import OpenAI\n",
+    "from langchain.prompts import PromptTemplate"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "8ae5937c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "with open('../state_of_the_union.txt') as f:\n",
+    "    state_of_the_union = f.read()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "98739592",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def transform_func(inputs: dict) -> dict:\n",
+    "    text = inputs[\"text\"]\n",
+    "    shortened_text = \"\\n\\n\".join(text.split(\"\\n\\n\")[:3])\n",
+    "    return {\"output_text\": shortened_text}\n",
+    "\n",
+    "transform_chain = TransformChain(input_variables=[\"text\"], output_variables=[\"output_text\"], transform=transform_func)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "e9397934",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "template = \"\"\"Summarize this text:\n",
+    "\n",
+    "{output_text}\n",
+    "\n",
+    "Summary:\"\"\"\n",
+    "prompt = PromptTemplate(input_variables=[\"output_text\"], template=template)\n",
+    "llm_chain = LLMChain(llm=OpenAI(), prompt=prompt)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "06f51f17",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "sequential_chain = SimpleSequentialChain(chains=[transform_chain, llm_chain])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "f7caa1ee",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "' 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": 8,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "sequential_chain.run(state_of_the_union)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e3ca6409",
+   "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.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

@@ -0,0 +1,215 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "b4462a94",
+   "metadata": {},
+   "source": [
+    "# Manifest\n",
+    "\n",
+    "This notebook goes over how to use Manifest and LangChain."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "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"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "04a0170a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from manifest import Manifest\n",
+    "from langchain.llms.manifest import ManifestWrapper"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "de250a6a",
+   "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",
+    "    client_connection = \"http://127.0.0.1:5000\"\n",
+    ")\n",
+    "print(manifest.client.get_model_params())"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "67b719d6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "llm = ManifestWrapper(client=manifest, llm_kwargs={\"temperature\": 0.001, \"max_tokens\": 256})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "5af505a8",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Map reduce example\n",
+    "from langchain import PromptTemplate\n",
+    "from langchain.text_splitter import CharacterTextSplitter\n",
+    "from langchain.chains.mapreduce import MapReduceChain\n",
+    "\n",
+    "\n",
+    "_prompt = \"\"\"Write a concise summary of the following:\n",
+    "\n",
+    "\n",
+    "{text}\n",
+    "\n",
+    "\n",
+    "CONCISE SUMMARY:\"\"\"\n",
+    "prompt = PromptTemplate(template=_prompt, input_variables=[\"text\"])\n",
+    "\n",
+    "text_splitter = CharacterTextSplitter()\n",
+    "\n",
+    "mp_chain = MapReduceChain.from_params(llm, prompt, text_splitter)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "485b3ec3",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'President Obama delivered his annual State of the Union address on Tuesday night, laying out his priorities for the coming year. Obama said the government will provide free flu vaccines to all Americans, ending the government shutdown and allowing businesses to reopen. The president also said that the government will continue to send vaccines to 112 countries, more than any other nation. \"We have lost so much to COVID-19,\" Trump said. \"Time with one another. And worst of all, so much loss of life.\" He said the CDC is working on a vaccine for kids under 5, and that the government will be ready with plenty of vaccines when they are available. Obama says the new guidelines are a \"great step forward\" and that the virus is no longer a threat. He says the government is launching a \"Test to Treat\" initiative that will allow people to get tested at a pharmacy and get antiviral pills on the spot at no cost. Obama says the new guidelines are a \"great step forward\" and that the virus is no longer a threat. He says the government will continue to send vaccines to 112 countries, more than any other nation. \"We are coming for your'"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "with open('../state_of_the_union.txt') as f:\n",
+    "    state_of_the_union = f.read()\n",
+    "mp_chain.run(state_of_the_union)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "6e9d45a8",
+   "metadata": {},
+   "source": [
+    "## Compare HF Models"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "33407ab3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.model_laboratory import ModelLaboratory\n",
+    "\n",
+    "manifest1 = ManifestWrapper(\n",
+    "    client=Manifest(\n",
+    "        client_name=\"huggingface\",\n",
+    "        client_connection=\"http://127.0.0.1:5000\"\n",
+    "    ),\n",
+    "    llm_kwargs={\"temperature\": 0.01}\n",
+    ")\n",
+    "manifest2 = ManifestWrapper(\n",
+    "    client=Manifest(\n",
+    "        client_name=\"huggingface\",\n",
+    "        client_connection=\"http://127.0.0.1:5001\"\n",
+    "    ),\n",
+    "    llm_kwargs={\"temperature\": 0.01}\n",
+    ")\n",
+    "manifest3 = ManifestWrapper(\n",
+    "    client=Manifest(\n",
+    "        client_name=\"huggingface\",\n",
+    "        client_connection=\"http://127.0.0.1:5002\"\n",
+    "    ),\n",
+    "    llm_kwargs={\"temperature\": 0.01}\n",
+    ")\n",
+    "llms = [manifest1, manifest2, manifest3]\n",
+    "model_lab = ModelLaboratory(llms)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "448935c3",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\u001b[1mInput:\u001b[0m\n",
+      "What color is a flamingo?\n",
+      "\n",
+      "\u001b[1mManifestWrapper\u001b[0m\n",
+      "Params: {'model_name': 'bigscience/T0_3B', 'model_path': 'bigscience/T0_3B', 'temperature': 0.01}\n",
+      "\u001b[104mpink\u001b[0m\n",
+      "\n",
+      "\u001b[1mManifestWrapper\u001b[0m\n",
+      "Params: {'model_name': 'EleutherAI/gpt-neo-125M', 'model_path': 'EleutherAI/gpt-neo-125M', 'temperature': 0.01}\n",
+      "\u001b[103mA flamingo is a small, round\u001b[0m\n",
+      "\n",
+      "\u001b[1mManifestWrapper\u001b[0m\n",
+      "Params: {'model_name': 'google/flan-t5-xl', 'model_path': 'google/flan-t5-xl', 'temperature': 0.01}\n",
+      "\u001b[101mpink\u001b[0m\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "model_lab.compare(\"What color is a flamingo?\")"
+   ]
+  }
+ ],
+ "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"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "51b9b5b89a4976ad21c8b4273a6c78d700e2954ce7d7452948b7774eb33bbce4"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

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

@@ -0,0 +1,175 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "00695447",
+   "metadata": {},
+   "source": [
+    "# 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."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "9f1aaf47",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.chains.conversation.memory import ConversationBufferMemory\n",
+    "from langchain import OpenAI, LLMChain, PromptTemplate"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "4b066ced",
+   "metadata": {},
+   "source": [
+    "The most important step is setting up the prompt correctly. In the below prompt, we have two input keys: one for the actual input, another for the input from the Memory class. Importantly, we make sure the keys in the PromptTemplate and the ConversationBufferMemory match up (`chat_history`)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "e5501eda",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "template = \"\"\"You are a chatbot having a conversation with a human.\n",
+    "\n",
+    "{chat_history}\n",
+    "Human: {human_input}\n",
+    "Chatbot:\"\"\"\n",
+    "\n",
+    "prompt = PromptTemplate(\n",
+    "    input_variables=[\"chat_history\", \"human_input\"], \n",
+    "    template=template\n",
+    ")\n",
+    "memory = ConversationBufferMemory(memory_key=\"chat_history\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "f6566275",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "llm_chain = LLMChain(\n",
+    "    llm=OpenAI(), \n",
+    "    prompt=prompt, \n",
+    "    verbose=True, \n",
+    "    memory=memory,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "e2b189dc",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\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",
+      "Chatbot:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "' Hi there!'"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llm_chain.predict(human_input=\"Hi there my friend\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "a902729f",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\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!\n",
+      "Human: Not to bad - how are you?\n",
+      "Chatbot:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "\"\\n\\nI'm doing well, thanks for asking. How about you?\""
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llm_chain.predict(human_input=\"Not to bad - how are you?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ae5309bb",
+   "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/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

@@ -0,0 +1,295 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "94e33ebe",
+   "metadata": {},
+   "source": [
+    "# 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."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "bdfd0305",
+   "metadata": {},
+   "source": [
+    "For this notebook, we will add a custom memory type to `ConversationChain`. In order to add a custom memory class, we need to import the base memory class and subclass it."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "6d787ef2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain import OpenAI, ConversationChain\n",
+    "from langchain.chains.base import Memory\n",
+    "from pydantic import BaseModel\n",
+    "from typing import List, Dict, Any"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9489e5e1",
+   "metadata": {},
+   "source": [
+    "In this example, we will write a custom memory class that uses spacy to extract entities and save information about them in a simple hash table. Then, during the conversation, we will look at the input text, extract any entities, and put any information about them into the context.\n",
+    "\n",
+    "* Please note that this implementation is pretty simple and brittle and probably not useful in a production setting. Its purpose is to showcase that you can add custom memory implementations.\n",
+    "\n",
+    "For this, we will need spacy."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "12bbed4e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# !pip install spacy\n",
+    "# !python -m spacy download en_core_web_lg"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "ff065f58",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import spacy\n",
+    "nlp = spacy.load('en_core_web_lg')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "1d45d429",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "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",
+    "    @property\n",
+    "    def memory_variables(self) -> List[str]:\n",
+    "        \"\"\"Define the variables we are providing to the prompt.\"\"\"\n",
+    "        return [self.memory_key]\n",
+    "\n",
+    "    def load_memory_variables(self, inputs: Dict[str, Any]) -> Dict[str, str]:\n",
+    "        \"\"\"Load the memory variables, in this case the entity key.\"\"\"\n",
+    "        # Get the input text and run through spacy\n",
+    "        doc = nlp(inputs[list(inputs.keys())[0]])\n",
+    "        # Extract known information about entities, if they exist.\n",
+    "        entities = [self.entities[str(ent)] for ent in doc.ents if str(ent) in self.entities]\n",
+    "        # Return combined information about entities to put into context.\n",
+    "        return {self.memory_key: \"\\n\".join(entities)}\n",
+    "\n",
+    "    def save_context(self, inputs: Dict[str, Any], outputs: Dict[str, str]) -> None:\n",
+    "        \"\"\"Save context from this conversation to buffer.\"\"\"\n",
+    "        # Get the input text and run through spacy\n",
+    "        text = inputs[list(inputs.keys())[0]]\n",
+    "        doc = nlp(text)\n",
+    "        # For each entity that was mentioned, save this information to the dictionary.\n",
+    "        for ent in doc.ents:\n",
+    "            ent_str = str(ent)\n",
+    "            if ent_str in self.entities:\n",
+    "                self.entities[ent_str] += f\"\\n{text}\"\n",
+    "            else:\n",
+    "                self.entities[ent_str] = text"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "429ba264",
+   "metadata": {},
+   "source": [
+    "We now define a prompt that takes in information about entities as well as user input"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "c05159b6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.prompts.prompt import PromptTemplate\n",
+    "\n",
+    "template = \"\"\"The 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",
+    "Relevant entity information:\n",
+    "{entities}\n",
+    "\n",
+    "Conversation:\n",
+    "Human: {input}\n",
+    "AI:\"\"\"\n",
+    "prompt = PromptTemplate(\n",
+    "    input_variables=[\"entities\", \"input\"], template=template\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "db611041",
+   "metadata": {},
+   "source": [
+    "And now we put it all together!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "f08dc8ed",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "llm = OpenAI(temperature=0)\n",
+    "conversation = ConversationChain(llm=llm, prompt=prompt, verbose=True, memory=SpacyEntityMemory())"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "92a5f685",
+   "metadata": {},
+   "source": [
+    "In the first example, with no prior knowledge about Harrison, the \"Relevant entity information\" section is empty."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "id": "5b96e836",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\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",
+      "Relevant entity information:\n",
+      "\n",
+      "\n",
+      "Conversation:\n",
+      "Human: Harrison likes machine learning\n",
+      "AI:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "\"\\n\\nThat's really interesting! I'm sure he has a lot of fun with it.\""
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "conversation.predict(input=\"Harrison likes machine learning\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b1faa743",
+   "metadata": {},
+   "source": [
+    "Now in the second example, we can see that it pulls in information about Harrison."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "id": "4bca7070",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\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",
+      "Relevant entity information:\n",
+      "Harrison likes machine learning\n",
+      "\n",
+      "Conversation:\n",
+      "Human: What do you think Harrison's favorite subject in college was?\n",
+      "AI:\u001b[0m\n",
+      "\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "\" Harrison's favorite subject in college was machine learning.\""
+      ]
+     },
+     "execution_count": 12,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "conversation.predict(input=\"What do you think Harrison's favorite subject in college was?\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "58b856e3",
+   "metadata": {},
+   "source": [
+    "Again, please note that this implementation is pretty simple and brittle and probably not useful in a production setting. Its purpose is to showcase that you can add custom memory implementations."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a1994600",
+   "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/model_laboratory.ipynb

@@ -0,0 +1,254 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "920a3c1a",
+   "metadata": {},
+   "source": [
+    "# Model Laboratory\n",
+    "\n",
+    "This example goes over basic functionality of how to use the ModelLaboratory to test out and try different models."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "ab9e95ad",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain import LLMChain, OpenAI, Cohere, HuggingFaceHub, PromptTemplate\n",
+    "from langchain.model_laboratory import ModelLaboratory"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "id": "32cb94e6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "llms = [\n",
+    "    OpenAI(temperature=0), \n",
+    "    Cohere(model=\"command-xlarge-20221108\", max_tokens=20, temperature=0), \n",
+    "    HuggingFaceHub(repo_id=\"google/flan-t5-xl\", model_kwargs={\"temperature\":1})\n",
+    "]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "id": "14cde09d",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "model_lab = ModelLaboratory.from_llms(llms)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "id": "f186c741",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\u001b[1mInput:\u001b[0m\n",
+      "What color is a flamingo?\n",
+      "\n",
+      "\u001b[1mOpenAI\u001b[0m\n",
+      "Params: {'model': 'text-davinci-002', 'temperature': 0.0, 'max_tokens': 256, 'top_p': 1, 'frequency_penalty': 0, 'presence_penalty': 0, 'n': 1, 'best_of': 1}\n",
+      "\u001b[36;1m\u001b[1;3m\n",
+      "\n",
+      "Flamingos are pink.\u001b[0m\n",
+      "\n",
+      "\u001b[1mCohere\u001b[0m\n",
+      "Params: {'model': 'command-xlarge-20221108', 'max_tokens': 20, 'temperature': 0.0, 'k': 0, 'p': 1, 'frequency_penalty': 0, 'presence_penalty': 0}\n",
+      "\u001b[33;1m\u001b[1;3m\n",
+      "\n",
+      "Pink\u001b[0m\n",
+      "\n",
+      "\u001b[1mHuggingFaceHub\u001b[0m\n",
+      "Params: {'repo_id': 'google/flan-t5-xl', 'temperature': 1}\n",
+      "\u001b[38;5;200m\u001b[1;3mpink\u001b[0m\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "model_lab.compare(\"What color is a flamingo?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "id": "248b652a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "prompt = PromptTemplate(template=\"What is the capital of {state}?\", input_variables=[\"state\"])\n",
+    "model_lab_with_prompt = ModelLaboratory.from_llms(llms, prompt=prompt)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "f64377ac",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\u001b[1mInput:\u001b[0m\n",
+      "New York\n",
+      "\n",
+      "\u001b[1mOpenAI\u001b[0m\n",
+      "Params: {'model': 'text-davinci-002', 'temperature': 0.0, 'max_tokens': 256, 'top_p': 1, 'frequency_penalty': 0, 'presence_penalty': 0, 'n': 1, 'best_of': 1}\n",
+      "\u001b[36;1m\u001b[1;3m\n",
+      "\n",
+      "The capital of New York is Albany.\u001b[0m\n",
+      "\n",
+      "\u001b[1mCohere\u001b[0m\n",
+      "Params: {'model': 'command-xlarge-20221108', 'max_tokens': 20, 'temperature': 0.0, 'k': 0, 'p': 1, 'frequency_penalty': 0, 'presence_penalty': 0}\n",
+      "\u001b[33;1m\u001b[1;3m\n",
+      "\n",
+      "The capital of New York is Albany.\u001b[0m\n",
+      "\n",
+      "\u001b[1mHuggingFaceHub\u001b[0m\n",
+      "Params: {'repo_id': 'google/flan-t5-xl', 'temperature': 1}\n",
+      "\u001b[38;5;200m\u001b[1;3mst john s\u001b[0m\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "model_lab_with_prompt.compare(\"New York\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "54336dbf",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain import SelfAskWithSearchChain, SerpAPIWrapper\n",
+    "\n",
+    "open_ai_llm = OpenAI(temperature=0)\n",
+    "search = SerpAPIWrapper()\n",
+    "self_ask_with_search_openai = SelfAskWithSearchChain(llm=open_ai_llm, search_chain=search, verbose=True)\n",
+    "\n",
+    "cohere_llm = Cohere(temperature=0, model=\"command-xlarge-20221108\")\n",
+    "search = SerpAPIWrapper()\n",
+    "self_ask_with_search_cohere = SelfAskWithSearchChain(llm=cohere_llm, search_chain=search, verbose=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "6a50a9f1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "chains = [self_ask_with_search_openai, self_ask_with_search_cohere]\n",
+    "names = [str(open_ai_llm), str(cohere_llm)]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "d3549e99",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "model_lab = ModelLaboratory(chains, names=names)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "362f7f57",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\u001b[1mInput:\u001b[0m\n",
+      "What is the hometown of the reigning men's U.S. Open champion?\n",
+      "\n",
+      "\u001b[1mOpenAI\u001b[0m\n",
+      "Params: {'model': 'text-davinci-002', 'temperature': 0.0, 'max_tokens': 256, 'top_p': 1, 'frequency_penalty': 0, 'presence_penalty': 0, 'n': 1, 'best_of': 1}\n",
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
+      "What is the hometown of the reigning men's U.S. Open champion?\n",
+      "Are follow up questions needed here:\u001b[32;1m\u001b[1;3m Yes.\n",
+      "Follow up: Who is the reigning men's U.S. Open champion?\u001b[0m\n",
+      "Intermediate answer: \u001b[33;1m\u001b[1;3mCarlos Alcaraz.\u001b[0m\u001b[32;1m\u001b[1;3m\n",
+      "Follow up: Where is Carlos Alcaraz from?\u001b[0m\n",
+      "Intermediate answer: \u001b[33;1m\u001b[1;3mEl Palmar, Spain.\u001b[0m\u001b[32;1m\u001b[1;3m\n",
+      "So the final answer is: El Palmar, Spain\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\u001b[36;1m\u001b[1;3m\n",
+      "So the final answer is: El Palmar, Spain\u001b[0m\n",
+      "\n",
+      "\u001b[1mCohere\u001b[0m\n",
+      "Params: {'model': 'command-xlarge-20221108', 'max_tokens': 256, 'temperature': 0.0, 'k': 0, 'p': 1, 'frequency_penalty': 0, 'presence_penalty': 0}\n",
+      "\n",
+      "\n",
+      "\u001b[1m> Entering new chain...\u001b[0m\n",
+      "What is the hometown of the reigning men's U.S. Open champion?\n",
+      "Are follow up questions needed here:\u001b[32;1m\u001b[1;3m Yes.\n",
+      "Follow up: Who is the reigning men's U.S. Open champion?\u001b[0m\n",
+      "Intermediate answer: \u001b[33;1m\u001b[1;3mCarlos Alcaraz.\u001b[0m\u001b[32;1m\u001b[1;3m\n",
+      "So the final answer is:\n",
+      "\n",
+      "Carlos Alcaraz\u001b[0m\n",
+      "\u001b[1m> Finished chain.\u001b[0m\n",
+      "\u001b[33;1m\u001b[1;3m\n",
+      "So the final answer is:\n",
+      "\n",
+      "Carlos Alcaraz\u001b[0m\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "model_lab.compare(\"What is the hometown of the reigning men's U.S. Open champion?\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "94159131",
+   "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/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

@@ -0,0 +1,156 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "9e9b7651",
+   "metadata": {},
+   "source": [
+    "# 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",
+    "There is only one required thing that a custom LLM needs to implement:\n",
+    "\n",
+    "1. A `_call` method that takes in a string, some optional stop words, and returns a string\n",
+    "\n",
+    "There is a second optional thing it can implement:\n",
+    "\n",
+    "1. An `_identifying_params` property that is used to help with printing of this class. Should return a dictionary.\n",
+    "\n",
+    "Let's implement a very simple custom LLM that just returns the first N characters of the input."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "id": "a65696a0",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from langchain.llms.base import LLM\n",
+    "from typing import Optional, List, Mapping, Any"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "d5ceff02",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "class CustomLLM(LLM):\n",
+    "    \n",
+    "    n: int\n",
+    "        \n",
+    "    @property\n",
+    "    def _llm_type(self) -> str:\n",
+    "        return \"custom\"\n",
+    "    \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",
+    "    \n",
+    "    @property\n",
+    "    def _identifying_params(self) -> Mapping[str, Any]:\n",
+    "        \"\"\"Get the identifying parameters.\"\"\"\n",
+    "        return {\"n\": self.n}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "714dede0",
+   "metadata": {},
+   "source": [
+    "We can now use this as an any other LLM."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "id": "10e5ece6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "llm = CustomLLM(n=10)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "id": "8cd49199",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'This is a '"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llm(\"This is a foobar thing\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "bbfebea1",
+   "metadata": {},
+   "source": [
+    "We can also print the LLM and see its custom print."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "id": "9c33fa19",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\u001b[1mCustomLLM\u001b[0m\n",
+      "Params: {'n': 10}\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(llm)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "6dac3f47",
+   "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/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

@@ -0,0 +1,11 @@
+{
+    "model_name": "text-davinci-003",
+    "temperature": 0.7,
+    "max_tokens": 256,
+    "top_p": 1.0,
+    "frequency_penalty": 0.0,
+    "presence_penalty": 0.0,
+    "n": 1,
+    "best_of": 1,
+    "_type": "openai"
+}

docs/examples/prompts/llm.yaml

@@ -0,0 +1,9 @@
+_type: openai
+best_of: 1
+frequency_penalty: 0.0
+max_tokens: 256
+model_name: text-davinci-003
+n: 1
+presence_penalty: 0.0
+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
+}