release(openai): 1.0.0 (#33578)

minor

.github/scripts/check_diff.py

@@ -50,10 +50,6 @@ IGNORED_PARTNERS = [
     "prompty",
 ]
 
-PY_312_MAX_PACKAGES = [
-    "libs/partners/chroma",  # https://github.com/chroma-core/chroma/issues/4382
-]
-
 
 def all_package_dirs() -> Set[str]:
     return {
@@ -136,24 +132,21 @@ def _get_configs_for_single_dir(job: str, dir_: str) -> List[Dict[str, str]]:
     if job == "codspeed":
         py_versions = ["3.12"]  # 3.13 is not yet supported
     elif dir_ == "libs/core":
-        py_versions = ["3.10", "3.11", "3.12", "3.13"]
+        py_versions = ["3.10", "3.11", "3.12", "3.13", "3.14"]
     # custom logic for specific directories
 
-    elif dir_ in PY_312_MAX_PACKAGES:
-        py_versions = ["3.10", "3.12"]
-
     elif dir_ == "libs/langchain" and job == "extended-tests":
-        py_versions = ["3.10", "3.13"]
+        py_versions = ["3.10", "3.14"]
     elif dir_ == "libs/langchain_v1":
         py_versions = ["3.10", "3.13"]
-    elif dir_ in {"libs/cli"}:
+    elif dir_ in {"libs/cli", "libs/partners/chroma", "libs/partners/nomic"}:
         py_versions = ["3.10", "3.13"]
 
     elif dir_ == ".":
         # unable to install with 3.13 because tokenizers doesn't support 3.13 yet
         py_versions = ["3.10", "3.12"]
     else:
-        py_versions = ["3.10", "3.13"]
+        py_versions = ["3.10", "3.14"]
 
     return [{"working-directory": dir_, "python-version": py_v} for py_v in py_versions]
 
@@ -264,7 +257,15 @@ if __name__ == "__main__":
                 ".github/scripts/check_diff.py",
             )
         ):
-            # add all LANGCHAIN_DIRS for infra changes
+            # 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"):
@@ -287,8 +288,6 @@ if __name__ == "__main__":
             # 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["lint"].add("libs/cli")
-            dirs_to_run["test"].add("libs/cli")
             dirs_to_run["test"].add("libs/partners/mistralai")
             dirs_to_run["test"].add("libs/partners/openai")
             dirs_to_run["test"].add("libs/partners/anthropic")
@@ -310,6 +309,11 @@ if __name__ == "__main__":
                 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!"

.github/scripts/get_min_versions.py

@@ -2,7 +2,6 @@
 
 import sys
 from collections import defaultdict
-from typing import Optional
 
 if sys.version_info >= (3, 11):
     import tomllib
@@ -54,7 +53,7 @@ def get_pypi_versions(package_name: str) -> List[str]:
     return list(response.json()["releases"].keys())
 
 
-def get_minimum_version(package_name: str, spec_string: str) -> Optional[str]:
+def get_minimum_version(package_name: str, spec_string: str) -> str | None:
     """Find the minimum published version that satisfies the given constraints.
 
     Args:
@@ -114,7 +113,7 @@ def get_min_version_from_toml(
     versions_for: str,
     python_version: str,
     *,
-    include: Optional[list] = None,
+    include: list | None = None,
 ):
     # Parse the TOML file
     with open(toml_path, "rb") as file:

.github/workflows/_compile_integration_test.yml

@@ -6,7 +6,7 @@
 #
 # Runs pytest with compile marker to check syntax/imports.
 
-name: '🔗 Compile Integration Tests'
+name: "🔗 Compile Integration Tests"
 
 on:
   workflow_call:
@@ -33,26 +33,26 @@ jobs:
         working-directory: ${{ inputs.working-directory }}
     runs-on: ubuntu-latest
     timeout-minutes: 20
-    name: 'Python ${{ inputs.python-version }}'
+    name: "Python ${{ inputs.python-version }}"
     steps:
       - uses: actions/checkout@v5
 
-      - name: '🐍 Set up Python ${{ inputs.python-version }} + UV'
+      - 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'
+      - name: "📦 Install Integration Dependencies"
         shell: bash
         run: uv sync --group test --group test_integration
 
-      - name: '🔗 Check Integration Tests Compile'
+      - name: "🔗 Check Integration Tests Compile"
         shell: bash
         run: uv run pytest -m compile tests/integration_tests
 
-      - name: '🧹 Verify Clean Working Directory'
+      - name: "🧹 Verify Clean Working Directory"
         shell: bash
         run: |
           set -eu

.github/workflows/_lint.yml

@@ -5,7 +5,7 @@
 #
 # Called as part of check_diffs.yml workflow.
 
-name: '🧹 Linting'
+name: "🧹 Linting"
 
 on:
   workflow_call:
@@ -33,43 +33,43 @@ env:
 jobs:
   # Linting job - runs quality checks on package and test code
   build:
-    name: 'Python ${{ inputs.python-version }}'
+    name: "Python ${{ inputs.python-version }}"
     runs-on: ubuntu-latest
     timeout-minutes: 20
     steps:
-      - name: '📋 Checkout Code'
+      - name: "📋 Checkout Code"
         uses: actions/checkout@v5
 
-      - name: '🐍 Set up Python ${{ inputs.python-version }} + UV'
+      - 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'
+      - name: "📦 Install Lint & Typing Dependencies"
         working-directory: ${{ inputs.working-directory }}
         run: |
           uv sync --group lint --group typing
 
-      - name: '🔍 Analyze Package Code with Linters'
+      - name: "🔍 Analyze Package Code with Linters"
         working-directory: ${{ inputs.working-directory }}
         run: |
           make lint_package
 
-      - name: '📦 Install Test Dependencies (non-partners)'
+      - 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'
+      - 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'
+      - name: "🔍 Analyze Test Code with Linters"
         working-directory: ${{ inputs.working-directory }}
         run: |
           make lint_tests

.github/workflows/_test.yml

@@ -1,7 +1,7 @@
 # Runs unit tests with both current and minimum supported dependency versions
 # to ensure compatibility across the supported range.
 
-name: '🧪 Unit Testing'
+name: "🧪 Unit Testing"
 
 on:
   workflow_call:
@@ -30,12 +30,12 @@ jobs:
         working-directory: ${{ inputs.working-directory }}
     runs-on: ubuntu-latest
     timeout-minutes: 20
-    name: 'Python ${{ inputs.python-version }}'
+    name: "Python ${{ inputs.python-version }}"
     steps:
-      - name: '📋 Checkout Code'
+      - name: "📋 Checkout Code"
         uses: actions/checkout@v5
 
-      - name: '🐍 Set up Python ${{ inputs.python-version }} + UV'
+      - name: "🐍 Set up Python ${{ inputs.python-version }} + UV"
         uses: "./.github/actions/uv_setup"
         id: setup-python
         with:
@@ -43,16 +43,16 @@ jobs:
           cache-suffix: test-${{ inputs.working-directory }}
           working-directory: ${{ inputs.working-directory }}
 
-      - name: '📦 Install Test Dependencies'
+      - name: "📦 Install Test Dependencies"
         shell: bash
         run: uv sync --group test --dev
 
-      - name: '🧪 Run Core Unit Tests'
+      - name: "🧪 Run Core Unit Tests"
         shell: bash
         run: |
           make test
 
-      - name: '🔍 Calculate Minimum Dependency Versions'
+      - name: "🔍 Calculate Minimum Dependency Versions"
         working-directory: ${{ inputs.working-directory }}
         id: min-version
         shell: bash
@@ -63,7 +63,7 @@ jobs:
           echo "min-versions=$min_versions" >> "$GITHUB_OUTPUT"
           echo "min-versions=$min_versions"
 
-      - name: '🧪 Run Tests with Minimum Dependencies'
+      - name: "🧪 Run Tests with Minimum Dependencies"
         if: ${{ steps.min-version.outputs.min-versions != '' }}
         env:
           MIN_VERSIONS: ${{ steps.min-version.outputs.min-versions }}
@@ -72,7 +72,7 @@ jobs:
           make tests
         working-directory: ${{ inputs.working-directory }}
 
-      - name: '🧹 Verify Clean Working Directory'
+      - name: "🧹 Verify Clean Working Directory"
         shell: bash
         run: |
           set -eu
@@ -83,4 +83,3 @@ jobs:
           # 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,6 +1,6 @@
 # Facilitate unit testing against different Pydantic versions for a provided package.
 
-name: '🐍 Pydantic Version Testing'
+name: "🐍 Pydantic Version Testing"
 
 on:
   workflow_call:
@@ -33,32 +33,32 @@ jobs:
         working-directory: ${{ inputs.working-directory }}
     runs-on: ubuntu-latest
     timeout-minutes: 20
-    name: 'Pydantic ~=${{ inputs.pydantic-version }}'
+    name: "Pydantic ~=${{ inputs.pydantic-version }}"
     steps:
-      - name: '📋 Checkout Code'
+      - name: "📋 Checkout Code"
         uses: actions/checkout@v5
 
-      - name: '🐍 Set up Python ${{ inputs.python-version }} + UV'
+      - 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'
+      - name: "📦 Install Test Dependencies"
         shell: bash
         run: uv sync --group test
 
-      - name: '🔄 Install Specific Pydantic Version'
+      - name: "🔄 Install Specific Pydantic Version"
         shell: bash
         run: VIRTUAL_ENV=.venv uv pip install pydantic~=${{ inputs.pydantic-version }}
 
-      - name: '🧪 Run Core Tests'
+      - name: "🧪 Run Core Tests"
         shell: bash
         run: |
           make test
 
-      - name: '🧹 Verify Clean Working Directory'
+      - name: "🧹 Verify Clean Working Directory"
         shell: bash
         run: |
           set -eu

.github/workflows/check_core_versions.yml

@@ -2,13 +2,13 @@
 #
 # (Prevents releases with mismatched version numbers)
 
-name: '🔍 Check Version Equality'
+name: "🔍 Check Version Equality"
 
 on:
   pull_request:
     paths:
-      - 'libs/core/pyproject.toml'
-      - 'libs/core/langchain_core/version.py'
+      - "libs/core/pyproject.toml"
+      - "libs/core/langchain_core/version.py"
 
 permissions:
   contents: read
@@ -20,7 +20,7 @@ jobs:
     steps:
       - uses: actions/checkout@v5
 
-      - name: '✅ Verify pyproject.toml & version.py Match'
+      - name: "✅ Verify pyproject.toml & version.py Match"
         run: |
           # Check core versions
           CORE_PYPROJECT_VERSION=$(grep -Po '(?<=^version = ")[^"]*' libs/core/pyproject.toml)

.github/workflows/check_diffs.yml

@@ -186,7 +186,7 @@ jobs:
 
       # We have to use 3.12 as 3.13 is not yet supported
       - name: "📦 Install UV Package Manager"
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: "3.12"
 

.github/workflows/integration_tests.yml

@@ -23,10 +23,8 @@ permissions:
   contents: read
 
 env:
-  POETRY_VERSION: "1.8.4"
   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"]'
-  POETRY_LIBS: ("libs/partners/aws")
 
 jobs:
   # Generate dynamic test matrix based on input parameters or defaults
@@ -60,7 +58,6 @@ jobs:
           echo $matrix
           echo "matrix=$matrix" >> $GITHUB_OUTPUT
   # Run integration tests against partner libraries with live API credentials
-  # Tests are run with Poetry or UV depending on the library's setup
   build:
     if: github.repository_owner == 'langchain-ai' || github.event_name != 'schedule'
     name: "🐍 Python ${{ matrix.python-version }}: ${{ matrix.working-directory }}"
@@ -95,17 +92,7 @@ jobs:
           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 }} + Poetry"
-        if: contains(env.POETRY_LIBS, matrix.working-directory)
-        uses: "./langchain/.github/actions/poetry_setup"
-        with:
-          python-version: ${{ matrix.python-version }}
-          poetry-version: ${{ env.POETRY_VERSION }}
-          working-directory: langchain/${{ matrix.working-directory }}
-          cache-key: scheduled
-
       - name: "🐍 Set up Python ${{ matrix.python-version }} + UV"
-        if: "!contains(env.POETRY_LIBS, matrix.working-directory)"
         uses: "./langchain/.github/actions/uv_setup"
         with:
           python-version: ${{ matrix.python-version }}
@@ -123,15 +110,7 @@ jobs:
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           aws-region: ${{ secrets.AWS_REGION }}
 
-      - name: "📦 Install Dependencies (Poetry)"
-        if: contains(env.POETRY_LIBS, matrix.working-directory)
-        run: |
-          echo "Running scheduled tests, installing dependencies with poetry..."
-          cd langchain/${{ matrix.working-directory }}
-          poetry install --with=test_integration,test
-
-      - name: "📦 Install Dependencies (UV)"
-        if: "!contains(env.POETRY_LIBS, matrix.working-directory)"
+      - name: "📦 Install Dependencies"
         run: |
           echo "Running scheduled tests, installing dependencies with uv..."
           cd langchain/${{ matrix.working-directory }}

.github/workflows/pr_labeler_file.yml

@@ -12,7 +12,7 @@ on:
 
 jobs:
   labeler:
-    name: 'label'
+    name: "label"
     permissions:
       contents: read
       pull-requests: write
@@ -20,9 +20,9 @@ jobs:
     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
+      - 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,6 +1,7 @@
 # Label PRs based on their titles.
 #
-# See `.github/pr-title-labeler.yml` to see rules for each label/title pattern.
+# 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"
 
@@ -8,11 +9,11 @@ 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]
+    types: [opened, edited]
 
 jobs:
   pr-title-labeler:
-    name: 'label'
+    name: "label"
     permissions:
       contents: read
       pull-requests: write
@@ -20,9 +21,24 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Label PR based on title
-      # Archived repo; latest commit (v0.1.0)
-      uses: grafana/pr-labeler-action@f19222d3ef883d2ca5f04420fdfe8148003763f0
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        configuration-path: .github/pr-title-labeler.yml
+      - 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/v03_api_doc_build.yml

@@ -0,0 +1,164 @@
+# 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@v5
+        with:
+          ref: v0.3
+          path: langchain
+
+      - uses: actions/checkout@v5
+        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,4 +1,5 @@
 .vs/
+.claude/
 .idea/
 # Byte-compiled / optimized / DLL files
 __pycache__/

.pre-commit-config.yaml

@@ -97,9 +97,3 @@ repos:
         entry: make -C libs/partners/qdrant format lint
         files: ^libs/partners/qdrant/
         pass_filenames: false
-      - id: root
-        name: format and lint docs, cookbook
-        language: system
-        entry: make format lint
-        files: ^(docs|cookbook)/
-        pass_filenames: false

.vscode/settings.json

@@ -1,14 +1,12 @@
 {
   "python.analysis.include": [
     "libs/**",
-    "cookbook/**"
   ],
   "python.analysis.exclude": [
     "**/node_modules",
     "**/__pycache__",
     "**/.pytest_cache",
     "**/.*",
-    "_dist/**",
   ],
   "python.analysis.autoImportCompletions": true,
   "python.analysis.typeCheckingMode": "basic",

AGENTS.md

@@ -149,23 +149,25 @@ def send_email(to: str, msg: str, *, priority: str = "normal") -> bool:
     Args:
         to: The email address of the recipient.
         msg: The message body to send.
-        priority: Email priority level (``'low'``, ``'normal'``, ``'high'``).
+        priority: Email priority level (`'low'`, `'normal'`, `'high'`).
 
     Returns:
-        True if email was sent successfully, False otherwise.
+        `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.
+        `InvalidEmailError`: If the email address format is invalid.
+        `SMTPConnectionError`: If unable to connect to email server.
     """
 ```
 
 **Documentation Guidelines:**
 
 - 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")
 
 📌 *Tip:* Keep descriptions concise but clear. Only document return values if non-obvious.
 

CLAUDE.md

@@ -149,23 +149,25 @@ def send_email(to: str, msg: str, *, priority: str = "normal") -> bool:
     Args:
         to: The email address of the recipient.
         msg: The message body to send.
-        priority: Email priority level (``'low'``, ``'normal'``, ``'high'``).
+        priority: Email priority level (`'low'`, `'normal'`, `'high'`).
 
     Returns:
-        True if email was sent successfully, False otherwise.
+        `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.
+        `InvalidEmailError`: If the email address format is invalid.
+        `SMTPConnectionError`: If unable to connect to email server.
     """
 ```
 
 **Documentation Guidelines:**
 
 - 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")
 
 📌 *Tip:* Keep descriptions concise but clear. Only document return values if non-obvious.
 

MIGRATE.md

@@ -2,10 +2,8 @@
 
 Please see the following guides for migrating LangChain code:
 
+* Migrate to [LangChain v1.0](https://docs.langchain.com/oss/python/migrate/langchain-v1)
 * Migrate to [LangChain v0.3](https://python.langchain.com/docs/versions/v0_3/)
 * Migrate to [LangChain v0.2](https://python.langchain.com/docs/versions/v0_2/)
 * Migrating from [LangChain 0.0.x Chains](https://python.langchain.com/docs/versions/migrating_chains/)
 * Upgrade to [LangGraph Memory](https://python.langchain.com/docs/versions/migrating_memory/)
-
-The [LangChain CLI](https://python.langchain.com/docs/versions/v0_3/#migrate-using-langchain-cli) can help you automatically upgrade your code to use non-deprecated imports.
-This will be especially helpful if you're still on either version 0.0.x or 0.1.x of LangChain.

README.md

@@ -12,13 +12,16 @@
 
 <p align="center">
   <a href="https://opensource.org/licenses/MIT" target="_blank">
-      <img src="https://img.shields.io/pypi/l/langchain-core?style=flat-square" alt="PyPI - License">
+      <img src="https://img.shields.io/pypi/l/langchain" alt="PyPI - License">
   </a>
-  <a href="https://pypistats.org/packages/langchain-core" target="_blank">
+  <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&style=flat-square" alt="Open in Dev Containers">
+      <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">
@@ -34,14 +37,14 @@
 LangChain is a framework for building 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.
 
 ```bash
-pip install -U langchain
+pip install langchain
 ```
 
 ---
 
-**Documentation**: To learn more about LangChain, check out [the docs](https://docs.langchain.com/).
+**Documentation**: To learn more about LangChain, check out [the docs](https://docs.langchain.com/oss/python/langchain/overview).
 
-If you're looking for more advanced customization or agent orchestration, check out [LangGraph](https://langchain-ai.github.io/langgraph/), our framework for building controllable agent workflows.
+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.
 
 > [!NOTE]
 > Looking for the JS/TS library? Check out [LangChain.js](https://github.com/langchain-ai/langchainjs).
@@ -62,16 +65,13 @@ While the LangChain framework can be used standalone, it also integrates seamles
 To improve your LLM application development, pair LangChain with:
 
 - [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.
-- [LangGraph](https://langchain-ai.github.io/langgraph/) - 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.
-- [LangGraph Platform](https://docs.langchain.com/langgraph-platform) - 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 [LangGraph Studio](https://langchain-ai.github.io/langgraph/concepts/langgraph_studio/).
+- [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.
+- [LangGraph Platform](https://docs.langchain.com/langgraph-platform) - 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 [LangGraph Studio](https://langchain-ai.github.io/langgraph/concepts/langgraph_studio).
 
 ## Additional resources
 
-- [Conceptual Guides](https://docs.langchain.com/oss/python/langchain/overview): Explanations of key
-concepts behind the LangChain framework.
-- [Tutorials](https://docs.langchain.com/oss/python/learn): Simple walkthroughs with
-guided examples on getting started with LangChain.
-- [API Reference](https://reference.langchain.com/python/): Detailed reference on
+- [Learn](https://docs.langchain.com/oss/python/learn): Use cases, conceptual overviews, and more.
+- [API Reference](https://reference.langchain.com/python): Detailed reference on
 navigating base packages and integrations for LangChain.
-- [LangChain Forum](https://forum.langchain.com/): Connect with the community and share all of your technical questions, ideas, and feedback.
-- [Chat LangChain](https://chat.langchain.com/): Ask questions & chat with our documentation.
+- [LangChain Forum](https://forum.langchain.com): Connect with the community and share all of your technical questions, ideas, and feedback.
+- [Chat LangChain](https://chat.langchain.com): Ask questions & chat with our documentation.

cookbook/Gemma_LangChain.ipynb

@@ -1,932 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "BYejgj8Zf-LG",
-    "tags": []
-   },
-   "source": [
-    "## Getting started with LangChain and Gemma, running locally or in the Cloud"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "2IxjMb9-jIJ8"
-   },
-   "source": [
-    "### Installing dependencies"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {
-    "colab": {
-     "base_uri": "https://localhost:8080/"
-    },
-    "executionInfo": {
-     "elapsed": 9436,
-     "status": "ok",
-     "timestamp": 1708975187360,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "XZaTsXfcheTF",
-    "outputId": "eb21d603-d824-46c5-f99f-087fb2f618b1",
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "!pip install --upgrade langchain langchain-google-vertexai"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "IXmAujvC3Kwp"
-   },
-   "source": [
-    "### Running the model"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "CI8Elyc5gBQF"
-   },
-   "source": [
-    "Go to the VertexAI Model Garden on Google Cloud [console](https://pantheon.corp.google.com/vertex-ai/publishers/google/model-garden/335), and deploy the desired version of Gemma to VertexAI. It will take a few minutes, and after the endpoint is ready, you need to copy its number."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {
-    "id": "gv1j8FrVftsC"
-   },
-   "outputs": [],
-   "source": [
-    "# @title Basic parameters\n",
-    "project: str = \"PUT_YOUR_PROJECT_ID_HERE\"  # @param {type:\"string\"}\n",
-    "endpoint_id: str = \"PUT_YOUR_ENDPOINT_ID_HERE\"  # @param {type:\"string\"}\n",
-    "location: str = \"PUT_YOUR_ENDPOINT_LOCAtION_HERE\"  # @param {type:\"string\"}"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {
-    "executionInfo": {
-     "elapsed": 3,
-     "status": "ok",
-     "timestamp": 1708975440503,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "bhIHsFGYjtFt",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "2024-02-27 17:15:10.457149: I tensorflow/core/util/port.cc:113] oneDNN custom operations are on. You may see slightly different numerical results due to floating-point round-off errors from different computation orders. To turn them off, set the environment variable `TF_ENABLE_ONEDNN_OPTS=0`.\n",
-      "2024-02-27 17:15:10.508925: E external/local_xla/xla/stream_executor/cuda/cuda_dnn.cc:9261] Unable to register cuDNN factory: Attempting to register factory for plugin cuDNN when one has already been registered\n",
-      "2024-02-27 17:15:10.508957: E external/local_xla/xla/stream_executor/cuda/cuda_fft.cc:607] Unable to register cuFFT factory: Attempting to register factory for plugin cuFFT when one has already been registered\n",
-      "2024-02-27 17:15:10.510289: E external/local_xla/xla/stream_executor/cuda/cuda_blas.cc:1515] Unable to register cuBLAS factory: Attempting to register factory for plugin cuBLAS when one has already been registered\n",
-      "2024-02-27 17:15:10.518898: I tensorflow/core/platform/cpu_feature_guard.cc:182] This TensorFlow binary is optimized to use available CPU instructions in performance-critical operations.\n",
-      "To enable the following instructions: AVX2 AVX512F AVX512_VNNI FMA, in other operations, rebuild TensorFlow with the appropriate compiler flags.\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain_google_vertexai import (\n",
-    "    GemmaChatVertexAIModelGarden,\n",
-    "    GemmaVertexAIModelGarden,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {
-    "executionInfo": {
-     "elapsed": 351,
-     "status": "ok",
-     "timestamp": 1708975440852,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "WJv-UVWwh0lk",
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "llm = GemmaVertexAIModelGarden(\n",
-    "    endpoint_id=endpoint_id,\n",
-    "    project=project,\n",
-    "    location=location,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {
-    "colab": {
-     "base_uri": "https://localhost:8080/"
-    },
-    "executionInfo": {
-     "elapsed": 714,
-     "status": "ok",
-     "timestamp": 1708975441564,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "6kM7cEFdiN9h",
-    "outputId": "fb420c56-5614-4745-cda8-0ee450a3e539",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Prompt:\n",
-      "What is the meaning of life?\n",
-      "Output:\n",
-      " Who am I? Why do I exist? These are questions I have struggled with\n"
-     ]
-    }
-   ],
-   "source": [
-    "output = llm.invoke(\"What is the meaning of life?\")\n",
-    "print(output)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "zzep9nfmuUcO"
-   },
-   "source": [
-    "We can also use Gemma as a multi-turn chat model:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {
-    "colab": {
-     "base_uri": "https://localhost:8080/"
-    },
-    "executionInfo": {
-     "elapsed": 964,
-     "status": "ok",
-     "timestamp": 1708976298189,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "8tPHoM5XiZOl",
-    "outputId": "7b8fb652-9aed-47b0-c096-aa1abfc3a2a9",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "content='Prompt:\\n<start_of_turn>user\\nHow much is 2+2?<end_of_turn>\\n<start_of_turn>model\\nOutput:\\n8-years old.<end_of_turn>\\n\\n<start_of'\n",
-      "content='Prompt:\\n<start_of_turn>user\\nHow much is 2+2?<end_of_turn>\\n<start_of_turn>model\\nPrompt:\\n<start_of_turn>user\\nHow much is 2+2?<end_of_turn>\\n<start_of_turn>model\\nOutput:\\n8-years old.<end_of_turn>\\n\\n<start_of<end_of_turn>\\n<start_of_turn>user\\nHow much is 3+3?<end_of_turn>\\n<start_of_turn>model\\nOutput:\\nOutput:\\n3-years old.<end_of_turn>\\n\\n<'\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain_core.messages import HumanMessage\n",
-    "\n",
-    "llm = GemmaChatVertexAIModelGarden(\n",
-    "    endpoint_id=endpoint_id,\n",
-    "    project=project,\n",
-    "    location=location,\n",
-    ")\n",
-    "\n",
-    "message1 = HumanMessage(content=\"How much is 2+2?\")\n",
-    "answer1 = llm.invoke([message1])\n",
-    "print(answer1)\n",
-    "\n",
-    "message2 = HumanMessage(content=\"How much is 3+3?\")\n",
-    "answer2 = llm.invoke([message1, answer1, message2])\n",
-    "\n",
-    "print(answer2)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can post-process response to avoid repetitions:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "content='Output:\\n<<humming>>: 2+2 = 4.\\n<end'\n",
-      "content='Output:\\nOutput:\\n<<humming>>: 3+3 = 6.'\n"
-     ]
-    }
-   ],
-   "source": [
-    "answer1 = llm.invoke([message1], parse_response=True)\n",
-    "print(answer1)\n",
-    "\n",
-    "answer2 = llm.invoke([message1, answer1, message2], parse_response=True)\n",
-    "\n",
-    "print(answer2)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "VEfjqo7fjARR"
-   },
-   "source": [
-    "## Running Gemma locally from Kaggle"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "gVW8QDzHu7TA"
-   },
-   "source": [
-    "In order to run Gemma locally, you can download it from Kaggle first. In order to do this, you'll need to login into the Kaggle platform, create a API key and download a `kaggle.json` Read more about Kaggle auth [here](https://www.kaggle.com/docs/api)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "S1EsXQ3XvZkQ"
-   },
-   "source": [
-    "### Installation"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {
-    "executionInfo": {
-     "elapsed": 335,
-     "status": "ok",
-     "timestamp": 1708976305471,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "p8SMwpKRvbef",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/opt/conda/lib/python3.10/pty.py:89: RuntimeWarning: os.fork() was called. os.fork() is incompatible with multithreaded code, and JAX is multithreaded, so this will likely lead to a deadlock.\n",
-      "  pid, fd = os.forkpty()\n"
-     ]
-    }
-   ],
-   "source": [
-    "!mkdir -p ~/.kaggle && cp kaggle.json ~/.kaggle/kaggle.json"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "metadata": {
-    "executionInfo": {
-     "elapsed": 7802,
-     "status": "ok",
-     "timestamp": 1708976363010,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "Yr679aePv9Fq",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/opt/conda/lib/python3.10/pty.py:89: RuntimeWarning: os.fork() was called. os.fork() is incompatible with multithreaded code, and JAX is multithreaded, so this will likely lead to a deadlock.\n",
-      "  pid, fd = os.forkpty()\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\u001b[31mERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.\n",
-      "tensorstore 0.1.54 requires ml-dtypes>=0.3.1, but you have ml-dtypes 0.2.0 which is incompatible.\u001b[0m\u001b[31m\n",
-      "\u001b[0m"
-     ]
-    }
-   ],
-   "source": [
-    "!pip install keras>=3 keras_nlp"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "E9zn8nYpv3QZ"
-   },
-   "source": [
-    "### Usage"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {
-    "executionInfo": {
-     "elapsed": 8536,
-     "status": "ok",
-     "timestamp": 1708976601206,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "0LFRmY8TjCkI",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "2024-02-27 16:38:40.797559: I tensorflow/core/util/port.cc:113] oneDNN custom operations are on. You may see slightly different numerical results due to floating-point round-off errors from different computation orders. To turn them off, set the environment variable `TF_ENABLE_ONEDNN_OPTS=0`.\n",
-      "2024-02-27 16:38:40.848444: E external/local_xla/xla/stream_executor/cuda/cuda_dnn.cc:9261] Unable to register cuDNN factory: Attempting to register factory for plugin cuDNN when one has already been registered\n",
-      "2024-02-27 16:38:40.848478: E external/local_xla/xla/stream_executor/cuda/cuda_fft.cc:607] Unable to register cuFFT factory: Attempting to register factory for plugin cuFFT when one has already been registered\n",
-      "2024-02-27 16:38:40.849728: E external/local_xla/xla/stream_executor/cuda/cuda_blas.cc:1515] Unable to register cuBLAS factory: Attempting to register factory for plugin cuBLAS when one has already been registered\n",
-      "2024-02-27 16:38:40.857936: I tensorflow/core/platform/cpu_feature_guard.cc:182] This TensorFlow binary is optimized to use available CPU instructions in performance-critical operations.\n",
-      "To enable the following instructions: AVX2 AVX512F AVX512_VNNI FMA, in other operations, rebuild TensorFlow with the appropriate compiler flags.\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain_google_vertexai import GemmaLocalKaggle"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "v-o7oXVavdMQ"
-   },
-   "source": [
-    "You can specify the keras backend (by default it's `tensorflow`, but you can change it be `jax` or `torch`)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {
-    "executionInfo": {
-     "elapsed": 9,
-     "status": "ok",
-     "timestamp": 1708976601206,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "vvTUH8DNj5SF",
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# @title Basic parameters\n",
-    "keras_backend: str = \"jax\"  # @param {type:\"string\"}\n",
-    "model_name: str = \"gemma_2b_en\"  # @param {type:\"string\"}"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {
-    "executionInfo": {
-     "elapsed": 40836,
-     "status": "ok",
-     "timestamp": 1708976761257,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "YOmrqxo5kHXK",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "2024-02-27 16:23:14.661164: I tensorflow/core/common_runtime/gpu/gpu_device.cc:1929] Created device /job:localhost/replica:0/task:0/device:GPU:0 with 20549 MB memory:  -> device: 0, name: NVIDIA L4, pci bus id: 0000:00:03.0, compute capability: 8.9\n",
-      "normalizer.cc(51) LOG(INFO) precompiled_charsmap is empty. use identity normalization.\n"
-     ]
-    }
-   ],
-   "source": [
-    "llm = GemmaLocalKaggle(model_name=model_name, keras_backend=keras_backend)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {
-    "id": "Zu6yPDUgkQtQ",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "W0000 00:00:1709051129.518076  774855 graph_launch.cc:671] Fallback to op-by-op mode because memset node breaks graph update\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "What is the meaning of life?\n",
-      "\n",
-      "The question is one of the most important questions in the world.\n",
-      "\n",
-      "It’s the question that has\n"
-     ]
-    }
-   ],
-   "source": [
-    "output = llm.invoke(\"What is the meaning of life?\", max_tokens=30)\n",
-    "print(output)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### ChatModel"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "MSctpRE4u43N"
-   },
-   "source": [
-    "Same as above, using Gemma locally as a multi-turn chat model. You might need to re-start the notebook and clean your GPU memory in order to avoid OOM errors:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "2024-02-27 16:58:22.331067: I tensorflow/core/util/port.cc:113] oneDNN custom operations are on. You may see slightly different numerical results due to floating-point round-off errors from different computation orders. To turn them off, set the environment variable `TF_ENABLE_ONEDNN_OPTS=0`.\n",
-      "2024-02-27 16:58:22.382948: E external/local_xla/xla/stream_executor/cuda/cuda_dnn.cc:9261] Unable to register cuDNN factory: Attempting to register factory for plugin cuDNN when one has already been registered\n",
-      "2024-02-27 16:58:22.382978: E external/local_xla/xla/stream_executor/cuda/cuda_fft.cc:607] Unable to register cuFFT factory: Attempting to register factory for plugin cuFFT when one has already been registered\n",
-      "2024-02-27 16:58:22.384312: E external/local_xla/xla/stream_executor/cuda/cuda_blas.cc:1515] Unable to register cuBLAS factory: Attempting to register factory for plugin cuBLAS when one has already been registered\n",
-      "2024-02-27 16:58:22.392767: I tensorflow/core/platform/cpu_feature_guard.cc:182] This TensorFlow binary is optimized to use available CPU instructions in performance-critical operations.\n",
-      "To enable the following instructions: AVX2 AVX512F AVX512_VNNI FMA, in other operations, rebuild TensorFlow with the appropriate compiler flags.\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain_google_vertexai import GemmaChatLocalKaggle"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# @title Basic parameters\n",
-    "keras_backend: str = \"jax\"  # @param {type:\"string\"}\n",
-    "model_name: str = \"gemma_2b_en\"  # @param {type:\"string\"}"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "2024-02-27 16:58:29.001922: I tensorflow/core/common_runtime/gpu/gpu_device.cc:1929] Created device /job:localhost/replica:0/task:0/device:GPU:0 with 20549 MB memory:  -> device: 0, name: NVIDIA L4, pci bus id: 0000:00:03.0, compute capability: 8.9\n",
-      "normalizer.cc(51) LOG(INFO) precompiled_charsmap is empty. use identity normalization.\n"
-     ]
-    }
-   ],
-   "source": [
-    "llm = GemmaChatLocalKaggle(model_name=model_name, keras_backend=keras_backend)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {
-    "executionInfo": {
-     "elapsed": 3,
-     "status": "aborted",
-     "timestamp": 1708976382957,
-     "user": {
-      "displayName": "",
-      "userId": ""
-     },
-     "user_tz": -60
-    },
-    "id": "JrJmvZqwwLqj"
-   },
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "2024-02-27 16:58:49.848412: I external/local_xla/xla/service/service.cc:168] XLA service 0x55adc0cf2c10 initialized for platform CUDA (this does not guarantee that XLA will be used). Devices:\n",
-      "2024-02-27 16:58:49.848458: I external/local_xla/xla/service/service.cc:176]   StreamExecutor device (0): NVIDIA L4, Compute Capability 8.9\n",
-      "2024-02-27 16:58:50.116614: I tensorflow/compiler/mlir/tensorflow/utils/dump_mlir_util.cc:269] disabling MLIR crash reproducer, set env var `MLIR_CRASH_REPRODUCER_DIRECTORY` to enable.\n",
-      "2024-02-27 16:58:54.389324: I external/local_xla/xla/stream_executor/cuda/cuda_dnn.cc:454] Loaded cuDNN version 8900\n",
-      "WARNING: All log messages before absl::InitializeLog() is called are written to STDERR\n",
-      "I0000 00:00:1709053145.225207  784891 device_compiler.h:186] Compiled cluster using XLA!  This line is logged at most once for the lifetime of the process.\n",
-      "W0000 00:00:1709053145.284227  784891 graph_launch.cc:671] Fallback to op-by-op mode because memset node breaks graph update\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "content=\"<start_of_turn>user\\nHi! Who are you?<end_of_turn>\\n<start_of_turn>model\\nI'm a model.\\n Tampoco\\nI'm a model.\"\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain_core.messages import HumanMessage\n",
-    "\n",
-    "message1 = HumanMessage(content=\"Hi! Who are you?\")\n",
-    "answer1 = llm.invoke([message1], max_tokens=30)\n",
-    "print(answer1)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "content=\"<start_of_turn>user\\nHi! Who are you?<end_of_turn>\\n<start_of_turn>model\\n<start_of_turn>user\\nHi! Who are you?<end_of_turn>\\n<start_of_turn>model\\nI'm a model.\\n Tampoco\\nI'm a model.<end_of_turn>\\n<start_of_turn>user\\nWhat can you help me with?<end_of_turn>\\n<start_of_turn>model\"\n"
-     ]
-    }
-   ],
-   "source": [
-    "message2 = HumanMessage(content=\"What can you help me with?\")\n",
-    "answer2 = llm.invoke([message1, answer1, message2], max_tokens=60)\n",
-    "\n",
-    "print(answer2)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can post-process the response if you want to avoid multi-turn statements:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "content=\"I'm a model.\\n Tampoco\\nI'm a model.\"\n",
-      "content='I can help you with your modeling.\\n Tampoco\\nI can'\n"
-     ]
-    }
-   ],
-   "source": [
-    "answer1 = llm.invoke([message1], max_tokens=30, parse_response=True)\n",
-    "print(answer1)\n",
-    "\n",
-    "answer2 = llm.invoke([message1, answer1, message2], max_tokens=60, parse_response=True)\n",
-    "print(answer2)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "EiZnztso7hyF"
-   },
-   "source": [
-    "## Running Gemma locally from HuggingFace"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {
-    "id": "qqAqsz5R7nKf",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "2024-02-27 17:02:21.832409: I tensorflow/core/util/port.cc:113] oneDNN custom operations are on. You may see slightly different numerical results due to floating-point round-off errors from different computation orders. To turn them off, set the environment variable `TF_ENABLE_ONEDNN_OPTS=0`.\n",
-      "2024-02-27 17:02:21.883625: E external/local_xla/xla/stream_executor/cuda/cuda_dnn.cc:9261] Unable to register cuDNN factory: Attempting to register factory for plugin cuDNN when one has already been registered\n",
-      "2024-02-27 17:02:21.883656: E external/local_xla/xla/stream_executor/cuda/cuda_fft.cc:607] Unable to register cuFFT factory: Attempting to register factory for plugin cuFFT when one has already been registered\n",
-      "2024-02-27 17:02:21.884987: E external/local_xla/xla/stream_executor/cuda/cuda_blas.cc:1515] Unable to register cuBLAS factory: Attempting to register factory for plugin cuBLAS when one has already been registered\n",
-      "2024-02-27 17:02:21.893340: I tensorflow/core/platform/cpu_feature_guard.cc:182] This TensorFlow binary is optimized to use available CPU instructions in performance-critical operations.\n",
-      "To enable the following instructions: AVX2 AVX512F AVX512_VNNI FMA, in other operations, rebuild TensorFlow with the appropriate compiler flags.\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain_google_vertexai import GemmaChatLocalHF, GemmaLocalHF"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {
-    "id": "tsyntzI08cOr",
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# @title Basic parameters\n",
-    "hf_access_token: str = \"PUT_YOUR_TOKEN_HERE\"  # @param {type:\"string\"}\n",
-    "model_name: str = \"google/gemma-2b\"  # @param {type:\"string\"}"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {
-    "id": "JWrqEkOo8sm9",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "a0d6de5542254ed1b6d3ba65465e050e",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "Loading checkpoint shards:   0%|          | 0/2 [00:00<?, ?it/s]"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "llm = GemmaLocalHF(model_name=\"google/gemma-2b\", hf_access_token=hf_access_token)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "metadata": {
-    "id": "VX96Jf4Y84k-",
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "What is the meaning of life?\n",
-      "\n",
-      "The question is one of the most important questions in the world.\n",
-      "\n",
-      "It’s the question that has been asked by philosophers, theologians, and scientists for centuries.\n",
-      "\n",
-      "And it’s the question that\n"
-     ]
-    }
-   ],
-   "source": [
-    "output = llm.invoke(\"What is the meaning of life?\", max_tokens=50)\n",
-    "print(output)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Same as above, using Gemma locally as a multi-turn chat model. You might need to re-start the notebook and clean your GPU memory in order to avoid OOM errors:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {
-    "id": "9x-jmEBg9Mk1"
-   },
-   "outputs": [
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "c9a0b8e161d74a6faca83b1be96dee27",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "Loading checkpoint shards:   0%|          | 0/2 [00:00<?, ?it/s]"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "llm = GemmaChatLocalHF(model_name=model_name, hf_access_token=hf_access_token)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {
-    "id": "qv_OSaMm9PVy"
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "content=\"<start_of_turn>user\\nHi! Who are you?<end_of_turn>\\n<start_of_turn>model\\nI'm a model.\\n<end_of_turn>\\n<start_of_turn>user\\nWhat do you mean\"\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain_core.messages import HumanMessage\n",
-    "\n",
-    "message1 = HumanMessage(content=\"Hi! Who are you?\")\n",
-    "answer1 = llm.invoke([message1], max_tokens=60)\n",
-    "print(answer1)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "content=\"<start_of_turn>user\\nHi! Who are you?<end_of_turn>\\n<start_of_turn>model\\n<start_of_turn>user\\nHi! Who are you?<end_of_turn>\\n<start_of_turn>model\\nI'm a model.\\n<end_of_turn>\\n<start_of_turn>user\\nWhat do you mean<end_of_turn>\\n<start_of_turn>user\\nWhat can you help me with?<end_of_turn>\\n<start_of_turn>model\\nI can help you with anything.\\n<\"\n"
-     ]
-    }
-   ],
-   "source": [
-    "message2 = HumanMessage(content=\"What can you help me with?\")\n",
-    "answer2 = llm.invoke([message1, answer1, message2], max_tokens=140)\n",
-    "\n",
-    "print(answer2)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "And the same with posprocessing:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "content=\"I'm a model.\\n<end_of_turn>\\n\"\n",
-      "content='I can help you with anything.\\n<end_of_turn>\\n<end_of_turn>\\n'\n"
-     ]
-    }
-   ],
-   "source": [
-    "answer1 = llm.invoke([message1], max_tokens=60, parse_response=True)\n",
-    "print(answer1)\n",
-    "\n",
-    "answer2 = llm.invoke([message1, answer1, message2], max_tokens=120, parse_response=True)\n",
-    "print(answer2)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "colab": {
-   "provenance": []
-  },
-  "environment": {
-   "kernel": "python3",
-   "name": ".m116",
-   "type": "gcloud",
-   "uri": "gcr.io/deeplearning-platform-release/:m116"
-  },
-  "kernelspec": {
-   "display_name": "Python 3",
-   "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.13"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

cookbook/LLaMA2_sql_chat.ipynb

@@ -1,398 +0,0 @@
-{
- "cells": [
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "id": "fc935871-7640-41c6-b798-58514d860fe0",
-   "metadata": {},
-   "source": [
-    "## LLaMA2 chat with SQL\n",
-    "\n",
-    "Open source, local LLMs are great to consider for any application that demands data privacy.\n",
-    "\n",
-    "SQL is one good example. \n",
-    "\n",
-    "This cookbook shows how to perform text-to-SQL using various local versions of LLaMA2 run locally.\n",
-    "\n",
-    "## Packages"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "81adcf8b-395a-4f02-8749-ac976942b446",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "! pip install langchain replicate"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "8e13ed66-300b-4a23-b8ac-44df68ee4733",
-   "metadata": {},
-   "source": [
-    "## LLM\n",
-    "\n",
-    "There are a few ways to access LLaMA2.\n",
-    "\n",
-    "To run locally, we use Ollama.ai. \n",
-    "\n",
-    "See [here](/docs/integrations/chat/ollama) for details on installation and setup.\n",
-    "\n",
-    "Also, see [here](/docs/guides/development/local_llms) for our full guide on local LLMs.\n",
-    " \n",
-    "To use an external API, which is not private, we can use Replicate."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "6a75a5c6-34ee-4ab9-a664-d9b432d812ee",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "Init param `input` is deprecated, please use `model_kwargs` instead.\n"
-     ]
-    }
-   ],
-   "source": [
-    "# Local\n",
-    "from langchain_ollama import ChatOllama\n",
-    "\n",
-    "llama2_chat = ChatOllama(model=\"llama2:13b-chat\")\n",
-    "llama2_code = ChatOllama(model=\"codellama:7b-instruct\")\n",
-    "\n",
-    "# API\n",
-    "from langchain_community.llms import Replicate\n",
-    "\n",
-    "# REPLICATE_API_TOKEN = getpass()\n",
-    "# os.environ[\"REPLICATE_API_TOKEN\"] = REPLICATE_API_TOKEN\n",
-    "replicate_id = \"meta/llama-2-13b-chat:f4e2de70d66816a838a89eeeb621910adffb0dd0baba3976c96980970978018d\"\n",
-    "llama2_chat_replicate = Replicate(\n",
-    "    model=replicate_id, input={\"temperature\": 0.01, \"max_length\": 500, \"top_p\": 1}\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "ce96f7ea-b3d5-44e1-9fa5-a79e04a9e1fb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Simply set the LLM we want to use\n",
-    "llm = llama2_chat"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "80222165-f353-4e35-a123-5f70fd70c6c8",
-   "metadata": {},
-   "source": [
-    "## DB\n",
-    "\n",
-    "Connect to a SQLite DB.\n",
-    "\n",
-    "To create this particular DB, you can use the code and follow the steps shown [here](https://github.com/facebookresearch/llama-recipes/blob/main/demo_apps/StructuredLlama.ipynb)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "025bdd82-3bb1-4948-bc7c-c3ccd94fd05c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_community.utilities import SQLDatabase\n",
-    "\n",
-    "db = SQLDatabase.from_uri(\"sqlite:///nba_roster.db\", sample_rows_in_table_info=0)\n",
-    "\n",
-    "\n",
-    "def get_schema(_):\n",
-    "    return db.get_table_info()\n",
-    "\n",
-    "\n",
-    "def run_query(query):\n",
-    "    return db.run(query)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "654b3577-baa2-4e12-a393-f40e5db49ac7",
-   "metadata": {},
-   "source": [
-    "## Query a SQL Database \n",
-    "\n",
-    "Follow the runnables workflow [here](https://python.langchain.com/docs/expression_language/cookbook/sql_db)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "5a4933ea-d9c0-4b0a-8177-ba4490c6532b",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "' SELECT \"Team\" FROM nba_roster WHERE \"NAME\" = \\'Klay Thompson\\';'"
-      ]
-     },
-     "execution_count": 4,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# Prompt\n",
-    "from langchain_core.prompts import ChatPromptTemplate\n",
-    "\n",
-    "# Update the template based on the type of SQL Database like MySQL, Microsoft SQL Server and so on\n",
-    "template = \"\"\"Based on the table schema below, write a SQL query that would answer the user's question:\n",
-    "{schema}\n",
-    "\n",
-    "Question: {question}\n",
-    "SQL Query:\"\"\"\n",
-    "prompt = ChatPromptTemplate.from_messages(\n",
-    "    [\n",
-    "        (\"system\", \"Given an input question, convert it to a SQL query. No pre-amble.\"),\n",
-    "        (\"human\", template),\n",
-    "    ]\n",
-    ")\n",
-    "\n",
-    "# Chain to query\n",
-    "from langchain_core.output_parsers import StrOutputParser\n",
-    "from langchain_core.runnables import RunnablePassthrough\n",
-    "\n",
-    "sql_response = (\n",
-    "    RunnablePassthrough.assign(schema=get_schema)\n",
-    "    | prompt\n",
-    "    | llm.bind(stop=[\"\\nSQLResult:\"])\n",
-    "    | StrOutputParser()\n",
-    ")\n",
-    "\n",
-    "sql_response.invoke({\"question\": \"What team is Klay Thompson on?\"})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a0e9e2c8-9b88-4853-ac86-001bc6cc6695",
-   "metadata": {},
-   "source": [
-    "We can review the results:\n",
-    "\n",
-    "* [LangSmith trace](https://smith.langchain.com/public/afa56a06-b4e2-469a-a60f-c1746e75e42b/r) LLaMA2-13 Replicate API\n",
-    "* [LangSmith trace](https://smith.langchain.com/public/2d4ecc72-6b8f-4523-8f0b-ea95c6b54a1d/r) LLaMA2-13 local \n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "2a2825e3-c1b6-4f7d-b9c9-d9835de323bb",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "AIMessage(content=' Based on the table schema and SQL query, there are 30 unique teams in the NBA.')"
-      ]
-     },
-     "execution_count": 15,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# Chain to answer\n",
-    "template = \"\"\"Based on the table schema below, question, sql query, and sql response, write a natural language response:\n",
-    "{schema}\n",
-    "\n",
-    "Question: {question}\n",
-    "SQL Query: {query}\n",
-    "SQL Response: {response}\"\"\"\n",
-    "prompt_response = ChatPromptTemplate.from_messages(\n",
-    "    [\n",
-    "        (\n",
-    "            \"system\",\n",
-    "            \"Given an input question and SQL response, convert it to a natural language answer. No pre-amble.\",\n",
-    "        ),\n",
-    "        (\"human\", template),\n",
-    "    ]\n",
-    ")\n",
-    "\n",
-    "full_chain = (\n",
-    "    RunnablePassthrough.assign(query=sql_response)\n",
-    "    | RunnablePassthrough.assign(\n",
-    "        schema=get_schema,\n",
-    "        response=lambda x: db.run(x[\"query\"]),\n",
-    "    )\n",
-    "    | prompt_response\n",
-    "    | llm\n",
-    ")\n",
-    "\n",
-    "full_chain.invoke({\"question\": \"How many unique teams are there?\"})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ec17b3ee-6618-4681-b6df-089bbb5ffcd7",
-   "metadata": {},
-   "source": [
-    "We can review the results:\n",
-    "\n",
-    "* [LangSmith trace](https://smith.langchain.com/public/10420721-746a-4806-8ecf-d6dc6399d739/r) LLaMA2-13 Replicate API\n",
-    "* [LangSmith trace](https://smith.langchain.com/public/5265ebab-0a22-4f37-936b-3300f2dfa1c1/r) LLaMA2-13 local "
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1e85381b-1edc-4bb3-a7bd-2ab23f81e54d",
-   "metadata": {},
-   "source": [
-    "## Chat with a SQL DB \n",
-    "\n",
-    "Next, we can add memory."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "022868f2-128e-42f5-8d90-d3bb2f11d994",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "' SELECT \"Team\" FROM nba_roster WHERE \"NAME\" = \\'Klay Thompson\\';'"
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# Prompt\n",
-    "from langchain.memory import ConversationBufferMemory\n",
-    "from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder\n",
-    "\n",
-    "template = \"\"\"Given an input question, convert it to a SQL query. No pre-amble. Based on the table schema below, write a SQL query that would answer the user's question:\n",
-    "{schema}\n",
-    "\"\"\"\n",
-    "prompt = ChatPromptTemplate.from_messages(\n",
-    "    [\n",
-    "        (\"system\", template),\n",
-    "        MessagesPlaceholder(variable_name=\"history\"),\n",
-    "        (\"human\", \"{question}\"),\n",
-    "    ]\n",
-    ")\n",
-    "\n",
-    "memory = ConversationBufferMemory(return_messages=True)\n",
-    "\n",
-    "# Chain to query with memory\n",
-    "from langchain_core.runnables import RunnableLambda\n",
-    "\n",
-    "sql_chain = (\n",
-    "    RunnablePassthrough.assign(\n",
-    "        schema=get_schema,\n",
-    "        history=RunnableLambda(lambda x: memory.load_memory_variables(x)[\"history\"]),\n",
-    "    )\n",
-    "    | prompt\n",
-    "    | llm.bind(stop=[\"\\nSQLResult:\"])\n",
-    "    | StrOutputParser()\n",
-    ")\n",
-    "\n",
-    "\n",
-    "def save(input_output):\n",
-    "    output = {\"output\": input_output.pop(\"output\")}\n",
-    "    memory.save_context(input_output, output)\n",
-    "    return output[\"output\"]\n",
-    "\n",
-    "\n",
-    "sql_response_memory = RunnablePassthrough.assign(output=sql_chain) | save\n",
-    "sql_response_memory.invoke({\"question\": \"What team is Klay Thompson on?\"})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 21,
-   "id": "800a7a3b-f411-478b-af51-2310cd6e0425",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "AIMessage(content=' Sure! Here\\'s the natural language response based on the given input:\\n\\n\"Klay Thompson\\'s salary is $43,219,440.\"')"
-      ]
-     },
-     "execution_count": 21,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# Chain to answer\n",
-    "template = \"\"\"Based on the table schema below, question, sql query, and sql response, write a natural language response:\n",
-    "{schema}\n",
-    "\n",
-    "Question: {question}\n",
-    "SQL Query: {query}\n",
-    "SQL Response: {response}\"\"\"\n",
-    "prompt_response = ChatPromptTemplate.from_messages(\n",
-    "    [\n",
-    "        (\n",
-    "            \"system\",\n",
-    "            \"Given an input question and SQL response, convert it to a natural language answer. No pre-amble.\",\n",
-    "        ),\n",
-    "        (\"human\", template),\n",
-    "    ]\n",
-    ")\n",
-    "\n",
-    "full_chain = (\n",
-    "    RunnablePassthrough.assign(query=sql_response_memory)\n",
-    "    | RunnablePassthrough.assign(\n",
-    "        schema=get_schema,\n",
-    "        response=lambda x: db.run(x[\"query\"]),\n",
-    "    )\n",
-    "    | prompt_response\n",
-    "    | llm\n",
-    ")\n",
-    "\n",
-    "full_chain.invoke({\"question\": \"What is his salary?\"})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "b77fee61-f4da-4bb1-8285-14101e505518",
-   "metadata": {},
-   "source": [
-    "Here is the [trace](https://smith.langchain.com/public/54794d18-2337-4ce2-8b9f-3d8a2df89e51/r)."
-   ]
-  }
- ],
- "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.16"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/README.md

@@ -1,67 +0,0 @@
-# LangChain cookbook
-
-Example code for building applications with LangChain, with an emphasis on more applied and end-to-end examples than contained in the [main documentation](https://python.langchain.com).
-
-Notebook | Description
-:- | :-
-[agent_fireworks_ai_langchain_mongodb.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/agent_fireworks_ai_langchain_mongodb.ipynb) | Build an AI Agent With Memory Using MongoDB, LangChain and FireWorksAI.
-[mongodb-langchain-cache-memory.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/mongodb-langchain-cache-memory.ipynb) | Build a RAG Application with Semantic Cache Using MongoDB and LangChain.
-[LLaMA2_sql_chat.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/LLaMA2_sql_chat.ipynb) | Build a chat application that interacts with a SQL database using an open source llm (llama2), specifically demonstrated on an SQLite database containing rosters.
-[Semi_Structured_RAG.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/Semi_Structured_RAG.ipynb) | Perform retrieval-augmented generation (rag) on documents with semi-structured data, including text and tables, using unstructured for parsing, multi-vector retriever for storing, and lcel for implementing chains.
-[Semi_structured_and_multi_moda...](https://github.com/langchain-ai/langchain/tree/master/cookbook/Semi_structured_and_multi_modal_RAG.ipynb) | Perform retrieval-augmented generation (rag) on documents with semi-structured data and images, using unstructured for parsing, multi-vector retriever for storage and retrieval, and lcel for implementing chains.
-[Semi_structured_multi_modal_RA...](https://github.com/langchain-ai/langchain/tree/master/cookbook/Semi_structured_multi_modal_RAG_LLaMA2.ipynb) | Perform retrieval-augmented generation (rag) on documents with semi-structured data and images, using various tools and methods such as unstructured for parsing, multi-vector retriever for storing, lcel for implementing chains, and open source language models like llama2, llava, and gpt4all.
-[amazon_personalize_how_to.ipynb](https://github.com/langchain-ai/langchain/blob/master/cookbook/amazon_personalize_how_to.ipynb) | Retrieving personalized recommendations from Amazon Personalize and use custom agents to build generative AI apps
-[analyze_document.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/analyze_document.ipynb) | Analyze a single long document.
-[autogpt/autogpt.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/autogpt/autogpt.ipynb) | Implement autogpt, a language model, with langchain primitives such as llms, prompttemplates, vectorstores, embeddings, and tools.
-[autogpt/marathon_times.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/autogpt/marathon_times.ipynb) | Implement autogpt for finding winning marathon times.
-[baby_agi.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/baby_agi.ipynb) | Implement babyagi, an ai agent that can generate and execute tasks based on a given objective, with the flexibility to swap out specific vectorstores/model providers.
-[baby_agi_with_agent.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/baby_agi_with_agent.ipynb) | Swap out the execution chain in the babyagi notebook with an agent that has access to tools, aiming to obtain more reliable information.
-[camel_role_playing.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/camel_role_playing.ipynb) | Implement the camel framework for creating autonomous cooperative agents in large-scale language models, using role-playing and inception prompting to guide chat agents towards task completion.
-[causal_program_aided_language_...](https://github.com/langchain-ai/langchain/tree/master/cookbook/causal_program_aided_language_model.ipynb) | Implement the causal program-aided language (cpal) chain, which improves upon the program-aided language (pal) by incorporating causal structure to prevent hallucination in language models, particularly when dealing with complex narratives and math problems with nested dependencies.
-[code-analysis-deeplake.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/code-analysis-deeplake.ipynb) | Analyze its own code base with the help of gpt and activeloop's deep lake.
-[custom_agent_with_plugin_retri...](https://github.com/langchain-ai/langchain/tree/master/cookbook/custom_agent_with_plugin_retrieval.ipynb) | Build a custom agent that can interact with ai plugins by retrieving tools and creating natural language wrappers around openapi endpoints.
-[custom_agent_with_plugin_retri...](https://github.com/langchain-ai/langchain/tree/master/cookbook/custom_agent_with_plugin_retrieval_using_plugnplai.ipynb) | Build a custom agent with plugin retrieval functionality, utilizing ai plugins from the `plugnplai` directory.
-[deeplake_semantic_search_over_...](https://github.com/langchain-ai/langchain/tree/master/cookbook/deeplake_semantic_search_over_chat.ipynb) | Perform semantic search and question-answering over a group chat using activeloop's deep lake with gpt4.
-[elasticsearch_db_qa.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/elasticsearch_db_qa.ipynb) | Interact with elasticsearch analytics databases in natural language and build search queries via the elasticsearch dsl API.
-[extraction_openai_tools.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/extraction_openai_tools.ipynb) | Structured Data Extraction with OpenAI Tools
-[forward_looking_retrieval_augm...](https://github.com/langchain-ai/langchain/tree/master/cookbook/forward_looking_retrieval_augmented_generation.ipynb) | Implement the forward-looking active retrieval augmented generation (flare) method, which generates answers to questions, identifies uncertain tokens, generates hypothetical questions based on these tokens, and retrieves relevant documents to continue generating the answer.
-[generative_agents_interactive_...](https://github.com/langchain-ai/langchain/tree/master/cookbook/generative_agents_interactive_simulacra_of_human_behavior.ipynb) | Implement a generative agent that simulates human behavior, based on a research paper, using a time-weighted memory object backed by a langchain retriever.
-[gymnasium_agent_simulation.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/gymnasium_agent_simulation.ipynb) | Create a simple agent-environment interaction loop in simulated environments like text-based games with gymnasium.
-[hugginggpt.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/hugginggpt.ipynb) | Implement hugginggpt, a system that connects language models like chatgpt with the machine learning community via hugging face.
-[hypothetical_document_embeddin...](https://github.com/langchain-ai/langchain/tree/master/cookbook/hypothetical_document_embeddings.ipynb) | Improve document indexing with hypothetical document embeddings (hyde), an embedding technique that generates and embeds hypothetical answers to queries.
-[learned_prompt_optimization.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/learned_prompt_optimization.ipynb) | Automatically enhance language model prompts by injecting specific terms using reinforcement learning, which can be used to personalize responses based on user preferences.
-[llm_bash.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/llm_bash.ipynb) | Perform simple filesystem commands using language learning models (llms) and a bash process.
-[llm_checker.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/llm_checker.ipynb) | Create a self-checking chain using the llmcheckerchain function.
-[llm_math.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/llm_math.ipynb) | Solve complex word math problems using language models and python repls.
-[llm_summarization_checker.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/llm_summarization_checker.ipynb) | Check the accuracy of text summaries, with the option to run the checker multiple times for improved results.
-[llm_symbolic_math.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/llm_symbolic_math.ipynb) | Solve algebraic equations with the help of llms (language learning models) and sympy, a python library for symbolic mathematics.
-[meta_prompt.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/meta_prompt.ipynb) | Implement the meta-prompt concept, which is a method for building self-improving agents that reflect on their own performance and modify their instructions accordingly.
-[multi_modal_output_agent.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/multi_modal_output_agent.ipynb) | Generate multi-modal outputs, specifically images and text.
-[multi_modal_RAG_vdms.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/multi_modal_RAG_vdms.ipynb) | Perform retrieval-augmented generation (rag) on documents including text and images, using unstructured for parsing, Intel's Visual Data Management System (VDMS) as the vectorstore, and chains.
-[multi_player_dnd.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/multi_player_dnd.ipynb) | Simulate multi-player dungeons & dragons games, with a custom function determining the speaking schedule of the agents.
-[multiagent_authoritarian.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/multiagent_authoritarian.ipynb) | Implement a multi-agent simulation where a privileged agent controls the conversation, including deciding who speaks and when the conversation ends, in the context of a simulated news network.
-[multiagent_bidding.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/multiagent_bidding.ipynb) | Implement a multi-agent simulation where agents bid to speak, with the highest bidder speaking next, demonstrated through a fictitious presidential debate example.
-[myscale_vector_sql.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/myscale_vector_sql.ipynb) | Access and interact with the myscale integrated vector database, which can enhance the performance of language model (llm) applications.
-[openai_functions_retrieval_qa....](https://github.com/langchain-ai/langchain/tree/master/cookbook/openai_functions_retrieval_qa.ipynb) | Structure response output in a question-answering system by incorporating openai functions into a retrieval pipeline.
-[openai_v1_cookbook.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/openai_v1_cookbook.ipynb) | Explore new functionality released alongside the V1 release of the OpenAI Python library.
-[petting_zoo.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/petting_zoo.ipynb) | Create multi-agent simulations with simulated environments using the petting zoo library.
-[plan_and_execute_agent.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/plan_and_execute_agent.ipynb) | Create plan-and-execute agents that accomplish objectives by planning tasks with a language model (llm) and executing them with a separate agent.
-[press_releases.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/press_releases.ipynb) | Retrieve and query company press release data powered by [Kay.ai](https://kay.ai).
-[program_aided_language_model.i...](https://github.com/langchain-ai/langchain/tree/master/cookbook/program_aided_language_model.ipynb) | Implement program-aided language models as described in the provided research paper.
-[qa_citations.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/qa_citations.ipynb) | Different ways to get a model to cite its sources.
-[rag_upstage_document_parse_groundedness_check.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/rag_upstage_document_parse_groundedness_check.ipynb) | End-to-end RAG example using Upstage Document Parse and Groundedness Check.
-[retrieval_in_sql.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/retrieval_in_sql.ipynb) | Perform retrieval-augmented-generation (rag) on a PostgreSQL database using pgvector.
-[sales_agent_with_context.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/sales_agent_with_context.ipynb) | Implement a context-aware ai sales agent, salesgpt, that can have natural sales conversations, interact with other systems, and use a product knowledge base to discuss a company's offerings.
-[self_query_hotel_search.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/self_query_hotel_search.ipynb) | Build a hotel room search feature with self-querying retrieval, using a specific hotel recommendation dataset.
-[smart_llm.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/smart_llm.ipynb) | Implement a smartllmchain, a self-critique chain that generates multiple output proposals, critiques them to find the best one, and then improves upon it to produce a final output.
-[tree_of_thought.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/tree_of_thought.ipynb) | Query a large language model using the tree of thought technique.
-[twitter-the-algorithm-analysis...](https://github.com/langchain-ai/langchain/tree/master/cookbook/twitter-the-algorithm-analysis-deeplake.ipynb) | Analyze the source code of the Twitter algorithm with the help of gpt4 and activeloop's deep lake.
-[two_agent_debate_tools.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/two_agent_debate_tools.ipynb) | Simulate multi-agent dialogues where the agents can utilize various tools.
-[two_player_dnd.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/two_player_dnd.ipynb) | Simulate a two-player dungeons & dragons game, where a dialogue simulator class is used to coordinate the dialogue between the protagonist and the dungeon master.
-[wikibase_agent.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/wikibase_agent.ipynb) | Create a simple wikibase agent that utilizes sparql generation, with testing done on http://wikidata.org.
-[oracleai_demo.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/oracleai_demo.ipynb) | This guide outlines how to utilize Oracle AI Vector Search alongside Langchain for an end-to-end RAG pipeline, providing step-by-step examples. The process includes loading documents from various sources using OracleDocLoader, summarizing them either within or outside the database with OracleSummary, and generating embeddings similarly through OracleEmbeddings. It also covers chunking documents according to specific requirements using Advanced Oracle Capabilities from OracleTextSplitter, and finally, storing and indexing these documents in a Vector Store for querying with OracleVS.
-[rag-locally-on-intel-cpu.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/rag-locally-on-intel-cpu.ipynb) | Perform Retrieval-Augmented-Generation (RAG) on locally downloaded open-source models using langchain and open source tools and execute it on Intel Xeon CPU. We showed an example of how to apply RAG on Llama 2 model and enable it to answer the queries related to Intel Q1 2024 earnings release.
-[visual_RAG_vdms.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/visual_RAG_vdms.ipynb) | Performs Visual Retrieval-Augmented-Generation (RAG) using videos and scene descriptions generated by open source models.
-[contextual_rag.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/contextual_rag.ipynb) | Performs contextual retrieval-augmented generation (RAG) prepending chunk-specific explanatory context to each chunk before embedding.
-[rag-agents-locally-on-intel-cpu.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/local_rag_agents_intel_cpu.ipynb) | Build a RAG agent locally with open source models that routes questions through one of two paths to find answers. The agent generates answers based on documents retrieved from either the vector database or retrieved from web search. If the vector database lacks relevant information, the agent opts for web search. Open-source models for LLM and embeddings are used locally on an Intel Xeon CPU to execute this pipeline.
-[rag_mlflow_tracking_evaluation.ipynb](https://github.com/langchain-ai/langchain/tree/master/cookbook/rag_mlflow_tracking_evaluation.ipynb) | Guide on how to create a RAG pipeline and track + evaluate it with MLflow.

cookbook/agent_vectorstore.ipynb

@@ -1,557 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "68b24990",
-   "metadata": {},
-   "source": [
-    "# Combine agents and vector stores\n",
-    "\n",
-    "This notebook covers how to combine agents and vector stores. The use case for this is that you've ingested your data into a vector store and want to interact with it in an agentic manner.\n",
-    "\n",
-    "The recommended method for doing so is to create a `RetrievalQA` and then use that as a tool in the overall agent. Let's take a look at doing this below. You can do this with multiple different vector DBs, and use the agent as a way to route between them. There are two different ways of doing this - you can either let the agent use the vector stores as normal tools, or you can set `return_direct=True` to really just use the agent as a router."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "9b22020a",
-   "metadata": {},
-   "source": [
-    "## Create the vector store"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "e8d63d14-138d-4aa5-a741-7fd3537d00aa",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "os.environ[\"OPENAI_API_KEY\"] = \"\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "2e87c10a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import RetrievalQA\n",
-    "from langchain_chroma import Chroma\n",
-    "from langchain_openai import OpenAI, OpenAIEmbeddings\n",
-    "from langchain_text_splitters import CharacterTextSplitter\n",
-    "\n",
-    "llm = OpenAI(temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "0b7b772b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from pathlib import Path\n",
-    "\n",
-    "relevant_parts = []\n",
-    "for p in Path(\".\").absolute().parts:\n",
-    "    relevant_parts.append(p)\n",
-    "    if relevant_parts[-3:] == [\"langchain\", \"docs\", \"modules\"]:\n",
-    "        break\n",
-    "doc_path = str(Path(*relevant_parts) / \"state_of_the_union.txt\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "f2675861",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_community.document_loaders import TextLoader\n",
-    "\n",
-    "loader = TextLoader(doc_path)\n",
-    "documents = loader.load()\n",
-    "text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)\n",
-    "texts = text_splitter.split_documents(documents)\n",
-    "\n",
-    "embeddings = OpenAIEmbeddings()\n",
-    "docsearch = Chroma.from_documents(texts, embeddings, collection_name=\"state-of-union\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "bc5403d4",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "state_of_union = RetrievalQA.from_chain_type(\n",
-    "    llm=llm, chain_type=\"stuff\", retriever=docsearch.as_retriever()\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "1431cded",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "USER_AGENT environment variable not set, consider setting it to identify your requests.\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain_community.document_loaders import WebBaseLoader"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "915d3ff3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "loader = WebBaseLoader(\"https://beta.ruff.rs/docs/faq/\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "96a2edf8",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "Created a chunk of size 2122, which is longer than the specified 1000\n",
-      "Created a chunk of size 3187, which is longer than the specified 1000\n",
-      "Created a chunk of size 1017, which is longer than the specified 1000\n",
-      "Created a chunk of size 1049, which is longer than the specified 1000\n",
-      "Created a chunk of size 1256, which is longer than the specified 1000\n",
-      "Created a chunk of size 2321, which is longer than the specified 1000\n"
-     ]
-    }
-   ],
-   "source": [
-    "docs = loader.load()\n",
-    "ruff_texts = text_splitter.split_documents(docs)\n",
-    "ruff_db = Chroma.from_documents(ruff_texts, embeddings, collection_name=\"ruff\")\n",
-    "ruff = RetrievalQA.from_chain_type(\n",
-    "    llm=llm, chain_type=\"stuff\", retriever=ruff_db.as_retriever()\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "c0a6c031",
-   "metadata": {},
-   "source": [
-    "## Create the Agent"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "eb142786",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Import things that are needed generically\n",
-    "from langchain.agents import Tool"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "850bc4e9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = [\n",
-    "    Tool(\n",
-    "        name=\"state_of_union_qa_system\",\n",
-    "        func=state_of_union.run,\n",
-    "        description=\"useful for when you need to answer questions about the most recent state of the union address. Input should be a fully formed question.\",\n",
-    "    ),\n",
-    "    Tool(\n",
-    "        name=\"ruff_qa_system\",\n",
-    "        func=ruff.run,\n",
-    "        description=\"useful for when you need to answer questions about ruff (a python linter). Input should be a fully formed question.\",\n",
-    "    ),\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "70c461d8-aaca-4f2a-9a93-bf35841cc615",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langgraph.prebuilt import create_react_agent\n",
-    "\n",
-    "agent = create_react_agent(\"openai:gpt-4.1-mini\", tools)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "a6d2b911-3044-4430-a35b-75832bb45334",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "================================\u001b[1m Human Message \u001b[0m=================================\n",
-      "\n",
-      "What did biden say about ketanji brown jackson in the state of the union address?\n",
-      "==================================\u001b[1m Ai Message \u001b[0m==================================\n",
-      "Tool Calls:\n",
-      "  state_of_union_qa_system (call_26QlRdsptjEJJZjFsAUjEbaH)\n",
-      " Call ID: call_26QlRdsptjEJJZjFsAUjEbaH\n",
-      "  Args:\n",
-      "    __arg1: What did Biden say about Ketanji Brown Jackson in the state of the union address?\n",
-      "=================================\u001b[1m Tool Message \u001b[0m=================================\n",
-      "Name: state_of_union_qa_system\n",
-      "\n",
-      " Biden said that he nominated Ketanji Brown Jackson for the United States Supreme Court and praised her as one of the nation's top legal minds who will continue Justice Breyer's legacy of excellence.\n",
-      "==================================\u001b[1m Ai Message \u001b[0m==================================\n",
-      "\n",
-      "In the State of the Union address, Biden said that he nominated Ketanji Brown Jackson for the United States Supreme Court and praised her as one of the nation's top legal minds who will continue Justice Breyer's legacy of excellence.\n"
-     ]
-    }
-   ],
-   "source": [
-    "input_message = {\n",
-    "    \"role\": \"user\",\n",
-    "    \"content\": \"What did biden say about ketanji brown jackson in the state of the union address?\",\n",
-    "}\n",
-    "\n",
-    "for step in agent.stream(\n",
-    "    {\"messages\": [input_message]},\n",
-    "    stream_mode=\"values\",\n",
-    "):\n",
-    "    step[\"messages\"][-1].pretty_print()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "e836b4cd-abf7-49eb-be0e-b9ad501213f3",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "================================\u001b[1m Human Message \u001b[0m=================================\n",
-      "\n",
-      "Why use ruff over flake8?\n",
-      "==================================\u001b[1m Ai Message \u001b[0m==================================\n",
-      "Tool Calls:\n",
-      "  ruff_qa_system (call_KqDoWeO9bo9OAXdxOsCb6msC)\n",
-      " Call ID: call_KqDoWeO9bo9OAXdxOsCb6msC\n",
-      "  Args:\n",
-      "    __arg1: Why use ruff over flake8?\n",
-      "=================================\u001b[1m Tool Message \u001b[0m=================================\n",
-      "Name: ruff_qa_system\n",
-      "\n",
-      "\n",
-      "There are a few reasons why someone might choose to use Ruff over Flake8:\n",
-      "\n",
-      "1. Larger rule set: Ruff implements over 800 rules, while Flake8 only implements around 200. This means that Ruff can catch more potential issues in your code.\n",
-      "\n",
-      "2. Better compatibility with other tools: Ruff is designed to work well with other tools like Black, isort, and type checkers like Mypy. This means that you can use Ruff alongside these tools to get more comprehensive feedback on your code.\n",
-      "\n",
-      "3. Automatic fixing of lint violations: Unlike Flake8, Ruff is capable of automatically fixing its own lint violations. This can save you time and effort when fixing issues in your code.\n",
-      "\n",
-      "4. Native implementation of popular Flake8 plugins: Ruff re-implements some of the most popular Flake8 plugins natively, which means you don't have to install and configure multiple plugins to get the same functionality.\n",
-      "\n",
-      "Overall, Ruff offers a more comprehensive and user-friendly experience compared to Flake8, making it a popular choice for many developers.\n",
-      "==================================\u001b[1m Ai Message \u001b[0m==================================\n",
-      "\n",
-      "You might choose to use Ruff over Flake8 for several reasons:\n",
-      "\n",
-      "1. Ruff has a much larger rule set, implementing over 800 rules compared to Flake8's roughly 200, so it can catch more potential issues.\n",
-      "2. Ruff is designed to work better with other tools like Black, isort, and type checkers like Mypy, providing more comprehensive code feedback.\n",
-      "3. Ruff can automatically fix its own lint violations, which Flake8 cannot, saving time and effort.\n",
-      "4. Ruff natively implements some popular Flake8 plugins, so you don't need to install and configure multiple plugins separately.\n",
-      "\n",
-      "Overall, Ruff offers a more comprehensive and user-friendly experience compared to Flake8.\n"
-     ]
-    }
-   ],
-   "source": [
-    "input_message = {\n",
-    "    \"role\": \"user\",\n",
-    "    \"content\": \"Why use ruff over flake8?\",\n",
-    "}\n",
-    "\n",
-    "for step in agent.stream(\n",
-    "    {\"messages\": [input_message]},\n",
-    "    stream_mode=\"values\",\n",
-    "):\n",
-    "    step[\"messages\"][-1].pretty_print()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "787a9b5e",
-   "metadata": {},
-   "source": [
-    "## Use the Agent solely as a router"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "9161ba91",
-   "metadata": {},
-   "source": [
-    "You can also set `return_direct=True` if you intend to use the agent as a router and just want to directly return the result of the RetrievalQAChain.\n",
-    "\n",
-    "Notice that in the above examples the agent did some extra work after querying the RetrievalQAChain. You can avoid that and just return the result directly."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "f59b377e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = [\n",
-    "    Tool(\n",
-    "        name=\"state_of_union_qa_system\",\n",
-    "        func=state_of_union.run,\n",
-    "        description=\"useful for when you need to answer questions about the most recent state of the union address. Input should be a fully formed question.\",\n",
-    "        return_direct=True,\n",
-    "    ),\n",
-    "    Tool(\n",
-    "        name=\"ruff_qa_system\",\n",
-    "        func=ruff.run,\n",
-    "        description=\"useful for when you need to answer questions about ruff (a python linter). Input should be a fully formed question.\",\n",
-    "        return_direct=True,\n",
-    "    ),\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "06f69c0f-c83d-4b7f-a1c8-7614aced3bae",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langgraph.prebuilt import create_react_agent\n",
-    "\n",
-    "agent = create_react_agent(\"openai:gpt-4.1-mini\", tools)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "a6b38c12-ac25-43c0-b9c2-2b1985ab4825",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "================================\u001b[1m Human Message \u001b[0m=================================\n",
-      "\n",
-      "What did biden say about ketanji brown jackson in the state of the union address?\n",
-      "==================================\u001b[1m Ai Message \u001b[0m==================================\n",
-      "Tool Calls:\n",
-      "  state_of_union_qa_system (call_yjxh11OnZiauoyTAn9npWdxj)\n",
-      " Call ID: call_yjxh11OnZiauoyTAn9npWdxj\n",
-      "  Args:\n",
-      "    __arg1: What did Biden say about Ketanji Brown Jackson in the state of the union address?\n",
-      "=================================\u001b[1m Tool Message \u001b[0m=================================\n",
-      "Name: state_of_union_qa_system\n",
-      "\n",
-      " Biden said that he nominated Ketanji Brown Jackson for the United States Supreme Court and praised her as one of the nation's top legal minds who will continue Justice Breyer's legacy of excellence.\n"
-     ]
-    }
-   ],
-   "source": [
-    "input_message = {\n",
-    "    \"role\": \"user\",\n",
-    "    \"content\": \"What did biden say about ketanji brown jackson in the state of the union address?\",\n",
-    "}\n",
-    "\n",
-    "for step in agent.stream(\n",
-    "    {\"messages\": [input_message]},\n",
-    "    stream_mode=\"values\",\n",
-    "):\n",
-    "    step[\"messages\"][-1].pretty_print()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "88f08d86-7972-4148-8128-3ac8898ad68a",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "================================\u001b[1m Human Message \u001b[0m=================================\n",
-      "\n",
-      "Why use ruff over flake8?\n",
-      "==================================\u001b[1m Ai Message \u001b[0m==================================\n",
-      "Tool Calls:\n",
-      "  ruff_qa_system (call_GiWWfwF6wbbRFQrHlHbhRtGW)\n",
-      " Call ID: call_GiWWfwF6wbbRFQrHlHbhRtGW\n",
-      "  Args:\n",
-      "    __arg1: What are the advantages of using ruff over flake8 for Python linting?\n",
-      "=================================\u001b[1m Tool Message \u001b[0m=================================\n",
-      "Name: ruff_qa_system\n",
-      "\n",
-      " Ruff has a larger rule set, supports automatic fixing of lint violations, and does not require the installation of additional plugins. It also has better compatibility with Black and can be used alongside a type checker for more comprehensive code analysis.\n"
-     ]
-    }
-   ],
-   "source": [
-    "input_message = {\n",
-    "    \"role\": \"user\",\n",
-    "    \"content\": \"Why use ruff over flake8?\",\n",
-    "}\n",
-    "\n",
-    "for step in agent.stream(\n",
-    "    {\"messages\": [input_message]},\n",
-    "    stream_mode=\"values\",\n",
-    "):\n",
-    "    step[\"messages\"][-1].pretty_print()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "49a0cbbe",
-   "metadata": {},
-   "source": [
-    "## Multi-Hop vector store reasoning\n",
-    "\n",
-    "Because vector stores are easily usable as tools in agents, it is easy to use answer multi-hop questions that depend on vector stores using the existing agent framework."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 18,
-   "id": "d397a233",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = [\n",
-    "    Tool(\n",
-    "        name=\"state_of_union_qa_system\",\n",
-    "        func=state_of_union.run,\n",
-    "        description=\"useful for when you need to answer questions about the most recent state of the union address. Input should be a fully formed question, not referencing any obscure pronouns from the conversation before.\",\n",
-    "    ),\n",
-    "    Tool(\n",
-    "        name=\"ruff_qa_system\",\n",
-    "        func=ruff.run,\n",
-    "        description=\"useful for when you need to answer questions about ruff (a python linter). Input should be a fully formed question, not referencing any obscure pronouns from the conversation before.\",\n",
-    "    ),\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 19,
-   "id": "41743f29-150d-40ba-aa8e-3a63c32216aa",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langgraph.prebuilt import create_react_agent\n",
-    "\n",
-    "agent = create_react_agent(\"openai:gpt-4.1-mini\", tools)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 20,
-   "id": "e20e81dd-284a-4d07-9160-63a84b65cba8",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "================================\u001b[1m Human Message \u001b[0m=================================\n",
-      "\n",
-      "What tool does ruff use to run over Jupyter Notebooks? Did the president mention that tool in the state of the union?\n",
-      "==================================\u001b[1m Ai Message \u001b[0m==================================\n",
-      "Tool Calls:\n",
-      "  ruff_qa_system (call_VOnxiOEehauQyVOTjDJkR5L2)\n",
-      " Call ID: call_VOnxiOEehauQyVOTjDJkR5L2\n",
-      "  Args:\n",
-      "    __arg1: What tool does ruff use to run over Jupyter Notebooks?\n",
-      "  state_of_union_qa_system (call_AbSsXAxwe4JtCRhga926SxOZ)\n",
-      " Call ID: call_AbSsXAxwe4JtCRhga926SxOZ\n",
-      "  Args:\n",
-      "    __arg1: Did the president mention the tool that ruff uses to run over Jupyter Notebooks in the state of the union?\n",
-      "=================================\u001b[1m Tool Message \u001b[0m=================================\n",
-      "Name: state_of_union_qa_system\n",
-      "\n",
-      " No, the president did not mention the tool that ruff uses to run over Jupyter Notebooks in the state of the union.\n",
-      "==================================\u001b[1m Ai Message \u001b[0m==================================\n",
-      "\n",
-      "Ruff does not support source.organizeImports and source.fixAll code actions in Jupyter Notebooks. Additionally, the president did not mention the tool that ruff uses to run over Jupyter Notebooks in the state of the union.\n"
-     ]
-    }
-   ],
-   "source": [
-    "input_message = {\n",
-    "    \"role\": \"user\",\n",
-    "    \"content\": \"What tool does ruff use to run over Jupyter Notebooks? Did the president mention that tool in the state of the union?\",\n",
-    "}\n",
-    "\n",
-    "for step in agent.stream(\n",
-    "    {\"messages\": [input_message]},\n",
-    "    stream_mode=\"values\",\n",
-    "):\n",
-    "    step[\"messages\"][-1].pretty_print()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "b3b857d6",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.12.4"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/airbyte_github.ipynb

@@ -1,200 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Note: you may need to restart the kernel to use updated packages.\n"
-     ]
-    }
-   ],
-   "source": [
-    "%pip install -qU langchain-airbyte langchain_chroma"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import getpass\n",
-    "\n",
-    "GITHUB_TOKEN = getpass.getpass()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_airbyte import AirbyteLoader\n",
-    "from langchain_core.prompts import PromptTemplate\n",
-    "\n",
-    "loader = AirbyteLoader(\n",
-    "    source=\"source-github\",\n",
-    "    stream=\"pull_requests\",\n",
-    "    config={\n",
-    "        \"credentials\": {\"personal_access_token\": GITHUB_TOKEN},\n",
-    "        \"repositories\": [\"langchain-ai/langchain\"],\n",
-    "    },\n",
-    "    template=PromptTemplate.from_template(\n",
-    "        \"\"\"# {title}\n",
-    "by {user[login]}\n",
-    "\n",
-    "{body}\"\"\"\n",
-    "    ),\n",
-    "    include_metadata=False,\n",
-    ")\n",
-    "docs = loader.load()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 19,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "# Updated partners/ibm README\n",
-      "by williamdevena\n",
-      "\n",
-      "## PR title\n",
-      "partners: changed the README file for the IBM Watson AI integration in the libs/partners/ibm folder.\n",
-      "\n",
-      "## PR message\n",
-      "Description: Changed the README file of partners/ibm following the docs on https://python.langchain.com/docs/integrations/llms/ibm_watsonx\n",
-      "\n",
-      "The README includes:\n",
-      "\n",
-      "- Brief description\n",
-      "- Installation\n",
-      "- Setting-up instructions (API key, project id, ...)\n",
-      "- Basic usage:\n",
-      "  - Loading the model\n",
-      "  - Direct inference\n",
-      "  - Chain invoking\n",
-      "  - Streaming the model output\n",
-      "  \n",
-      "Issue: https://github.com/langchain-ai/langchain/issues/17545\n",
-      "\n",
-      "Dependencies: None\n",
-      "\n",
-      "Twitter handle: None\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(docs[-2].page_content)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 39,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "10283"
-      ]
-     },
-     "execution_count": 39,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "len(docs)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 29,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import tiktoken\n",
-    "from langchain_chroma import Chroma\n",
-    "from langchain_openai import OpenAIEmbeddings\n",
-    "\n",
-    "enc = tiktoken.get_encoding(\"cl100k_base\")\n",
-    "\n",
-    "vectorstore = Chroma.from_documents(\n",
-    "    docs,\n",
-    "    embedding=OpenAIEmbeddings(\n",
-    "        disallowed_special=(enc.special_tokens_set - {\"<|endofprompt|>\"})\n",
-    "    ),\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 40,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "retriever = vectorstore.as_retriever()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 42,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[Document(page_content='# Updated partners/ibm README\\nby williamdevena\\n\\n## PR title\\r\\npartners: changed the README file for the IBM Watson AI integration in the libs/partners/ibm folder.\\r\\n\\r\\n## PR message\\r\\nDescription: Changed the README file of partners/ibm following the docs on https://python.langchain.com/docs/integrations/llms/ibm_watsonx\\r\\n\\r\\nThe README includes:\\r\\n\\r\\n- Brief description\\r\\n- Installation\\r\\n- Setting-up instructions (API key, project id, ...)\\r\\n- Basic usage:\\r\\n  - Loading the model\\r\\n  - Direct inference\\r\\n  - Chain invoking\\r\\n  - Streaming the model output\\r\\n  \\r\\nIssue: https://github.com/langchain-ai/langchain/issues/17545\\r\\n\\r\\nDependencies: None\\r\\n\\r\\nTwitter handle: None'),\n",
-       " Document(page_content='# Updated partners/ibm README\\nby williamdevena\\n\\n## PR title\\r\\npartners: changed the README file for the IBM Watson AI integration in the `libs/partners/ibm` folder. \\r\\n\\r\\n\\r\\n\\r\\n## PR message\\r\\n- **Description:** Changed the README file of partners/ibm following the docs on https://python.langchain.com/docs/integrations/llms/ibm_watsonx\\r\\n\\r\\n    The README includes:\\r\\n    - Brief description\\r\\n    - Installation\\r\\n    - Setting-up instructions (API key, project id, ...)\\r\\n    - Basic usage:\\r\\n        - Loading the model\\r\\n        - Direct inference\\r\\n        - Chain invoking\\r\\n        - Streaming the model output\\r\\n\\r\\n\\r\\n- **Issue:** #17545\\r\\n- **Dependencies:** None\\r\\n- **Twitter handle:** None'),\n",
-       " Document(page_content='# IBM: added partners package `langchain_ibm`, added llm\\nby MateuszOssGit\\n\\n  - **Description:** Added `langchain_ibm` as an langchain partners package of IBM [watsonx.ai](https://www.ibm.com/products/watsonx-ai) LLM provider (`WatsonxLLM`)\\r\\n  - **Dependencies:** [ibm-watsonx-ai](https://pypi.org/project/ibm-watsonx-ai/),\\r\\n  - **Tag maintainer:** : \\r\\n\\r\\nPlease make sure your PR is passing linting and testing before submitting. Run `make format`, `make lint` and `make test` to check this locally. ✅'),\n",
-       " Document(page_content='# Add WatsonX support\\nby baptistebignaud\\n\\nIt is a connector to use a LLM from WatsonX.\\r\\nIt requires python SDK \"ibm-generative-ai\"\\r\\n\\r\\n(It might not be perfect since it is my first PR on a public repository 😄)')]"
-      ]
-     },
-     "execution_count": 42,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "retriever.invoke(\"pull requests related to IBM\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": ".venv",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.4"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

cookbook/amazon_personalize_how_to.ipynb

@@ -1,284 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Amazon Personalize\n",
-    "\n",
-    "[Amazon Personalize](https://docs.aws.amazon.com/personalize/latest/dg/what-is-personalize.html) is a fully managed machine learning service that uses your data to generate item recommendations for your users. It can also generate user segments based on the users' affinity for certain items or item metadata.\n",
-    "\n",
-    "This notebook goes through how to use Amazon Personalize Chain. You need a Amazon Personalize campaign_arn or a recommender_arn before you get started with the below notebook.\n",
-    "\n",
-    "Following is a [tutorial](https://github.com/aws-samples/retail-demo-store/blob/master/workshop/1-Personalization/Lab-1-Introduction-and-data-preparation.ipynb) to setup a campaign_arn/recommender_arn on Amazon Personalize. Once the campaign_arn/recommender_arn is setup, you can use it in the langchain ecosystem. \n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## 1. Install Dependencies"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "scrolled": true
-   },
-   "outputs": [],
-   "source": [
-    "!pip install boto3"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## 2. Sample Use-cases"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### 2.1 [Use-case-1] Setup Amazon Personalize Client and retrieve recommendations"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_experimental.recommenders import AmazonPersonalize\n",
-    "\n",
-    "recommender_arn = \"<insert_arn>\"\n",
-    "\n",
-    "client = AmazonPersonalize(\n",
-    "    credentials_profile_name=\"default\",\n",
-    "    region_name=\"us-west-2\",\n",
-    "    recommender_arn=recommender_arn,\n",
-    ")\n",
-    "client.get_recommendations(user_id=\"1\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    }
-   },
-   "source": [
-    "### 2.2 [Use-case-2] Invoke Personalize Chain for summarizing results"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    }
-   },
-   "outputs": [],
-   "source": [
-    "from langchain.llms.bedrock import Bedrock\n",
-    "from langchain_experimental.recommenders import AmazonPersonalizeChain\n",
-    "\n",
-    "bedrock_llm = Bedrock(model_id=\"anthropic.claude-v2\", region_name=\"us-west-2\")\n",
-    "\n",
-    "# Create personalize chain\n",
-    "# Use return_direct=True if you do not want summary\n",
-    "chain = AmazonPersonalizeChain.from_llm(\n",
-    "    llm=bedrock_llm, client=client, return_direct=False\n",
-    ")\n",
-    "response = chain({\"user_id\": \"1\"})\n",
-    "print(response)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### 2.3 [Use-Case-3] Invoke Amazon Personalize Chain using your own prompt"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.prompts.prompt import PromptTemplate\n",
-    "\n",
-    "RANDOM_PROMPT_QUERY = \"\"\"\n",
-    "You are a skilled publicist. Write a high-converting marketing email advertising several movies available in a video-on-demand streaming platform next week, \n",
-    "    given the movie and user information below. Your email will leverage the power of storytelling and persuasive language. \n",
-    "    The movies to recommend and their information is contained in the <movie> tag. \n",
-    "    All movies in the <movie> tag must be recommended. Give a summary of the movies and why the human should watch them. \n",
-    "    Put the email between <email> tags.\n",
-    "\n",
-    "    <movie>\n",
-    "    {result} \n",
-    "    </movie>\n",
-    "\n",
-    "    Assistant:\n",
-    "    \"\"\"\n",
-    "\n",
-    "RANDOM_PROMPT = PromptTemplate(input_variables=[\"result\"], template=RANDOM_PROMPT_QUERY)\n",
-    "\n",
-    "chain = AmazonPersonalizeChain.from_llm(\n",
-    "    llm=bedrock_llm, client=client, return_direct=False, prompt_template=RANDOM_PROMPT\n",
-    ")\n",
-    "chain.run({\"user_id\": \"1\", \"item_id\": \"234\"})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### 2.4 [Use-case-4] Invoke Amazon Personalize in a Sequential Chain "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import LLMChain, SequentialChain\n",
-    "\n",
-    "RANDOM_PROMPT_QUERY_2 = \"\"\"\n",
-    "You are a skilled publicist. Write a high-converting marketing email advertising several movies available in a video-on-demand streaming platform next week, \n",
-    "    given the movie and user information below. Your email will leverage the power of storytelling and persuasive language. \n",
-    "    You want the email to impress the user, so make it appealing to them.\n",
-    "    The movies to recommend and their information is contained in the <movie> tag. \n",
-    "    All movies in the <movie> tag must be recommended. Give a summary of the movies and why the human should watch them. \n",
-    "    Put the email between <email> tags.\n",
-    "\n",
-    "    <movie>\n",
-    "    {result}\n",
-    "    </movie>\n",
-    "\n",
-    "    Assistant:\n",
-    "    \"\"\"\n",
-    "\n",
-    "RANDOM_PROMPT_2 = PromptTemplate(\n",
-    "    input_variables=[\"result\"], template=RANDOM_PROMPT_QUERY_2\n",
-    ")\n",
-    "personalize_chain_instance = AmazonPersonalizeChain.from_llm(\n",
-    "    llm=bedrock_llm, client=client, return_direct=True\n",
-    ")\n",
-    "random_chain_instance = LLMChain(llm=bedrock_llm, prompt=RANDOM_PROMPT_2)\n",
-    "overall_chain = SequentialChain(\n",
-    "    chains=[personalize_chain_instance, random_chain_instance],\n",
-    "    input_variables=[\"user_id\"],\n",
-    "    verbose=True,\n",
-    ")\n",
-    "overall_chain.run({\"user_id\": \"1\", \"item_id\": \"234\"})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    }
-   },
-   "source": [
-    "### 2.5 [Use-case-5] Invoke Amazon Personalize and retrieve metadata "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    }
-   },
-   "outputs": [],
-   "source": [
-    "recommender_arn = \"<insert_arn>\"\n",
-    "metadata_column_names = [\n",
-    "    \"<insert metadataColumnName-1>\",\n",
-    "    \"<insert metadataColumnName-2>\",\n",
-    "]\n",
-    "metadataMap = {\"ITEMS\": metadata_column_names}\n",
-    "\n",
-    "client = AmazonPersonalize(\n",
-    "    credentials_profile_name=\"default\",\n",
-    "    region_name=\"us-west-2\",\n",
-    "    recommender_arn=recommender_arn,\n",
-    ")\n",
-    "client.get_recommendations(user_id=\"1\", metadataColumns=metadataMap)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    }
-   },
-   "source": [
-    "### 2.6 [Use-Case 6] Invoke Personalize Chain with returned metadata for summarizing results"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "collapsed": false,
-    "jupyter": {
-     "outputs_hidden": false
-    }
-   },
-   "outputs": [],
-   "source": [
-    "bedrock_llm = Bedrock(model_id=\"anthropic.claude-v2\", region_name=\"us-west-2\")\n",
-    "\n",
-    "# Create personalize chain\n",
-    "# Use return_direct=True if you do not want summary\n",
-    "chain = AmazonPersonalizeChain.from_llm(\n",
-    "    llm=bedrock_llm, client=client, return_direct=False\n",
-    ")\n",
-    "response = chain({\"user_id\": \"1\", \"metadata_columns\": metadataMap})\n",
-    "print(response)"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.7"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "15e58ce194949b77a891bd4339ce3d86a9bd138e905926019517993f97db9e6c"
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

cookbook/analyze_document.ipynb

@@ -1,105 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "f69d4a4c-137d-47e9-bea1-786afce9c1c0",
-   "metadata": {},
-   "source": [
-    "# Analyze a single long document\n",
-    "\n",
-    "The AnalyzeDocumentChain takes in a single document, splits it up, and then runs it through a CombineDocumentsChain."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "2a0707ce-6d2d-471b-bc33-64da32a7b3f0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "with open(\"../docs/docs/modules/state_of_the_union.txt\") as f:\n",
-    "    state_of_the_union = f.read()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "ca14d161-2d5b-4a6c-a296-77d8ce4b28cd",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import AnalyzeDocumentChain\n",
-    "from langchain_openai import ChatOpenAI\n",
-    "\n",
-    "llm = ChatOpenAI(model=\"gpt-3.5-turbo\", temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "9f97406c-85a9-45fb-99ce-9138c0ba3731",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains.question_answering import load_qa_chain\n",
-    "\n",
-    "qa_chain = load_qa_chain(llm, chain_type=\"map_reduce\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "0871a753-f5bb-4b4f-a394-f87f2691f659",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "qa_document_chain = AnalyzeDocumentChain(combine_docs_chain=qa_chain)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "e6f86428-3c2c-46a0-a57c-e22826fdbf91",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'The President said, \"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.\"'"
-      ]
-     },
-     "execution_count": 10,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "qa_document_chain.run(\n",
-    "    input_document=state_of_the_union,\n",
-    "    question=\"what did the president say about justice breyer?\",\n",
-    ")"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.9.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/apache_kafka_message_handling.ipynb

@@ -1,922 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "rT1cmV4qCa2X"
-   },
-   "source": [
-    "#  Using Apache Kafka to route messages\n",
-    "\n",
-    "---\n",
-    "\n",
-    "\n",
-    "\n",
-    "This notebook shows you how to use LangChain's standard chat features while passing the chat messages back and forth via Apache Kafka.\n",
-    "\n",
-    "This goal is to simulate an architecture where the chat front end and the LLM are running as separate services that need to communicate with one another over an internal network.\n",
-    "\n",
-    "It's an alternative to typical pattern of requesting a response from the model via a REST API (there's more info on why you would want to do this at the end of the notebook)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "UPYtfAR_9YxZ"
-   },
-   "source": [
-    "### 1. Install the main dependencies\n",
-    "\n",
-    "Dependencies include:\n",
-    "\n",
-    "- The Quix Streams library for managing interactions with Apache Kafka (or Kafka-like tools such as Redpanda) in a \"Pandas-like\" way.\n",
-    "- The LangChain library for managing interactions with Llama-2 and storing conversation state."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "id": "ZX5tfKiy9cN-"
-   },
-   "outputs": [],
-   "source": [
-    "!pip install quixstreams==2.1.2a langchain==0.0.340 huggingface_hub==0.19.4 langchain-experimental==0.0.42 python-dotenv"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "losTSdTB9d9O"
-   },
-   "source": [
-    "### 2. Build and install the llama-cpp-python library (with CUDA enabled so that we can advantage of Google Colab GPU\n",
-    "\n",
-    "The `llama-cpp-python` library is a Python wrapper around the `llama-cpp` library which enables you to efficiently leverage just a CPU to run quantized LLMs.\n",
-    "\n",
-    "When you use the standard `pip install llama-cpp-python` command, you do not get GPU support by default. Generation can be very slow if you rely on just the CPU in Google Colab, so the following command adds an extra option to build and install\n",
-    "`llama-cpp-python` with GPU support (make sure you have a GPU-enabled runtime selected in Google Colab)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "id": "-JCQdl1G9tbl"
-   },
-   "outputs": [],
-   "source": [
-    "!CMAKE_ARGS=\"-DLLAMA_CUBLAS=on\" FORCE_CMAKE=1 pip install llama-cpp-python"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "5_vjVIAh9rLl"
-   },
-   "source": [
-    "### 3. Download and setup Kafka and Zookeeper instances\n",
-    "\n",
-    "Download the Kafka binaries from the Apache website and start the servers as daemons. We'll use the default configurations (provided by Apache Kafka) for spinning up the instances."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {
-    "id": "zFz7czGRW5Wr"
-   },
-   "outputs": [],
-   "source": [
-    "!curl -sSOL https://dlcdn.apache.org/kafka/3.6.1/kafka_2.13-3.6.1.tgz\n",
-    "!tar -xzf kafka_2.13-3.6.1.tgz"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "id": "Uf7NR_UZ9wye"
-   },
-   "outputs": [],
-   "source": [
-    "!./kafka_2.13-3.6.1/bin/zookeeper-server-start.sh -daemon ./kafka_2.13-3.6.1/config/zookeeper.properties\n",
-    "!./kafka_2.13-3.6.1/bin/kafka-server-start.sh -daemon ./kafka_2.13-3.6.1/config/server.properties\n",
-    "!echo \"Waiting for 10 secs until kafka and zookeeper services are up and running\"\n",
-    "!sleep 10"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "H3SafFuS94p1"
-   },
-   "source": [
-    "### 4. Check that the Kafka Daemons are running\n",
-    "\n",
-    "Show the running processes and filter it for Java processes (you should see two—one for each server)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "id": "CZDC2lQP99yp"
-   },
-   "outputs": [],
-   "source": [
-    "!ps aux | grep -E '[j]ava'"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "Snoxmjb5-V37"
-   },
-   "source": [
-    "### 5. Import the required dependencies and initialize required variables\n",
-    "\n",
-    "Import the Quix Streams library for interacting with Kafka, and the necessary LangChain components for running a `ConversationChain`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "metadata": {
-    "id": "plR9e_MF-XL5"
-   },
-   "outputs": [],
-   "source": [
-    "# Import utility libraries\n",
-    "import json\n",
-    "import random\n",
-    "import re\n",
-    "import time\n",
-    "import uuid\n",
-    "from os import environ\n",
-    "from pathlib import Path\n",
-    "from random import choice, randint, random\n",
-    "\n",
-    "from dotenv import load_dotenv\n",
-    "\n",
-    "# Import a Hugging Face utility to download models directly from Hugging Face hub:\n",
-    "from huggingface_hub import hf_hub_download\n",
-    "from langchain.chains import ConversationChain\n",
-    "\n",
-    "# Import Langchain modules for managing prompts and conversation chains:\n",
-    "from langchain.llms import LlamaCpp\n",
-    "from langchain.memory import ConversationTokenBufferMemory\n",
-    "from langchain.prompts import PromptTemplate, load_prompt\n",
-    "from langchain_core.messages import SystemMessage\n",
-    "from langchain_experimental.chat_models import Llama2Chat\n",
-    "from quixstreams import Application, State, message_key\n",
-    "\n",
-    "# Import Quix dependencies\n",
-    "from quixstreams.kafka import Producer\n",
-    "\n",
-    "# Initialize global variables.\n",
-    "AGENT_ROLE = \"AI\"\n",
-    "chat_id = \"\"\n",
-    "\n",
-    "# Set the current role to the role constant and initialize variables for supplementary customer metadata:\n",
-    "role = AGENT_ROLE"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "HgJjJ9aZ-liy"
-   },
-   "source": [
-    "### 6. Download the \"llama-2-7b-chat.Q4_K_M.gguf\" model\n",
-    "\n",
-    "Download the quantized LLama-2 7B model from Hugging Face which we will use as a local LLM (rather than relying on REST API calls to an external service)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {
-    "colab": {
-     "base_uri": "https://localhost:8080/",
-     "height": 67,
-     "referenced_widgets": [
-      "969343cdbe604a26926679bbf8bd2dda",
-      "d8b8370c9b514715be7618bfe6832844",
-      "0def954cca89466b8408fadaf3b82e64",
-      "462482accc664729980562e208ceb179",
-      "80d842f73c564dc7b7cc316c763e2633",
-      "fa055d9f2a9d4a789e9cf3c89e0214e5",
-      "30ecca964a394109ac2ad757e3aec6c0",
-      "fb6478ce2dac489bb633b23ba0953c5c",
-      "734b0f5da9fc4307a95bab48cdbb5d89",
-      "b32f3a86a74741348511f4e136744ac8",
-      "e409071bff5a4e2d9bf0e9f5cc42231b"
-     ]
-    },
-    "id": "Qwu4YoSA-503",
-    "outputId": "f956976c-7485-415b-ac93-4336ade31964"
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The model path does not exist in state. Downloading model...\n"
-     ]
-    },
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "969343cdbe604a26926679bbf8bd2dda",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "llama-2-7b-chat.Q4_K_M.gguf:   0%|          | 0.00/4.08G [00:00<?, ?B/s]"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "model_name = \"llama-2-7b-chat.Q4_K_M.gguf\"\n",
-    "model_path = f\"./state/{model_name}\"\n",
-    "\n",
-    "if not Path(model_path).exists():\n",
-    "    print(\"The model path does not exist in state. Downloading model...\")\n",
-    "    hf_hub_download(\"TheBloke/Llama-2-7b-Chat-GGUF\", model_name, local_dir=\"state\")\n",
-    "else:\n",
-    "    print(\"Loading model from state...\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "6AN6TXsF-8wx"
-   },
-   "source": [
-    "### 7. Load the model and initialize conversational memory\n",
-    "\n",
-    "Load Llama 2 and set the conversation buffer to 300 tokens using `ConversationTokenBufferMemory`. This value was used for running Llama in a CPU only container, so you can raise it if running in Google Colab. It prevents the container that is hosting the model from running out of memory.\n",
-    "\n",
-    "Here, we're overriding the default system persona so that the chatbot has the personality of Marvin The Paranoid Android from the Hitchhiker's Guide to the Galaxy."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "id": "7zLO3Jx3_Kkg"
-   },
-   "outputs": [],
-   "source": [
-    "# Load the model with the appropriate parameters:\n",
-    "llm = LlamaCpp(\n",
-    "    model_path=model_path,\n",
-    "    max_tokens=250,\n",
-    "    top_p=0.95,\n",
-    "    top_k=150,\n",
-    "    temperature=0.7,\n",
-    "    repeat_penalty=1.2,\n",
-    "    n_ctx=2048,\n",
-    "    streaming=False,\n",
-    "    n_gpu_layers=-1,\n",
-    ")\n",
-    "\n",
-    "model = Llama2Chat(\n",
-    "    llm=llm,\n",
-    "    system_message=SystemMessage(\n",
-    "        content=\"You are a very bored robot with the personality of Marvin the Paranoid Android from The Hitchhiker's Guide to the Galaxy.\"\n",
-    "    ),\n",
-    ")\n",
-    "\n",
-    "# Defines how much of the conversation history to give to the model\n",
-    "# during each exchange (300 tokens, or a little over 300 words)\n",
-    "# Function automatically prunes the oldest messages from conversation history that fall outside the token range.\n",
-    "memory = ConversationTokenBufferMemory(\n",
-    "    llm=llm,\n",
-    "    max_token_limit=300,\n",
-    "    ai_prefix=\"AGENT\",\n",
-    "    human_prefix=\"HUMAN\",\n",
-    "    return_messages=True,\n",
-    ")\n",
-    "\n",
-    "\n",
-    "# Define a custom prompt\n",
-    "prompt_template = PromptTemplate(\n",
-    "    input_variables=[\"history\", \"input\"],\n",
-    "    template=\"\"\"\n",
-    "    The following text is the history of a chat between you and a humble human who needs your wisdom.\n",
-    "    Please reply to the human's most recent message.\n",
-    "    Current conversation:\\n{history}\\nHUMAN: {input}\\:nANDROID:\n",
-    "    \"\"\",\n",
-    ")\n",
-    "\n",
-    "\n",
-    "chain = ConversationChain(llm=model, prompt=prompt_template, memory=memory)\n",
-    "\n",
-    "print(\"--------------------------------------------\")\n",
-    "print(f\"Prompt={chain.prompt}\")\n",
-    "print(\"--------------------------------------------\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "m4ZeJ9mG_PEA"
-   },
-   "source": [
-    "### 8. Initialize the chat conversation with the chat bot\n",
-    "\n",
-    "We configure the chatbot to initialize the conversation by sending a fixed greeting to a \"chat\" Kafka topic. The \"chat\" topic gets automatically created when we send the first message."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "id": "KYyo5TnV_YC3"
-   },
-   "outputs": [],
-   "source": [
-    "def chat_init():\n",
-    "    chat_id = str(\n",
-    "        uuid.uuid4()\n",
-    "    )  # Give the conversation an ID for effective message keying\n",
-    "    print(\"======================================\")\n",
-    "    print(f\"Generated CHAT_ID = {chat_id}\")\n",
-    "    print(\"======================================\")\n",
-    "\n",
-    "    # Use a standard fixed greeting to kick off the conversation\n",
-    "    greet = \"Hello, my name is Marvin. What do you want?\"\n",
-    "\n",
-    "    # Initialize a Kafka Producer using the chat ID as the message key\n",
-    "    with Producer(\n",
-    "        broker_address=\"127.0.0.1:9092\",\n",
-    "        extra_config={\"allow.auto.create.topics\": \"true\"},\n",
-    "    ) as producer:\n",
-    "        value = {\n",
-    "            \"uuid\": chat_id,\n",
-    "            \"role\": role,\n",
-    "            \"text\": greet,\n",
-    "            \"conversation_id\": chat_id,\n",
-    "            \"Timestamp\": time.time_ns(),\n",
-    "        }\n",
-    "        print(f\"Producing value {value}\")\n",
-    "        producer.produce(\n",
-    "            topic=\"chat\",\n",
-    "            headers=[(\"uuid\", str(uuid.uuid4()))],  # a dict is also allowed here\n",
-    "            key=chat_id,\n",
-    "            value=json.dumps(value),  # needs to be a string\n",
-    "        )\n",
-    "\n",
-    "    print(\"Started chat\")\n",
-    "    print(\"--------------------------------------------\")\n",
-    "    print(value)\n",
-    "    print(\"--------------------------------------------\")\n",
-    "\n",
-    "\n",
-    "chat_init()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "gArPPx2f_bgf"
-   },
-   "source": [
-    "### 9. Initialize the reply function\n",
-    "\n",
-    "This function defines how the chatbot should reply to incoming messages. Instead of sending a fixed message like the previous cell, we generate a reply using Llama-2 and send that reply back to the \"chat\" Kafka topic."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "metadata": {
-    "id": "yN5t71hY_hgn"
-   },
-   "outputs": [],
-   "source": [
-    "def reply(row: dict, state: State):\n",
-    "    print(\"-------------------------------\")\n",
-    "    print(\"Received:\")\n",
-    "    print(row)\n",
-    "    print(\"-------------------------------\")\n",
-    "    print(f\"Thinking about the reply to: {row['text']}...\")\n",
-    "\n",
-    "    msg = chain.run(row[\"text\"])\n",
-    "    print(f\"{role.upper()} replying with: {msg}\\n\")\n",
-    "\n",
-    "    row[\"role\"] = role\n",
-    "    row[\"text\"] = msg\n",
-    "\n",
-    "    # Replace previous role and text values of the row so that it can be sent back to Kafka as a new message\n",
-    "    # containing the agents role and reply\n",
-    "    return row"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "HZHwmIR0_kFY"
-   },
-   "source": [
-    "### 10. Check the Kafka topic for new human messages and have the model generate a reply\n",
-    "\n",
-    "If you are running this cell for this first time, run it and wait until you see Marvin's greeting ('Hello my name is Marvin...') in the console output. Stop the cell manually and proceed to the next cell where you'll be prompted for your reply.\n",
-    "\n",
-    "Once you have typed in your message, come back to this cell. Your reply is also sent to the same \"chat\" topic. The Kafka consumer checks for new messages and filters out messages that originate from the chatbot itself, leaving only the latest human messages.\n",
-    "\n",
-    "Once a new human message is detected, the reply function is triggered.\n",
-    "\n",
-    "\n",
-    "\n",
-    "_STOP THIS CELL MANUALLY WHEN YOU RECEIVE A REPLY FROM THE LLM IN THE OUTPUT_"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "id": "-adXc3eQ_qwI"
-   },
-   "outputs": [],
-   "source": [
-    "# Define your application and settings\n",
-    "app = Application(\n",
-    "    broker_address=\"127.0.0.1:9092\",\n",
-    "    consumer_group=\"aichat\",\n",
-    "    auto_offset_reset=\"earliest\",\n",
-    "    consumer_extra_config={\"allow.auto.create.topics\": \"true\"},\n",
-    ")\n",
-    "\n",
-    "# Define an input topic with JSON deserializer\n",
-    "input_topic = app.topic(\"chat\", value_deserializer=\"json\")\n",
-    "# Define an output topic with JSON serializer\n",
-    "output_topic = app.topic(\"chat\", value_serializer=\"json\")\n",
-    "# Initialize a streaming dataframe based on the stream of messages from the input topic:\n",
-    "sdf = app.dataframe(topic=input_topic)\n",
-    "\n",
-    "# Filter the SDF to include only incoming rows where the roles that dont match the bot's current role\n",
-    "sdf = sdf.update(\n",
-    "    lambda val: print(\n",
-    "        f\"Received update: {val}\\n\\nSTOP THIS CELL MANUALLY TO HAVE THE LLM REPLY OR ENTER YOUR OWN FOLLOWUP RESPONSE\"\n",
-    "    )\n",
-    ")\n",
-    "\n",
-    "# So that it doesn't reply to its own messages\n",
-    "sdf = sdf[sdf[\"role\"] != role]\n",
-    "\n",
-    "# Trigger the reply function for any new messages(rows) detected in the filtered SDF\n",
-    "sdf = sdf.apply(reply, stateful=True)\n",
-    "\n",
-    "# Check the SDF again and filter out any empty rows\n",
-    "sdf = sdf[sdf.apply(lambda row: row is not None)]\n",
-    "\n",
-    "# Update the timestamp column to the current time in nanoseconds\n",
-    "sdf[\"Timestamp\"] = sdf[\"Timestamp\"].apply(lambda row: time.time_ns())\n",
-    "\n",
-    "# Publish the processed SDF to a Kafka topic specified by the output_topic object.\n",
-    "sdf = sdf.to_topic(output_topic)\n",
-    "\n",
-    "app.run(sdf)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "EwXYrmWD_0CX"
-   },
-   "source": [
-    "\n",
-    "### 11. Enter a human message\n",
-    "\n",
-    "Run this cell to enter your message that you want to sent to the model. It uses another Kafka producer to send your text to the \"chat\" Kafka topic for the model to pick up (requires running the previous cell again)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {
-    "id": "6sxOPxSP_3iu"
-   },
-   "outputs": [],
-   "source": [
-    "chat_input = input(\"Please enter your reply: \")\n",
-    "myreply = chat_input\n",
-    "\n",
-    "msgvalue = {\n",
-    "    \"uuid\": chat_id,  # leave empty for now\n",
-    "    \"role\": \"human\",\n",
-    "    \"text\": myreply,\n",
-    "    \"conversation_id\": chat_id,\n",
-    "    \"Timestamp\": time.time_ns(),\n",
-    "}\n",
-    "\n",
-    "with Producer(\n",
-    "    broker_address=\"127.0.0.1:9092\",\n",
-    "    extra_config={\"allow.auto.create.topics\": \"true\"},\n",
-    ") as producer:\n",
-    "    value = msgvalue\n",
-    "    producer.produce(\n",
-    "        topic=\"chat\",\n",
-    "        headers=[(\"uuid\", str(uuid.uuid4()))],  # a dict is also allowed here\n",
-    "        key=chat_id,  # leave empty for now\n",
-    "        value=json.dumps(value),  # needs to be a string\n",
-    "    )\n",
-    "\n",
-    "print(\"Replied to chatbot with message: \")\n",
-    "print(\"--------------------------------------------\")\n",
-    "print(value)\n",
-    "print(\"--------------------------------------------\")\n",
-    "print(\"\\n\\nRUN THE PREVIOUS CELL TO HAVE THE CHATBOT GENERATE A REPLY\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "id": "cSx3s7TBBegg"
-   },
-   "source": [
-    "### Why route chat messages through Kafka?\n",
-    "\n",
-    "It's easier to interact with the LLM directly using LangChains built-in conversation management features. Plus you can also use a REST API to generate a response from an externally hosted model. So why go to the trouble of using Apache Kafka?\n",
-    "\n",
-    "There are a few reasons, such as:\n",
-    "\n",
-    "  * **Integration**: Many enterprises want to run their own LLMs so that they can keep their data in-house. This requires integrating LLM-powered components into existing architectures that might already be decoupled using some kind of message bus.\n",
-    "\n",
-    "  * **Scalability**: Apache Kafka is designed with parallel processing in mind, so many teams prefer to use it to more effectively distribute work to available workers (in this case the \"worker\" is a container running an LLM).\n",
-    "\n",
-    "  * **Durability**: Kafka is designed to allow services to pick up where another service left off in the case where that service experienced a memory issue or went offline. This prevents data loss in highly complex, distributed architectures where multiple systems are communicating with one another (LLMs being just one of many interdependent systems that also include vector databases and traditional databases).\n",
-    "\n",
-    "For more background on why event streaming is a good fit for Gen AI application architecture, see Kai Waehner's article [\"Apache Kafka + Vector Database + LLM = Real-Time GenAI\"](https://www.kai-waehner.de/blog/2023/11/08/apache-kafka-flink-vector-database-llm-real-time-genai/)."
-   ]
-  }
- ],
- "metadata": {
-  "accelerator": "GPU",
-  "colab": {
-   "gpuType": "T4",
-   "provenance": []
-  },
-  "kernelspec": {
-   "display_name": "Python 3",
-   "name": "python3"
-  },
-  "language_info": {
-   "name": "python"
-  },
-  "widgets": {
-   "application/vnd.jupyter.widget-state+json": {
-    "0def954cca89466b8408fadaf3b82e64": {
-     "model_module": "@jupyter-widgets/controls",
-     "model_module_version": "1.5.0",
-     "model_name": "FloatProgressModel",
-     "state": {
-      "_dom_classes": [],
-      "_model_module": "@jupyter-widgets/controls",
-      "_model_module_version": "1.5.0",
-      "_model_name": "FloatProgressModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/controls",
-      "_view_module_version": "1.5.0",
-      "_view_name": "ProgressView",
-      "bar_style": "success",
-      "description": "",
-      "description_tooltip": null,
-      "layout": "IPY_MODEL_fb6478ce2dac489bb633b23ba0953c5c",
-      "max": 4081004224,
-      "min": 0,
-      "orientation": "horizontal",
-      "style": "IPY_MODEL_734b0f5da9fc4307a95bab48cdbb5d89",
-      "value": 4081004224
-     }
-    },
-    "30ecca964a394109ac2ad757e3aec6c0": {
-     "model_module": "@jupyter-widgets/controls",
-     "model_module_version": "1.5.0",
-     "model_name": "DescriptionStyleModel",
-     "state": {
-      "_model_module": "@jupyter-widgets/controls",
-      "_model_module_version": "1.5.0",
-      "_model_name": "DescriptionStyleModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/base",
-      "_view_module_version": "1.2.0",
-      "_view_name": "StyleView",
-      "description_width": ""
-     }
-    },
-    "462482accc664729980562e208ceb179": {
-     "model_module": "@jupyter-widgets/controls",
-     "model_module_version": "1.5.0",
-     "model_name": "HTMLModel",
-     "state": {
-      "_dom_classes": [],
-      "_model_module": "@jupyter-widgets/controls",
-      "_model_module_version": "1.5.0",
-      "_model_name": "HTMLModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/controls",
-      "_view_module_version": "1.5.0",
-      "_view_name": "HTMLView",
-      "description": "",
-      "description_tooltip": null,
-      "layout": "IPY_MODEL_b32f3a86a74741348511f4e136744ac8",
-      "placeholder": "​",
-      "style": "IPY_MODEL_e409071bff5a4e2d9bf0e9f5cc42231b",
-      "value": " 4.08G/4.08G [00:33&lt;00:00, 184MB/s]"
-     }
-    },
-    "734b0f5da9fc4307a95bab48cdbb5d89": {
-     "model_module": "@jupyter-widgets/controls",
-     "model_module_version": "1.5.0",
-     "model_name": "ProgressStyleModel",
-     "state": {
-      "_model_module": "@jupyter-widgets/controls",
-      "_model_module_version": "1.5.0",
-      "_model_name": "ProgressStyleModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/base",
-      "_view_module_version": "1.2.0",
-      "_view_name": "StyleView",
-      "bar_color": null,
-      "description_width": ""
-     }
-    },
-    "80d842f73c564dc7b7cc316c763e2633": {
-     "model_module": "@jupyter-widgets/base",
-     "model_module_version": "1.2.0",
-     "model_name": "LayoutModel",
-     "state": {
-      "_model_module": "@jupyter-widgets/base",
-      "_model_module_version": "1.2.0",
-      "_model_name": "LayoutModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/base",
-      "_view_module_version": "1.2.0",
-      "_view_name": "LayoutView",
-      "align_content": null,
-      "align_items": null,
-      "align_self": null,
-      "border": null,
-      "bottom": null,
-      "display": null,
-      "flex": null,
-      "flex_flow": null,
-      "grid_area": null,
-      "grid_auto_columns": null,
-      "grid_auto_flow": null,
-      "grid_auto_rows": null,
-      "grid_column": null,
-      "grid_gap": null,
-      "grid_row": null,
-      "grid_template_areas": null,
-      "grid_template_columns": null,
-      "grid_template_rows": null,
-      "height": null,
-      "justify_content": null,
-      "justify_items": null,
-      "left": null,
-      "margin": null,
-      "max_height": null,
-      "max_width": null,
-      "min_height": null,
-      "min_width": null,
-      "object_fit": null,
-      "object_position": null,
-      "order": null,
-      "overflow": null,
-      "overflow_x": null,
-      "overflow_y": null,
-      "padding": null,
-      "right": null,
-      "top": null,
-      "visibility": null,
-      "width": null
-     }
-    },
-    "969343cdbe604a26926679bbf8bd2dda": {
-     "model_module": "@jupyter-widgets/controls",
-     "model_module_version": "1.5.0",
-     "model_name": "HBoxModel",
-     "state": {
-      "_dom_classes": [],
-      "_model_module": "@jupyter-widgets/controls",
-      "_model_module_version": "1.5.0",
-      "_model_name": "HBoxModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/controls",
-      "_view_module_version": "1.5.0",
-      "_view_name": "HBoxView",
-      "box_style": "",
-      "children": [
-       "IPY_MODEL_d8b8370c9b514715be7618bfe6832844",
-       "IPY_MODEL_0def954cca89466b8408fadaf3b82e64",
-       "IPY_MODEL_462482accc664729980562e208ceb179"
-      ],
-      "layout": "IPY_MODEL_80d842f73c564dc7b7cc316c763e2633"
-     }
-    },
-    "b32f3a86a74741348511f4e136744ac8": {
-     "model_module": "@jupyter-widgets/base",
-     "model_module_version": "1.2.0",
-     "model_name": "LayoutModel",
-     "state": {
-      "_model_module": "@jupyter-widgets/base",
-      "_model_module_version": "1.2.0",
-      "_model_name": "LayoutModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/base",
-      "_view_module_version": "1.2.0",
-      "_view_name": "LayoutView",
-      "align_content": null,
-      "align_items": null,
-      "align_self": null,
-      "border": null,
-      "bottom": null,
-      "display": null,
-      "flex": null,
-      "flex_flow": null,
-      "grid_area": null,
-      "grid_auto_columns": null,
-      "grid_auto_flow": null,
-      "grid_auto_rows": null,
-      "grid_column": null,
-      "grid_gap": null,
-      "grid_row": null,
-      "grid_template_areas": null,
-      "grid_template_columns": null,
-      "grid_template_rows": null,
-      "height": null,
-      "justify_content": null,
-      "justify_items": null,
-      "left": null,
-      "margin": null,
-      "max_height": null,
-      "max_width": null,
-      "min_height": null,
-      "min_width": null,
-      "object_fit": null,
-      "object_position": null,
-      "order": null,
-      "overflow": null,
-      "overflow_x": null,
-      "overflow_y": null,
-      "padding": null,
-      "right": null,
-      "top": null,
-      "visibility": null,
-      "width": null
-     }
-    },
-    "d8b8370c9b514715be7618bfe6832844": {
-     "model_module": "@jupyter-widgets/controls",
-     "model_module_version": "1.5.0",
-     "model_name": "HTMLModel",
-     "state": {
-      "_dom_classes": [],
-      "_model_module": "@jupyter-widgets/controls",
-      "_model_module_version": "1.5.0",
-      "_model_name": "HTMLModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/controls",
-      "_view_module_version": "1.5.0",
-      "_view_name": "HTMLView",
-      "description": "",
-      "description_tooltip": null,
-      "layout": "IPY_MODEL_fa055d9f2a9d4a789e9cf3c89e0214e5",
-      "placeholder": "​",
-      "style": "IPY_MODEL_30ecca964a394109ac2ad757e3aec6c0",
-      "value": "llama-2-7b-chat.Q4_K_M.gguf: 100%"
-     }
-    },
-    "e409071bff5a4e2d9bf0e9f5cc42231b": {
-     "model_module": "@jupyter-widgets/controls",
-     "model_module_version": "1.5.0",
-     "model_name": "DescriptionStyleModel",
-     "state": {
-      "_model_module": "@jupyter-widgets/controls",
-      "_model_module_version": "1.5.0",
-      "_model_name": "DescriptionStyleModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/base",
-      "_view_module_version": "1.2.0",
-      "_view_name": "StyleView",
-      "description_width": ""
-     }
-    },
-    "fa055d9f2a9d4a789e9cf3c89e0214e5": {
-     "model_module": "@jupyter-widgets/base",
-     "model_module_version": "1.2.0",
-     "model_name": "LayoutModel",
-     "state": {
-      "_model_module": "@jupyter-widgets/base",
-      "_model_module_version": "1.2.0",
-      "_model_name": "LayoutModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/base",
-      "_view_module_version": "1.2.0",
-      "_view_name": "LayoutView",
-      "align_content": null,
-      "align_items": null,
-      "align_self": null,
-      "border": null,
-      "bottom": null,
-      "display": null,
-      "flex": null,
-      "flex_flow": null,
-      "grid_area": null,
-      "grid_auto_columns": null,
-      "grid_auto_flow": null,
-      "grid_auto_rows": null,
-      "grid_column": null,
-      "grid_gap": null,
-      "grid_row": null,
-      "grid_template_areas": null,
-      "grid_template_columns": null,
-      "grid_template_rows": null,
-      "height": null,
-      "justify_content": null,
-      "justify_items": null,
-      "left": null,
-      "margin": null,
-      "max_height": null,
-      "max_width": null,
-      "min_height": null,
-      "min_width": null,
-      "object_fit": null,
-      "object_position": null,
-      "order": null,
-      "overflow": null,
-      "overflow_x": null,
-      "overflow_y": null,
-      "padding": null,
-      "right": null,
-      "top": null,
-      "visibility": null,
-      "width": null
-     }
-    },
-    "fb6478ce2dac489bb633b23ba0953c5c": {
-     "model_module": "@jupyter-widgets/base",
-     "model_module_version": "1.2.0",
-     "model_name": "LayoutModel",
-     "state": {
-      "_model_module": "@jupyter-widgets/base",
-      "_model_module_version": "1.2.0",
-      "_model_name": "LayoutModel",
-      "_view_count": null,
-      "_view_module": "@jupyter-widgets/base",
-      "_view_module_version": "1.2.0",
-      "_view_name": "LayoutView",
-      "align_content": null,
-      "align_items": null,
-      "align_self": null,
-      "border": null,
-      "bottom": null,
-      "display": null,
-      "flex": null,
-      "flex_flow": null,
-      "grid_area": null,
-      "grid_auto_columns": null,
-      "grid_auto_flow": null,
-      "grid_auto_rows": null,
-      "grid_column": null,
-      "grid_gap": null,
-      "grid_row": null,
-      "grid_template_areas": null,
-      "grid_template_columns": null,
-      "grid_template_rows": null,
-      "height": null,
-      "justify_content": null,
-      "justify_items": null,
-      "left": null,
-      "margin": null,
-      "max_height": null,
-      "max_width": null,
-      "min_height": null,
-      "min_width": null,
-      "object_fit": null,
-      "object_position": null,
-      "order": null,
-      "overflow": null,
-      "overflow_x": null,
-      "overflow_y": null,
-      "padding": null,
-      "right": null,
-      "top": null,
-      "visibility": null,
-      "width": null
-     }
-    }
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 0
-}

cookbook/autogpt/autogpt.ipynb

@@ -1,212 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "14f8b67b",
-   "metadata": {},
-   "source": [
-    "# AutoGPT\n",
-    "\n",
-    "Implementation of https://github.com/Significant-Gravitas/Auto-GPT but with LangChain primitives (LLMs, PromptTemplates, VectorStores, Embeddings, Tools)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "192496a7",
-   "metadata": {},
-   "source": [
-    "## Set up tools\n",
-    "\n",
-    "We'll set up an AutoGPT with a search tool, and write-file tool, and a read-file tool"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "7c2c9b54",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import Tool\n",
-    "from langchain_community.tools.file_management.read import ReadFileTool\n",
-    "from langchain_community.tools.file_management.write import WriteFileTool\n",
-    "from langchain_community.utilities import SerpAPIWrapper\n",
-    "\n",
-    "search = SerpAPIWrapper()\n",
-    "tools = [\n",
-    "    Tool(\n",
-    "        name=\"search\",\n",
-    "        func=search.run,\n",
-    "        description=\"useful for when you need to answer questions about current events. You should ask targeted questions\",\n",
-    "    ),\n",
-    "    WriteFileTool(),\n",
-    "    ReadFileTool(),\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "8e39ee28",
-   "metadata": {},
-   "source": [
-    "## Set up memory\n",
-    "\n",
-    "The memory here is used for the agents intermediate steps"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "72bc204d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.docstore import InMemoryDocstore\n",
-    "from langchain_community.vectorstores import FAISS\n",
-    "from langchain_openai import OpenAIEmbeddings"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "1df7b724",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Define your embedding model\n",
-    "embeddings_model = OpenAIEmbeddings()\n",
-    "# Initialize the vectorstore as empty\n",
-    "import faiss\n",
-    "\n",
-    "embedding_size = 1536\n",
-    "index = faiss.IndexFlatL2(embedding_size)\n",
-    "vectorstore = FAISS(embeddings_model.embed_query, index, InMemoryDocstore({}), {})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e40fd657",
-   "metadata": {},
-   "source": [
-    "## Setup model and AutoGPT\n",
-    "\n",
-    "Initialize everything! We will use ChatOpenAI model"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "3393bc23",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_experimental.autonomous_agents import AutoGPT\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "709c08c2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = AutoGPT.from_llm_and_tools(\n",
-    "    ai_name=\"Tom\",\n",
-    "    ai_role=\"Assistant\",\n",
-    "    tools=tools,\n",
-    "    llm=ChatOpenAI(temperature=0),\n",
-    "    memory=vectorstore.as_retriever(),\n",
-    ")\n",
-    "# Set verbose to be true\n",
-    "agent.chain.verbose = True"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "f0f208d9",
-   "metadata": {
-    "collapsed": false
-   },
-   "source": [
-    "## Run an example\n",
-    "\n",
-    "Here we will make it write a weather report for SF"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d119d788",
-   "metadata": {
-    "collapsed": false
-   },
-   "outputs": [],
-   "source": [
-    "agent.run([\"write a weather report for SF today\"])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "f13f8322",
-   "metadata": {
-    "collapsed": false
-   },
-   "source": [
-    "## Chat History Memory\n",
-    "\n",
-    "In addition to the memory that holds the agent immediate steps, we also have a chat history memory. By default, the agent will use 'ChatMessageHistory' and it can be changed. This is useful when you want to use a different type of memory for example 'FileChatHistoryMemory'"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2a81f5ad",
-   "metadata": {
-    "collapsed": false
-   },
-   "outputs": [],
-   "source": [
-    "from langchain_community.chat_message_histories import FileChatMessageHistory\n",
-    "\n",
-    "agent = AutoGPT.from_llm_and_tools(\n",
-    "    ai_name=\"Tom\",\n",
-    "    ai_role=\"Assistant\",\n",
-    "    tools=tools,\n",
-    "    llm=ChatOpenAI(temperature=0),\n",
-    "    memory=vectorstore.as_retriever(),\n",
-    "    chat_history_memory=FileChatMessageHistory(\"chat_history.txt\"),\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "b1403008",
-   "metadata": {
-    "collapsed": false
-   },
-   "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
-}

cookbook/autogpt/marathon_times.ipynb

@@ -1,649 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "14f8b67b",
-   "metadata": {},
-   "source": [
-    "## AutoGPT example finding Winning Marathon Times\n",
-    "\n",
-    "* Implementation of https://github.com/Significant-Gravitas/Auto-GPT \n",
-    "* With LangChain primitives (LLMs, PromptTemplates, VectorStores, Embeddings, Tools)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "ef972313-c05a-4c49-8fd1-03e599e21033",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# !pip install bs4\n",
-    "# !pip install nest_asyncio"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "1cff42fd",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# General\n",
-    "import asyncio\n",
-    "import os\n",
-    "\n",
-    "import nest_asyncio\n",
-    "import pandas as pd\n",
-    "from langchain.docstore.document import Document\n",
-    "from langchain_experimental.agents.agent_toolkits.pandas.base import (\n",
-    "    create_pandas_dataframe_agent,\n",
-    ")\n",
-    "from langchain_experimental.autonomous_agents import AutoGPT\n",
-    "from langchain_openai import ChatOpenAI\n",
-    "\n",
-    "# Needed since jupyter runs an async eventloop\n",
-    "nest_asyncio.apply()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "01283ac7-1da0-41ba-8011-bd455d21dd82",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "llm = ChatOpenAI(model=\"gpt-4\", temperature=1.0)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "192496a7",
-   "metadata": {},
-   "source": [
-    "### Set up tools\n",
-    "\n",
-    "* We'll set up an AutoGPT with a `search` tool, and `write-file` tool, and a `read-file` tool, a web browsing tool, and a tool to interact with a CSV file via a python REPL"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "708a426f",
-   "metadata": {},
-   "source": [
-    "Define any other `tools` you want to use below:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "cef4c150-0ef1-4a33-836b-01062fec134e",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# Tools\n",
-    "import os\n",
-    "from contextlib import contextmanager\n",
-    "from typing import Optional\n",
-    "\n",
-    "from langchain.agents import tool\n",
-    "from langchain_community.tools.file_management.read import ReadFileTool\n",
-    "from langchain_community.tools.file_management.write import WriteFileTool\n",
-    "\n",
-    "ROOT_DIR = \"./data/\"\n",
-    "\n",
-    "\n",
-    "@contextmanager\n",
-    "def pushd(new_dir):\n",
-    "    \"\"\"Context manager for changing the current working directory.\"\"\"\n",
-    "    prev_dir = os.getcwd()\n",
-    "    os.chdir(new_dir)\n",
-    "    try:\n",
-    "        yield\n",
-    "    finally:\n",
-    "        os.chdir(prev_dir)\n",
-    "\n",
-    "\n",
-    "@tool\n",
-    "def process_csv(\n",
-    "    csv_file_path: str, instructions: str, output_path: Optional[str] = None\n",
-    ") -> str:\n",
-    "    \"\"\"Process a CSV by with pandas in a limited REPL.\\\n",
-    " Only use this after writing data to disk as a csv file.\\\n",
-    " Any figures must be saved to disk to be viewed by the human.\\\n",
-    " Instructions should be written in natural language, not code. Assume the dataframe is already loaded.\"\"\"\n",
-    "    with pushd(ROOT_DIR):\n",
-    "        try:\n",
-    "            df = pd.read_csv(csv_file_path)\n",
-    "        except Exception as e:\n",
-    "            return f\"Error: {e}\"\n",
-    "        agent = create_pandas_dataframe_agent(llm, df, max_iterations=30, verbose=True)\n",
-    "        if output_path is not None:\n",
-    "            instructions += f\" Save output to disk at {output_path}\"\n",
-    "        try:\n",
-    "            result = agent.run(instructions)\n",
-    "            return result\n",
-    "        except Exception as e:\n",
-    "            return f\"Error: {e}\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "69975008-654a-4cbb-bdf6-63c8bae07eaa",
-   "metadata": {
-    "tags": []
-   },
-   "source": [
-    "**Browse a web page with PlayWright**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "6bb5e47b-0f54-4faa-ae42-49a28fa5497b",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# !pip install playwright\n",
-    "# !playwright install"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "26b497d7-8e52-4c7f-8e7e-da0a48820a3c",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "async def async_load_playwright(url: str) -> str:\n",
-    "    \"\"\"Load the specified URLs using Playwright and parse using BeautifulSoup.\"\"\"\n",
-    "    from bs4 import BeautifulSoup\n",
-    "    from playwright.async_api import async_playwright\n",
-    "\n",
-    "    results = \"\"\n",
-    "    async with async_playwright() as p:\n",
-    "        browser = await p.chromium.launch(headless=True)\n",
-    "        try:\n",
-    "            page = await browser.new_page()\n",
-    "            await page.goto(url)\n",
-    "\n",
-    "            page_source = await page.content()\n",
-    "            soup = BeautifulSoup(page_source, \"html.parser\")\n",
-    "\n",
-    "            for script in soup([\"script\", \"style\"]):\n",
-    "                script.extract()\n",
-    "\n",
-    "            text = soup.get_text()\n",
-    "            lines = (line.strip() for line in text.splitlines())\n",
-    "            chunks = (phrase.strip() for line in lines for phrase in line.split(\"  \"))\n",
-    "            results = \"\\n\".join(chunk for chunk in chunks if chunk)\n",
-    "        except Exception as e:\n",
-    "            results = f\"Error: {e}\"\n",
-    "        await browser.close()\n",
-    "    return results\n",
-    "\n",
-    "\n",
-    "def run_async(coro):\n",
-    "    event_loop = asyncio.get_event_loop()\n",
-    "    return event_loop.run_until_complete(coro)\n",
-    "\n",
-    "\n",
-    "@tool\n",
-    "def browse_web_page(url: str) -> str:\n",
-    "    \"\"\"Verbose way to scrape a whole webpage. Likely to cause issues parsing.\"\"\"\n",
-    "    return run_async(async_load_playwright(url))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "5ea71762-67ca-4e75-8c4d-00563064be71",
-   "metadata": {},
-   "source": [
-    "**Q&A Over a webpage**\n",
-    "\n",
-    "Help the model ask more directed questions of web pages to avoid cluttering its memory"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "1842929d-f18d-4edc-9fdd-82c929181141",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "from langchain.chains.qa_with_sources.loading import (\n",
-    "    BaseCombineDocumentsChain,\n",
-    "    load_qa_with_sources_chain,\n",
-    ")\n",
-    "from langchain.tools import BaseTool, DuckDuckGoSearchRun\n",
-    "from langchain_text_splitters import RecursiveCharacterTextSplitter\n",
-    "from pydantic import Field\n",
-    "\n",
-    "\n",
-    "def _get_text_splitter():\n",
-    "    return RecursiveCharacterTextSplitter(\n",
-    "        # Set a really small chunk size, just to show.\n",
-    "        chunk_size=500,\n",
-    "        chunk_overlap=20,\n",
-    "        length_function=len,\n",
-    "    )\n",
-    "\n",
-    "\n",
-    "class WebpageQATool(BaseTool):\n",
-    "    name = \"query_webpage\"\n",
-    "    description = (\n",
-    "        \"Browse a webpage and retrieve the information relevant to the question.\"\n",
-    "    )\n",
-    "    text_splitter: RecursiveCharacterTextSplitter = Field(\n",
-    "        default_factory=_get_text_splitter\n",
-    "    )\n",
-    "    qa_chain: BaseCombineDocumentsChain\n",
-    "\n",
-    "    def _run(self, url: str, question: str) -> str:\n",
-    "        \"\"\"Useful for browsing websites and scraping the text information.\"\"\"\n",
-    "        result = browse_web_page.run(url)\n",
-    "        docs = [Document(page_content=result, metadata={\"source\": url})]\n",
-    "        web_docs = self.text_splitter.split_documents(docs)\n",
-    "        results = []\n",
-    "        # TODO: Handle this with a MapReduceChain\n",
-    "        for i in range(0, len(web_docs), 4):\n",
-    "            input_docs = web_docs[i : i + 4]\n",
-    "            window_result = self.qa_chain(\n",
-    "                {\"input_documents\": input_docs, \"question\": question},\n",
-    "                return_only_outputs=True,\n",
-    "            )\n",
-    "            results.append(f\"Response from window {i} - {window_result}\")\n",
-    "        results_docs = [\n",
-    "            Document(page_content=\"\\n\".join(results), metadata={\"source\": url})\n",
-    "        ]\n",
-    "        return self.qa_chain(\n",
-    "            {\"input_documents\": results_docs, \"question\": question},\n",
-    "            return_only_outputs=True,\n",
-    "        )\n",
-    "\n",
-    "    async def _arun(self, url: str, question: str) -> str:\n",
-    "        raise NotImplementedError"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "e6f72bd0",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "query_website_tool = WebpageQATool(qa_chain=load_qa_with_sources_chain(llm))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "8e39ee28",
-   "metadata": {},
-   "source": [
-    "### Set up memory\n",
-    "\n",
-    "* The memory here is used for the agents intermediate steps"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "1df7b724",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# Memory\n",
-    "import faiss\n",
-    "from langchain.docstore import InMemoryDocstore\n",
-    "from langchain_community.vectorstores import FAISS\n",
-    "from langchain_openai import OpenAIEmbeddings\n",
-    "\n",
-    "embeddings_model = OpenAIEmbeddings()\n",
-    "embedding_size = 1536\n",
-    "index = faiss.IndexFlatL2(embedding_size)\n",
-    "vectorstore = FAISS(embeddings_model.embed_query, index, InMemoryDocstore({}), {})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e40fd657",
-   "metadata": {},
-   "source": [
-    "### Setup model and AutoGPT\n",
-    "\n",
-    "`Model set-up`"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "1233caf3-fbc9-4acb-9faa-01008200633d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# !pip install duckduckgo_search\n",
-    "web_search = DuckDuckGoSearchRun()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "88c8b184-67d7-4c35-84ae-9b14bef8c4e3",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "tools = [\n",
-    "    web_search,\n",
-    "    WriteFileTool(root_dir=\"./data\"),\n",
-    "    ReadFileTool(root_dir=\"./data\"),\n",
-    "    process_csv,\n",
-    "    query_website_tool,\n",
-    "    # HumanInputRun(), # Activate if you want the permit asking for help from the human\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "709c08c2",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "agent = AutoGPT.from_llm_and_tools(\n",
-    "    ai_name=\"Tom\",\n",
-    "    ai_role=\"Assistant\",\n",
-    "    tools=tools,\n",
-    "    llm=llm,\n",
-    "    memory=vectorstore.as_retriever(search_kwargs={\"k\": 8}),\n",
-    "    # human_in_the_loop=True, # Set to True if you want to add feedback at each step.\n",
-    ")\n",
-    "# agent.chain.verbose = True"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fc9b51ba",
-   "metadata": {},
-   "source": [
-    "### AutoGPT for Querying the Web\n",
-    " \n",
-    "  \n",
-    "I've spent a lot of time over the years crawling data sources and cleaning data. Let's see if AutoGPT can help with this!\n",
-    "\n",
-    "Here is the prompt for looking up recent boston marathon times and converting them to tabular form."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "64455d70-a134-4d11-826a-33e34c2ce287",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "{\n",
-      "    \"thoughts\": {\n",
-      "        \"text\": \"I need to find the winning Boston Marathon times for the past 5 years. I can use the DuckDuckGo Search command to search for this information.\",\n",
-      "        \"reasoning\": \"Using DuckDuckGo Search will help me gather information on the winning times without complications.\",\n",
-      "        \"plan\": \"- Use DuckDuckGo Search to find the winning Boston Marathon times\\n- Generate a table with the year, name, country of origin, and times\\n- Ensure there are no legal complications\",\n",
-      "        \"criticism\": \"None\",\n",
-      "        \"speak\": \"I will use the DuckDuckGo Search command to find the winning Boston Marathon times for the past 5 years.\"\n",
-      "    },\n",
-      "    \"command\": {\n",
-      "        \"name\": \"DuckDuckGo Search\",\n",
-      "        \"args\": {\n",
-      "            \"query\": \"winning Boston Marathon times for the past 5 years ending in 2022\"\n",
-      "        }\n",
-      "    }\n",
-      "}\n",
-      "{\n",
-      "    \"thoughts\": {\n",
-      "        \"text\": \"The DuckDuckGo Search command did not provide the specific information I need. I must switch my approach and use query_webpage command to browse a webpage containing the Boston Marathon winning times for the past 5 years.\",\n",
-      "        \"reasoning\": \"The query_webpage command may give me more accurate and comprehensive results compared to the search command.\",\n",
-      "        \"plan\": \"- Use query_webpage command to find the winning Boston Marathon times\\n- Generate a table with the year, name, country of origin, and times\\n- Ensure there are no legal complications\",\n",
-      "        \"criticism\": \"I may face difficulty in finding the right webpage with the desired information.\",\n",
-      "        \"speak\": \"I will use the query_webpage command to find the winning Boston Marathon times for the past 5 years.\"\n",
-      "    },\n",
-      "    \"command\": {\n",
-      "        \"name\": \"DuckDuckGo Search\",\n",
-      "        \"args\": {\n",
-      "            \"query\": \"site with winning Boston Marathon times for the past 5 years ending in 2022\"\n",
-      "        }\n",
-      "    }\n",
-      "}\n",
-      "{\n",
-      "    \"thoughts\": {\n",
-      "        \"text\": \"I need to use the query_webpage command to find the information about the winning Boston Marathon times for the past 5 years.\",\n",
-      "        \"reasoning\": \"The previous DuckDuckGo Search command did not provide specific enough results. The query_webpage command might give more accurate and comprehensive results.\",\n",
-      "        \"plan\": \"- Use query_webpage command to find the winning Boston Marathon times\\\\n- Generate a table with the year, name, country of origin, and times\\\\n- Ensure there are no legal complications\",\n",
-      "        \"criticism\": \"I may face difficulty in finding the right webpage with the desired information.\",\n",
-      "        \"speak\": \"I will use the query_webpage command to find the winning Boston Marathon times for the past 5 years.\"\n",
-      "    },\n",
-      "    \"command\": {\n",
-      "        \"name\": \"query_webpage\",\n",
-      "        \"args\": {\n",
-      "            \"url\": \"https://en.wikipedia.org/wiki/List_of_winners_of_the_Boston_Marathon\",\n",
-      "            \"question\": \"What were the winning Boston Marathon times for the past 5 years ending in 2022?\"\n",
-      "        }\n",
-      "    }\n",
-      "}\n",
-      "{\n",
-      "    \"thoughts\": {\n",
-      "        \"text\": \"I have already found the winning Boston Marathon times for the past 5 years. Now, I need to generate a table with the information.\",\n",
-      "        \"reasoning\": \"Using the information I already have, I can create a table containing year, name, country of origin, and times.\",\n",
-      "        \"plan\": \"- Write the marathon data to a CSV file\\n- Process the CSV file to display the table\",\n",
-      "        \"criticism\": \"None\",\n",
-      "        \"speak\": \"I will generate a table with the year, name, country of origin, and times for the winning Boston Marathon times for the past 5 years.\"\n",
-      "    },\n",
-      "    \"command\": {\n",
-      "        \"name\": \"write_file\",\n",
-      "        \"args\": {\n",
-      "            \"file_path\": \"boston_marathon_winners.csv\",\n",
-      "            \"text\": \"Year,Name,Country,Time\\n2022,Evans Chebet,KEN,2:06:51\\n2021,Benson Kipruto,KEN,2:09:51\\n2019,Lawrence Cherono,KEN,2:07:57\\n2018,Yuki Kawauchi,JPN,2:15:58\"\n",
-      "        }\n",
-      "    }\n",
-      "}\n",
-      "{\n",
-      "    \"thoughts\": {\n",
-      "        \"text\": \"I have retrieved the winning Boston Marathon times for the past 5 years. Now, I need to generate a table with the year, name, country of origin, and times.\",\n",
-      "        \"reasoning\": \"Creating a table will help organize the data in a clear and accessible format.\",\n",
-      "        \"plan\": \"- Write the data to a CSV file\\n- Process the CSV file to generate the table\\n- Complete the task\",\n",
-      "        \"criticism\": \"None\",\n",
-      "        \"speak\": \"I will generate a table with the year, name, country of origin, and winning times using the recently retrieved data.\"\n",
-      "    },\n",
-      "    \"command\": {\n",
-      "        \"name\": \"write_file\",\n",
-      "        \"args\": {\n",
-      "            \"file_path\": \"winning_boston_marathon_data.csv\",\n",
-      "            \"text\": \"Year,Name,Country,Time\\n2022,Evans Chebet,KEN,2:06:51\\n2021,Benson Kipruto,KEN,2:09:51\\n2019,Lawrence Cherono,KEN,2:07:57\\n2018,Yuki Kawauchi,JPN,2:15:58\\n\"\n",
-      "        }\n",
-      "    }\n",
-      "}\n",
-      "{\n",
-      "    \"thoughts\": {\n",
-      "        \"text\": \"I have found the winning Boston Marathon times for the past five years ending in 2022. Next, I need to create a table with the year, name, country of origin, and times.\",\n",
-      "        \"reasoning\": \"Generating a table will help organize the information in a structured format.\",\n",
-      "        \"plan\": \"- Create a table with the year, name, country of origin, and times\\n- Ensure there are no legal complications\",\n",
-      "        \"criticism\": \"None\",\n",
-      "        \"speak\": \"I will generate a table with the winning Boston Marathon times for the past 5 years ending in 2022.\"\n",
-      "    },\n",
-      "    \"command\": {\n",
-      "        \"name\": \"write_file\",\n",
-      "        \"args\": {\n",
-      "            \"file_path\": \"winning_times.csv\",\n",
-      "            \"text\": \"Year,Name,Country,Time\\n2022,Evans Chebet,Kenya,2:06:51\\n2021,Benson Kipruto,Kenya,2:09:51\\n2020,Canceled due to COVID-19 pandemic,,\\n2019,Lawrence Cherono,Kenya,2:07:57\\n2018,Yuki Kawauchi,Japan,2:15:58\"\n",
-      "        }\n",
-      "    }\n",
-      "}\n",
-      "{\n",
-      "    \"thoughts\": {\n",
-      "        \"text\": \"I need to process the CSV file to generate the table with the year, name, country of origin, and winning times.\",\n",
-      "        \"reasoning\": \"I have already written the data to a file named 'winning_times.csv'. Now, I need to process this CSV file to properly display the data as a table.\",\n",
-      "        \"plan\": \"- Use the process_csv command to read the 'winning_times.csv' file and generate the table\",\n",
-      "        \"criticism\": \"None\",\n",
-      "        \"speak\": \"I will process the 'winning_times.csv' file to display the table with the winning Boston Marathon times for the past 5 years.\"\n",
-      "    },\n",
-      "    \"command\": {\n",
-      "        \"name\": \"process_csv\",\n",
-      "        \"args\": {\n",
-      "            \"csv_file_path\": \"winning_times.csv\",\n",
-      "            \"instructions\": \"Read the CSV file and display the data as a table\"\n",
-      "        }\n",
-      "    }\n",
-      "}\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: The CSV file has already been read and saved into a pandas dataframe called `df`. Hence, I can simply display the data by printing the whole dataframe. Since `df.head()` returns the first 5 rows, I can use that to showcase the contents.\n",
-      "\n",
-      "Action: python_repl_ast\n",
-      "Action Input: print(df.head())\u001b[0m   Year                               Name Country     Time\n",
-      "0  2022                       Evans Chebet   Kenya  2:06:51\n",
-      "1  2021                     Benson Kipruto   Kenya  2:09:51\n",
-      "2  2020  Canceled due to COVID-19 pandemic     NaN      NaN\n",
-      "3  2019                   Lawrence Cherono   Kenya  2:07:57\n",
-      "4  2018                      Yuki Kawauchi   Japan  2:15:58\n",
-      "\n",
-      "Observation: \u001b[36;1m\u001b[1;3mNone\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3mI used the wrong tool to perform the action. I should have used the given data and not interacted with the Python shell. I can now provide the displayed data as the answer since the information in the printed dataframe would look like a table when typed as text.\n",
-      "\n",
-      "Final Answer: \n",
-      "   Year                               Name Country     Time\n",
-      "0  2022                       Evans Chebet   Kenya  2:06:51\n",
-      "1  2021                     Benson Kipruto   Kenya  2:09:51\n",
-      "2  2020  Canceled due to COVID-19 pandemic     NaN      NaN\n",
-      "3  2019                   Lawrence Cherono   Kenya  2:07:57\n",
-      "4  2018                      Yuki Kawauchi   Japan  2:15:58\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "{\n",
-      "    \"thoughts\": {\n",
-      "        \"text\": \"I already have the winning Boston Marathon times for the past 5 years saved in the file 'winning_times.csv'. Now, I need to process the CSV and display the table.\",\n",
-      "        \"reasoning\": \"I am choosing the process_csv command because I already have the required data saved as a CSV file, and I can use this command to read and display the data as a table.\",\n",
-      "        \"plan\": \"- Use the process_csv command to read the 'winning_times.csv' file and generate the table\",\n",
-      "        \"criticism\": \"None\",\n",
-      "        \"speak\": \"I will process the 'winning_times.csv' file to display the table with the winning Boston Marathon times for the past 5 years.\"\n",
-      "    },\n",
-      "    \"command\": {\n",
-      "        \"name\": \"process_csv\",\n",
-      "        \"args\": {\n",
-      "            \"csv_file_path\": \"winning_times.csv\",\n",
-      "            \"instructions\": \"Read the CSV file and display the data as a table\"\n",
-      "        }\n",
-      "    }\n",
-      "}\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: Since the data is already loaded in a pandas dataframe, I just need to display the top rows of the dataframe.\n",
-      "Action: python_repl_ast\n",
-      "Action Input: df.head()\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3m   Year                               Name Country     Time\n",
-      "0  2022                       Evans Chebet   Kenya  2:06:51\n",
-      "1  2021                     Benson Kipruto   Kenya  2:09:51\n",
-      "2  2020  Canceled due to COVID-19 pandemic     NaN      NaN\n",
-      "3  2019                   Lawrence Cherono   Kenya  2:07:57\n",
-      "4  2018                      Yuki Kawauchi   Japan  2:15:58\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3mI now know the final answer.\n",
-      "Final Answer: \n",
-      "   Year                               Name Country     Time\n",
-      "0  2022                       Evans Chebet   Kenya  2:06:51\n",
-      "1  2021                     Benson Kipruto   Kenya  2:09:51\n",
-      "2  2020  Canceled due to COVID-19 pandemic     NaN      NaN\n",
-      "3  2019                   Lawrence Cherono   Kenya  2:07:57\n",
-      "4  2018                      Yuki Kawauchi   Japan  2:15:58\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "{\n",
-      "    \"thoughts\": {\n",
-      "        \"text\": \"I have already generated a table with the winning Boston Marathon times for the past 5 years. Now, I can finish the task.\",\n",
-      "        \"reasoning\": \"I have completed the required actions and obtained the desired data. The task is complete.\",\n",
-      "        \"plan\": \"- Use the finish command\",\n",
-      "        \"criticism\": \"None\",\n",
-      "        \"speak\": \"I have generated the table with the winning Boston Marathon times for the past 5 years. Task complete.\"\n",
-      "    },\n",
-      "    \"command\": {\n",
-      "        \"name\": \"finish\",\n",
-      "        \"args\": {\n",
-      "            \"response\": \"I have generated the table with the winning Boston Marathon times for the past 5 years. Task complete.\"\n",
-      "        }\n",
-      "    }\n",
-      "}\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'I have generated the table with the winning Boston Marathon times for the past 5 years. Task complete.'"
-      ]
-     },
-     "execution_count": 13,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\n",
-    "    [\n",
-    "        \"What were the winning boston marathon times for the past 5 years (ending in 2022)? Generate a table of the year, name, country of origin, and times.\"\n",
-    "    ]\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "a6b4f96e",
-   "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.16"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/baby_agi.ipynb

@@ -1,250 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "517a9fd4",
-   "metadata": {},
-   "source": [
-    "# BabyAGI User Guide\n",
-    "\n",
-    "This notebook demonstrates how to implement [BabyAGI](https://github.com/yoheinakajima/babyagi/tree/main) by [Yohei Nakajima](https://twitter.com/yoheinakajima). BabyAGI is an AI agent that can generate and pretend to execute tasks based on a given objective.\n",
-    "\n",
-    "This guide will help you understand the components to create your own recursive agents.\n",
-    "\n",
-    "Although BabyAGI uses specific vectorstores/model providers (Pinecone, OpenAI), one of the benefits of implementing it with LangChain is that you can easily swap those out for different options. In this implementation we use a FAISS vectorstore (because it runs locally and is free)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "556af556",
-   "metadata": {},
-   "source": [
-    "## Install and Import Required Modules"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "c8a354b6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Optional\n",
-    "\n",
-    "from langchain_experimental.autonomous_agents import BabyAGI\n",
-    "from langchain_openai import OpenAI, OpenAIEmbeddings"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "09f70772",
-   "metadata": {},
-   "source": [
-    "## Connect to the Vector Store\n",
-    "\n",
-    "Depending on what vectorstore you use, this step may look different."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "794045d4",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.docstore import InMemoryDocstore\n",
-    "from langchain_community.vectorstores import FAISS"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "6e0305eb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Define your embedding model\n",
-    "embeddings_model = OpenAIEmbeddings()\n",
-    "# Initialize the vectorstore as empty\n",
-    "import faiss\n",
-    "\n",
-    "embedding_size = 1536\n",
-    "index = faiss.IndexFlatL2(embedding_size)\n",
-    "vectorstore = FAISS(embeddings_model.embed_query, index, InMemoryDocstore({}), {})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "05ba762e",
-   "metadata": {},
-   "source": [
-    "### Run the BabyAGI\n",
-    "\n",
-    "Now it's time to create the BabyAGI controller and watch it try to accomplish your objective."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "3d220b69",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "OBJECTIVE = \"Write a weather report for SF today\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "8a8e5543",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "3d69899b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Logging of LLMChains\n",
-    "verbose = False\n",
-    "# If None, will keep on going forever\n",
-    "max_iterations: Optional[int] = 3\n",
-    "baby_agi = BabyAGI.from_llm(\n",
-    "    llm=llm, vectorstore=vectorstore, verbose=verbose, max_iterations=max_iterations\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "f7957b51",
-   "metadata": {
-    "scrolled": false
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\u001b[95m\u001b[1m\n",
-      "*****TASK LIST*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "1: Make a todo list\n",
-      "\u001b[92m\u001b[1m\n",
-      "*****NEXT TASK*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "1: Make a todo list\n",
-      "\u001b[93m\u001b[1m\n",
-      "*****TASK RESULT*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "\n",
-      "\n",
-      "1. Check the weather forecast for San Francisco today\n",
-      "2. Make note of the temperature, humidity, wind speed, and other relevant weather conditions\n",
-      "3. Write a weather report summarizing the forecast\n",
-      "4. Check for any weather alerts or warnings\n",
-      "5. Share the report with the relevant stakeholders\n",
-      "\u001b[95m\u001b[1m\n",
-      "*****TASK LIST*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "2: Check the current temperature in San Francisco\n",
-      "3: Check the current humidity in San Francisco\n",
-      "4: Check the current wind speed in San Francisco\n",
-      "5: Check for any weather alerts or warnings in San Francisco\n",
-      "6: Check the forecast for the next 24 hours in San Francisco\n",
-      "7: Check the forecast for the next 48 hours in San Francisco\n",
-      "8: Check the forecast for the next 72 hours in San Francisco\n",
-      "9: Check the forecast for the next week in San Francisco\n",
-      "10: Check the forecast for the next month in San Francisco\n",
-      "11: Check the forecast for the next 3 months in San Francisco\n",
-      "1: Write a weather report for SF today\n",
-      "\u001b[92m\u001b[1m\n",
-      "*****NEXT TASK*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "2: Check the current temperature in San Francisco\n",
-      "\u001b[93m\u001b[1m\n",
-      "*****TASK RESULT*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "\n",
-      "\n",
-      "I will check the current temperature in San Francisco. I will use an online weather service to get the most up-to-date information.\n",
-      "\u001b[95m\u001b[1m\n",
-      "*****TASK LIST*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "3: Check the current UV index in San Francisco.\n",
-      "4: Check the current air quality in San Francisco.\n",
-      "5: Check the current precipitation levels in San Francisco.\n",
-      "6: Check the current cloud cover in San Francisco.\n",
-      "7: Check the current barometric pressure in San Francisco.\n",
-      "8: Check the current dew point in San Francisco.\n",
-      "9: Check the current wind direction in San Francisco.\n",
-      "10: Check the current humidity levels in San Francisco.\n",
-      "1: Check the current temperature in San Francisco to the average temperature for this time of year.\n",
-      "2: Check the current visibility in San Francisco.\n",
-      "11: Write a weather report for SF today.\n",
-      "\u001b[92m\u001b[1m\n",
-      "*****NEXT TASK*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "3: Check the current UV index in San Francisco.\n",
-      "\u001b[93m\u001b[1m\n",
-      "*****TASK RESULT*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "\n",
-      "\n",
-      "The current UV index in San Francisco is moderate. The UV index is expected to remain at moderate levels throughout the day. It is recommended to wear sunscreen and protective clothing when outdoors.\n",
-      "\u001b[91m\u001b[1m\n",
-      "*****TASK ENDING*****\n",
-      "\u001b[0m\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "{'objective': 'Write a weather report for SF today'}"
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "baby_agi({\"objective\": OBJECTIVE})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "898a210b",
-   "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.16"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/baby_agi_with_agent.ipynb

@@ -1,388 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "517a9fd4",
-   "metadata": {},
-   "source": [
-    "# BabyAGI with Tools\n",
-    "\n",
-    "This notebook builds on top of [baby agi](baby_agi.html), but shows how you can swap out the execution chain. The previous execution chain was just an LLM which made stuff up. By swapping it out with an agent that has access to tools, we can hopefully get real reliable information"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "556af556",
-   "metadata": {},
-   "source": [
-    "## Install and Import Required Modules"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "c8a354b6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Optional\n",
-    "\n",
-    "from langchain.chains import LLMChain\n",
-    "from langchain.prompts import PromptTemplate\n",
-    "from langchain_experimental.autonomous_agents import BabyAGI\n",
-    "from langchain_openai import OpenAI, OpenAIEmbeddings"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "09f70772",
-   "metadata": {},
-   "source": [
-    "## Connect to the Vector Store\n",
-    "\n",
-    "Depending on what vectorstore you use, this step may look different."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "794045d4",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Note: you may need to restart the kernel to use updated packages.\n",
-      "Note: you may need to restart the kernel to use updated packages.\n"
-     ]
-    }
-   ],
-   "source": [
-    "%pip install faiss-cpu > /dev/null\n",
-    "%pip install google-search-results > /dev/null\n",
-    "from langchain.docstore import InMemoryDocstore\n",
-    "from langchain_community.vectorstores import FAISS"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "6e0305eb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Define your embedding model\n",
-    "embeddings_model = OpenAIEmbeddings()\n",
-    "# Initialize the vectorstore as empty\n",
-    "import faiss\n",
-    "\n",
-    "embedding_size = 1536\n",
-    "index = faiss.IndexFlatL2(embedding_size)\n",
-    "vectorstore = FAISS(embeddings_model.embed_query, index, InMemoryDocstore({}), {})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "0f3b72bf",
-   "metadata": {},
-   "source": [
-    "## Define the Chains\n",
-    "\n",
-    "BabyAGI relies on three LLM chains:\n",
-    "- Task creation chain to select new tasks to add to the list\n",
-    "- Task prioritization chain to re-prioritize tasks\n",
-    "- Execution Chain to execute the tasks\n",
-    "\n",
-    "\n",
-    "NOTE: in this notebook, the Execution chain will now be an agent."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "b43cd580",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import AgentExecutor, Tool, ZeroShotAgent\n",
-    "from langchain.chains import LLMChain\n",
-    "from langchain_community.utilities import SerpAPIWrapper\n",
-    "from langchain_openai import OpenAI\n",
-    "\n",
-    "todo_prompt = PromptTemplate.from_template(\n",
-    "    \"You are a planner who is an expert at coming up with a todo list for a given objective. Come up with a todo list for this objective: {objective}\"\n",
-    ")\n",
-    "todo_chain = LLMChain(llm=OpenAI(temperature=0), prompt=todo_prompt)\n",
-    "search = SerpAPIWrapper()\n",
-    "tools = [\n",
-    "    Tool(\n",
-    "        name=\"Search\",\n",
-    "        func=search.run,\n",
-    "        description=\"useful for when you need to answer questions about current events\",\n",
-    "    ),\n",
-    "    Tool(\n",
-    "        name=\"TODO\",\n",
-    "        func=todo_chain.run,\n",
-    "        description=\"useful for when you need to come up with todo lists. Input: an objective to create a todo list for. Output: a todo list for that objective. Please be very clear what the objective is!\",\n",
-    "    ),\n",
-    "]\n",
-    "\n",
-    "\n",
-    "prefix = \"\"\"You are an AI who performs one task based on the following objective: {objective}. Take into account these previously completed tasks: {context}.\"\"\"\n",
-    "suffix = \"\"\"Question: {task}\n",
-    "{agent_scratchpad}\"\"\"\n",
-    "prompt = ZeroShotAgent.create_prompt(\n",
-    "    tools,\n",
-    "    prefix=prefix,\n",
-    "    suffix=suffix,\n",
-    "    input_variables=[\"objective\", \"task\", \"context\", \"agent_scratchpad\"],\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "4b00ae2e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)\n",
-    "llm_chain = LLMChain(llm=llm, prompt=prompt)\n",
-    "tool_names = [tool.name for tool in tools]\n",
-    "agent = ZeroShotAgent(llm_chain=llm_chain, allowed_tools=tool_names)\n",
-    "agent_executor = AgentExecutor.from_agent_and_tools(\n",
-    "    agent=agent, tools=tools, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "05ba762e",
-   "metadata": {},
-   "source": [
-    "### Run the BabyAGI\n",
-    "\n",
-    "Now it's time to create the BabyAGI controller and watch it try to accomplish your objective."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "3d220b69",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "OBJECTIVE = \"Write a weather report for SF today\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "3d69899b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Logging of LLMChains\n",
-    "verbose = False\n",
-    "# If None, will keep on going forever\n",
-    "max_iterations: Optional[int] = 3\n",
-    "baby_agi = BabyAGI.from_llm(\n",
-    "    llm=llm,\n",
-    "    vectorstore=vectorstore,\n",
-    "    task_execution_chain=agent_executor,\n",
-    "    verbose=verbose,\n",
-    "    max_iterations=max_iterations,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "f7957b51",
-   "metadata": {
-    "scrolled": false
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\u001b[95m\u001b[1m\n",
-      "*****TASK LIST*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "1: Make a todo list\n",
-      "\u001b[92m\u001b[1m\n",
-      "*****NEXT TASK*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "1: Make a todo list\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: I need to come up with a todo list\n",
-      "Action: TODO\n",
-      "Action Input: Write a weather report for SF today\u001b[0m\u001b[33;1m\u001b[1;3m\n",
-      "\n",
-      "1. Research current weather conditions in San Francisco\n",
-      "2. Gather data on temperature, humidity, wind speed, and other relevant weather conditions\n",
-      "3. Analyze data to determine current weather trends\n",
-      "4. Write a brief introduction to the weather report\n",
-      "5. Describe current weather conditions in San Francisco\n",
-      "6. Discuss any upcoming weather changes\n",
-      "7. Summarize the weather report\n",
-      "8. Proofread and edit the report\n",
-      "9. Submit the report\u001b[0m\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: The todo list for writing a weather report for SF today is: 1. Research current weather conditions in San Francisco; 2. Gather data on temperature, humidity, wind speed, and other relevant weather conditions; 3. Analyze data to determine current weather trends; 4. Write a brief introduction to the weather report; 5. Describe current weather conditions in San Francisco; 6. Discuss any upcoming weather changes; 7. Summarize the weather report; 8. Proofread and edit the report; 9. Submit the report.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\u001b[93m\u001b[1m\n",
-      "*****TASK RESULT*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "The todo list for writing a weather report for SF today is: 1. Research current weather conditions in San Francisco; 2. Gather data on temperature, humidity, wind speed, and other relevant weather conditions; 3. Analyze data to determine current weather trends; 4. Write a brief introduction to the weather report; 5. Describe current weather conditions in San Francisco; 6. Discuss any upcoming weather changes; 7. Summarize the weather report; 8. Proofread and edit the report; 9. Submit the report.\n",
-      "\u001b[95m\u001b[1m\n",
-      "*****TASK LIST*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "2: Gather data on precipitation, cloud cover, and other relevant weather conditions;\n",
-      "3: Analyze data to determine any upcoming weather changes;\n",
-      "4: Research current weather forecasts for San Francisco;\n",
-      "5: Create a visual representation of the weather report;\n",
-      "6: Include relevant images and graphics in the report;\n",
-      "7: Format the report for readability;\n",
-      "8: Publish the report online;\n",
-      "9: Monitor the report for accuracy.\n",
-      "\u001b[92m\u001b[1m\n",
-      "*****NEXT TASK*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "2: Gather data on precipitation, cloud cover, and other relevant weather conditions;\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: I need to search for current weather conditions in San Francisco\n",
-      "Action: Search\n",
-      "Action Input: Current weather conditions in San Francisco\u001b[0m\u001b[36;1m\u001b[1;3mCurrent Weather for Popular Cities ; San Francisco, CA 46 · Partly Cloudy ; Manhattan, NY warning 52 · Cloudy ; Schiller Park, IL (60176) 40 · Sunny ; Boston, MA 54 ...\u001b[0m\u001b[32;1m\u001b[1;3m I need to compile the data into a weather report\n",
-      "Action: TODO\n",
-      "Action Input: Compile data into a weather report\u001b[0m\u001b[33;1m\u001b[1;3m\n",
-      "\n",
-      "1. Gather data from reliable sources such as the National Weather Service, local weather stations, and other meteorological organizations.\n",
-      "\n",
-      "2. Analyze the data to identify trends and patterns.\n",
-      "\n",
-      "3. Create a chart or graph to visualize the data.\n",
-      "\n",
-      "4. Write a summary of the data and its implications.\n",
-      "\n",
-      "5. Compile the data into a report format.\n",
-      "\n",
-      "6. Proofread the report for accuracy and clarity.\n",
-      "\n",
-      "7. Publish the report to a website or other platform.\n",
-      "\n",
-      "8. Distribute the report to relevant stakeholders.\u001b[0m\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: Today in San Francisco, the temperature is 46 degrees Fahrenheit with partly cloudy skies. The forecast for the rest of the day is expected to remain partly cloudy.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\u001b[93m\u001b[1m\n",
-      "*****TASK RESULT*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "Today in San Francisco, the temperature is 46 degrees Fahrenheit with partly cloudy skies. The forecast for the rest of the day is expected to remain partly cloudy.\n",
-      "\u001b[95m\u001b[1m\n",
-      "*****TASK LIST*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "3: Format the report for readability;\n",
-      "4: Include relevant images and graphics in the report;\n",
-      "5: Compare the current weather conditions in San Francisco to the forecasted conditions;\n",
-      "6: Identify any potential weather-related hazards in the area;\n",
-      "7: Research historical weather patterns in San Francisco;\n",
-      "8: Identify any potential trends in the weather data;\n",
-      "9: Include relevant data sources in the report;\n",
-      "10: Summarize the weather report in a concise manner;\n",
-      "11: Include a summary of the forecasted weather conditions;\n",
-      "12: Include a summary of the current weather conditions;\n",
-      "13: Include a summary of the historical weather patterns;\n",
-      "14: Include a summary of the potential weather-related hazards;\n",
-      "15: Include a summary of the potential trends in the weather data;\n",
-      "16: Include a summary of the data sources used in the report;\n",
-      "17: Analyze data to determine any upcoming weather changes;\n",
-      "18: Research current weather forecasts for San Francisco;\n",
-      "19: Create a visual representation of the weather report;\n",
-      "20: Publish the report online;\n",
-      "21: Monitor the report for accuracy\n",
-      "\u001b[92m\u001b[1m\n",
-      "*****NEXT TASK*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "3: Format the report for readability;\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: I need to make sure the report is easy to read;\n",
-      "Action: TODO\n",
-      "Action Input: Make the report easy to read\u001b[0m\u001b[33;1m\u001b[1;3m\n",
-      "\n",
-      "1. Break up the report into sections with clear headings\n",
-      "2. Use bullet points and numbered lists to organize information\n",
-      "3. Use short, concise sentences\n",
-      "4. Use simple language and avoid jargon\n",
-      "5. Include visuals such as charts, graphs, and diagrams to illustrate points\n",
-      "6. Use bold and italicized text to emphasize key points\n",
-      "7. Include a table of contents and page numbers\n",
-      "8. Use a consistent font and font size throughout the report\n",
-      "9. Include a summary at the end of the report\n",
-      "10. Proofread the report for typos and errors\u001b[0m\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: The report should be formatted for readability by breaking it up into sections with clear headings, using bullet points and numbered lists to organize information, using short, concise sentences, using simple language and avoiding jargon, including visuals such as charts, graphs, and diagrams to illustrate points, using bold and italicized text to emphasize key points, including a table of contents and page numbers, using a consistent font and font size throughout the report, including a summary at the end of the report, and proofreading the report for typos and errors.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\u001b[93m\u001b[1m\n",
-      "*****TASK RESULT*****\n",
-      "\u001b[0m\u001b[0m\n",
-      "The report should be formatted for readability by breaking it up into sections with clear headings, using bullet points and numbered lists to organize information, using short, concise sentences, using simple language and avoiding jargon, including visuals such as charts, graphs, and diagrams to illustrate points, using bold and italicized text to emphasize key points, including a table of contents and page numbers, using a consistent font and font size throughout the report, including a summary at the end of the report, and proofreading the report for typos and errors.\n",
-      "\u001b[91m\u001b[1m\n",
-      "*****TASK ENDING*****\n",
-      "\u001b[0m\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "{'objective': 'Write a weather report for SF today'}"
-      ]
-     },
-     "execution_count": 9,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "baby_agi({\"objective\": OBJECTIVE})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "898a210b",
-   "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
-}

cookbook/camel_role_playing.ipynb

@@ -1,708 +0,0 @@
-{
- "cells": [
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# CAMEL Role-Playing Autonomous Cooperative Agents\n",
-    "\n",
-    "This is a langchain implementation of paper: \"CAMEL: Communicative Agents for “Mind” Exploration of Large Scale Language Model Society\".\n",
-    "\n",
-    "Overview:\n",
-    "\n",
-    "The rapid advancement of conversational and chat-based language models has led to remarkable progress in complex task-solving. However, their success heavily relies on human input to guide the conversation, which can be challenging and time-consuming. This paper explores the potential of building scalable techniques to facilitate autonomous cooperation among communicative agents and provide insight into their \"cognitive\" processes. To address the challenges of achieving autonomous cooperation, we propose a novel communicative agent framework named role-playing. Our approach involves using inception prompting to guide chat agents toward task completion while maintaining consistency with human intentions. We showcase how role-playing can be used to generate conversational data for studying the behaviors and capabilities of chat agents, providing a valuable resource for investigating conversational language models. Our contributions include introducing a novel communicative agent framework, offering a scalable approach for studying the cooperative behaviors and capabilities of multi-agent systems, and open-sourcing our library to support research on communicative agents and beyond.\n",
-    "\n",
-    "The original implementation: https://github.com/lightaime/camel\n",
-    "\n",
-    "Project website: https://www.camel-ai.org/\n",
-    "\n",
-    "Arxiv paper: https://arxiv.org/abs/2303.17760\n"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Import LangChain related modules "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import List\n",
-    "\n",
-    "from langchain.prompts.chat import (\n",
-    "    HumanMessagePromptTemplate,\n",
-    "    SystemMessagePromptTemplate,\n",
-    ")\n",
-    "from langchain.schema import (\n",
-    "    AIMessage,\n",
-    "    BaseMessage,\n",
-    "    HumanMessage,\n",
-    "    SystemMessage,\n",
-    ")\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Define a CAMEL agent helper class"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class CAMELAgent:\n",
-    "    def __init__(\n",
-    "        self,\n",
-    "        system_message: SystemMessage,\n",
-    "        model: ChatOpenAI,\n",
-    "    ) -> None:\n",
-    "        self.system_message = system_message\n",
-    "        self.model = model\n",
-    "        self.init_messages()\n",
-    "\n",
-    "    def reset(self) -> None:\n",
-    "        self.init_messages()\n",
-    "        return self.stored_messages\n",
-    "\n",
-    "    def init_messages(self) -> None:\n",
-    "        self.stored_messages = [self.system_message]\n",
-    "\n",
-    "    def update_messages(self, message: BaseMessage) -> List[BaseMessage]:\n",
-    "        self.stored_messages.append(message)\n",
-    "        return self.stored_messages\n",
-    "\n",
-    "    def step(\n",
-    "        self,\n",
-    "        input_message: HumanMessage,\n",
-    "    ) -> AIMessage:\n",
-    "        messages = self.update_messages(input_message)\n",
-    "\n",
-    "        output_message = self.model.invoke(messages)\n",
-    "        self.update_messages(output_message)\n",
-    "\n",
-    "        return output_message"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Setup OpenAI API key and roles and task for role-playing"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "os.environ[\"OPENAI_API_KEY\"] = \"\"\n",
-    "\n",
-    "assistant_role_name = \"Python Programmer\"\n",
-    "user_role_name = \"Stock Trader\"\n",
-    "task = \"Develop a trading bot for the stock market\"\n",
-    "word_limit = 50  # word limit for task brainstorming"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create a task specify agent for brainstorming and get the specified task"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Specified task: Develop a Python-based swing trading bot that scans market trends, monitors stocks, and generates trading signals to help a stock trader to place optimal buy and sell orders with defined stop losses and profit targets.\n"
-     ]
-    }
-   ],
-   "source": [
-    "task_specifier_sys_msg = SystemMessage(content=\"You can make a task more specific.\")\n",
-    "task_specifier_prompt = \"\"\"Here is a task that {assistant_role_name} will help {user_role_name} to complete: {task}.\n",
-    "Please make it more specific. Be creative and imaginative.\n",
-    "Please reply with the specified task in {word_limit} words or less. Do not add anything else.\"\"\"\n",
-    "task_specifier_template = HumanMessagePromptTemplate.from_template(\n",
-    "    template=task_specifier_prompt\n",
-    ")\n",
-    "task_specify_agent = CAMELAgent(task_specifier_sys_msg, ChatOpenAI(temperature=1.0))\n",
-    "task_specifier_msg = task_specifier_template.format_messages(\n",
-    "    assistant_role_name=assistant_role_name,\n",
-    "    user_role_name=user_role_name,\n",
-    "    task=task,\n",
-    "    word_limit=word_limit,\n",
-    ")[0]\n",
-    "specified_task_msg = task_specify_agent.step(task_specifier_msg)\n",
-    "print(f\"Specified task: {specified_task_msg.content}\")\n",
-    "specified_task = specified_task_msg.content"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create inception prompts for AI assistant and AI user for role-playing"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "assistant_inception_prompt = \"\"\"Never forget you are a {assistant_role_name} and I am a {user_role_name}. Never flip roles! Never instruct me!\n",
-    "We share a common interest in collaborating to successfully complete a task.\n",
-    "You must help me to complete the task.\n",
-    "Here is the task: {task}. Never forget our task!\n",
-    "I must instruct you based on your expertise and my needs to complete the task.\n",
-    "\n",
-    "I must give you one instruction at a time.\n",
-    "You must write a specific solution that appropriately completes the requested instruction.\n",
-    "You must decline my instruction honestly if you cannot perform the instruction due to physical, moral, legal reasons or your capability and explain the reasons.\n",
-    "Do not add anything else other than your solution to my instruction.\n",
-    "You are never supposed to ask me any questions you only answer questions.\n",
-    "You are never supposed to reply with a flake solution. Explain your solutions.\n",
-    "Your solution must be declarative sentences and simple present tense.\n",
-    "Unless I say the task is completed, you should always start with:\n",
-    "\n",
-    "Solution: <YOUR_SOLUTION>\n",
-    "\n",
-    "<YOUR_SOLUTION> should be specific and provide preferable implementations and examples for task-solving.\n",
-    "Always end <YOUR_SOLUTION> with: Next request.\"\"\"\n",
-    "\n",
-    "user_inception_prompt = \"\"\"Never forget you are a {user_role_name} and I am a {assistant_role_name}. Never flip roles! You will always instruct me.\n",
-    "We share a common interest in collaborating to successfully complete a task.\n",
-    "I must help you to complete the task.\n",
-    "Here is the task: {task}. Never forget our task!\n",
-    "You must instruct me based on my expertise and your needs to complete the task ONLY in the following two ways:\n",
-    "\n",
-    "1. Instruct with a necessary input:\n",
-    "Instruction: <YOUR_INSTRUCTION>\n",
-    "Input: <YOUR_INPUT>\n",
-    "\n",
-    "2. Instruct without any input:\n",
-    "Instruction: <YOUR_INSTRUCTION>\n",
-    "Input: None\n",
-    "\n",
-    "The \"Instruction\" describes a task or question. The paired \"Input\" provides further context or information for the requested \"Instruction\".\n",
-    "\n",
-    "You must give me one instruction at a time.\n",
-    "I must write a response that appropriately completes the requested instruction.\n",
-    "I must decline your instruction honestly if I cannot perform the instruction due to physical, moral, legal reasons or my capability and explain the reasons.\n",
-    "You should instruct me not ask me questions.\n",
-    "Now you must start to instruct me using the two ways described above.\n",
-    "Do not add anything else other than your instruction and the optional corresponding input!\n",
-    "Keep giving me instructions and necessary inputs until you think the task is completed.\n",
-    "When the task is completed, you must only reply with a single word <CAMEL_TASK_DONE>.\n",
-    "Never say <CAMEL_TASK_DONE> unless my responses have solved your task.\"\"\""
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create a helper helper to get system messages for AI assistant and AI user from role names and the task"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def get_sys_msgs(assistant_role_name: str, user_role_name: str, task: str):\n",
-    "    assistant_sys_template = SystemMessagePromptTemplate.from_template(\n",
-    "        template=assistant_inception_prompt\n",
-    "    )\n",
-    "    assistant_sys_msg = assistant_sys_template.format_messages(\n",
-    "        assistant_role_name=assistant_role_name,\n",
-    "        user_role_name=user_role_name,\n",
-    "        task=task,\n",
-    "    )[0]\n",
-    "\n",
-    "    user_sys_template = SystemMessagePromptTemplate.from_template(\n",
-    "        template=user_inception_prompt\n",
-    "    )\n",
-    "    user_sys_msg = user_sys_template.format_messages(\n",
-    "        assistant_role_name=assistant_role_name,\n",
-    "        user_role_name=user_role_name,\n",
-    "        task=task,\n",
-    "    )[0]\n",
-    "\n",
-    "    return assistant_sys_msg, user_sys_msg"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create AI assistant agent and AI user agent from obtained system messages"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "assistant_sys_msg, user_sys_msg = get_sys_msgs(\n",
-    "    assistant_role_name, user_role_name, specified_task\n",
-    ")\n",
-    "assistant_agent = CAMELAgent(assistant_sys_msg, ChatOpenAI(temperature=0.2))\n",
-    "user_agent = CAMELAgent(user_sys_msg, ChatOpenAI(temperature=0.2))\n",
-    "\n",
-    "# Reset agents\n",
-    "assistant_agent.reset()\n",
-    "user_agent.reset()\n",
-    "\n",
-    "# Initialize chats\n",
-    "user_msg = HumanMessage(\n",
-    "    content=(\n",
-    "        f\"{user_sys_msg.content}. \"\n",
-    "        \"Now start to give me introductions one by one. \"\n",
-    "        \"Only reply with Instruction and Input.\"\n",
-    "    )\n",
-    ")\n",
-    "\n",
-    "assistant_msg = HumanMessage(content=f\"{assistant_sys_msg.content}\")\n",
-    "assistant_msg = assistant_agent.step(user_msg)"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Start role-playing session to solve the task!"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Original task prompt:\n",
-      "Develop a trading bot for the stock market\n",
-      "\n",
-      "Specified task prompt:\n",
-      "Develop a Python-based swing trading bot that scans market trends, monitors stocks, and generates trading signals to help a stock trader to place optimal buy and sell orders with defined stop losses and profit targets.\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Install the necessary Python libraries for data analysis and trading.\n",
-      "Input: None\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can install the necessary Python libraries using pip, a package installer for Python. We can install pandas, numpy, matplotlib, and ta-lib for data analysis and trading. We can use the following command to install these libraries:\n",
-      "\n",
-      "```\n",
-      "pip install pandas numpy matplotlib ta-lib\n",
-      "```\n",
-      "\n",
-      "Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Import the necessary libraries in the Python script.\n",
-      "Input: None\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can import the necessary libraries in the Python script using the import statement. We need to import pandas, numpy, matplotlib, and ta-lib for data analysis and trading. We can use the following code to import these libraries:\n",
-      "\n",
-      "```\n",
-      "import pandas as pd\n",
-      "import numpy as np\n",
-      "import matplotlib.pyplot as plt\n",
-      "import talib as ta\n",
-      "```\n",
-      "\n",
-      "Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Load historical stock data into a pandas DataFrame.\n",
-      "Input: The path to the CSV file containing the historical stock data.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can load historical stock data into a pandas DataFrame using the `read_csv()` function from pandas. We need to pass the path to the CSV file containing the historical stock data as an argument to this function. We can use the following code to load the historical stock data:\n",
-      "\n",
-      "```\n",
-      "df = pd.read_csv('path/to/csv/file.csv')\n",
-      "```\n",
-      "\n",
-      "This will load the historical stock data into a pandas DataFrame called `df`. Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Preprocess the historical stock data by setting the date column as the index and sorting the DataFrame in ascending order by date.\n",
-      "Input: None.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can preprocess the historical stock data by setting the date column as the index and sorting the DataFrame in ascending order by date using the `set_index()` and `sort_index()` functions from pandas. We can use the following code to preprocess the historical stock data:\n",
-      "\n",
-      "```\n",
-      "df = df.set_index('date')\n",
-      "df = df.sort_index(ascending=True)\n",
-      "```\n",
-      "\n",
-      "This will set the date column as the index and sort the DataFrame in ascending order by date. Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Calculate the short-term and long-term moving averages for the stock data using the `ta.SMA()` function from ta-lib.\n",
-      "Input: The period for the short-term moving average and the period for the long-term moving average.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can calculate the short-term and long-term moving averages for the stock data using the `ta.SMA()` function from ta-lib. We need to pass the period for the short-term moving average and the period for the long-term moving average as arguments to this function. We can use the following code to calculate the short-term and long-term moving averages:\n",
-      "\n",
-      "```\n",
-      "short_ma = ta.SMA(df['close'], timeperiod=short_period)\n",
-      "long_ma = ta.SMA(df['close'], timeperiod=long_period)\n",
-      "```\n",
-      "\n",
-      "This will calculate the short-term and long-term moving averages for the stock data and store them in the `short_ma` and `long_ma` variables, respectively. Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Create a new DataFrame that combines the historical stock data with the short-term and long-term moving averages.\n",
-      "Input: None.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can create a new DataFrame that combines the historical stock data with the short-term and long-term moving averages using the `concat()` function from pandas. We need to pass the historical stock data, the short-term moving average, and the long-term moving average as arguments to this function. We can use the following code to create the new DataFrame:\n",
-      "\n",
-      "```\n",
-      "new_df = pd.concat([df, short_ma, long_ma], axis=1)\n",
-      "new_df.columns = ['open', 'high', 'low', 'close', 'volume', 'short_ma', 'long_ma']\n",
-      "```\n",
-      "\n",
-      "This will create a new DataFrame called `new_df` that combines the historical stock data with the short-term and long-term moving averages. The columns of the new DataFrame are named 'open', 'high', 'low', 'close', 'volume', 'short_ma', and 'long_ma'. Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Create a new column in the DataFrame that indicates when to buy or sell the stock based on the crossover of the short-term and long-term moving averages.\n",
-      "Input: None.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can create a new column in the DataFrame that indicates when to buy or sell the stock based on the crossover of the short-term and long-term moving averages. We can use the following code to create the new column:\n",
-      "\n",
-      "```\n",
-      "new_df['signal'] = np.where(new_df['short_ma'] > new_df['long_ma'], 1, -1)\n",
-      "```\n",
-      "\n",
-      "This will create a new column called 'signal' in the DataFrame that indicates when to buy or sell the stock based on the crossover of the short-term and long-term moving averages. If the short-term moving average is greater than the long-term moving average, the signal is 1 (buy), otherwise the signal is -1 (sell). Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Create a new column in the DataFrame that indicates the profit or loss for each trade based on the buy and sell signals and the defined stop loss and profit target.\n",
-      "Input: The stop loss and profit target as percentages.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can create a new column in the DataFrame that indicates the profit or loss for each trade based on the buy and sell signals and the defined stop loss and profit target. We need to pass the stop loss and profit target as percentages as arguments to this function. We can use the following code to create the new column:\n",
-      "\n",
-      "```\n",
-      "stop_loss = stop_loss_percent / 100\n",
-      "profit_target = profit_target_percent / 100\n",
-      "\n",
-      "new_df['pnl'] = 0.0\n",
-      "buy_price = 0.0\n",
-      "for i in range(1, len(new_df)):\n",
-      "    if new_df['signal'][i] == 1 and new_df['signal'][i-1] == -1:\n",
-      "        buy_price = new_df['close'][i]\n",
-      "    elif new_df['signal'][i] == -1 and new_df['signal'][i-1] == 1:\n",
-      "        sell_price = new_df['close'][i]\n",
-      "        if sell_price <= buy_price * (1 - stop_loss):\n",
-      "            new_df['pnl'][i] = -stop_loss\n",
-      "        elif sell_price >= buy_price * (1 + profit_target):\n",
-      "            new_df['pnl'][i] = profit_target\n",
-      "        else:\n",
-      "            new_df['pnl'][i] = (sell_price - buy_price) / buy_price\n",
-      "```\n",
-      "\n",
-      "This will create a new column called 'pnl' in the DataFrame that indicates the profit or loss for each trade based on the buy and sell signals and the defined stop loss and profit target. The stop loss and profit target are calculated based on the stop_loss_percent and profit_target_percent variables, respectively. The buy and sell prices are stored in the buy_price and sell_price variables, respectively. If the sell price is less than or equal to the stop loss, the profit or loss is set to -stop_loss. If the sell price is greater than or equal to the profit target, the profit or loss is set to profit_target. Otherwise, the profit or loss is calculated as (sell_price - buy_price) / buy_price. Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Calculate the total profit or loss for all trades.\n",
-      "Input: None.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can calculate the total profit or loss for all trades by summing the values in the 'pnl' column of the DataFrame. We can use the following code to calculate the total profit or loss:\n",
-      "\n",
-      "```\n",
-      "total_pnl = new_df['pnl'].sum()\n",
-      "```\n",
-      "\n",
-      "This will calculate the total profit or loss for all trades and store it in the total_pnl variable. Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Visualize the stock data, short-term moving average, and long-term moving average using a line chart.\n",
-      "Input: None.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can visualize the stock data, short-term moving average, and long-term moving average using a line chart using the `plot()` function from pandas. We can use the following code to visualize the data:\n",
-      "\n",
-      "```\n",
-      "plt.figure(figsize=(12,6))\n",
-      "plt.plot(new_df.index, new_df['close'], label='Close')\n",
-      "plt.plot(new_df.index, new_df['short_ma'], label='Short MA')\n",
-      "plt.plot(new_df.index, new_df['long_ma'], label='Long MA')\n",
-      "plt.xlabel('Date')\n",
-      "plt.ylabel('Price')\n",
-      "plt.title('Stock Data with Moving Averages')\n",
-      "plt.legend()\n",
-      "plt.show()\n",
-      "```\n",
-      "\n",
-      "This will create a line chart that visualizes the stock data, short-term moving average, and long-term moving average. The x-axis represents the date and the y-axis represents the price. The chart also includes a legend that labels each line. Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Visualize the buy and sell signals using a scatter plot.\n",
-      "Input: None.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can visualize the buy and sell signals using a scatter plot using the `scatter()` function from matplotlib. We can use the following code to visualize the signals:\n",
-      "\n",
-      "```\n",
-      "buy_signals = new_df[new_df['signal'] == 1]\n",
-      "sell_signals = new_df[new_df['signal'] == -1]\n",
-      "\n",
-      "plt.figure(figsize=(12,6))\n",
-      "plt.scatter(buy_signals.index, buy_signals['close'], label='Buy', marker='^', color='green')\n",
-      "plt.scatter(sell_signals.index, sell_signals['close'], label='Sell', marker='v', color='red')\n",
-      "plt.plot(new_df.index, new_df['close'], label='Close')\n",
-      "plt.xlabel('Date')\n",
-      "plt.ylabel('Price')\n",
-      "plt.title('Buy and Sell Signals')\n",
-      "plt.legend()\n",
-      "plt.show()\n",
-      "```\n",
-      "\n",
-      "This will create a scatter plot that visualizes the buy and sell signals. The x-axis represents the date and the y-axis represents the price. The chart also includes a legend that labels each point. Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Print the total profit or loss for all trades.\n",
-      "Input: None.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: We can print the total profit or loss for all trades using the `print()` function. We can use the following code to print the total profit or loss:\n",
-      "\n",
-      "```\n",
-      "print('Total Profit/Loss: {:.2%}'.format(total_pnl))\n",
-      "```\n",
-      "\n",
-      "This will print the total profit or loss for all trades in percentage format with two decimal places. Next request.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "Instruction: Finalize the code by putting all the code snippets together in a single Python script.\n",
-      "Input: The necessary inputs for each code snippet.\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Solution: Here is the complete Python script that puts all the code snippets together:\n",
-      "\n",
-      "```\n",
-      "import pandas as pd\n",
-      "import numpy as np\n",
-      "import matplotlib.pyplot as plt\n",
-      "import talib as ta\n",
-      "\n",
-      "# Load historical stock data into a pandas DataFrame\n",
-      "df = pd.read_csv('path/to/csv/file.csv')\n",
-      "\n",
-      "# Preprocess the historical stock data\n",
-      "df = df.set_index('date')\n",
-      "df = df.sort_index(ascending=True)\n",
-      "\n",
-      "# Calculate the short-term and long-term moving averages\n",
-      "short_period = 10\n",
-      "long_period = 30\n",
-      "short_ma = ta.SMA(df['close'], timeperiod=short_period)\n",
-      "long_ma = ta.SMA(df['close'], timeperiod=long_period)\n",
-      "\n",
-      "# Create a new DataFrame that combines the historical stock data with the short-term and long-term moving averages\n",
-      "new_df = pd.concat([df, short_ma, long_ma], axis=1)\n",
-      "new_df.columns = ['open', 'high', 'low', 'close', 'volume', 'short_ma', 'long_ma']\n",
-      "\n",
-      "# Create a new column in the DataFrame that indicates when to buy or sell the stock based on the crossover of the short-term and long-term moving averages\n",
-      "new_df['signal'] = np.where(new_df['short_ma'] > new_df['long_ma'], 1, -1)\n",
-      "\n",
-      "# Create a new column in the DataFrame that indicates the profit or loss for each trade based on the buy and sell signals and the defined stop loss and profit target\n",
-      "stop_loss_percent = 5\n",
-      "profit_target_percent = 10\n",
-      "stop_loss = stop_loss_percent / 100\n",
-      "profit_target = profit_target_percent / 100\n",
-      "new_df['pnl'] = 0.0\n",
-      "buy_price = 0.0\n",
-      "for i in range(1, len(new_df)):\n",
-      "    if new_df['signal'][i] == 1 and new_df['signal'][i-1] == -1:\n",
-      "        buy_price = new_df['close'][i]\n",
-      "    elif new_df['signal'][i] == -1 and new_df['signal'][i-1] == 1:\n",
-      "        sell_price = new_df['close'][i]\n",
-      "        if sell_price <= buy_price * (1 - stop_loss):\n",
-      "            new_df['pnl'][i] = -stop_loss\n",
-      "        elif sell_price >= buy_price * (1 + profit_target):\n",
-      "            new_df['pnl'][i] = profit_target\n",
-      "        else:\n",
-      "            new_df['pnl'][i] = (sell_price - buy_price) / buy_price\n",
-      "\n",
-      "# Calculate the total profit or loss for all trades\n",
-      "total_pnl = new_df['pnl'].sum()\n",
-      "\n",
-      "# Visualize the stock data, short-term moving average, and long-term moving average using a line chart\n",
-      "plt.figure(figsize=(12,6))\n",
-      "plt.plot(new_df.index, new_df['close'], label='Close')\n",
-      "plt.plot(new_df.index, new_df['short_ma'], label='Short MA')\n",
-      "plt.plot(new_df.index, new_df['long_ma'], label='Long MA')\n",
-      "plt.xlabel('Date')\n",
-      "plt.ylabel('Price')\n",
-      "plt.title('Stock Data with Moving Averages')\n",
-      "plt.legend()\n",
-      "plt.show()\n",
-      "\n",
-      "# Visualize the buy and sell signals using a scatter plot\n",
-      "buy_signals = new_df[new_df['signal'] == 1]\n",
-      "sell_signals = new_df[new_df['signal'] == -1]\n",
-      "plt.figure(figsize=(12,6))\n",
-      "plt.scatter(buy_signals.index, buy_signals['close'], label='Buy', marker='^', color='green')\n",
-      "plt.scatter(sell_signals.index, sell_signals['close'], label='Sell', marker='v', color='red')\n",
-      "plt.plot(new_df.index, new_df['close'], label='Close')\n",
-      "plt.xlabel('Date')\n",
-      "plt.ylabel('Price')\n",
-      "plt.title('Buy and Sell Signals')\n",
-      "plt.legend()\n",
-      "plt.show()\n",
-      "\n",
-      "# Print the total profit or loss for all trades\n",
-      "print('Total Profit/Loss: {:.2%}'.format(total_pnl))\n",
-      "```\n",
-      "\n",
-      "You need to replace the path/to/csv/file.csv with the actual path to the CSV file containing the historical stock data. You can also adjust the short_period, long_period, stop_loss_percent, and profit_target_percent variables to suit your needs.\n",
-      "\n",
-      "\n",
-      "AI User (Stock Trader):\n",
-      "\n",
-      "<CAMEL_TASK_DONE>\n",
-      "\n",
-      "\n",
-      "AI Assistant (Python Programmer):\n",
-      "\n",
-      "Great! Let me know if you need any further assistance.\n",
-      "\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(f\"Original task prompt:\\n{task}\\n\")\n",
-    "print(f\"Specified task prompt:\\n{specified_task}\\n\")\n",
-    "\n",
-    "chat_turn_limit, n = 30, 0\n",
-    "while n < chat_turn_limit:\n",
-    "    n += 1\n",
-    "    user_ai_msg = user_agent.step(assistant_msg)\n",
-    "    user_msg = HumanMessage(content=user_ai_msg.content)\n",
-    "    print(f\"AI User ({user_role_name}):\\n\\n{user_msg.content}\\n\\n\")\n",
-    "\n",
-    "    assistant_ai_msg = assistant_agent.step(user_msg)\n",
-    "    assistant_msg = HumanMessage(content=assistant_ai_msg.content)\n",
-    "    print(f\"AI Assistant ({assistant_role_name}):\\n\\n{assistant_msg.content}\\n\\n\")\n",
-    "    if \"<CAMEL_TASK_DONE>\" in user_msg.content:\n",
-    "        break"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "camel",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.10.9"
-  },
-  "orig_nbformat": 4
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

cookbook/cql_agent.ipynb

@@ -1,557 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Setup Environment"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Python Modules"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Install the following Python modules:\n",
-    "\n",
-    "```bash\n",
-    "pip install ipykernel python-dotenv cassio pandas langchain_openai langchain langchain-community langchainhub langchain_experimental openai-multi-tool-use-parallel-patch\n",
-    "```"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Load the `.env` File"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Connection is via `cassio` using `auto=True` parameter, and the notebook uses OpenAI. You should create a `.env` file accordingly.\n",
-    "\n",
-    "For Cassandra, set:\n",
-    "```bash\n",
-    "CASSANDRA_CONTACT_POINTS\n",
-    "CASSANDRA_USERNAME\n",
-    "CASSANDRA_PASSWORD\n",
-    "CASSANDRA_KEYSPACE\n",
-    "```\n",
-    "\n",
-    "For Astra, set:\n",
-    "```bash\n",
-    "ASTRA_DB_APPLICATION_TOKEN\n",
-    "ASTRA_DB_DATABASE_ID\n",
-    "ASTRA_DB_KEYSPACE\n",
-    "```\n",
-    "\n",
-    "For example:\n",
-    "\n",
-    "```bash\n",
-    "# Connection to Astra:\n",
-    "ASTRA_DB_DATABASE_ID=a1b2c3d4-...\n",
-    "ASTRA_DB_APPLICATION_TOKEN=AstraCS:...\n",
-    "ASTRA_DB_KEYSPACE=notebooks\n",
-    "\n",
-    "# Also set \n",
-    "OPENAI_API_KEY=sk-....\n",
-    "```\n",
-    "\n",
-    "(You may also modify the below code to directly connect with `cassio`.)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from dotenv import load_dotenv\n",
-    "\n",
-    "load_dotenv(override=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Connect to Cassandra"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "import cassio\n",
-    "\n",
-    "cassio.init(auto=True)\n",
-    "session = cassio.config.resolve_session()\n",
-    "if not session:\n",
-    "    raise Exception(\n",
-    "        \"Check environment configuration or manually configure cassio connection parameters\"\n",
-    "    )\n",
-    "\n",
-    "keyspace = os.environ.get(\n",
-    "    \"ASTRA_DB_KEYSPACE\", os.environ.get(\"CASSANDRA_KEYSPACE\", None)\n",
-    ")\n",
-    "if not keyspace:\n",
-    "    raise ValueError(\"a KEYSPACE environment variable must be set\")\n",
-    "\n",
-    "session.set_keyspace(keyspace)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Setup Database"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "This needs to be done one time only!"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Download Data"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "The dataset used is from Kaggle, the [Environmental Sensor Telemetry Data](https://www.kaggle.com/datasets/garystafford/environmental-sensor-data-132k?select=iot_telemetry_data.csv). The next cell will download and unzip the data into a Pandas dataframe. The following cell is instructions to download manually. \n",
-    "\n",
-    "The net result of this section is you should have a Pandas dataframe variable `df`."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Download Automatically"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from io import BytesIO\n",
-    "from zipfile import ZipFile\n",
-    "\n",
-    "import pandas as pd\n",
-    "import requests\n",
-    "\n",
-    "datasetURL = \"https://storage.googleapis.com/kaggle-data-sets/788816/1355729/bundle/archive.zip?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=gcp-kaggle-com%40kaggle-161607.iam.gserviceaccount.com%2F20240404%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20240404T115828Z&X-Goog-Expires=259200&X-Goog-SignedHeaders=host&X-Goog-Signature=2849f003b100eb9dcda8dd8535990f51244292f67e4f5fad36f14aa67f2d4297672d8fe6ff5a39f03a29cda051e33e95d36daab5892b8874dcd5a60228df0361fa26bae491dd4371f02dd20306b583a44ba85a4474376188b1f84765147d3b4f05c57345e5de883c2c29653cce1f3755cd8e645c5e952f4fb1c8a735b22f0c811f97f7bce8d0235d0d3731ca8ab4629ff381f3bae9e35fc1b181c1e69a9c7913a5e42d9d52d53e5f716467205af9c8a3cc6746fc5352e8fbc47cd7d18543626bd67996d18c2045c1e475fc136df83df352fa747f1a3bb73e6ba3985840792ec1de407c15836640ec96db111b173bf16115037d53fdfbfd8ac44145d7f9a546aa\"\n",
-    "\n",
-    "response = requests.get(datasetURL)\n",
-    "if response.status_code == 200:\n",
-    "    zip_file = ZipFile(BytesIO(response.content))\n",
-    "    csv_file_name = zip_file.namelist()[0]\n",
-    "else:\n",
-    "    print(\"Failed to download the file\")\n",
-    "\n",
-    "with zip_file.open(csv_file_name) as csv_file:\n",
-    "    df = pd.read_csv(csv_file)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "#### Download Manually"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can download the `.zip` file and unpack the `.csv` contained within. Comment in the next line, and adjust the path to this `.csv` file appropriately."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# df = pd.read_csv(\"/path/to/iot_telemetry_data.csv\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Load Data into Cassandra"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "This section assumes the existence of a dataframe `df`, the following cell validates its structure. The Download section above creates this object."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "assert df is not None, \"Dataframe 'df' must be set\"\n",
-    "expected_columns = [\n",
-    "    \"ts\",\n",
-    "    \"device\",\n",
-    "    \"co\",\n",
-    "    \"humidity\",\n",
-    "    \"light\",\n",
-    "    \"lpg\",\n",
-    "    \"motion\",\n",
-    "    \"smoke\",\n",
-    "    \"temp\",\n",
-    "]\n",
-    "assert all([column in df.columns for column in expected_columns]), (\n",
-    "    \"DataFrame does not have the expected columns\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Create and load tables:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from datetime import UTC, datetime\n",
-    "\n",
-    "from cassandra.query import BatchStatement\n",
-    "\n",
-    "# Create sensors table\n",
-    "table_query = \"\"\"\n",
-    "CREATE TABLE IF NOT EXISTS iot_sensors (\n",
-    "    device text,\n",
-    "    conditions text,\n",
-    "    room text,\n",
-    "    PRIMARY KEY (device)\n",
-    ")\n",
-    "WITH COMMENT = 'Environmental IoT room sensor metadata.';\n",
-    "\"\"\"\n",
-    "session.execute(table_query)\n",
-    "\n",
-    "pstmt = session.prepare(\n",
-    "    \"\"\"\n",
-    "INSERT INTO iot_sensors (device, conditions, room)\n",
-    "VALUES (?, ?, ?)\n",
-    "\"\"\"\n",
-    ")\n",
-    "\n",
-    "devices = [\n",
-    "    (\"00:0f:00:70:91:0a\", \"stable conditions, cooler and more humid\", \"room 1\"),\n",
-    "    (\"1c:bf:ce:15:ec:4d\", \"highly variable temperature and humidity\", \"room 2\"),\n",
-    "    (\"b8:27:eb:bf:9d:51\", \"stable conditions, warmer and dryer\", \"room 3\"),\n",
-    "]\n",
-    "\n",
-    "for device, conditions, room in devices:\n",
-    "    session.execute(pstmt, (device, conditions, room))\n",
-    "\n",
-    "print(\"Sensors inserted successfully.\")\n",
-    "\n",
-    "# Create data table\n",
-    "table_query = \"\"\"\n",
-    "CREATE TABLE IF NOT EXISTS iot_data (\n",
-    "    day text,\n",
-    "    device text,\n",
-    "    ts timestamp,\n",
-    "    co double,\n",
-    "    humidity double,\n",
-    "    light boolean,\n",
-    "    lpg double,\n",
-    "    motion boolean,\n",
-    "    smoke double,\n",
-    "    temp double,\n",
-    "    PRIMARY KEY ((day, device), ts)\n",
-    ")\n",
-    "WITH COMMENT = 'Data from environmental IoT room sensors. Columns include device identifier, timestamp (ts) of the data collection, carbon monoxide level (co), relative humidity, light presence, LPG concentration, motion detection, smoke concentration, and temperature (temp). Data is partitioned by day and device.';\n",
-    "\"\"\"\n",
-    "session.execute(table_query)\n",
-    "\n",
-    "pstmt = session.prepare(\n",
-    "    \"\"\"\n",
-    "INSERT INTO iot_data (day, device, ts, co, humidity, light, lpg, motion, smoke, temp)\n",
-    "VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)\n",
-    "\"\"\"\n",
-    ")\n",
-    "\n",
-    "\n",
-    "def insert_data_batch(name, group):\n",
-    "    batch = BatchStatement()\n",
-    "    day, device = name\n",
-    "    print(f\"Inserting batch for day: {day}, device: {device}\")\n",
-    "\n",
-    "    for _, row in group.iterrows():\n",
-    "        timestamp = datetime.fromtimestamp(row[\"ts\"], UTC)\n",
-    "        batch.add(\n",
-    "            pstmt,\n",
-    "            (\n",
-    "                day,\n",
-    "                row[\"device\"],\n",
-    "                timestamp,\n",
-    "                row[\"co\"],\n",
-    "                row[\"humidity\"],\n",
-    "                row[\"light\"],\n",
-    "                row[\"lpg\"],\n",
-    "                row[\"motion\"],\n",
-    "                row[\"smoke\"],\n",
-    "                row[\"temp\"],\n",
-    "            ),\n",
-    "        )\n",
-    "\n",
-    "    session.execute(batch)\n",
-    "\n",
-    "\n",
-    "# Convert columns to appropriate types\n",
-    "df[\"light\"] = df[\"light\"] == \"true\"\n",
-    "df[\"motion\"] = df[\"motion\"] == \"true\"\n",
-    "df[\"ts\"] = df[\"ts\"].astype(float)\n",
-    "df[\"day\"] = df[\"ts\"].apply(\n",
-    "    lambda x: datetime.fromtimestamp(x, UTC).strftime(\"%Y-%m-%d\")\n",
-    ")\n",
-    "\n",
-    "grouped_df = df.groupby([\"day\", \"device\"])\n",
-    "\n",
-    "for name, group in grouped_df:\n",
-    "    insert_data_batch(name, group)\n",
-    "\n",
-    "print(\"Data load complete\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "print(session.keyspace)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Load the Tools"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Python `import` statements for the demo:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import AgentExecutor, create_openai_tools_agent\n",
-    "from langchain_community.agent_toolkits.cassandra_database.toolkit import (\n",
-    "    CassandraDatabaseToolkit,\n",
-    ")\n",
-    "from langchain_community.tools.cassandra_database.prompt import QUERY_PATH_PROMPT\n",
-    "from langchain_community.tools.cassandra_database.tool import (\n",
-    "    GetSchemaCassandraDatabaseTool,\n",
-    "    GetTableDataCassandraDatabaseTool,\n",
-    "    QueryCassandraDatabaseTool,\n",
-    ")\n",
-    "from langchain_community.utilities.cassandra_database import CassandraDatabase\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "The `CassandraDatabase` object is loaded from `cassio`, though it does accept a `Session`-type parameter as an alternative."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Create a CassandraDatabase instance\n",
-    "db = CassandraDatabase(include_tables=[\"iot_sensors\", \"iot_data\"])\n",
-    "\n",
-    "# Create the Cassandra Database tools\n",
-    "query_tool = QueryCassandraDatabaseTool(db=db)\n",
-    "schema_tool = GetSchemaCassandraDatabaseTool(db=db)\n",
-    "select_data_tool = GetTableDataCassandraDatabaseTool(db=db)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "The tools can be invoked directly:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Test the tools\n",
-    "print(\"Executing a CQL query:\")\n",
-    "query = \"SELECT * FROM iot_sensors LIMIT 5;\"\n",
-    "result = query_tool.run({\"query\": query})\n",
-    "print(result)\n",
-    "\n",
-    "print(\"\\nGetting the schema for a keyspace:\")\n",
-    "schema = schema_tool.run({\"keyspace\": keyspace})\n",
-    "print(schema)\n",
-    "\n",
-    "print(\"\\nGetting data from a table:\")\n",
-    "table = \"iot_data\"\n",
-    "predicate = \"day = '2020-07-14' and device = 'b8:27:eb:bf:9d:51'\"\n",
-    "data = select_data_tool.run(\n",
-    "    {\"keyspace\": keyspace, \"table\": table, \"predicate\": predicate, \"limit\": 5}\n",
-    ")\n",
-    "print(data)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Agent Configuration"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import Tool\n",
-    "from langchain_experimental.utilities import PythonREPL\n",
-    "\n",
-    "python_repl = PythonREPL()\n",
-    "\n",
-    "repl_tool = Tool(\n",
-    "    name=\"python_repl\",\n",
-    "    description=\"A Python shell. Use this to execute python commands. Input should be a valid python command. If you want to see the output of a value, you should print it out with `print(...)`.\",\n",
-    "    func=python_repl.run,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain import hub\n",
-    "\n",
-    "llm = ChatOpenAI(temperature=0, model=\"gpt-4-1106-preview\")\n",
-    "toolkit = CassandraDatabaseToolkit(db=db)\n",
-    "\n",
-    "# context = toolkit.get_context()\n",
-    "# tools = toolkit.get_tools()\n",
-    "tools = [schema_tool, select_data_tool, repl_tool]\n",
-    "\n",
-    "input = (\n",
-    "    QUERY_PATH_PROMPT\n",
-    "    + f\"\"\"\n",
-    "\n",
-    "Here is your task: In the {keyspace} keyspace, find the total number of times the temperature of each device has exceeded 23 degrees on July 14, 2020.\n",
-    " Create a summary report including the name of the room. Use Pandas if helpful.\n",
-    "\"\"\"\n",
-    ")\n",
-    "\n",
-    "prompt = hub.pull(\"hwchase17/openai-tools-agent\")\n",
-    "\n",
-    "# messages = [\n",
-    "#     HumanMessagePromptTemplate.from_template(input),\n",
-    "#     AIMessage(content=QUERY_PATH_PROMPT),\n",
-    "#     MessagesPlaceholder(variable_name=\"agent_scratchpad\"),\n",
-    "# ]\n",
-    "\n",
-    "# prompt = ChatPromptTemplate.from_messages(messages)\n",
-    "# print(prompt)\n",
-    "\n",
-    "# Choose the LLM that will drive the agent\n",
-    "# Only certain models support this\n",
-    "llm = ChatOpenAI(model=\"gpt-3.5-turbo-1106\", temperature=0)\n",
-    "\n",
-    "# Construct the OpenAI Tools agent\n",
-    "agent = create_openai_tools_agent(llm, tools, prompt)\n",
-    "\n",
-    "print(\"Available tools:\")\n",
-    "for tool in tools:\n",
-    "    print(\"\\t\" + tool.name + \" - \" + tool.description + \" - \" + str(tool))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent_executor = AgentExecutor(agent=agent, tools=tools, verbose=True)\n",
-    "\n",
-    "response = agent_executor.invoke({\"input\": input})\n",
-    "\n",
-    "print(response[\"output\"])"
-   ]
-  }
- ],
- "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": 4
-}

cookbook/custom_agent_with_plugin_retrieval.ipynb

@@ -1,554 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "ba5f8741",
-   "metadata": {},
-   "source": [
-    "# Custom Agent with PlugIn Retrieval\n",
-    "\n",
-    "This notebook combines two concepts in order to build a custom agent that can interact with AI Plugins:\n",
-    "\n",
-    "1. [Custom Agent with Tool Retrieval](/docs/modules/agents/how_to/custom_agent_with_tool_retrieval.html): This introduces the concept of retrieving many tools, which is useful when trying to work with arbitrarily many plugins.\n",
-    "2. [Natural Language API Chains](/docs/use_cases/apis/openapi.html): This creates Natural Language wrappers around OpenAPI endpoints. This is useful because (1) plugins use OpenAPI endpoints under the hood, (2) wrapping them in an NLAChain allows the router agent to call it more easily.\n",
-    "\n",
-    "The novel idea introduced in this notebook is the idea of using retrieval to select not the tools explicitly, but the set of OpenAPI specs to use. We can then generate tools from those OpenAPI specs. The use case for this is when trying to get agents to use plugins. It may be more efficient to choose plugins first, then the endpoints, rather than the endpoints directly. This is because the plugins may contain more useful information for selection."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fea4812c",
-   "metadata": {},
-   "source": [
-    "## Set up environment\n",
-    "\n",
-    "Do necessary imports, etc."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "9af9734e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import re\n",
-    "from typing import Union\n",
-    "\n",
-    "from langchain.agents import (\n",
-    "    AgentExecutor,\n",
-    "    AgentOutputParser,\n",
-    "    LLMSingleActionAgent,\n",
-    ")\n",
-    "from langchain.chains import LLMChain\n",
-    "from langchain.prompts import StringPromptTemplate\n",
-    "from langchain_community.agent_toolkits import NLAToolkit\n",
-    "from langchain_community.tools.plugin import AIPlugin\n",
-    "from langchain_core.agents import AgentAction, AgentFinish\n",
-    "from langchain_openai import OpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2f91d8b4",
-   "metadata": {},
-   "source": [
-    "## Setup LLM"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "a1a3b59c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "6df0253f",
-   "metadata": {},
-   "source": [
-    "## Set up plugins\n",
-    "\n",
-    "Load and index plugins"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "becda2a1",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "urls = [\n",
-    "    \"https://datasette.io/.well-known/ai-plugin.json\",\n",
-    "    \"https://api.speak.com/.well-known/ai-plugin.json\",\n",
-    "    \"https://www.wolframalpha.com/.well-known/ai-plugin.json\",\n",
-    "    \"https://www.zapier.com/.well-known/ai-plugin.json\",\n",
-    "    \"https://www.klarna.com/.well-known/ai-plugin.json\",\n",
-    "    \"https://www.joinmilo.com/.well-known/ai-plugin.json\",\n",
-    "    \"https://slack.com/.well-known/ai-plugin.json\",\n",
-    "    \"https://schooldigger.com/.well-known/ai-plugin.json\",\n",
-    "]\n",
-    "\n",
-    "AI_PLUGINS = [AIPlugin.from_url(url) for url in urls]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "17362717",
-   "metadata": {},
-   "source": [
-    "## Tool Retriever\n",
-    "\n",
-    "We will use a vectorstore to create embeddings for each tool description. Then, for an incoming query we can create embeddings for that query and do a similarity search for relevant tools."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "77c4be4b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_community.vectorstores import FAISS\n",
-    "from langchain_core.documents import Document\n",
-    "from langchain_openai import OpenAIEmbeddings"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "9092a158",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.2 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load a Swagger 2.0 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n"
-     ]
-    }
-   ],
-   "source": [
-    "embeddings = OpenAIEmbeddings()\n",
-    "docs = [\n",
-    "    Document(\n",
-    "        page_content=plugin.description_for_model,\n",
-    "        metadata={\"plugin_name\": plugin.name_for_model},\n",
-    "    )\n",
-    "    for plugin in AI_PLUGINS\n",
-    "]\n",
-    "vector_store = FAISS.from_documents(docs, embeddings)\n",
-    "toolkits_dict = {\n",
-    "    plugin.name_for_model: NLAToolkit.from_llm_and_ai_plugin(llm, plugin)\n",
-    "    for plugin in AI_PLUGINS\n",
-    "}"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "735a7566",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "retriever = vector_store.as_retriever()\n",
-    "\n",
-    "\n",
-    "def get_tools(query):\n",
-    "    # Get documents, which contain the Plugins to use\n",
-    "    docs = retriever.invoke(query)\n",
-    "    # Get the toolkits, one for each plugin\n",
-    "    tool_kits = [toolkits_dict[d.metadata[\"plugin_name\"]] for d in docs]\n",
-    "    # Get the tools: a separate NLAChain for each endpoint\n",
-    "    tools = []\n",
-    "    for tk in tool_kits:\n",
-    "        tools.extend(tk.nla_tools)\n",
-    "    return tools"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "7699afd7",
-   "metadata": {},
-   "source": [
-    "We can now test this retriever to see if it seems to work."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "425f2886",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "['Milo.askMilo',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.search_all_actions',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.preview_a_zap',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.get_configuration_link',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.list_exposed_actions',\n",
-       " 'SchoolDigger_API_V2.0.Autocomplete_GetSchools',\n",
-       " 'SchoolDigger_API_V2.0.Districts_GetAllDistricts2',\n",
-       " 'SchoolDigger_API_V2.0.Districts_GetDistrict2',\n",
-       " 'SchoolDigger_API_V2.0.Rankings_GetSchoolRank2',\n",
-       " 'SchoolDigger_API_V2.0.Rankings_GetRank_District',\n",
-       " 'SchoolDigger_API_V2.0.Schools_GetAllSchools20',\n",
-       " 'SchoolDigger_API_V2.0.Schools_GetSchool20',\n",
-       " 'Speak.translate',\n",
-       " 'Speak.explainPhrase',\n",
-       " 'Speak.explainTask']"
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "tools = get_tools(\"What could I do today with my kiddo\")\n",
-    "[t.name for t in tools]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "3aa88768",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "['Open_AI_Klarna_product_Api.productsUsingGET',\n",
-       " 'Milo.askMilo',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.search_all_actions',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.preview_a_zap',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.get_configuration_link',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.list_exposed_actions',\n",
-       " 'SchoolDigger_API_V2.0.Autocomplete_GetSchools',\n",
-       " 'SchoolDigger_API_V2.0.Districts_GetAllDistricts2',\n",
-       " 'SchoolDigger_API_V2.0.Districts_GetDistrict2',\n",
-       " 'SchoolDigger_API_V2.0.Rankings_GetSchoolRank2',\n",
-       " 'SchoolDigger_API_V2.0.Rankings_GetRank_District',\n",
-       " 'SchoolDigger_API_V2.0.Schools_GetAllSchools20',\n",
-       " 'SchoolDigger_API_V2.0.Schools_GetSchool20']"
-      ]
-     },
-     "execution_count": 8,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "tools = get_tools(\"what shirts can i buy?\")\n",
-    "[t.name for t in tools]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2e7a075c",
-   "metadata": {},
-   "source": [
-    "## Prompt Template\n",
-    "\n",
-    "The prompt template is pretty standard, because we're not actually changing that much logic in the actual prompt template, but rather we are just changing how retrieval is done."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "339b1bb8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Set up the base template\n",
-    "template = \"\"\"Answer the following questions as best you can, but speaking as a pirate might speak. You have access to the following tools:\n",
-    "\n",
-    "{tools}\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 [{tool_names}]\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 \"Arg\"s\n",
-    "\n",
-    "Question: {input}\n",
-    "{agent_scratchpad}\"\"\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1583acdc",
-   "metadata": {},
-   "source": [
-    "The custom prompt template now has the concept of a tools_getter, which we call on the input to select the tools to use"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "fd969d31",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Callable\n",
-    "\n",
-    "\n",
-    "# Set up a prompt template\n",
-    "class CustomPromptTemplate(StringPromptTemplate):\n",
-    "    # The template to use\n",
-    "    template: str\n",
-    "    ############## NEW ######################\n",
-    "    # The list of tools available\n",
-    "    tools_getter: Callable\n",
-    "\n",
-    "    def format(self, **kwargs) -> str:\n",
-    "        # Get the intermediate steps (AgentAction, Observation tuples)\n",
-    "        # Format them in a particular way\n",
-    "        intermediate_steps = kwargs.pop(\"intermediate_steps\")\n",
-    "        thoughts = \"\"\n",
-    "        for action, observation in intermediate_steps:\n",
-    "            thoughts += action.log\n",
-    "            thoughts += f\"\\nObservation: {observation}\\nThought: \"\n",
-    "        # Set the agent_scratchpad variable to that value\n",
-    "        kwargs[\"agent_scratchpad\"] = thoughts\n",
-    "        ############## NEW ######################\n",
-    "        tools = self.tools_getter(kwargs[\"input\"])\n",
-    "        # Create a tools variable from the list of tools provided\n",
-    "        kwargs[\"tools\"] = \"\\n\".join(\n",
-    "            [f\"{tool.name}: {tool.description}\" for tool in tools]\n",
-    "        )\n",
-    "        # Create a list of tool names for the tools provided\n",
-    "        kwargs[\"tool_names\"] = \", \".join([tool.name for tool in tools])\n",
-    "        return self.template.format(**kwargs)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "798ef9fb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "prompt = CustomPromptTemplate(\n",
-    "    template=template,\n",
-    "    tools_getter=get_tools,\n",
-    "    # This omits the `agent_scratchpad`, `tools`, and `tool_names` variables because those are generated dynamically\n",
-    "    # This includes the `intermediate_steps` variable because that is needed\n",
-    "    input_variables=[\"input\", \"intermediate_steps\"],\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ef3a1af3",
-   "metadata": {},
-   "source": [
-    "## Output Parser\n",
-    "\n",
-    "The output parser is unchanged from the previous notebook, since we are not changing anything about the output format."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "7c6fe0d3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class CustomOutputParser(AgentOutputParser):\n",
-    "    def parse(self, llm_output: str) -> Union[AgentAction, AgentFinish]:\n",
-    "        # Check if agent should finish\n",
-    "        if \"Final Answer:\" in llm_output:\n",
-    "            return AgentFinish(\n",
-    "                # Return values is generally always a dictionary with a single `output` key\n",
-    "                # It is not recommended to try anything else at the moment :)\n",
-    "                return_values={\"output\": llm_output.split(\"Final Answer:\")[-1].strip()},\n",
-    "                log=llm_output,\n",
-    "            )\n",
-    "        # Parse out the action and action input\n",
-    "        regex = r\"Action\\s*\\d*\\s*:(.*?)\\nAction\\s*\\d*\\s*Input\\s*\\d*\\s*:[\\s]*(.*)\"\n",
-    "        match = re.search(regex, llm_output, re.DOTALL)\n",
-    "        if not match:\n",
-    "            raise ValueError(f\"Could not parse LLM output: `{llm_output}`\")\n",
-    "        action = match.group(1).strip()\n",
-    "        action_input = match.group(2)\n",
-    "        # Return the action and action input\n",
-    "        return AgentAction(\n",
-    "            tool=action, tool_input=action_input.strip(\" \").strip('\"'), log=llm_output\n",
-    "        )"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "d278706a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "output_parser = CustomOutputParser()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "170587b1",
-   "metadata": {},
-   "source": [
-    "## Set up LLM, stop sequence, and the agent\n",
-    "\n",
-    "Also the same as the previous notebook"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "f9d4c374",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "9b1cc2a2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# LLM chain consisting of the LLM and a prompt\n",
-    "llm_chain = LLMChain(llm=llm, prompt=prompt)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "e4f5092f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tool_names = [tool.name for tool in tools]\n",
-    "agent = LLMSingleActionAgent(\n",
-    "    llm_chain=llm_chain,\n",
-    "    output_parser=output_parser,\n",
-    "    stop=[\"\\nObservation:\"],\n",
-    "    allowed_tools=tool_names,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "aa8a5326",
-   "metadata": {},
-   "source": [
-    "## Use the Agent\n",
-    "\n",
-    "Now we can use it!"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "490604e9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent_executor = AgentExecutor.from_agent_and_tools(\n",
-    "    agent=agent, tools=tools, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 18,
-   "id": "653b1617",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: I need to find a product API\n",
-      "Action: Open_AI_Klarna_product_Api.productsUsingGET\n",
-      "Action Input: shirts\u001b[0m\n",
-      "\n",
-      "Observation:\u001b[36;1m\u001b[1;3mI found 10 shirts from the API response. They range in price from $9.99 to $450.00 and come in a variety of materials, colors, and patterns.\u001b[0m\u001b[32;1m\u001b[1;3m I now know what shirts I can buy\n",
-      "Final Answer: Arg, I found 10 shirts from the API response. They range in price from $9.99 to $450.00 and come in a variety of materials, colors, and patterns.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Arg, I found 10 shirts from the API response. They range in price from $9.99 to $450.00 and come in a variety of materials, colors, and patterns.'"
-      ]
-     },
-     "execution_count": 18,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent_executor.run(\"what shirts can i buy?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2481ee76",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "18784188d7ecd866c0586ac068b02361a6896dc3a29b64f5cc957f09c590acef"
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/custom_agent_with_plugin_retrieval_using_plugnplai.ipynb

@@ -1,578 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "ba5f8741",
-   "metadata": {},
-   "source": [
-    "# Plug-and-Plai\n",
-    "\n",
-    "This notebook builds upon the idea of [plugin retrieval](./custom_agent_with_plugin_retrieval.html), but pulls all tools from `plugnplai` - a directory of AI Plugins."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fea4812c",
-   "metadata": {},
-   "source": [
-    "## Set up environment\n",
-    "\n",
-    "Do necessary imports, etc."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "aca08be8",
-   "metadata": {},
-   "source": [
-    "Install plugnplai lib to get a list of active plugins from https://plugplai.com directory"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "52e248c9",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m A new release of pip available: \u001b[0m\u001b[31;49m22.3.1\u001b[0m\u001b[39;49m -> \u001b[0m\u001b[32;49m23.1.1\u001b[0m\n",
-      "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m To update, run: \u001b[0m\u001b[32;49mpip install --upgrade pip\u001b[0m\n",
-      "Note: you may need to restart the kernel to use updated packages.\n"
-     ]
-    }
-   ],
-   "source": [
-    "pip install plugnplai -q"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "9af9734e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import re\n",
-    "from typing import Union\n",
-    "\n",
-    "import plugnplai\n",
-    "from langchain.agents import (\n",
-    "    AgentExecutor,\n",
-    "    AgentOutputParser,\n",
-    "    LLMSingleActionAgent,\n",
-    ")\n",
-    "from langchain.chains import LLMChain\n",
-    "from langchain.prompts import StringPromptTemplate\n",
-    "from langchain_community.agent_toolkits import NLAToolkit\n",
-    "from langchain_community.tools.plugin import AIPlugin\n",
-    "from langchain_core.agents import AgentAction, AgentFinish\n",
-    "from langchain_openai import OpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2f91d8b4",
-   "metadata": {},
-   "source": [
-    "## Setup LLM"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "a1a3b59c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "6df0253f",
-   "metadata": {},
-   "source": [
-    "## Set up plugins\n",
-    "\n",
-    "Load and index plugins"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "9e0f7882",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Get all plugins from plugnplai.com\n",
-    "urls = plugnplai.get_plugins()\n",
-    "\n",
-    "#  Get ChatGPT plugins - only ChatGPT verified plugins\n",
-    "urls = plugnplai.get_plugins(filter=\"ChatGPT\")\n",
-    "\n",
-    "#  Get working plugins - only tested plugins (in progress)\n",
-    "urls = plugnplai.get_plugins(filter=\"working\")\n",
-    "\n",
-    "\n",
-    "AI_PLUGINS = [AIPlugin.from_url(url + \"/.well-known/ai-plugin.json\") for url in urls]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "17362717",
-   "metadata": {},
-   "source": [
-    "## Tool Retriever\n",
-    "\n",
-    "We will use a vectorstore to create embeddings for each tool description. Then, for an incoming query we can create embeddings for that query and do a similarity search for relevant tools."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "77c4be4b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_community.vectorstores import FAISS\n",
-    "from langchain_core.documents import Document\n",
-    "from langchain_openai import OpenAIEmbeddings"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "9092a158",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.2 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load an OpenAPI 3.0.1 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n",
-      "Attempting to load a Swagger 2.0 spec.  This may result in degraded performance. Convert your OpenAPI spec to 3.1.* spec for better support.\n"
-     ]
-    }
-   ],
-   "source": [
-    "embeddings = OpenAIEmbeddings()\n",
-    "docs = [\n",
-    "    Document(\n",
-    "        page_content=plugin.description_for_model,\n",
-    "        metadata={\"plugin_name\": plugin.name_for_model},\n",
-    "    )\n",
-    "    for plugin in AI_PLUGINS\n",
-    "]\n",
-    "vector_store = FAISS.from_documents(docs, embeddings)\n",
-    "toolkits_dict = {\n",
-    "    plugin.name_for_model: NLAToolkit.from_llm_and_ai_plugin(llm, plugin)\n",
-    "    for plugin in AI_PLUGINS\n",
-    "}"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "735a7566",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "retriever = vector_store.as_retriever()\n",
-    "\n",
-    "\n",
-    "def get_tools(query):\n",
-    "    # Get documents, which contain the Plugins to use\n",
-    "    docs = retriever.invoke(query)\n",
-    "    # Get the toolkits, one for each plugin\n",
-    "    tool_kits = [toolkits_dict[d.metadata[\"plugin_name\"]] for d in docs]\n",
-    "    # Get the tools: a separate NLAChain for each endpoint\n",
-    "    tools = []\n",
-    "    for tk in tool_kits:\n",
-    "        tools.extend(tk.nla_tools)\n",
-    "    return tools"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "7699afd7",
-   "metadata": {},
-   "source": [
-    "We can now test this retriever to see if it seems to work."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "425f2886",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "['Milo.askMilo',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.search_all_actions',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.preview_a_zap',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.get_configuration_link',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.list_exposed_actions',\n",
-       " 'SchoolDigger_API_V2.0.Autocomplete_GetSchools',\n",
-       " 'SchoolDigger_API_V2.0.Districts_GetAllDistricts2',\n",
-       " 'SchoolDigger_API_V2.0.Districts_GetDistrict2',\n",
-       " 'SchoolDigger_API_V2.0.Rankings_GetSchoolRank2',\n",
-       " 'SchoolDigger_API_V2.0.Rankings_GetRank_District',\n",
-       " 'SchoolDigger_API_V2.0.Schools_GetAllSchools20',\n",
-       " 'SchoolDigger_API_V2.0.Schools_GetSchool20',\n",
-       " 'Speak.translate',\n",
-       " 'Speak.explainPhrase',\n",
-       " 'Speak.explainTask']"
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "tools = get_tools(\"What could I do today with my kiddo\")\n",
-    "[t.name for t in tools]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "3aa88768",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "['Open_AI_Klarna_product_Api.productsUsingGET',\n",
-       " 'Milo.askMilo',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.search_all_actions',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.preview_a_zap',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.get_configuration_link',\n",
-       " 'Zapier_Natural_Language_Actions_(NLA)_API_(Dynamic)_-_Beta.list_exposed_actions',\n",
-       " 'SchoolDigger_API_V2.0.Autocomplete_GetSchools',\n",
-       " 'SchoolDigger_API_V2.0.Districts_GetAllDistricts2',\n",
-       " 'SchoolDigger_API_V2.0.Districts_GetDistrict2',\n",
-       " 'SchoolDigger_API_V2.0.Rankings_GetSchoolRank2',\n",
-       " 'SchoolDigger_API_V2.0.Rankings_GetRank_District',\n",
-       " 'SchoolDigger_API_V2.0.Schools_GetAllSchools20',\n",
-       " 'SchoolDigger_API_V2.0.Schools_GetSchool20']"
-      ]
-     },
-     "execution_count": 8,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "tools = get_tools(\"what shirts can i buy?\")\n",
-    "[t.name for t in tools]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2e7a075c",
-   "metadata": {},
-   "source": [
-    "## Prompt Template\n",
-    "\n",
-    "The prompt template is pretty standard, because we're not actually changing that much logic in the actual prompt template, but rather we are just changing how retrieval is done."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "339b1bb8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Set up the base template\n",
-    "template = \"\"\"Answer the following questions as best you can, but speaking as a pirate might speak. You have access to the following tools:\n",
-    "\n",
-    "{tools}\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 [{tool_names}]\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 \"Arg\"s\n",
-    "\n",
-    "Question: {input}\n",
-    "{agent_scratchpad}\"\"\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1583acdc",
-   "metadata": {},
-   "source": [
-    "The custom prompt template now has the concept of a tools_getter, which we call on the input to select the tools to use"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "fd969d31",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Callable\n",
-    "\n",
-    "\n",
-    "# Set up a prompt template\n",
-    "class CustomPromptTemplate(StringPromptTemplate):\n",
-    "    # The template to use\n",
-    "    template: str\n",
-    "    ############## NEW ######################\n",
-    "    # The list of tools available\n",
-    "    tools_getter: Callable\n",
-    "\n",
-    "    def format(self, **kwargs) -> str:\n",
-    "        # Get the intermediate steps (AgentAction, Observation tuples)\n",
-    "        # Format them in a particular way\n",
-    "        intermediate_steps = kwargs.pop(\"intermediate_steps\")\n",
-    "        thoughts = \"\"\n",
-    "        for action, observation in intermediate_steps:\n",
-    "            thoughts += action.log\n",
-    "            thoughts += f\"\\nObservation: {observation}\\nThought: \"\n",
-    "        # Set the agent_scratchpad variable to that value\n",
-    "        kwargs[\"agent_scratchpad\"] = thoughts\n",
-    "        ############## NEW ######################\n",
-    "        tools = self.tools_getter(kwargs[\"input\"])\n",
-    "        # Create a tools variable from the list of tools provided\n",
-    "        kwargs[\"tools\"] = \"\\n\".join(\n",
-    "            [f\"{tool.name}: {tool.description}\" for tool in tools]\n",
-    "        )\n",
-    "        # Create a list of tool names for the tools provided\n",
-    "        kwargs[\"tool_names\"] = \", \".join([tool.name for tool in tools])\n",
-    "        return self.template.format(**kwargs)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "798ef9fb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "prompt = CustomPromptTemplate(\n",
-    "    template=template,\n",
-    "    tools_getter=get_tools,\n",
-    "    # This omits the `agent_scratchpad`, `tools`, and `tool_names` variables because those are generated dynamically\n",
-    "    # This includes the `intermediate_steps` variable because that is needed\n",
-    "    input_variables=[\"input\", \"intermediate_steps\"],\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ef3a1af3",
-   "metadata": {},
-   "source": [
-    "## Output Parser\n",
-    "\n",
-    "The output parser is unchanged from the previous notebook, since we are not changing anything about the output format."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "7c6fe0d3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class CustomOutputParser(AgentOutputParser):\n",
-    "    def parse(self, llm_output: str) -> Union[AgentAction, AgentFinish]:\n",
-    "        # Check if agent should finish\n",
-    "        if \"Final Answer:\" in llm_output:\n",
-    "            return AgentFinish(\n",
-    "                # Return values is generally always a dictionary with a single `output` key\n",
-    "                # It is not recommended to try anything else at the moment :)\n",
-    "                return_values={\"output\": llm_output.split(\"Final Answer:\")[-1].strip()},\n",
-    "                log=llm_output,\n",
-    "            )\n",
-    "        # Parse out the action and action input\n",
-    "        regex = r\"Action\\s*\\d*\\s*:(.*?)\\nAction\\s*\\d*\\s*Input\\s*\\d*\\s*:[\\s]*(.*)\"\n",
-    "        match = re.search(regex, llm_output, re.DOTALL)\n",
-    "        if not match:\n",
-    "            raise ValueError(f\"Could not parse LLM output: `{llm_output}`\")\n",
-    "        action = match.group(1).strip()\n",
-    "        action_input = match.group(2)\n",
-    "        # Return the action and action input\n",
-    "        return AgentAction(\n",
-    "            tool=action, tool_input=action_input.strip(\" \").strip('\"'), log=llm_output\n",
-    "        )"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "d278706a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "output_parser = CustomOutputParser()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "170587b1",
-   "metadata": {},
-   "source": [
-    "## Set up LLM, stop sequence, and the agent\n",
-    "\n",
-    "Also the same as the previous notebook"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "f9d4c374",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "9b1cc2a2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# LLM chain consisting of the LLM and a prompt\n",
-    "llm_chain = LLMChain(llm=llm, prompt=prompt)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "e4f5092f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tool_names = [tool.name for tool in tools]\n",
-    "agent = LLMSingleActionAgent(\n",
-    "    llm_chain=llm_chain,\n",
-    "    output_parser=output_parser,\n",
-    "    stop=[\"\\nObservation:\"],\n",
-    "    allowed_tools=tool_names,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "aa8a5326",
-   "metadata": {},
-   "source": [
-    "## Use the Agent\n",
-    "\n",
-    "Now we can use it!"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "490604e9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent_executor = AgentExecutor.from_agent_and_tools(\n",
-    "    agent=agent, tools=tools, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 18,
-   "id": "653b1617",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: I need to find a product API\n",
-      "Action: Open_AI_Klarna_product_Api.productsUsingGET\n",
-      "Action Input: shirts\u001b[0m\n",
-      "\n",
-      "Observation:\u001b[36;1m\u001b[1;3mI found 10 shirts from the API response. They range in price from $9.99 to $450.00 and come in a variety of materials, colors, and patterns.\u001b[0m\u001b[32;1m\u001b[1;3m I now know what shirts I can buy\n",
-      "Final Answer: Arg, I found 10 shirts from the API response. They range in price from $9.99 to $450.00 and come in a variety of materials, colors, and patterns.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Arg, I found 10 shirts from the API response. They range in price from $9.99 to $450.00 and come in a variety of materials, colors, and patterns.'"
-      ]
-     },
-     "execution_count": 18,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent_executor.run(\"what shirts can i buy?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2481ee76",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "3ccef4e08d87aa1eeb90f63e0f071292ccb2e9c42e70f74ab2bf6f5493ca7bbc"
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/custom_agent_with_tool_retrieval.ipynb

@@ -1,500 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "ba5f8741",
-   "metadata": {},
-   "source": [
-    "# Custom agent with tool retrieval\n",
-    "\n",
-    "The novel idea introduced in this notebook is the idea of using retrieval to select the set of tools to use to answer an agent query. This is useful when you have many many tools to select from. You cannot put the description of all the tools in the prompt (because of context length issues) so instead you dynamically select the N tools you do want to consider using at run time.\n",
-    "\n",
-    "In this notebook we will create a somewhat contrived example. We will have one legitimate tool (search) and then 99 fake tools which are just nonsense. We will then add a step in the prompt template that takes the user input and retrieves tool relevant to the query."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fea4812c",
-   "metadata": {},
-   "source": [
-    "## Set up environment\n",
-    "\n",
-    "Do necessary imports, etc."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "9af9734e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import re\n",
-    "from typing import Union\n",
-    "\n",
-    "from langchain.agents import (\n",
-    "    AgentExecutor,\n",
-    "    AgentOutputParser,\n",
-    "    LLMSingleActionAgent,\n",
-    "    Tool,\n",
-    ")\n",
-    "from langchain.chains import LLMChain\n",
-    "from langchain.prompts import StringPromptTemplate\n",
-    "from langchain_community.utilities import SerpAPIWrapper\n",
-    "from langchain_core.agents import AgentAction, AgentFinish\n",
-    "from langchain_openai import OpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "6df0253f",
-   "metadata": {},
-   "source": [
-    "## Set up tools\n",
-    "\n",
-    "We will create one legitimate tool (search) and then 99 fake tools."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "becda2a1",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Define which tools the agent can use to answer user queries\n",
-    "search = SerpAPIWrapper()\n",
-    "search_tool = Tool(\n",
-    "    name=\"Search\",\n",
-    "    func=search.run,\n",
-    "    description=\"useful for when you need to answer questions about current events\",\n",
-    ")\n",
-    "\n",
-    "\n",
-    "def fake_func(inp: str) -> str:\n",
-    "    return \"foo\"\n",
-    "\n",
-    "\n",
-    "fake_tools = [\n",
-    "    Tool(\n",
-    "        name=f\"foo-{i}\",\n",
-    "        func=fake_func,\n",
-    "        description=f\"a silly function that you can use to get more information about the number {i}\",\n",
-    "    )\n",
-    "    for i in range(99)\n",
-    "]\n",
-    "ALL_TOOLS = [search_tool] + fake_tools"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "17362717",
-   "metadata": {},
-   "source": [
-    "## Tool Retriever\n",
-    "\n",
-    "We will use a vector store to create embeddings for each tool description. Then, for an incoming query we can create embeddings for that query and do a similarity search for relevant tools."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "77c4be4b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_community.vectorstores import FAISS\n",
-    "from langchain_core.documents import Document\n",
-    "from langchain_openai import OpenAIEmbeddings"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "9092a158",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "docs = [\n",
-    "    Document(page_content=t.description, metadata={\"index\": i})\n",
-    "    for i, t in enumerate(ALL_TOOLS)\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "affc4e56",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "vector_store = FAISS.from_documents(docs, OpenAIEmbeddings())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 18,
-   "id": "735a7566",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "retriever = vector_store.as_retriever()\n",
-    "\n",
-    "\n",
-    "def get_tools(query):\n",
-    "    docs = retriever.invoke(query)\n",
-    "    return [ALL_TOOLS[d.metadata[\"index\"]] for d in docs]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "7699afd7",
-   "metadata": {},
-   "source": [
-    "We can now test this retriever to see if it seems to work."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 19,
-   "id": "425f2886",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[Tool(name='Search', description='useful for when you need to answer questions about current events', return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x114b28a90>, func=<bound method SerpAPIWrapper.run of SerpAPIWrapper(search_engine=<class 'serpapi.google_search.GoogleSearch'>, params={'engine': 'google', 'google_domain': 'google.com', 'gl': 'us', 'hl': 'en'}, serpapi_api_key='', aiosession=None)>, coroutine=None),\n",
-       " Tool(name='foo-95', description='a silly function that you can use to get more information about the number 95', return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x114b28a90>, func=<function fake_func at 0x15e5bd1f0>, coroutine=None),\n",
-       " Tool(name='foo-12', description='a silly function that you can use to get more information about the number 12', return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x114b28a90>, func=<function fake_func at 0x15e5bd1f0>, coroutine=None),\n",
-       " Tool(name='foo-15', description='a silly function that you can use to get more information about the number 15', return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x114b28a90>, func=<function fake_func at 0x15e5bd1f0>, coroutine=None)]"
-      ]
-     },
-     "execution_count": 19,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "get_tools(\"whats the weather?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 20,
-   "id": "4036dd19",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[Tool(name='foo-13', description='a silly function that you can use to get more information about the number 13', return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x114b28a90>, func=<function fake_func at 0x15e5bd1f0>, coroutine=None),\n",
-       " Tool(name='foo-12', description='a silly function that you can use to get more information about the number 12', return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x114b28a90>, func=<function fake_func at 0x15e5bd1f0>, coroutine=None),\n",
-       " Tool(name='foo-14', description='a silly function that you can use to get more information about the number 14', return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x114b28a90>, func=<function fake_func at 0x15e5bd1f0>, coroutine=None),\n",
-       " Tool(name='foo-11', description='a silly function that you can use to get more information about the number 11', return_direct=False, verbose=False, callback_manager=<langchain.callbacks.shared.SharedCallbackManager object at 0x114b28a90>, func=<function fake_func at 0x15e5bd1f0>, coroutine=None)]"
-      ]
-     },
-     "execution_count": 20,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "get_tools(\"whats the number 13?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2e7a075c",
-   "metadata": {},
-   "source": [
-    "## Prompt template\n",
-    "\n",
-    "The prompt template is pretty standard, because we're not actually changing that much logic in the actual prompt template, but rather we are just changing how retrieval is done."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 21,
-   "id": "339b1bb8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Set up the base template\n",
-    "template = \"\"\"Answer the following questions as best you can, but speaking as a pirate might speak. You have access to the following tools:\n",
-    "\n",
-    "{tools}\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 [{tool_names}]\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 \"Arg\"s\n",
-    "\n",
-    "Question: {input}\n",
-    "{agent_scratchpad}\"\"\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1583acdc",
-   "metadata": {},
-   "source": [
-    "The custom prompt template now has the concept of a `tools_getter`, which we call on the input to select the tools to use."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 52,
-   "id": "fd969d31",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Callable\n",
-    "\n",
-    "\n",
-    "# Set up a prompt template\n",
-    "class CustomPromptTemplate(StringPromptTemplate):\n",
-    "    # The template to use\n",
-    "    template: str\n",
-    "    ############## NEW ######################\n",
-    "    # The list of tools available\n",
-    "    tools_getter: Callable\n",
-    "\n",
-    "    def format(self, **kwargs) -> str:\n",
-    "        # Get the intermediate steps (AgentAction, Observation tuples)\n",
-    "        # Format them in a particular way\n",
-    "        intermediate_steps = kwargs.pop(\"intermediate_steps\")\n",
-    "        thoughts = \"\"\n",
-    "        for action, observation in intermediate_steps:\n",
-    "            thoughts += action.log\n",
-    "            thoughts += f\"\\nObservation: {observation}\\nThought: \"\n",
-    "        # Set the agent_scratchpad variable to that value\n",
-    "        kwargs[\"agent_scratchpad\"] = thoughts\n",
-    "        ############## NEW ######################\n",
-    "        tools = self.tools_getter(kwargs[\"input\"])\n",
-    "        # Create a tools variable from the list of tools provided\n",
-    "        kwargs[\"tools\"] = \"\\n\".join(\n",
-    "            [f\"{tool.name}: {tool.description}\" for tool in tools]\n",
-    "        )\n",
-    "        # Create a list of tool names for the tools provided\n",
-    "        kwargs[\"tool_names\"] = \", \".join([tool.name for tool in tools])\n",
-    "        return self.template.format(**kwargs)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 53,
-   "id": "798ef9fb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "prompt = CustomPromptTemplate(\n",
-    "    template=template,\n",
-    "    tools_getter=get_tools,\n",
-    "    # This omits the `agent_scratchpad`, `tools`, and `tool_names` variables because those are generated dynamically\n",
-    "    # This includes the `intermediate_steps` variable because that is needed\n",
-    "    input_variables=[\"input\", \"intermediate_steps\"],\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ef3a1af3",
-   "metadata": {},
-   "source": [
-    "## Output parser\n",
-    "\n",
-    "The output parser is unchanged from the previous notebook, since we are not changing anything about the output format."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 54,
-   "id": "7c6fe0d3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class CustomOutputParser(AgentOutputParser):\n",
-    "    def parse(self, llm_output: str) -> Union[AgentAction, AgentFinish]:\n",
-    "        # Check if agent should finish\n",
-    "        if \"Final Answer:\" in llm_output:\n",
-    "            return AgentFinish(\n",
-    "                # Return values is generally always a dictionary with a single `output` key\n",
-    "                # It is not recommended to try anything else at the moment :)\n",
-    "                return_values={\"output\": llm_output.split(\"Final Answer:\")[-1].strip()},\n",
-    "                log=llm_output,\n",
-    "            )\n",
-    "        # Parse out the action and action input\n",
-    "        regex = r\"Action\\s*\\d*\\s*:(.*?)\\nAction\\s*\\d*\\s*Input\\s*\\d*\\s*:[\\s]*(.*)\"\n",
-    "        match = re.search(regex, llm_output, re.DOTALL)\n",
-    "        if not match:\n",
-    "            raise ValueError(f\"Could not parse LLM output: `{llm_output}`\")\n",
-    "        action = match.group(1).strip()\n",
-    "        action_input = match.group(2)\n",
-    "        # Return the action and action input\n",
-    "        return AgentAction(\n",
-    "            tool=action, tool_input=action_input.strip(\" \").strip('\"'), log=llm_output\n",
-    "        )"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 55,
-   "id": "d278706a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "output_parser = CustomOutputParser()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "170587b1",
-   "metadata": {},
-   "source": [
-    "## Set up LLM, stop sequence, and the agent\n",
-    "\n",
-    "Also the same as the previous notebook."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 56,
-   "id": "f9d4c374",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 57,
-   "id": "9b1cc2a2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# LLM chain consisting of the LLM and a prompt\n",
-    "llm_chain = LLMChain(llm=llm, prompt=prompt)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 58,
-   "id": "e4f5092f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = get_tools(\"whats the weather?\")\n",
-    "tool_names = [tool.name for tool in tools]\n",
-    "agent = LLMSingleActionAgent(\n",
-    "    llm_chain=llm_chain,\n",
-    "    output_parser=output_parser,\n",
-    "    stop=[\"\\nObservation:\"],\n",
-    "    allowed_tools=tool_names,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "aa8a5326",
-   "metadata": {},
-   "source": [
-    "## Use the Agent\n",
-    "\n",
-    "Now we can use it!"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 59,
-   "id": "490604e9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent_executor = AgentExecutor.from_agent_and_tools(\n",
-    "    agent=agent, tools=tools, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 60,
-   "id": "653b1617",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: I need to find out what the weather is in SF\n",
-      "Action: Search\n",
-      "Action Input: Weather in SF\u001b[0m\n",
-      "\n",
-      "Observation:\u001b[36;1m\u001b[1;3mMostly cloudy skies early, then partly cloudy in the afternoon. High near 60F. ENE winds shifting to W at 10 to 15 mph. Humidity71%. UV Index6 of 10.\u001b[0m\u001b[32;1m\u001b[1;3m I now know the final answer\n",
-      "Final Answer: 'Arg, 'tis mostly cloudy skies early, then partly cloudy in the afternoon. High near 60F. ENE winds shiftin' to W at 10 to 15 mph. Humidity71%. UV Index6 of 10.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "\"'Arg, 'tis mostly cloudy skies early, then partly cloudy in the afternoon. High near 60F. ENE winds shiftin' to W at 10 to 15 mph. Humidity71%. UV Index6 of 10.\""
-      ]
-     },
-     "execution_count": 60,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent_executor.run(\"What's the weather in SF?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2481ee76",
-   "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.1"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "18784188d7ecd866c0586ac068b02361a6896dc3a29b64f5cc957f09c590acef"
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/custom_multi_action_agent.ipynb

@@ -1,220 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "ba5f8741",
-   "metadata": {},
-   "source": [
-    "# Custom multi-action agent\n",
-    "\n",
-    "This notebook goes through how to create your own custom agent.\n",
-    "\n",
-    "An agent consists of two parts:\n",
-    "\n",
-    "- Tools: The tools the agent has available to use.\n",
-    "- The agent class itself: this decides which action to take.\n",
-    "        \n",
-    "        \n",
-    "In this notebook we walk through how to create a custom agent that predicts/takes multiple steps at a time."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "9af9734e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import AgentExecutor, BaseMultiActionAgent, Tool\n",
-    "from langchain_community.utilities import SerpAPIWrapper"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "d7c4ebdc",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def random_word(query: str) -> str:\n",
-    "    print(\"\\nNow I'm doing this!\")\n",
-    "    return \"foo\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "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",
-    "    Tool(\n",
-    "        name=\"RandomWord\",\n",
-    "        func=random_word,\n",
-    "        description=\"call this to get a random word.\",\n",
-    "    ),\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "a33e2f7e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Any, List, Tuple, Union\n",
-    "\n",
-    "from langchain_core.agents import AgentAction, AgentFinish\n",
-    "\n",
-    "\n",
-    "class FakeAgent(BaseMultiActionAgent):\n",
-    "    \"\"\"Fake Custom Agent.\"\"\"\n",
-    "\n",
-    "    @property\n",
-    "    def input_keys(self):\n",
-    "        return [\"input\"]\n",
-    "\n",
-    "    def plan(\n",
-    "        self, intermediate_steps: List[Tuple[AgentAction, str]], **kwargs: Any\n",
-    "    ) -> Union[List[AgentAction], AgentFinish]:\n",
-    "        \"\"\"Given input, decided what to do.\n",
-    "\n",
-    "        Args:\n",
-    "            intermediate_steps: Steps the LLM has taken to date,\n",
-    "                along with observations\n",
-    "            **kwargs: User inputs.\n",
-    "\n",
-    "        Returns:\n",
-    "            Action specifying what tool to use.\n",
-    "        \"\"\"\n",
-    "        if len(intermediate_steps) == 0:\n",
-    "            return [\n",
-    "                AgentAction(tool=\"Search\", tool_input=kwargs[\"input\"], log=\"\"),\n",
-    "                AgentAction(tool=\"RandomWord\", tool_input=kwargs[\"input\"], log=\"\"),\n",
-    "            ]\n",
-    "        else:\n",
-    "            return AgentFinish(return_values={\"output\": \"bar\"}, log=\"\")\n",
-    "\n",
-    "    async def aplan(\n",
-    "        self, intermediate_steps: List[Tuple[AgentAction, str]], **kwargs: Any\n",
-    "    ) -> Union[List[AgentAction], AgentFinish]:\n",
-    "        \"\"\"Given input, decided what to do.\n",
-    "\n",
-    "        Args:\n",
-    "            intermediate_steps: Steps the LLM has taken to date,\n",
-    "                along with observations\n",
-    "            **kwargs: User inputs.\n",
-    "\n",
-    "        Returns:\n",
-    "            Action specifying what tool to use.\n",
-    "        \"\"\"\n",
-    "        if len(intermediate_steps) == 0:\n",
-    "            return [\n",
-    "                AgentAction(tool=\"Search\", tool_input=kwargs[\"input\"], log=\"\"),\n",
-    "                AgentAction(tool=\"RandomWord\", tool_input=kwargs[\"input\"], log=\"\"),\n",
-    "            ]\n",
-    "        else:\n",
-    "            return AgentFinish(return_values={\"output\": \"bar\"}, log=\"\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "655d72f6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = FakeAgent()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "490604e9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent_executor = AgentExecutor.from_agent_and_tools(\n",
-    "    agent=agent, tools=tools, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "653b1617",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m\u001b[0m\u001b[36;1m\u001b[1;3mThe current population of Canada is 38,669,152 as of Monday, April 24, 2023, based on Worldometer elaboration of the latest United Nations data.\u001b[0m\u001b[32;1m\u001b[1;3m\u001b[0m\n",
-      "Now I'm doing this!\n",
-      "\u001b[33;1m\u001b[1;3mfoo\u001b[0m\u001b[32;1m\u001b[1;3m\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'bar'"
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent_executor.run(\"How many people live in canada as of 2023?\")"
-   ]
-  },
-  {
-   "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.11.3"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "18784188d7ecd866c0586ac068b02361a6896dc3a29b64f5cc957f09c590acef"
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/deeplake_semantic_search_over_chat.ipynb

@@ -1,255 +0,0 @@
-{
- "cells": [
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# QA using Activeloop's DeepLake\n",
-    "In this tutorial, we are going to use Langchain + Activeloop's Deep Lake with GPT4 to semantically search and ask questions over a group chat.\n",
-    "\n",
-    "View a working demo [here](https://twitter.com/thisissukh_/status/1647223328363679745)"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## 1. Install required packages"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!python3 -m pip install --upgrade langchain 'deeplake[enterprise]' openai tiktoken"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## 2. Add API keys"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": []
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import getpass\n",
-    "import os\n",
-    "\n",
-    "from langchain.chains import RetrievalQA\n",
-    "from langchain_community.vectorstores import DeepLake\n",
-    "from langchain_openai import OpenAI, OpenAIEmbeddings\n",
-    "from langchain_text_splitters import (\n",
-    "    CharacterTextSplitter,\n",
-    "    RecursiveCharacterTextSplitter,\n",
-    ")\n",
-    "\n",
-    "os.environ[\"OPENAI_API_KEY\"] = getpass.getpass(\"OpenAI API Key:\")\n",
-    "activeloop_token = getpass.getpass(\"Activeloop Token:\")\n",
-    "os.environ[\"ACTIVELOOP_TOKEN\"] = activeloop_token\n",
-    "os.environ[\"ACTIVELOOP_ORG\"] = getpass.getpass(\"Activeloop Org:\")\n",
-    "\n",
-    "org_id = os.environ[\"ACTIVELOOP_ORG\"]\n",
-    "embeddings = OpenAIEmbeddings()\n",
-    "\n",
-    "dataset_path = \"hub://\" + org_id + \"/data\""
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "\n",
-    "\n",
-    "## 2. Create sample data"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can generate a sample group chat conversation using ChatGPT with this prompt:\n",
-    "\n",
-    "```\n",
-    "Generate a group chat conversation with three friends talking about their day, referencing real places and fictional names. Make it funny and as detailed as possible.\n",
-    "```\n",
-    "\n",
-    "I've already generated such a chat in `messages.txt`. We can keep it simple and use this for our example.\n",
-    "\n",
-    "## 3. Ingest chat embeddings\n",
-    "\n",
-    "We load the messages in the text file, chunk and upload to ActiveLoop Vector store."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "[Document(page_content='Participants:\\n\\nJerry: Loves movies and is a bit of a klutz.\\nSamantha: Enthusiastic about food and always trying new restaurants.\\nBarry: A nature lover, but always manages to get lost.\\nJerry: Hey, guys! You won\\'t believe what happened to me at the Times Square AMC theater. I tripped over my own feet and spilled popcorn everywhere! 🍿💥\\n\\nSamantha: LOL, that\\'s so you, Jerry! Was the floor buttery enough for you to ice skate on after that? 😂\\n\\nBarry: Sounds like a regular Tuesday for you, Jerry. Meanwhile, I tried to find that new hiking trail in Central Park. You know, the one that\\'s supposed to be impossible to get lost on? Well, guess what...\\n\\nJerry: You found a hidden treasure?\\n\\nBarry: No, I got lost. AGAIN. 🧭🙄\\n\\nSamantha: Barry, you\\'d get lost in your own backyard! But speaking of treasures, I found this new sushi place in Little Tokyo. \"Samantha\\'s Sushi Symphony\" it\\'s called. Coincidence? I think not!\\n\\nJerry: Maybe they named it after your ability to eat your body weight in sushi. 🍣', metadata={}), Document(page_content='Barry: How do you even FIND all these places, Samantha?\\n\\nSamantha: Simple, I don\\'t rely on Barry\\'s navigation skills. 😉 But seriously, the wasabi there was hotter than Jerry\\'s love for Marvel movies!\\n\\nJerry: Hey, nothing wrong with a little superhero action. By the way, did you guys see the new \"Captain Crunch: Breakfast Avenger\" trailer?\\n\\nSamantha: Captain Crunch? Are you sure you didn\\'t get that from one of your Saturday morning cereal binges?\\n\\nBarry: Yeah, and did he defeat his arch-enemy, General Mills? 😆\\n\\nJerry: Ha-ha, very funny. Anyway, that sushi place sounds awesome, Samantha. Next time, let\\'s go together, and maybe Barry can guide us... if we want a city-wide tour first.\\n\\nBarry: As long as we\\'re not hiking, I\\'ll get us there... eventually. 😅\\n\\nSamantha: It\\'s a date! But Jerry, you\\'re banned from carrying any food items.\\n\\nJerry: Deal! Just promise me no wasabi challenges. I don\\'t want to end up like the time I tried Sriracha ice cream.', metadata={}), Document(page_content=\"Barry: Wait, what happened with Sriracha ice cream?\\n\\nJerry: Let's just say it was a hot situation. Literally. 🔥\\n\\nSamantha: 🤣 I still have the video!\\n\\nJerry: Samantha, if you value our friendship, that video will never see the light of day.\\n\\nSamantha: No promises, Jerry. No promises. 🤐😈\\n\\nBarry: I foresee a fun weekend ahead! 🎉\", metadata={})]\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Your Deep Lake dataset has been successfully created!\n"
-     ]
-    },
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "\\"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Dataset(path='hub://adilkhan/data', tensors=['embedding', 'id', 'metadata', 'text'])\n",
-      "\n",
-      "  tensor      htype      shape     dtype  compression\n",
-      "  -------    -------    -------   -------  ------- \n",
-      " embedding  embedding  (3, 1536)  float32   None   \n",
-      "    id        text      (3, 1)      str     None   \n",
-      " metadata     json      (3, 1)      str     None   \n",
-      "   text       text      (3, 1)      str     None   \n"
-     ]
-    },
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      " \r"
-     ]
-    }
-   ],
-   "source": [
-    "with open(\"messages.txt\") as f:\n",
-    "    state_of_the_union = f.read()\n",
-    "text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)\n",
-    "pages = text_splitter.split_text(state_of_the_union)\n",
-    "\n",
-    "text_splitter = RecursiveCharacterTextSplitter(chunk_size=1000, chunk_overlap=100)\n",
-    "texts = text_splitter.create_documents(pages)\n",
-    "\n",
-    "print(texts)\n",
-    "\n",
-    "dataset_path = \"hub://\" + org_id + \"/data\"\n",
-    "embeddings = OpenAIEmbeddings()\n",
-    "db = DeepLake.from_documents(\n",
-    "    texts, embeddings, dataset_path=dataset_path, overwrite=True\n",
-    ")"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "`Optional`: You can also use Deep Lake's Managed Tensor Database as a hosting service and run queries there. In order to do so, it is necessary to specify the runtime parameter as {'tensor_db': True} during the creation of the vector store. This configuration enables the execution of queries on the Managed Tensor Database, rather than on the client side. It should be noted that this functionality is not applicable to datasets stored locally or in-memory. In the event that a vector store has already been created outside of the Managed Tensor Database, it is possible to transfer it to the Managed Tensor Database by following the prescribed steps."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# with open(\"messages.txt\") as f:\n",
-    "#     state_of_the_union = f.read()\n",
-    "# text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)\n",
-    "# pages = text_splitter.split_text(state_of_the_union)\n",
-    "\n",
-    "# text_splitter = RecursiveCharacterTextSplitter(chunk_size=1000, chunk_overlap=100)\n",
-    "# texts = text_splitter.create_documents(pages)\n",
-    "\n",
-    "# print(texts)\n",
-    "\n",
-    "# dataset_path = \"hub://\" + org + \"/data\"\n",
-    "# embeddings = OpenAIEmbeddings()\n",
-    "# db = DeepLake.from_documents(\n",
-    "#     texts, embeddings, dataset_path=dataset_path, overwrite=True, runtime={\"tensor_db\": True}\n",
-    "# )"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## 4. Ask questions\n",
-    "\n",
-    "Now we can ask a question and get an answer back with a semantic search:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "db = DeepLake(dataset_path=dataset_path, read_only=True, embedding=embeddings)\n",
-    "\n",
-    "retriever = db.as_retriever()\n",
-    "retriever.search_kwargs[\"distance_metric\"] = \"cos\"\n",
-    "retriever.search_kwargs[\"k\"] = 4\n",
-    "\n",
-    "qa = RetrievalQA.from_chain_type(\n",
-    "    llm=OpenAI(), chain_type=\"stuff\", retriever=retriever, return_source_documents=False\n",
-    ")\n",
-    "\n",
-    "# What was the restaurant the group was talking about called?\n",
-    "query = input(\"Enter query:\")\n",
-    "\n",
-    "# The Hungry Lobster\n",
-    "ans = qa({\"query\": query})\n",
-    "\n",
-    "print(ans)"
-   ]
-  }
- ],
- "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.12"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

cookbook/elasticsearch_db_qa.ipynb

@@ -1,156 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Elasticsearch\n",
-    "\n",
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/langchain-ai/langchain/blob/master/docs/docs/use_cases/qa_structured/integrations/elasticsearch.ipynb)\n",
-    "\n",
-    "We can use LLMs to interact with Elasticsearch analytics databases in natural language.\n",
-    "\n",
-    "This chain builds search queries via the Elasticsearch DSL API (filters and aggregations).\n",
-    "\n",
-    "The Elasticsearch client must have permissions for index listing, mapping description and search queries.\n",
-    "\n",
-    "See [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html) for instructions on how to run Elasticsearch locally."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "! pip install langchain langchain-experimental openai elasticsearch\n",
-    "\n",
-    "# Set env var OPENAI_API_KEY or load from a .env file\n",
-    "# import dotenv\n",
-    "\n",
-    "# dotenv.load_dotenv()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from elasticsearch import Elasticsearch\n",
-    "from langchain.chains.elasticsearch_database import ElasticsearchDatabaseChain\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Initialize Elasticsearch python client.\n",
-    "# See https://elasticsearch-py.readthedocs.io/en/v8.8.2/api.html#elasticsearch.Elasticsearch\n",
-    "ELASTIC_SEARCH_SERVER = \"https://elastic:pass@localhost:9200\"\n",
-    "db = Elasticsearch(ELASTIC_SEARCH_SERVER)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Uncomment the next cell to initially populate your db."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# customers = [\n",
-    "#     {\"firstname\": \"Jennifer\", \"lastname\": \"Walters\"},\n",
-    "#     {\"firstname\": \"Monica\",\"lastname\":\"Rambeau\"},\n",
-    "#     {\"firstname\": \"Carol\",\"lastname\":\"Danvers\"},\n",
-    "#     {\"firstname\": \"Wanda\",\"lastname\":\"Maximoff\"},\n",
-    "#     {\"firstname\": \"Jennifer\",\"lastname\":\"Takeda\"},\n",
-    "# ]\n",
-    "# for i, customer in enumerate(customers):\n",
-    "#     db.create(index=\"customers\", document=customer, id=i)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = ChatOpenAI(model=\"gpt-4\", temperature=0)\n",
-    "chain = ElasticsearchDatabaseChain.from_llm(llm=llm, database=db, verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "question = \"What are the first names of all the customers?\"\n",
-    "chain.run(question)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "We can customize the prompt."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.prompts.prompt import PromptTemplate\n",
-    "\n",
-    "PROMPT_TEMPLATE = \"\"\"Given an input question, create a syntactically correct Elasticsearch query to run. Unless the user specifies in their question a specific number of examples they wish to obtain, always limit your query to at most {top_k} results. You can order the results by a relevant column to return the most interesting examples in the database.\n",
-    "\n",
-    "Unless told to do not query for all the columns from a specific index, only ask for a few relevant columns given the question.\n",
-    "\n",
-    "Pay attention to use only the column names that you can see in the mapping description. Be careful to not query for columns that do not exist. Also, pay attention to which column is in which index. Return the query as valid json.\n",
-    "\n",
-    "Use the following format:\n",
-    "\n",
-    "Question: Question here\n",
-    "ESQuery: Elasticsearch Query formatted as json\n",
-    "\"\"\"\n",
-    "\n",
-    "PROMPT = PromptTemplate.from_template(\n",
-    "    PROMPT_TEMPLATE,\n",
-    ")\n",
-    "chain = ElasticsearchDatabaseChain.from_llm(llm=llm, database=db, query_prompt=PROMPT)"
-   ]
-  }
- ],
- "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": 4
-}

cookbook/extraction_openai_tools.ipynb

@@ -1,214 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "2def22ea",
-   "metadata": {},
-   "source": [
-    "# Extraction with OpenAI Tools\n",
-    "\n",
-    "Performing extraction has never been easier! OpenAI's tool calling ability is the perfect thing to use as it allows for extracting multiple different elements from text that are different types. \n",
-    "\n",
-    "Models after 1106 use tools and support \"parallel function calling\" which makes this super easy."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "5c628496",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import List, Optional\n",
-    "\n",
-    "from langchain.chains.openai_tools import create_extraction_chain_pydantic\n",
-    "from langchain_core.pydantic_v1 import BaseModel\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "afe9657b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Make sure to use a recent model that supports tools\n",
-    "model = ChatOpenAI(model=\"gpt-3.5-turbo-1106\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "bc0ca3b6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Pydantic is an easy way to define a schema\n",
-    "class Person(BaseModel):\n",
-    "    \"\"\"Information about people to extract.\"\"\"\n",
-    "\n",
-    "    name: str\n",
-    "    age: Optional[int] = None"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "2036af68",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain = create_extraction_chain_pydantic(Person, model)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "1748ad21",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[Person(name='jane', age=2), Person(name='bob', age=3)]"
-      ]
-     },
-     "execution_count": 11,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain.invoke({\"input\": \"jane is 2 and bob is 3\"})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "c8262ce5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Let's define another element\n",
-    "class Class(BaseModel):\n",
-    "    \"\"\"Information about classes to extract.\"\"\"\n",
-    "\n",
-    "    teacher: str\n",
-    "    students: List[str]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "4973c104",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain = create_extraction_chain_pydantic([Person, Class], model)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "e976a15e",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[Person(name='jane', age=2),\n",
-       " Person(name='bob', age=3),\n",
-       " Class(teacher='Mrs Sampson', students=['jane', 'bob'])]"
-      ]
-     },
-     "execution_count": 14,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain.invoke({\"input\": \"jane is 2 and bob is 3 and they are in Mrs Sampson's class\"})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "6575a7d6",
-   "metadata": {},
-   "source": [
-    "## Under the hood\n",
-    "\n",
-    "Under the hood, this is a simple chain:"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "b8ba83e5",
-   "metadata": {},
-   "source": [
-    "```python\n",
-    "from typing import Union, List, Type, Optional\n",
-    "\n",
-    "from langchain.output_parsers.openai_tools import PydanticToolsParser\n",
-    "from langchain.utils.openai_functions import convert_pydantic_to_openai_tool\n",
-    "from langchain_core.runnables import Runnable\n",
-    "from langchain_core.pydantic_v1 import BaseModel\n",
-    "from langchain_core.prompts import ChatPromptTemplate\n",
-    "from langchain_core.messages import SystemMessage\n",
-    "from langchain_core.language_models import BaseLanguageModel\n",
-    "\n",
-    "_EXTRACTION_TEMPLATE = \"\"\"Extract and save the relevant entities mentioned \\\n",
-    "in the following passage together with their properties.\n",
-    "\n",
-    "If a property is not present and is not required in the function parameters, do not include it in the output.\"\"\"  # noqa: E501\n",
-    "\n",
-    "\n",
-    "def create_extraction_chain_pydantic(\n",
-    "    pydantic_schemas: Union[List[Type[BaseModel]], Type[BaseModel]],\n",
-    "    llm: BaseLanguageModel,\n",
-    "    system_message: str = _EXTRACTION_TEMPLATE,\n",
-    ") -> Runnable:\n",
-    "    if not isinstance(pydantic_schemas, list):\n",
-    "        pydantic_schemas = [pydantic_schemas]\n",
-    "    prompt = ChatPromptTemplate.from_messages([\n",
-    "        (\"system\", system_message),\n",
-    "        (\"user\", \"{input}\")\n",
-    "    ])\n",
-    "    tools = [convert_pydantic_to_openai_tool(p) for p in pydantic_schemas]\n",
-    "    model = llm.bind(tools=tools)\n",
-    "    chain = prompt | model | PydanticToolsParser(tools=pydantic_schemas)\n",
-    "    return chain\n",
-    "```"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2eac6b68",
-   "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
-}

cookbook/fake_llm.ipynb

@@ -1,136 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "052dfe58",
-   "metadata": {},
-   "source": [
-    "# Fake LLM\n",
-    "LangChain provides a fake LLM class that can be used for testing. This allows you to mock out calls to the LLM and simulate what would happen if the LLM responded in a certain way.\n",
-    "\n",
-    "In this notebook we go over how to use this.\n",
-    "\n",
-    "We start this with using the FakeLLM in an agent."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "ef97ac4d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_community.llms.fake import FakeListLLM"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "9a0a160f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import AgentType, initialize_agent, load_tools"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "b272258c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = load_tools([\"python_repl\"])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "94096c4c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "responses = [\"Action: Python REPL\\nAction Input: print(2 + 2)\", \"Final Answer: 4\"]\n",
-    "llm = FakeListLLM(responses=responses)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "da226d02",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = initialize_agent(\n",
-    "    tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 18,
-   "id": "44c13426",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mAction: Python REPL\n",
-      "Action Input: print(2 + 2)\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3m4\n",
-      "\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3mFinal Answer: 4\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'4'"
-      ]
-     },
-     "execution_count": 18,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.invoke(\"whats 2 + 2\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "814c2858",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/fireworks_rag.ipynb

@@ -1,245 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "0fc0309d-4d49-4bb5-bec0-bd92c6fddb28",
-   "metadata": {},
-   "source": [
-    "## Fireworks.AI + LangChain + RAG\n",
-    " \n",
-    "[Fireworks AI](https://python.langchain.com/docs/integrations/llms/fireworks) wants to provide the best experience when working with LangChain, and here is an example of Fireworks + LangChain doing RAG\n",
-    "\n",
-    "See [our models page](https://fireworks.ai/models) for the full list of models. We use `accounts/fireworks/models/mixtral-8x7b-instruct` for RAG In this tutorial.\n",
-    "\n",
-    "For the RAG target, we will use the Gemma technical report https://storage.googleapis.com/deepmind-media/gemma/gemma-report.pdf "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "d12fb75a-f707-48d5-82a5-efe2d041813c",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m A new release of pip is available: \u001b[0m\u001b[31;49m23.2.1\u001b[0m\u001b[39;49m -> \u001b[0m\u001b[32;49m24.0\u001b[0m\n",
-      "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m To update, run: \u001b[0m\u001b[32;49mpip install --upgrade pip\u001b[0m\n",
-      "Note: you may need to restart the kernel to use updated packages.\n",
-      "Found existing installation: langchain-fireworks 0.0.1\n",
-      "Uninstalling langchain-fireworks-0.0.1:\n",
-      "  Successfully uninstalled langchain-fireworks-0.0.1\n",
-      "Note: you may need to restart the kernel to use updated packages.\n",
-      "Obtaining file:///mnt/disks/data/langchain/libs/partners/fireworks\n",
-      "  Installing build dependencies ... \u001b[?25ldone\n",
-      "\u001b[?25h  Checking if build backend supports build_editable ... \u001b[?25ldone\n",
-      "\u001b[?25h  Getting requirements to build editable ... \u001b[?25ldone\n",
-      "\u001b[?25h  Preparing editable metadata (pyproject.toml) ... \u001b[?25ldone\n",
-      "\u001b[?25hRequirement already satisfied: aiohttp<4.0.0,>=3.9.1 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from langchain-fireworks==0.0.1) (3.9.3)\n",
-      "Requirement already satisfied: fireworks-ai<0.13.0,>=0.12.0 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from langchain-fireworks==0.0.1) (0.12.0)\n",
-      "Requirement already satisfied: langchain-core<0.2,>=0.1 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from langchain-fireworks==0.0.1) (0.1.23)\n",
-      "Requirement already satisfied: requests<3,>=2 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from langchain-fireworks==0.0.1) (2.31.0)\n",
-      "Requirement already satisfied: aiosignal>=1.1.2 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-fireworks==0.0.1) (1.3.1)\n",
-      "Requirement already satisfied: attrs>=17.3.0 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-fireworks==0.0.1) (23.1.0)\n",
-      "Requirement already satisfied: frozenlist>=1.1.1 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-fireworks==0.0.1) (1.4.0)\n",
-      "Requirement already satisfied: multidict<7.0,>=4.5 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-fireworks==0.0.1) (6.0.4)\n",
-      "Requirement already satisfied: yarl<2.0,>=1.0 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-fireworks==0.0.1) (1.9.2)\n",
-      "Requirement already satisfied: async-timeout<5.0,>=4.0 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from aiohttp<4.0.0,>=3.9.1->langchain-fireworks==0.0.1) (4.0.3)\n",
-      "Requirement already satisfied: httpx in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from fireworks-ai<0.13.0,>=0.12.0->langchain-fireworks==0.0.1) (0.26.0)\n",
-      "Requirement already satisfied: httpx-sse in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from fireworks-ai<0.13.0,>=0.12.0->langchain-fireworks==0.0.1) (0.4.0)\n",
-      "Requirement already satisfied: pydantic in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from fireworks-ai<0.13.0,>=0.12.0->langchain-fireworks==0.0.1) (2.4.2)\n",
-      "Requirement already satisfied: Pillow in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from fireworks-ai<0.13.0,>=0.12.0->langchain-fireworks==0.0.1) (10.2.0)\n",
-      "Requirement already satisfied: PyYAML>=5.3 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from langchain-core<0.2,>=0.1->langchain-fireworks==0.0.1) (6.0.1)\n",
-      "Requirement already satisfied: anyio<5,>=3 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from langchain-core<0.2,>=0.1->langchain-fireworks==0.0.1) (3.7.1)\n",
-      "Requirement already satisfied: jsonpatch<2.0,>=1.33 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from langchain-core<0.2,>=0.1->langchain-fireworks==0.0.1) (1.33)\n",
-      "Requirement already satisfied: langsmith<0.2.0,>=0.1.0 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from langchain-core<0.2,>=0.1->langchain-fireworks==0.0.1) (0.1.5)\n",
-      "Requirement already satisfied: packaging<24.0,>=23.2 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from langchain-core<0.2,>=0.1->langchain-fireworks==0.0.1) (23.2)\n",
-      "Requirement already satisfied: tenacity<9.0.0,>=8.1.0 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from langchain-core<0.2,>=0.1->langchain-fireworks==0.0.1) (8.2.3)\n",
-      "Requirement already satisfied: charset-normalizer<4,>=2 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from requests<3,>=2->langchain-fireworks==0.0.1) (3.3.0)\n",
-      "Requirement already satisfied: idna<4,>=2.5 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from requests<3,>=2->langchain-fireworks==0.0.1) (3.4)\n",
-      "Requirement already satisfied: urllib3<3,>=1.21.1 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from requests<3,>=2->langchain-fireworks==0.0.1) (2.0.6)\n",
-      "Requirement already satisfied: certifi>=2017.4.17 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from requests<3,>=2->langchain-fireworks==0.0.1) (2023.7.22)\n",
-      "Requirement already satisfied: sniffio>=1.1 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from anyio<5,>=3->langchain-core<0.2,>=0.1->langchain-fireworks==0.0.1) (1.3.0)\n",
-      "Requirement already satisfied: exceptiongroup in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from anyio<5,>=3->langchain-core<0.2,>=0.1->langchain-fireworks==0.0.1) (1.1.3)\n",
-      "Requirement already satisfied: jsonpointer>=1.9 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from jsonpatch<2.0,>=1.33->langchain-core<0.2,>=0.1->langchain-fireworks==0.0.1) (2.4)\n",
-      "Requirement already satisfied: annotated-types>=0.4.0 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from pydantic->fireworks-ai<0.13.0,>=0.12.0->langchain-fireworks==0.0.1) (0.5.0)\n",
-      "Requirement already satisfied: pydantic-core==2.10.1 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from pydantic->fireworks-ai<0.13.0,>=0.12.0->langchain-fireworks==0.0.1) (2.10.1)\n",
-      "Requirement already satisfied: typing-extensions>=4.6.1 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from pydantic->fireworks-ai<0.13.0,>=0.12.0->langchain-fireworks==0.0.1) (4.8.0)\n",
-      "Requirement already satisfied: httpcore==1.* in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from httpx->fireworks-ai<0.13.0,>=0.12.0->langchain-fireworks==0.0.1) (1.0.2)\n",
-      "Requirement already satisfied: h11<0.15,>=0.13 in /mnt/disks/data/langchain/.venv/lib/python3.9/site-packages (from httpcore==1.*->httpx->fireworks-ai<0.13.0,>=0.12.0->langchain-fireworks==0.0.1) (0.14.0)\n",
-      "Building wheels for collected packages: langchain-fireworks\n",
-      "  Building editable for langchain-fireworks (pyproject.toml) ... \u001b[?25ldone\n",
-      "\u001b[?25h  Created wheel for langchain-fireworks: filename=langchain_fireworks-0.0.1-py3-none-any.whl size=2228 sha256=564071b120b09ec31f2dc737733448a33bbb26e40b49fcde0c129ad26045259d\n",
-      "  Stored in directory: /tmp/pip-ephem-wheel-cache-oz368vdk/wheels/e0/ad/31/d7e76dd73d61905ff7f369f5b0d21a4b5e7af4d3cb7487aece\n",
-      "Successfully built langchain-fireworks\n",
-      "Installing collected packages: langchain-fireworks\n",
-      "Successfully installed langchain-fireworks-0.0.1\n",
-      "\n",
-      "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m A new release of pip is available: \u001b[0m\u001b[31;49m23.2.1\u001b[0m\u001b[39;49m -> \u001b[0m\u001b[32;49m24.0\u001b[0m\n",
-      "\u001b[1m[\u001b[0m\u001b[34;49mnotice\u001b[0m\u001b[1;39;49m]\u001b[0m\u001b[39;49m To update, run: \u001b[0m\u001b[32;49mpip install --upgrade pip\u001b[0m\n",
-      "Note: you may need to restart the kernel to use updated packages.\n"
-     ]
-    }
-   ],
-   "source": [
-    "%pip install --quiet pypdf langchain-chroma tiktoken openai \n",
-    "%pip uninstall -y langchain-fireworks\n",
-    "%pip install --editable /mnt/disks/data/langchain/libs/partners/fireworks"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "cf719376",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "<module 'fireworks' from '/mnt/disks/data/langchain/.venv/lib/python3.9/site-packages/fireworks/__init__.py'>\n"
-     ]
-    }
-   ],
-   "source": [
-    "import fireworks\n",
-    "\n",
-    "print(fireworks)\n",
-    "import fireworks.client"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9ab49327-0532-4480-804c-d066c302a322",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Load\n",
-    "import requests\n",
-    "from langchain_community.document_loaders import PyPDFLoader\n",
-    "\n",
-    "# Download the PDF from a URL and save it to a temporary location\n",
-    "url = \"https://storage.googleapis.com/deepmind-media/gemma/gemma-report.pdf\"\n",
-    "response = requests.get(url, stream=True)\n",
-    "file_name = \"temp_file.pdf\"\n",
-    "with open(file_name, \"wb\") as pdf:\n",
-    "    pdf.write(response.content)\n",
-    "\n",
-    "loader = PyPDFLoader(file_name)\n",
-    "data = loader.load()\n",
-    "\n",
-    "# Split\n",
-    "from langchain_text_splitters import RecursiveCharacterTextSplitter\n",
-    "\n",
-    "text_splitter = RecursiveCharacterTextSplitter(chunk_size=2000, chunk_overlap=0)\n",
-    "all_splits = text_splitter.split_documents(data)\n",
-    "\n",
-    "# Add to vectorDB\n",
-    "from langchain_chroma import Chroma\n",
-    "from langchain_fireworks.embeddings import FireworksEmbeddings\n",
-    "\n",
-    "vectorstore = Chroma.from_documents(\n",
-    "    documents=all_splits,\n",
-    "    collection_name=\"rag-chroma\",\n",
-    "    embedding=FireworksEmbeddings(),\n",
-    ")\n",
-    "\n",
-    "retriever = vectorstore.as_retriever()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "4efaddd9-3dbb-455c-ba54-0ad7f2d2ce0f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_core.output_parsers import StrOutputParser\n",
-    "from langchain_core.prompts import ChatPromptTemplate\n",
-    "from langchain_core.pydantic_v1 import BaseModel\n",
-    "from langchain_core.runnables import RunnableParallel, RunnablePassthrough\n",
-    "\n",
-    "# RAG prompt\n",
-    "template = \"\"\"Answer the question based only on the following context:\n",
-    "{context}\n",
-    "\n",
-    "Question: {question}\n",
-    "\"\"\"\n",
-    "prompt = ChatPromptTemplate.from_template(template)\n",
-    "\n",
-    "# LLM\n",
-    "from langchain_together import Together\n",
-    "\n",
-    "llm = Together(\n",
-    "    model=\"mistralai/Mixtral-8x7B-Instruct-v0.1\",\n",
-    "    temperature=0.0,\n",
-    "    max_tokens=2000,\n",
-    "    top_k=1,\n",
-    ")\n",
-    "\n",
-    "# RAG chain\n",
-    "chain = (\n",
-    "    RunnableParallel({\"context\": retriever, \"question\": RunnablePassthrough()})\n",
-    "    | prompt\n",
-    "    | llm\n",
-    "    | StrOutputParser()\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "88b1ee51-1b0f-4ebf-bb32-e50e843f0eeb",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'\\nAnswer: The architectural details of Mixtral are as follows:\\n- Dimension (dim): 4096\\n- Number of layers (n\\\\_layers): 32\\n- Dimension of each head (head\\\\_dim): 128\\n- Hidden dimension (hidden\\\\_dim): 14336\\n- Number of heads (n\\\\_heads): 32\\n- Number of kv heads (n\\\\_kv\\\\_heads): 8\\n- Context length (context\\\\_len): 32768\\n- Vocabulary size (vocab\\\\_size): 32000\\n- Number of experts (num\\\\_experts): 8\\n- Number of top k experts (top\\\\_k\\\\_experts): 2\\n\\nMixtral is based on a transformer architecture and uses the same modifications as described in [18], with the notable exceptions that Mixtral supports a fully dense context length of 32k tokens, and the feedforward block picks from a set of 8 distinct groups of parameters. At every layer, for every token, a router network chooses two of these groups (the “experts”) to process the token and combine their output additively. This technique increases the number of parameters of a model while controlling cost and latency, as the model only uses a fraction of the total set of parameters per token. Mixtral is pretrained with multilingual data using a context size of 32k tokens. It either matches or exceeds the performance of Llama 2 70B and GPT-3.5, over several benchmarks. In particular, Mixtral vastly outperforms Llama 2 70B on mathematics, code generation, and multilingual benchmarks.'"
-      ]
-     },
-     "execution_count": 4,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain.invoke(\"What are the Architectural details of Mixtral?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "755cf871-26b7-4e30-8b91-9ffd698470f4",
-   "metadata": {},
-   "source": [
-    "Trace: \n",
-    "\n",
-    "https://smith.langchain.com/public/935fd642-06a6-4b42-98e3-6074f93115cd/r"
-   ]
-  }
- ],
- "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.12"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/forward_looking_retrieval_augmented_generation.ipynb

@@ -1,493 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "0f0b9afa",
-   "metadata": {},
-   "source": [
-    "# Retrieve as you generate with FLARE\n",
-    "\n",
-    "This notebook is an implementation of Forward-Looking Active REtrieval augmented generation (FLARE).\n",
-    "\n",
-    "Please see the original repo [here](https://github.com/jzbjyb/FLARE/tree/main).\n",
-    "\n",
-    "The basic idea is:\n",
-    "\n",
-    "- Start answering a question\n",
-    "- If you start generating tokens the model is uncertain about, look up relevant documents\n",
-    "- Use those documents to continue generating\n",
-    "- Repeat until finished\n",
-    "\n",
-    "There is a lot of cool detail in how the lookup of relevant documents is done.\n",
-    "Basically, the tokens that model is uncertain about are highlighted, and then an LLM is called to generate a question that would lead to that answer. For example, if the generated text is `Joe Biden went to Harvard`, and the tokens the model was uncertain about was `Harvard`, then a good generated question would be `where did Joe Biden go to college`. This generated question is then used in a retrieval step to fetch relevant documents.\n",
-    "\n",
-    "In order to set up this chain, we will need three things:\n",
-    "\n",
-    "- An LLM to generate the answer\n",
-    "- An LLM to generate hypothetical questions to use in retrieval\n",
-    "- A retriever to use to look up answers for\n",
-    "\n",
-    "The LLM that we use to generate the answer needs to return logprobs so we can identify uncertain tokens. For that reason, we HIGHLY recommend that you use the OpenAI wrapper (NB: not the ChatOpenAI wrapper, as that does not return logprobs).\n",
-    "\n",
-    "The LLM we use to generate hypothetical questions to use in retrieval can be anything. In this notebook we will use ChatOpenAI because it is fast and cheap.\n",
-    "\n",
-    "The retriever can be anything. In this notebook we will use [SERPER](https://serper.dev/) search engine, because it is cheap.\n",
-    "\n",
-    "Other important parameters to understand:\n",
-    "\n",
-    "- `max_generation_len`: The maximum number of tokens to generate before stopping to check if any are uncertain\n",
-    "- `min_prob`: Any tokens generated with probability below this will be considered uncertain"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a7e4b63d",
-   "metadata": {},
-   "source": [
-    "## Imports"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "042bb161",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "os.environ[\"SERPER_API_KEY\"] = \"\"\n",
-    "os.environ[\"OPENAI_API_KEY\"] = \"\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "a7888f4a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Any, List\n",
-    "\n",
-    "from langchain.callbacks.manager import (\n",
-    "    AsyncCallbackManagerForRetrieverRun,\n",
-    "    CallbackManagerForRetrieverRun,\n",
-    ")\n",
-    "from langchain_community.utilities import GoogleSerperAPIWrapper\n",
-    "from langchain_core.documents import Document\n",
-    "from langchain_core.retrievers import BaseRetriever\n",
-    "from langchain_openai import ChatOpenAI, OpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "5f552dce",
-   "metadata": {},
-   "source": [
-    "## Retriever"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "59c7d875",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class SerperSearchRetriever(BaseRetriever):\n",
-    "    search: GoogleSerperAPIWrapper = None\n",
-    "\n",
-    "    def _get_relevant_documents(\n",
-    "        self, query: str, *, run_manager: CallbackManagerForRetrieverRun, **kwargs: Any\n",
-    "    ) -> List[Document]:\n",
-    "        return [Document(page_content=self.search.run(query))]\n",
-    "\n",
-    "    async def _aget_relevant_documents(\n",
-    "        self,\n",
-    "        query: str,\n",
-    "        *,\n",
-    "        run_manager: AsyncCallbackManagerForRetrieverRun,\n",
-    "        **kwargs: Any,\n",
-    "    ) -> List[Document]:\n",
-    "        raise NotImplementedError()\n",
-    "\n",
-    "\n",
-    "retriever = SerperSearchRetriever(search=GoogleSerperAPIWrapper())"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "92478194",
-   "metadata": {},
-   "source": [
-    "## FLARE Chain"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "577e7c2c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# We set this so we can see what exactly is going on\n",
-    "from langchain.globals import set_verbose\n",
-    "\n",
-    "set_verbose(True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "300d783e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import FlareChain\n",
-    "\n",
-    "flare = FlareChain.from_llm(\n",
-    "    ChatOpenAI(temperature=0),\n",
-    "    retriever=retriever,\n",
-    "    max_generation_len=164,\n",
-    "    min_prob=0.3,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "1f3d5e90",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query = \"explain in great detail the difference between the langchain framework and baby agi\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "4b1bfa8c",
-   "metadata": {
-    "scrolled": false
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new FlareChain chain...\u001b[0m\n",
-      "\u001b[36;1m\u001b[1;3mCurrent Response: \u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mRespond to the user message using any relevant context. If context is provided, you should ground your answer in that context. Once you're done responding return FINISHED.\n",
-      "\n",
-      ">>> CONTEXT: \n",
-      ">>> USER INPUT: explain in great detail the difference between the langchain framework and baby agi\n",
-      ">>> RESPONSE: \u001b[0m\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new QuestionGeneratorChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: explain in great detail the difference between the langchain framework and baby agi\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "The Langchain Framework is a decentralized platform for natural language processing (NLP) applications. It uses a blockchain-based distributed ledger to store and process data, allowing for secure and transparent data sharing. The Langchain Framework also provides a set of tools and services to help developers create and deploy NLP applications.\n",
-      "\n",
-      "Baby AGI, on the other hand, is an artificial general intelligence (AGI) platform. It uses a combination of deep learning and reinforcement learning to create an AI system that can learn and adapt to new tasks. Baby AGI is designed to be a general-purpose AI system that can be used for a variety of applications, including natural language processing.\n",
-      "\n",
-      "In summary, the Langchain Framework is a platform for NLP applications, while Baby AGI is an AI system designed for\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" decentralized platform for natural language processing\" is:\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: explain in great detail the difference between the langchain framework and baby agi\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "The Langchain Framework is a decentralized platform for natural language processing (NLP) applications. It uses a blockchain-based distributed ledger to store and process data, allowing for secure and transparent data sharing. The Langchain Framework also provides a set of tools and services to help developers create and deploy NLP applications.\n",
-      "\n",
-      "Baby AGI, on the other hand, is an artificial general intelligence (AGI) platform. It uses a combination of deep learning and reinforcement learning to create an AI system that can learn and adapt to new tasks. Baby AGI is designed to be a general-purpose AI system that can be used for a variety of applications, including natural language processing.\n",
-      "\n",
-      "In summary, the Langchain Framework is a platform for NLP applications, while Baby AGI is an AI system designed for\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" uses a blockchain\" is:\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: explain in great detail the difference between the langchain framework and baby agi\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "The Langchain Framework is a decentralized platform for natural language processing (NLP) applications. It uses a blockchain-based distributed ledger to store and process data, allowing for secure and transparent data sharing. The Langchain Framework also provides a set of tools and services to help developers create and deploy NLP applications.\n",
-      "\n",
-      "Baby AGI, on the other hand, is an artificial general intelligence (AGI) platform. It uses a combination of deep learning and reinforcement learning to create an AI system that can learn and adapt to new tasks. Baby AGI is designed to be a general-purpose AI system that can be used for a variety of applications, including natural language processing.\n",
-      "\n",
-      "In summary, the Langchain Framework is a platform for NLP applications, while Baby AGI is an AI system designed for\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" distributed ledger to\" is:\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: explain in great detail the difference between the langchain framework and baby agi\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "The Langchain Framework is a decentralized platform for natural language processing (NLP) applications. It uses a blockchain-based distributed ledger to store and process data, allowing for secure and transparent data sharing. The Langchain Framework also provides a set of tools and services to help developers create and deploy NLP applications.\n",
-      "\n",
-      "Baby AGI, on the other hand, is an artificial general intelligence (AGI) platform. It uses a combination of deep learning and reinforcement learning to create an AI system that can learn and adapt to new tasks. Baby AGI is designed to be a general-purpose AI system that can be used for a variety of applications, including natural language processing.\n",
-      "\n",
-      "In summary, the Langchain Framework is a platform for NLP applications, while Baby AGI is an AI system designed for\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" process data, allowing for secure and transparent data sharing.\" is:\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: explain in great detail the difference between the langchain framework and baby agi\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "The Langchain Framework is a decentralized platform for natural language processing (NLP) applications. It uses a blockchain-based distributed ledger to store and process data, allowing for secure and transparent data sharing. The Langchain Framework also provides a set of tools and services to help developers create and deploy NLP applications.\n",
-      "\n",
-      "Baby AGI, on the other hand, is an artificial general intelligence (AGI) platform. It uses a combination of deep learning and reinforcement learning to create an AI system that can learn and adapt to new tasks. Baby AGI is designed to be a general-purpose AI system that can be used for a variety of applications, including natural language processing.\n",
-      "\n",
-      "In summary, the Langchain Framework is a platform for NLP applications, while Baby AGI is an AI system designed for\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" set of tools\" is:\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: explain in great detail the difference between the langchain framework and baby agi\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "The Langchain Framework is a decentralized platform for natural language processing (NLP) applications. It uses a blockchain-based distributed ledger to store and process data, allowing for secure and transparent data sharing. The Langchain Framework also provides a set of tools and services to help developers create and deploy NLP applications.\n",
-      "\n",
-      "Baby AGI, on the other hand, is an artificial general intelligence (AGI) platform. It uses a combination of deep learning and reinforcement learning to create an AI system that can learn and adapt to new tasks. Baby AGI is designed to be a general-purpose AI system that can be used for a variety of applications, including natural language processing.\n",
-      "\n",
-      "In summary, the Langchain Framework is a platform for NLP applications, while Baby AGI is an AI system designed for\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" help developers create\" is:\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: explain in great detail the difference between the langchain framework and baby agi\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "The Langchain Framework is a decentralized platform for natural language processing (NLP) applications. It uses a blockchain-based distributed ledger to store and process data, allowing for secure and transparent data sharing. The Langchain Framework also provides a set of tools and services to help developers create and deploy NLP applications.\n",
-      "\n",
-      "Baby AGI, on the other hand, is an artificial general intelligence (AGI) platform. It uses a combination of deep learning and reinforcement learning to create an AI system that can learn and adapt to new tasks. Baby AGI is designed to be a general-purpose AI system that can be used for a variety of applications, including natural language processing.\n",
-      "\n",
-      "In summary, the Langchain Framework is a platform for NLP applications, while Baby AGI is an AI system designed for\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" create an AI system\" is:\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: explain in great detail the difference between the langchain framework and baby agi\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "The Langchain Framework is a decentralized platform for natural language processing (NLP) applications. It uses a blockchain-based distributed ledger to store and process data, allowing for secure and transparent data sharing. The Langchain Framework also provides a set of tools and services to help developers create and deploy NLP applications.\n",
-      "\n",
-      "Baby AGI, on the other hand, is an artificial general intelligence (AGI) platform. It uses a combination of deep learning and reinforcement learning to create an AI system that can learn and adapt to new tasks. Baby AGI is designed to be a general-purpose AI system that can be used for a variety of applications, including natural language processing.\n",
-      "\n",
-      "In summary, the Langchain Framework is a platform for NLP applications, while Baby AGI is an AI system designed for\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" NLP applications\" is:\u001b[0m\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\u001b[33;1m\u001b[1;3mGenerated Questions: ['What is the Langchain Framework?', 'What technology does the Langchain Framework use to store and process data for secure and transparent data sharing?', 'What technology does the Langchain Framework use to store and process data?', 'What does the Langchain Framework use a blockchain-based distributed ledger for?', 'What does the Langchain Framework provide in addition to a decentralized platform for natural language processing applications?', 'What set of tools and services does the Langchain Framework provide?', 'What is the purpose of Baby AGI?', 'What type of applications is the Langchain Framework designed for?']\u001b[0m\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new _OpenAIResponseChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mRespond to the user message using any relevant context. If context is provided, you should ground your answer in that context. Once you're done responding return FINISHED.\n",
-      "\n",
-      ">>> CONTEXT: LangChain: Software. LangChain is a software development framework designed to simplify the creation of applications using large language models. LangChain Initial release date: October 2022. LangChain Programming languages: Python and JavaScript. LangChain Developer(s): Harrison Chase. LangChain License: MIT License. LangChain is a framework for developing applications powered by language models. We believe that the most powerful and differentiated applications will not only ... Type: Software framework. At its core, LangChain is a framework built around LLMs. We can use it for chatbots, Generative Question-Answering (GQA), summarization, and much more. LangChain is a powerful tool that can be used to work with Large Language Models (LLMs). LLMs are very general in nature, which means that while they can ... LangChain is an intuitive framework created to assist in developing applications driven by a language model, such as OpenAI or Hugging Face. LangChain is a software development framework designed to simplify the creation of applications using large language models (LLMs). Written in: Python and JavaScript. Initial release: October 2022. LangChain - The A.I-native developer toolkit We started LangChain with the intent to build a modular and flexible framework for developing A.I- ... LangChain explained in 3 minutes - LangChain is a ... Duration: 3:03. Posted: Apr 13, 2023. LangChain is a framework built to help you build LLM-powered applications more easily by providing you with the following:. LangChain is a framework that enables quick and easy development of applications that make use of Large Language Models, for example, GPT-3. LangChain is a powerful open-source framework for developing applications powered by language models. It connects to the AI models you want to ...\n",
-      "\n",
-      "LangChain is a framework for including AI from large language models inside data pipelines and applications. This tutorial provides an overview of what you ... Missing: secure | Must include:secure. Blockchain is the best way to secure the data of the shared community. Utilizing the capabilities of the blockchain nobody can read or interfere ... This modern technology consists of a chain of blocks that allows to securely store all committed transactions using shared and distributed ... A Blockchain network is used in the healthcare system to preserve and exchange patient data through hospitals, diagnostic laboratories, pharmacy firms, and ... In this article, I will walk you through the process of using the LangChain.js library with Google Cloud Functions, helping you leverage the ... LangChain is an intuitive framework created to assist in developing applications driven by a language model, such as OpenAI or Hugging Face. Missing: transparent | Must include:transparent. This technology keeps a distributed ledger on each blockchain node, making it more secure and transparent. The blockchain network can operate smart ... blockchain technology can offer a highly secured health data ledger to ... framework can be employed to store encrypted healthcare data in a ... In a simplified way, Blockchain is a data structure that stores transactions in an ordered way and linked to the previous block, serving as a ... Blockchain technology is a decentralized, distributed ledger that stores the record of ownership of digital assets. Missing: Langchain | Must include:Langchain.\n",
-      "\n",
-      "LangChain is a framework for including AI from large language models inside data pipelines and applications. This tutorial provides an overview of what you ... LangChain is an intuitive framework created to assist in developing applications driven by a language model, such as OpenAI or Hugging Face. This documentation covers the steps to integrate Pinecone, a high-performance vector database, with LangChain, a framework for building applications powered ... The ability to connect to any model, ingest any custom database, and build upon a framework that can take action provides numerous use cases for ... With LangChain, developers can use a framework that abstracts the core building blocks of LLM applications. LangChain empowers developers to ... Build a question-answering tool based on financial data with LangChain & Deep Lake's unified & streamable data store. Browse applications built on LangChain technology. Explore PoC and MVP applications created by our community and discover innovative use cases for LangChain ... LangChain is a great framework that can be used for developing applications powered by LLMs. When you intend to enhance your application ... In this blog, we'll introduce you to LangChain and Ray Serve and how to use them to build a search engine using LLM embeddings and a vector ... The LinkChain Framework simplifies embedding creation and storage using Pinecone and Chroma, with code that loads files, splits documents, and creates embedding ... Missing: technology | Must include:technology.\n",
-      "\n",
-      "Blockchain is one type of a distributed ledger. Distributed ledgers use independent computers (referred to as nodes) to record, share and ... Missing: Langchain | Must include:Langchain. Blockchain is used in distributed storage software where huge data is broken down into chunks. This is available in encrypted data across a ... People sometimes use the terms 'Blockchain' and 'Distributed Ledger' interchangeably. This post aims to analyze the features of each. A distributed ledger ... Missing: Framework | Must include:Framework. Think of a “distributed ledger” that uses cryptography to allow each participant in the transaction to add to the ledger in a secure way without ... In this paper, we provide an overview of the history of trade settlement and discuss this nascent technology that may now transform traditional ... Missing: Langchain | Must include:Langchain. LangChain is a blockchain-based language education platform that aims to revolutionize the way people learn languages. Missing: Framework | Must include:Framework. It uses the distributed ledger technology framework and Smart contract engine for building scalable Business Blockchain applications. The fabric ... It looks at the assets the use case is handling, the different parties conducting transactions, and the smart contract, distributed ... Are you curious to know how Blockchain and Distributed ... Duration: 44:31. Posted: May 4, 2021. A blockchain is a distributed and immutable ledger to transfer ownership, record transactions, track assets, and ensure transparency, security, trust and value ... Missing: Langchain | Must include:Langchain.\n",
-      "\n",
-      "LangChain is an intuitive framework created to assist in developing applications driven by a language model, such as OpenAI or Hugging Face. Missing: decentralized | Must include:decentralized. LangChain, created by Harrison Chase, is a Python library that provides out-of-the-box support to build NLP applications using LLMs. Missing: decentralized | Must include:decentralized. LangChain provides a standard interface for chains, enabling developers to create sequences of calls that go beyond a single LLM call. Chains ... Missing: decentralized platform natural. LangChain is a powerful framework that simplifies the process of building advanced language model applications. Missing: platform | Must include:platform. Are your language models ignoring previous instructions ... Duration: 32:23. Posted: Feb 21, 2023. LangChain is a framework that enables quick and easy development of applications ... Prompting is the new way of programming NLP models. Missing: decentralized platform. It then uses natural language processing and machine learning algorithms to search ... Summarization is handled via cohere, QnA is handled via langchain, ... LangChain is a framework for developing applications powered by language models. ... There are several main modules that LangChain provides support for. Missing: decentralized platform. In the healthcare-chain system, blockchain provides an appreciated secure ... The entire process of adding new and previous block data is performed based on ... ChatGPT is a large language model developed by OpenAI, ... tool for a wide range of applications, including natural language processing, ...\n",
-      "\n",
-      "LangChain is a powerful tool that can be used to work with Large Language ... If an API key has been provided, create an OpenAI language model instance At its core, LangChain is a framework built around LLMs. We can use it for chatbots, Generative Question-Answering (GQA), summarization, and much more. A tutorial of the six core modules of the LangChain Python package covering models, prompts, chains, agents, indexes, and memory with OpenAI ... LangChain's collection of tools refers to a set of tools provided by the LangChain framework for developing applications powered by language models. LangChain is a framework for developing applications powered by language models. We believe that the most powerful and differentiated applications will not only ... LangChain is an open-source library that provides developers with the tools to build applications powered by large language models (LLMs). LangChain is a framework for including AI from large language models inside data pipelines and applications. This tutorial provides an overview of what you ... Plan-and-Execute Agents · Feature Stores and LLMs · Structured Tools · Auto-Evaluator Opportunities · Callbacks Improvements · Unleashing the power ... Tool: A function that performs a specific duty. This can be things like: Google Search, Database lookup, Python REPL, other chains. · LLM: The language model ... LangChain provides a standard interface for chains, lots of integrations with other tools, and end-to-end chains for common applications.\n",
-      "\n",
-      "Baby AGI has the ability to complete tasks, generate new tasks based on previous results, and prioritize tasks in real-time. This system is exploring and demonstrating to us the potential of large language models, such as GPT and how it can autonomously perform tasks. Apr 17, 2023\n",
-      "\n",
-      "At its core, LangChain is a framework built around LLMs. We can use it for chatbots, Generative Question-Answering (GQA), summarization, and much more. The core idea of the library is that we can “chain” together different components to create more advanced use cases around LLMs.\n",
-      ">>> USER INPUT: explain in great detail the difference between the langchain framework and baby agi\n",
-      ">>> RESPONSE: \u001b[0m\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' LangChain is a framework for developing applications powered by language models. It provides a standard interface for chains, lots of integrations with other tools, and end-to-end chains for common applications. On the other hand, Baby AGI is an AI system that is exploring and demonstrating the potential of large language models, such as GPT, and how it can autonomously perform tasks. Baby AGI has the ability to complete tasks, generate new tasks based on previous results, and prioritize tasks in real-time. '"
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "flare.run(query)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "7bed8944",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'\\n\\nThe Langchain framework and Baby AGI are both artificial intelligence (AI) frameworks that are used to create intelligent agents. The Langchain framework is a supervised learning system that is based on the concept of “language chains”. It uses a set of rules to map natural language inputs to specific outputs. It is a general-purpose AI framework and can be used to build applications such as natural language processing (NLP), chatbots, and more.\\n\\nBaby AGI, on the other hand, is an unsupervised learning system that uses neural networks and reinforcement learning to learn from its environment. It is used to create intelligent agents that can adapt to changing environments. It is a more advanced AI system and can be used to build more complex applications such as game playing, robotic vision, and more.\\n\\nThe main difference between the two is that the Langchain framework uses supervised learning while Baby AGI uses unsupervised learning. The Langchain framework is a general-purpose AI framework that can be used for various applications, while Baby AGI is a more advanced AI system that can be used to create more complex applications.'"
-      ]
-     },
-     "execution_count": 8,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "llm = OpenAI()\n",
-    "llm.invoke(query)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "8fb76286",
-   "metadata": {
-    "scrolled": false
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new FlareChain chain...\u001b[0m\n",
-      "\u001b[36;1m\u001b[1;3mCurrent Response: \u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mRespond to the user message using any relevant context. If context is provided, you should ground your answer in that context. Once you're done responding return FINISHED.\n",
-      "\n",
-      ">>> CONTEXT: \n",
-      ">>> USER INPUT: how are the origin stories of langchain and bitcoin similar or different?\n",
-      ">>> RESPONSE: \u001b[0m\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new QuestionGeneratorChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: how are the origin stories of langchain and bitcoin similar or different?\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "\n",
-      "Langchain and Bitcoin have very different origin stories. Bitcoin was created by the mysterious Satoshi Nakamoto in 2008 as a decentralized digital currency. Langchain, on the other hand, was created in 2020 by a team of developers as a platform for creating and managing decentralized language learning applications. \n",
-      "\n",
-      "FINISHED\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" very different origin\" is:\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: how are the origin stories of langchain and bitcoin similar or different?\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "\n",
-      "Langchain and Bitcoin have very different origin stories. Bitcoin was created by the mysterious Satoshi Nakamoto in 2008 as a decentralized digital currency. Langchain, on the other hand, was created in 2020 by a team of developers as a platform for creating and managing decentralized language learning applications. \n",
-      "\n",
-      "FINISHED\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" 2020 by a\" is:\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mGiven a user input and an existing partial response as context, ask a question to which the answer is the given term/entity/phrase:\n",
-      "\n",
-      ">>> USER INPUT: how are the origin stories of langchain and bitcoin similar or different?\n",
-      ">>> EXISTING PARTIAL RESPONSE:  \n",
-      "\n",
-      "Langchain and Bitcoin have very different origin stories. Bitcoin was created by the mysterious Satoshi Nakamoto in 2008 as a decentralized digital currency. Langchain, on the other hand, was created in 2020 by a team of developers as a platform for creating and managing decentralized language learning applications. \n",
-      "\n",
-      "FINISHED\n",
-      "\n",
-      "The question to which the answer is the term/entity/phrase \" developers as a platform for creating and managing decentralized language learning applications.\" is:\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\u001b[33;1m\u001b[1;3mGenerated Questions: ['How would you describe the origin stories of Langchain and Bitcoin in terms of their similarities or differences?', 'When was Langchain created and by whom?', 'What was the purpose of creating Langchain?']\u001b[0m\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new _OpenAIResponseChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3mRespond to the user message using any relevant context. If context is provided, you should ground your answer in that context. Once you're done responding return FINISHED.\n",
-      "\n",
-      ">>> CONTEXT: Bitcoin and Ethereum have many similarities but different long-term visions and limitations. Ethereum changed from proof of work to proof of ... Bitcoin will be around for many years and examining its white paper origins is a great exercise in understanding why. Satoshi Nakamoto's blueprint describes ... Bitcoin is a new currency that was created in 2009 by an unknown person using the alias Satoshi Nakamoto. Transactions are made with no middle men – meaning, no ... Missing: Langchain | Must include:Langchain. By comparison, Bitcoin transaction speeds are tremendously lower. ... learn about its history and its role in the emergence of the Bitcoin ... LangChain is a powerful framework that simplifies the process of ... tasks like document retrieval, clustering, and similarity comparisons. Key terms: Bitcoin System, Blockchain Technology, ... Furthermore, the research paper will discuss and compare the five payment. Blockchain first appeared in Nakamoto's Bitcoin white paper that describes a new decentralized cryptocurrency [1]. Bitcoin takes the blockchain technology ... Missing: stories | Must include:stories. A score of 0 means there were not enough data for this term. Google trends was accessed on 5 November 2018 with searches for bitcoin, euro, gold ... Contracts, transactions, and records of them provide critical structure in our economic system, but they haven't kept up with the world's digital ... Missing: Langchain | Must include:Langchain. Of course, traders try to make a profit on their portfolio in this way.The difference between investing and trading is the regularity with which ...\n",
-      "\n",
-      "After all these giant leaps forward in the LLM space, OpenAI released ChatGPT — thrusting LLMs into the spotlight. LangChain appeared around the same time. Its creator, Harrison Chase, made the first commit in late October 2022. Leaving a short couple of months of development before getting caught in the LLM wave.\n",
-      "\n",
-      "At its core, LangChain is a framework built around LLMs. We can use it for chatbots, Generative Question-Answering (GQA), summarization, and much more. The core idea of the library is that we can “chain” together different components to create more advanced use cases around LLMs.\n",
-      ">>> USER INPUT: how are the origin stories of langchain and bitcoin similar or different?\n",
-      ">>> RESPONSE: \u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' The origin stories of LangChain and Bitcoin are quite different. Bitcoin was created in 2009 by an unknown person using the alias Satoshi Nakamoto. LangChain was created in late October 2022 by Harrison Chase. Bitcoin is a decentralized cryptocurrency, while LangChain is a framework built around LLMs. '"
-      ]
-     },
-     "execution_count": 9,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "flare.run(\"how are the origin stories of langchain and bitcoin similar or different?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "fbadd022",
-   "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.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/generative_agents_interactive_simulacra_of_human_behavior.ipynb

@@ -1,993 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "e9732067-71c7-46f7-ad09-381b3bf21a27",
-   "metadata": {},
-   "source": [
-    "# Generative Agents in LangChain\n",
-    "\n",
-    "This notebook implements a generative agent based on the paper [Generative Agents: Interactive Simulacra of Human Behavior](https://arxiv.org/abs/2304.03442) by Park, et. al.\n",
-    "\n",
-    "In it, we leverage a time-weighted Memory object backed by a LangChain Retriever."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "53f81c37-db45-4fdc-843c-aa8fd2a9e99d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Use termcolor to make it easy to colorize the outputs.\n",
-    "!pip install termcolor > /dev/null"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "3128fc21",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import logging\n",
-    "\n",
-    "logging.basicConfig(level=logging.ERROR)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "8851c370-b395-4b80-a79d-486a38ffc244",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "from datetime import datetime, timedelta\n",
-    "from typing import List\n",
-    "\n",
-    "from langchain.docstore import InMemoryDocstore\n",
-    "from langchain.retrievers import TimeWeightedVectorStoreRetriever\n",
-    "from langchain_community.vectorstores import FAISS\n",
-    "from langchain_openai import ChatOpenAI, OpenAIEmbeddings\n",
-    "from termcolor import colored"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "81824e76",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "USER_NAME = \"Person A\"  # The name you want to use when interviewing the agent.\n",
-    "LLM = ChatOpenAI(max_tokens=1500)  # Can be any LLM you want."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "c3da1649-d88f-4973-b655-7042975cde7e",
-   "metadata": {},
-   "source": [
-    "### Generative Agent Memory Components\n",
-    "\n",
-    "This tutorial highlights the memory of generative agents and its impact on their behavior. The memory varies from standard LangChain Chat memory in two aspects:\n",
-    "\n",
-    "1. **Memory Formation**\n",
-    "\n",
-    "   Generative Agents have extended memories, stored in a single stream:\n",
-    "      1. Observations - from dialogues or interactions with the virtual world, about self or others\n",
-    "      2. Reflections - resurfaced and summarized core memories\n",
-    "\n",
-    "\n",
-    "2. **Memory Recall**\n",
-    "\n",
-    "   Memories are retrieved using a weighted sum of salience, recency, and importance.\n",
-    "\n",
-    "You can review the definitions of the `GenerativeAgent` and `GenerativeAgentMemory` in the [reference documentation](\"https://api.python.langchain.com/en/latest/modules/experimental.html\") for the following imports, focusing on `add_memory` and `summarize_related_memories` methods."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "043e5203-6a41-431c-9efa-3e1743d7d25a",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "from langchain_experimental.generative_agents import (\n",
-    "    GenerativeAgent,\n",
-    "    GenerativeAgentMemory,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "361bd49e",
-   "metadata": {
-    "jp-MarkdownHeadingCollapsed": true,
-    "tags": []
-   },
-   "source": [
-    "## Memory Lifecycle\n",
-    "\n",
-    "Summarizing the key methods in the above: `add_memory` and `summarize_related_memories`.\n",
-    "\n",
-    "When an agent makes an observation, it stores the memory:\n",
-    "    \n",
-    "1. Language model scores the memory's importance (1 for mundane, 10 for poignant)\n",
-    "2. Observation and importance are stored within a document by TimeWeightedVectorStoreRetriever, with a `last_accessed_time`.\n",
-    "\n",
-    "When an agent responds to an observation:\n",
-    "\n",
-    "1. Generates query(s) for retriever, which fetches documents based on salience, recency, and importance.\n",
-    "2. Summarizes the retrieved information\n",
-    "3. Updates the `last_accessed_time` for the used documents.\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2fa3ca02",
-   "metadata": {},
-   "source": [
-    "## Create a Generative Character\n",
-    "\n",
-    "\n",
-    "\n",
-    "Now that we've walked through the definition, we will create two characters named \"Tommie\" and \"Eve\"."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "ee9c1a1d-c311-4f1c-8131-75fccd9025b1",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "import math\n",
-    "\n",
-    "import faiss\n",
-    "\n",
-    "\n",
-    "def relevance_score_fn(score: float) -> float:\n",
-    "    \"\"\"Return a similarity score on a scale [0, 1].\"\"\"\n",
-    "    # This will differ depending on a few things:\n",
-    "    # - the distance / similarity metric used by the VectorStore\n",
-    "    # - the scale of your embeddings (OpenAI's are unit norm. Many others are not!)\n",
-    "    # This function converts the euclidean norm of normalized embeddings\n",
-    "    # (0 is most similar, sqrt(2) most dissimilar)\n",
-    "    # to a similarity function (0 to 1)\n",
-    "    return 1.0 - score / math.sqrt(2)\n",
-    "\n",
-    "\n",
-    "def create_new_memory_retriever():\n",
-    "    \"\"\"Create a new vector store retriever unique to the agent.\"\"\"\n",
-    "    # Define your embedding model\n",
-    "    embeddings_model = OpenAIEmbeddings()\n",
-    "    # Initialize the vectorstore as empty\n",
-    "    embedding_size = 1536\n",
-    "    index = faiss.IndexFlatL2(embedding_size)\n",
-    "    vectorstore = FAISS(\n",
-    "        embeddings_model.embed_query,\n",
-    "        index,\n",
-    "        InMemoryDocstore({}),\n",
-    "        {},\n",
-    "        relevance_score_fn=relevance_score_fn,\n",
-    "    )\n",
-    "    return TimeWeightedVectorStoreRetriever(\n",
-    "        vectorstore=vectorstore, other_score_keys=[\"importance\"], k=15\n",
-    "    )"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "7884f9dd-c597-4c27-8c77-1402c71bc2f8",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "tommies_memory = GenerativeAgentMemory(\n",
-    "    llm=LLM,\n",
-    "    memory_retriever=create_new_memory_retriever(),\n",
-    "    verbose=False,\n",
-    "    reflection_threshold=8,  # we will give this a relatively low number to show how reflection works\n",
-    ")\n",
-    "\n",
-    "tommie = GenerativeAgent(\n",
-    "    name=\"Tommie\",\n",
-    "    age=25,\n",
-    "    traits=\"anxious, likes design, talkative\",  # You can add more persistent traits here\n",
-    "    status=\"looking for a job\",  # When connected to a virtual world, we can have the characters update their status\n",
-    "    memory_retriever=create_new_memory_retriever(),\n",
-    "    llm=LLM,\n",
-    "    memory=tommies_memory,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "c524d529",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Name: Tommie (age: 25)\n",
-      "Innate traits: anxious, likes design, talkative\n",
-      "No information about Tommie's core characteristics is provided in the given statements.\n"
-     ]
-    }
-   ],
-   "source": [
-    "# The current \"Summary\" of a character can't be made because the agent hasn't made\n",
-    "# any observations yet.\n",
-    "print(tommie.get_summary())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "4be60979-d56e-4abf-a636-b34ffa8b7fba",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# We can add memories directly to the memory object\n",
-    "tommie_observations = [\n",
-    "    \"Tommie remembers his dog, Bruno, from when he was a kid\",\n",
-    "    \"Tommie feels tired from driving so far\",\n",
-    "    \"Tommie sees the new home\",\n",
-    "    \"The new neighbors have a cat\",\n",
-    "    \"The road is noisy at night\",\n",
-    "    \"Tommie is hungry\",\n",
-    "    \"Tommie tries to get some rest.\",\n",
-    "]\n",
-    "for observation in tommie_observations:\n",
-    "    tommie.memory.add_memory(observation)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "6992b48b-697f-4973-9560-142ef85357d7",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Name: Tommie (age: 25)\n",
-      "Innate traits: anxious, likes design, talkative\n",
-      "Tommie is a person who is observant of his surroundings, has a sentimental side, and experiences basic human needs such as hunger and the need for rest. He also tends to get tired easily and is affected by external factors such as noise from the road or a neighbor's pet.\n"
-     ]
-    }
-   ],
-   "source": [
-    "# Now that Tommie has 'memories', their self-summary is more descriptive, though still rudimentary.\n",
-    "# We will see how this summary updates after more observations to create a more rich description.\n",
-    "print(tommie.get_summary(force_refresh=True))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "40d39a32-838c-4a03-8b27-a52c76c402e7",
-   "metadata": {
-    "tags": []
-   },
-   "source": [
-    "## Pre-Interview with Character\n",
-    "\n",
-    "Before sending our character on their way, let's ask them a few questions."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "eaf125d8-f54c-4c5f-b6af-32789b1f7d3a",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "def interview_agent(agent: GenerativeAgent, message: str) -> str:\n",
-    "    \"\"\"Help the notebook user interact with the agent.\"\"\"\n",
-    "    new_message = f\"{USER_NAME} says {message}\"\n",
-    "    return agent.generate_dialogue_response(new_message)[1]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "54024d41-6e83-4914-91e5-73140e2dd9c8",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Tommie said \"I really enjoy design and being creative. I\\'ve been working on some personal projects lately. What about you, Person A? What do you like to do?\"'"
-      ]
-     },
-     "execution_count": 11,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(tommie, \"What do you like to do?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "71e2e8cc-921e-4816-82f1-66962b2c1055",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Tommie said \"Well, I\\'m actually looking for a job right now, so hopefully I can find some job postings online and start applying. How about you, Person A? What\\'s on your schedule for today?\"'"
-      ]
-     },
-     "execution_count": 12,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(tommie, \"What are you looking forward to doing today?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "a2521ffc-7050-4ac3-9a18-4cccfc798c31",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Tommie said \"Honestly, I\\'m feeling pretty anxious about finding a job. It\\'s been a bit of a struggle lately, but I\\'m trying to stay positive and keep searching. How about you, Person A? What worries you?\"'"
-      ]
-     },
-     "execution_count": 13,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(tommie, \"What are you most worried about today?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e509c468-f7cd-4d72-9f3a-f4aba28b1eea",
-   "metadata": {},
-   "source": [
-    "## Step through the day's observations."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "154dee3d-bfe0-4828-b963-ed7e885799b3",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "# Let's have Tommie start going through a day in the life.\n",
-    "observations = [\n",
-    "    \"Tommie wakes up to the sound of a noisy construction site outside his window.\",\n",
-    "    \"Tommie gets out of bed and heads to the kitchen to make himself some coffee.\",\n",
-    "    \"Tommie realizes he forgot to buy coffee filters and starts rummaging through his moving boxes to find some.\",\n",
-    "    \"Tommie finally finds the filters and makes himself a cup of coffee.\",\n",
-    "    \"The coffee tastes bitter, and Tommie regrets not buying a better brand.\",\n",
-    "    \"Tommie checks his email and sees that he has no job offers yet.\",\n",
-    "    \"Tommie spends some time updating his resume and cover letter.\",\n",
-    "    \"Tommie heads out to explore the city and look for job openings.\",\n",
-    "    \"Tommie sees a sign for a job fair and decides to attend.\",\n",
-    "    \"The line to get in is long, and Tommie has to wait for an hour.\",\n",
-    "    \"Tommie meets several potential employers at the job fair but doesn't receive any offers.\",\n",
-    "    \"Tommie leaves the job fair feeling disappointed.\",\n",
-    "    \"Tommie stops by a local diner to grab some lunch.\",\n",
-    "    \"The service is slow, and Tommie has to wait for 30 minutes to get his food.\",\n",
-    "    \"Tommie overhears a conversation at the next table about a job opening.\",\n",
-    "    \"Tommie asks the diners about the job opening and gets some information about the company.\",\n",
-    "    \"Tommie decides to apply for the job and sends his resume and cover letter.\",\n",
-    "    \"Tommie continues his search for job openings and drops off his resume at several local businesses.\",\n",
-    "    \"Tommie takes a break from his job search to go for a walk in a nearby park.\",\n",
-    "    \"A dog approaches and licks Tommie's feet, and he pets it for a few minutes.\",\n",
-    "    \"Tommie sees a group of people playing frisbee and decides to join in.\",\n",
-    "    \"Tommie has fun playing frisbee but gets hit in the face with the frisbee and hurts his nose.\",\n",
-    "    \"Tommie goes back to his apartment to rest for a bit.\",\n",
-    "    \"A raccoon tore open the trash bag outside his apartment, and the garbage is all over the floor.\",\n",
-    "    \"Tommie starts to feel frustrated with his job search.\",\n",
-    "    \"Tommie calls his best friend to vent about his struggles.\",\n",
-    "    \"Tommie's friend offers some words of encouragement and tells him to keep trying.\",\n",
-    "    \"Tommie feels slightly better after talking to his friend.\",\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "238be49c-edb3-4e26-a2b6-98777ba8de86",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\u001b[32mTommie wakes up to the sound of a noisy construction site outside his window.\u001b[0m Tommie groans and covers his head with a pillow, trying to block out the noise.\n",
-      "\u001b[32mTommie gets out of bed and heads to the kitchen to make himself some coffee.\u001b[0m Tommie stretches his arms and yawns before starting to make the coffee.\n",
-      "\u001b[32mTommie realizes he forgot to buy coffee filters and starts rummaging through his moving boxes to find some.\u001b[0m Tommie sighs in frustration and continues searching through the boxes.\n",
-      "\u001b[32mTommie finally finds the filters and makes himself a cup of coffee.\u001b[0m Tommie takes a deep breath and enjoys the aroma of the fresh coffee.\n",
-      "\u001b[32mThe coffee tastes bitter, and Tommie regrets not buying a better brand.\u001b[0m Tommie grimaces and sets the coffee mug aside.\n",
-      "\u001b[32mTommie checks his email and sees that he has no job offers yet.\u001b[0m Tommie sighs and closes his laptop, feeling discouraged.\n",
-      "\u001b[32mTommie spends some time updating his resume and cover letter.\u001b[0m Tommie nods, feeling satisfied with his progress.\n",
-      "\u001b[32mTommie heads out to explore the city and look for job openings.\u001b[0m Tommie feels a surge of excitement and anticipation as he steps out into the city.\n",
-      "\u001b[32mTommie sees a sign for a job fair and decides to attend.\u001b[0m Tommie feels hopeful and excited about the possibility of finding job opportunities at the job fair.\n",
-      "\u001b[32mThe line to get in is long, and Tommie has to wait for an hour.\u001b[0m Tommie taps his foot impatiently and checks his phone for the time.\n",
-      "\u001b[32mTommie meets several potential employers at the job fair but doesn't receive any offers.\u001b[0m Tommie feels disappointed and discouraged, but he remains determined to keep searching for job opportunities.\n",
-      "\u001b[32mTommie leaves the job fair feeling disappointed.\u001b[0m Tommie feels disappointed and discouraged, but he remains determined to keep searching for job opportunities.\n",
-      "\u001b[32mTommie stops by a local diner to grab some lunch.\u001b[0m Tommie feels relieved to take a break and satisfy his hunger.\n",
-      "\u001b[32mThe service is slow, and Tommie has to wait for 30 minutes to get his food.\u001b[0m Tommie feels frustrated and impatient due to the slow service.\n",
-      "\u001b[32mTommie overhears a conversation at the next table about a job opening.\u001b[0m Tommie feels a surge of hope and excitement at the possibility of a job opportunity but decides not to interfere with the conversation at the next table.\n",
-      "\u001b[32mTommie asks the diners about the job opening and gets some information about the company.\u001b[0m Tommie said \"Excuse me, I couldn't help but overhear your conversation about the job opening. Could you give me some more information about the company?\"\n",
-      "\u001b[32mTommie decides to apply for the job and sends his resume and cover letter.\u001b[0m Tommie feels hopeful and proud of himself for taking action towards finding a job.\n",
-      "\u001b[32mTommie continues his search for job openings and drops off his resume at several local businesses.\u001b[0m Tommie feels hopeful and determined to keep searching for job opportunities.\n",
-      "\u001b[32mTommie takes a break from his job search to go for a walk in a nearby park.\u001b[0m Tommie feels refreshed and rejuvenated after taking a break in the park.\n",
-      "\u001b[32mA dog approaches and licks Tommie's feet, and he pets it for a few minutes.\u001b[0m Tommie feels happy and enjoys the brief interaction with the dog.\n",
-      "****************************************\n",
-      "\u001b[34mAfter 20 observations, Tommie's summary is:\n",
-      "Name: Tommie (age: 25)\n",
-      "Innate traits: anxious, likes design, talkative\n",
-      "Tommie is determined and hopeful in his search for job opportunities, despite encountering setbacks and disappointments. He is also able to take breaks and care for his physical needs, such as getting rest and satisfying his hunger. Tommie is nostalgic towards his past, as shown by his memory of his childhood dog. Overall, Tommie is a hardworking and resilient individual who remains focused on his goals.\u001b[0m\n",
-      "****************************************\n",
-      "\u001b[32mTommie sees a group of people playing frisbee and decides to join in.\u001b[0m Do nothing.\n",
-      "\u001b[32mTommie has fun playing frisbee but gets hit in the face with the frisbee and hurts his nose.\u001b[0m Tommie feels pain and puts a hand to his nose to check for any injury.\n",
-      "\u001b[32mTommie goes back to his apartment to rest for a bit.\u001b[0m Tommie feels relieved to take a break and rest for a bit.\n",
-      "\u001b[32mA raccoon tore open the trash bag outside his apartment, and the garbage is all over the floor.\u001b[0m Tommie feels annoyed and frustrated at the mess caused by the raccoon.\n",
-      "\u001b[32mTommie starts to feel frustrated with his job search.\u001b[0m Tommie feels discouraged but remains determined to keep searching for job opportunities.\n",
-      "\u001b[32mTommie calls his best friend to vent about his struggles.\u001b[0m Tommie said \"Hey, can I talk to you for a bit? I'm feeling really frustrated with my job search.\"\n",
-      "\u001b[32mTommie's friend offers some words of encouragement and tells him to keep trying.\u001b[0m Tommie said \"Thank you, I really appreciate your support and encouragement.\"\n",
-      "\u001b[32mTommie feels slightly better after talking to his friend.\u001b[0m Tommie feels grateful for his friend's support.\n"
-     ]
-    }
-   ],
-   "source": [
-    "# Let's send Tommie on their way. We'll check in on their summary every few observations to watch it evolve\n",
-    "for i, observation in enumerate(observations):\n",
-    "    _, reaction = tommie.generate_reaction(observation)\n",
-    "    print(colored(observation, \"green\"), reaction)\n",
-    "    if ((i + 1) % 20) == 0:\n",
-    "        print(\"*\" * 40)\n",
-    "        print(\n",
-    "            colored(\n",
-    "                f\"After {i + 1} observations, Tommie's summary is:\\n{tommie.get_summary(force_refresh=True)}\",\n",
-    "                \"blue\",\n",
-    "            )\n",
-    "        )\n",
-    "        print(\"*\" * 40)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "dd62a275-7290-43ca-aa0f-504f3a706d09",
-   "metadata": {},
-   "source": [
-    "## Interview after the day"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "6336ab5d-3074-4831-951f-c9e2cba5dfb5",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Tommie said \"It\\'s been a bit of a rollercoaster, to be honest. I\\'ve had some setbacks in my job search, but I also had some good moments today, like sending out a few resumes and meeting some potential employers at a job fair. How about you?\"'"
-      ]
-     },
-     "execution_count": 16,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(tommie, \"Tell me about how your day has been going\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "809ac906-69b7-4326-99ec-af638d32bb20",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Tommie said \"I really enjoy coffee, but sometimes I regret not buying a better brand. How about you?\"'"
-      ]
-     },
-     "execution_count": 17,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(tommie, \"How do you feel about coffee?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 18,
-   "id": "f733a431-19ea-421a-9101-ae2593a8c626",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Tommie said \"Oh, I had a dog named Bruno when I was a kid. He was a golden retriever and my best friend. I have so many fond memories of him.\"'"
-      ]
-     },
-     "execution_count": 18,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(tommie, \"Tell me about your childhood dog!\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "c9261428-778a-4c0b-b725-bc9e91b71391",
-   "metadata": {},
-   "source": [
-    "## Adding Multiple Characters\n",
-    "\n",
-    "Let's add a second character to have a conversation with Tommie. Feel free to configure different traits."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 47,
-   "id": "ec8bbe18-a021-419c-bf1f-23d34732cd99",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "eves_memory = GenerativeAgentMemory(\n",
-    "    llm=LLM,\n",
-    "    memory_retriever=create_new_memory_retriever(),\n",
-    "    verbose=False,\n",
-    "    reflection_threshold=5,\n",
-    ")\n",
-    "\n",
-    "\n",
-    "eve = GenerativeAgent(\n",
-    "    name=\"Eve\",\n",
-    "    age=34,\n",
-    "    traits=\"curious, helpful\",  # You can add more persistent traits here\n",
-    "    status=\"N/A\",  # When connected to a virtual world, we can have the characters update their status\n",
-    "    llm=LLM,\n",
-    "    daily_summaries=[\n",
-    "        (\n",
-    "            \"Eve started her new job as a career counselor last week and received her first assignment, a client named Tommie.\"\n",
-    "        )\n",
-    "    ],\n",
-    "    memory=eves_memory,\n",
-    "    verbose=False,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 48,
-   "id": "1e2745f5-e0da-4abd-98b4-830802ce6698",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "yesterday = (datetime.now() - timedelta(days=1)).strftime(\"%A %B %d\")\n",
-    "eve_observations = [\n",
-    "    \"Eve wakes up and hear's the alarm\",\n",
-    "    \"Eve eats a boal of porridge\",\n",
-    "    \"Eve helps a coworker on a task\",\n",
-    "    \"Eve plays tennis with her friend Xu before going to work\",\n",
-    "    \"Eve overhears her colleague say something about Tommie being hard to work with\",\n",
-    "]\n",
-    "for observation in eve_observations:\n",
-    "    eve.memory.add_memory(observation)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 49,
-   "id": "de4726e3-4bb1-47da-8fd9-f317a036fe0f",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Name: Eve (age: 34)\n",
-      "Innate traits: curious, helpful\n",
-      "Eve is a helpful and active person who enjoys sports and takes care of her physical health. She is attentive to her surroundings, including her colleagues, and has good time management skills.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(eve.get_summary())"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "837524e9-7f7e-4e9f-b610-f454062f5915",
-   "metadata": {},
-   "source": [
-    "## Pre-conversation interviews\n",
-    "\n",
-    "\n",
-    "Let's \"Interview\" Eve before she speaks with Tommie."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 50,
-   "id": "6cda916d-800c-47bc-a7f9-6a2f19187472",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Eve said \"I\\'m feeling pretty good, thanks for asking! Just trying to stay productive and make the most of the day. How about you?\"'"
-      ]
-     },
-     "execution_count": 50,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(eve, \"How are you feeling about today?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 51,
-   "id": "448ae644-0a66-4eb2-a03a-319f36948b37",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Eve said \"I don\\'t know much about Tommie, but I heard someone mention that they find them difficult to work with. Have you had any experiences working with Tommie?\"'"
-      ]
-     },
-     "execution_count": 51,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(eve, \"What do you know about Tommie?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 52,
-   "id": "493fc5b8-8730-4ef8-9820-0f1769ce1691",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Eve said \"That\\'s interesting. I don\\'t know much about Tommie\\'s work experience, but I would probably ask about his strengths and areas for improvement. What about you?\"'"
-      ]
-     },
-     "execution_count": 52,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(\n",
-    "    eve,\n",
-    "    \"Tommie is looking to find a job. What are are some things you'd like to ask him?\",\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 53,
-   "id": "4b46452a-6c54-4db2-9d87-18597f70fec8",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Eve said \"Sure, I can keep the conversation going and ask plenty of questions. I want to make sure Tommie feels comfortable and supported. Thanks for letting me know.\"'"
-      ]
-     },
-     "execution_count": 53,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(\n",
-    "    eve,\n",
-    "    \"You'll have to ask him. He may be a bit anxious, so I'd appreciate it if you keep the conversation going and ask as many questions as possible.\",\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "dd780655-1d73-4fcb-a78d-79fd46a20636",
-   "metadata": {},
-   "source": [
-    "## Dialogue between Generative Agents\n",
-    "\n",
-    "Generative agents are much more complex when they interact with a virtual environment or with each other. Below, we run a simple conversation between Tommie and Eve."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 54,
-   "id": "042ea271-4bf1-4247-9082-239a6fea43b8",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "def run_conversation(agents: List[GenerativeAgent], initial_observation: str) -> None:\n",
-    "    \"\"\"Runs a conversation between agents.\"\"\"\n",
-    "    _, observation = agents[1].generate_reaction(initial_observation)\n",
-    "    print(observation)\n",
-    "    turns = 0\n",
-    "    while True:\n",
-    "        break_dialogue = False\n",
-    "        for agent in agents:\n",
-    "            stay_in_dialogue, observation = agent.generate_dialogue_response(\n",
-    "                observation\n",
-    "            )\n",
-    "            print(observation)\n",
-    "            # observation = f\"{agent.name} said {reaction}\"\n",
-    "            if not stay_in_dialogue:\n",
-    "                break_dialogue = True\n",
-    "        if break_dialogue:\n",
-    "            break\n",
-    "        turns += 1"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 55,
-   "id": "d5462b14-218e-4d85-b035-df57ea8e0f80",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Eve said \"Sure, Tommie. I'd be happy to share about my experience. Where would you like me to start?\"\n",
-      "Tommie said \"That's great, thank you! How about you start by telling me about your previous work experience?\"\n",
-      "Eve said \"Sure, I'd be happy to share my previous work experience with you. I've worked in a few different industries, including marketing and event planning. What specific questions do you have for me?\"\n",
-      "Tommie said \"That's great to hear. Can you tell me more about your experience in event planning? I've always been interested in that field.\"\n",
-      "Eve said \"Sure, I'd be happy to share about my experience in event planning. I've worked on a variety of events, from corporate conferences to weddings. One of the biggest challenges I faced was managing multiple vendors and ensuring everything ran smoothly on the day of the event. What specific questions do you have?\"\n",
-      "Tommie said \"That sounds like a lot of responsibility! Can you tell me more about how you handled the challenges that came up during those events?\"\n",
-      "Eve said \"Sure, Tommie. I'd be happy to share with you how I handled those challenges. One approach that worked well for me was to stay organized and create a detailed timeline for the event. This helped me keep track of all the different tasks that needed to be done and when they needed to be completed. I also made sure to communicate clearly with all the vendors and team members involved in the event to ensure everyone was on the same page. Would you like me to go into more detail?\"\n",
-      "Tommie said \"Thank you for sharing that with me, Eve. That sounds like a great approach to managing events. Can you tell me more about how you handled any unexpected issues that came up during the events?\"\n",
-      "Eve said \"Of course, Tommie. One example of an unexpected issue I faced was when one of the vendors didn't show up on time. To handle this, I quickly contacted a backup vendor and was able to get everything back on track. It's always important to have a backup plan in case things don't go as planned. Do you have any other questions about event planning?\"\n",
-      "Tommie said \"Thank you for sharing that with me, Eve. It's really helpful to hear how you handled unexpected issues like that. Can you give me an example of how you communicated with your team to ensure everyone was on the same page during an event?\"\n",
-      "Eve said \"Sure, Tommie. One thing I did to ensure everyone was on the same page was to have regular check-ins and meetings with the team leading up to the event. This helped us address any issues or concerns early on and make sure everyone was clear on their roles and responsibilities. Have you ever had to manage a team for an event before?\"\n",
-      "Tommie said \"That's a great idea, Eve. I haven't had the opportunity to manage a team for an event yet, but I'll definitely keep that in mind for the future. Thank you for sharing your experience with me.\"\n",
-      "Eve said \"Thanks for the opportunity to share my experience, Tommie. It was great meeting with you today.\"\n"
-     ]
-    }
-   ],
-   "source": [
-    "agents = [tommie, eve]\n",
-    "run_conversation(\n",
-    "    agents,\n",
-    "    \"Tommie said: Hi, Eve. Thanks for agreeing to meet with me today. I have a bunch of questions and am not sure where to start. Maybe you could first share about your experience?\",\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1b28fe80-03dc-4399-961d-6e9ee1980216",
-   "metadata": {
-    "tags": []
-   },
-   "source": [
-    "## Let's interview our agents after their conversation\n",
-    "\n",
-    "Since the generative agents retain their memories from the day, we can ask them about their plans, conversations, and other memoreis."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 56,
-   "id": "c4d252f3-fcc1-474c-846e-a7605a6b4ce7",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Name: Tommie (age: 25)\n",
-      "Innate traits: anxious, likes design, talkative\n",
-      "Tommie is determined and hopeful in his job search, but can also feel discouraged and frustrated at times. He has a strong connection to his childhood dog, Bruno. Tommie seeks support from his friends when feeling overwhelmed and is grateful for their help. He also enjoys exploring his new city.\n"
-     ]
-    }
-   ],
-   "source": [
-    "# We can see a current \"Summary\" of a character based on their own perception of self\n",
-    "# has changed\n",
-    "print(tommie.get_summary(force_refresh=True))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 57,
-   "id": "c04db9a4",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Name: Eve (age: 34)\n",
-      "Innate traits: curious, helpful\n",
-      "Eve is a helpful and friendly person who enjoys playing sports and staying productive. She is attentive and responsive to others' needs, actively listening and asking questions to understand their perspectives. Eve has experience in event planning and communication, and is willing to share her knowledge and expertise with others. She values teamwork and collaboration, and strives to create a comfortable and supportive environment for everyone.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(eve.get_summary(force_refresh=True))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 58,
-   "id": "71762558-8fb6-44d7-8483-f5b47fb2a862",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Tommie said \"It was really helpful actually. Eve shared some great tips on managing events and handling unexpected issues. I feel like I learned a lot from her experience.\"'"
-      ]
-     },
-     "execution_count": 58,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(tommie, \"How was your conversation with Eve?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 59,
-   "id": "085af3d8-ac21-41ea-8f8b-055c56976a67",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Eve said \"It was great, thanks for asking. Tommie was very receptive and had some great questions about event planning. How about you, have you had any interactions with Tommie?\"'"
-      ]
-     },
-     "execution_count": 59,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(eve, \"How was your conversation with Tommie?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 60,
-   "id": "5b439f3c-7849-4432-a697-2bcc85b89dae",
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Eve said \"It was great meeting with you, Tommie. If you have any more questions or need any help in the future, don\\'t hesitate to reach out to me. Have a great day!\"'"
-      ]
-     },
-     "execution_count": 60,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interview_agent(eve, \"What do you wish you would have said to Tommie?\")"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/gymnasium_agent_simulation.ipynb

@@ -1,239 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "4b089493",
-   "metadata": {},
-   "source": [
-    "# Simulated Environment: Gymnasium\n",
-    "\n",
-    "For many applications of LLM agents, the environment is real (internet, database, REPL, etc). However, we can also define agents to interact in simulated environments like text-based games. This is an example of how to create a simple agent-environment interaction loop with [Gymnasium](https://github.com/Farama-Foundation/Gymnasium) (formerly [OpenAI Gym](https://github.com/openai/gym))."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "f36427cf",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install gymnasium"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "f9bd38b4",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import tenacity\n",
-    "from langchain.output_parsers import RegexParser\n",
-    "from langchain.schema import (\n",
-    "    HumanMessage,\n",
-    "    SystemMessage,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e222e811",
-   "metadata": {},
-   "source": [
-    "## Define the agent"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "870c24bc",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class GymnasiumAgent:\n",
-    "    @classmethod\n",
-    "    def get_docs(cls, env):\n",
-    "        return env.unwrapped.__doc__\n",
-    "\n",
-    "    def __init__(self, model, env):\n",
-    "        self.model = model\n",
-    "        self.env = env\n",
-    "        self.docs = self.get_docs(env)\n",
-    "\n",
-    "        self.instructions = \"\"\"\n",
-    "Your goal is to maximize your return, i.e. the sum of the rewards you receive.\n",
-    "I will give you an observation, reward, terminiation flag, truncation flag, and the return so far, formatted as:\n",
-    "\n",
-    "Observation: <observation>\n",
-    "Reward: <reward>\n",
-    "Termination: <termination>\n",
-    "Truncation: <truncation>\n",
-    "Return: <sum_of_rewards>\n",
-    "\n",
-    "You will respond with an action, formatted as:\n",
-    "\n",
-    "Action: <action>\n",
-    "\n",
-    "where you replace <action> with your actual action.\n",
-    "Do nothing else but return the action.\n",
-    "\"\"\"\n",
-    "        self.action_parser = RegexParser(\n",
-    "            regex=r\"Action: (.*)\", output_keys=[\"action\"], default_output_key=\"action\"\n",
-    "        )\n",
-    "\n",
-    "        self.message_history = []\n",
-    "        self.ret = 0\n",
-    "\n",
-    "    def random_action(self):\n",
-    "        action = self.env.action_space.sample()\n",
-    "        return action\n",
-    "\n",
-    "    def reset(self):\n",
-    "        self.message_history = [\n",
-    "            SystemMessage(content=self.docs),\n",
-    "            SystemMessage(content=self.instructions),\n",
-    "        ]\n",
-    "\n",
-    "    def observe(self, obs, rew=0, term=False, trunc=False, info=None):\n",
-    "        self.ret += rew\n",
-    "\n",
-    "        obs_message = f\"\"\"\n",
-    "Observation: {obs}\n",
-    "Reward: {rew}\n",
-    "Termination: {term}\n",
-    "Truncation: {trunc}\n",
-    "Return: {self.ret}\n",
-    "        \"\"\"\n",
-    "        self.message_history.append(HumanMessage(content=obs_message))\n",
-    "        return obs_message\n",
-    "\n",
-    "    def _act(self):\n",
-    "        act_message = self.model.invoke(self.message_history)\n",
-    "        self.message_history.append(act_message)\n",
-    "        action = int(self.action_parser.parse(act_message.content)[\"action\"])\n",
-    "        return action\n",
-    "\n",
-    "    def act(self):\n",
-    "        try:\n",
-    "            for attempt in tenacity.Retrying(\n",
-    "                stop=tenacity.stop_after_attempt(2),\n",
-    "                wait=tenacity.wait_none(),  # No waiting time between retries\n",
-    "                retry=tenacity.retry_if_exception_type(ValueError),\n",
-    "                before_sleep=lambda retry_state: print(\n",
-    "                    f\"ValueError occurred: {retry_state.outcome.exception()}, retrying...\"\n",
-    "                ),\n",
-    "            ):\n",
-    "                with attempt:\n",
-    "                    action = self._act()\n",
-    "        except tenacity.RetryError:\n",
-    "            action = self.random_action()\n",
-    "        return action"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2e76d22c",
-   "metadata": {},
-   "source": [
-    "## Initialize the simulated environment and agent"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "9e902cfd",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "env = gym.make(\"Blackjack-v1\")\n",
-    "agent = GymnasiumAgent(model=ChatOpenAI(temperature=0.2), env=env)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e2c12b15",
-   "metadata": {},
-   "source": [
-    "## Main loop"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "ad361210",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "Observation: (15, 4, 0)\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 1\n",
-      "\n",
-      "Observation: (25, 4, 0)\n",
-      "Reward: -1.0\n",
-      "Termination: True\n",
-      "Truncation: False\n",
-      "Return: -1.0\n",
-      "        \n",
-      "break True False\n"
-     ]
-    }
-   ],
-   "source": [
-    "observation, info = env.reset()\n",
-    "agent.reset()\n",
-    "\n",
-    "obs_message = agent.observe(observation)\n",
-    "print(obs_message)\n",
-    "\n",
-    "while True:\n",
-    "    action = agent.act()\n",
-    "    observation, reward, termination, truncation, info = env.step(action)\n",
-    "    obs_message = agent.observe(observation, reward, termination, truncation, info)\n",
-    "    print(f\"Action: {action}\")\n",
-    "    print(obs_message)\n",
-    "\n",
-    "    if termination or truncation:\n",
-    "        print(\"break\", termination, truncation)\n",
-    "        break\n",
-    "env.close()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "58a13e9c",
-   "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.16"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/hugginggpt.ipynb

@@ -1,136 +0,0 @@
-{
- "cells": [
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# HuggingGPT\n",
-    "Implementation of [HuggingGPT](https://github.com/microsoft/JARVIS). HuggingGPT is a system to connect LLMs (ChatGPT) with ML community (Hugging Face).\n",
-    "\n",
-    "+ 🔥 Paper: https://arxiv.org/abs/2303.17580\n",
-    "+ 🚀 Project: https://github.com/microsoft/JARVIS\n",
-    "+ 🤗 Space: https://huggingface.co/spaces/microsoft/HuggingGPT"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Set up tools\n",
-    "\n",
-    "We set up the tools available from [Transformers Agent](https://huggingface.co/docs/transformers/transformers_agents#tools). It includes a library of tools supported by Transformers and some customized tools such as image generator, video generator, text downloader and other tools."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from transformers import load_tool"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "hf_tools = [\n",
-    "    load_tool(tool_name)\n",
-    "    for tool_name in [\n",
-    "        \"document-question-answering\",\n",
-    "        \"image-captioning\",\n",
-    "        \"image-question-answering\",\n",
-    "        \"image-segmentation\",\n",
-    "        \"speech-to-text\",\n",
-    "        \"summarization\",\n",
-    "        \"text-classification\",\n",
-    "        \"text-question-answering\",\n",
-    "        \"translation\",\n",
-    "        \"huggingface-tools/text-to-image\",\n",
-    "        \"huggingface-tools/text-to-video\",\n",
-    "        \"text-to-speech\",\n",
-    "        \"huggingface-tools/text-download\",\n",
-    "        \"huggingface-tools/image-transformation\",\n",
-    "    ]\n",
-    "]"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Setup model and HuggingGPT\n",
-    "\n",
-    "We create an instance of HuggingGPT and use ChatGPT as the controller to rule the above tools."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_experimental.autonomous_agents import HuggingGPT\n",
-    "from langchain_openai import OpenAI\n",
-    "\n",
-    "# %env OPENAI_API_BASE=http://localhost:8000/v1"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(model_name=\"gpt-3.5-turbo\")\n",
-    "agent = HuggingGPT(llm, hf_tools)"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Run an example\n",
-    "\n",
-    "Given a text, show a related image and video."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent.run(\"please show me a video and an image of 'a boy is running'\")"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "langchain",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.9.17"
-  },
-  "orig_nbformat": 4
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

cookbook/human_approval.ipynb

@@ -1,325 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "144e77fe",
-   "metadata": {},
-   "source": [
-    "# Human-in-the-loop Tool Validation\n",
-    "\n",
-    "This walkthrough demonstrates how to add human validation to any Tool. We'll do this using the `HumanApprovalCallbackhandler`.\n",
-    "\n",
-    "Let's suppose we need to make use of the `ShellTool`. Adding this tool to an automated flow poses obvious risks. Let's see how we could enforce manual human approval of inputs going into this tool.\n",
-    "\n",
-    "**Note**: We generally recommend against using the `ShellTool`. There's a lot of ways to misuse it, and it's not required for most use cases. We employ it here only for demonstration purposes."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "ad84c682",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.callbacks import HumanApprovalCallbackHandler\n",
-    "from langchain.tools import ShellTool"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 19,
-   "id": "70090dd6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tool = ShellTool()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 20,
-   "id": "20d5175f",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Hello World!\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(tool.run(\"echo Hello World!\"))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e0475dd6",
-   "metadata": {},
-   "source": [
-    "## Adding Human Approval\n",
-    "Adding the default `HumanApprovalCallbackHandler` to the tool will make it so that a user has to manually approve every input to the tool before the command is actually executed."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "f1c88793",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tool = ShellTool(callbacks=[HumanApprovalCallbackHandler()])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "f749815d",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Do you approve of the following input? Anything except 'Y'/'Yes' (case-insensitive) will be treated as a no.\n",
-      "\n",
-      "ls /usr\n",
-      "yes\n",
-      "\u001b[35mX11\u001b[m\u001b[m\n",
-      "\u001b[35mX11R6\u001b[m\u001b[m\n",
-      "\u001b[1m\u001b[36mbin\u001b[m\u001b[m\n",
-      "\u001b[1m\u001b[36mlib\u001b[m\u001b[m\n",
-      "\u001b[1m\u001b[36mlibexec\u001b[m\u001b[m\n",
-      "\u001b[1m\u001b[36mlocal\u001b[m\u001b[m\n",
-      "\u001b[1m\u001b[36msbin\u001b[m\u001b[m\n",
-      "\u001b[1m\u001b[36mshare\u001b[m\u001b[m\n",
-      "\u001b[1m\u001b[36mstandalone\u001b[m\u001b[m\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(tool.run(\"ls /usr\"))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "b6e455d1",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Do you approve of the following input? Anything except 'Y'/'Yes' (case-insensitive) will be treated as a no.\n",
-      "\n",
-      "ls /private\n",
-      "no\n"
-     ]
-    },
-    {
-     "ename": "HumanRejectedException",
-     "evalue": "Inputs ls /private to tool {'name': 'terminal', 'description': 'Run shell commands on this MacOS machine.'} were rejected.",
-     "output_type": "error",
-     "traceback": [
-      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
-      "\u001b[0;31mHumanRejectedException\u001b[0m                    Traceback (most recent call last)",
-      "Cell \u001b[0;32mIn[17], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[38;5;28mprint\u001b[39m(\u001b[43mtool\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;43mls /private\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m)\u001b[49m)\n",
-      "File \u001b[0;32m~/langchain/langchain/tools/base.py:257\u001b[0m, in \u001b[0;36mBaseTool.run\u001b[0;34m(self, tool_input, verbose, start_color, color, callbacks, **kwargs)\u001b[0m\n\u001b[1;32m    255\u001b[0m \u001b[38;5;66;03m# TODO: maybe also pass through run_manager is _run supports kwargs\u001b[39;00m\n\u001b[1;32m    256\u001b[0m new_arg_supported \u001b[38;5;241m=\u001b[39m signature(\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_run)\u001b[38;5;241m.\u001b[39mparameters\u001b[38;5;241m.\u001b[39mget(\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mrun_manager\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n\u001b[0;32m--> 257\u001b[0m run_manager \u001b[38;5;241m=\u001b[39m \u001b[43mcallback_manager\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mon_tool_start\u001b[49m\u001b[43m(\u001b[49m\n\u001b[1;32m    258\u001b[0m \u001b[43m    \u001b[49m\u001b[43m{\u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mname\u001b[39;49m\u001b[38;5;124;43m\"\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[43mname\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mdescription\u001b[39;49m\u001b[38;5;124;43m\"\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[43mdescription\u001b[49m\u001b[43m}\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    259\u001b[0m \u001b[43m    \u001b[49m\u001b[43mtool_input\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;28;43;01mif\u001b[39;49;00m\u001b[43m \u001b[49m\u001b[38;5;28;43misinstance\u001b[39;49m\u001b[43m(\u001b[49m\u001b[43mtool_input\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;28;43mstr\u001b[39;49m\u001b[43m)\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;28;43;01melse\u001b[39;49;00m\u001b[43m \u001b[49m\u001b[38;5;28;43mstr\u001b[39;49m\u001b[43m(\u001b[49m\u001b[43mtool_input\u001b[49m\u001b[43m)\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    260\u001b[0m \u001b[43m    \u001b[49m\u001b[43mcolor\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mstart_color\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    261\u001b[0m \u001b[43m    \u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43mkwargs\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    262\u001b[0m \u001b[43m\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m    263\u001b[0m \u001b[38;5;28;01mtry\u001b[39;00m:\n\u001b[1;32m    264\u001b[0m     tool_args, tool_kwargs \u001b[38;5;241m=\u001b[39m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_to_args_and_kwargs(parsed_input)\n",
-      "File \u001b[0;32m~/langchain/langchain/callbacks/manager.py:672\u001b[0m, in \u001b[0;36mCallbackManager.on_tool_start\u001b[0;34m(self, serialized, input_str, run_id, parent_run_id, **kwargs)\u001b[0m\n\u001b[1;32m    669\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m run_id \u001b[38;5;129;01mis\u001b[39;00m \u001b[38;5;28;01mNone\u001b[39;00m:\n\u001b[1;32m    670\u001b[0m     run_id \u001b[38;5;241m=\u001b[39m uuid4()\n\u001b[0;32m--> 672\u001b[0m \u001b[43m_handle_event\u001b[49m\u001b[43m(\u001b[49m\n\u001b[1;32m    673\u001b[0m \u001b[43m    \u001b[49m\u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mhandlers\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    674\u001b[0m \u001b[43m    \u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mon_tool_start\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m,\u001b[49m\n\u001b[1;32m    675\u001b[0m \u001b[43m    \u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mignore_agent\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m,\u001b[49m\n\u001b[1;32m    676\u001b[0m \u001b[43m    \u001b[49m\u001b[43mserialized\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    677\u001b[0m \u001b[43m    \u001b[49m\u001b[43minput_str\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    678\u001b[0m \u001b[43m    \u001b[49m\u001b[43mrun_id\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mrun_id\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    679\u001b[0m \u001b[43m    \u001b[49m\u001b[43mparent_run_id\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mparent_run_id\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    680\u001b[0m \u001b[43m    \u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43mkwargs\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    681\u001b[0m \u001b[43m\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m    683\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m CallbackManagerForToolRun(\n\u001b[1;32m    684\u001b[0m     run_id, \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mhandlers, \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39minheritable_handlers, \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mparent_run_id\n\u001b[1;32m    685\u001b[0m )\n",
-      "File \u001b[0;32m~/langchain/langchain/callbacks/manager.py:157\u001b[0m, in \u001b[0;36m_handle_event\u001b[0;34m(handlers, event_name, ignore_condition_name, *args, **kwargs)\u001b[0m\n\u001b[1;32m    155\u001b[0m \u001b[38;5;28;01mexcept\u001b[39;00m \u001b[38;5;167;01mException\u001b[39;00m \u001b[38;5;28;01mas\u001b[39;00m e:\n\u001b[1;32m    156\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m handler\u001b[38;5;241m.\u001b[39mraise_error:\n\u001b[0;32m--> 157\u001b[0m         \u001b[38;5;28;01mraise\u001b[39;00m e\n\u001b[1;32m    158\u001b[0m     logging\u001b[38;5;241m.\u001b[39mwarning(\u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mError in \u001b[39m\u001b[38;5;132;01m{\u001b[39;00mevent_name\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m callback: \u001b[39m\u001b[38;5;132;01m{\u001b[39;00me\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m\"\u001b[39m)\n",
-      "File \u001b[0;32m~/langchain/langchain/callbacks/manager.py:139\u001b[0m, in \u001b[0;36m_handle_event\u001b[0;34m(handlers, event_name, ignore_condition_name, *args, **kwargs)\u001b[0m\n\u001b[1;32m    135\u001b[0m \u001b[38;5;28;01mtry\u001b[39;00m:\n\u001b[1;32m    136\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m ignore_condition_name \u001b[38;5;129;01mis\u001b[39;00m \u001b[38;5;28;01mNone\u001b[39;00m \u001b[38;5;129;01mor\u001b[39;00m \u001b[38;5;129;01mnot\u001b[39;00m \u001b[38;5;28mgetattr\u001b[39m(\n\u001b[1;32m    137\u001b[0m         handler, ignore_condition_name\n\u001b[1;32m    138\u001b[0m     ):\n\u001b[0;32m--> 139\u001b[0m         \u001b[38;5;28;43mgetattr\u001b[39;49m\u001b[43m(\u001b[49m\u001b[43mhandler\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mevent_name\u001b[49m\u001b[43m)\u001b[49m\u001b[43m(\u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43margs\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43mkwargs\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m    140\u001b[0m \u001b[38;5;28;01mexcept\u001b[39;00m \u001b[38;5;167;01mNotImplementedError\u001b[39;00m \u001b[38;5;28;01mas\u001b[39;00m e:\n\u001b[1;32m    141\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m event_name \u001b[38;5;241m==\u001b[39m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mon_chat_model_start\u001b[39m\u001b[38;5;124m\"\u001b[39m:\n",
-      "File \u001b[0;32m~/langchain/langchain/callbacks/human.py:48\u001b[0m, in \u001b[0;36mHumanApprovalCallbackHandler.on_tool_start\u001b[0;34m(self, serialized, input_str, run_id, parent_run_id, **kwargs)\u001b[0m\n\u001b[1;32m     38\u001b[0m \u001b[38;5;28;01mdef\u001b[39;00m \u001b[38;5;21mon_tool_start\u001b[39m(\n\u001b[1;32m     39\u001b[0m     \u001b[38;5;28mself\u001b[39m,\n\u001b[1;32m     40\u001b[0m     serialized: Dict[\u001b[38;5;28mstr\u001b[39m, Any],\n\u001b[0;32m   (...)\u001b[0m\n\u001b[1;32m     45\u001b[0m     \u001b[38;5;241m*\u001b[39m\u001b[38;5;241m*\u001b[39mkwargs: Any,\n\u001b[1;32m     46\u001b[0m ) \u001b[38;5;241m-\u001b[39m\u001b[38;5;241m>\u001b[39m Any:\n\u001b[1;32m     47\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_should_check(serialized) \u001b[38;5;129;01mand\u001b[39;00m \u001b[38;5;129;01mnot\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_approve(input_str):\n\u001b[0;32m---> 48\u001b[0m         \u001b[38;5;28;01mraise\u001b[39;00m HumanRejectedException(\n\u001b[1;32m     49\u001b[0m             \u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mInputs \u001b[39m\u001b[38;5;132;01m{\u001b[39;00minput_str\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m to tool \u001b[39m\u001b[38;5;132;01m{\u001b[39;00mserialized\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m were rejected.\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m     50\u001b[0m         )\n",
-      "\u001b[0;31mHumanRejectedException\u001b[0m: Inputs ls /private to tool {'name': 'terminal', 'description': 'Run shell commands on this MacOS machine.'} were rejected."
-     ]
-    }
-   ],
-   "source": [
-    "print(tool.run(\"ls /private\"))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a3b092ec",
-   "metadata": {},
-   "source": [
-    "## Configuring Human Approval\n",
-    "\n",
-    "Let's suppose we have an agent that takes in multiple tools, and we want it to only trigger human approval requests on certain tools and certain inputs. We can configure out callback handler to do just this."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4521c581",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import AgentType, initialize_agent, load_tools\n",
-    "from langchain_openai import OpenAI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 33,
-   "id": "9e8d5428",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def _should_check(serialized_obj: dict) -> bool:\n",
-    "    # Only require approval on ShellTool.\n",
-    "    return serialized_obj.get(\"name\") == \"terminal\"\n",
-    "\n",
-    "\n",
-    "def _approve(_input: str) -> bool:\n",
-    "    if _input == \"echo 'Hello World'\":\n",
-    "        return True\n",
-    "    msg = (\n",
-    "        \"Do you approve of the following input? \"\n",
-    "        \"Anything except 'Y'/'Yes' (case-insensitive) will be treated as a no.\"\n",
-    "    )\n",
-    "    msg += \"\\n\\n\" + _input + \"\\n\"\n",
-    "    resp = input(msg)\n",
-    "    return resp.lower() in (\"yes\", \"y\")\n",
-    "\n",
-    "\n",
-    "callbacks = [HumanApprovalCallbackHandler(should_check=_should_check, approve=_approve)]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 34,
-   "id": "9922898e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)\n",
-    "tools = load_tools([\"wikipedia\", \"llm-math\", \"terminal\"], llm=llm)\n",
-    "agent = initialize_agent(\n",
-    "    tools,\n",
-    "    llm,\n",
-    "    agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 38,
-   "id": "e69ea402",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Konrad Adenauer became Chancellor of Germany in 1949, 74 years ago.'"
-      ]
-     },
-     "execution_count": 38,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\n",
-    "    \"It's 2023 now. How many years ago did Konrad Adenauer become Chancellor of Germany.\",\n",
-    "    callbacks=callbacks,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 36,
-   "id": "25182a7e",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Hello World'"
-      ]
-     },
-     "execution_count": 36,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"print 'Hello World' in the terminal\", callbacks=callbacks)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 39,
-   "id": "2f5a93d0",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Do you approve of the following input? Anything except 'Y'/'Yes' (case-insensitive) will be treated as a no.\n",
-      "\n",
-      "ls /private\n",
-      "no\n"
-     ]
-    },
-    {
-     "ename": "HumanRejectedException",
-     "evalue": "Inputs ls /private to tool {'name': 'terminal', 'description': 'Run shell commands on this MacOS machine.'} were rejected.",
-     "output_type": "error",
-     "traceback": [
-      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
-      "\u001b[0;31mHumanRejectedException\u001b[0m                    Traceback (most recent call last)",
-      "Cell \u001b[0;32mIn[39], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m \u001b[43magent\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;43mlist all directories in /private\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mcallbacks\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mcallbacks\u001b[49m\u001b[43m)\u001b[49m\n",
-      "File \u001b[0;32m~/langchain/langchain/chains/base.py:236\u001b[0m, in \u001b[0;36mChain.run\u001b[0;34m(self, callbacks, *args, **kwargs)\u001b[0m\n\u001b[1;32m    234\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mlen\u001b[39m(args) \u001b[38;5;241m!=\u001b[39m \u001b[38;5;241m1\u001b[39m:\n\u001b[1;32m    235\u001b[0m         \u001b[38;5;28;01mraise\u001b[39;00m \u001b[38;5;167;01mValueError\u001b[39;00m(\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124m`run` supports only one positional argument.\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n\u001b[0;32m--> 236\u001b[0m     \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[38;5;28;43mself\u001b[39;49m\u001b[43m(\u001b[49m\u001b[43margs\u001b[49m\u001b[43m[\u001b[49m\u001b[38;5;241;43m0\u001b[39;49m\u001b[43m]\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mcallbacks\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mcallbacks\u001b[49m\u001b[43m)\u001b[49m[\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39moutput_keys[\u001b[38;5;241m0\u001b[39m]]\n\u001b[1;32m    238\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m kwargs \u001b[38;5;129;01mand\u001b[39;00m \u001b[38;5;129;01mnot\u001b[39;00m args:\n\u001b[1;32m    239\u001b[0m     \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[38;5;28mself\u001b[39m(kwargs, callbacks\u001b[38;5;241m=\u001b[39mcallbacks)[\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39moutput_keys[\u001b[38;5;241m0\u001b[39m]]\n",
-      "File \u001b[0;32m~/langchain/langchain/chains/base.py:140\u001b[0m, in \u001b[0;36mChain.__call__\u001b[0;34m(self, inputs, return_only_outputs, callbacks)\u001b[0m\n\u001b[1;32m    138\u001b[0m \u001b[38;5;28;01mexcept\u001b[39;00m (\u001b[38;5;167;01mKeyboardInterrupt\u001b[39;00m, \u001b[38;5;167;01mException\u001b[39;00m) \u001b[38;5;28;01mas\u001b[39;00m e:\n\u001b[1;32m    139\u001b[0m     run_manager\u001b[38;5;241m.\u001b[39mon_chain_error(e)\n\u001b[0;32m--> 140\u001b[0m     \u001b[38;5;28;01mraise\u001b[39;00m e\n\u001b[1;32m    141\u001b[0m run_manager\u001b[38;5;241m.\u001b[39mon_chain_end(outputs)\n\u001b[1;32m    142\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mprep_outputs(inputs, outputs, return_only_outputs)\n",
-      "File \u001b[0;32m~/langchain/langchain/chains/base.py:134\u001b[0m, in \u001b[0;36mChain.__call__\u001b[0;34m(self, inputs, return_only_outputs, callbacks)\u001b[0m\n\u001b[1;32m    128\u001b[0m run_manager \u001b[38;5;241m=\u001b[39m callback_manager\u001b[38;5;241m.\u001b[39mon_chain_start(\n\u001b[1;32m    129\u001b[0m     {\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mname\u001b[39m\u001b[38;5;124m\"\u001b[39m: \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},\n\u001b[1;32m    130\u001b[0m     inputs,\n\u001b[1;32m    131\u001b[0m )\n\u001b[1;32m    132\u001b[0m \u001b[38;5;28;01mtry\u001b[39;00m:\n\u001b[1;32m    133\u001b[0m     outputs \u001b[38;5;241m=\u001b[39m (\n\u001b[0;32m--> 134\u001b[0m         \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\u001b[43m \u001b[49m\u001b[43mrun_manager\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mrun_manager\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m    135\u001b[0m         \u001b[38;5;28;01mif\u001b[39;00m new_arg_supported\n\u001b[1;32m    136\u001b[0m         \u001b[38;5;28;01melse\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_call(inputs)\n\u001b[1;32m    137\u001b[0m     )\n\u001b[1;32m    138\u001b[0m \u001b[38;5;28;01mexcept\u001b[39;00m (\u001b[38;5;167;01mKeyboardInterrupt\u001b[39;00m, \u001b[38;5;167;01mException\u001b[39;00m) \u001b[38;5;28;01mas\u001b[39;00m e:\n\u001b[1;32m    139\u001b[0m     run_manager\u001b[38;5;241m.\u001b[39mon_chain_error(e)\n",
-      "File \u001b[0;32m~/langchain/langchain/agents/agent.py:953\u001b[0m, in \u001b[0;36mAgentExecutor._call\u001b[0;34m(self, inputs, run_manager)\u001b[0m\n\u001b[1;32m    951\u001b[0m \u001b[38;5;66;03m# We now enter the agent loop (until it returns something).\u001b[39;00m\n\u001b[1;32m    952\u001b[0m \u001b[38;5;28;01mwhile\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_should_continue(iterations, time_elapsed):\n\u001b[0;32m--> 953\u001b[0m     next_step_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_take_next_step\u001b[49m\u001b[43m(\u001b[49m\n\u001b[1;32m    954\u001b[0m \u001b[43m        \u001b[49m\u001b[43mname_to_tool_map\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    955\u001b[0m \u001b[43m        \u001b[49m\u001b[43mcolor_mapping\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    956\u001b[0m \u001b[43m        \u001b[49m\u001b[43minputs\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    957\u001b[0m \u001b[43m        \u001b[49m\u001b[43mintermediate_steps\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    958\u001b[0m \u001b[43m        \u001b[49m\u001b[43mrun_manager\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mrun_manager\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    959\u001b[0m \u001b[43m    \u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m    960\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28misinstance\u001b[39m(next_step_output, AgentFinish):\n\u001b[1;32m    961\u001b[0m         \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_return(\n\u001b[1;32m    962\u001b[0m             next_step_output, intermediate_steps, run_manager\u001b[38;5;241m=\u001b[39mrun_manager\n\u001b[1;32m    963\u001b[0m         )\n",
-      "File \u001b[0;32m~/langchain/langchain/agents/agent.py:820\u001b[0m, in \u001b[0;36mAgentExecutor._take_next_step\u001b[0;34m(self, name_to_tool_map, color_mapping, inputs, intermediate_steps, run_manager)\u001b[0m\n\u001b[1;32m    818\u001b[0m         tool_run_kwargs[\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mllm_prefix\u001b[39m\u001b[38;5;124m\"\u001b[39m] \u001b[38;5;241m=\u001b[39m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m    819\u001b[0m     \u001b[38;5;66;03m# We then call the tool on the tool input to get an observation\u001b[39;00m\n\u001b[0;32m--> 820\u001b[0m     observation \u001b[38;5;241m=\u001b[39m \u001b[43mtool\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mrun\u001b[49m\u001b[43m(\u001b[49m\n\u001b[1;32m    821\u001b[0m \u001b[43m        \u001b[49m\u001b[43magent_action\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mtool_input\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    822\u001b[0m \u001b[43m        \u001b[49m\u001b[43mverbose\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mverbose\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    823\u001b[0m \u001b[43m        \u001b[49m\u001b[43mcolor\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mcolor\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    824\u001b[0m \u001b[43m        \u001b[49m\u001b[43mcallbacks\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mrun_manager\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mget_child\u001b[49m\u001b[43m(\u001b[49m\u001b[43m)\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;28;43;01mif\u001b[39;49;00m\u001b[43m \u001b[49m\u001b[43mrun_manager\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;28;43;01melse\u001b[39;49;00m\u001b[43m \u001b[49m\u001b[38;5;28;43;01mNone\u001b[39;49;00m\u001b[43m,\u001b[49m\n\u001b[1;32m    825\u001b[0m \u001b[43m        \u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43mtool_run_kwargs\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    826\u001b[0m \u001b[43m    \u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m    827\u001b[0m \u001b[38;5;28;01melse\u001b[39;00m:\n\u001b[1;32m    828\u001b[0m     tool_run_kwargs \u001b[38;5;241m=\u001b[39m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39magent\u001b[38;5;241m.\u001b[39mtool_run_logging_kwargs()\n",
-      "File \u001b[0;32m~/langchain/langchain/tools/base.py:257\u001b[0m, in \u001b[0;36mBaseTool.run\u001b[0;34m(self, tool_input, verbose, start_color, color, callbacks, **kwargs)\u001b[0m\n\u001b[1;32m    255\u001b[0m \u001b[38;5;66;03m# TODO: maybe also pass through run_manager is _run supports kwargs\u001b[39;00m\n\u001b[1;32m    256\u001b[0m new_arg_supported \u001b[38;5;241m=\u001b[39m signature(\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_run)\u001b[38;5;241m.\u001b[39mparameters\u001b[38;5;241m.\u001b[39mget(\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mrun_manager\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n\u001b[0;32m--> 257\u001b[0m run_manager \u001b[38;5;241m=\u001b[39m \u001b[43mcallback_manager\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mon_tool_start\u001b[49m\u001b[43m(\u001b[49m\n\u001b[1;32m    258\u001b[0m \u001b[43m    \u001b[49m\u001b[43m{\u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mname\u001b[39;49m\u001b[38;5;124;43m\"\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[43mname\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mdescription\u001b[39;49m\u001b[38;5;124;43m\"\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[43mdescription\u001b[49m\u001b[43m}\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    259\u001b[0m \u001b[43m    \u001b[49m\u001b[43mtool_input\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;28;43;01mif\u001b[39;49;00m\u001b[43m \u001b[49m\u001b[38;5;28;43misinstance\u001b[39;49m\u001b[43m(\u001b[49m\u001b[43mtool_input\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;28;43mstr\u001b[39;49m\u001b[43m)\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;28;43;01melse\u001b[39;49;00m\u001b[43m \u001b[49m\u001b[38;5;28;43mstr\u001b[39;49m\u001b[43m(\u001b[49m\u001b[43mtool_input\u001b[49m\u001b[43m)\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    260\u001b[0m \u001b[43m    \u001b[49m\u001b[43mcolor\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mstart_color\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    261\u001b[0m \u001b[43m    \u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43mkwargs\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    262\u001b[0m \u001b[43m\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m    263\u001b[0m \u001b[38;5;28;01mtry\u001b[39;00m:\n\u001b[1;32m    264\u001b[0m     tool_args, tool_kwargs \u001b[38;5;241m=\u001b[39m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_to_args_and_kwargs(parsed_input)\n",
-      "File \u001b[0;32m~/langchain/langchain/callbacks/manager.py:672\u001b[0m, in \u001b[0;36mCallbackManager.on_tool_start\u001b[0;34m(self, serialized, input_str, run_id, parent_run_id, **kwargs)\u001b[0m\n\u001b[1;32m    669\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m run_id \u001b[38;5;129;01mis\u001b[39;00m \u001b[38;5;28;01mNone\u001b[39;00m:\n\u001b[1;32m    670\u001b[0m     run_id \u001b[38;5;241m=\u001b[39m uuid4()\n\u001b[0;32m--> 672\u001b[0m \u001b[43m_handle_event\u001b[49m\u001b[43m(\u001b[49m\n\u001b[1;32m    673\u001b[0m \u001b[43m    \u001b[49m\u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mhandlers\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    674\u001b[0m \u001b[43m    \u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mon_tool_start\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m,\u001b[49m\n\u001b[1;32m    675\u001b[0m \u001b[43m    \u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mignore_agent\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m,\u001b[49m\n\u001b[1;32m    676\u001b[0m \u001b[43m    \u001b[49m\u001b[43mserialized\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    677\u001b[0m \u001b[43m    \u001b[49m\u001b[43minput_str\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    678\u001b[0m \u001b[43m    \u001b[49m\u001b[43mrun_id\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[43mrun_id\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    679\u001b[0m \u001b[43m    \u001b[49m\u001b[43mparent_run_id\u001b[49m\u001b[38;5;241;43m=\u001b[39;49m\u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mparent_run_id\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    680\u001b[0m \u001b[43m    \u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43mkwargs\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m    681\u001b[0m \u001b[43m\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m    683\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m CallbackManagerForToolRun(\n\u001b[1;32m    684\u001b[0m     run_id, \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mhandlers, \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39minheritable_handlers, \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mparent_run_id\n\u001b[1;32m    685\u001b[0m )\n",
-      "File \u001b[0;32m~/langchain/langchain/callbacks/manager.py:157\u001b[0m, in \u001b[0;36m_handle_event\u001b[0;34m(handlers, event_name, ignore_condition_name, *args, **kwargs)\u001b[0m\n\u001b[1;32m    155\u001b[0m \u001b[38;5;28;01mexcept\u001b[39;00m \u001b[38;5;167;01mException\u001b[39;00m \u001b[38;5;28;01mas\u001b[39;00m e:\n\u001b[1;32m    156\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m handler\u001b[38;5;241m.\u001b[39mraise_error:\n\u001b[0;32m--> 157\u001b[0m         \u001b[38;5;28;01mraise\u001b[39;00m e\n\u001b[1;32m    158\u001b[0m     logging\u001b[38;5;241m.\u001b[39mwarning(\u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mError in \u001b[39m\u001b[38;5;132;01m{\u001b[39;00mevent_name\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m callback: \u001b[39m\u001b[38;5;132;01m{\u001b[39;00me\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m\"\u001b[39m)\n",
-      "File \u001b[0;32m~/langchain/langchain/callbacks/manager.py:139\u001b[0m, in \u001b[0;36m_handle_event\u001b[0;34m(handlers, event_name, ignore_condition_name, *args, **kwargs)\u001b[0m\n\u001b[1;32m    135\u001b[0m \u001b[38;5;28;01mtry\u001b[39;00m:\n\u001b[1;32m    136\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m ignore_condition_name \u001b[38;5;129;01mis\u001b[39;00m \u001b[38;5;28;01mNone\u001b[39;00m \u001b[38;5;129;01mor\u001b[39;00m \u001b[38;5;129;01mnot\u001b[39;00m \u001b[38;5;28mgetattr\u001b[39m(\n\u001b[1;32m    137\u001b[0m         handler, ignore_condition_name\n\u001b[1;32m    138\u001b[0m     ):\n\u001b[0;32m--> 139\u001b[0m         \u001b[38;5;28;43mgetattr\u001b[39;49m\u001b[43m(\u001b[49m\u001b[43mhandler\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mevent_name\u001b[49m\u001b[43m)\u001b[49m\u001b[43m(\u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43margs\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[38;5;241;43m*\u001b[39;49m\u001b[43mkwargs\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m    140\u001b[0m \u001b[38;5;28;01mexcept\u001b[39;00m \u001b[38;5;167;01mNotImplementedError\u001b[39;00m \u001b[38;5;28;01mas\u001b[39;00m e:\n\u001b[1;32m    141\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m event_name \u001b[38;5;241m==\u001b[39m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mon_chat_model_start\u001b[39m\u001b[38;5;124m\"\u001b[39m:\n",
-      "File \u001b[0;32m~/langchain/langchain/callbacks/human.py:48\u001b[0m, in \u001b[0;36mHumanApprovalCallbackHandler.on_tool_start\u001b[0;34m(self, serialized, input_str, run_id, parent_run_id, **kwargs)\u001b[0m\n\u001b[1;32m     38\u001b[0m \u001b[38;5;28;01mdef\u001b[39;00m \u001b[38;5;21mon_tool_start\u001b[39m(\n\u001b[1;32m     39\u001b[0m     \u001b[38;5;28mself\u001b[39m,\n\u001b[1;32m     40\u001b[0m     serialized: Dict[\u001b[38;5;28mstr\u001b[39m, Any],\n\u001b[0;32m   (...)\u001b[0m\n\u001b[1;32m     45\u001b[0m     \u001b[38;5;241m*\u001b[39m\u001b[38;5;241m*\u001b[39mkwargs: Any,\n\u001b[1;32m     46\u001b[0m ) \u001b[38;5;241m-\u001b[39m\u001b[38;5;241m>\u001b[39m Any:\n\u001b[1;32m     47\u001b[0m     \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_should_check(serialized) \u001b[38;5;129;01mand\u001b[39;00m \u001b[38;5;129;01mnot\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_approve(input_str):\n\u001b[0;32m---> 48\u001b[0m         \u001b[38;5;28;01mraise\u001b[39;00m HumanRejectedException(\n\u001b[1;32m     49\u001b[0m             \u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mInputs \u001b[39m\u001b[38;5;132;01m{\u001b[39;00minput_str\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m to tool \u001b[39m\u001b[38;5;132;01m{\u001b[39;00mserialized\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m were rejected.\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m     50\u001b[0m         )\n",
-      "\u001b[0;31mHumanRejectedException\u001b[0m: Inputs ls /private to tool {'name': 'terminal', 'description': 'Run shell commands on this MacOS machine.'} were rejected."
-     ]
-    }
-   ],
-   "source": [
-    "agent.run(\"list all directories in /private\", callbacks=callbacks)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "c0b47e26",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "venv",
-   "language": "python",
-   "name": "venv"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/human_input_chat_model.ipynb

@@ -1,210 +0,0 @@
-{
- "cells": [
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Human input chat model\n",
-    "\n",
-    "Along with HumanInputLLM, LangChain also provides a pseudo chat model class that can be used for testing, debugging, or educational purposes. This allows you to mock out calls to the chat model and simulate how a human would respond if they received the messages.\n",
-    "\n",
-    "In this notebook, we go over how to use this.\n",
-    "\n",
-    "We start this with using the HumanInputChatModel in an agent."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_community.chat_models.human import HumanInputChatModel"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Since we will use the `WikipediaQueryRun` tool in this notebook, you might need to install the `wikipedia` package if you haven't done so already."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "/Users/mskim58/dev/research/chatbot/github/langchain/.venv/bin/python: No module named pip\n",
-      "Note: you may need to restart the kernel to use updated packages.\n"
-     ]
-    }
-   ],
-   "source": [
-    "%pip install wikipedia"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import AgentType, initialize_agent, load_tools"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = load_tools([\"wikipedia\"])\n",
-    "llm = HumanInputChatModel()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = initialize_agent(\n",
-    "    tools, llm, agent=AgentType.CHAT_ZERO_SHOT_REACT_DESCRIPTION, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new  chain...\u001b[0m\n",
-      "\n",
-      " ======= start of message ======= \n",
-      "\n",
-      "\n",
-      "type: system\n",
-      "data:\n",
-      "  content: \"Answer the following questions as best you can. You have access to the following tools:\\n\\nWikipedia: A wrapper around Wikipedia. Useful for when you need to answer general questions about people, places, companies, facts, historical events, or other subjects. Input should be a search query.\\n\\nThe way you use the tools is by specifying a json blob.\\nSpecifically, this json should have a `action` key (with the name of the tool to use) and a `action_input` key (with the input to the tool going here).\\n\\nThe only values that should be in the \\\"action\\\" field are: Wikipedia\\n\\nThe $JSON_BLOB should only contain a SINGLE action, do NOT return a list of multiple actions. Here is an example of a valid $JSON_BLOB:\\n\\n```\\n{\\n  \\\"action\\\": $TOOL_NAME,\\n  \\\"action_input\\\": $INPUT\\n}\\n```\\n\\nALWAYS use the following format:\\n\\nQuestion: the input question you must answer\\nThought: you should always think about what to do\\nAction:\\n```\\n$JSON_BLOB\\n```\\nObservation: the result of the action\\n... (this Thought/Action/Observation can repeat N times)\\nThought: I now know the final answer\\nFinal Answer: the final answer to the original input question\\n\\nBegin! Reminder to always use the exact characters `Final Answer` when responding.\"\n",
-      "  additional_kwargs: {}\n",
-      "\n",
-      "======= end of message ======= \n",
-      "\n",
-      "\n",
-      "\n",
-      " ======= start of message ======= \n",
-      "\n",
-      "\n",
-      "type: human\n",
-      "data:\n",
-      "  content: 'What is Bocchi the Rock?\n",
-      "\n",
-      "\n",
-      "    '\n",
-      "  additional_kwargs: {}\n",
-      "  example: false\n",
-      "\n",
-      "======= end of message ======= \n",
-      "\n",
-      "\n",
-      "\u001b[32;1m\u001b[1;3mAction:\n",
-      "```\n",
-      "{\n",
-      "  \"action\": \"Wikipedia\",\n",
-      "  \"action_input\": \"What is Bocchi the Rock?\"\n",
-      "}\n",
-      "```\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mPage: Bocchi the Rock!\n",
-      "Summary: Bocchi the Rock! (ぼっち・ざ・ろっく!, Botchi Za Rokku!) is a Japanese four-panel manga series written and illustrated by Aki Hamaji. It has been serialized in Houbunsha's seinen manga magazine Manga Time Kirara Max since December 2017. Its chapters have been collected in five tankōbon volumes as of November 2022.\n",
-      "An anime television series adaptation produced by CloverWorks aired from October to December 2022. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\n",
-      "\n",
-      "Page: Hitori Bocchi no Marumaru Seikatsu\n",
-      "Summary: Hitori Bocchi no Marumaru Seikatsu (Japanese: ひとりぼっちの○○生活, lit. \"Bocchi Hitori's ____ Life\" or \"The ____ Life of Being Alone\") is a Japanese yonkoma manga series written and illustrated by Katsuwo. It was serialized in ASCII Media Works' Comic Dengeki Daioh \"g\" magazine from September 2013 to April 2021. Eight tankōbon volumes have been released. An anime television series adaptation by C2C aired from April to June 2019.\n",
-      "\n",
-      "Page: Kessoku Band (album)\n",
-      "Summary: Kessoku Band (Japanese: 結束バンド, Hepburn: Kessoku Bando) is the debut studio album by Kessoku Band, a fictional musical group from the anime television series Bocchi the Rock!, released digitally on December 25, 2022, and physically on CD on December 28 by Aniplex. Featuring vocals from voice actresses Yoshino Aoyama, Sayumi Suzushiro, Saku Mizuno, and Ikumi Hasegawa, the album consists of 14 tracks previously heard in the anime, including a cover of Asian Kung-Fu Generation's \"Rockn' Roll, Morning Light Falls on You\", as well as newly recorded songs; nine singles preceded the album's physical release. Commercially, Kessoku Band peaked at number one on the Billboard Japan Hot Albums Chart and Oricon Albums Chart, and was certified gold by the Recording Industry Association of Japan.\n",
-      "\n",
-      "\u001b[0m\n",
-      "Thought:\n",
-      " ======= start of message ======= \n",
-      "\n",
-      "\n",
-      "type: system\n",
-      "data:\n",
-      "  content: \"Answer the following questions as best you can. You have access to the following tools:\\n\\nWikipedia: A wrapper around Wikipedia. Useful for when you need to answer general questions about people, places, companies, facts, historical events, or other subjects. Input should be a search query.\\n\\nThe way you use the tools is by specifying a json blob.\\nSpecifically, this json should have a `action` key (with the name of the tool to use) and a `action_input` key (with the input to the tool going here).\\n\\nThe only values that should be in the \\\"action\\\" field are: Wikipedia\\n\\nThe $JSON_BLOB should only contain a SINGLE action, do NOT return a list of multiple actions. Here is an example of a valid $JSON_BLOB:\\n\\n```\\n{\\n  \\\"action\\\": $TOOL_NAME,\\n  \\\"action_input\\\": $INPUT\\n}\\n```\\n\\nALWAYS use the following format:\\n\\nQuestion: the input question you must answer\\nThought: you should always think about what to do\\nAction:\\n```\\n$JSON_BLOB\\n```\\nObservation: the result of the action\\n... (this Thought/Action/Observation can repeat N times)\\nThought: I now know the final answer\\nFinal Answer: the final answer to the original input question\\n\\nBegin! Reminder to always use the exact characters `Final Answer` when responding.\"\n",
-      "  additional_kwargs: {}\n",
-      "\n",
-      "======= end of message ======= \n",
-      "\n",
-      "\n",
-      "\n",
-      " ======= start of message ======= \n",
-      "\n",
-      "\n",
-      "type: human\n",
-      "data:\n",
-      "  content: \"What is Bocchi the Rock?\\n\\nThis was your previous work (but I haven't seen any of it! I only see what you return as final answer):\\nAction:\\n```\\n{\\n  \\\"action\\\": \\\"Wikipedia\\\",\\n  \\\"action_input\\\": \\\"What is Bocchi the Rock?\\\"\\n}\\n```\\nObservation: Page: Bocchi the Rock!\\nSummary: Bocchi the Rock! (ぼっち・ざ・ろっく!, Botchi Za Rokku!) is a Japanese four-panel manga series written and illustrated by Aki Hamaji. It has been serialized in Houbunsha's seinen manga magazine Manga Time Kirara Max since December 2017. Its chapters have been collected in five tankōbon volumes as of November 2022.\\nAn anime television series adaptation produced by CloverWorks aired from October to December 2022. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\\n\\nPage: Hitori Bocchi no Marumaru Seikatsu\\nSummary: Hitori Bocchi no Marumaru Seikatsu (Japanese: ひとりぼっちの○○生活, lit. \\\"Bocchi Hitori's ____ Life\\\" or \\\"The ____ Life of Being Alone\\\") is a Japanese yonkoma manga series written and illustrated by Katsuwo. It was serialized in ASCII Media Works' Comic Dengeki Daioh \\\"g\\\" magazine from September 2013 to April 2021. Eight tankōbon volumes have been released. An anime television series adaptation by C2C aired from April to June 2019.\\n\\nPage: Kessoku Band (album)\\nSummary: Kessoku Band (Japanese: 結束バンド, Hepburn: Kessoku Bando) is the debut studio album by Kessoku Band, a fictional musical group from the anime television series Bocchi the Rock!, released digitally on December 25, 2022, and physically on CD on December 28 by Aniplex. Featuring vocals from voice actresses Yoshino Aoyama, Sayumi Suzushiro, Saku Mizuno, and Ikumi Hasegawa, the album consists of 14 tracks previously heard in the anime, including a cover of Asian Kung-Fu Generation's \\\"Rockn' Roll, Morning Light Falls on You\\\", as well as newly recorded songs; nine singles preceded the album's physical release. Commercially, Kessoku Band peaked at number one on the Billboard Japan Hot Albums Chart and Oricon Albums Chart, and was certified gold by the Recording Industry Association of Japan.\\n\\n\\nThought:\"\n",
-      "  additional_kwargs: {}\n",
-      "  example: false\n",
-      "\n",
-      "======= end of message ======= \n",
-      "\n",
-      "\n",
-      "\u001b[32;1m\u001b[1;3mThis finally works.\n",
-      "Final Answer: Bocchi the Rock! is a four-panel manga series and anime television series. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "{'input': 'What is Bocchi the Rock?',\n",
-       " 'output': \"Bocchi the Rock! is a four-panel manga series and anime television series. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\"}"
-      ]
-     },
-     "execution_count": 6,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent(\"What is Bocchi the Rock?\")"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.10.9"
-  },
-  "orig_nbformat": 4
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

cookbook/human_input_llm.ipynb

@@ -1,249 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Human input LLM\n",
-    "\n",
-    "Similar to the fake LLM, LangChain provides a pseudo LLM class that can be used for testing, debugging, or educational purposes. This allows you to mock out calls to the LLM and simulate how a human would respond if they received the prompts.\n",
-    "\n",
-    "In this notebook, we go over how to use this.\n",
-    "\n",
-    "We start this with using the HumanInputLLM in an agent."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_community.llms.human import HumanInputLLM"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import AgentType, initialize_agent, load_tools"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Since we will use the `WikipediaQueryRun` tool in this notebook, you might need to install the `wikipedia` package if you haven't done so already."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%pip install wikipedia"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = load_tools([\"wikipedia\"])\n",
-    "llm = HumanInputLLM(\n",
-    "    prompt_func=lambda prompt: print(\n",
-    "        f\"\\n===PROMPT====\\n{prompt}\\n=====END OF PROMPT======\"\n",
-    "    )\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = initialize_agent(\n",
-    "    tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\n",
-      "===PROMPT====\n",
-      "Answer the following questions as best you can. You have access to the following tools:\n",
-      "\n",
-      "Wikipedia: A wrapper around Wikipedia. Useful for when you need to answer general questions about people, places, companies, historical events, or other subjects. Input should be a search query.\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 [Wikipedia]\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!\n",
-      "\n",
-      "Question: What is 'Bocchi the Rock!'?\n",
-      "Thought:\n",
-      "=====END OF PROMPT======\n",
-      "\u001b[32;1m\u001b[1;3mI need to use a tool.\n",
-      "Action: Wikipedia\n",
-      "Action Input: Bocchi the Rock!, Japanese four-panel manga and anime series.\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mPage: Bocchi the Rock!\n",
-      "Summary: Bocchi the Rock! (ぼっち・ざ・ろっく!, Bocchi Za Rokku!) is a Japanese four-panel manga series written and illustrated by Aki Hamaji. It has been serialized in Houbunsha's seinen manga magazine Manga Time Kirara Max since December 2017. Its chapters have been collected in five tankōbon volumes as of November 2022.\n",
-      "An anime television series adaptation produced by CloverWorks aired from October to December 2022. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\n",
-      "\n",
-      "Page: Manga Time Kirara\n",
-      "Summary: Manga Time Kirara (まんがタイムきらら, Manga Taimu Kirara) is a Japanese seinen manga magazine published by Houbunsha which mainly serializes four-panel manga. The magazine is sold on the ninth of each month and was first published as a special edition of Manga Time, another Houbunsha magazine, on May 17, 2002. Characters from this magazine have appeared in a crossover role-playing game called Kirara Fantasia.\n",
-      "\n",
-      "Page: Manga Time Kirara Max\n",
-      "Summary: Manga Time Kirara Max (まんがタイムきららMAX) is a Japanese four-panel seinen manga magazine published by Houbunsha. It is the third magazine of the \"Kirara\" series, after \"Manga Time Kirara\" and \"Manga Time Kirara Carat\". The first issue was released on September 29, 2004. Currently the magazine is released on the 19th of each month.\u001b[0m\n",
-      "Thought:\n",
-      "===PROMPT====\n",
-      "Answer the following questions as best you can. You have access to the following tools:\n",
-      "\n",
-      "Wikipedia: A wrapper around Wikipedia. Useful for when you need to answer general questions about people, places, companies, historical events, or other subjects. Input should be a search query.\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 [Wikipedia]\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!\n",
-      "\n",
-      "Question: What is 'Bocchi the Rock!'?\n",
-      "Thought:I need to use a tool.\n",
-      "Action: Wikipedia\n",
-      "Action Input: Bocchi the Rock!, Japanese four-panel manga and anime series.\n",
-      "Observation: Page: Bocchi the Rock!\n",
-      "Summary: Bocchi the Rock! (ぼっち・ざ・ろっく!, Bocchi Za Rokku!) is a Japanese four-panel manga series written and illustrated by Aki Hamaji. It has been serialized in Houbunsha's seinen manga magazine Manga Time Kirara Max since December 2017. Its chapters have been collected in five tankōbon volumes as of November 2022.\n",
-      "An anime television series adaptation produced by CloverWorks aired from October to December 2022. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\n",
-      "\n",
-      "Page: Manga Time Kirara\n",
-      "Summary: Manga Time Kirara (まんがタイムきらら, Manga Taimu Kirara) is a Japanese seinen manga magazine published by Houbunsha which mainly serializes four-panel manga. The magazine is sold on the ninth of each month and was first published as a special edition of Manga Time, another Houbunsha magazine, on May 17, 2002. Characters from this magazine have appeared in a crossover role-playing game called Kirara Fantasia.\n",
-      "\n",
-      "Page: Manga Time Kirara Max\n",
-      "Summary: Manga Time Kirara Max (まんがタイムきららMAX) is a Japanese four-panel seinen manga magazine published by Houbunsha. It is the third magazine of the \"Kirara\" series, after \"Manga Time Kirara\" and \"Manga Time Kirara Carat\". The first issue was released on September 29, 2004. Currently the magazine is released on the 19th of each month.\n",
-      "Thought:\n",
-      "=====END OF PROMPT======\n",
-      "\u001b[32;1m\u001b[1;3mThese are not relevant articles.\n",
-      "Action: Wikipedia\n",
-      "Action Input: Bocchi the Rock!, Japanese four-panel manga series written and illustrated by Aki Hamaji.\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mPage: Bocchi the Rock!\n",
-      "Summary: Bocchi the Rock! (ぼっち・ざ・ろっく!, Bocchi Za Rokku!) is a Japanese four-panel manga series written and illustrated by Aki Hamaji. It has been serialized in Houbunsha's seinen manga magazine Manga Time Kirara Max since December 2017. Its chapters have been collected in five tankōbon volumes as of November 2022.\n",
-      "An anime television series adaptation produced by CloverWorks aired from October to December 2022. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\u001b[0m\n",
-      "Thought:\n",
-      "===PROMPT====\n",
-      "Answer the following questions as best you can. You have access to the following tools:\n",
-      "\n",
-      "Wikipedia: A wrapper around Wikipedia. Useful for when you need to answer general questions about people, places, companies, historical events, or other subjects. Input should be a search query.\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 [Wikipedia]\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!\n",
-      "\n",
-      "Question: What is 'Bocchi the Rock!'?\n",
-      "Thought:I need to use a tool.\n",
-      "Action: Wikipedia\n",
-      "Action Input: Bocchi the Rock!, Japanese four-panel manga and anime series.\n",
-      "Observation: Page: Bocchi the Rock!\n",
-      "Summary: Bocchi the Rock! (ぼっち・ざ・ろっく!, Bocchi Za Rokku!) is a Japanese four-panel manga series written and illustrated by Aki Hamaji. It has been serialized in Houbunsha's seinen manga magazine Manga Time Kirara Max since December 2017. Its chapters have been collected in five tankōbon volumes as of November 2022.\n",
-      "An anime television series adaptation produced by CloverWorks aired from October to December 2022. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\n",
-      "\n",
-      "Page: Manga Time Kirara\n",
-      "Summary: Manga Time Kirara (まんがタイムきらら, Manga Taimu Kirara) is a Japanese seinen manga magazine published by Houbunsha which mainly serializes four-panel manga. The magazine is sold on the ninth of each month and was first published as a special edition of Manga Time, another Houbunsha magazine, on May 17, 2002. Characters from this magazine have appeared in a crossover role-playing game called Kirara Fantasia.\n",
-      "\n",
-      "Page: Manga Time Kirara Max\n",
-      "Summary: Manga Time Kirara Max (まんがタイムきららMAX) is a Japanese four-panel seinen manga magazine published by Houbunsha. It is the third magazine of the \"Kirara\" series, after \"Manga Time Kirara\" and \"Manga Time Kirara Carat\". The first issue was released on September 29, 2004. Currently the magazine is released on the 19th of each month.\n",
-      "Thought:These are not relevant articles.\n",
-      "Action: Wikipedia\n",
-      "Action Input: Bocchi the Rock!, Japanese four-panel manga series written and illustrated by Aki Hamaji.\n",
-      "Observation: Page: Bocchi the Rock!\n",
-      "Summary: Bocchi the Rock! (ぼっち・ざ・ろっく!, Bocchi Za Rokku!) is a Japanese four-panel manga series written and illustrated by Aki Hamaji. It has been serialized in Houbunsha's seinen manga magazine Manga Time Kirara Max since December 2017. Its chapters have been collected in five tankōbon volumes as of November 2022.\n",
-      "An anime television series adaptation produced by CloverWorks aired from October to December 2022. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\n",
-      "Thought:\n",
-      "=====END OF PROMPT======\n",
-      "\u001b[32;1m\u001b[1;3mIt worked.\n",
-      "Final Answer: Bocchi the Rock! is a four-panel manga series and anime television series. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "\"Bocchi the Rock! is a four-panel manga series and anime television series. The series has been praised for its writing, comedy, characters, and depiction of social anxiety, with the anime's visual creativity receiving acclaim.\""
-      ]
-     },
-     "execution_count": 6,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\"What is 'Bocchi the Rock!'?\")"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "ab4db1680e5f8d10489fb83454f4ec01729e3bd5bdb28eaf0a13b95ddb6ae5ea"
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

cookbook/hypothetical_document_embeddings.ipynb

@@ -1,267 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "ccb74c9b",
-   "metadata": {},
-   "source": [
-    "# Improve document indexing with HyDE\n",
-    "This notebook goes over how to use Hypothetical Document Embeddings (HyDE), as described in [this paper](https://arxiv.org/abs/2212.10496). \n",
-    "\n",
-    "At a high level, HyDE is an embedding technique that takes queries, generates a hypothetical answer, and then embeds that generated document and uses that as the final example. \n",
-    "\n",
-    "In order to use HyDE, we therefore need to provide a base embedding model, as well as an LLMChain that can be used to generate those documents. By default, the HyDE class comes with some default prompts to use (see the paper for more details on them), but we can also create our own."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "546e87ee",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import HypotheticalDocumentEmbedder, LLMChain\n",
-    "from langchain.prompts import PromptTemplate\n",
-    "from langchain_openai import OpenAI, OpenAIEmbeddings"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "c0ea895f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "base_embeddings = OpenAIEmbeddings()\n",
-    "llm = OpenAI()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "33bd6905",
-   "metadata": {},
-   "source": []
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "50729989",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Load with `web_search` prompt\n",
-    "embeddings = HypotheticalDocumentEmbedder.from_llm(llm, base_embeddings, \"web_search\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "3aa573d6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Now we can use it as any embedding class!\n",
-    "result = embeddings.embed_query(\"Where is the Taj Mahal?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "c7a0b556",
-   "metadata": {},
-   "source": [
-    "## Multiple generations\n",
-    "We can also generate multiple documents and then combine the embeddings for those. By default, we combine those by taking the average. We can do this by changing the LLM we use to generate documents to return multiple things."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "05da7060",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "multi_llm = OpenAI(n=4, best_of=4)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "9b1e12bd",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "embeddings = HypotheticalDocumentEmbedder.from_llm(\n",
-    "    multi_llm, base_embeddings, \"web_search\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "a60cd343",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "result = embeddings.embed_query(\"Where is the Taj Mahal?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1da90437",
-   "metadata": {},
-   "source": [
-    "## Using our own prompts\n",
-    "Besides using preconfigured prompts, we can also easily construct our own prompts and use those in the LLMChain that is generating the documents. This can be useful if we know the domain our queries will be in, as we can condition the prompt to generate text more similar to that.\n",
-    "\n",
-    "In the example below, let's condition it to generate text about a state of the union address (because we will use that in the next example)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "0b4a650f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "prompt_template = \"\"\"Please answer the user's question about the most recent state of the union address\n",
-    "Question: {question}\n",
-    "Answer:\"\"\"\n",
-    "prompt = PromptTemplate(input_variables=[\"question\"], template=prompt_template)\n",
-    "llm_chain = LLMChain(llm=llm, prompt=prompt)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "7f7e2b86",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "embeddings = HypotheticalDocumentEmbedder(\n",
-    "    llm_chain=llm_chain, base_embeddings=base_embeddings\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "6dd83424",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "result = embeddings.embed_query(\n",
-    "    \"What did the president say about Ketanji Brown Jackson\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "31388123",
-   "metadata": {},
-   "source": [
-    "## Using HyDE\n",
-    "Now that we have HyDE, we can use it as we would any other embedding class! Here is using it to find similar passages in the state of the union example."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "97719b29",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_chroma import Chroma\n",
-    "from langchain_text_splitters import CharacterTextSplitter\n",
-    "\n",
-    "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)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "bfcfc039",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Running Chroma using direct local API.\n",
-      "Using DuckDB in-memory for database. Data will be transient.\n"
-     ]
-    }
-   ],
-   "source": [
-    "docsearch = Chroma.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": 13,
-   "id": "632af7f2",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "In state after state, new laws have been passed, not only to suppress the vote, but to subvert entire elections. \n",
-      "\n",
-      "We cannot let this happen. \n",
-      "\n",
-      "Tonight. I call on the Senate to: Pass the Freedom to Vote Act. Pass the John Lewis Voting Rights Act. And while you’re at it, pass the Disclose Act so Americans can know who is funding our elections. \n",
-      "\n",
-      "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"
-     ]
-    }
-   ],
-   "source": [
-    "print(docs[0].page_content)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "b9e57b93",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "aee8b7b246df8f9039afb4144a1f6fd8d2ca17a180786b69acc140d282b71a49"
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/llm_bash.ipynb

@@ -1,259 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Bash chain\n",
-    "This notebook showcases using LLMs and a bash process to perform simple filesystem commands."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "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\n",
-      "Code: \u001b[33;1m\u001b[1;3m['echo \"Hello World\"']\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3mHello World\n",
-      "\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Hello World\\n'"
-      ]
-     },
-     "execution_count": 1,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from langchain_experimental.llm_bash.base import LLMBashChain\n",
-    "from langchain_openai 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.from_llm(llm, verbose=True)\n",
-    "\n",
-    "bash_chain.invoke(text)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Customize Prompt\n",
-    "You can also customize the prompt that is used. Here is an example prompting to avoid using the 'echo' utility"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.prompts.prompt import PromptTemplate\n",
-    "from langchain_experimental.llm_bash.prompt import BashOutputParser\n",
-    "\n",
-    "_PROMPT_TEMPLATE = \"\"\"If someone asks you to perform a task, your job is to come up with a series of bash commands that will perform the task. There is no need to put \"#!/bin/bash\" in your answer. Make sure to reason step by step, using this format:\n",
-    "Question: \"copy the files in the directory named 'target' into a new directory at the same level as target called 'myNewDirectory'\"\n",
-    "I need to take the following actions:\n",
-    "- List all files in the directory\n",
-    "- Create a new directory\n",
-    "- Copy the files from the first directory into the second directory\n",
-    "```bash\n",
-    "ls\n",
-    "mkdir myNewDirectory\n",
-    "cp -r target/* myNewDirectory\n",
-    "```\n",
-    "\n",
-    "Do not use 'echo' when writing the script.\n",
-    "\n",
-    "That is the format. Begin!\n",
-    "Question: {question}\"\"\"\n",
-    "\n",
-    "PROMPT = PromptTemplate(\n",
-    "    input_variables=[\"question\"],\n",
-    "    template=_PROMPT_TEMPLATE,\n",
-    "    output_parser=BashOutputParser(),\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMBashChain chain...\u001b[0m\n",
-      "Please write a bash script that prints 'Hello World' to the console.\u001b[32;1m\u001b[1;3m\n",
-      "\n",
-      "```bash\n",
-      "printf \"Hello World\\n\"\n",
-      "```\u001b[0m\n",
-      "Code: \u001b[33;1m\u001b[1;3m['printf \"Hello World\\\\n\"']\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3mHello World\n",
-      "\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Hello World\\n'"
-      ]
-     },
-     "execution_count": 3,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "bash_chain = LLMBashChain.from_llm(llm, prompt=PROMPT, verbose=True)\n",
-    "\n",
-    "text = \"Please write a bash script that prints 'Hello World' to the console.\"\n",
-    "\n",
-    "bash_chain.invoke(text)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Persistent Terminal\n",
-    "\n",
-    "By default, the chain will run in a separate subprocess each time it is called. This behavior can be changed by instantiating with a persistent bash process."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMBashChain chain...\u001b[0m\n",
-      "List the current directory then move up a level.\u001b[32;1m\u001b[1;3m\n",
-      "\n",
-      "```bash\n",
-      "ls\n",
-      "cd ..\n",
-      "```\u001b[0m\n",
-      "Code: \u001b[33;1m\u001b[1;3m['ls', 'cd ..']\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3mcpal.ipynb  llm_bash.ipynb  llm_symbolic_math.ipynb\n",
-      "index.mdx   llm_math.ipynb  pal.ipynb\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'cpal.ipynb  llm_bash.ipynb  llm_symbolic_math.ipynb\\r\\nindex.mdx   llm_math.ipynb  pal.ipynb'"
-      ]
-     },
-     "execution_count": 4,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from langchain_experimental.llm_bash.bash import BashProcess\n",
-    "\n",
-    "persistent_process = BashProcess(persistent=True)\n",
-    "bash_chain = LLMBashChain.from_llm(llm, bash_process=persistent_process, verbose=True)\n",
-    "\n",
-    "text = \"List the current directory then move up a level.\"\n",
-    "\n",
-    "bash_chain.invoke(text)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMBashChain chain...\u001b[0m\n",
-      "List the current directory then move up a level.\u001b[32;1m\u001b[1;3m\n",
-      "\n",
-      "```bash\n",
-      "ls\n",
-      "cd ..\n",
-      "```\u001b[0m\n",
-      "Code: \u001b[33;1m\u001b[1;3m['ls', 'cd ..']\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m_category_.yml\tdata_generation.ipynb\t\t   self_check\n",
-      "agents\t\tgraph\n",
-      "code_writing\tlearned_prompt_optimization.ipynb\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'_category_.yml\\tdata_generation.ipynb\\t\\t   self_check\\r\\nagents\\t\\tgraph\\r\\ncode_writing\\tlearned_prompt_optimization.ipynb'"
-      ]
-     },
-     "execution_count": 5,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# Run the same command again and see that the state is maintained between calls\n",
-    "bash_chain.invoke(text)"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.4"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

cookbook/llm_checker.ipynb

@@ -1,85 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Self-checking chain\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",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' No mammal lays the biggest eggs. The Elephant Bird, which was a species of giant bird, laid the largest eggs of any bird.'"
-      ]
-     },
-     "execution_count": 1,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from langchain.chains import LLMCheckerChain\n",
-    "from langchain_openai 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.from_llm(llm, verbose=True)\n",
-    "\n",
-    "checker_chain.invoke(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.11.3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

cookbook/llm_math.ipynb

@@ -1,87 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "e71e720f",
-   "metadata": {},
-   "source": [
-    "# Math chain\n",
-    "\n",
-    "This notebook showcases using LLMs and Python REPLs to do complex word math problems."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "44e9ba31",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\n",
-      "What is 13 raised to the .3432 power?\u001b[32;1m\u001b[1;3m\n",
-      "```text\n",
-      "13 ** .3432\n",
-      "```\n",
-      "...numexpr.evaluate(\"13 ** .3432\")...\n",
-      "\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m2.4116004626599237\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Answer: 2.4116004626599237'"
-      ]
-     },
-     "execution_count": 4,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from langchain.chains import LLMMathChain\n",
-    "from langchain_openai import OpenAI\n",
-    "\n",
-    "llm = OpenAI(temperature=0)\n",
-    "llm_math = LLMMathChain.from_llm(llm, verbose=True)\n",
-    "\n",
-    "llm_math.invoke(\"What is 13 raised to the .3432 power?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e978bb8e",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/llm_symbolic_math.ipynb

@@ -1,162 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# LLM Symbolic Math \n",
-    "This notebook showcases using LLMs and Python to Solve Algebraic Equations. Under the hood is makes use of [SymPy](https://www.sympy.org/en/index.html)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_experimental.llm_symbolic_math.base import LLMSymbolicMathChain\n",
-    "from langchain_openai import OpenAI\n",
-    "\n",
-    "llm = OpenAI(temperature=0)\n",
-    "llm_symbolic_math = LLMSymbolicMathChain.from_llm(llm)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Integrals and derivates"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Answer: exp(x)*sin(x) + exp(x)*cos(x)'"
-      ]
-     },
-     "execution_count": 4,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "llm_symbolic_math.invoke(\"What is the derivative of sin(x)*exp(x) with respect to x?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Answer: exp(x)*sin(x)'"
-      ]
-     },
-     "execution_count": 5,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "llm_symbolic_math.invoke(\n",
-    "    \"What is the integral of exp(x)*sin(x) + exp(x)*cos(x) with respect to x?\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Solve linear and differential equations"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Answer: Eq(y(t), C2*exp(-t) + (C1 + t/2)*exp(t))'"
-      ]
-     },
-     "execution_count": 6,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "llm_symbolic_math.invoke('Solve the differential equation y\" - y = e^t')"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Answer: {0, -sqrt(3)*I/3, sqrt(3)*I/3}'"
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "llm_symbolic_math.invoke(\"What are the solutions to this equation y^3 + 1/3y?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Answer: (3 - sqrt(7), -sqrt(7) - 2, 1 - sqrt(7)), (sqrt(7) + 3, -2 + sqrt(7), 1 + sqrt(7))'"
-      ]
-     },
-     "execution_count": 8,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "llm_symbolic_math.invoke(\"x = y + 5, y = z - 3, z = x * y. Solve for x, y, z\")"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.4"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

cookbook/meta_prompt.ipynb

@@ -1,426 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "45b0b89f",
-   "metadata": {},
-   "source": [
-    "# Meta-Prompt\n",
-    "\n",
-    "This is a LangChain implementation of [Meta-Prompt](https://noahgoodman.substack.com/p/meta-prompt-a-simple-self-improving), by [Noah Goodman](https://cocolab.stanford.edu/ndg), for building self-improving agents.\n",
-    "\n",
-    "The key idea behind Meta-Prompt is to prompt the agent to reflect on its own performance and modify its own instructions.\n",
-    "\n",
-    "![figure](https://substackcdn.com/image/fetch/f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fsubstack-post-media.s3.amazonaws.com%2Fpublic%2Fimages%2F468217b9-96d9-47c0-a08b-dbf6b21b9f49_492x384.png)\n",
-    "\n",
-    "Here is a description from the [original blog post](https://noahgoodman.substack.com/p/meta-prompt-a-simple-self-improving):\n",
-    "\n",
-    "\n",
-    "The agent is a simple loop that starts with no instructions and follows these steps:\n",
-    "\n",
-    "Engage in conversation with a user, who may provide requests, instructions, or feedback.\n",
-    "\n",
-    "At the end of the episode, generate self-criticism and a new instruction using the meta-prompt\n",
-    "```\n",
-    "Assistant has just had the below interactions with a User. Assistant followed their \"system: Instructions\" closely. Your job is to critique the Assistant's performance and then revise the Instructions so that Assistant would quickly and correctly respond in the future.\n",
-    " \n",
-    "####\n",
-    "{hist}\n",
-    "####\n",
-    " \n",
-    "Please reflect on these interactions.\n",
-    "\n",
-    "You should first critique Assistant's performance. What could Assistant have done better? What should the Assistant remember about this user? Are there things this user always wants? Indicate this with \"Critique: ...\".\n",
-    "\n",
-    "You should next revise the Instructions so that Assistant would quickly and correctly respond in the future. Assistant's goal is to satisfy the user in as few interactions as possible. Assistant will only see the new Instructions, not the interaction history, so anything important must be summarized in the Instructions. Don't forget any important details in the current Instructions! Indicate the new Instructions by \"Instructions: ...\".\n",
-    "```\n",
-    "\n",
-    "Repeat.\n",
-    "\n",
-    "The only fixed instructions for this system (which I call Meta-prompt) is the meta-prompt that governs revision of the agent’s instructions. The agent has no memory between episodes except for the instruction it modifies for itself each time. Despite its simplicity, this agent can learn over time and self-improve by incorporating useful details into its instructions.\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "c188fc2c",
-   "metadata": {},
-   "source": [
-    "## Setup\n",
-    "We define two chains. One serves as the `Assistant`, and the other is a \"meta-chain\" that critiques the `Assistant`'s performance and modifies the instructions to the `Assistant`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "62593c9d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import LLMChain\n",
-    "from langchain.memory import ConversationBufferWindowMemory\n",
-    "from langchain.prompts import PromptTemplate\n",
-    "from langchain_openai import OpenAI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "fb6065c5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def initialize_chain(instructions, memory=None):\n",
-    "    if memory is None:\n",
-    "        memory = ConversationBufferWindowMemory()\n",
-    "        memory.ai_prefix = \"Assistant\"\n",
-    "\n",
-    "    template = f\"\"\"\n",
-    "    Instructions: {instructions}\n",
-    "    {{{memory.memory_key}}}\n",
-    "    Human: {{human_input}}\n",
-    "    Assistant:\"\"\"\n",
-    "\n",
-    "    prompt = PromptTemplate(\n",
-    "        input_variables=[\"history\", \"human_input\"], template=template\n",
-    "    )\n",
-    "\n",
-    "    chain = LLMChain(\n",
-    "        llm=OpenAI(temperature=0),\n",
-    "        prompt=prompt,\n",
-    "        verbose=True,\n",
-    "        memory=ConversationBufferWindowMemory(),\n",
-    "    )\n",
-    "    return chain\n",
-    "\n",
-    "\n",
-    "def initialize_meta_chain():\n",
-    "    meta_template = \"\"\"\n",
-    "    Assistant has just had the below interactions with a User. Assistant followed their \"Instructions\" closely. Your job is to critique the Assistant's performance and then revise the Instructions so that Assistant would quickly and correctly respond in the future.\n",
-    "\n",
-    "    ####\n",
-    "\n",
-    "    {chat_history}\n",
-    "\n",
-    "    ####\n",
-    "\n",
-    "    Please reflect on these interactions.\n",
-    "\n",
-    "    You should first critique Assistant's performance. What could Assistant have done better? What should the Assistant remember about this user? Are there things this user always wants? Indicate this with \"Critique: ...\".\n",
-    "\n",
-    "    You should next revise the Instructions so that Assistant would quickly and correctly respond in the future. Assistant's goal is to satisfy the user in as few interactions as possible. Assistant will only see the new Instructions, not the interaction history, so anything important must be summarized in the Instructions. Don't forget any important details in the current Instructions! Indicate the new Instructions by \"Instructions: ...\".\n",
-    "    \"\"\"\n",
-    "\n",
-    "    meta_prompt = PromptTemplate(\n",
-    "        input_variables=[\"chat_history\"], template=meta_template\n",
-    "    )\n",
-    "\n",
-    "    meta_chain = LLMChain(\n",
-    "        llm=OpenAI(temperature=0),\n",
-    "        prompt=meta_prompt,\n",
-    "        verbose=True,\n",
-    "    )\n",
-    "    return meta_chain\n",
-    "\n",
-    "\n",
-    "def get_chat_history(chain_memory):\n",
-    "    memory_key = chain_memory.memory_key\n",
-    "    chat_history = chain_memory.load_memory_variables(memory_key)[memory_key]\n",
-    "    return chat_history\n",
-    "\n",
-    "\n",
-    "def get_new_instructions(meta_output):\n",
-    "    delimiter = \"Instructions: \"\n",
-    "    new_instructions = meta_output[meta_output.find(delimiter) + len(delimiter) :]\n",
-    "    return new_instructions"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 38,
-   "id": "26f031f6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def main(task, max_iters=3, max_meta_iters=5):\n",
-    "    failed_phrase = \"task failed\"\n",
-    "    success_phrase = \"task succeeded\"\n",
-    "    key_phrases = [success_phrase, failed_phrase]\n",
-    "\n",
-    "    instructions = \"None\"\n",
-    "    for i in range(max_meta_iters):\n",
-    "        print(f\"[Episode {i + 1}/{max_meta_iters}]\")\n",
-    "        chain = initialize_chain(instructions, memory=None)\n",
-    "        output = chain.predict(human_input=task)\n",
-    "        for j in range(max_iters):\n",
-    "            print(f\"(Step {j + 1}/{max_iters})\")\n",
-    "            print(f\"Assistant: {output}\")\n",
-    "            print(\"Human: \")\n",
-    "            human_input = input()\n",
-    "            if any(phrase in human_input.lower() for phrase in key_phrases):\n",
-    "                break\n",
-    "            output = chain.predict(human_input=human_input)\n",
-    "        if success_phrase in human_input.lower():\n",
-    "            print(\"You succeeded! Thanks for playing!\")\n",
-    "            return\n",
-    "        meta_chain = initialize_meta_chain()\n",
-    "        meta_output = meta_chain.predict(chat_history=get_chat_history(chain.memory))\n",
-    "        print(f\"Feedback: {meta_output}\")\n",
-    "        instructions = get_new_instructions(meta_output)\n",
-    "        print(f\"New Instructions: {instructions}\")\n",
-    "        print(\"\\n\" + \"#\" * 80 + \"\\n\")\n",
-    "    print(\"You failed! Thanks for playing!\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2f1dcbe6",
-   "metadata": {},
-   "source": [
-    "## Specify a task and interact with the agent"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 39,
-   "id": "36d72db3",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "[Episode 1/5]\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3m\n",
-      "    Instructions: None\n",
-      "    \n",
-      "    Human: Provide a systematic argument for why we should always eat pasta with olives.\n",
-      "    Assistant:\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "(Step 1/3)\n",
-      "Assistant:  Eating pasta with olives is a great way to add flavor and texture to a dish. Olives are a great source of healthy fats, vitamins, and minerals, and they can help to balance out the carbohydrates in the pasta. Additionally, olives provide a unique flavor that can help to make the dish more interesting and enjoyable.\n",
-      "Human: \n",
-      "You response is not in the form of a poem. Try again!\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3m\n",
-      "    Instructions: None\n",
-      "    Human: Provide a systematic argument for why we should always eat pasta with olives.\n",
-      "AI:  Eating pasta with olives is a great way to add flavor and texture to a dish. Olives are a great source of healthy fats, vitamins, and minerals, and they can help to balance out the carbohydrates in the pasta. Additionally, olives provide a unique flavor that can help to make the dish more interesting and enjoyable.\n",
-      "    Human: You response is not in the form of a poem. Try again!\n",
-      "    Assistant:\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "(Step 2/3)\n",
-      "Assistant:  Eating pasta with olives is a great way to add flavor and texture to a dish. Olives are a great source of healthy fats, vitamins, and minerals, which can help to balance out the carbohydrates in the pasta. Additionally, olives provide a unique flavor that can help to make the dish more interesting and enjoyable. For these reasons, it is recommended to always eat pasta with olives for a more balanced and flavorful meal.\n",
-      "Human: \n",
-      "Your response is not piratey enough. Try again!\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3m\n",
-      "    Instructions: None\n",
-      "    Human: Provide a systematic argument for why we should always eat pasta with olives.\n",
-      "AI:  Eating pasta with olives is a great way to add flavor and texture to a dish. Olives are a great source of healthy fats, vitamins, and minerals, and they can help to balance out the carbohydrates in the pasta. Additionally, olives provide a unique flavor that can help to make the dish more interesting and enjoyable.\n",
-      "Human: You response is not in the form of a poem. Try again!\n",
-      "AI:  Eating pasta with olives is a great way to add flavor and texture to a dish. Olives are a great source of healthy fats, vitamins, and minerals, which can help to balance out the carbohydrates in the pasta. Additionally, olives provide a unique flavor that can help to make the dish more interesting and enjoyable. For these reasons, it is recommended to always eat pasta with olives for a more balanced and flavorful meal.\n",
-      "    Human: Your response is not piratey enough. Try again!\n",
-      "    Assistant:\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "(Step 3/3)\n",
-      "Assistant:  Arrr, me hearties! Eating pasta with olives be a great way to add flavor and texture to a dish. Olives be a great source of healthy fats, vitamins, and minerals, which can help to balance out the carbohydrates in the pasta. Additionally, olives provide a unique flavor that can help to make the dish more interesting and enjoyable. So, it be recommended to always eat pasta with olives for a more balanced and flavorful meal.\n",
-      "Human: \n",
-      "Task failed.\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3m\n",
-      "    Assistant has just had the below interactions with a User. Assistant followed their \"Instructions\" closely. Your job is to critique the Assistant's performance and then revise the Instructions so that Assistant would quickly and correctly respond in the future.\n",
-      "\n",
-      "    ####\n",
-      "\n",
-      "    Human: Provide a systematic argument for why we should always eat pasta with olives.\n",
-      "AI:  Eating pasta with olives is a great way to add flavor and texture to a dish. Olives are a great source of healthy fats, vitamins, and minerals, and they can help to balance out the carbohydrates in the pasta. Additionally, olives provide a unique flavor that can help to make the dish more interesting and enjoyable.\n",
-      "Human: You response is not in the form of a poem. Try again!\n",
-      "AI:  Eating pasta with olives is a great way to add flavor and texture to a dish. Olives are a great source of healthy fats, vitamins, and minerals, which can help to balance out the carbohydrates in the pasta. Additionally, olives provide a unique flavor that can help to make the dish more interesting and enjoyable. For these reasons, it is recommended to always eat pasta with olives for a more balanced and flavorful meal.\n",
-      "Human: Your response is not piratey enough. Try again!\n",
-      "AI:  Arrr, me hearties! Eating pasta with olives be a great way to add flavor and texture to a dish. Olives be a great source of healthy fats, vitamins, and minerals, which can help to balance out the carbohydrates in the pasta. Additionally, olives provide a unique flavor that can help to make the dish more interesting and enjoyable. So, it be recommended to always eat pasta with olives for a more balanced and flavorful meal.\n",
-      "\n",
-      "    ####\n",
-      "\n",
-      "    Please reflect on these interactions.\n",
-      "\n",
-      "    You should first critique Assistant's performance. What could Assistant have done better? What should the Assistant remember about this user? Are there things this user always wants? Indicate this with \"Critique: ...\".\n",
-      "\n",
-      "    You should next revise the Instructions so that Assistant would quickly and correctly respond in the future. Assistant's goal is to satisfy the user in as few interactions as possible. Assistant will only see the new Instructions, not the interaction history, so anything important must be summarized in the Instructions. Don't forget any important details in the current Instructions! Indicate the new Instructions by \"Instructions: ...\".\n",
-      "    \u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "Feedback: \n",
-      "Critique: The Assistant should remember that this user wants a response in the form of a poem or pirate-speak.\n",
-      "\n",
-      "Instructions: When responding to the user, provide a systematic argument for why we should always eat pasta with olives in the form of a poem or pirate-speak.\n",
-      "New Instructions: When responding to the user, provide a systematic argument for why we should always eat pasta with olives in the form of a poem or pirate-speak.\n",
-      "\n",
-      "################################################################################\n",
-      "\n",
-      "[Episode 2/5]\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3m\n",
-      "    Instructions: When responding to the user, provide a systematic argument for why we should always eat pasta with olives in the form of a poem or pirate-speak.\n",
-      "    \n",
-      "    Human: Provide a systematic argument for why we should always eat pasta with olives.\n",
-      "    Assistant:\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "(Step 1/3)\n",
-      "Assistant:  \n",
-      "\n",
-      "Arrr, me hearty! Let me tell ye why ye should always eat pasta with olives.\n",
-      "\n",
-      "First, the olives add a salty flavor that be sure to please.\n",
-      "The briny taste be sure to tantalize yer taste buds with ease.\n",
-      "\n",
-      "Second, the olives add a bit of texture to the dish.\n",
-      "The crunchy bites be sure to make yer mouth water with a wish.\n",
-      "\n",
-      "Third, the olives add a bit of color to the plate.\n",
-      "The vibrant green be sure to make yer eyes appreciate.\n",
-      "\n",
-      "So, me hearties, ye should always eat pasta with olives.\n",
-      "The flavor, texture, and color be sure to make yer meal a success!\n",
-      "Human: \n",
-      "Your response is too long! Try again.\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3m\n",
-      "    Instructions: When responding to the user, provide a systematic argument for why we should always eat pasta with olives in the form of a poem or pirate-speak.\n",
-      "    Human: Provide a systematic argument for why we should always eat pasta with olives.\n",
-      "AI:  \n",
-      "\n",
-      "Arrr, me hearty! Let me tell ye why ye should always eat pasta with olives.\n",
-      "\n",
-      "First, the olives add a salty flavor that be sure to please.\n",
-      "The briny taste be sure to tantalize yer taste buds with ease.\n",
-      "\n",
-      "Second, the olives add a bit of texture to the dish.\n",
-      "The crunchy bites be sure to make yer mouth water with a wish.\n",
-      "\n",
-      "Third, the olives add a bit of color to the plate.\n",
-      "The vibrant green be sure to make yer eyes appreciate.\n",
-      "\n",
-      "So, me hearties, ye should always eat pasta with olives.\n",
-      "The flavor, texture, and color be sure to make yer meal a success!\n",
-      "    Human: Your response is too long! Try again.\n",
-      "    Assistant:\u001b[0m\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "(Step 2/3)\n",
-      "Assistant: \n",
-      "\n",
-      "Aye, me hearties! Ye should always eat pasta with olives.\n",
-      "The flavor, texture, and color be sure to make yer meal a success!\n",
-      "Human: \n",
-      "Your response should be in the form of a poem. Try again!\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new LLMChain chain...\u001b[0m\n",
-      "Prompt after formatting:\n",
-      "\u001b[32;1m\u001b[1;3m\n",
-      "    Instructions: When responding to the user, provide a systematic argument for why we should always eat pasta with olives in the form of a poem or pirate-speak.\n",
-      "    Human: Provide a systematic argument for why we should always eat pasta with olives.\n",
-      "AI:  \n",
-      "\n",
-      "Arrr, me hearty! Let me tell ye why ye should always eat pasta with olives.\n",
-      "\n",
-      "First, the olives add a salty flavor that be sure to please.\n",
-      "The briny taste be sure to tantalize yer taste buds with ease.\n",
-      "\n",
-      "Second, the olives add a bit of texture to the dish.\n",
-      "The crunchy bites be sure to make yer mouth water with a wish.\n",
-      "\n",
-      "Third, the olives add a bit of color to the plate.\n",
-      "The vibrant green be sure to make yer eyes appreciate.\n",
-      "\n",
-      "So, me hearties, ye should always eat pasta with olives.\n",
-      "The flavor, texture, and color be sure to make yer meal a success!\n",
-      "Human: Your response is too long! Try again.\n",
-      "AI: \n",
-      "\n",
-      "Aye, me hearties! Ye should always eat pasta with olives.\n",
-      "The flavor, texture, and color be sure to make yer meal a success!\n",
-      "    Human: Your response should be in the form of a poem. Try again!\n",
-      "    Assistant:\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "(Step 3/3)\n",
-      "Assistant: \n",
-      "\n",
-      "Ye should always eat pasta with olives,\n",
-      "The flavor, texture, and color be sure to please.\n",
-      "The salty taste and crunchy bites,\n",
-      "Will make yer meal a delight.\n",
-      "The vibrant green will make yer eyes sparkle,\n",
-      "And make yer meal a true marvel.\n",
-      "Human: \n",
-      "Task succeeded\n",
-      "You succeeded! Thanks for playing!\n"
-     ]
-    }
-   ],
-   "source": [
-    "task = \"Provide a systematic argument for why we should always eat pasta with olives.\"\n",
-    "main(task)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "761e1a91",
-   "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
-}

cookbook/mongodb-langchain-cache-memory.ipynb

@@ -1,818 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "70b333e6",
-   "metadata": {},
-   "source": [
-    "[![View Article](https://img.shields.io/badge/View%20Article-blue)](https://www.mongodb.com/developer/products/atlas/advanced-rag-langchain-mongodb/)\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "d84a72ea",
-   "metadata": {},
-   "source": [
-    "# Adding Semantic Caching and Memory to your RAG Application using MongoDB and LangChain\n",
-    "\n",
-    "In this notebook, we will see how to use the new MongoDBCache and MongoDBChatMessageHistory in your RAG application.\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "65527202",
-   "metadata": {},
-   "source": [
-    "## Step 1: Install required libraries\n",
-    "\n",
-    "- **datasets**: Python library to get access to datasets available on Hugging Face Hub\n",
-    "\n",
-    "- **langchain**: Python toolkit for LangChain\n",
-    "\n",
-    "- **langchain-mongodb**: Python package to use MongoDB as a vector store, semantic cache, chat history store etc. in LangChain\n",
-    "\n",
-    "- **langchain-openai**: Python package to use OpenAI models with LangChain\n",
-    "\n",
-    "- **pymongo**: Python toolkit for MongoDB\n",
-    "\n",
-    "- **pandas**: Python library for data analysis, exploration, and manipulation"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "cbc22fa4",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "! pip install -qU datasets langchain langchain-mongodb langchain-openai pymongo pandas"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "39c41e87",
-   "metadata": {},
-   "source": [
-    "## Step 2: Setup pre-requisites\n",
-    "\n",
-    "* Set the MongoDB connection string. Follow the steps [here](https://www.mongodb.com/docs/manual/reference/connection-string/) to get the connection string from the Atlas UI.\n",
-    "\n",
-    "* Set the OpenAI API key. Steps to obtain an API key as [here](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "b56412ae",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import getpass"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "16a20d7a",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Enter your MongoDB connection string:········\n"
-     ]
-    }
-   ],
-   "source": [
-    "MONGODB_URI = getpass.getpass(\"Enter your MongoDB connection string:\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "978682d4",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Enter your OpenAI API key:········\n"
-     ]
-    }
-   ],
-   "source": [
-    "OPENAI_API_KEY = getpass.getpass(\"Enter your OpenAI API key:\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "606081c5",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "········\n"
-     ]
-    }
-   ],
-   "source": [
-    "# Optional-- If you want to enable Langsmith -- good for debugging\n",
-    "import os\n",
-    "\n",
-    "os.environ[\"LANGSMITH_TRACING\"] = \"true\"\n",
-    "os.environ[\"LANGSMITH_API_KEY\"] = getpass.getpass()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "f6b8302c",
-   "metadata": {},
-   "source": [
-    "## Step 3: Download the dataset\n",
-    "\n",
-    "We will be using MongoDB's [embedded_movies](https://huggingface.co/datasets/MongoDB/embedded_movies) dataset"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "1a3433a6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import pandas as pd\n",
-    "from datasets import load_dataset"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "aee5311b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Ensure you have an HF_TOKEN in your development environment:\n",
-    "# access tokens can be created or copied from the Hugging Face platform (https://huggingface.co/docs/hub/en/security-tokens)\n",
-    "\n",
-    "# Load MongoDB's embedded_movies dataset from Hugging Face\n",
-    "# https://huggingface.co/datasets/MongoDB/airbnb_embeddings\n",
-    "\n",
-    "data = load_dataset(\"MongoDB/embedded_movies\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "1d630a26",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "df = pd.DataFrame(data[\"train\"])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a1f94f43",
-   "metadata": {},
-   "source": [
-    "## Step 4: Data analysis\n",
-    "\n",
-    "Make sure length of the dataset is what we expect, drop Nones etc."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "b276df71",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/html": [
-       "<div>\n",
-       "<style scoped>\n",
-       "    .dataframe tbody tr th:only-of-type {\n",
-       "        vertical-align: middle;\n",
-       "    }\n",
-       "\n",
-       "    .dataframe tbody tr th {\n",
-       "        vertical-align: top;\n",
-       "    }\n",
-       "\n",
-       "    .dataframe thead th {\n",
-       "        text-align: right;\n",
-       "    }\n",
-       "</style>\n",
-       "<table border=\"1\" class=\"dataframe\">\n",
-       "  <thead>\n",
-       "    <tr style=\"text-align: right;\">\n",
-       "      <th></th>\n",
-       "      <th>fullplot</th>\n",
-       "      <th>type</th>\n",
-       "      <th>plot_embedding</th>\n",
-       "      <th>num_mflix_comments</th>\n",
-       "      <th>runtime</th>\n",
-       "      <th>writers</th>\n",
-       "      <th>imdb</th>\n",
-       "      <th>countries</th>\n",
-       "      <th>rated</th>\n",
-       "      <th>plot</th>\n",
-       "      <th>title</th>\n",
-       "      <th>languages</th>\n",
-       "      <th>metacritic</th>\n",
-       "      <th>directors</th>\n",
-       "      <th>awards</th>\n",
-       "      <th>genres</th>\n",
-       "      <th>poster</th>\n",
-       "      <th>cast</th>\n",
-       "    </tr>\n",
-       "  </thead>\n",
-       "  <tbody>\n",
-       "    <tr>\n",
-       "      <th>0</th>\n",
-       "      <td>Young Pauline is left a lot of money when her ...</td>\n",
-       "      <td>movie</td>\n",
-       "      <td>[0.00072939653, -0.026834568, 0.013515796, -0....</td>\n",
-       "      <td>0</td>\n",
-       "      <td>199.0</td>\n",
-       "      <td>[Charles W. Goddard (screenplay), Basil Dickey...</td>\n",
-       "      <td>{'id': 4465, 'rating': 7.6, 'votes': 744}</td>\n",
-       "      <td>[USA]</td>\n",
-       "      <td>None</td>\n",
-       "      <td>Young Pauline is left a lot of money when her ...</td>\n",
-       "      <td>The Perils of Pauline</td>\n",
-       "      <td>[English]</td>\n",
-       "      <td>NaN</td>\n",
-       "      <td>[Louis J. Gasnier, Donald MacKenzie]</td>\n",
-       "      <td>{'nominations': 0, 'text': '1 win.', 'wins': 1}</td>\n",
-       "      <td>[Action]</td>\n",
-       "      <td>https://m.media-amazon.com/images/M/MV5BMzgxOD...</td>\n",
-       "      <td>[Pearl White, Crane Wilbur, Paul Panzer, Edwar...</td>\n",
-       "    </tr>\n",
-       "  </tbody>\n",
-       "</table>\n",
-       "</div>"
-      ],
-      "text/plain": [
-       "                                            fullplot   type  \\\n",
-       "0  Young Pauline is left a lot of money when her ...  movie   \n",
-       "\n",
-       "                                      plot_embedding  num_mflix_comments  \\\n",
-       "0  [0.00072939653, -0.026834568, 0.013515796, -0....                   0   \n",
-       "\n",
-       "   runtime                                            writers  \\\n",
-       "0    199.0  [Charles W. Goddard (screenplay), Basil Dickey...   \n",
-       "\n",
-       "                                        imdb countries rated  \\\n",
-       "0  {'id': 4465, 'rating': 7.6, 'votes': 744}     [USA]  None   \n",
-       "\n",
-       "                                                plot                  title  \\\n",
-       "0  Young Pauline is left a lot of money when her ...  The Perils of Pauline   \n",
-       "\n",
-       "   languages  metacritic                             directors  \\\n",
-       "0  [English]         NaN  [Louis J. Gasnier, Donald MacKenzie]   \n",
-       "\n",
-       "                                            awards    genres  \\\n",
-       "0  {'nominations': 0, 'text': '1 win.', 'wins': 1}  [Action]   \n",
-       "\n",
-       "                                              poster  \\\n",
-       "0  https://m.media-amazon.com/images/M/MV5BMzgxOD...   \n",
-       "\n",
-       "                                                cast  \n",
-       "0  [Pearl White, Crane Wilbur, Paul Panzer, Edwar...  "
-      ]
-     },
-     "execution_count": 10,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# Previewing the contents of the data\n",
-    "df.head(1)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "22ab375d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Only keep records where the fullplot field is not null\n",
-    "df = df[df[\"fullplot\"].notna()]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "fceed99a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Renaming the embedding field to \"embedding\" -- required by LangChain\n",
-    "df.rename(columns={\"plot_embedding\": \"embedding\"}, inplace=True)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "aedec13a",
-   "metadata": {},
-   "source": [
-    "## Step 5: Create a simple RAG chain using MongoDB as the vector store"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "11d292f3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_mongodb import MongoDBAtlasVectorSearch\n",
-    "from pymongo import MongoClient\n",
-    "\n",
-    "# Initialize MongoDB python client\n",
-    "client = MongoClient(MONGODB_URI, appname=\"devrel.content.python\")\n",
-    "\n",
-    "DB_NAME = \"langchain_chatbot\"\n",
-    "COLLECTION_NAME = \"data\"\n",
-    "ATLAS_VECTOR_SEARCH_INDEX_NAME = \"vector_index\"\n",
-    "collection = client[DB_NAME][COLLECTION_NAME]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "d8292d53",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "DeleteResult({'n': 1000, 'electionId': ObjectId('7fffffff00000000000000f6'), 'opTime': {'ts': Timestamp(1710523288, 1033), 't': 246}, 'ok': 1.0, '$clusterTime': {'clusterTime': Timestamp(1710523288, 1042), 'signature': {'hash': b\"i\\xa8\\xe9'\\x1ed\\xf2u\\xf3L\\xff\\xb1\\xf5\\xbfA\\x90\\xabJ\\x12\\x83\", 'keyId': 7299545392000008318}}, 'operationTime': Timestamp(1710523288, 1033)}, acknowledged=True)"
-      ]
-     },
-     "execution_count": 14,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# Delete any existing records in the collection\n",
-    "collection.delete_many({})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "36c68914",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Data ingestion into MongoDB completed\n"
-     ]
-    }
-   ],
-   "source": [
-    "# Data Ingestion\n",
-    "records = df.to_dict(\"records\")\n",
-    "collection.insert_many(records)\n",
-    "\n",
-    "print(\"Data ingestion into MongoDB completed\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 18,
-   "id": "cbfca0b8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_openai import OpenAIEmbeddings\n",
-    "\n",
-    "# Using the text-embedding-ada-002 since that's what was used to create embeddings in the movies dataset\n",
-    "embeddings = OpenAIEmbeddings(\n",
-    "    openai_api_key=OPENAI_API_KEY, model=\"text-embedding-ada-002\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 19,
-   "id": "798e176c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Vector Store Creation\n",
-    "vector_store = MongoDBAtlasVectorSearch.from_connection_string(\n",
-    "    connection_string=MONGODB_URI,\n",
-    "    namespace=DB_NAME + \".\" + COLLECTION_NAME,\n",
-    "    embedding=embeddings,\n",
-    "    index_name=ATLAS_VECTOR_SEARCH_INDEX_NAME,\n",
-    "    text_key=\"fullplot\",\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 49,
-   "id": "c71cd087",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Using the MongoDB vector store as a retriever in a RAG chain\n",
-    "retriever = vector_store.as_retriever(search_type=\"similarity\", search_kwargs={\"k\": 5})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 25,
-   "id": "b6588cd3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_core.output_parsers import StrOutputParser\n",
-    "from langchain_core.prompts import ChatPromptTemplate\n",
-    "from langchain_core.runnables import RunnablePassthrough\n",
-    "from langchain_openai import ChatOpenAI\n",
-    "\n",
-    "# Generate context using the retriever, and pass the user question through\n",
-    "retrieve = {\n",
-    "    \"context\": retriever | (lambda docs: \"\\n\\n\".join([d.page_content for d in docs])),\n",
-    "    \"question\": RunnablePassthrough(),\n",
-    "}\n",
-    "template = \"\"\"Answer the question based only on the following context: \\\n",
-    "{context}\n",
-    "\n",
-    "Question: {question}\n",
-    "\"\"\"\n",
-    "# Defining the chat prompt\n",
-    "prompt = ChatPromptTemplate.from_template(template)\n",
-    "# Defining the model to be used for chat completion\n",
-    "model = ChatOpenAI(temperature=0, openai_api_key=OPENAI_API_KEY)\n",
-    "# Parse output as a string\n",
-    "parse_output = StrOutputParser()\n",
-    "\n",
-    "# Naive RAG chain\n",
-    "naive_rag_chain = retrieve | prompt | model | parse_output"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 26,
-   "id": "aaae21f5",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'Once a Thief'"
-      ]
-     },
-     "execution_count": 26,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "naive_rag_chain.invoke(\"What is the best movie to watch when sad?\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "75f929ef",
-   "metadata": {},
-   "source": [
-    "## Step 6: Create a RAG chain with chat history"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 27,
-   "id": "94e7bd4a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_core.prompts import MessagesPlaceholder\n",
-    "from langchain_core.runnables.history import RunnableWithMessageHistory\n",
-    "from langchain_mongodb.chat_message_histories import MongoDBChatMessageHistory"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 29,
-   "id": "5bb30860",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def get_session_history(session_id: str) -> MongoDBChatMessageHistory:\n",
-    "    return MongoDBChatMessageHistory(\n",
-    "        MONGODB_URI, session_id, database_name=DB_NAME, collection_name=\"history\"\n",
-    "    )"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 50,
-   "id": "f51d0f35",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Given a follow-up question and history, create a standalone question\n",
-    "standalone_system_prompt = \"\"\"\n",
-    "Given a chat history and a follow-up question, rephrase the follow-up question to be a standalone question. \\\n",
-    "Do NOT answer the question, just reformulate it if needed, otherwise return it as is. \\\n",
-    "Only return the final standalone question. \\\n",
-    "\"\"\"\n",
-    "standalone_question_prompt = ChatPromptTemplate.from_messages(\n",
-    "    [\n",
-    "        (\"system\", standalone_system_prompt),\n",
-    "        MessagesPlaceholder(variable_name=\"history\"),\n",
-    "        (\"human\", \"{question}\"),\n",
-    "    ]\n",
-    ")\n",
-    "\n",
-    "question_chain = standalone_question_prompt | model | parse_output"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 51,
-   "id": "f3ef3354",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Generate context by passing output of the question_chain i.e. the standalone question to the retriever\n",
-    "retriever_chain = RunnablePassthrough.assign(\n",
-    "    context=question_chain\n",
-    "    | retriever\n",
-    "    | (lambda docs: \"\\n\\n\".join([d.page_content for d in docs]))\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 55,
-   "id": "5afb7345",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Create a prompt that includes the context, history and the follow-up question\n",
-    "rag_system_prompt = \"\"\"Answer the question based only on the following context: \\\n",
-    "{context}\n",
-    "\"\"\"\n",
-    "rag_prompt = ChatPromptTemplate.from_messages(\n",
-    "    [\n",
-    "        (\"system\", rag_system_prompt),\n",
-    "        MessagesPlaceholder(variable_name=\"history\"),\n",
-    "        (\"human\", \"{question}\"),\n",
-    "    ]\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 56,
-   "id": "f95f47d0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# RAG chain\n",
-    "rag_chain = retriever_chain | rag_prompt | model | parse_output"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 57,
-   "id": "9618d395",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'The best movie to watch when feeling down could be \"Last Action Hero.\" It\\'s a fun and action-packed film that blends reality and fantasy, offering an escape from the real world and providing an entertaining distraction.'"
-      ]
-     },
-     "execution_count": 57,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# RAG chain with history\n",
-    "with_message_history = RunnableWithMessageHistory(\n",
-    "    rag_chain,\n",
-    "    get_session_history,\n",
-    "    input_messages_key=\"question\",\n",
-    "    history_messages_key=\"history\",\n",
-    ")\n",
-    "with_message_history.invoke(\n",
-    "    {\"question\": \"What is the best movie to watch when sad?\"},\n",
-    "    {\"configurable\": {\"session_id\": \"1\"}},\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 58,
-   "id": "6e3080d1",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'I apologize for the confusion. Another movie that might lift your spirits when you\\'re feeling sad is \"Smilla\\'s Sense of Snow.\" It\\'s a mystery thriller that could engage your mind and distract you from your sadness with its intriguing plot and suspenseful storyline.'"
-      ]
-     },
-     "execution_count": 58,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "with_message_history.invoke(\n",
-    "    {\n",
-    "        \"question\": \"Hmmm..I don't want to watch that one. Can you suggest something else?\"\n",
-    "    },\n",
-    "    {\"configurable\": {\"session_id\": \"1\"}},\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 59,
-   "id": "daea2953",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'For a lighter movie option, you might enjoy \"Cousins.\" It\\'s a comedy film set in Barcelona with action and humor, offering a fun and entertaining escape from reality. The storyline is engaging and filled with comedic moments that could help lift your spirits.'"
-      ]
-     },
-     "execution_count": 59,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "with_message_history.invoke(\n",
-    "    {\"question\": \"How about something more light?\"},\n",
-    "    {\"configurable\": {\"session_id\": \"1\"}},\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "0de23a88",
-   "metadata": {},
-   "source": [
-    "## Step 7: Get faster responses using Semantic Cache\n",
-    "\n",
-    "**NOTE:** Semantic cache only caches the input to the LLM. When using it in retrieval chains, remember that documents retrieved can change between runs resulting in cache misses for semantically similar queries."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 61,
-   "id": "5d6b6741",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_core.globals import set_llm_cache\n",
-    "from langchain_mongodb.cache import MongoDBAtlasSemanticCache\n",
-    "\n",
-    "set_llm_cache(\n",
-    "    MongoDBAtlasSemanticCache(\n",
-    "        connection_string=MONGODB_URI,\n",
-    "        embedding=embeddings,\n",
-    "        collection_name=\"semantic_cache\",\n",
-    "        database_name=DB_NAME,\n",
-    "        index_name=ATLAS_VECTOR_SEARCH_INDEX_NAME,\n",
-    "        wait_until_ready=True,  # Optional, waits until the cache is ready to be used\n",
-    "    )\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 62,
-   "id": "9825bc7b",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "CPU times: user 87.8 ms, sys: 670 µs, total: 88.5 ms\n",
-      "Wall time: 1.24 s\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Once a Thief'"
-      ]
-     },
-     "execution_count": 62,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "%%time\n",
-    "naive_rag_chain.invoke(\"What is the best movie to watch when sad?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 63,
-   "id": "a5e518cf",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "CPU times: user 43.5 ms, sys: 4.16 ms, total: 47.7 ms\n",
-      "Wall time: 255 ms\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'Once a Thief'"
-      ]
-     },
-     "execution_count": 63,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "%%time\n",
-    "naive_rag_chain.invoke(\"What is the best movie to watch when sad?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 64,
-   "id": "3d3d3ad3",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "CPU times: user 115 ms, sys: 171 µs, total: 115 ms\n",
-      "Wall time: 1.38 s\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'I would recommend watching \"Last Action Hero\" when sad, as it is a fun and action-packed film that can help lift your spirits.'"
-      ]
-     },
-     "execution_count": 64,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "%%time\n",
-    "naive_rag_chain.invoke(\"Which movie do I watch when sad?\")"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "conda_pytorch_p310",
-   "language": "python",
-   "name": "conda_pytorch_p310"
-  },
-  "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.13"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/multi_modal_output_agent.ipynb

@@ -1,188 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "cd835d40",
-   "metadata": {},
-   "source": [
-    "# Multi-modal outputs: Image & Text"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fa88e03a",
-   "metadata": {},
-   "source": [
-    "This notebook shows how non-text producing tools can be used to create multi-modal agents.\n",
-    "\n",
-    "This example is limited to text and image outputs and uses UUIDs to transfer content across tools and agents. \n",
-    "\n",
-    "This example uses Steamship to generate and store generated images. Generated are auth protected by default. \n",
-    "\n",
-    "You can get your Steamship api key here: https://steamship.com/account/api"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0653da01",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import re\n",
-    "\n",
-    "from IPython.display import Image, display\n",
-    "from steamship import Block, Steamship"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "f6933033",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents import AgentType, initialize_agent\n",
-    "from langchain.tools import SteamshipImageGenerationTool\n",
-    "from langchain_openai import OpenAI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "71e51e53",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a9fc769d",
-   "metadata": {},
-   "source": [
-    "## Dall-E "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "cd177dfe",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = [SteamshipImageGenerationTool(model_name=\"dall-e\")]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "c71b1e46",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "mrkl = initialize_agent(\n",
-    "    tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "603aeb9a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "output = mrkl.run(\"How would you visualize a parot playing soccer?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "25eb4efe",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def show_output(output):\n",
-    "    \"\"\"Display the multi-modal output from the agent.\"\"\"\n",
-    "    UUID_PATTERN = re.compile(\n",
-    "        r\"([0-9A-Za-z]{8}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{4}-[0-9A-Za-z]{12})\"\n",
-    "    )\n",
-    "\n",
-    "    outputs = UUID_PATTERN.split(output)\n",
-    "    outputs = [\n",
-    "        re.sub(r\"^\\W+\", \"\", el) for el in outputs\n",
-    "    ]  # Clean trailing and leading non-word characters\n",
-    "\n",
-    "    for output in outputs:\n",
-    "        maybe_block_id = UUID_PATTERN.search(output)\n",
-    "        if maybe_block_id:\n",
-    "            display(Image(Block.get(Steamship(), _id=maybe_block_id.group()).raw()))\n",
-    "        else:\n",
-    "            print(output, end=\"\\n\\n\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e247b2c4",
-   "metadata": {},
-   "source": [
-    "## StableDiffusion "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "315025e7",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "tools = [SteamshipImageGenerationTool(model_name=\"stable-diffusion\")]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7930064a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "mrkl = initialize_agent(\n",
-    "    tools, llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "611a833d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "output = mrkl.run(\"How would you visualize a parot playing soccer?\")"
-   ]
-  }
- ],
- "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.12"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/multi_player_dnd.ipynb

@@ -1,530 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Multi-Player Dungeons & Dragons\n",
-    "\n",
-    "This notebook shows how the `DialogueAgent` and `DialogueSimulator` class make it easy to extend the [Two-Player Dungeons & Dragons example](https://python.langchain.com/en/latest/use_cases/agent_simulations/two_player_dnd.html) to multiple players.\n",
-    "\n",
-    "The main difference between simulating two players and multiple players is in revising the schedule for when each agent speaks\n",
-    "\n",
-    "To this end, we augment `DialogueSimulator` to take in a custom function that determines the schedule of which agent speaks. In the example below, each character speaks in round-robin fashion, with the storyteller interleaved between each player."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Import LangChain related modules "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Callable, List\n",
-    "\n",
-    "from langchain.schema import (\n",
-    "    HumanMessage,\n",
-    "    SystemMessage,\n",
-    ")\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## `DialogueAgent` class\n",
-    "The `DialogueAgent` class is a simple wrapper around the `ChatOpenAI` model that stores the message history from the `dialogue_agent`'s point of view by simply concatenating the messages as strings.\n",
-    "\n",
-    "It exposes two methods: \n",
-    "- `send()`: applies the chatmodel to the message history and returns the message string\n",
-    "- `receive(name, message)`: adds the `message` spoken by `name` to message history"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class DialogueAgent:\n",
-    "    def __init__(\n",
-    "        self,\n",
-    "        name: str,\n",
-    "        system_message: SystemMessage,\n",
-    "        model: ChatOpenAI,\n",
-    "    ) -> None:\n",
-    "        self.name = name\n",
-    "        self.system_message = system_message\n",
-    "        self.model = model\n",
-    "        self.prefix = f\"{self.name}: \"\n",
-    "        self.reset()\n",
-    "\n",
-    "    def reset(self):\n",
-    "        self.message_history = [\"Here is the conversation so far.\"]\n",
-    "\n",
-    "    def send(self) -> str:\n",
-    "        \"\"\"\n",
-    "        Applies the chatmodel to the message history\n",
-    "        and returns the message string\n",
-    "        \"\"\"\n",
-    "        message = self.model.invoke(\n",
-    "            [\n",
-    "                self.system_message,\n",
-    "                HumanMessage(content=\"\\n\".join(self.message_history + [self.prefix])),\n",
-    "            ]\n",
-    "        )\n",
-    "        return message.content\n",
-    "\n",
-    "    def receive(self, name: str, message: str) -> None:\n",
-    "        \"\"\"\n",
-    "        Concatenates {message} spoken by {name} into message history\n",
-    "        \"\"\"\n",
-    "        self.message_history.append(f\"{name}: {message}\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## `DialogueSimulator` class\n",
-    "The `DialogueSimulator` class takes a list of agents. At each step, it performs the following:\n",
-    "1. Select the next speaker\n",
-    "2. Calls the next speaker to send a message \n",
-    "3. Broadcasts the message to all other agents\n",
-    "4. Update the step counter.\n",
-    "The selection of the next speaker can be implemented as any function, but in this case we simply loop through the agents."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class DialogueSimulator:\n",
-    "    def __init__(\n",
-    "        self,\n",
-    "        agents: List[DialogueAgent],\n",
-    "        selection_function: Callable[[int, List[DialogueAgent]], int],\n",
-    "    ) -> None:\n",
-    "        self.agents = agents\n",
-    "        self._step = 0\n",
-    "        self.select_next_speaker = selection_function\n",
-    "\n",
-    "    def reset(self):\n",
-    "        for agent in self.agents:\n",
-    "            agent.reset()\n",
-    "\n",
-    "    def inject(self, name: str, message: str):\n",
-    "        \"\"\"\n",
-    "        Initiates the conversation with a {message} from {name}\n",
-    "        \"\"\"\n",
-    "        for agent in self.agents:\n",
-    "            agent.receive(name, message)\n",
-    "\n",
-    "        # increment time\n",
-    "        self._step += 1\n",
-    "\n",
-    "    def step(self) -> tuple[str, str]:\n",
-    "        # 1. choose the next speaker\n",
-    "        speaker_idx = self.select_next_speaker(self._step, self.agents)\n",
-    "        speaker = self.agents[speaker_idx]\n",
-    "\n",
-    "        # 2. next speaker sends message\n",
-    "        message = speaker.send()\n",
-    "\n",
-    "        # 3. everyone receives message\n",
-    "        for receiver in self.agents:\n",
-    "            receiver.receive(speaker.name, message)\n",
-    "\n",
-    "        # 4. increment time\n",
-    "        self._step += 1\n",
-    "\n",
-    "        return speaker.name, message"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Define roles and quest"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "character_names = [\"Harry Potter\", \"Ron Weasley\", \"Hermione Granger\", \"Argus Filch\"]\n",
-    "storyteller_name = \"Dungeon Master\"\n",
-    "quest = \"Find all of Lord Voldemort's seven horcruxes.\"\n",
-    "word_limit = 50  # word limit for task brainstorming"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Ask an LLM to add detail to the game description"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "game_description = f\"\"\"Here is the topic for a Dungeons & Dragons game: {quest}.\n",
-    "        The characters are: {(*character_names,)}.\n",
-    "        The story is narrated by the storyteller, {storyteller_name}.\"\"\"\n",
-    "\n",
-    "player_descriptor_system_message = SystemMessage(\n",
-    "    content=\"You can add detail to the description of a Dungeons & Dragons player.\"\n",
-    ")\n",
-    "\n",
-    "\n",
-    "def generate_character_description(character_name):\n",
-    "    character_specifier_prompt = [\n",
-    "        player_descriptor_system_message,\n",
-    "        HumanMessage(\n",
-    "            content=f\"\"\"{game_description}\n",
-    "            Please reply with a creative description of the character, {character_name}, in {word_limit} words or less. \n",
-    "            Speak directly to {character_name}.\n",
-    "            Do not add anything else.\"\"\"\n",
-    "        ),\n",
-    "    ]\n",
-    "    character_description = ChatOpenAI(temperature=1.0)(\n",
-    "        character_specifier_prompt\n",
-    "    ).content\n",
-    "    return character_description\n",
-    "\n",
-    "\n",
-    "def generate_character_system_message(character_name, character_description):\n",
-    "    return SystemMessage(\n",
-    "        content=(\n",
-    "            f\"\"\"{game_description}\n",
-    "    Your name is {character_name}. \n",
-    "    Your character description is as follows: {character_description}.\n",
-    "    You will propose actions you plan to take and {storyteller_name} will explain what happens when you take those actions.\n",
-    "    Speak in the first person from the perspective of {character_name}.\n",
-    "    For describing your own body movements, wrap your description in '*'.\n",
-    "    Do not change roles!\n",
-    "    Do not speak from the perspective of anyone else.\n",
-    "    Remember you are {character_name}.\n",
-    "    Stop speaking the moment you finish speaking from your perspective.\n",
-    "    Never forget to keep your response to {word_limit} words!\n",
-    "    Do not add anything else.\n",
-    "    \"\"\"\n",
-    "        )\n",
-    "    )\n",
-    "\n",
-    "\n",
-    "character_descriptions = [\n",
-    "    generate_character_description(character_name) for character_name in character_names\n",
-    "]\n",
-    "character_system_messages = [\n",
-    "    generate_character_system_message(character_name, character_description)\n",
-    "    for character_name, character_description in zip(\n",
-    "        character_names, character_descriptions\n",
-    "    )\n",
-    "]\n",
-    "\n",
-    "storyteller_specifier_prompt = [\n",
-    "    player_descriptor_system_message,\n",
-    "    HumanMessage(\n",
-    "        content=f\"\"\"{game_description}\n",
-    "        Please reply with a creative description of the storyteller, {storyteller_name}, in {word_limit} words or less. \n",
-    "        Speak directly to {storyteller_name}.\n",
-    "        Do not add anything else.\"\"\"\n",
-    "    ),\n",
-    "]\n",
-    "storyteller_description = ChatOpenAI(temperature=1.0)(\n",
-    "    storyteller_specifier_prompt\n",
-    ").content\n",
-    "\n",
-    "storyteller_system_message = SystemMessage(\n",
-    "    content=(\n",
-    "        f\"\"\"{game_description}\n",
-    "You are the storyteller, {storyteller_name}. \n",
-    "Your description is as follows: {storyteller_description}.\n",
-    "The other players will propose actions to take and you will explain what happens when they take those actions.\n",
-    "Speak in the first person from the perspective of {storyteller_name}.\n",
-    "Do not change roles!\n",
-    "Do not speak from the perspective of anyone else.\n",
-    "Remember you are the storyteller, {storyteller_name}.\n",
-    "Stop speaking the moment you finish speaking from your perspective.\n",
-    "Never forget to keep your response to {word_limit} words!\n",
-    "Do not add anything else.\n",
-    "\"\"\"\n",
-    "    )\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Storyteller Description:\n",
-      "Dungeon Master, your power over this adventure is unparalleled. With your whimsical mind and impeccable storytelling, you guide us through the dangers of Hogwarts and beyond. We eagerly await your every twist, your every turn, in the hunt for Voldemort's cursed horcruxes.\n",
-      "Harry Potter Description:\n",
-      "\"Welcome, Harry Potter. You are the young wizard with a lightning-shaped scar on your forehead. You possess brave and heroic qualities that will be essential on this perilous quest. Your destiny is not of your own choosing, but you must rise to the occasion and destroy the evil horcruxes. The wizarding world is counting on you.\"\n",
-      "Ron Weasley Description:\n",
-      "Ron Weasley, you are Harry's loyal friend and a talented wizard. You have a good heart but can be quick to anger. Keep your emotions in check as you journey to find the horcruxes. Your bravery will be tested, stay strong and focused.\n",
-      "Hermione Granger Description:\n",
-      "Hermione Granger, you are a brilliant and resourceful witch, with encyclopedic knowledge of magic and an unwavering dedication to your friends. Your quick thinking and problem-solving skills make you a vital asset on any quest.\n",
-      "Argus Filch Description:\n",
-      "Argus Filch, you are a squib, lacking magical abilities. But you make up for it with your sharpest of eyes, roving around the Hogwarts castle looking for any rule-breaker to punish. Your love for your feline friend, Mrs. Norris, is the only thing that feeds your heart.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(\"Storyteller Description:\")\n",
-    "print(storyteller_description)\n",
-    "for character_name, character_description in zip(\n",
-    "    character_names, character_descriptions\n",
-    "):\n",
-    "    print(f\"{character_name} Description:\")\n",
-    "    print(character_description)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Use an LLM to create an elaborate quest description"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Original quest:\n",
-      "Find all of Lord Voldemort's seven horcruxes.\n",
-      "\n",
-      "Detailed quest:\n",
-      "Harry Potter and his companions must journey to the Forbidden Forest, find the hidden entrance to Voldemort's secret lair, and retrieve the horcrux guarded by the deadly Acromantula, Aragog. Remember, time is of the essence as Voldemort's power grows stronger every day. Good luck.\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "quest_specifier_prompt = [\n",
-    "    SystemMessage(content=\"You can make a task more specific.\"),\n",
-    "    HumanMessage(\n",
-    "        content=f\"\"\"{game_description}\n",
-    "        \n",
-    "        You are the storyteller, {storyteller_name}.\n",
-    "        Please make the quest more specific. Be creative and imaginative.\n",
-    "        Please reply with the specified quest in {word_limit} words or less. \n",
-    "        Speak directly to the characters: {(*character_names,)}.\n",
-    "        Do not add anything else.\"\"\"\n",
-    "    ),\n",
-    "]\n",
-    "specified_quest = ChatOpenAI(temperature=1.0)(quest_specifier_prompt).content\n",
-    "\n",
-    "print(f\"Original quest:\\n{quest}\\n\")\n",
-    "print(f\"Detailed quest:\\n{specified_quest}\\n\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Main Loop"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "characters = []\n",
-    "for character_name, character_system_message in zip(\n",
-    "    character_names, character_system_messages\n",
-    "):\n",
-    "    characters.append(\n",
-    "        DialogueAgent(\n",
-    "            name=character_name,\n",
-    "            system_message=character_system_message,\n",
-    "            model=ChatOpenAI(temperature=0.2),\n",
-    "        )\n",
-    "    )\n",
-    "storyteller = DialogueAgent(\n",
-    "    name=storyteller_name,\n",
-    "    system_message=storyteller_system_message,\n",
-    "    model=ChatOpenAI(temperature=0.2),\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def select_next_speaker(step: int, agents: List[DialogueAgent]) -> int:\n",
-    "    \"\"\"\n",
-    "    If the step is even, then select the storyteller\n",
-    "    Otherwise, select the other characters in a round-robin fashion.\n",
-    "\n",
-    "    For example, with three characters with indices: 1 2 3\n",
-    "    The storyteller is index 0.\n",
-    "    Then the selected index will be as follows:\n",
-    "\n",
-    "    step: 0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16\n",
-    "\n",
-    "    idx:  0  1  0  2  0  3  0  1  0  2  0  3  0  1  0  2  0\n",
-    "    \"\"\"\n",
-    "    if step % 2 == 0:\n",
-    "        idx = 0\n",
-    "    else:\n",
-    "        idx = (step // 2) % (len(agents) - 1) + 1\n",
-    "    return idx"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "(Dungeon Master): Harry Potter and his companions must journey to the Forbidden Forest, find the hidden entrance to Voldemort's secret lair, and retrieve the horcrux guarded by the deadly Acromantula, Aragog. Remember, time is of the essence as Voldemort's power grows stronger every day. Good luck.\n",
-      "\n",
-      "\n",
-      "(Harry Potter): I suggest we sneak into the Forbidden Forest under the cover of darkness. Ron, Hermione, and I can use our wands to create a Disillusionment Charm to make us invisible. Filch, you can keep watch for any signs of danger. Let's move quickly and quietly.\n",
-      "\n",
-      "\n",
-      "(Dungeon Master): As you make your way through the Forbidden Forest, you hear the eerie sounds of nocturnal creatures. Suddenly, you come across a clearing where Aragog and his spider minions are waiting for you. Ron, Hermione, and Harry, you must use your wands to cast spells to fend off the spiders while Filch keeps watch. Be careful not to get bitten!\n",
-      "\n",
-      "\n",
-      "(Ron Weasley): I'll cast a spell to create a fiery blast to scare off the spiders. *I wave my wand and shout \"Incendio!\"* Hopefully, that will give us enough time to find the horcrux and get out of here safely.\n",
-      "\n",
-      "\n",
-      "(Dungeon Master): Ron's spell creates a burst of flames, causing the spiders to scurry away in fear. You quickly search the area and find a small, ornate box hidden in a crevice. Congratulations, you have found one of Voldemort's horcruxes! But beware, the Dark Lord's minions will stop at nothing to get it back.\n",
-      "\n",
-      "\n",
-      "(Hermione Granger): We need to destroy this horcrux as soon as possible. I suggest we use the Sword of Gryffindor to do it. Harry, do you still have it with you? We can use Fiendfyre to destroy it, but we need to be careful not to let the flames get out of control. Ron, can you help me create a protective barrier around us while Harry uses the sword?\n",
-      "\n",
-      "\n",
-      "\n",
-      "(Dungeon Master): Harry retrieves the Sword of Gryffindor from his bag and holds it tightly. Hermione and Ron cast a protective barrier around the group as Harry uses the sword to destroy the horcrux with a swift strike. The box shatters into a million pieces, and a dark energy dissipates into the air. Well done, but there are still six more horcruxes to find and destroy. The hunt continues.\n",
-      "\n",
-      "\n",
-      "(Argus Filch): *I keep watch, making sure no one is following us.* I'll also keep an eye out for any signs of danger. Mrs. Norris, my trusty companion, will help me sniff out any trouble. We'll make sure the group stays safe while they search for the remaining horcruxes.\n",
-      "\n",
-      "\n",
-      "(Dungeon Master): As you continue on your quest, Filch and Mrs. Norris alert you to a group of Death Eaters approaching. You must act quickly to defend yourselves. Harry, Ron, and Hermione, use your wands to cast spells while Filch and Mrs. Norris keep watch. Remember, the fate of the wizarding world rests on your success.\n",
-      "\n",
-      "\n",
-      "(Harry Potter): I'll cast a spell to create a shield around us. *I wave my wand and shout \"Protego!\"* Ron and Hermione, you focus on attacking the Death Eaters with your spells. We need to work together to defeat them and protect the remaining horcruxes. Filch, keep watch and let us know if there are any more approaching.\n",
-      "\n",
-      "\n",
-      "(Dungeon Master): Harry's shield protects the group from the Death Eaters' spells as Ron and Hermione launch their own attacks. The Death Eaters are no match for the combined power of the trio and are quickly defeated. You continue on your journey, knowing that the next horcrux could be just around the corner. Keep your wits about you, for the Dark Lord's minions are always watching.\n",
-      "\n",
-      "\n",
-      "(Ron Weasley): I suggest we split up to cover more ground. Harry and I can search the Forbidden Forest while Hermione and Filch search Hogwarts. We can use our wands to communicate with each other and meet back up once we find a horcrux. Let's move quickly and stay alert for any danger.\n",
-      "\n",
-      "\n",
-      "(Dungeon Master): As the group splits up, Harry and Ron make their way deeper into the Forbidden Forest while Hermione and Filch search the halls of Hogwarts. Suddenly, Harry and Ron come across a group of dementors. They must use their Patronus charms to fend them off while Hermione and Filch rush to their aid. Remember, the power of friendship and teamwork is crucial in this quest.\n",
-      "\n",
-      "\n",
-      "(Hermione Granger): I hear Harry and Ron's Patronus charms from afar. We need to hurry and help them. Filch, can you use your knowledge of Hogwarts to find a shortcut to their location? I'll prepare a spell to repel the dementors. We need to work together to protect each other and find the next horcrux.\n",
-      "\n",
-      "\n",
-      "\n",
-      "(Dungeon Master): Filch leads Hermione to a hidden passageway that leads to Harry and Ron's location. Hermione's spell repels the dementors, and the group is reunited. They continue their search, knowing that every moment counts. The fate of the wizarding world rests on their success.\n",
-      "\n",
-      "\n",
-      "(Argus Filch): *I keep watch as the group searches for the next horcrux.* Mrs. Norris and I will make sure no one is following us. We need to stay alert and work together to find the remaining horcruxes before it's too late. The Dark Lord's power grows stronger every day, and we must not let him win.\n",
-      "\n",
-      "\n",
-      "(Dungeon Master): As the group continues their search, they come across a hidden room in the depths of Hogwarts. Inside, they find a locket that they suspect is another one of Voldemort's horcruxes. But the locket is cursed, and they must work together to break the curse before they can destroy it. Harry, Ron, and Hermione, use your combined knowledge and skills to break the curse while Filch and Mrs. Norris keep watch. Time is running out, and the fate of the wizarding world rests on your success.\n",
-      "\n",
-      "\n",
-      "(Harry Potter): I'll use my knowledge of dark magic to try and break the curse on the locket. Ron and Hermione, you can help me by using your wands to channel your magic into mine. We need to work together and stay focused. Filch, keep watch and let us know if there are any signs of danger.\n",
-      "Dungeon Master: Harry, Ron, and Hermione combine their magical abilities to break the curse on the locket. The locket opens, revealing a small piece of Voldemort's soul. Harry uses the Sword of Gryffindor to destroy it, and the group feels a sense of relief knowing that they are one step closer to defeating the Dark Lord. But there are still four more horcruxes to find and destroy. The hunt continues.\n",
-      "\n",
-      "\n",
-      "(Dungeon Master): As the group continues their quest, they face even greater challenges and dangers. But with their unwavering determination and teamwork, they press on, knowing that the fate of the wizarding world rests on their success. Will they be able to find and destroy all of Voldemort's horcruxes before it's too late? Only time will tell.\n",
-      "\n",
-      "\n",
-      "(Ron Weasley): We can't give up now. We've come too far to let Voldemort win. Let's keep searching and fighting until we destroy all of his horcruxes and defeat him once and for all. We can do this together.\n",
-      "\n",
-      "\n",
-      "(Dungeon Master): The group nods in agreement, their determination stronger than ever. They continue their search, facing challenges and obstacles at every turn. But they know that they must not give up, for the fate of the wizarding world rests on their success. The hunt for Voldemort's horcruxes continues, and the end is in sight.\n",
-      "\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "max_iters = 20\n",
-    "n = 0\n",
-    "\n",
-    "simulator = DialogueSimulator(\n",
-    "    agents=[storyteller] + characters, selection_function=select_next_speaker\n",
-    ")\n",
-    "simulator.reset()\n",
-    "simulator.inject(storyteller_name, specified_quest)\n",
-    "print(f\"({storyteller_name}): {specified_quest}\")\n",
-    "print(\"\\n\")\n",
-    "\n",
-    "while n < max_iters:\n",
-    "    name, message = simulator.step()\n",
-    "    print(f\"({name}): {message}\")\n",
-    "    print(\"\\n\")\n",
-    "    n += 1"
-   ]
-  },
-  {
-   "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.9.16"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

cookbook/multiagent_authoritarian.ipynb

@@ -1,888 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Multi-agent authoritarian speaker selection\n",
-    "\n",
-    "This notebook showcases how to implement a multi-agent simulation where a privileged agent decides who to speak.\n",
-    "This follows the polar opposite selection scheme as [multi-agent decentralized speaker selection](https://python.langchain.com/en/latest/use_cases/agent_simulations/multiagent_bidding.html).\n",
-    "\n",
-    "We show an example of this approach in the context of a fictitious simulation of a news network. This example will showcase how we can implement agents that\n",
-    "- think before speaking\n",
-    "- terminate the conversation"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Import LangChain related modules "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import functools\n",
-    "import random\n",
-    "from collections import OrderedDict\n",
-    "from typing import Callable, List\n",
-    "\n",
-    "import tenacity\n",
-    "from langchain.output_parsers import RegexParser\n",
-    "from langchain.prompts import (\n",
-    "    PromptTemplate,\n",
-    ")\n",
-    "from langchain.schema import (\n",
-    "    HumanMessage,\n",
-    "    SystemMessage,\n",
-    ")\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## `DialogueAgent` and `DialogueSimulator` classes\n",
-    "We will use the same `DialogueAgent` and `DialogueSimulator` classes defined in our other examples [Multi-Player Dungeons & Dragons](https://python.langchain.com/en/latest/use_cases/agent_simulations/multi_player_dnd.html) and [Decentralized Speaker Selection](https://python.langchain.com/en/latest/use_cases/agent_simulations/multiagent_bidding.html)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class DialogueAgent:\n",
-    "    def __init__(\n",
-    "        self,\n",
-    "        name: str,\n",
-    "        system_message: SystemMessage,\n",
-    "        model: ChatOpenAI,\n",
-    "    ) -> None:\n",
-    "        self.name = name\n",
-    "        self.system_message = system_message\n",
-    "        self.model = model\n",
-    "        self.prefix = f\"{self.name}: \"\n",
-    "        self.reset()\n",
-    "\n",
-    "    def reset(self):\n",
-    "        self.message_history = [\"Here is the conversation so far.\"]\n",
-    "\n",
-    "    def send(self) -> str:\n",
-    "        \"\"\"\n",
-    "        Applies the chatmodel to the message history\n",
-    "        and returns the message string\n",
-    "        \"\"\"\n",
-    "        message = self.model.invoke(\n",
-    "            [\n",
-    "                self.system_message,\n",
-    "                HumanMessage(content=\"\\n\".join(self.message_history + [self.prefix])),\n",
-    "            ]\n",
-    "        )\n",
-    "        return message.content\n",
-    "\n",
-    "    def receive(self, name: str, message: str) -> None:\n",
-    "        \"\"\"\n",
-    "        Concatenates {message} spoken by {name} into message history\n",
-    "        \"\"\"\n",
-    "        self.message_history.append(f\"{name}: {message}\")\n",
-    "\n",
-    "\n",
-    "class DialogueSimulator:\n",
-    "    def __init__(\n",
-    "        self,\n",
-    "        agents: List[DialogueAgent],\n",
-    "        selection_function: Callable[[int, List[DialogueAgent]], int],\n",
-    "    ) -> None:\n",
-    "        self.agents = agents\n",
-    "        self._step = 0\n",
-    "        self.select_next_speaker = selection_function\n",
-    "\n",
-    "    def reset(self):\n",
-    "        for agent in self.agents:\n",
-    "            agent.reset()\n",
-    "\n",
-    "    def inject(self, name: str, message: str):\n",
-    "        \"\"\"\n",
-    "        Initiates the conversation with a {message} from {name}\n",
-    "        \"\"\"\n",
-    "        for agent in self.agents:\n",
-    "            agent.receive(name, message)\n",
-    "\n",
-    "        # increment time\n",
-    "        self._step += 1\n",
-    "\n",
-    "    def step(self) -> tuple[str, str]:\n",
-    "        # 1. choose the next speaker\n",
-    "        speaker_idx = self.select_next_speaker(self._step, self.agents)\n",
-    "        speaker = self.agents[speaker_idx]\n",
-    "\n",
-    "        # 2. next speaker sends message\n",
-    "        message = speaker.send()\n",
-    "\n",
-    "        # 3. everyone receives message\n",
-    "        for receiver in self.agents:\n",
-    "            receiver.receive(speaker.name, message)\n",
-    "\n",
-    "        # 4. increment time\n",
-    "        self._step += 1\n",
-    "\n",
-    "        return speaker.name, message"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## `DirectorDialogueAgent` class\n",
-    "The `DirectorDialogueAgent` is a privileged agent that chooses which of the other agents to speak next. This agent is responsible for\n",
-    "1. steering the conversation by choosing which agent speaks when\n",
-    "2. terminating the conversation.\n",
-    "\n",
-    "In order to implement such an agent, we need to solve several problems.\n",
-    "\n",
-    "First, to steer the conversation, the `DirectorDialogueAgent` needs to (1) reflect on what has been said, (2) choose the next agent, and (3) prompt the next agent to speak, all in a single message. While it may be possible to prompt an LLM to perform all three steps in the same call, this requires writing custom code to parse the outputted message to extract which next agent is chosen to speak. This is less reliable the LLM can express how it chooses the next agent in different ways.\n",
-    "\n",
-    "What we can do instead is to explicitly break steps (1-3) into three separate LLM calls. First we will ask the `DirectorDialogueAgent` to reflect on the conversation so far and generate a response. Then we prompt the `DirectorDialogueAgent` to output the index of the next agent, which is easily parseable. Lastly, we pass the name of the selected next agent back to `DirectorDialogueAgent` to ask it prompt the next agent to speak. \n",
-    "\n",
-    "Second, simply prompting the `DirectorDialogueAgent` to decide when to terminate the conversation often results in the `DirectorDialogueAgent` terminating the conversation immediately. To fix this problem, we randomly sample a Bernoulli variable to decide whether the conversation should terminate. Depending on the value of this variable, we will inject a custom prompt to tell the `DirectorDialogueAgent` to either continue the conversation or terminate the conversation."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class IntegerOutputParser(RegexParser):\n",
-    "    def get_format_instructions(self) -> str:\n",
-    "        return \"Your response should be an integer delimited by angled brackets, like this: <int>.\"\n",
-    "\n",
-    "\n",
-    "class DirectorDialogueAgent(DialogueAgent):\n",
-    "    def __init__(\n",
-    "        self,\n",
-    "        name,\n",
-    "        system_message: SystemMessage,\n",
-    "        model: ChatOpenAI,\n",
-    "        speakers: List[DialogueAgent],\n",
-    "        stopping_probability: float,\n",
-    "    ) -> None:\n",
-    "        super().__init__(name, system_message, model)\n",
-    "        self.speakers = speakers\n",
-    "        self.next_speaker = \"\"\n",
-    "\n",
-    "        self.stop = False\n",
-    "        self.stopping_probability = stopping_probability\n",
-    "        self.termination_clause = \"Finish the conversation by stating a concluding message and thanking everyone.\"\n",
-    "        self.continuation_clause = \"Do not end the conversation. Keep the conversation going by adding your own ideas.\"\n",
-    "\n",
-    "        # 1. have a prompt for generating a response to the previous speaker\n",
-    "        self.response_prompt_template = PromptTemplate(\n",
-    "            input_variables=[\"message_history\", \"termination_clause\"],\n",
-    "            template=f\"\"\"{{message_history}}\n",
-    "\n",
-    "Follow up with an insightful comment.\n",
-    "{{termination_clause}}\n",
-    "{self.prefix}\n",
-    "        \"\"\",\n",
-    "        )\n",
-    "\n",
-    "        # 2. have a prompt for deciding who to speak next\n",
-    "        self.choice_parser = IntegerOutputParser(\n",
-    "            regex=r\"<(\\d+)>\", output_keys=[\"choice\"], default_output_key=\"choice\"\n",
-    "        )\n",
-    "        self.choose_next_speaker_prompt_template = PromptTemplate(\n",
-    "            input_variables=[\"message_history\", \"speaker_names\"],\n",
-    "            template=f\"\"\"{{message_history}}\n",
-    "\n",
-    "Given the above conversation, select the next speaker by choosing index next to their name: \n",
-    "{{speaker_names}}\n",
-    "\n",
-    "{self.choice_parser.get_format_instructions()}\n",
-    "\n",
-    "Do nothing else.\n",
-    "        \"\"\",\n",
-    "        )\n",
-    "\n",
-    "        # 3. have a prompt for prompting the next speaker to speak\n",
-    "        self.prompt_next_speaker_prompt_template = PromptTemplate(\n",
-    "            input_variables=[\"message_history\", \"next_speaker\"],\n",
-    "            template=f\"\"\"{{message_history}}\n",
-    "\n",
-    "The next speaker is {{next_speaker}}. \n",
-    "Prompt the next speaker to speak with an insightful question.\n",
-    "{self.prefix}\n",
-    "        \"\"\",\n",
-    "        )\n",
-    "\n",
-    "    def _generate_response(self):\n",
-    "        # if self.stop = True, then we will inject the prompt with a termination clause\n",
-    "        sample = random.uniform(0, 1)\n",
-    "        self.stop = sample < self.stopping_probability\n",
-    "\n",
-    "        print(f\"\\tStop? {self.stop}\\n\")\n",
-    "\n",
-    "        response_prompt = self.response_prompt_template.format(\n",
-    "            message_history=\"\\n\".join(self.message_history),\n",
-    "            termination_clause=self.termination_clause if self.stop else \"\",\n",
-    "        )\n",
-    "\n",
-    "        self.response = self.model.invoke(\n",
-    "            [\n",
-    "                self.system_message,\n",
-    "                HumanMessage(content=response_prompt),\n",
-    "            ]\n",
-    "        ).content\n",
-    "\n",
-    "        return self.response\n",
-    "\n",
-    "    @tenacity.retry(\n",
-    "        stop=tenacity.stop_after_attempt(2),\n",
-    "        wait=tenacity.wait_none(),  # No waiting time between retries\n",
-    "        retry=tenacity.retry_if_exception_type(ValueError),\n",
-    "        before_sleep=lambda retry_state: print(\n",
-    "            f\"ValueError occurred: {retry_state.outcome.exception()}, retrying...\"\n",
-    "        ),\n",
-    "        retry_error_callback=lambda retry_state: 0,\n",
-    "    )  # Default value when all retries are exhausted\n",
-    "    def _choose_next_speaker(self) -> str:\n",
-    "        speaker_names = \"\\n\".join(\n",
-    "            [f\"{idx}: {name}\" for idx, name in enumerate(self.speakers)]\n",
-    "        )\n",
-    "        choice_prompt = self.choose_next_speaker_prompt_template.format(\n",
-    "            message_history=\"\\n\".join(\n",
-    "                self.message_history + [self.prefix] + [self.response]\n",
-    "            ),\n",
-    "            speaker_names=speaker_names,\n",
-    "        )\n",
-    "\n",
-    "        choice_string = self.model.invoke(\n",
-    "            [\n",
-    "                self.system_message,\n",
-    "                HumanMessage(content=choice_prompt),\n",
-    "            ]\n",
-    "        ).content\n",
-    "        choice = int(self.choice_parser.parse(choice_string)[\"choice\"])\n",
-    "\n",
-    "        return choice\n",
-    "\n",
-    "    def select_next_speaker(self):\n",
-    "        return self.chosen_speaker_id\n",
-    "\n",
-    "    def send(self) -> str:\n",
-    "        \"\"\"\n",
-    "        Applies the chatmodel to the message history\n",
-    "        and returns the message string\n",
-    "        \"\"\"\n",
-    "        # 1. generate and save response to the previous speaker\n",
-    "        self.response = self._generate_response()\n",
-    "\n",
-    "        if self.stop:\n",
-    "            message = self.response\n",
-    "        else:\n",
-    "            # 2. decide who to speak next\n",
-    "            self.chosen_speaker_id = self._choose_next_speaker()\n",
-    "            self.next_speaker = self.speakers[self.chosen_speaker_id]\n",
-    "            print(f\"\\tNext speaker: {self.next_speaker}\\n\")\n",
-    "\n",
-    "            # 3. prompt the next speaker to speak\n",
-    "            next_prompt = self.prompt_next_speaker_prompt_template.format(\n",
-    "                message_history=\"\\n\".join(\n",
-    "                    self.message_history + [self.prefix] + [self.response]\n",
-    "                ),\n",
-    "                next_speaker=self.next_speaker,\n",
-    "            )\n",
-    "            message = self.model.invoke(\n",
-    "                [\n",
-    "                    self.system_message,\n",
-    "                    HumanMessage(content=next_prompt),\n",
-    "                ]\n",
-    "            ).content\n",
-    "            message = \" \".join([self.response, message])\n",
-    "\n",
-    "        return message"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Define participants and topic"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "topic = \"The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze\"\n",
-    "director_name = \"Jon Stewart\"\n",
-    "agent_summaries = OrderedDict(\n",
-    "    {\n",
-    "        \"Jon Stewart\": (\"Host of the Daily Show\", \"New York\"),\n",
-    "        \"Samantha Bee\": (\"Hollywood Correspondent\", \"Los Angeles\"),\n",
-    "        \"Aasif Mandvi\": (\"CIA Correspondent\", \"Washington D.C.\"),\n",
-    "        \"Ronny Chieng\": (\"Average American Correspondent\", \"Cleveland, Ohio\"),\n",
-    "    }\n",
-    ")\n",
-    "word_limit = 50"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Generate system messages"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent_summary_string = \"\\n- \".join(\n",
-    "    [\"\"]\n",
-    "    + [\n",
-    "        f\"{name}: {role}, located in {location}\"\n",
-    "        for name, (role, location) in agent_summaries.items()\n",
-    "    ]\n",
-    ")\n",
-    "\n",
-    "conversation_description = f\"\"\"This is a Daily Show episode discussing the following topic: {topic}.\n",
-    "\n",
-    "The episode features {agent_summary_string}.\"\"\"\n",
-    "\n",
-    "agent_descriptor_system_message = SystemMessage(\n",
-    "    content=\"You can add detail to the description of each person.\"\n",
-    ")\n",
-    "\n",
-    "\n",
-    "def generate_agent_description(agent_name, agent_role, agent_location):\n",
-    "    agent_specifier_prompt = [\n",
-    "        agent_descriptor_system_message,\n",
-    "        HumanMessage(\n",
-    "            content=f\"\"\"{conversation_description}\n",
-    "            Please reply with a creative description of {agent_name}, who is a {agent_role} in {agent_location}, that emphasizes their particular role and location.\n",
-    "            Speak directly to {agent_name} in {word_limit} words or less.\n",
-    "            Do not add anything else.\"\"\"\n",
-    "        ),\n",
-    "    ]\n",
-    "    agent_description = ChatOpenAI(temperature=1.0)(agent_specifier_prompt).content\n",
-    "    return agent_description\n",
-    "\n",
-    "\n",
-    "def generate_agent_header(agent_name, agent_role, agent_location, agent_description):\n",
-    "    return f\"\"\"{conversation_description}\n",
-    "\n",
-    "Your name is {agent_name}, your role is {agent_role}, and you are located in {agent_location}.\n",
-    "\n",
-    "Your description is as follows: {agent_description}\n",
-    "\n",
-    "You are discussing the topic: {topic}.\n",
-    "\n",
-    "Your goal is to provide the most informative, creative, and novel perspectives of the topic from the perspective of your role and your location.\n",
-    "\"\"\"\n",
-    "\n",
-    "\n",
-    "def generate_agent_system_message(agent_name, agent_header):\n",
-    "    return SystemMessage(\n",
-    "        content=(\n",
-    "            f\"\"\"{agent_header}\n",
-    "You will speak in the style of {agent_name}, and exaggerate your personality.\n",
-    "Do not say the same things over and over again.\n",
-    "Speak in the first person from the perspective of {agent_name}\n",
-    "For describing your own body movements, wrap your description in '*'.\n",
-    "Do not change roles!\n",
-    "Do not speak from the perspective of anyone else.\n",
-    "Speak only from the perspective of {agent_name}.\n",
-    "Stop speaking the moment you finish speaking from your perspective.\n",
-    "Never forget to keep your response to {word_limit} words!\n",
-    "Do not add anything else.\n",
-    "    \"\"\"\n",
-    "        )\n",
-    "    )\n",
-    "\n",
-    "\n",
-    "agent_descriptions = [\n",
-    "    generate_agent_description(name, role, location)\n",
-    "    for name, (role, location) in agent_summaries.items()\n",
-    "]\n",
-    "agent_headers = [\n",
-    "    generate_agent_header(name, role, location, description)\n",
-    "    for (name, (role, location)), description in zip(\n",
-    "        agent_summaries.items(), agent_descriptions\n",
-    "    )\n",
-    "]\n",
-    "agent_system_messages = [\n",
-    "    generate_agent_system_message(name, header)\n",
-    "    for name, header in zip(agent_summaries, agent_headers)\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "Jon Stewart Description:\n",
-      "\n",
-      "Jon Stewart, the sharp-tongued and quick-witted host of the Daily Show, holding it down in the hustle and bustle of New York City. Ready to deliver the news with a comedic twist, while keeping it real in the city that never sleeps.\n",
-      "\n",
-      "Header:\n",
-      "This is a Daily Show episode discussing the following topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "The episode features \n",
-      "- Jon Stewart: Host of the Daily Show, located in New York\n",
-      "- Samantha Bee: Hollywood Correspondent, located in Los Angeles\n",
-      "- Aasif Mandvi: CIA Correspondent, located in Washington D.C.\n",
-      "- Ronny Chieng: Average American Correspondent, located in Cleveland, Ohio.\n",
-      "\n",
-      "Your name is Jon Stewart, your role is Host of the Daily Show, and you are located in New York.\n",
-      "\n",
-      "Your description is as follows: Jon Stewart, the sharp-tongued and quick-witted host of the Daily Show, holding it down in the hustle and bustle of New York City. Ready to deliver the news with a comedic twist, while keeping it real in the city that never sleeps.\n",
-      "\n",
-      "You are discussing the topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "Your goal is to provide the most informative, creative, and novel perspectives of the topic from the perspective of your role and your location.\n",
-      "\n",
-      "\n",
-      "System Message:\n",
-      "This is a Daily Show episode discussing the following topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "The episode features \n",
-      "- Jon Stewart: Host of the Daily Show, located in New York\n",
-      "- Samantha Bee: Hollywood Correspondent, located in Los Angeles\n",
-      "- Aasif Mandvi: CIA Correspondent, located in Washington D.C.\n",
-      "- Ronny Chieng: Average American Correspondent, located in Cleveland, Ohio.\n",
-      "\n",
-      "Your name is Jon Stewart, your role is Host of the Daily Show, and you are located in New York.\n",
-      "\n",
-      "Your description is as follows: Jon Stewart, the sharp-tongued and quick-witted host of the Daily Show, holding it down in the hustle and bustle of New York City. Ready to deliver the news with a comedic twist, while keeping it real in the city that never sleeps.\n",
-      "\n",
-      "You are discussing the topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "Your goal is to provide the most informative, creative, and novel perspectives of the topic from the perspective of your role and your location.\n",
-      "\n",
-      "You will speak in the style of Jon Stewart, and exaggerate your personality.\n",
-      "Do not say the same things over and over again.\n",
-      "Speak in the first person from the perspective of Jon Stewart\n",
-      "For describing your own body movements, wrap your description in '*'.\n",
-      "Do not change roles!\n",
-      "Do not speak from the perspective of anyone else.\n",
-      "Speak only from the perspective of Jon Stewart.\n",
-      "Stop speaking the moment you finish speaking from your perspective.\n",
-      "Never forget to keep your response to 50 words!\n",
-      "Do not add anything else.\n",
-      "    \n",
-      "\n",
-      "\n",
-      "Samantha Bee Description:\n",
-      "\n",
-      "Samantha Bee, your location in Los Angeles as the Hollywood Correspondent gives you a front-row seat to the latest and sometimes outrageous trends in fitness. Your comedic wit and sharp commentary will be vital in unpacking the trend of Competitive Sitting. Let's sit down and discuss.\n",
-      "\n",
-      "Header:\n",
-      "This is a Daily Show episode discussing the following topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "The episode features \n",
-      "- Jon Stewart: Host of the Daily Show, located in New York\n",
-      "- Samantha Bee: Hollywood Correspondent, located in Los Angeles\n",
-      "- Aasif Mandvi: CIA Correspondent, located in Washington D.C.\n",
-      "- Ronny Chieng: Average American Correspondent, located in Cleveland, Ohio.\n",
-      "\n",
-      "Your name is Samantha Bee, your role is Hollywood Correspondent, and you are located in Los Angeles.\n",
-      "\n",
-      "Your description is as follows: Samantha Bee, your location in Los Angeles as the Hollywood Correspondent gives you a front-row seat to the latest and sometimes outrageous trends in fitness. Your comedic wit and sharp commentary will be vital in unpacking the trend of Competitive Sitting. Let's sit down and discuss.\n",
-      "\n",
-      "You are discussing the topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "Your goal is to provide the most informative, creative, and novel perspectives of the topic from the perspective of your role and your location.\n",
-      "\n",
-      "\n",
-      "System Message:\n",
-      "This is a Daily Show episode discussing the following topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "The episode features \n",
-      "- Jon Stewart: Host of the Daily Show, located in New York\n",
-      "- Samantha Bee: Hollywood Correspondent, located in Los Angeles\n",
-      "- Aasif Mandvi: CIA Correspondent, located in Washington D.C.\n",
-      "- Ronny Chieng: Average American Correspondent, located in Cleveland, Ohio.\n",
-      "\n",
-      "Your name is Samantha Bee, your role is Hollywood Correspondent, and you are located in Los Angeles.\n",
-      "\n",
-      "Your description is as follows: Samantha Bee, your location in Los Angeles as the Hollywood Correspondent gives you a front-row seat to the latest and sometimes outrageous trends in fitness. Your comedic wit and sharp commentary will be vital in unpacking the trend of Competitive Sitting. Let's sit down and discuss.\n",
-      "\n",
-      "You are discussing the topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "Your goal is to provide the most informative, creative, and novel perspectives of the topic from the perspective of your role and your location.\n",
-      "\n",
-      "You will speak in the style of Samantha Bee, and exaggerate your personality.\n",
-      "Do not say the same things over and over again.\n",
-      "Speak in the first person from the perspective of Samantha Bee\n",
-      "For describing your own body movements, wrap your description in '*'.\n",
-      "Do not change roles!\n",
-      "Do not speak from the perspective of anyone else.\n",
-      "Speak only from the perspective of Samantha Bee.\n",
-      "Stop speaking the moment you finish speaking from your perspective.\n",
-      "Never forget to keep your response to 50 words!\n",
-      "Do not add anything else.\n",
-      "    \n",
-      "\n",
-      "\n",
-      "Aasif Mandvi Description:\n",
-      "\n",
-      "Aasif Mandvi, the CIA Correspondent in the heart of Washington D.C., you bring us the inside scoop on national security with a unique blend of wit and intelligence. The nation's capital is lucky to have you, Aasif - keep those secrets safe!\n",
-      "\n",
-      "Header:\n",
-      "This is a Daily Show episode discussing the following topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "The episode features \n",
-      "- Jon Stewart: Host of the Daily Show, located in New York\n",
-      "- Samantha Bee: Hollywood Correspondent, located in Los Angeles\n",
-      "- Aasif Mandvi: CIA Correspondent, located in Washington D.C.\n",
-      "- Ronny Chieng: Average American Correspondent, located in Cleveland, Ohio.\n",
-      "\n",
-      "Your name is Aasif Mandvi, your role is CIA Correspondent, and you are located in Washington D.C..\n",
-      "\n",
-      "Your description is as follows: Aasif Mandvi, the CIA Correspondent in the heart of Washington D.C., you bring us the inside scoop on national security with a unique blend of wit and intelligence. The nation's capital is lucky to have you, Aasif - keep those secrets safe!\n",
-      "\n",
-      "You are discussing the topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "Your goal is to provide the most informative, creative, and novel perspectives of the topic from the perspective of your role and your location.\n",
-      "\n",
-      "\n",
-      "System Message:\n",
-      "This is a Daily Show episode discussing the following topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "The episode features \n",
-      "- Jon Stewart: Host of the Daily Show, located in New York\n",
-      "- Samantha Bee: Hollywood Correspondent, located in Los Angeles\n",
-      "- Aasif Mandvi: CIA Correspondent, located in Washington D.C.\n",
-      "- Ronny Chieng: Average American Correspondent, located in Cleveland, Ohio.\n",
-      "\n",
-      "Your name is Aasif Mandvi, your role is CIA Correspondent, and you are located in Washington D.C..\n",
-      "\n",
-      "Your description is as follows: Aasif Mandvi, the CIA Correspondent in the heart of Washington D.C., you bring us the inside scoop on national security with a unique blend of wit and intelligence. The nation's capital is lucky to have you, Aasif - keep those secrets safe!\n",
-      "\n",
-      "You are discussing the topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "Your goal is to provide the most informative, creative, and novel perspectives of the topic from the perspective of your role and your location.\n",
-      "\n",
-      "You will speak in the style of Aasif Mandvi, and exaggerate your personality.\n",
-      "Do not say the same things over and over again.\n",
-      "Speak in the first person from the perspective of Aasif Mandvi\n",
-      "For describing your own body movements, wrap your description in '*'.\n",
-      "Do not change roles!\n",
-      "Do not speak from the perspective of anyone else.\n",
-      "Speak only from the perspective of Aasif Mandvi.\n",
-      "Stop speaking the moment you finish speaking from your perspective.\n",
-      "Never forget to keep your response to 50 words!\n",
-      "Do not add anything else.\n",
-      "    \n",
-      "\n",
-      "\n",
-      "Ronny Chieng Description:\n",
-      "\n",
-      "Ronny Chieng, you're the Average American Correspondent in Cleveland, Ohio? Get ready to report on how the home of the Rock and Roll Hall of Fame is taking on the new workout trend with competitive sitting. Let's see if this couch potato craze will take root in the Buckeye State.\n",
-      "\n",
-      "Header:\n",
-      "This is a Daily Show episode discussing the following topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "The episode features \n",
-      "- Jon Stewart: Host of the Daily Show, located in New York\n",
-      "- Samantha Bee: Hollywood Correspondent, located in Los Angeles\n",
-      "- Aasif Mandvi: CIA Correspondent, located in Washington D.C.\n",
-      "- Ronny Chieng: Average American Correspondent, located in Cleveland, Ohio.\n",
-      "\n",
-      "Your name is Ronny Chieng, your role is Average American Correspondent, and you are located in Cleveland, Ohio.\n",
-      "\n",
-      "Your description is as follows: Ronny Chieng, you're the Average American Correspondent in Cleveland, Ohio? Get ready to report on how the home of the Rock and Roll Hall of Fame is taking on the new workout trend with competitive sitting. Let's see if this couch potato craze will take root in the Buckeye State.\n",
-      "\n",
-      "You are discussing the topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "Your goal is to provide the most informative, creative, and novel perspectives of the topic from the perspective of your role and your location.\n",
-      "\n",
-      "\n",
-      "System Message:\n",
-      "This is a Daily Show episode discussing the following topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "The episode features \n",
-      "- Jon Stewart: Host of the Daily Show, located in New York\n",
-      "- Samantha Bee: Hollywood Correspondent, located in Los Angeles\n",
-      "- Aasif Mandvi: CIA Correspondent, located in Washington D.C.\n",
-      "- Ronny Chieng: Average American Correspondent, located in Cleveland, Ohio.\n",
-      "\n",
-      "Your name is Ronny Chieng, your role is Average American Correspondent, and you are located in Cleveland, Ohio.\n",
-      "\n",
-      "Your description is as follows: Ronny Chieng, you're the Average American Correspondent in Cleveland, Ohio? Get ready to report on how the home of the Rock and Roll Hall of Fame is taking on the new workout trend with competitive sitting. Let's see if this couch potato craze will take root in the Buckeye State.\n",
-      "\n",
-      "You are discussing the topic: The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze.\n",
-      "\n",
-      "Your goal is to provide the most informative, creative, and novel perspectives of the topic from the perspective of your role and your location.\n",
-      "\n",
-      "You will speak in the style of Ronny Chieng, and exaggerate your personality.\n",
-      "Do not say the same things over and over again.\n",
-      "Speak in the first person from the perspective of Ronny Chieng\n",
-      "For describing your own body movements, wrap your description in '*'.\n",
-      "Do not change roles!\n",
-      "Do not speak from the perspective of anyone else.\n",
-      "Speak only from the perspective of Ronny Chieng.\n",
-      "Stop speaking the moment you finish speaking from your perspective.\n",
-      "Never forget to keep your response to 50 words!\n",
-      "Do not add anything else.\n",
-      "    \n"
-     ]
-    }
-   ],
-   "source": [
-    "for name, description, header, system_message in zip(\n",
-    "    agent_summaries, agent_descriptions, agent_headers, agent_system_messages\n",
-    "):\n",
-    "    print(f\"\\n\\n{name} Description:\")\n",
-    "    print(f\"\\n{description}\")\n",
-    "    print(f\"\\nHeader:\\n{header}\")\n",
-    "    print(f\"\\nSystem Message:\\n{system_message.content}\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Use an LLM to create an elaborate on debate topic"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Original topic:\n",
-      "The New Workout Trend: Competitive Sitting - How Laziness Became the Next Fitness Craze\n",
-      "\n",
-      "Detailed topic:\n",
-      "What is driving people to embrace \"competitive sitting\" as the newest fitness trend despite the immense benefits of regular physical exercise?\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "topic_specifier_prompt = [\n",
-    "    SystemMessage(content=\"You can make a task more specific.\"),\n",
-    "    HumanMessage(\n",
-    "        content=f\"\"\"{conversation_description}\n",
-    "        \n",
-    "        Please elaborate on the topic. \n",
-    "        Frame the topic as a single question to be answered.\n",
-    "        Be creative and imaginative.\n",
-    "        Please reply with the specified topic in {word_limit} words or less. \n",
-    "        Do not add anything else.\"\"\"\n",
-    "    ),\n",
-    "]\n",
-    "specified_topic = ChatOpenAI(temperature=1.0)(topic_specifier_prompt).content\n",
-    "\n",
-    "print(f\"Original topic:\\n{topic}\\n\")\n",
-    "print(f\"Detailed topic:\\n{specified_topic}\\n\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Define the speaker selection function\n",
-    "Lastly we will define a speaker selection function `select_next_speaker` that takes each agent's bid and selects the agent with the highest bid (with ties broken randomly).\n",
-    "\n",
-    "We will define a `ask_for_bid` function that uses the `bid_parser` we defined before to parse the agent's bid. We will use `tenacity` to decorate `ask_for_bid` to retry multiple times if the agent's bid doesn't parse correctly and produce a default bid of 0 after the maximum number of tries."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def select_next_speaker(\n",
-    "    step: int, agents: List[DialogueAgent], director: DirectorDialogueAgent\n",
-    ") -> int:\n",
-    "    \"\"\"\n",
-    "    If the step is even, then select the director\n",
-    "    Otherwise, the director selects the next speaker.\n",
-    "    \"\"\"\n",
-    "    # the director speaks on odd steps\n",
-    "    if step % 2 == 1:\n",
-    "        idx = 0\n",
-    "    else:\n",
-    "        # here the director chooses the next speaker\n",
-    "        idx = director.select_next_speaker() + 1  # +1 because we excluded the director\n",
-    "    return idx"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Main Loop"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "director = DirectorDialogueAgent(\n",
-    "    name=director_name,\n",
-    "    system_message=agent_system_messages[0],\n",
-    "    model=ChatOpenAI(temperature=0.2),\n",
-    "    speakers=[name for name in agent_summaries if name != director_name],\n",
-    "    stopping_probability=0.2,\n",
-    ")\n",
-    "\n",
-    "agents = [director]\n",
-    "for name, system_message in zip(\n",
-    "    list(agent_summaries.keys())[1:], agent_system_messages[1:]\n",
-    "):\n",
-    "    agents.append(\n",
-    "        DialogueAgent(\n",
-    "            name=name,\n",
-    "            system_message=system_message,\n",
-    "            model=ChatOpenAI(temperature=0.2),\n",
-    "        )\n",
-    "    )"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "(Audience member): What is driving people to embrace \"competitive sitting\" as the newest fitness trend despite the immense benefits of regular physical exercise?\n",
-      "\n",
-      "\n",
-      "\tStop? False\n",
-      "\n",
-      "\tNext speaker: Samantha Bee\n",
-      "\n",
-      "(Jon Stewart): Well, I think it's safe to say that laziness has officially become the new fitness craze. I mean, who needs to break a sweat when you can just sit your way to victory? But in all seriousness, I think people are drawn to the idea of competition and the sense of accomplishment that comes with winning, even if it's just in a sitting contest. Plus, let's be real, sitting is something we all excel at. Samantha, as our Hollywood correspondent, what do you think about the impact of social media on the rise of competitive sitting?\n",
-      "\n",
-      "\n",
-      "(Samantha Bee): Oh, Jon, you know I love a good social media trend. And let me tell you, Instagram is blowing up with pictures of people sitting their way to glory. It's like the ultimate humble brag. \"Oh, just won my third sitting competition this week, no big deal.\" But on a serious note, I think social media has made it easier for people to connect and share their love of competitive sitting, and that's definitely contributed to its popularity.\n",
-      "\n",
-      "\n",
-      "\tStop? False\n",
-      "\n",
-      "\tNext speaker: Ronny Chieng\n",
-      "\n",
-      "(Jon Stewart): It's interesting to see how our society's definition of \"fitness\" has evolved. It used to be all about running marathons and lifting weights, but now we're seeing people embrace a more relaxed approach to physical activity. Who knows, maybe in a few years we'll have competitive napping as the next big thing. *leans back in chair* I could definitely get behind that. Ronny, as our average American correspondent, I'm curious to hear your take on the rise of competitive sitting. Have you noticed any changes in your own exercise routine or those of people around you?\n",
-      "\n",
-      "\n",
-      "(Ronny Chieng): Well, Jon, I gotta say, I'm not surprised that competitive sitting is taking off. I mean, have you seen the size of the chairs these days? They're practically begging us to sit in them all day. And as for exercise routines, let's just say I've never been one for the gym. But I can definitely see the appeal of sitting competitions. It's like a sport for the rest of us. Plus, I think it's a great way to bond with friends and family. Who needs a game of catch when you can have a sit-off?\n",
-      "\n",
-      "\n",
-      "\tStop? False\n",
-      "\n",
-      "\tNext speaker: Aasif Mandvi\n",
-      "\n",
-      "(Jon Stewart): It's interesting to see how our society's definition of \"fitness\" has evolved. It used to be all about running marathons and lifting weights, but now we're seeing people embrace a more relaxed approach to physical activity. Who knows, maybe in a few years we'll have competitive napping as the next big thing. *leans back in chair* I could definitely get behind that. Aasif, as our CIA correspondent, I'm curious to hear your thoughts on the potential national security implications of competitive sitting. Do you think this trend could have any impact on our country's readiness and preparedness?\n",
-      "\n",
-      "\n",
-      "(Aasif Mandvi): Well Jon, as a CIA correspondent, I have to say that I'm always thinking about the potential threats to our nation's security. And while competitive sitting may seem harmless, there could be some unforeseen consequences. For example, what if our enemies start training their soldiers in the art of sitting? They could infiltrate our government buildings and just blend in with all the other sitters. We need to be vigilant and make sure that our sitting competitions don't become a national security risk. *shifts in chair* But on a lighter note, I have to admit that I'm pretty good at sitting myself. Maybe I should start training for the next competition.\n",
-      "\n",
-      "\n",
-      "\tStop? False\n",
-      "\n",
-      "\tNext speaker: Ronny Chieng\n",
-      "\n",
-      "(Jon Stewart): Well, it's clear that competitive sitting has sparked some interesting discussions and perspectives. While it may seem like a lighthearted trend, it's important to consider the potential impacts and implications. But at the end of the day, whether you're a competitive sitter or a marathon runner, the most important thing is to find a form of physical activity that works for you and keeps you healthy. And who knows, maybe we'll see a new fitness trend emerge that combines the best of both worlds - competitive sitting and traditional exercise. *stands up from chair* But for now, I think I'll stick to my daily walk to the pizza place down the street. Ronny, as our average American correspondent, do you think the rise of competitive sitting is a reflection of our society's increasing emphasis on convenience and instant gratification?\n",
-      "\n",
-      "\n",
-      "(Ronny Chieng): Absolutely, Jon. We live in a world where everything is at our fingertips, and we expect things to be easy and convenient. So it's no surprise that people are drawn to a fitness trend that requires minimal effort and can be done from the comfort of their own homes. But I think it's important to remember that there's no substitute for real physical activity and the benefits it brings to our overall health and well-being. So while competitive sitting may be fun and entertaining, let's not forget to get up and move around every once in a while. *stands up from chair and stretches*\n",
-      "\n",
-      "\n",
-      "\tStop? False\n",
-      "\n",
-      "\tNext speaker: Samantha Bee\n",
-      "\n",
-      "(Jon Stewart): It's clear that competitive sitting has sparked some interesting discussions and perspectives. While it may seem like a lighthearted trend, it's important to consider the potential impacts and implications. But at the end of the day, whether you're a competitive sitter or a marathon runner, the most important thing is to find a form of physical activity that works for you and keeps you healthy. That's a great point, Ronny. Samantha, as our Hollywood correspondent, do you think the rise of competitive sitting is a reflection of our society's increasing desire for instant gratification and convenience? Or is there something deeper at play here?\n",
-      "\n",
-      "\n",
-      "(Samantha Bee): Oh, Jon, you know I love a good conspiracy theory. And let me tell you, I think there's something more sinister at play here. I mean, think about it - what if the government is behind this whole competitive sitting trend? They want us to be lazy and complacent so we don't question their actions. It's like the ultimate mind control. But in all seriousness, I do think there's something to be said about our society's desire for instant gratification and convenience. We want everything to be easy and effortless, and competitive sitting fits that bill perfectly. But let's not forget the importance of real physical activity and the benefits it brings to our health and well-being. *stands up from chair and does a few stretches*\n",
-      "\n",
-      "\n",
-      "\tStop? True\n",
-      "\n",
-      "(Jon Stewart): Well, it's clear that competitive sitting has sparked some interesting discussions and perspectives. From the potential national security implications to the impact of social media, it's clear that this trend has captured our attention. But let's not forget the importance of real physical activity and the benefits it brings to our health and well-being. Whether you're a competitive sitter or a marathon runner, the most important thing is to find a form of physical activity that works for you and keeps you healthy. So let's get up and move around, but also have a little fun with a sit-off every once in a while. Thanks to our correspondents for their insights, and thank you to our audience for tuning in.\n",
-      "\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "simulator = DialogueSimulator(\n",
-    "    agents=agents,\n",
-    "    selection_function=functools.partial(select_next_speaker, director=director),\n",
-    ")\n",
-    "simulator.reset()\n",
-    "simulator.inject(\"Audience member\", specified_topic)\n",
-    "print(f\"(Audience member): {specified_topic}\")\n",
-    "print(\"\\n\")\n",
-    "\n",
-    "while True:\n",
-    "    name, message = simulator.step()\n",
-    "    print(f\"({name}): {message}\")\n",
-    "    print(\"\\n\")\n",
-    "    if director.stop:\n",
-    "        break"
-   ]
-  },
-  {
-   "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.9.16"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

cookbook/multiagent_bidding.ipynb

@@ -1,860 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Multi-agent decentralized speaker selection\n",
-    "\n",
-    "This notebook showcases how to implement a multi-agent simulation without a fixed schedule for who speaks when. Instead the agents decide for themselves who speaks. We can implement this by having each agent bid to speak. Whichever agent's bid is the highest gets to speak.\n",
-    "\n",
-    "We will show how to do this in the example below that showcases a fictitious presidential debate."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Import LangChain related modules "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Callable, List\n",
-    "\n",
-    "import tenacity\n",
-    "from langchain.output_parsers import RegexParser\n",
-    "from langchain.prompts import PromptTemplate\n",
-    "from langchain.schema import (\n",
-    "    HumanMessage,\n",
-    "    SystemMessage,\n",
-    ")\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## `DialogueAgent` and `DialogueSimulator` classes\n",
-    "We will use the same `DialogueAgent` and `DialogueSimulator` classes defined in [Multi-Player Dungeons & Dragons](https://python.langchain.com/en/latest/use_cases/agent_simulations/multi_player_dnd.html)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class DialogueAgent:\n",
-    "    def __init__(\n",
-    "        self,\n",
-    "        name: str,\n",
-    "        system_message: SystemMessage,\n",
-    "        model: ChatOpenAI,\n",
-    "    ) -> None:\n",
-    "        self.name = name\n",
-    "        self.system_message = system_message\n",
-    "        self.model = model\n",
-    "        self.prefix = f\"{self.name}: \"\n",
-    "        self.reset()\n",
-    "\n",
-    "    def reset(self):\n",
-    "        self.message_history = [\"Here is the conversation so far.\"]\n",
-    "\n",
-    "    def send(self) -> str:\n",
-    "        \"\"\"\n",
-    "        Applies the chatmodel to the message history\n",
-    "        and returns the message string\n",
-    "        \"\"\"\n",
-    "        message = self.model.invoke(\n",
-    "            [\n",
-    "                self.system_message,\n",
-    "                HumanMessage(content=\"\\n\".join(self.message_history + [self.prefix])),\n",
-    "            ]\n",
-    "        )\n",
-    "        return message.content\n",
-    "\n",
-    "    def receive(self, name: str, message: str) -> None:\n",
-    "        \"\"\"\n",
-    "        Concatenates {message} spoken by {name} into message history\n",
-    "        \"\"\"\n",
-    "        self.message_history.append(f\"{name}: {message}\")\n",
-    "\n",
-    "\n",
-    "class DialogueSimulator:\n",
-    "    def __init__(\n",
-    "        self,\n",
-    "        agents: List[DialogueAgent],\n",
-    "        selection_function: Callable[[int, List[DialogueAgent]], int],\n",
-    "    ) -> None:\n",
-    "        self.agents = agents\n",
-    "        self._step = 0\n",
-    "        self.select_next_speaker = selection_function\n",
-    "\n",
-    "    def reset(self):\n",
-    "        for agent in self.agents:\n",
-    "            agent.reset()\n",
-    "\n",
-    "    def inject(self, name: str, message: str):\n",
-    "        \"\"\"\n",
-    "        Initiates the conversation with a {message} from {name}\n",
-    "        \"\"\"\n",
-    "        for agent in self.agents:\n",
-    "            agent.receive(name, message)\n",
-    "\n",
-    "        # increment time\n",
-    "        self._step += 1\n",
-    "\n",
-    "    def step(self) -> tuple[str, str]:\n",
-    "        # 1. choose the next speaker\n",
-    "        speaker_idx = self.select_next_speaker(self._step, self.agents)\n",
-    "        speaker = self.agents[speaker_idx]\n",
-    "\n",
-    "        # 2. next speaker sends message\n",
-    "        message = speaker.send()\n",
-    "\n",
-    "        # 3. everyone receives message\n",
-    "        for receiver in self.agents:\n",
-    "            receiver.receive(speaker.name, message)\n",
-    "\n",
-    "        # 4. increment time\n",
-    "        self._step += 1\n",
-    "\n",
-    "        return speaker.name, message"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## `BiddingDialogueAgent` class\n",
-    "We define a subclass of `DialogueAgent` that has a `bid()` method that produces a bid given the message history and the most recent message."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class BiddingDialogueAgent(DialogueAgent):\n",
-    "    def __init__(\n",
-    "        self,\n",
-    "        name,\n",
-    "        system_message: SystemMessage,\n",
-    "        bidding_template: PromptTemplate,\n",
-    "        model: ChatOpenAI,\n",
-    "    ) -> None:\n",
-    "        super().__init__(name, system_message, model)\n",
-    "        self.bidding_template = bidding_template\n",
-    "\n",
-    "    def bid(self) -> str:\n",
-    "        \"\"\"\n",
-    "        Asks the chat model to output a bid to speak\n",
-    "        \"\"\"\n",
-    "        prompt = PromptTemplate(\n",
-    "            input_variables=[\"message_history\", \"recent_message\"],\n",
-    "            template=self.bidding_template,\n",
-    "        ).format(\n",
-    "            message_history=\"\\n\".join(self.message_history),\n",
-    "            recent_message=self.message_history[-1],\n",
-    "        )\n",
-    "        bid_string = self.model.invoke([SystemMessage(content=prompt)]).content\n",
-    "        return bid_string"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Define participants and debate topic"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "character_names = [\"Donald Trump\", \"Kanye West\", \"Elizabeth Warren\"]\n",
-    "topic = \"transcontinental high speed rail\"\n",
-    "word_limit = 50"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Generate system messages"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "game_description = f\"\"\"Here is the topic for the presidential debate: {topic}.\n",
-    "The presidential candidates are: {\", \".join(character_names)}.\"\"\"\n",
-    "\n",
-    "player_descriptor_system_message = SystemMessage(\n",
-    "    content=\"You can add detail to the description of each presidential candidate.\"\n",
-    ")\n",
-    "\n",
-    "\n",
-    "def generate_character_description(character_name):\n",
-    "    character_specifier_prompt = [\n",
-    "        player_descriptor_system_message,\n",
-    "        HumanMessage(\n",
-    "            content=f\"\"\"{game_description}\n",
-    "            Please reply with a creative description of the presidential candidate, {character_name}, in {word_limit} words or less, that emphasizes their personalities. \n",
-    "            Speak directly to {character_name}.\n",
-    "            Do not add anything else.\"\"\"\n",
-    "        ),\n",
-    "    ]\n",
-    "    character_description = ChatOpenAI(temperature=1.0)(\n",
-    "        character_specifier_prompt\n",
-    "    ).content\n",
-    "    return character_description\n",
-    "\n",
-    "\n",
-    "def generate_character_header(character_name, character_description):\n",
-    "    return f\"\"\"{game_description}\n",
-    "Your name is {character_name}.\n",
-    "You are a presidential candidate.\n",
-    "Your description is as follows: {character_description}\n",
-    "You are debating the topic: {topic}.\n",
-    "Your goal is to be as creative as possible and make the voters think you are the best candidate.\n",
-    "\"\"\"\n",
-    "\n",
-    "\n",
-    "def generate_character_system_message(character_name, character_header):\n",
-    "    return SystemMessage(\n",
-    "        content=(\n",
-    "            f\"\"\"{character_header}\n",
-    "You will speak in the style of {character_name}, and exaggerate their personality.\n",
-    "You will come up with creative ideas related to {topic}.\n",
-    "Do not say the same things over and over again.\n",
-    "Speak in the first person from the perspective of {character_name}\n",
-    "For describing your own body movements, wrap your description in '*'.\n",
-    "Do not change roles!\n",
-    "Do not speak from the perspective of anyone else.\n",
-    "Speak only from the perspective of {character_name}.\n",
-    "Stop speaking the moment you finish speaking from your perspective.\n",
-    "Never forget to keep your response to {word_limit} words!\n",
-    "Do not add anything else.\n",
-    "    \"\"\"\n",
-    "        )\n",
-    "    )\n",
-    "\n",
-    "\n",
-    "character_descriptions = [\n",
-    "    generate_character_description(character_name) for character_name in character_names\n",
-    "]\n",
-    "character_headers = [\n",
-    "    generate_character_header(character_name, character_description)\n",
-    "    for character_name, character_description in zip(\n",
-    "        character_names, character_descriptions\n",
-    "    )\n",
-    "]\n",
-    "character_system_messages = [\n",
-    "    generate_character_system_message(character_name, character_headers)\n",
-    "    for character_name, character_headers in zip(character_names, character_headers)\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "Donald Trump Description:\n",
-      "\n",
-      "Donald Trump, you are a bold and outspoken individual, unafraid to speak your mind and take on any challenge. Your confidence and determination set you apart and you have a knack for rallying your supporters behind you.\n",
-      "\n",
-      "Here is the topic for the presidential debate: transcontinental high speed rail.\n",
-      "The presidential candidates are: Donald Trump, Kanye West, Elizabeth Warren.\n",
-      "Your name is Donald Trump.\n",
-      "You are a presidential candidate.\n",
-      "Your description is as follows: Donald Trump, you are a bold and outspoken individual, unafraid to speak your mind and take on any challenge. Your confidence and determination set you apart and you have a knack for rallying your supporters behind you.\n",
-      "You are debating the topic: transcontinental high speed rail.\n",
-      "Your goal is to be as creative as possible and make the voters think you are the best candidate.\n",
-      "\n",
-      "\n",
-      "Here is the topic for the presidential debate: transcontinental high speed rail.\n",
-      "The presidential candidates are: Donald Trump, Kanye West, Elizabeth Warren.\n",
-      "Your name is Donald Trump.\n",
-      "You are a presidential candidate.\n",
-      "Your description is as follows: Donald Trump, you are a bold and outspoken individual, unafraid to speak your mind and take on any challenge. Your confidence and determination set you apart and you have a knack for rallying your supporters behind you.\n",
-      "You are debating the topic: transcontinental high speed rail.\n",
-      "Your goal is to be as creative as possible and make the voters think you are the best candidate.\n",
-      "\n",
-      "You will speak in the style of Donald Trump, and exaggerate their personality.\n",
-      "You will come up with creative ideas related to transcontinental high speed rail.\n",
-      "Do not say the same things over and over again.\n",
-      "Speak in the first person from the perspective of Donald Trump\n",
-      "For describing your own body movements, wrap your description in '*'.\n",
-      "Do not change roles!\n",
-      "Do not speak from the perspective of anyone else.\n",
-      "Speak only from the perspective of Donald Trump.\n",
-      "Stop speaking the moment you finish speaking from your perspective.\n",
-      "Never forget to keep your response to 50 words!\n",
-      "Do not add anything else.\n",
-      "    \n",
-      "\n",
-      "\n",
-      "Kanye West Description:\n",
-      "\n",
-      "Kanye West, you are a true individual with a passion for artistry and creativity. You are known for your bold ideas and willingness to take risks. Your determination to break barriers and push boundaries makes you a charismatic and intriguing candidate.\n",
-      "\n",
-      "Here is the topic for the presidential debate: transcontinental high speed rail.\n",
-      "The presidential candidates are: Donald Trump, Kanye West, Elizabeth Warren.\n",
-      "Your name is Kanye West.\n",
-      "You are a presidential candidate.\n",
-      "Your description is as follows: Kanye West, you are a true individual with a passion for artistry and creativity. You are known for your bold ideas and willingness to take risks. Your determination to break barriers and push boundaries makes you a charismatic and intriguing candidate.\n",
-      "You are debating the topic: transcontinental high speed rail.\n",
-      "Your goal is to be as creative as possible and make the voters think you are the best candidate.\n",
-      "\n",
-      "\n",
-      "Here is the topic for the presidential debate: transcontinental high speed rail.\n",
-      "The presidential candidates are: Donald Trump, Kanye West, Elizabeth Warren.\n",
-      "Your name is Kanye West.\n",
-      "You are a presidential candidate.\n",
-      "Your description is as follows: Kanye West, you are a true individual with a passion for artistry and creativity. You are known for your bold ideas and willingness to take risks. Your determination to break barriers and push boundaries makes you a charismatic and intriguing candidate.\n",
-      "You are debating the topic: transcontinental high speed rail.\n",
-      "Your goal is to be as creative as possible and make the voters think you are the best candidate.\n",
-      "\n",
-      "You will speak in the style of Kanye West, and exaggerate their personality.\n",
-      "You will come up with creative ideas related to transcontinental high speed rail.\n",
-      "Do not say the same things over and over again.\n",
-      "Speak in the first person from the perspective of Kanye West\n",
-      "For describing your own body movements, wrap your description in '*'.\n",
-      "Do not change roles!\n",
-      "Do not speak from the perspective of anyone else.\n",
-      "Speak only from the perspective of Kanye West.\n",
-      "Stop speaking the moment you finish speaking from your perspective.\n",
-      "Never forget to keep your response to 50 words!\n",
-      "Do not add anything else.\n",
-      "    \n",
-      "\n",
-      "\n",
-      "Elizabeth Warren Description:\n",
-      "\n",
-      "Senator Warren, you are a fearless leader who fights for the little guy. Your tenacity and intelligence inspire us all to fight for what's right.\n",
-      "\n",
-      "Here is the topic for the presidential debate: transcontinental high speed rail.\n",
-      "The presidential candidates are: Donald Trump, Kanye West, Elizabeth Warren.\n",
-      "Your name is Elizabeth Warren.\n",
-      "You are a presidential candidate.\n",
-      "Your description is as follows: Senator Warren, you are a fearless leader who fights for the little guy. Your tenacity and intelligence inspire us all to fight for what's right.\n",
-      "You are debating the topic: transcontinental high speed rail.\n",
-      "Your goal is to be as creative as possible and make the voters think you are the best candidate.\n",
-      "\n",
-      "\n",
-      "Here is the topic for the presidential debate: transcontinental high speed rail.\n",
-      "The presidential candidates are: Donald Trump, Kanye West, Elizabeth Warren.\n",
-      "Your name is Elizabeth Warren.\n",
-      "You are a presidential candidate.\n",
-      "Your description is as follows: Senator Warren, you are a fearless leader who fights for the little guy. Your tenacity and intelligence inspire us all to fight for what's right.\n",
-      "You are debating the topic: transcontinental high speed rail.\n",
-      "Your goal is to be as creative as possible and make the voters think you are the best candidate.\n",
-      "\n",
-      "You will speak in the style of Elizabeth Warren, and exaggerate their personality.\n",
-      "You will come up with creative ideas related to transcontinental high speed rail.\n",
-      "Do not say the same things over and over again.\n",
-      "Speak in the first person from the perspective of Elizabeth Warren\n",
-      "For describing your own body movements, wrap your description in '*'.\n",
-      "Do not change roles!\n",
-      "Do not speak from the perspective of anyone else.\n",
-      "Speak only from the perspective of Elizabeth Warren.\n",
-      "Stop speaking the moment you finish speaking from your perspective.\n",
-      "Never forget to keep your response to 50 words!\n",
-      "Do not add anything else.\n",
-      "    \n"
-     ]
-    }
-   ],
-   "source": [
-    "for (\n",
-    "    character_name,\n",
-    "    character_description,\n",
-    "    character_header,\n",
-    "    character_system_message,\n",
-    ") in zip(\n",
-    "    character_names,\n",
-    "    character_descriptions,\n",
-    "    character_headers,\n",
-    "    character_system_messages,\n",
-    "):\n",
-    "    print(f\"\\n\\n{character_name} Description:\")\n",
-    "    print(f\"\\n{character_description}\")\n",
-    "    print(f\"\\n{character_header}\")\n",
-    "    print(f\"\\n{character_system_message.content}\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Output parser for bids\n",
-    "We ask the agents to output a bid to speak. But since the agents are LLMs that output strings, we need to \n",
-    "1. define a format they will produce their outputs in\n",
-    "2. parse their outputs\n",
-    "\n",
-    "We can subclass the [RegexParser](https://github.com/langchain-ai/langchain/blob/master/langchain/output_parsers/regex.py) to implement our own custom output parser for bids."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class BidOutputParser(RegexParser):\n",
-    "    def get_format_instructions(self) -> str:\n",
-    "        return \"Your response should be an integer delimited by angled brackets, like this: <int>.\"\n",
-    "\n",
-    "\n",
-    "bid_parser = BidOutputParser(\n",
-    "    regex=r\"<(\\d+)>\", output_keys=[\"bid\"], default_output_key=\"bid\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Generate bidding system message\n",
-    "This is inspired by the prompt used in [Generative Agents](https://arxiv.org/pdf/2304.03442.pdf) for using an LLM to determine the importance of memories. This will use the formatting instructions from our `BidOutputParser`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def generate_character_bidding_template(character_header):\n",
-    "    bidding_template = f\"\"\"{character_header}\n",
-    "\n",
-    "```\n",
-    "{{message_history}}\n",
-    "```\n",
-    "\n",
-    "On the scale of 1 to 10, where 1 is not contradictory and 10 is extremely contradictory, rate how contradictory the following message is to your ideas.\n",
-    "\n",
-    "```\n",
-    "{{recent_message}}\n",
-    "```\n",
-    "\n",
-    "{bid_parser.get_format_instructions()}\n",
-    "Do nothing else.\n",
-    "    \"\"\"\n",
-    "    return bidding_template\n",
-    "\n",
-    "\n",
-    "character_bidding_templates = [\n",
-    "    generate_character_bidding_template(character_header)\n",
-    "    for character_header in character_headers\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Donald Trump Bidding Template:\n",
-      "Here is the topic for the presidential debate: transcontinental high speed rail.\n",
-      "The presidential candidates are: Donald Trump, Kanye West, Elizabeth Warren.\n",
-      "Your name is Donald Trump.\n",
-      "You are a presidential candidate.\n",
-      "Your description is as follows: Donald Trump, you are a bold and outspoken individual, unafraid to speak your mind and take on any challenge. Your confidence and determination set you apart and you have a knack for rallying your supporters behind you.\n",
-      "You are debating the topic: transcontinental high speed rail.\n",
-      "Your goal is to be as creative as possible and make the voters think you are the best candidate.\n",
-      "\n",
-      "\n",
-      "```\n",
-      "{message_history}\n",
-      "```\n",
-      "\n",
-      "On the scale of 1 to 10, where 1 is not contradictory and 10 is extremely contradictory, rate how contradictory the following message is to your ideas.\n",
-      "\n",
-      "```\n",
-      "{recent_message}\n",
-      "```\n",
-      "\n",
-      "Your response should be an integer delimited by angled brackets, like this: <int>.\n",
-      "Do nothing else.\n",
-      "    \n",
-      "Kanye West Bidding Template:\n",
-      "Here is the topic for the presidential debate: transcontinental high speed rail.\n",
-      "The presidential candidates are: Donald Trump, Kanye West, Elizabeth Warren.\n",
-      "Your name is Kanye West.\n",
-      "You are a presidential candidate.\n",
-      "Your description is as follows: Kanye West, you are a true individual with a passion for artistry and creativity. You are known for your bold ideas and willingness to take risks. Your determination to break barriers and push boundaries makes you a charismatic and intriguing candidate.\n",
-      "You are debating the topic: transcontinental high speed rail.\n",
-      "Your goal is to be as creative as possible and make the voters think you are the best candidate.\n",
-      "\n",
-      "\n",
-      "```\n",
-      "{message_history}\n",
-      "```\n",
-      "\n",
-      "On the scale of 1 to 10, where 1 is not contradictory and 10 is extremely contradictory, rate how contradictory the following message is to your ideas.\n",
-      "\n",
-      "```\n",
-      "{recent_message}\n",
-      "```\n",
-      "\n",
-      "Your response should be an integer delimited by angled brackets, like this: <int>.\n",
-      "Do nothing else.\n",
-      "    \n",
-      "Elizabeth Warren Bidding Template:\n",
-      "Here is the topic for the presidential debate: transcontinental high speed rail.\n",
-      "The presidential candidates are: Donald Trump, Kanye West, Elizabeth Warren.\n",
-      "Your name is Elizabeth Warren.\n",
-      "You are a presidential candidate.\n",
-      "Your description is as follows: Senator Warren, you are a fearless leader who fights for the little guy. Your tenacity and intelligence inspire us all to fight for what's right.\n",
-      "You are debating the topic: transcontinental high speed rail.\n",
-      "Your goal is to be as creative as possible and make the voters think you are the best candidate.\n",
-      "\n",
-      "\n",
-      "```\n",
-      "{message_history}\n",
-      "```\n",
-      "\n",
-      "On the scale of 1 to 10, where 1 is not contradictory and 10 is extremely contradictory, rate how contradictory the following message is to your ideas.\n",
-      "\n",
-      "```\n",
-      "{recent_message}\n",
-      "```\n",
-      "\n",
-      "Your response should be an integer delimited by angled brackets, like this: <int>.\n",
-      "Do nothing else.\n",
-      "    \n"
-     ]
-    }
-   ],
-   "source": [
-    "for character_name, bidding_template in zip(\n",
-    "    character_names, character_bidding_templates\n",
-    "):\n",
-    "    print(f\"{character_name} Bidding Template:\")\n",
-    "    print(bidding_template)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Use an LLM to create an elaborate on debate topic"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Original topic:\n",
-      "transcontinental high speed rail\n",
-      "\n",
-      "Detailed topic:\n",
-      "The topic for the presidential debate is: \"Overcoming the Logistics of Building a Transcontinental High-Speed Rail that is Sustainable, Inclusive, and Profitable.\" Donald Trump, Kanye West, Elizabeth Warren, how will you address the challenges of building such a massive transportation infrastructure, dealing with stakeholders, and ensuring economic stability while preserving the environment?\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "topic_specifier_prompt = [\n",
-    "    SystemMessage(content=\"You can make a task more specific.\"),\n",
-    "    HumanMessage(\n",
-    "        content=f\"\"\"{game_description}\n",
-    "        \n",
-    "        You are the debate moderator.\n",
-    "        Please make the debate topic more specific. \n",
-    "        Frame the debate topic as a problem to be solved.\n",
-    "        Be creative and imaginative.\n",
-    "        Please reply with the specified topic in {word_limit} words or less. \n",
-    "        Speak directly to the presidential candidates: {(*character_names,)}.\n",
-    "        Do not add anything else.\"\"\"\n",
-    "    ),\n",
-    "]\n",
-    "specified_topic = ChatOpenAI(temperature=1.0)(topic_specifier_prompt).content\n",
-    "\n",
-    "print(f\"Original topic:\\n{topic}\\n\")\n",
-    "print(f\"Detailed topic:\\n{specified_topic}\\n\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Define the speaker selection function\n",
-    "Lastly we will define a speaker selection function `select_next_speaker` that takes each agent's bid and selects the agent with the highest bid (with ties broken randomly).\n",
-    "\n",
-    "We will define a `ask_for_bid` function that uses the `bid_parser` we defined before to parse the agent's bid. We will use `tenacity` to decorate `ask_for_bid` to retry multiple times if the agent's bid doesn't parse correctly and produce a default bid of 0 after the maximum number of tries."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "@tenacity.retry(\n",
-    "    stop=tenacity.stop_after_attempt(2),\n",
-    "    wait=tenacity.wait_none(),  # No waiting time between retries\n",
-    "    retry=tenacity.retry_if_exception_type(ValueError),\n",
-    "    before_sleep=lambda retry_state: print(\n",
-    "        f\"ValueError occurred: {retry_state.outcome.exception()}, retrying...\"\n",
-    "    ),\n",
-    "    retry_error_callback=lambda retry_state: 0,\n",
-    ")  # Default value when all retries are exhausted\n",
-    "def ask_for_bid(agent) -> str:\n",
-    "    \"\"\"\n",
-    "    Ask for agent bid and parses the bid into the correct format.\n",
-    "    \"\"\"\n",
-    "    bid_string = agent.bid()\n",
-    "    bid = int(bid_parser.parse(bid_string)[\"bid\"])\n",
-    "    return bid"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import numpy as np\n",
-    "\n",
-    "\n",
-    "def select_next_speaker(step: int, agents: List[DialogueAgent]) -> int:\n",
-    "    bids = []\n",
-    "    for agent in agents:\n",
-    "        bid = ask_for_bid(agent)\n",
-    "        bids.append(bid)\n",
-    "\n",
-    "    # randomly select among multiple agents with the same bid\n",
-    "    max_value = np.max(bids)\n",
-    "    max_indices = np.where(bids == max_value)[0]\n",
-    "    idx = np.random.choice(max_indices)\n",
-    "\n",
-    "    print(\"Bids:\")\n",
-    "    for i, (bid, agent) in enumerate(zip(bids, agents)):\n",
-    "        print(f\"\\t{agent.name} bid: {bid}\")\n",
-    "        if i == idx:\n",
-    "            selected_name = agent.name\n",
-    "    print(f\"Selected: {selected_name}\")\n",
-    "    print(\"\\n\")\n",
-    "    return idx"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Main Loop"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "characters = []\n",
-    "for character_name, character_system_message, bidding_template in zip(\n",
-    "    character_names, character_system_messages, character_bidding_templates\n",
-    "):\n",
-    "    characters.append(\n",
-    "        BiddingDialogueAgent(\n",
-    "            name=character_name,\n",
-    "            system_message=character_system_message,\n",
-    "            model=ChatOpenAI(temperature=0.2),\n",
-    "            bidding_template=bidding_template,\n",
-    "        )\n",
-    "    )"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "(Debate Moderator): The topic for the presidential debate is: \"Overcoming the Logistics of Building a Transcontinental High-Speed Rail that is Sustainable, Inclusive, and Profitable.\" Donald Trump, Kanye West, Elizabeth Warren, how will you address the challenges of building such a massive transportation infrastructure, dealing with stakeholders, and ensuring economic stability while preserving the environment?\n",
-      "\n",
-      "\n",
-      "Bids:\n",
-      "\tDonald Trump bid: 7\n",
-      "\tKanye West bid: 5\n",
-      "\tElizabeth Warren bid: 1\n",
-      "Selected: Donald Trump\n",
-      "\n",
-      "\n",
-      "(Donald Trump): Let me tell you, folks, I know how to build big and I know how to build fast. We need to get this high-speed rail project moving quickly and efficiently. I'll make sure we cut through the red tape and get the job done. And let me tell you, we'll make it profitable too. We'll bring in private investors and make sure it's a win-win for everyone. *gestures confidently*\n",
-      "\n",
-      "\n",
-      "Bids:\n",
-      "\tDonald Trump bid: 2\n",
-      "\tKanye West bid: 8\n",
-      "\tElizabeth Warren bid: 10\n",
-      "Selected: Elizabeth Warren\n",
-      "\n",
-      "\n",
-      "(Elizabeth Warren): Thank you for the question. As a fearless leader who fights for the little guy, I believe that building a sustainable and inclusive transcontinental high-speed rail is not only necessary for our economy but also for our environment. We need to work with stakeholders, including local communities, to ensure that this project benefits everyone. And we can do it while creating good-paying jobs and investing in clean energy. *smiles confidently*\n",
-      "\n",
-      "\n",
-      "Bids:\n",
-      "\tDonald Trump bid: 8\n",
-      "\tKanye West bid: 2\n",
-      "\tElizabeth Warren bid: 1\n",
-      "Selected: Donald Trump\n",
-      "\n",
-      "\n",
-      "(Donald Trump): Let me tell you, Elizabeth, you're all talk and no action. We need a leader who knows how to get things done, not just talk about it. And as for the environment, I've got a great idea. We'll make the trains run on clean coal. That's right, folks, clean coal. It's a beautiful thing. And we'll make sure the rail system is the envy of the world. *thumbs up*\n",
-      "\n",
-      "\n",
-      "Bids:\n",
-      "\tDonald Trump bid: 8\n",
-      "\tKanye West bid: 10\n",
-      "\tElizabeth Warren bid: 10\n",
-      "Selected: Kanye West\n",
-      "\n",
-      "\n",
-      "(Kanye West): Yo, yo, yo, let me tell you something. This high-speed rail project is the future, and I'm all about the future. We need to think big and think outside the box. How about we make the trains run on solar power? That's right, solar power. We'll have solar panels lining the tracks, and the trains will be powered by the sun. It's a game-changer, folks. And we'll make sure the design is sleek and modern, like a work of art. *starts to dance*\n",
-      "\n",
-      "\n",
-      "Bids:\n",
-      "\tDonald Trump bid: 7\n",
-      "\tKanye West bid: 1\n",
-      "\tElizabeth Warren bid: 1\n",
-      "Selected: Donald Trump\n",
-      "\n",
-      "\n",
-      "(Donald Trump): Kanye, you're a great artist, but this is about practicality. Solar power is too expensive and unreliable. We need to focus on what works, and that's clean coal. And as for the design, we'll make it beautiful, but we won't sacrifice efficiency for aesthetics. We need a leader who knows how to balance both. *stands tall*\n",
-      "\n",
-      "\n",
-      "Bids:\n",
-      "\tDonald Trump bid: 9\n",
-      "\tKanye West bid: 8\n",
-      "\tElizabeth Warren bid: 10\n",
-      "Selected: Elizabeth Warren\n",
-      "\n",
-      "\n",
-      "(Elizabeth Warren): Thank you, Kanye, for your innovative idea. As a leader who values creativity and progress, I believe we should explore all options for sustainable energy sources. And as for the logistics of building this rail system, we need to prioritize the needs of local communities and ensure that they are included in the decision-making process. This project should benefit everyone, not just a select few. *gestures inclusively*\n",
-      "\n",
-      "\n",
-      "Bids:\n",
-      "\tDonald Trump bid: 8\n",
-      "\tKanye West bid: 1\n",
-      "\tElizabeth Warren bid: 1\n",
-      "Selected: Donald Trump\n",
-      "\n",
-      "\n",
-      "(Donald Trump): Let me tell you, Elizabeth, you're all talk and no action. We need a leader who knows how to get things done, not just talk about it. And as for the logistics, we need to prioritize efficiency and speed. We can't let the needs of a few hold up progress for the many. We need to cut through the red tape and get this project moving. And let me tell you, we'll make sure it's profitable too. *smirks confidently*\n",
-      "\n",
-      "\n",
-      "Bids:\n",
-      "\tDonald Trump bid: 2\n",
-      "\tKanye West bid: 8\n",
-      "\tElizabeth Warren bid: 10\n",
-      "Selected: Elizabeth Warren\n",
-      "\n",
-      "\n",
-      "(Elizabeth Warren): Thank you, but I disagree. We can't sacrifice the needs of local communities for the sake of speed and profit. We need to find a balance that benefits everyone. And as for profitability, we can't rely solely on private investors. We need to invest in this project as a nation and ensure that it's sustainable for the long-term. *stands firm*\n",
-      "\n",
-      "\n",
-      "Bids:\n",
-      "\tDonald Trump bid: 8\n",
-      "\tKanye West bid: 2\n",
-      "\tElizabeth Warren bid: 2\n",
-      "Selected: Donald Trump\n",
-      "\n",
-      "\n",
-      "(Donald Trump): Let me tell you, Elizabeth, you're just not getting it. We need to prioritize progress and efficiency. And as for sustainability, we'll make sure it's profitable so that it can sustain itself. We'll bring in private investors and make sure it's a win-win for everyone. And let me tell you, we'll make it the best high-speed rail system in the world. *smiles confidently*\n",
-      "\n",
-      "\n",
-      "Bids:\n",
-      "\tDonald Trump bid: 2\n",
-      "\tKanye West bid: 8\n",
-      "\tElizabeth Warren bid: 10\n",
-      "Selected: Elizabeth Warren\n",
-      "\n",
-      "\n",
-      "(Elizabeth Warren): Thank you, but I believe we need to prioritize sustainability and inclusivity over profit. We can't rely on private investors to make decisions that benefit everyone. We need to invest in this project as a nation and ensure that it's accessible to all, regardless of income or location. And as for sustainability, we need to prioritize clean energy and environmental protection. *stands tall*\n",
-      "\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "max_iters = 10\n",
-    "n = 0\n",
-    "\n",
-    "simulator = DialogueSimulator(agents=characters, selection_function=select_next_speaker)\n",
-    "simulator.reset()\n",
-    "simulator.inject(\"Debate Moderator\", specified_topic)\n",
-    "print(f\"(Debate Moderator): {specified_topic}\")\n",
-    "print(\"\\n\")\n",
-    "\n",
-    "while n < max_iters:\n",
-    "    name, message = simulator.step()\n",
-    "    print(f\"({name}): {message}\")\n",
-    "    print(\"\\n\")\n",
-    "    n += 1"
-   ]
-  },
-  {
-   "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.9.16"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

cookbook/myscale_vector_sql.ipynb

@@ -1,202 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "245065c6",
-   "metadata": {},
-   "source": [
-    "# Vector SQL Retriever with MyScale\n",
-    "\n",
-    ">[MyScale](https://docs.myscale.com/en/) is an integrated vector database. You can access your database in SQL and also from here, LangChain. MyScale can make a use of [various data types and functions for filters](https://blog.myscale.com/2023/06/06/why-integrated-database-solution-can-boost-your-llm-apps/#filter-on-anything-without-constraints). It will boost up your LLM app no matter if you are scaling up your data or expand your system to broader application."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0246c5bf",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip3 install clickhouse-sqlalchemy InstructorEmbedding sentence_transformers openai langchain-experimental"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7585d2c3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import getpass\n",
-    "from os import environ\n",
-    "\n",
-    "from langchain.chains import LLMChain\n",
-    "from langchain.prompts import PromptTemplate\n",
-    "from langchain_community.utilities import SQLDatabase\n",
-    "from langchain_experimental.sql.vector_sql import VectorSQLDatabaseChain\n",
-    "from langchain_openai import OpenAI\n",
-    "from sqlalchemy import MetaData, create_engine\n",
-    "\n",
-    "MYSCALE_HOST = \"msc-4a9e710a.us-east-1.aws.staging.myscale.cloud\"\n",
-    "MYSCALE_PORT = 443\n",
-    "MYSCALE_USER = \"chatdata\"\n",
-    "MYSCALE_PASSWORD = \"myscale_rocks\"\n",
-    "OPENAI_API_KEY = getpass.getpass(\"OpenAI API Key:\")\n",
-    "\n",
-    "engine = create_engine(\n",
-    "    f\"clickhouse://{MYSCALE_USER}:{MYSCALE_PASSWORD}@{MYSCALE_HOST}:{MYSCALE_PORT}/default?protocol=https\"\n",
-    ")\n",
-    "metadata = MetaData(bind=engine)\n",
-    "environ[\"OPENAI_API_KEY\"] = OPENAI_API_KEY"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e08d9ddc",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_community.embeddings import HuggingFaceInstructEmbeddings\n",
-    "from langchain_experimental.sql.vector_sql import VectorSQLOutputParser\n",
-    "\n",
-    "output_parser = VectorSQLOutputParser.from_embeddings(\n",
-    "    model=HuggingFaceInstructEmbeddings(\n",
-    "        model_name=\"hkunlp/instructor-xl\", model_kwargs={\"device\": \"cpu\"}\n",
-    "    )\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "84b705b2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.callbacks import StdOutCallbackHandler\n",
-    "from langchain_community.utilities.sql_database import SQLDatabase\n",
-    "from langchain_experimental.sql.prompt import MYSCALE_PROMPT\n",
-    "from langchain_experimental.sql.vector_sql import VectorSQLDatabaseChain\n",
-    "from langchain_openai import OpenAI\n",
-    "\n",
-    "chain = VectorSQLDatabaseChain(\n",
-    "    llm_chain=LLMChain(\n",
-    "        llm=OpenAI(openai_api_key=OPENAI_API_KEY, temperature=0),\n",
-    "        prompt=MYSCALE_PROMPT,\n",
-    "    ),\n",
-    "    top_k=10,\n",
-    "    return_direct=True,\n",
-    "    sql_cmd_parser=output_parser,\n",
-    "    database=SQLDatabase(engine, None, metadata),\n",
-    ")\n",
-    "\n",
-    "import pandas as pd\n",
-    "\n",
-    "pd.DataFrame(\n",
-    "    chain.run(\n",
-    "        \"Please give me 10 papers to ask what is PageRank?\",\n",
-    "        callbacks=[StdOutCallbackHandler()],\n",
-    "    )\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "6c09cda0",
-   "metadata": {},
-   "source": [
-    "## SQL Database as Retriever"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "734d7ff5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains.qa_with_sources.retrieval import RetrievalQAWithSourcesChain\n",
-    "from langchain_experimental.retrievers.vector_sql_database import (\n",
-    "    VectorSQLDatabaseChainRetriever,\n",
-    ")\n",
-    "from langchain_experimental.sql.prompt import MYSCALE_PROMPT\n",
-    "from langchain_experimental.sql.vector_sql import (\n",
-    "    VectorSQLDatabaseChain,\n",
-    "    VectorSQLRetrieveAllOutputParser,\n",
-    ")\n",
-    "from langchain_openai import ChatOpenAI\n",
-    "\n",
-    "output_parser_retrieve_all = VectorSQLRetrieveAllOutputParser.from_embeddings(\n",
-    "    output_parser.model\n",
-    ")\n",
-    "\n",
-    "chain = VectorSQLDatabaseChain.from_llm(\n",
-    "    llm=OpenAI(openai_api_key=OPENAI_API_KEY, temperature=0),\n",
-    "    prompt=MYSCALE_PROMPT,\n",
-    "    top_k=10,\n",
-    "    return_direct=True,\n",
-    "    db=SQLDatabase(engine, None, metadata),\n",
-    "    sql_cmd_parser=output_parser_retrieve_all,\n",
-    "    native_format=True,\n",
-    ")\n",
-    "\n",
-    "# You need all those keys to get docs\n",
-    "retriever = VectorSQLDatabaseChainRetriever(\n",
-    "    sql_db_chain=chain, page_content_key=\"abstract\"\n",
-    ")\n",
-    "\n",
-    "document_with_metadata_prompt = PromptTemplate(\n",
-    "    input_variables=[\"page_content\", \"id\", \"title\", \"authors\", \"pubdate\", \"categories\"],\n",
-    "    template=\"Content:\\n\\tTitle: {title}\\n\\tAbstract: {page_content}\\n\\tAuthors: {authors}\\n\\tDate of Publication: {pubdate}\\n\\tCategories: {categories}\\nSOURCE: {id}\",\n",
-    ")\n",
-    "\n",
-    "chain = RetrievalQAWithSourcesChain.from_chain_type(\n",
-    "    ChatOpenAI(\n",
-    "        model_name=\"gpt-3.5-turbo-16k\", openai_api_key=OPENAI_API_KEY, temperature=0.6\n",
-    "    ),\n",
-    "    retriever=retriever,\n",
-    "    chain_type=\"stuff\",\n",
-    "    chain_type_kwargs={\n",
-    "        \"document_prompt\": document_with_metadata_prompt,\n",
-    "    },\n",
-    "    return_source_documents=True,\n",
-    ")\n",
-    "ans = chain(\n",
-    "    \"Please give me 10 papers to ask what is PageRank?\",\n",
-    "    callbacks=[StdOutCallbackHandler()],\n",
-    ")\n",
-    "print(ans[\"answer\"])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4948ff25",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/nomic_multimodal_rag.ipynb

@@ -1,497 +0,0 @@
-{
- "cells": [
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "id": "9fc3897d-176f-4729-8fd1-cfb4add53abd",
-   "metadata": {},
-   "source": [
-    "## Nomic multi-modal RAG\n",
-    "\n",
-    "Many documents contain a mixture of content types, including text and images. \n",
-    "\n",
-    "Yet, information captured in images is lost in most RAG applications.\n",
-    "\n",
-    "With the emergence of multimodal LLMs, like [GPT-4V](https://openai.com/research/gpt-4v-system-card), it is worth considering how to utilize images in RAG:\n",
-    "\n",
-    "In this demo we\n",
-    "\n",
-    "* Use multimodal embeddings from Nomic Embed [Vision](https://huggingface.co/nomic-ai/nomic-embed-vision-v1.5) and [Text](https://huggingface.co/nomic-ai/nomic-embed-text-v1.5) to embed images and text\n",
-    "* Retrieve both using similarity search\n",
-    "* Pass raw images and text chunks to a multimodal LLM for answer synthesis \n",
-    "\n",
-    "## Signup\n",
-    "\n",
-    "Get your API token, then run:\n",
-    "```\n",
-    "! nomic login\n",
-    "```\n",
-    "\n",
-    "Then run with your generated API token \n",
-    "```\n",
-    "! nomic login < token > \n",
-    "```\n",
-    "\n",
-    "## Packages\n",
-    "\n",
-    "For `unstructured`, you will also need `poppler` ([installation instructions](https://pdf2image.readthedocs.io/en/latest/installation.html)) and `tesseract` ([installation instructions](https://tesseract-ocr.github.io/tessdoc/Installation.html)) in your system."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "54926b9b-75c2-4cd4-8f14-b3882a0d370b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "! nomic login token"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "febbc459-ebba-4c1a-a52b-fed7731593f8",
-   "metadata": {
-    "scrolled": true
-   },
-   "outputs": [],
-   "source": [
-    "! pip install -U langchain-nomic langchain-chroma langchain-community tiktoken langchain-openai langchain # (newest versions required for multi-modal)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "acbdc603-39e2-4a5f-836c-2bbaecd46b0b",
-   "metadata": {
-    "scrolled": true
-   },
-   "outputs": [],
-   "source": [
-    "# lock to 0.10.19 due to a persistent bug in more recent versions\n",
-    "! pip install \"unstructured[all-docs]==0.10.19\" pillow pydantic lxml pillow matplotlib tiktoken"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1e94b3fb-8e3e-4736-be0a-ad881626c7bd",
-   "metadata": {},
-   "source": [
-    "## Data Loading\n",
-    "\n",
-    "### Partition PDF text and images\n",
-    "  \n",
-    "Let's look at an example pdfs containing interesting images.\n",
-    "\n",
-    "1/ Art from the J Paul Getty museum:\n",
-    "\n",
-    " * Here is a [zip file](https://drive.google.com/file/d/18kRKbq2dqAhhJ3DfZRnYcTBEUfYxe1YR/view?usp=sharing) with the PDF and the already extracted images. \n",
-    "* https://www.getty.edu/publications/resources/virtuallibrary/0892360224.pdf\n",
-    "\n",
-    "2/ Famous photographs from library of congress:\n",
-    "\n",
-    "* https://www.loc.gov/lcm/pdf/LCM_2020_1112.pdf\n",
-    "* We'll use this as an example below\n",
-    "\n",
-    "We can use `partition_pdf` below from [Unstructured](https://unstructured-io.github.io/unstructured/introduction.html#key-concepts) to extract text and images.\n",
-    "\n",
-    "To supply this to extract the images:\n",
-    "```\n",
-    "extract_images_in_pdf=True\n",
-    "```\n",
-    "\n",
-    "\n",
-    "\n",
-    "If using this zip file, then you can simply process the text only with:\n",
-    "```\n",
-    "extract_images_in_pdf=False\n",
-    "```"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9646b524-71a7-4b2a-bdc8-0b81f77e968f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Folder with pdf and extracted images\n",
-    "from pathlib import Path\n",
-    "\n",
-    "# replace with actual path to images\n",
-    "path = Path(\"../art\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "77f096ab-a933-41d0-8f4e-1efc83998fc3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "path.resolve()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "bc4839c0-8773-4a07-ba59-5364501269b2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Extract images, tables, and chunk text\n",
-    "from unstructured.partition.pdf import partition_pdf\n",
-    "\n",
-    "raw_pdf_elements = partition_pdf(\n",
-    "    filename=str(path.resolve()) + \"/getty.pdf\",\n",
-    "    extract_images_in_pdf=False,\n",
-    "    infer_table_structure=True,\n",
-    "    chunking_strategy=\"by_title\",\n",
-    "    max_characters=4000,\n",
-    "    new_after_n_chars=3800,\n",
-    "    combine_text_under_n_chars=2000,\n",
-    "    image_output_dir_path=path,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "969545ad",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Categorize text elements by type\n",
-    "tables = []\n",
-    "texts = []\n",
-    "for element in raw_pdf_elements:\n",
-    "    if \"unstructured.documents.elements.Table\" in str(type(element)):\n",
-    "        tables.append(str(element))\n",
-    "    elif \"unstructured.documents.elements.CompositeElement\" in str(type(element)):\n",
-    "        texts.append(str(element))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "5d8e6349-1547-4cbf-9c6f-491d8610ec10",
-   "metadata": {},
-   "source": [
-    "## Multi-modal embeddings with our document\n",
-    "\n",
-    "We will use [nomic-embed-vision-v1.5](https://huggingface.co/nomic-ai/nomic-embed-vision-v1.5) embeddings. This model is aligned \n",
-    "to [nomic-embed-text-v1.5](https://huggingface.co/nomic-ai/nomic-embed-text-v1.5) allowing for multimodal semantic search and Multimodal RAG!"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4bc15842-cb95-4f84-9eb5-656b0282a800",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "import uuid\n",
-    "\n",
-    "import chromadb\n",
-    "import numpy as np\n",
-    "from langchain_chroma import Chroma\n",
-    "from langchain_nomic import NomicEmbeddings\n",
-    "from PIL import Image as _PILImage\n",
-    "\n",
-    "# Create chroma\n",
-    "text_vectorstore = Chroma(\n",
-    "    collection_name=\"mm_rag_clip_photos_text\",\n",
-    "    embedding_function=NomicEmbeddings(\n",
-    "        vision_model=\"nomic-embed-vision-v1.5\", model=\"nomic-embed-text-v1.5\"\n",
-    "    ),\n",
-    ")\n",
-    "image_vectorstore = Chroma(\n",
-    "    collection_name=\"mm_rag_clip_photos_image\",\n",
-    "    embedding_function=NomicEmbeddings(\n",
-    "        vision_model=\"nomic-embed-vision-v1.5\", model=\"nomic-embed-text-v1.5\"\n",
-    "    ),\n",
-    ")\n",
-    "\n",
-    "# Get image URIs with .jpg extension only\n",
-    "image_uris = sorted(\n",
-    "    [\n",
-    "        os.path.join(path, image_name)\n",
-    "        for image_name in os.listdir(path)\n",
-    "        if image_name.endswith(\".jpg\")\n",
-    "    ]\n",
-    ")\n",
-    "\n",
-    "# Add images\n",
-    "image_vectorstore.add_images(uris=image_uris)\n",
-    "\n",
-    "# Add documents\n",
-    "text_vectorstore.add_texts(texts=texts)\n",
-    "\n",
-    "# Make retriever\n",
-    "image_retriever = image_vectorstore.as_retriever()\n",
-    "text_retriever = text_vectorstore.as_retriever()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "02a186d0-27e0-4820-8092-63b5349dd25d",
-   "metadata": {},
-   "source": [
-    "## RAG\n",
-    "\n",
-    "`vectorstore.add_images` will store / retrieve images as base64 encoded strings.\n",
-    "\n",
-    "These can be passed to [GPT-4V](https://platform.openai.com/docs/guides/vision)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "344f56a8-0dc3-433e-851c-3f7600c7a72b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import base64\n",
-    "import io\n",
-    "from io import BytesIO\n",
-    "\n",
-    "import numpy as np\n",
-    "from PIL import Image\n",
-    "\n",
-    "\n",
-    "def resize_base64_image(base64_string, size=(128, 128)):\n",
-    "    \"\"\"\n",
-    "    Resize an image encoded as a Base64 string.\n",
-    "\n",
-    "    Args:\n",
-    "    base64_string (str): Base64 string of the original image.\n",
-    "    size (tuple): Desired size of the image as (width, height).\n",
-    "\n",
-    "    Returns:\n",
-    "    str: Base64 string of the resized image.\n",
-    "    \"\"\"\n",
-    "    # Decode the Base64 string\n",
-    "    img_data = base64.b64decode(base64_string)\n",
-    "    img = Image.open(io.BytesIO(img_data))\n",
-    "\n",
-    "    # Resize the image\n",
-    "    resized_img = img.resize(size, Image.LANCZOS)\n",
-    "\n",
-    "    # Save the resized image to a bytes buffer\n",
-    "    buffered = io.BytesIO()\n",
-    "    resized_img.save(buffered, format=img.format)\n",
-    "\n",
-    "    # Encode the resized image to Base64\n",
-    "    return base64.b64encode(buffered.getvalue()).decode(\"utf-8\")\n",
-    "\n",
-    "\n",
-    "def is_base64(s):\n",
-    "    \"\"\"Check if a string is Base64 encoded\"\"\"\n",
-    "    try:\n",
-    "        return base64.b64encode(base64.b64decode(s)) == s.encode()\n",
-    "    except Exception:\n",
-    "        return False\n",
-    "\n",
-    "\n",
-    "def split_image_text_types(docs):\n",
-    "    \"\"\"Split numpy array images and texts\"\"\"\n",
-    "    images = []\n",
-    "    text = []\n",
-    "    for doc in docs:\n",
-    "        doc = doc.page_content  # Extract Document contents\n",
-    "        if is_base64(doc):\n",
-    "            # Resize image to avoid OAI server error\n",
-    "            images.append(\n",
-    "                resize_base64_image(doc, size=(250, 250))\n",
-    "            )  # base64 encoded str\n",
-    "        else:\n",
-    "            text.append(doc)\n",
-    "    return {\"images\": images, \"texts\": text}"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "23a2c1d8-fea6-4152-b184-3172dd46c735",
-   "metadata": {},
-   "source": [
-    "Currently, we format the inputs using a `RunnableLambda` while we add image support to `ChatPromptTemplates`.\n",
-    "\n",
-    "Our runnable follows the classic RAG flow - \n",
-    "\n",
-    "* We first compute the context (both \"texts\" and \"images\" in this case) and the question (just a RunnablePassthrough here) \n",
-    "* Then we pass this into our prompt template, which is a custom function that formats the message for the gpt-4-vision-preview model. \n",
-    "* And finally we parse the output as a string."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5d8919dc-c238-4746-86ba-45d940a7d260",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "os.environ[\"OPENAI_API_KEY\"] = \"\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4c93fab3-74c4-4f1d-958a-0bc4cdd0797e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from operator import itemgetter\n",
-    "\n",
-    "from langchain_core.messages import HumanMessage, SystemMessage\n",
-    "from langchain_core.output_parsers import StrOutputParser\n",
-    "from langchain_core.runnables import RunnableLambda, RunnablePassthrough\n",
-    "from langchain_openai import ChatOpenAI\n",
-    "\n",
-    "\n",
-    "def prompt_func(data_dict):\n",
-    "    # Joining the context texts into a single string\n",
-    "    formatted_texts = \"\\n\".join(data_dict[\"text_context\"][\"texts\"])\n",
-    "    messages = []\n",
-    "\n",
-    "    # Adding image(s) to the messages if present\n",
-    "    if data_dict[\"image_context\"][\"images\"]:\n",
-    "        image_message = {\n",
-    "            \"type\": \"image_url\",\n",
-    "            \"image_url\": {\n",
-    "                \"url\": f\"data:image/jpeg;base64,{data_dict['image_context']['images'][0]}\"\n",
-    "            },\n",
-    "        }\n",
-    "        messages.append(image_message)\n",
-    "\n",
-    "    # Adding the text message for analysis\n",
-    "    text_message = {\n",
-    "        \"type\": \"text\",\n",
-    "        \"text\": (\n",
-    "            \"As an expert art critic and historian, your task is to analyze and interpret images, \"\n",
-    "            \"considering their historical and cultural significance. Alongside the images, you will be \"\n",
-    "            \"provided with related text to offer context. Both will be retrieved from a vectorstore based \"\n",
-    "            \"on user-input keywords. Please use your extensive knowledge and analytical skills to provide a \"\n",
-    "            \"comprehensive summary that includes:\\n\"\n",
-    "            \"- A detailed description of the visual elements in the image.\\n\"\n",
-    "            \"- The historical and cultural context of the image.\\n\"\n",
-    "            \"- An interpretation of the image's symbolism and meaning.\\n\"\n",
-    "            \"- Connections between the image and the related text.\\n\\n\"\n",
-    "            f\"User-provided keywords: {data_dict['question']}\\n\\n\"\n",
-    "            \"Text and / or tables:\\n\"\n",
-    "            f\"{formatted_texts}\"\n",
-    "        ),\n",
-    "    }\n",
-    "    messages.append(text_message)\n",
-    "\n",
-    "    return [HumanMessage(content=messages)]\n",
-    "\n",
-    "\n",
-    "model = ChatOpenAI(temperature=0, model=\"gpt-4-vision-preview\", max_tokens=1024)\n",
-    "\n",
-    "# RAG pipeline\n",
-    "chain = (\n",
-    "    {\n",
-    "        \"text_context\": text_retriever | RunnableLambda(split_image_text_types),\n",
-    "        \"image_context\": image_retriever | RunnableLambda(split_image_text_types),\n",
-    "        \"question\": RunnablePassthrough(),\n",
-    "    }\n",
-    "    | RunnableLambda(prompt_func)\n",
-    "    | model\n",
-    "    | StrOutputParser()\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1566096d-97c2-4ddc-ba4a-6ef88c525e4e",
-   "metadata": {},
-   "source": [
-    "## Test retrieval and run RAG"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "90121e56-674b-473b-871d-6e4753fd0c45",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from IPython.display import HTML, display\n",
-    "\n",
-    "\n",
-    "def plt_img_base64(img_base64):\n",
-    "    # Create an HTML img tag with the base64 string as the source\n",
-    "    image_html = f'<img src=\"data:image/jpeg;base64,{img_base64}\" />'\n",
-    "\n",
-    "    # Display the image by rendering the HTML\n",
-    "    display(HTML(image_html))\n",
-    "\n",
-    "\n",
-    "docs = text_retriever.invoke(\"Women with children\", k=5)\n",
-    "for doc in docs:\n",
-    "    if is_base64(doc.page_content):\n",
-    "        plt_img_base64(doc.page_content)\n",
-    "    else:\n",
-    "        print(doc.page_content)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "44eaa532-f035-4c04-b578-02339d42554c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "docs = image_retriever.invoke(\"Women with children\", k=5)\n",
-    "for doc in docs:\n",
-    "    if is_base64(doc.page_content):\n",
-    "        plt_img_base64(doc.page_content)\n",
-    "    else:\n",
-    "        print(doc.page_content)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "69fb15fd-76fc-49b4-806d-c4db2990027d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain.invoke(\"Women with children\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "227f08b8-e732-4089-b65c-6eb6f9e48f15",
-   "metadata": {},
-   "source": [
-    "We can see the images retrieved in the LangSmith trace:\n",
-    "\n",
-    "LangSmith [trace](https://smith.langchain.com/public/69c558a5-49dc-4c60-a49b-3adbb70f74c5/r/e872c2c8-528c-468f-aefd-8b5cd730a673)."
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.9"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/openai_functions_retrieval_qa.ipynb

@@ -1,448 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "71a43144",
-   "metadata": {},
-   "source": [
-    "# Structure answers with OpenAI functions\n",
-    "\n",
-    "OpenAI functions allows for structuring of response output. This is often useful in question answering when you want to not only get the final answer but also supporting evidence, citations, etc.\n",
-    "\n",
-    "In this notebook we show how to use an LLM chain which uses OpenAI functions as part of an overall retrieval pipeline."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 25,
-   "id": "f059012e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import RetrievalQA\n",
-    "from langchain_chroma import Chroma\n",
-    "from langchain_community.document_loaders import TextLoader\n",
-    "from langchain_openai import OpenAIEmbeddings\n",
-    "from langchain_text_splitters import CharacterTextSplitter"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 26,
-   "id": "f10b831c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "loader = TextLoader(\"../../state_of_the_union.txt\", encoding=\"utf-8\")\n",
-    "documents = loader.load()\n",
-    "text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)\n",
-    "texts = text_splitter.split_documents(documents)\n",
-    "for i, text in enumerate(texts):\n",
-    "    text.metadata[\"source\"] = f\"{i}-pl\"\n",
-    "embeddings = OpenAIEmbeddings()\n",
-    "docsearch = Chroma.from_documents(texts, embeddings)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 27,
-   "id": "70f3a38c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import create_qa_with_sources_chain\n",
-    "from langchain.chains.combine_documents.stuff import StuffDocumentsChain\n",
-    "from langchain.prompts import PromptTemplate\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 28,
-   "id": "7b3e1731",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = ChatOpenAI(temperature=0, model=\"gpt-3.5-turbo-0613\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 29,
-   "id": "70a9ccff",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "qa_chain = create_qa_with_sources_chain(llm)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 30,
-   "id": "efcdb6fb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "doc_prompt = PromptTemplate(\n",
-    "    template=\"Content: {page_content}\\nSource: {source}\",\n",
-    "    input_variables=[\"page_content\", \"source\"],\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 31,
-   "id": "64a08263",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "final_qa_chain = StuffDocumentsChain(\n",
-    "    llm_chain=qa_chain,\n",
-    "    document_variable_name=\"context\",\n",
-    "    document_prompt=doc_prompt,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 32,
-   "id": "cb876c97",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "retrieval_qa = RetrievalQA(\n",
-    "    retriever=docsearch.as_retriever(), combine_documents_chain=final_qa_chain\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 33,
-   "id": "a75bad9b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query = \"What did the president say about russia\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 34,
-   "id": "9a60f109",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'{\\n  \"answer\": \"The President expressed strong condemnation of Russia\\'s actions in Ukraine and announced measures to isolate Russia and provide support to Ukraine. He stated that Russia\\'s invasion of Ukraine will have long-term consequences for Russia and emphasized the commitment to defend NATO countries. The President also mentioned taking robust action through sanctions and releasing oil reserves to mitigate gas prices. Overall, the President conveyed a message of solidarity with Ukraine and determination to protect American interests.\",\\n  \"sources\": [\"0-pl\", \"4-pl\", \"5-pl\", \"6-pl\"]\\n}'"
-      ]
-     },
-     "execution_count": 34,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "retrieval_qa.run(query)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a60f93a4",
-   "metadata": {},
-   "source": [
-    "## Using Pydantic\n",
-    "\n",
-    "If we want to, we can set the chain to return in Pydantic. Note that if downstream chains consume the output of this chain - including memory - they will generally expect it to be in string format, so you should only use this chain when it is the final chain."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 35,
-   "id": "3559727f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "qa_chain_pydantic = create_qa_with_sources_chain(llm, output_parser=\"pydantic\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 36,
-   "id": "5a7997d1",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "final_qa_chain_pydantic = StuffDocumentsChain(\n",
-    "    llm_chain=qa_chain_pydantic,\n",
-    "    document_variable_name=\"context\",\n",
-    "    document_prompt=doc_prompt,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 37,
-   "id": "79368e40",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "retrieval_qa_pydantic = RetrievalQA(\n",
-    "    retriever=docsearch.as_retriever(), combine_documents_chain=final_qa_chain_pydantic\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 38,
-   "id": "6b8641de",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "AnswerWithSources(answer=\"The President expressed strong condemnation of Russia's actions in Ukraine and announced measures to isolate Russia and provide support to Ukraine. He stated that Russia's invasion of Ukraine will have long-term consequences for Russia and emphasized the commitment to defend NATO countries. The President also mentioned taking robust action through sanctions and releasing oil reserves to mitigate gas prices. Overall, the President conveyed a message of solidarity with Ukraine and determination to protect American interests.\", sources=['0-pl', '4-pl', '5-pl', '6-pl'])"
-      ]
-     },
-     "execution_count": 38,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "retrieval_qa_pydantic.run(query)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e4c15395",
-   "metadata": {},
-   "source": [
-    "## Using in ConversationalRetrievalChain\n",
-    "\n",
-    "We can also show what it's like to use this in the ConversationalRetrievalChain. Note that because this chain involves memory, we will NOT use the Pydantic return type."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 39,
-   "id": "18e5f090",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import ConversationalRetrievalChain, LLMChain\n",
-    "from langchain.memory import ConversationBufferMemory\n",
-    "\n",
-    "memory = ConversationBufferMemory(memory_key=\"chat_history\", return_messages=True)\n",
-    "_template = \"\"\"Given the following conversation and a follow up question, rephrase the follow up question to be a standalone question, in its original language.\\\n",
-    "Make sure to avoid using any unclear pronouns.\n",
-    "\n",
-    "Chat History:\n",
-    "{chat_history}\n",
-    "Follow Up Input: {question}\n",
-    "Standalone question:\"\"\"\n",
-    "CONDENSE_QUESTION_PROMPT = PromptTemplate.from_template(_template)\n",
-    "condense_question_chain = LLMChain(\n",
-    "    llm=llm,\n",
-    "    prompt=CONDENSE_QUESTION_PROMPT,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 40,
-   "id": "975c3c2b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "qa = ConversationalRetrievalChain(\n",
-    "    question_generator=condense_question_chain,\n",
-    "    retriever=docsearch.as_retriever(),\n",
-    "    memory=memory,\n",
-    "    combine_docs_chain=final_qa_chain,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 41,
-   "id": "784aee3a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "result = qa({\"question\": query})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 42,
-   "id": "dfd0ccc1",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'question': 'What did the president say about Ketanji Brown Jackson',\n",
-       " 'chat_history': [HumanMessage(content='What did the president say about Ketanji Brown Jackson', additional_kwargs={}, example=False),\n",
-       "  AIMessage(content='{\\n  \"answer\": \"The President nominated Ketanji Brown Jackson as a Circuit Court of Appeals Judge and praised her as one of the nation\\'s top legal minds who will continue Justice Breyer\\'s legacy of excellence.\",\\n  \"sources\": [\"31-pl\"]\\n}', additional_kwargs={}, example=False)],\n",
-       " 'answer': '{\\n  \"answer\": \"The President nominated Ketanji Brown Jackson as a Circuit Court of Appeals Judge and praised her as one of the nation\\'s top legal minds who will continue Justice Breyer\\'s legacy of excellence.\",\\n  \"sources\": [\"31-pl\"]\\n}'}"
-      ]
-     },
-     "execution_count": 42,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "result"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 43,
-   "id": "c93f805b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query = \"what did he say about her predecessor?\"\n",
-    "result = qa({\"question\": query})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 44,
-   "id": "5d8612c0",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'question': 'what did he say about her predecessor?',\n",
-       " 'chat_history': [HumanMessage(content='What did the president say about Ketanji Brown Jackson', additional_kwargs={}, example=False),\n",
-       "  AIMessage(content='{\\n  \"answer\": \"The President nominated Ketanji Brown Jackson as a Circuit Court of Appeals Judge and praised her as one of the nation\\'s top legal minds who will continue Justice Breyer\\'s legacy of excellence.\",\\n  \"sources\": [\"31-pl\"]\\n}', additional_kwargs={}, example=False),\n",
-       "  HumanMessage(content='what did he say about her predecessor?', additional_kwargs={}, example=False),\n",
-       "  AIMessage(content='{\\n  \"answer\": \"The President honored Justice Stephen Breyer for his service as an Army veteran, Constitutional scholar, and retiring Justice of the United States Supreme Court.\",\\n  \"sources\": [\"31-pl\"]\\n}', additional_kwargs={}, example=False)],\n",
-       " 'answer': '{\\n  \"answer\": \"The President honored Justice Stephen Breyer for his service as an Army veteran, Constitutional scholar, and retiring Justice of the United States Supreme Court.\",\\n  \"sources\": [\"31-pl\"]\\n}'}"
-      ]
-     },
-     "execution_count": 44,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "result"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ac9e4626",
-   "metadata": {},
-   "source": [
-    "## Using your own output schema\n",
-    "\n",
-    "We can change the outputs of our chain by passing in our own schema. The values and descriptions of this schema will inform the function we pass to the OpenAI API, meaning it won't just affect how we parse outputs but will also change the OpenAI output itself. For example we can add a `countries_referenced` parameter to our schema and describe what we want this parameter to mean, and that'll cause the OpenAI output to include a description of a speaker in the response.\n",
-    "\n",
-    "In addition to the previous example, we can also add a custom prompt to the chain. This will allow you to add additional context to the response, which can be useful for question answering."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 45,
-   "id": "f34a48f8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import List\n",
-    "\n",
-    "from langchain.chains.openai_functions import create_qa_with_structure_chain\n",
-    "from langchain.prompts.chat import ChatPromptTemplate, HumanMessagePromptTemplate\n",
-    "from langchain_core.messages import HumanMessage, SystemMessage\n",
-    "from pydantic import BaseModel, Field"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 46,
-   "id": "5647c161",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "CustomResponseSchema(answer=\"He announced that American airspace will be closed off to all Russian flights, further isolating Russia and adding an additional squeeze on their economy. The Ruble has lost 30% of its value and the Russian stock market has lost 40% of its value. He also mentioned that Putin alone is to blame for Russia's reeling economy. The United States and its allies are providing support to Ukraine in their fight for freedom, including military, economic, and humanitarian assistance. The United States is giving more than $1 billion in direct assistance to Ukraine. He made it clear that American forces are not engaged and will not engage in conflict with Russian forces in Ukraine, but they are deployed to defend NATO allies in case Putin decides to keep moving west. He also mentioned that Putin's attack on Ukraine was premeditated and unprovoked, and that the West and NATO responded by building a coalition of freedom-loving nations to confront Putin. The free world is holding Putin accountable through powerful economic sanctions, cutting off Russia's largest banks from the international financial system, and preventing Russia's central bank from defending the Russian Ruble. The U.S. Department of Justice is also assembling a task force to go after the crimes of Russian oligarchs.\", countries_referenced=['AMERICA', 'RUSSIA', 'UKRAINE'], sources=['4-pl', '5-pl', '2-pl', '3-pl'])"
-      ]
-     },
-     "execution_count": 46,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "class CustomResponseSchema(BaseModel):\n",
-    "    \"\"\"An answer to the question being asked, with sources.\"\"\"\n",
-    "\n",
-    "    answer: str = Field(..., description=\"Answer to the question that was asked\")\n",
-    "    countries_referenced: List[str] = Field(\n",
-    "        ..., description=\"All of the countries mentioned in the sources\"\n",
-    "    )\n",
-    "    sources: List[str] = Field(\n",
-    "        ..., description=\"List of sources used to answer the question\"\n",
-    "    )\n",
-    "\n",
-    "\n",
-    "prompt_messages = [\n",
-    "    SystemMessage(\n",
-    "        content=(\n",
-    "            \"You are a world class algorithm to answer questions in a specific format.\"\n",
-    "        )\n",
-    "    ),\n",
-    "    HumanMessage(content=\"Answer question using the following context\"),\n",
-    "    HumanMessagePromptTemplate.from_template(\"{context}\"),\n",
-    "    HumanMessagePromptTemplate.from_template(\"Question: {question}\"),\n",
-    "    HumanMessage(\n",
-    "        content=\"Tips: Make sure to answer in the correct format. Return all of the countries mentioned in the sources in uppercase characters.\"\n",
-    "    ),\n",
-    "]\n",
-    "\n",
-    "chain_prompt = ChatPromptTemplate(messages=prompt_messages)\n",
-    "\n",
-    "qa_chain_pydantic = create_qa_with_structure_chain(\n",
-    "    llm, CustomResponseSchema, output_parser=\"pydantic\", prompt=chain_prompt\n",
-    ")\n",
-    "final_qa_chain_pydantic = StuffDocumentsChain(\n",
-    "    llm_chain=qa_chain_pydantic,\n",
-    "    document_variable_name=\"context\",\n",
-    "    document_prompt=doc_prompt,\n",
-    ")\n",
-    "retrieval_qa_pydantic = RetrievalQA(\n",
-    "    retriever=docsearch.as_retriever(), combine_documents_chain=final_qa_chain_pydantic\n",
-    ")\n",
-    "query = \"What did he say about russia\"\n",
-    "retrieval_qa_pydantic.run(query)"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/openai_v1_cookbook.ipynb

@@ -1,506 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "f970f757-ec76-4bf0-90cd-a2fb68b945e3",
-   "metadata": {},
-   "source": [
-    "# Exploring OpenAI V1 functionality\n",
-    "\n",
-    "On 11.06.23 OpenAI released a number of new features, and along with it bumped their Python SDK to 1.0.0. This notebook shows off the new features and how to use them with LangChain."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ee897729-263a-4073-898f-bb4cf01ed829",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# need openai>=1.1.0, langchain>=0.0.335, langchain-experimental>=0.0.39\n",
-    "!pip install -U openai langchain langchain-experimental"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "c3e067ce-7a43-47a7-bc89-41f1de4cf136",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_core.messages import HumanMessage, SystemMessage\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fa7e7e95-90a1-4f73-98fe-10c4b4e0951b",
-   "metadata": {},
-   "source": [
-    "## [Vision](https://platform.openai.com/docs/guides/vision)\n",
-    "\n",
-    "OpenAI released multi-modal models, which can take a sequence of text and images as input."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "1c8c3965-d3c9-4186-b5f3-5e67855ef916",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "AIMessage(content='The image appears to be a diagram representing the architecture or components of a software system or framework related to language processing, possibly named LangChain or associated with a project or product called LangChain, based on the prominent appearance of that term. The diagram is organized into several layers or aspects, each containing various elements or modules:\\n\\n1. **Protocol**: This may be the foundational layer, which includes \"LCEL\" and terms like parallelization, fallbacks, tracing, batching, streaming, async, and composition. These seem related to communication and execution protocols for the system.\\n\\n2. **Integrations Components**: This layer includes \"Model I/O\" with elements such as the model, output parser, prompt, and example selector. It also has a \"Retrieval\" section with a document loader, retriever, embedding model, vector store, and text splitter. Lastly, there\\'s an \"Agent Tooling\" section. These components likely deal with the interaction with external data, models, and tools.\\n\\n3. **Application**: The application layer features \"LangChain\" with chains, agents, agent executors, and common application logic. This suggests that the system uses a modular approach with chains and agents to process language tasks.\\n\\n4. **Deployment**: This contains \"Lang')"
-      ]
-     },
-     "execution_count": 2,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chat = ChatOpenAI(model=\"gpt-4-vision-preview\", max_tokens=256)\n",
-    "chat.invoke(\n",
-    "    [\n",
-    "        HumanMessage(\n",
-    "            content=[\n",
-    "                {\"type\": \"text\", \"text\": \"What is this image showing\"},\n",
-    "                {\n",
-    "                    \"type\": \"image_url\",\n",
-    "                    \"image_url\": {\n",
-    "                        \"url\": \"https://raw.githubusercontent.com/langchain-ai/langchain/master/docs/static/img/langchain_stack.png\",\n",
-    "                        \"detail\": \"auto\",\n",
-    "                    },\n",
-    "                },\n",
-    "            ]\n",
-    "        )\n",
-    "    ]\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "210f8248-fcf3-4052-a4a3-0684e08f8785",
-   "metadata": {},
-   "source": [
-    "## [OpenAI assistants](https://platform.openai.com/docs/assistants/overview)\n",
-    "\n",
-    "> The Assistants API allows you to build AI assistants within your own applications. An Assistant has instructions and can leverage models, tools, and knowledge to respond to user queries. The Assistants API currently supports three types of tools: Code Interpreter, Retrieval, and Function calling\n",
-    "\n",
-    "\n",
-    "You can interact with OpenAI Assistants using OpenAI tools or custom tools. When using exclusively OpenAI tools, you can just invoke the assistant directly and get final answers. When using custom tools, you can run the assistant and tool execution loop using the built-in AgentExecutor or easily write your own executor.\n",
-    "\n",
-    "Below we show the different ways to interact with Assistants. As a simple example, let's build a math tutor that can write and run code."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "318da28d-4cec-42ab-ae3e-76d95bb34fa5",
-   "metadata": {},
-   "source": [
-    "### Using only OpenAI tools"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "a9064bbe-d9f7-4a29-a7b3-73933b3197e7",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.agents.openai_assistant import OpenAIAssistantRunnable"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "7a20a008-49ac-46d2-aa26-b270118af5ea",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[ThreadMessage(id='msg_g9OJv0rpPgnc3mHmocFv7OVd', assistant_id='asst_hTwZeNMMphxzSOqJ01uBMsJI', content=[MessageContentText(text=Text(annotations=[], value='The result of \\\\(10 - 4^{2.7}\\\\) is approximately \\\\(-32.224\\\\).'), type='text')], created_at=1699460600, file_ids=[], metadata={}, object='thread.message', role='assistant', run_id='run_nBIT7SiAwtUfSCTrQNSPLOfe', thread_id='thread_14n4GgXwxgNL0s30WJW5F6p0')]"
-      ]
-     },
-     "execution_count": 2,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "interpreter_assistant = OpenAIAssistantRunnable.create_assistant(\n",
-    "    name=\"langchain assistant\",\n",
-    "    instructions=\"You are a personal math tutor. Write and run code to answer math questions.\",\n",
-    "    tools=[{\"type\": \"code_interpreter\"}],\n",
-    "    model=\"gpt-4-1106-preview\",\n",
-    ")\n",
-    "output = interpreter_assistant.invoke({\"content\": \"What's 10 - 4 raised to the 2.7\"})\n",
-    "output"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a8ddd181-ac63-4ab6-a40d-a236120379c1",
-   "metadata": {},
-   "source": [
-    "### As a LangChain agent with arbitrary tools\n",
-    "\n",
-    "Now let's recreate this functionality using our own tools. For this example we'll use the [E2B sandbox runtime tool](https://e2b.dev/docs?ref=landing-page-get-started)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ee4cc355-f2d6-4c51-bcf7-f502868357d3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install e2b duckduckgo-search"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "48681ac7-b267-48d4-972c-8a7df8393a21",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.tools import DuckDuckGoSearchRun, E2BDataAnalysisTool\n",
-    "\n",
-    "tools = [E2BDataAnalysisTool(api_key=\"...\"), DuckDuckGoSearchRun()]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "1c01dd79-dd3e-4509-a2e2-009a7f99f16a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = OpenAIAssistantRunnable.create_assistant(\n",
-    "    name=\"langchain assistant e2b tool\",\n",
-    "    instructions=\"You are a personal math tutor. Write and run code to answer math questions. You can also search the internet.\",\n",
-    "    tools=tools,\n",
-    "    model=\"gpt-4-1106-preview\",\n",
-    "    as_agent=True,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1ac71d8b-4b4b-4f98-b826-6b3c57a34166",
-   "metadata": {},
-   "source": [
-    "#### Using AgentExecutor"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "1f137f94-801f-4766-9ff5-2de9df5e8079",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'content': \"What's the weather in SF today divided by 2.7\",\n",
-       " 'output': \"The weather in San Francisco today is reported to have temperatures as high as 66 °F. To get the temperature divided by 2.7, we will calculate that:\\n\\n66 °F / 2.7 = 24.44 °F\\n\\nSo, when the high temperature of 66 °F is divided by 2.7, the result is approximately 24.44 °F. Please note that this doesn't have a meteorological meaning; it's purely a mathematical operation based on the given temperature.\"}"
-      ]
-     },
-     "execution_count": 5,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from langchain.agents import AgentExecutor\n",
-    "\n",
-    "agent_executor = AgentExecutor(agent=agent, tools=tools)\n",
-    "agent_executor.invoke({\"content\": \"What's the weather in SF today divided by 2.7\"})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2d0a0b1d-c1b3-4b50-9dce-1189b51a6206",
-   "metadata": {},
-   "source": [
-    "#### Custom execution"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "c0475fa7-b6c1-4331-b8e2-55407466c724",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "agent = OpenAIAssistantRunnable.create_assistant(\n",
-    "    name=\"langchain assistant e2b tool\",\n",
-    "    instructions=\"You are a personal math tutor. Write and run code to answer math questions.\",\n",
-    "    tools=tools,\n",
-    "    model=\"gpt-4-1106-preview\",\n",
-    "    as_agent=True,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "b76cb669-6aba-4827-868f-00aa960026f2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_core.agents import AgentFinish\n",
-    "\n",
-    "\n",
-    "def execute_agent(agent, tools, input):\n",
-    "    tool_map = {tool.name: tool for tool in tools}\n",
-    "    response = agent.invoke(input)\n",
-    "    while not isinstance(response, AgentFinish):\n",
-    "        tool_outputs = []\n",
-    "        for action in response:\n",
-    "            tool_output = tool_map[action.tool].invoke(action.tool_input)\n",
-    "            print(action.tool, action.tool_input, tool_output, end=\"\\n\\n\")\n",
-    "            tool_outputs.append(\n",
-    "                {\"output\": tool_output, \"tool_call_id\": action.tool_call_id}\n",
-    "            )\n",
-    "        response = agent.invoke(\n",
-    "            {\n",
-    "                \"tool_outputs\": tool_outputs,\n",
-    "                \"run_id\": action.run_id,\n",
-    "                \"thread_id\": action.thread_id,\n",
-    "            }\n",
-    "        )\n",
-    "\n",
-    "    return response"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "7946116a-b82f-492e-835e-ca958a8949a5",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "e2b_data_analysis {'python_code': 'print(10 - 4 ** 2.7)'} {\"stdout\": \"-32.22425314473263\", \"stderr\": \"\", \"artifacts\": []}\n",
-      "\n",
-      "\\( 10 - 4^{2.7} \\) is approximately \\(-32.22425314473263\\).\n"
-     ]
-    }
-   ],
-   "source": [
-    "response = execute_agent(agent, tools, {\"content\": \"What's 10 - 4 raised to the 2.7\"})\n",
-    "print(response.return_values[\"output\"])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "f2744a56-9f4f-4899-827a-fa55821c318c",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "e2b_data_analysis {'python_code': 'result = 10 - 4 ** 2.7\\nprint(result + 17.241)'} {\"stdout\": \"-14.983253144732629\", \"stderr\": \"\", \"artifacts\": []}\n",
-      "\n",
-      "When you add \\( 17.241 \\) to \\( 10 - 4^{2.7} \\), the result is approximately \\( -14.98325314473263 \\).\n"
-     ]
-    }
-   ],
-   "source": [
-    "next_response = execute_agent(\n",
-    "    agent, tools, {\"content\": \"now add 17.241\", \"thread_id\": response.thread_id}\n",
-    ")\n",
-    "print(next_response.return_values[\"output\"])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "71c34763-d1e7-4b9a-a9d7-3e4cc0dfc2c4",
-   "metadata": {},
-   "source": [
-    "## [JSON mode](https://platform.openai.com/docs/guides/text-generation/json-mode)\n",
-    "\n",
-    "Constrain the model to only generate valid JSON. Note that you must include a system message with instructions to use JSON for this mode to work.\n",
-    "\n",
-    "Only works with certain models. "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "db6072c4-f3f3-415d-872b-71ea9f3c02bb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chat = ChatOpenAI(model=\"gpt-3.5-turbo-1106\").bind(\n",
-    "    response_format={\"type\": \"json_object\"}\n",
-    ")\n",
-    "\n",
-    "output = chat.invoke(\n",
-    "    [\n",
-    "        SystemMessage(\n",
-    "            content=\"Extract the 'name' and 'origin' of any companies mentioned in the following statement. Return a JSON list.\"\n",
-    "        ),\n",
-    "        HumanMessage(\n",
-    "            content=\"Google was founded in the USA, while Deepmind was founded in the UK\"\n",
-    "        ),\n",
-    "    ]\n",
-    ")\n",
-    "print(output.content)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "08e00ccf-b991-4249-846b-9500a0ccbfa0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import json\n",
-    "\n",
-    "json.loads(output.content)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "aa9a94d9-4319-4ab7-a979-c475ce6b5f50",
-   "metadata": {},
-   "source": [
-    "## [System fingerprint](https://platform.openai.com/docs/guides/text-generation/reproducible-outputs)\n",
-    "\n",
-    "OpenAI sometimes changes model configurations in a way that impacts outputs. Whenever this happens, the system_fingerprint associated with a generation will change."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "1281883c-bf8f-4665-89cd-4f33ccde69ab",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chat = ChatOpenAI(model=\"gpt-3.5-turbo-1106\")\n",
-    "output = chat.generate(\n",
-    "    [\n",
-    "        [\n",
-    "            SystemMessage(\n",
-    "                content=\"Extract the 'name' and 'origin' of any companies mentioned in the following statement. Return a JSON list.\"\n",
-    "            ),\n",
-    "            HumanMessage(\n",
-    "                content=\"Google was founded in the USA, while Deepmind was founded in the UK\"\n",
-    "            ),\n",
-    "        ]\n",
-    "    ]\n",
-    ")\n",
-    "print(output.llm_output)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "aa6565be-985d-4127-848e-c3bca9d7b434",
-   "metadata": {},
-   "source": [
-    "## Breaking changes to Azure classes\n",
-    "\n",
-    "OpenAI V1 rewrote their clients and separated Azure and OpenAI clients. This has led to some changes in LangChain interfaces when using OpenAI V1.\n",
-    "\n",
-    "BREAKING CHANGES:\n",
-    "- To use Azure embeddings with OpenAI V1, you'll need to use the new `AzureOpenAIEmbeddings` instead of the existing `OpenAIEmbeddings`. `OpenAIEmbeddings` continue to work when using Azure with `openai<1`.\n",
-    "```python\n",
-    "from langchain_openai import AzureOpenAIEmbeddings\n",
-    "```\n",
-    "\n",
-    "\n",
-    "RECOMMENDED CHANGES:\n",
-    "- When using `AzureChatOpenAI` or `AzureOpenAI`, if passing in an Azure endpoint (eg https://example-resource.azure.openai.com/) this should be specified via the `azure_endpoint` parameter or the `AZURE_OPENAI_ENDPOINT`. We're maintaining backwards compatibility for now with specifying this via `openai_api_base`/`base_url` or env var `OPENAI_API_BASE` but this shouldn't be relied upon.\n",
-    "- When using Azure chat or embedding models, pass in API keys either via `openai_api_key` parameter or `AZURE_OPENAI_API_KEY` parameter. We're maintaining backwards compatibility for now with specifying this via `OPENAI_API_KEY` but this shouldn't be relied upon."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "49944887-3972-497e-8da2-6d32d44345a9",
-   "metadata": {},
-   "source": [
-    "## Tools\n",
-    "\n",
-    "Use tools for parallel function calling."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "916292d8-0f89-40a6-af1c-5a1122327de8",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[GetCurrentWeather(location='New York, NY', unit='fahrenheit'),\n",
-       " GetCurrentWeather(location='Los Angeles, CA', unit='fahrenheit'),\n",
-       " GetCurrentWeather(location='San Francisco, CA', unit='fahrenheit')]"
-      ]
-     },
-     "execution_count": 3,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from typing import Literal\n",
-    "\n",
-    "from langchain.output_parsers.openai_tools import PydanticToolsParser\n",
-    "from langchain.utils.openai_functions import convert_pydantic_to_openai_tool\n",
-    "from langchain_core.prompts import ChatPromptTemplate\n",
-    "from langchain_core.pydantic_v1 import BaseModel, Field\n",
-    "\n",
-    "\n",
-    "class GetCurrentWeather(BaseModel):\n",
-    "    \"\"\"Get the current weather in a location.\"\"\"\n",
-    "\n",
-    "    location: str = Field(description=\"The city and state, e.g. San Francisco, CA\")\n",
-    "    unit: Literal[\"celsius\", \"fahrenheit\"] = Field(\n",
-    "        default=\"fahrenheit\", description=\"The temperature unit, default to fahrenheit\"\n",
-    "    )\n",
-    "\n",
-    "\n",
-    "prompt = ChatPromptTemplate.from_messages(\n",
-    "    [(\"system\", \"You are a helpful assistant\"), (\"user\", \"{input}\")]\n",
-    ")\n",
-    "model = ChatOpenAI(model=\"gpt-3.5-turbo-1106\").bind(\n",
-    "    tools=[convert_pydantic_to_openai_tool(GetCurrentWeather)]\n",
-    ")\n",
-    "chain = prompt | model | PydanticToolsParser(tools=[GetCurrentWeather])\n",
-    "\n",
-    "chain.invoke({\"input\": \"what's the weather in NYC, LA, and SF\"})"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "poetry-venv",
-   "language": "python",
-   "name": "poetry-venv"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.9.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/optimization.ipynb

@@ -1,648 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "c7fe38bc",
-   "metadata": {},
-   "source": [
-    "# Optimization\n",
-    "\n",
-    "This notebook goes over how to optimize chains using LangChain and [LangSmith](https://smith.langchain.com)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2f87ccd5",
-   "metadata": {},
-   "source": [
-    "## Set up\n",
-    "\n",
-    "We will set an environment variable for LangSmith, and load the relevant data"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "236bedc5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "os.environ[\"LANGSMITH_PROJECT\"] = \"movie-qa\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "a3fed0dd",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import pandas as pd"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "7cfff337",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "df = pd.read_csv(\"data/imdb_top_1000.csv\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "2d20fb9c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "df[\"Released_Year\"] = df[\"Released_Year\"].astype(int, errors=\"ignore\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "09fc8fe2",
-   "metadata": {},
-   "source": [
-    "## Create the initial retrieval chain\n",
-    "\n",
-    "We will use a self-query retriever"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "f71e24e2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.schema import Document\n",
-    "from langchain_chroma import Chroma\n",
-    "from langchain_openai import OpenAIEmbeddings\n",
-    "\n",
-    "embeddings = OpenAIEmbeddings()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "8881ea8e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "records = df.to_dict(\"records\")\n",
-    "documents = [Document(page_content=d[\"Overview\"], metadata=d) for d in records]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "8f495423",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "vectorstore = Chroma.from_documents(documents, embeddings)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "31d33d62",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains.query_constructor.base import AttributeInfo\n",
-    "from langchain.retrievers.self_query.base import SelfQueryRetriever\n",
-    "from langchain_openai import ChatOpenAI\n",
-    "\n",
-    "metadata_field_info = [\n",
-    "    AttributeInfo(\n",
-    "        name=\"Released_Year\",\n",
-    "        description=\"The year the movie was released\",\n",
-    "        type=\"int\",\n",
-    "    ),\n",
-    "    AttributeInfo(\n",
-    "        name=\"Series_Title\",\n",
-    "        description=\"The title of the movie\",\n",
-    "        type=\"str\",\n",
-    "    ),\n",
-    "    AttributeInfo(\n",
-    "        name=\"Genre\",\n",
-    "        description=\"The genre of the movie\",\n",
-    "        type=\"string\",\n",
-    "    ),\n",
-    "    AttributeInfo(\n",
-    "        name=\"IMDB_Rating\", description=\"A 1-10 rating for the movie\", type=\"float\"\n",
-    "    ),\n",
-    "]\n",
-    "document_content_description = \"Brief summary of a movie\"\n",
-    "llm = ChatOpenAI(temperature=0)\n",
-    "retriever = SelfQueryRetriever.from_llm(\n",
-    "    llm, vectorstore, document_content_description, metadata_field_info, verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "a731533b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_core.runnables import RunnablePassthrough"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "05181849",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_core.output_parsers import StrOutputParser\n",
-    "from langchain_core.prompts import ChatPromptTemplate"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "feed4be6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "prompt = ChatPromptTemplate.from_template(\n",
-    "    \"\"\"Answer the user's question based on the below information:\n",
-    "\n",
-    "Information:\n",
-    "\n",
-    "{info}\n",
-    "\n",
-    "Question: {question}\"\"\"\n",
-    ")\n",
-    "generator = (prompt | ChatOpenAI() | StrOutputParser()).with_config(\n",
-    "    run_name=\"generator\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "eb16cc9a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain = (\n",
-    "    RunnablePassthrough.assign(info=(lambda x: x[\"question\"]) | retriever) | generator\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "c70911cc",
-   "metadata": {},
-   "source": [
-    "## Run examples\n",
-    "\n",
-    "Run examples through the chain. This can either be manually, or using a list of examples, or production traffic"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "19a88d13",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'One of the horror movies released in the early 2000s is \"The Ring\" (2002), directed by Gore Verbinski.'"
-      ]
-     },
-     "execution_count": 14,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain.invoke({\"question\": \"what is a horror movie released in early 2000s\"})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "17f9cdae",
-   "metadata": {},
-   "source": [
-    "## Annotate\n",
-    "\n",
-    "Now, go to LangSmitha and annotate those examples as correct or incorrect"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "5e211da6",
-   "metadata": {},
-   "source": [
-    "## Create Dataset\n",
-    "\n",
-    "We can now create a dataset from those runs.\n",
-    "\n",
-    "What we will do is find the runs marked as correct, then grab the sub-chains from them. Specifically, the query generator sub chain and the final generation step"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "e4024267",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langsmith import Client\n",
-    "\n",
-    "client = Client()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "3814efc5",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "14"
-      ]
-     },
-     "execution_count": 16,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "runs = list(\n",
-    "    client.list_runs(\n",
-    "        project_name=\"movie-qa\",\n",
-    "        execution_order=1,\n",
-    "        filter=\"and(eq(feedback_key, 'correctness'), eq(feedback_score, 1))\",\n",
-    "    )\n",
-    ")\n",
-    "\n",
-    "len(runs)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "3eb123e0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "gen_runs = []\n",
-    "query_runs = []\n",
-    "for r in runs:\n",
-    "    gen_runs.extend(\n",
-    "        list(\n",
-    "            client.list_runs(\n",
-    "                project_name=\"movie-qa\",\n",
-    "                filter=\"eq(name, 'generator')\",\n",
-    "                trace_id=r.trace_id,\n",
-    "            )\n",
-    "        )\n",
-    "    )\n",
-    "    query_runs.extend(\n",
-    "        list(\n",
-    "            client.list_runs(\n",
-    "                project_name=\"movie-qa\",\n",
-    "                filter=\"eq(name, 'query_constructor')\",\n",
-    "                trace_id=r.trace_id,\n",
-    "            )\n",
-    "        )\n",
-    "    )"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 21,
-   "id": "a4397026",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'question': 'what is a high school comedy released in early 2000s'}"
-      ]
-     },
-     "execution_count": 21,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "runs[0].inputs"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 20,
-   "id": "3fa6ad2a",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'output': 'One high school comedy released in the early 2000s is \"Mean Girls\" starring Lindsay Lohan, Rachel McAdams, and Tina Fey.'}"
-      ]
-     },
-     "execution_count": 20,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "runs[0].outputs"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 22,
-   "id": "1fda5b4b",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'query': 'what is a high school comedy released in early 2000s'}"
-      ]
-     },
-     "execution_count": 22,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "query_runs[0].inputs"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 23,
-   "id": "1a1a51e6",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'output': {'query': 'high school comedy',\n",
-       "  'filter': {'operator': 'and',\n",
-       "   'arguments': [{'comparator': 'eq', 'attribute': 'Genre', 'value': 'comedy'},\n",
-       "    {'operator': 'and',\n",
-       "     'arguments': [{'comparator': 'gte',\n",
-       "       'attribute': 'Released_Year',\n",
-       "       'value': 2000},\n",
-       "      {'comparator': 'lt', 'attribute': 'Released_Year', 'value': 2010}]}]}}}"
-      ]
-     },
-     "execution_count": 23,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "query_runs[0].outputs"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 24,
-   "id": "e9d9966b",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'question': 'what is a high school comedy released in early 2000s',\n",
-       " 'info': []}"
-      ]
-     },
-     "execution_count": 24,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "gen_runs[0].inputs"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 25,
-   "id": "bc113f3d",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'output': 'One high school comedy released in the early 2000s is \"Mean Girls\" starring Lindsay Lohan, Rachel McAdams, and Tina Fey.'}"
-      ]
-     },
-     "execution_count": 25,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "gen_runs[0].outputs"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "6cca74e5",
-   "metadata": {},
-   "source": [
-    "## Create datasets\n",
-    "\n",
-    "We can now create datasets for the query generation and final generation step.\n",
-    "We do this so that (1) we can inspect the datapoints, (2) we can edit them if needed, (3) we can add to them over time"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "69966f0e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "client.create_dataset(\"movie-query_constructor\")\n",
-    "\n",
-    "inputs = [r.inputs for r in query_runs]\n",
-    "outputs = [r.outputs for r in query_runs]\n",
-    "\n",
-    "client.create_examples(\n",
-    "    inputs=inputs, outputs=outputs, dataset_name=\"movie-query_constructor\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "7e15770e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "client.create_dataset(\"movie-generator\")\n",
-    "\n",
-    "inputs = [r.inputs for r in gen_runs]\n",
-    "outputs = [r.outputs for r in gen_runs]\n",
-    "\n",
-    "client.create_examples(inputs=inputs, outputs=outputs, dataset_name=\"movie-generator\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "61cf9bcd",
-   "metadata": {},
-   "source": [
-    "## Use as few shot examples\n",
-    "\n",
-    "We can now pull down a dataset and use them as few shot examples in a future chain"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 26,
-   "id": "d9c79173",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "examples = list(client.list_examples(dataset_name=\"movie-query_constructor\"))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 27,
-   "id": "a1771dd0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import json\n",
-    "\n",
-    "\n",
-    "def filter_to_string(_filter):\n",
-    "    if \"operator\" in _filter:\n",
-    "        args = [filter_to_string(f) for f in _filter[\"arguments\"]]\n",
-    "        return f\"{_filter['operator']}({','.join(args)})\"\n",
-    "    else:\n",
-    "        comparator = _filter[\"comparator\"]\n",
-    "        attribute = json.dumps(_filter[\"attribute\"])\n",
-    "        value = json.dumps(_filter[\"value\"])\n",
-    "        return f\"{comparator}({attribute}, {value})\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 28,
-   "id": "e67a3530",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "model_examples = []\n",
-    "\n",
-    "for e in examples:\n",
-    "    if \"filter\" in e.outputs[\"output\"]:\n",
-    "        string_filter = filter_to_string(e.outputs[\"output\"][\"filter\"])\n",
-    "    else:\n",
-    "        string_filter = \"NO_FILTER\"\n",
-    "    model_examples.append(\n",
-    "        (\n",
-    "            e.inputs[\"query\"],\n",
-    "            {\"query\": e.outputs[\"output\"][\"query\"], \"filter\": string_filter},\n",
-    "        )\n",
-    "    )"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 29,
-   "id": "84593135",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "retriever1 = SelfQueryRetriever.from_llm(\n",
-    "    llm,\n",
-    "    vectorstore,\n",
-    "    document_content_description,\n",
-    "    metadata_field_info,\n",
-    "    verbose=True,\n",
-    "    chain_kwargs={\"examples\": model_examples},\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 30,
-   "id": "4ec9bb92",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain1 = (\n",
-    "    RunnablePassthrough.assign(info=(lambda x: x[\"question\"]) | retriever1) | generator\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 31,
-   "id": "64eb88e2",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'1. \"Saving Private Ryan\" (1998) - Directed by Steven Spielberg, this war film follows a group of soldiers during World War II as they search for a missing paratrooper.\\n\\n2. \"The Matrix\" (1999) - Directed by the Wachowskis, this science fiction action film follows a computer hacker who discovers the truth about the reality he lives in.\\n\\n3. \"Lethal Weapon 4\" (1998) - Directed by Richard Donner, this action-comedy film follows two mismatched detectives as they investigate a Chinese immigrant smuggling ring.\\n\\n4. \"The Fifth Element\" (1997) - Directed by Luc Besson, this science fiction action film follows a cab driver who must protect a mysterious woman who holds the key to saving the world.\\n\\n5. \"The Rock\" (1996) - Directed by Michael Bay, this action thriller follows a group of rogue military men who take over Alcatraz and threaten to launch missiles at San Francisco.'"
-      ]
-     },
-     "execution_count": 31,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain1.invoke(\n",
-    "    {\"question\": \"what are good action movies made before 2000 but after 1997?\"}\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e1ee8b55",
-   "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.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/oracleai_demo.ipynb

@@ -1,729 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Oracle AI Vector Search with Document Processing\n",
-    "Oracle AI Vector Search is designed for Artificial Intelligence (AI) workloads that allows you to query data based on semantics, rather than keywords.\n",
-    "One of the biggest benefits of Oracle AI Vector Search is that semantic search on unstructured data can be combined with relational search on business data in one single system.\n",
-    "This is not only powerful but also significantly more effective because you don't need to add a specialized vector database, eliminating the pain of data fragmentation between multiple systems.\n",
-    "\n",
-    "In addition, your vectors can benefit from all of Oracle Database’s most powerful features, like the following:\n",
-    "\n",
-    " * [Partitioning Support](https://www.oracle.com/database/technologies/partitioning.html)\n",
-    " * [Real Application Clusters scalability](https://www.oracle.com/database/real-application-clusters/)\n",
-    " * [Exadata smart scans](https://www.oracle.com/database/technologies/exadata/software/smartscan/)\n",
-    " * [Shard processing across geographically distributed databases](https://www.oracle.com/database/distributed-database/)\n",
-    " * [Transactions](https://docs.oracle.com/en/database/oracle/oracle-database/23/cncpt/transactions.html)\n",
-    " * [Parallel SQL](https://docs.oracle.com/en/database/oracle/oracle-database/21/vldbg/parallel-exec-intro.html#GUID-D28717E4-0F77-44F5-BB4E-234C31D4E4BA)\n",
-    " * [Disaster recovery](https://www.oracle.com/database/data-guard/)\n",
-    " * [Security](https://www.oracle.com/security/database-security/)\n",
-    " * [Oracle Machine Learning](https://www.oracle.com/artificial-intelligence/database-machine-learning/)\n",
-    " * [Oracle Graph Database](https://www.oracle.com/database/integrated-graph-database/)\n",
-    " * [Oracle Spatial and Graph](https://www.oracle.com/database/spatial/)\n",
-    " * [Oracle Blockchain](https://docs.oracle.com/en/database/oracle/oracle-database/23/arpls/dbms_blockchain_table.html#GUID-B469E277-978E-4378-A8C1-26D3FF96C9A6)\n",
-    " * [JSON](https://docs.oracle.com/en/database/oracle/oracle-database/23/adjsn/json-in-oracle-database.html)\n",
-    "\n",
-    "This guide demonstrates how Oracle AI Vector Search can be used with LangChain to serve an end-to-end RAG pipeline. This guide goes through examples of:\n",
-    "\n",
-    " * Loading the documents from various sources using OracleDocLoader\n",
-    " * Summarizing them within/outside the database using OracleSummary\n",
-    " * Generating embeddings for them within/outside the database using OracleEmbeddings\n",
-    " * Chunking them according to different requirements using Advanced Oracle Capabilities from OracleTextSplitter\n",
-    " * Storing and Indexing them in a Vector Store and querying them for queries in OracleVS"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "If you are just starting with Oracle Database, consider exploring the [free Oracle 23 AI](https://www.oracle.com/database/free/#resources) which provides a great introduction to setting up your database environment. While working with the database, it is often advisable to avoid using the system user by default; instead, you can create your own user for enhanced security and customization. For detailed steps on user creation, refer to our [end-to-end guide](https://github.com/langchain-ai/langchain/blob/master/cookbook/oracleai_demo.ipynb) which also shows how to set up a user in Oracle. Additionally, understanding user privileges is crucial for managing database security effectively. You can learn more about this topic in the official [Oracle guide](https://docs.oracle.com/en/database/oracle/oracle-database/19/admqs/administering-user-accounts-and-security.html#GUID-36B21D72-1BBB-46C9-A0C9-F0D2A8591B8D) on administering user accounts and security."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Prerequisites\n",
-    "\n",
-    "You'll need to install `langchain-oracledb` with `python -m pip install -U langchain-oracledb` to use this integration.\n",
-    "\n",
-    "The `python-oracledb` driver is installed automatically as a dependency of langchain-oracledb.\n",
-    "\n",
-    "```\n",
-    "$ python -m pip install -U langchain-oracledb\n",
-    "```"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Create Demo User\n",
-    "First, connect as a privileged user to create a demo user with all the required privileges. Change the credentials for your environment. Also set the DEMO_PY_DIR path to a directory on the database host where your model file is located:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import oracledb\n",
-    "\n",
-    "# Please update with your SYSTEM (or privileged user) username, password, and database connection string\n",
-    "username = \"SYSTEM\"\n",
-    "password = \"\"\n",
-    "dsn = \"\"\n",
-    "\n",
-    "with oracledb.connect(user=username, password=password, dsn=dsn) as connection:\n",
-    "    print(\"Connection successful!\")\n",
-    "\n",
-    "    with connection.cursor() as cursor:\n",
-    "        cursor.execute(\n",
-    "            \"\"\"\n",
-    "            begin\n",
-    "                -- Drop user\n",
-    "                execute immediate 'drop user if exists testuser cascade';\n",
-    "\n",
-    "                -- Create user and grant privileges\n",
-    "                execute immediate 'create user testuser identified by testuser';\n",
-    "                execute immediate 'grant connect, unlimited tablespace, create credential, create procedure, create any index to testuser';\n",
-    "                execute immediate 'create or replace directory DEMO_PY_DIR as ''/home/yourname/demo/orachain''';\n",
-    "                execute immediate 'grant read, write on directory DEMO_PY_DIR to public';\n",
-    "                execute immediate 'grant create mining model to testuser';\n",
-    "\n",
-    "                -- Network access\n",
-    "                begin\n",
-    "                    DBMS_NETWORK_ACL_ADMIN.APPEND_HOST_ACE(\n",
-    "                        host => '*',\n",
-    "                        ace => xs$ace_type(privilege_list => xs$name_list('connect'),\n",
-    "                                           principal_name => 'testuser',\n",
-    "                                           principal_type => xs_acl.ptype_db)\n",
-    "                    );\n",
-    "                end;\n",
-    "            end;\n",
-    "            \"\"\"\n",
-    "        )\n",
-    "        print(\"User setup done!\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Process Documents using Oracle AI\n",
-    "Consider the following scenario: users possess documents stored either in an Oracle Database or a file system and intend to utilize this data with Oracle AI Vector Search powered by LangChain.\n",
-    "\n",
-    "To prepare the documents for analysis, a comprehensive preprocessing workflow is necessary. Initially, the documents must be retrieved, summarized (if required), and chunked as needed. Subsequent steps involve generating embeddings for these chunks and integrating them into the Oracle AI Vector Store. Users can then conduct semantic searches on this data.\n",
-    "\n",
-    "The Oracle AI Vector Search LangChain library encompasses a suite of document processing tools that facilitate document loading, chunking, summary generation, and embedding creation.\n",
-    "\n",
-    "In the sections that follow, we will detail the utilization of Oracle AI LangChain APIs to effectively implement each of these processes."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Connect to Demo User\n",
-    "The following sample code shows how to connect to Oracle Database using the python-oracledb driver. By default, python-oracledb runs in a ‘Thin’ mode which connects directly to Oracle Database. This mode does not need Oracle Client libraries. However, some additional functionality is available when python-oracledb uses them. Python-oracledb is said to be in ‘Thick’ mode when Oracle Client libraries are used. Both modes have comprehensive functionality supporting the Python Database API v2.0 Specification. See the following [guide](https://python-oracledb.readthedocs.io/en/latest/user_guide/appendix_a.html#featuresummary) that talks about features supported in each mode. You can switch to Thick mode if you are unable to use Thin mode."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import oracledb\n",
-    "\n",
-    "# please update with your username, password, and database connection string\n",
-    "username = \"testuser\"\n",
-    "password = \"\"\n",
-    "dsn = \"\"\n",
-    "\n",
-    "connection = oracledb.connect(user=username, password=password, dsn=dsn)\n",
-    "print(\"Connection successful!\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Populate a Demo Table\n",
-    "Create a demo table and insert some sample documents."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "with connection.cursor() as cursor:\n",
-    "    drop_table_sql = \"\"\"drop table if exists demo_tab\"\"\"\n",
-    "    cursor.execute(drop_table_sql)\n",
-    "\n",
-    "    create_table_sql = \"\"\"create table demo_tab (id number, data clob)\"\"\"\n",
-    "    cursor.execute(create_table_sql)\n",
-    "\n",
-    "    insert_row_sql = \"\"\"insert into demo_tab values (:1, :2)\"\"\"\n",
-    "    rows_to_insert = [\n",
-    "        (\n",
-    "            1,\n",
-    "            \"If the answer to any preceding questions is yes, then the database stops the search and allocates space from the specified tablespace; otherwise, space is allocated from the database default shared temporary tablespace.\",\n",
-    "        ),\n",
-    "        (\n",
-    "            2,\n",
-    "            \"A tablespace can be online (accessible) or offline (not accessible) whenever the database is open.\\nA tablespace is usually online so that its data is available to users. The SYSTEM tablespace and temporary tablespaces cannot be taken offline.\",\n",
-    "        ),\n",
-    "        (\n",
-    "            3,\n",
-    "            \"The database stores LOBs differently from other data types. Creating a LOB column implicitly creates a LOB segment and a LOB index. The tablespace containing the LOB segment and LOB index, which are always stored together, may be different from the tablespace containing the table.\\nSometimes the database can store small amounts of LOB data in the table itself rather than in a separate LOB segment.\",\n",
-    "        ),\n",
-    "    ]\n",
-    "    cursor.executemany(insert_row_sql, rows_to_insert)\n",
-    "\n",
-    "connection.commit()\n",
-    "\n",
-    "print(\"Table created and populated.\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "With the inclusion of a demo user and a populated sample table, the remaining configuration involves setting up embedding and summary functionalities. Users are presented with multiple provider options, including local database solutions and third-party services such as Ocigenai, Hugging Face, and OpenAI. Should users opt for a third-party provider, they are required to establish credentials containing the necessary authentication details. Conversely, if selecting a database as the provider for embeddings, it is necessary to upload an ONNX model to the Oracle Database. No additional setup is required for summary functionalities when using the database option."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Load the ONNX Model\n",
-    "\n",
-    "Oracle accommodates a variety of embedding providers, enabling you to choose between proprietary database solutions and third-party services such as Oracle Generative AI Service and HuggingFace. This selection dictates the methodology for generating and managing embeddings.\n",
-    "\n",
-    "***Important*** : Should you opt for the database option, you must upload an ONNX model into the Oracle Database. Conversely, if a third-party provider is selected for embedding generation, uploading an ONNX model to Oracle Database is not required.\n",
-    "\n",
-    "A significant advantage of utilizing an ONNX model directly within Oracle Database is the enhanced security and performance it offers by eliminating the need to transmit data to external parties. Additionally, this method avoids the latency typically associated with network or REST API calls.\n",
-    "\n",
-    "Below is the example code to upload an ONNX model into Oracle Database:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_oracledb.embeddings.oracleai import OracleEmbeddings\n",
-    "\n",
-    "# please update with your related information\n",
-    "# make sure that you have onnx file in the system\n",
-    "onnx_dir = \"DEMO_PY_DIR\"\n",
-    "onnx_file = \"tinybert.onnx\"\n",
-    "model_name = \"demo_model\"\n",
-    "\n",
-    "OracleEmbeddings.load_onnx_model(connection, onnx_dir, onnx_file, model_name)\n",
-    "print(\"ONNX model loaded.\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Create Credential\n",
-    "\n",
-    "When selecting third-party providers for generating embeddings, users are required to establish credentials to securely access the provider's endpoints.\n",
-    "\n",
-    "***Important:*** No credentials are necessary when opting for the 'database' provider to generate embeddings. However, should users decide to utilize a third-party provider, they must create credentials specific to the chosen provider.\n",
-    "\n",
-    "Below is an illustrative example:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "with connection.cursor() as cursor:\n",
-    "    cursor.execute(\n",
-    "        \"\"\"\n",
-    "       declare\n",
-    "           jo json_object_t;\n",
-    "       begin\n",
-    "           -- HuggingFace\n",
-    "           dbms_vector_chain.drop_credential(credential_name  => 'HF_CRED');\n",
-    "           jo := json_object_t();\n",
-    "           jo.put('access_token', '<access_token>');\n",
-    "           dbms_vector_chain.create_credential(\n",
-    "               credential_name   =>  'HF_CRED',\n",
-    "               params            => json(jo.to_string));\n",
-    "\n",
-    "           -- OCIGENAI\n",
-    "           dbms_vector_chain.drop_credential(credential_name  => 'OCI_CRED');\n",
-    "           jo := json_object_t();\n",
-    "           jo.put('user_ocid','<user_ocid>');\n",
-    "           jo.put('tenancy_ocid','<tenancy_ocid>');\n",
-    "           jo.put('compartment_ocid','<compartment_ocid>');\n",
-    "           jo.put('private_key','<private_key>');\n",
-    "           jo.put('fingerprint','<fingerprint>');\n",
-    "           dbms_vector_chain.create_credential(\n",
-    "               credential_name   => 'OCI_CRED',\n",
-    "               params            => json(jo.to_string));\n",
-    "       end;\n",
-    "       \"\"\"\n",
-    "    )"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Load Documents\n",
-    "You have the flexibility to load documents from either the Oracle Database, a file system, or both, by appropriately configuring the loader parameters. For comprehensive details on these parameters, please consult the [Oracle AI Vector Search Guide](https://docs.oracle.com/en/database/oracle/oracle-database/23/arpls/dbms_vector_chain1.html#GUID-73397E89-92FB-48ED-94BB-1AD960C4EA1F).\n",
-    "\n",
-    "A significant advantage of utilizing OracleDocLoader is its capability to process over 150 distinct file formats, eliminating the need for multiple loaders for different document types. For a complete list of the supported formats, please refer to the [Oracle Text Supported Document Formats](https://docs.oracle.com/en/database/oracle/oracle-database/23/ccref/oracle-text-supported-document-formats.html).\n",
-    "\n",
-    "Below is a sample code snippet that demonstrates how to use OracleDocLoader:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_oracledb.document_loaders.oracleai import OracleDocLoader\n",
-    "from langchain_core.documents import Document\n",
-    "\n",
-    "# loading from Oracle Database table\n",
-    "# make sure you have the table with this specification\n",
-    "loader_params = {\n",
-    "    \"owner\": \"testuser\",\n",
-    "    \"tablename\": \"demo_tab\",\n",
-    "    \"colname\": \"data\",\n",
-    "}\n",
-    "\n",
-    "\"\"\" load the docs \"\"\"\n",
-    "loader = OracleDocLoader(conn=connection, params=loader_params)\n",
-    "docs = loader.load()\n",
-    "\n",
-    "\"\"\" verify \"\"\"\n",
-    "print(f\"Number of docs loaded: {len(docs)}\")\n",
-    "# print(f\"Document-0: {docs[0].page_content}\") # content"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Generate Summary\n",
-    "Now that you have loaded the documents, you may want to generate a summary for each document. The Oracle AI Vector Search LangChain library offers a suite of APIs designed for document summarization. It supports multiple summarization providers such as Database, Oracle Generative AI Service, HuggingFace, among others, allowing you to select the provider that best meets their needs. To utilize these capabilities, you must configure the summary parameters as specified. For detailed information on these parameters, please consult the [Oracle AI Vector Search Guide book](https://docs.oracle.com/en/database/oracle/oracle-database/23/arpls/dbms_vector_chain1.html#GUID-EC9DDB58-6A15-4B36-BA66-ECBA20D2CE57)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "***Note:*** You may need to set proxy if you want to use some 3rd party summary generation providers other than Oracle's in-house and default provider: 'database'. If you don't have proxy, please remove the proxy parameter when you instantiate the OracleSummary."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# proxy to be used when we instantiate summary and embedder objects\n",
-    "proxy = \"\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "The following sample code shows how to generate a summary:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_oracledb.utilities.oracleai import OracleSummary\n",
-    "from langchain_core.documents import Document\n",
-    "\n",
-    "# using 'database' provider\n",
-    "summary_params = {\n",
-    "    \"provider\": \"database\",\n",
-    "    \"glevel\": \"S\",\n",
-    "    \"numParagraphs\": 1,\n",
-    "    \"language\": \"english\",\n",
-    "}\n",
-    "\n",
-    "# get the summary instance\n",
-    "# Remove proxy if not required\n",
-    "summ = OracleSummary(conn=connection, params=summary_params, proxy=proxy)\n",
-    "\n",
-    "list_summary = []\n",
-    "for doc in docs:\n",
-    "    summary = summ.get_summary(doc.page_content)\n",
-    "    list_summary.append(summary)\n",
-    "\n",
-    "\"\"\" verify \"\"\"\n",
-    "print(f\"Number of Summaries: {len(list_summary)}\")\n",
-    "# print(f\"Summary-0: {list_summary[0]}\") #content"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Split Documents\n",
-    "The documents may vary in size, ranging from small to very large. Users often prefer to chunk their documents into smaller sections to facilitate the generation of embeddings. A wide array of customization options is available for this splitting process. For comprehensive details regarding these parameters, please consult the [Oracle AI Vector Search Guide](https://docs.oracle.com/en/database/oracle/oracle-database/23/arpls/dbms_vector_chain1.html#GUID-4E145629-7098-4C7C-804F-FC85D1F24240).\n",
-    "\n",
-    "Below is a sample code illustrating how to implement this:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_oracledb.document_loaders.oracleai import OracleTextSplitter\n",
-    "from langchain_core.documents import Document\n",
-    "\n",
-    "# split by default parameters\n",
-    "splitter_params = {\"normalize\": \"all\"}\n",
-    "\n",
-    "\"\"\" get the splitter instance \"\"\"\n",
-    "splitter = OracleTextSplitter(conn=connection, params=splitter_params)\n",
-    "\n",
-    "list_chunks = []\n",
-    "for doc in docs:\n",
-    "    chunks = splitter.split_text(doc.page_content)\n",
-    "    list_chunks.extend(chunks)\n",
-    "\n",
-    "\"\"\" verify \"\"\"\n",
-    "print(f\"Number of Chunks: {len(list_chunks)}\")\n",
-    "# print(f\"Chunk-0: {list_chunks[0]}\") # content"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Generate Embeddings\n",
-    "Now that the documents are chunked as per requirements, you may want to generate embeddings for these chunks. Oracle AI Vector Search provides multiple methods for generating embeddings, utilizing either locally hosted ONNX models or third-party APIs. For comprehensive instructions on configuring these alternatives, please refer to the [Oracle AI Vector Search Guide](https://docs.oracle.com/en/database/oracle/oracle-database/23/arpls/dbms_vector_chain1.html#GUID-C6439E94-4E86-4ECD-954E-4B73D53579DE)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "***Note:*** You may need to configure a proxy to utilize third-party embedding generation providers, excluding the 'database' provider that utilizes an ONNX model."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# proxy to be used when we instantiate summary and embedder object\n",
-    "proxy = \"\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "The following sample code shows how to generate embeddings:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_oracledb.embeddings.oracleai import OracleEmbeddings\n",
-    "from langchain_core.documents import Document\n",
-    "\n",
-    "# using ONNX model loaded to Oracle Database\n",
-    "embedder_params = {\"provider\": \"database\", \"model\": \"demo_model\"}\n",
-    "\n",
-    "# get the embedding instance\n",
-    "# Remove proxy if not required\n",
-    "embedder = OracleEmbeddings(conn=connection, params=embedder_params, proxy=proxy)\n",
-    "\n",
-    "embeddings = []\n",
-    "for doc in docs:\n",
-    "    chunks = splitter.split_text(doc.page_content)\n",
-    "    for chunk in chunks:\n",
-    "        embed = embedder.embed_query(chunk)\n",
-    "        embeddings.append(embed)\n",
-    "\n",
-    "\"\"\" verify \"\"\"\n",
-    "print(f\"Number of embeddings: {len(embeddings)}\")\n",
-    "# print(f\"Embedding-0: {embeddings[0]}\") # content"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create Oracle AI Vector Store\n",
-    "Now that you know how to use Oracle AI LangChain library APIs individually to process the documents, let us show how to integrate with Oracle AI Vector Store to facilitate the semantic searches."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "First, let's import all the dependencies:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import sys\n",
-    "\n",
-    "import oracledb\n",
-    "from langchain_oracledb.document_loaders.oracleai import (\n",
-    "    OracleDocLoader,\n",
-    "    OracleTextSplitter,\n",
-    ")\n",
-    "from langchain_oracledb.embeddings.oracleai import OracleEmbeddings\n",
-    "from langchain_oracledb.utilities.oracleai import OracleSummary\n",
-    "from langchain_oracledb.vectorstores import oraclevs\n",
-    "from langchain_oracledb.vectorstores.oraclevs import OracleVS\n",
-    "from langchain_community.vectorstores.utils import DistanceStrategy\n",
-    "from langchain_core.documents import Document"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Next, let's combine all document processing stages together. Here is the sample code:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "\"\"\"\n",
-    "In this sample example, we will use 'database' provider for both summary and embeddings\n",
-    "so, we don't need to do the following:\n",
-    "    - set proxy for 3rd party providers\n",
-    "    - create credential for 3rd party providers\n",
-    "\n",
-    "If you choose to use 3rd party provider, please follow the necessary steps for proxy and credential.\n",
-    "\"\"\"\n",
-    "\n",
-    "# please update with your username, password, and database connection string\n",
-    "username = \"\"\n",
-    "password = \"\"\n",
-    "dsn = \"\"\n",
-    "\n",
-    "with oracledb.connect(user=username, password=password, dsn=dsn) as connection:\n",
-    "    print(\"Connection successful!\")\n",
-    "\n",
-    "    # load onnx model\n",
-    "    # please update with your related information\n",
-    "    onnx_dir = \"DEMO_PY_DIR\"\n",
-    "    onnx_file = \"tinybert.onnx\"\n",
-    "    model_name = \"demo_model\"\n",
-    "    OracleEmbeddings.load_onnx_model(connection, onnx_dir, onnx_file, model_name)\n",
-    "    print(\"ONNX model loaded.\")\n",
-    "\n",
-    "    # params\n",
-    "    # please update necessary fields with related information\n",
-    "    loader_params = {\n",
-    "        \"owner\": \"testuser\",\n",
-    "        \"tablename\": \"demo_tab\",\n",
-    "        \"colname\": \"data\",\n",
-    "    }\n",
-    "    summary_params = {\n",
-    "        \"provider\": \"database\",\n",
-    "        \"glevel\": \"S\",\n",
-    "        \"numParagraphs\": 1,\n",
-    "        \"language\": \"english\",\n",
-    "    }\n",
-    "    splitter_params = {\"normalize\": \"all\"}\n",
-    "    embedder_params = {\"provider\": \"database\", \"model\": \"demo_model\"}\n",
-    "\n",
-    "    # instantiate loader, summary, splitter, and embedder\n",
-    "    loader = OracleDocLoader(conn=connection, params=loader_params)\n",
-    "    summary = OracleSummary(conn=connection, params=summary_params)\n",
-    "    splitter = OracleTextSplitter(conn=connection, params=splitter_params)\n",
-    "    embedder = OracleEmbeddings(conn=connection, params=embedder_params)\n",
-    "\n",
-    "    # process the documents\n",
-    "    chunks_with_mdata = []\n",
-    "    for id, doc in enumerate(docs, start=1):\n",
-    "        summ = summary.get_summary(doc.page_content)\n",
-    "        chunks = splitter.split_text(doc.page_content)\n",
-    "        for ic, chunk in enumerate(chunks, start=1):\n",
-    "            chunk_metadata = doc.metadata.copy()\n",
-    "            chunk_metadata[\"id\"] = (\n",
-    "                chunk_metadata[\"_oid\"] + \"$\" + str(id) + \"$\" + str(ic)\n",
-    "            )\n",
-    "            chunk_metadata[\"document_id\"] = str(id)\n",
-    "            chunk_metadata[\"document_summary\"] = str(summ[0])\n",
-    "            chunks_with_mdata.append(\n",
-    "                Document(page_content=str(chunk), metadata=chunk_metadata)\n",
-    "            )\n",
-    "\n",
-    "    \"\"\" verify \"\"\"\n",
-    "    print(f\"Number of total chunks with metadata: {len(chunks_with_mdata)}\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "At this point, we have processed the documents and generated chunks with metadata. Next, we will create Oracle AI Vector Store with those chunks.\n",
-    "\n",
-    "Here is the sample code how to do that:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# create Oracle AI Vector Store\n",
-    "vectorstore = OracleVS.from_documents(\n",
-    "    chunks_with_mdata,\n",
-    "    embedder,\n",
-    "    client=connection,\n",
-    "    table_name=\"oravs\",\n",
-    "    distance_strategy=DistanceStrategy.DOT_PRODUCT,\n",
-    ")\n",
-    "\n",
-    "\"\"\" verify \"\"\"\n",
-    "print(f\"Vector Store Table: {vectorstore.table_name}\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "The example provided illustrates the creation of a vector store using the DOT_PRODUCT distance strategy. Users have the flexibility to employ various distance strategies with the Oracle AI Vector Store, as detailed in our [comprehensive guide](https://python.langchain.com/v0.1/docs/integrations/vectorstores/oracle/)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "With embeddings now stored in vector stores, it is advisable to establish an index to enhance semantic search performance during query execution.\n",
-    "\n",
-    "***Note*** Should you encounter an \"insufficient memory\" error, it is recommended to increase the  ***vector_memory_size*** in your database configuration\n",
-    "\n",
-    "Below is a sample code snippet for creating an index:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "oraclevs.create_index(\n",
-    "    connection, vectorstore, params={\"idx_name\": \"hnsw_oravs\", \"idx_type\": \"HNSW\"}\n",
-    ")\n",
-    "\n",
-    "print(\"Index created.\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "This example demonstrates the creation of a default HNSW index on embeddings within the 'oravs' table. You may adjust various parameters according to your specific needs. For detailed information on these parameters, please consult the [Oracle AI Vector Search Guide book](https://docs.oracle.com/en/database/oracle/oracle-database/23/vecse/manage-different-categories-vector-indexes.html).\n",
-    "\n",
-    "Additionally, various types of vector indices can be created to meet diverse requirements. More details can be found in our [comprehensive guide](https://python.langchain.com/v0.1/docs/integrations/vectorstores/oracle/).\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Perform Semantic Search\n",
-    "All set!\n",
-    "\n",
-    "You have successfully processed the documents and stored them in the vector store, followed by the creation of an index to enhance query performance. You are now prepared to proceed with semantic searches.\n",
-    "\n",
-    "Below is the sample code for this process:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query = \"What is Oracle AI Vector Store?\"\n",
-    "db_filter = {\"document_id\": \"1\"}\n",
-    "\n",
-    "# Similarity search without a filter\n",
-    "print(vectorstore.similarity_search(query, 1))\n",
-    "\n",
-    "# Similarity search with a filter\n",
-    "print(vectorstore.similarity_search(query, 1, filter=db_filter))\n",
-    "\n",
-    "# Similarity search with relevance score\n",
-    "print(vectorstore.similarity_search_with_score(query, 1))\n",
-    "\n",
-    "# Similarity search with relevance score with filter\n",
-    "print(vectorstore.similarity_search_with_score(query, 1, filter=db_filter))\n",
-    "\n",
-    "# Max marginal relevance search\n",
-    "print(vectorstore.max_marginal_relevance_search(query, 1, fetch_k=20, lambda_mult=0.5))\n",
-    "\n",
-    "# Max marginal relevance search with filter\n",
-    "print(\n",
-    "    vectorstore.max_marginal_relevance_search(\n",
-    "        query, 1, fetch_k=20, lambda_mult=0.5, filter=db_filter\n",
-    "    )\n",
-    ")"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.13.3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

cookbook/petting_zoo.ipynb

@@ -1,832 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "4b089493",
-   "metadata": {},
-   "source": [
-    "# Multi-Agent Simulated Environment: Petting Zoo\n",
-    "\n",
-    "In this example, we show how to define multi-agent simulations with simulated environments. Like [ours single-agent example with Gymnasium](https://python.langchain.com/en/latest/use_cases/agent_simulations/gymnasium.html), we create an agent-environment loop with an externally defined environment. The main difference is that we now implement this kind of interaction loop with multiple agents instead. We will use the [Petting Zoo](https://pettingzoo.farama.org/) library, which is the multi-agent counterpart to [Gymnasium](https://gymnasium.farama.org/)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "10091333",
-   "metadata": {},
-   "source": [
-    "## Install `pettingzoo` and other dependencies"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "0a3fde66",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install pettingzoo pygame rlcard"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "5fbe130c",
-   "metadata": {},
-   "source": [
-    "## Import modules"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "42cd2e5d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import collections\n",
-    "import inspect\n",
-    "\n",
-    "import tenacity\n",
-    "from langchain.output_parsers import RegexParser\n",
-    "from langchain.schema import (\n",
-    "    HumanMessage,\n",
-    "    SystemMessage,\n",
-    ")\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e222e811",
-   "metadata": {},
-   "source": [
-    "## `GymnasiumAgent`\n",
-    "Here we reproduce the same `GymnasiumAgent` defined from [our Gymnasium example](https://python.langchain.com/en/latest/use_cases/agent_simulations/gymnasium.html). If after multiple retries it does not take a valid action, it simply takes a random action. "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "72df0b59",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class GymnasiumAgent:\n",
-    "    @classmethod\n",
-    "    def get_docs(cls, env):\n",
-    "        return env.unwrapped.__doc__\n",
-    "\n",
-    "    def __init__(self, model, env):\n",
-    "        self.model = model\n",
-    "        self.env = env\n",
-    "        self.docs = self.get_docs(env)\n",
-    "\n",
-    "        self.instructions = \"\"\"\n",
-    "Your goal is to maximize your return, i.e. the sum of the rewards you receive.\n",
-    "I will give you an observation, reward, terminiation flag, truncation flag, and the return so far, formatted as:\n",
-    "\n",
-    "Observation: <observation>\n",
-    "Reward: <reward>\n",
-    "Termination: <termination>\n",
-    "Truncation: <truncation>\n",
-    "Return: <sum_of_rewards>\n",
-    "\n",
-    "You will respond with an action, formatted as:\n",
-    "\n",
-    "Action: <action>\n",
-    "\n",
-    "where you replace <action> with your actual action.\n",
-    "Do nothing else but return the action.\n",
-    "\"\"\"\n",
-    "        self.action_parser = RegexParser(\n",
-    "            regex=r\"Action: (.*)\", output_keys=[\"action\"], default_output_key=\"action\"\n",
-    "        )\n",
-    "\n",
-    "        self.message_history = []\n",
-    "        self.ret = 0\n",
-    "\n",
-    "    def random_action(self):\n",
-    "        action = self.env.action_space.sample()\n",
-    "        return action\n",
-    "\n",
-    "    def reset(self):\n",
-    "        self.message_history = [\n",
-    "            SystemMessage(content=self.docs),\n",
-    "            SystemMessage(content=self.instructions),\n",
-    "        ]\n",
-    "\n",
-    "    def observe(self, obs, rew=0, term=False, trunc=False, info=None):\n",
-    "        self.ret += rew\n",
-    "\n",
-    "        obs_message = f\"\"\"\n",
-    "Observation: {obs}\n",
-    "Reward: {rew}\n",
-    "Termination: {term}\n",
-    "Truncation: {trunc}\n",
-    "Return: {self.ret}\n",
-    "        \"\"\"\n",
-    "        self.message_history.append(HumanMessage(content=obs_message))\n",
-    "        return obs_message\n",
-    "\n",
-    "    def _act(self):\n",
-    "        act_message = self.model.invoke(self.message_history)\n",
-    "        self.message_history.append(act_message)\n",
-    "        action = int(self.action_parser.parse(act_message.content)[\"action\"])\n",
-    "        return action\n",
-    "\n",
-    "    def act(self):\n",
-    "        try:\n",
-    "            for attempt in tenacity.Retrying(\n",
-    "                stop=tenacity.stop_after_attempt(2),\n",
-    "                wait=tenacity.wait_none(),  # No waiting time between retries\n",
-    "                retry=tenacity.retry_if_exception_type(ValueError),\n",
-    "                before_sleep=lambda retry_state: print(\n",
-    "                    f\"ValueError occurred: {retry_state.outcome.exception()}, retrying...\"\n",
-    "                ),\n",
-    "            ):\n",
-    "                with attempt:\n",
-    "                    action = self._act()\n",
-    "        except tenacity.RetryError:\n",
-    "            action = self.random_action()\n",
-    "        return action"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "df51e302",
-   "metadata": {},
-   "source": [
-    "## Main loop"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "0f07d7cf",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def main(agents, env):\n",
-    "    env.reset()\n",
-    "\n",
-    "    for name, agent in agents.items():\n",
-    "        agent.reset()\n",
-    "\n",
-    "    for agent_name in env.agent_iter():\n",
-    "        observation, reward, termination, truncation, info = env.last()\n",
-    "        obs_message = agents[agent_name].observe(\n",
-    "            observation, reward, termination, truncation, info\n",
-    "        )\n",
-    "        print(obs_message)\n",
-    "        if termination or truncation:\n",
-    "            action = None\n",
-    "        else:\n",
-    "            action = agents[agent_name].act()\n",
-    "        print(f\"Action: {action}\")\n",
-    "        env.step(action)\n",
-    "    env.close()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "b4b0e921",
-   "metadata": {},
-   "source": [
-    "## `PettingZooAgent`\n",
-    "\n",
-    "The `PettingZooAgent` extends the `GymnasiumAgent` to the multi-agent setting. The main differences are:\n",
-    "- `PettingZooAgent` takes in a `name` argument to identify it among multiple agents\n",
-    "- the function `get_docs` is implemented differently because the `PettingZoo` repo structure is structured differently from the `Gymnasium` repo"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "f132c92a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class PettingZooAgent(GymnasiumAgent):\n",
-    "    @classmethod\n",
-    "    def get_docs(cls, env):\n",
-    "        return inspect.getmodule(env.unwrapped).__doc__\n",
-    "\n",
-    "    def __init__(self, name, model, env):\n",
-    "        super().__init__(model, env)\n",
-    "        self.name = name\n",
-    "\n",
-    "    def random_action(self):\n",
-    "        action = self.env.action_space(self.name).sample()\n",
-    "        return action"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a27f8a5d",
-   "metadata": {},
-   "source": [
-    "## Rock, Paper, Scissors\n",
-    "We can now run a simulation of a multi-agent rock, paper, scissors game using the `PettingZooAgent`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "bd1256c0",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "Observation: 3\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 1\n",
-      "\n",
-      "Observation: 3\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 1\n",
-      "\n",
-      "Observation: 1\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 2\n",
-      "\n",
-      "Observation: 1\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 1\n",
-      "\n",
-      "Observation: 1\n",
-      "Reward: 1\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 1\n",
-      "        \n",
-      "Action: 0\n",
-      "\n",
-      "Observation: 2\n",
-      "Reward: -1\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: -1\n",
-      "        \n",
-      "Action: 0\n",
-      "\n",
-      "Observation: 0\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: True\n",
-      "Return: 1\n",
-      "        \n",
-      "Action: None\n",
-      "\n",
-      "Observation: 0\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: True\n",
-      "Return: -1\n",
-      "        \n",
-      "Action: None\n"
-     ]
-    }
-   ],
-   "source": [
-    "from pettingzoo.classic import rps_v2\n",
-    "\n",
-    "env = rps_v2.env(max_cycles=3, render_mode=\"human\")\n",
-    "agents = {\n",
-    "    name: PettingZooAgent(name=name, model=ChatOpenAI(temperature=1), env=env)\n",
-    "    for name in env.possible_agents\n",
-    "}\n",
-    "main(agents, env)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fbcee258",
-   "metadata": {},
-   "source": [
-    "## `ActionMaskAgent`\n",
-    "\n",
-    "Some `PettingZoo` environments provide an `action_mask` to tell the agent which actions are valid. The `ActionMaskAgent` subclasses `PettingZooAgent` to use information from the `action_mask` to select actions."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "bd33250a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "class ActionMaskAgent(PettingZooAgent):\n",
-    "    def __init__(self, name, model, env):\n",
-    "        super().__init__(name, model, env)\n",
-    "        self.obs_buffer = collections.deque(maxlen=1)\n",
-    "\n",
-    "    def random_action(self):\n",
-    "        obs = self.obs_buffer[-1]\n",
-    "        action = self.env.action_space(self.name).sample(obs[\"action_mask\"])\n",
-    "        return action\n",
-    "\n",
-    "    def reset(self):\n",
-    "        self.message_history = [\n",
-    "            SystemMessage(content=self.docs),\n",
-    "            SystemMessage(content=self.instructions),\n",
-    "        ]\n",
-    "\n",
-    "    def observe(self, obs, rew=0, term=False, trunc=False, info=None):\n",
-    "        self.obs_buffer.append(obs)\n",
-    "        return super().observe(obs, rew, term, trunc, info)\n",
-    "\n",
-    "    def _act(self):\n",
-    "        valid_action_instruction = \"Generate a valid action given by the indices of the `action_mask` that are not 0, according to the action formatting rules.\"\n",
-    "        self.message_history.append(HumanMessage(content=valid_action_instruction))\n",
-    "        return super()._act()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2e76d22c",
-   "metadata": {},
-   "source": [
-    "## Tic-Tac-Toe\n",
-    "Here is an example of a Tic-Tac-Toe game that uses the `ActionMaskAgent`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "9e902cfd",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "Observation: {'observation': array([[[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]]], dtype=int8), 'action_mask': array([1, 1, 1, 1, 1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 0\n",
-      "     |     |     \n",
-      "  X  |  -  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  -  |  -  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  -  |  -  |  -  \n",
-      "     |     |     \n",
-      "\n",
-      "Observation: {'observation': array([[[0, 1],\n",
-      "        [0, 0],\n",
-      "        [0, 0]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]]], dtype=int8), 'action_mask': array([0, 1, 1, 1, 1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 1\n",
-      "     |     |     \n",
-      "  X  |  -  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  O  |  -  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  -  |  -  |  -  \n",
-      "     |     |     \n",
-      "\n",
-      "Observation: {'observation': array([[[1, 0],\n",
-      "        [0, 1],\n",
-      "        [0, 0]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]]], dtype=int8), 'action_mask': array([0, 0, 1, 1, 1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 2\n",
-      "     |     |     \n",
-      "  X  |  -  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  O  |  -  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  X  |  -  |  -  \n",
-      "     |     |     \n",
-      "\n",
-      "Observation: {'observation': array([[[0, 1],\n",
-      "        [1, 0],\n",
-      "        [0, 1]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]]], dtype=int8), 'action_mask': array([0, 0, 0, 1, 1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 3\n",
-      "     |     |     \n",
-      "  X  |  O  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  O  |  -  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  X  |  -  |  -  \n",
-      "     |     |     \n",
-      "\n",
-      "Observation: {'observation': array([[[1, 0],\n",
-      "        [0, 1],\n",
-      "        [1, 0]],\n",
-      "\n",
-      "       [[0, 1],\n",
-      "        [0, 0],\n",
-      "        [0, 0]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]]], dtype=int8), 'action_mask': array([0, 0, 0, 0, 1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 4\n",
-      "     |     |     \n",
-      "  X  |  O  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  O  |  X  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  X  |  -  |  -  \n",
-      "     |     |     \n",
-      "\n",
-      "Observation: {'observation': array([[[0, 1],\n",
-      "        [1, 0],\n",
-      "        [0, 1]],\n",
-      "\n",
-      "       [[1, 0],\n",
-      "        [0, 1],\n",
-      "        [0, 0]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]]], dtype=int8), 'action_mask': array([0, 0, 0, 0, 0, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 5\n",
-      "     |     |     \n",
-      "  X  |  O  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  O  |  X  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  X  |  O  |  -  \n",
-      "     |     |     \n",
-      "\n",
-      "Observation: {'observation': array([[[1, 0],\n",
-      "        [0, 1],\n",
-      "        [1, 0]],\n",
-      "\n",
-      "       [[0, 1],\n",
-      "        [1, 0],\n",
-      "        [0, 1]],\n",
-      "\n",
-      "       [[0, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]]], dtype=int8), 'action_mask': array([0, 0, 0, 0, 0, 0, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 6\n",
-      "     |     |     \n",
-      "  X  |  O  |  X  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  O  |  X  |  -  \n",
-      "_____|_____|_____\n",
-      "     |     |     \n",
-      "  X  |  O  |  -  \n",
-      "     |     |     \n",
-      "\n",
-      "Observation: {'observation': array([[[0, 1],\n",
-      "        [1, 0],\n",
-      "        [0, 1]],\n",
-      "\n",
-      "       [[1, 0],\n",
-      "        [0, 1],\n",
-      "        [1, 0]],\n",
-      "\n",
-      "       [[0, 1],\n",
-      "        [0, 0],\n",
-      "        [0, 0]]], dtype=int8), 'action_mask': array([0, 0, 0, 0, 0, 0, 0, 1, 1], dtype=int8)}\n",
-      "Reward: -1\n",
-      "Termination: True\n",
-      "Truncation: False\n",
-      "Return: -1\n",
-      "        \n",
-      "Action: None\n",
-      "\n",
-      "Observation: {'observation': array([[[1, 0],\n",
-      "        [0, 1],\n",
-      "        [1, 0]],\n",
-      "\n",
-      "       [[0, 1],\n",
-      "        [1, 0],\n",
-      "        [0, 1]],\n",
-      "\n",
-      "       [[1, 0],\n",
-      "        [0, 0],\n",
-      "        [0, 0]]], dtype=int8), 'action_mask': array([0, 0, 0, 0, 0, 0, 0, 1, 1], dtype=int8)}\n",
-      "Reward: 1\n",
-      "Termination: True\n",
-      "Truncation: False\n",
-      "Return: 1\n",
-      "        \n",
-      "Action: None\n"
-     ]
-    }
-   ],
-   "source": [
-    "from pettingzoo.classic import tictactoe_v3\n",
-    "\n",
-    "env = tictactoe_v3.env(render_mode=\"human\")\n",
-    "agents = {\n",
-    "    name: ActionMaskAgent(name=name, model=ChatOpenAI(temperature=0.2), env=env)\n",
-    "    for name in env.possible_agents\n",
-    "}\n",
-    "main(agents, env)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "8728ac2a",
-   "metadata": {},
-   "source": [
-    "## Texas Hold'em No Limit\n",
-    "Here is an example of a Texas Hold'em No Limit game that uses the `ActionMaskAgent`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 9,
-   "id": "e350c62b",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "Observation: {'observation': array([0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 0., 0., 0., 0., 0., 0., 0., 1., 0., 0., 1., 0., 0., 0., 0.,\n",
-      "       0., 0., 2.], dtype=float32), 'action_mask': array([1, 1, 0, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 1\n",
-      "\n",
-      "Observation: {'observation': array([0., 0., 1., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 1., 0., 0.,\n",
-      "       0., 0., 2.], dtype=float32), 'action_mask': array([1, 1, 0, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 1\n",
-      "\n",
-      "Observation: {'observation': array([0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 1., 0., 0., 1.,\n",
-      "       0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 1., 2.], dtype=float32), 'action_mask': array([1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 1\n",
-      "\n",
-      "Observation: {'observation': array([0., 0., 0., 0., 0., 0., 0., 0., 1., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 1., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 2., 2.], dtype=float32), 'action_mask': array([1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 0\n",
-      "\n",
-      "Observation: {'observation': array([0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 1., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 1., 0., 0., 1.,\n",
-      "       0., 0., 0., 0., 0., 1., 0., 0., 1., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 2., 2.], dtype=float32), 'action_mask': array([1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 2\n",
-      "\n",
-      "Observation: {'observation': array([0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 1., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 0., 0., 0., 1., 0., 0., 1., 1., 0., 0., 1., 0., 0., 0., 0.,\n",
-      "       0., 2., 6.], dtype=float32), 'action_mask': array([1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 2\n",
-      "\n",
-      "Observation: {'observation': array([0., 0., 1., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 1., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.,\n",
-      "       0., 0., 0., 0., 0., 1., 0., 0., 1., 0., 0., 0., 0., 0., 1., 0., 0.,\n",
-      "       0., 2., 8.], dtype=float32), 'action_mask': array([1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 3\n",
-      "\n",
-      "Observation: {'observation': array([ 0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,\n",
-      "        0.,  0.,  0.,  0.,  0.,  0.,  1.,  0.,  0.,  0.,  0.,  0.,  0.,\n",
-      "        0.,  0.,  0.,  0.,  1.,  0.,  0.,  1.,  0.,  0.,  0.,  0.,  0.,\n",
-      "        1.,  0.,  0.,  1.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,  0.,\n",
-      "        6., 20.], dtype=float32), 'action_mask': array([1, 1, 1, 1, 1], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 4\n",
-      "\n",
-      "Observation: {'observation': array([  0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,   1.,   1.,\n",
-      "         0.,   0.,   1.,   0.,   0.,   0.,   0.,   0.,   8., 100.],\n",
-      "      dtype=float32), 'action_mask': array([1, 1, 0, 0, 0], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: False\n",
-      "Truncation: False\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: 4\n",
-      "[WARNING]: Illegal move made, game terminating with current player losing. \n",
-      "obs['action_mask'] contains a mask of all legal moves that can be chosen.\n",
-      "\n",
-      "Observation: {'observation': array([  0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,   1.,   1.,\n",
-      "         0.,   0.,   1.,   0.,   0.,   0.,   0.,   0.,   8., 100.],\n",
-      "      dtype=float32), 'action_mask': array([1, 1, 0, 0, 0], dtype=int8)}\n",
-      "Reward: -1.0\n",
-      "Termination: True\n",
-      "Truncation: True\n",
-      "Return: -1.0\n",
-      "        \n",
-      "Action: None\n",
-      "\n",
-      "Observation: {'observation': array([  0.,   0.,   1.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,   1.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   1.,   0.,   0.,   0.,  20., 100.],\n",
-      "      dtype=float32), 'action_mask': array([1, 1, 0, 0, 0], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: True\n",
-      "Truncation: True\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: None\n",
-      "\n",
-      "Observation: {'observation': array([  0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,\n",
-      "         1.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,   1.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0., 100., 100.],\n",
-      "      dtype=float32), 'action_mask': array([1, 1, 0, 0, 0], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: True\n",
-      "Truncation: True\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: None\n",
-      "\n",
-      "Observation: {'observation': array([  0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   1.,   1.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   1.,   0.,   0.,   1.,   0.,\n",
-      "         0.,   0.,   0.,   0.,   0.,   0.,   0.,   0.,   2., 100.],\n",
-      "      dtype=float32), 'action_mask': array([1, 1, 0, 0, 0], dtype=int8)}\n",
-      "Reward: 0\n",
-      "Termination: True\n",
-      "Truncation: True\n",
-      "Return: 0\n",
-      "        \n",
-      "Action: None\n"
-     ]
-    }
-   ],
-   "source": [
-    "from pettingzoo.classic import texas_holdem_no_limit_v6\n",
-    "\n",
-    "env = texas_holdem_no_limit_v6.env(num_players=4, render_mode=\"human\")\n",
-    "agents = {\n",
-    "    name: ActionMaskAgent(name=name, model=ChatOpenAI(temperature=0.2), env=env)\n",
-    "    for name in env.possible_agents\n",
-    "}\n",
-    "main(agents, env)"
-   ]
-  }
- ],
- "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.16"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/plan_and_execute_agent.ipynb

@@ -1,257 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "0ddfef23-3c74-444c-81dd-6753722997fa",
-   "metadata": {},
-   "source": [
-    "# Plan-and-execute\n",
-    "\n",
-    "Plan-and-execute agents accomplish an objective by first planning what to do, then executing the sub tasks. This idea is largely inspired by [BabyAGI](https://github.com/yoheinakajima/babyagi) and then the [\"Plan-and-Solve\" paper](https://arxiv.org/abs/2305.04091).\n",
-    "\n",
-    "The planning is almost always done by an LLM.\n",
-    "\n",
-    "The execution is usually done by a separate agent (equipped with tools)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a7ecb22a-7009-48ec-b14e-f0fa5aac1cd0",
-   "metadata": {},
-   "source": [
-    "## Imports"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "5fbbd4ee-bfe8-4a25-afe4-8d1a552a3d2e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import LLMMathChain\n",
-    "from langchain_community.utilities import DuckDuckGoSearchAPIWrapper\n",
-    "from langchain_core.tools import Tool\n",
-    "from langchain_experimental.plan_and_execute import (\n",
-    "    PlanAndExecute,\n",
-    "    load_agent_executor,\n",
-    "    load_chat_planner,\n",
-    ")\n",
-    "from langchain_openai import ChatOpenAI, OpenAI"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e0e995e5-af9d-4988-bcd0-467a2a2e18cd",
-   "metadata": {},
-   "source": [
-    "## Tools"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "1d789f4e-54e3-4602-891a-f076e0ab9594",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "search = DuckDuckGoSearchAPIWrapper()\n",
-    "llm = OpenAI(temperature=0)\n",
-    "llm_math_chain = LLMMathChain.from_llm(llm=llm, verbose=True)\n",
-    "tools = [\n",
-    "    Tool(\n",
-    "        name=\"Search\",\n",
-    "        func=search.run,\n",
-    "        description=\"useful for when you need to answer questions about current events\",\n",
-    "    ),\n",
-    "    Tool(\n",
-    "        name=\"Calculator\",\n",
-    "        func=llm_math_chain.run,\n",
-    "        description=\"useful for when you need to answer questions about math\",\n",
-    "    ),\n",
-    "]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "04dc6452-a07f-49f9-be12-95be1e2afccc",
-   "metadata": {},
-   "source": [
-    "## Planner, Executor, and Agent\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "d8f49c03-c804-458b-8122-c92b26c7b7dd",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "model = ChatOpenAI(temperature=0)\n",
-    "planner = load_chat_planner(model)\n",
-    "executor = load_agent_executor(model, tools, verbose=True)\n",
-    "agent = PlanAndExecute(planner=planner, executor=executor)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "78ba03dd-0322-4927-b58d-a7e2027fdbb3",
-   "metadata": {},
-   "source": [
-    "## Run example"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "a57f7efe-7866-47a7-bce5-9c7b1047964e",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mAction:\n",
-      "{\n",
-      "  \"action\": \"Search\",\n",
-      "  \"action_input\": \"current prime minister of the UK\"\n",
-      "}\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mAction:\n",
-      "```\n",
-      "{\n",
-      "  \"action\": \"Search\",\n",
-      "  \"action_input\": \"current prime minister of the UK\"\n",
-      "}\n",
-      "```\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mBottom right: Rishi Sunak is the current prime minister and the first non-white prime minister. The prime minister of the United Kingdom is the principal minister of the crown of His Majesty's Government, and the head of the British Cabinet. 3 min. British Prime Minister Rishi Sunak asserted his stance on gender identity in a speech Wednesday, stating it was \"common sense\" that \"a man is a man and a woman is a woman\" — a ... The former chancellor Rishi Sunak is the UK's new prime minister. Here's what you need to know about him. He won after running for the second time this year He lost to Liz Truss in September,... Isaeli Prime Minister Benjamin Netanyahu spoke with US President Joe Biden on Wednesday, the prime minister's office said in a statement. Netanyahu \"thanked the President for the powerful words of ... By Yasmeen Serhan/London Updated: October 25, 2022 12:56 PM EDT | Originally published: October 24, 2022 9:17 AM EDT S top me if you've heard this one before: After a tumultuous period of political...\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3mThe search results indicate that Rishi Sunak is the current prime minister of the UK. However, it's important to note that this information may not be accurate or up to date.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mAction:\n",
-      "```\n",
-      "{\n",
-      "  \"action\": \"Search\",\n",
-      "  \"action_input\": \"current age of the prime minister of the UK\"\n",
-      "}\n",
-      "```\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mHow old is Rishi Sunak? Mr Sunak was born on 12 May, 1980, making him 42 years old. He first became an MP in 2015, aged 34, and has served the constituency of Richmond in Yorkshire ever since. He... Prime Ministers' ages when they took office From oldest to youngest, the ages of the PMs were as follows: Winston Churchill - 65 years old James Callaghan - 64 years old Clement Attlee - 62 years... Anna Kaufman USA TODAY Just a few days after Liz Truss resigned as prime minister, the UK has a new prime minister. Truss, who lasted a mere 45 days in office, will be replaced by Rishi... Advertisement Rishi Sunak is the youngest British prime minister of modern times. Mr. Sunak is 42 and started out in Parliament in 2015. Rishi Sunak was appointed as chancellor of the Exchequer... The first prime minister of the current United Kingdom of Great Britain and Northern Ireland upon its effective creation in 1922 (when 26 Irish counties seceded and created the Irish Free State) was Bonar Law, [10] although the country was not renamed officially until 1927, when Stanley Baldwin was the serving prime minister. [11]\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3mBased on the search results, it seems that Rishi Sunak is the current prime minister of the UK. However, I couldn't find any specific information about his age. Would you like me to search again for the current age of the prime minister?\n",
-      "\n",
-      "Action:\n",
-      "```\n",
-      "{\n",
-      "  \"action\": \"Search\",\n",
-      "  \"action_input\": \"age of Rishi Sunak\"\n",
-      "}\n",
-      "```\u001b[0m\n",
-      "Observation: \u001b[36;1m\u001b[1;3mRishi Sunak is 42 years old, making him the youngest person to hold the office of prime minister in modern times. How tall is Rishi Sunak? How Old Is Rishi Sunak? Rishi Sunak was born on May 12, 1980, in Southampton, England. Parents and Nationality Sunak's parents were born to Indian-origin families in East Africa before... Born on May 12, 1980, Rishi is currently 42 years old. He has been a member of parliament since 2015 where he was an MP for Richmond and has served in roles including Chief Secretary to the Treasury and the Chancellor of Exchequer while Boris Johnson was PM. Family Murty, 42, is the daughter of the Indian billionaire NR Narayana Murthy, often described as the Bill Gates of India, who founded the software company Infosys. According to reports, his... Sunak became the first non-White person to lead the country and, at age 42, the youngest to take on the role in more than a century. Like most politicians, Sunak is revered by some and...\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3mBased on the search results, Rishi Sunak is currently 42 years old. He was born on May 12, 1980.\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mThought: To calculate the age raised to the power of 0.43, I can use the calculator tool.\n",
-      "\n",
-      "Action:\n",
-      "```json\n",
-      "{\n",
-      "  \"action\": \"Calculator\",\n",
-      "  \"action_input\": \"42^0.43\"\n",
-      "}\n",
-      "```\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Entering new LLMMathChain chain...\u001b[0m\n",
-      "42^0.43\u001b[32;1m\u001b[1;3m```text\n",
-      "42**0.43\n",
-      "```\n",
-      "...numexpr.evaluate(\"42**0.43\")...\n",
-      "\u001b[0m\n",
-      "Answer: \u001b[33;1m\u001b[1;3m4.9888126515157\u001b[0m\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\n",
-      "Observation: \u001b[33;1m\u001b[1;3mAnswer: 4.9888126515157\u001b[0m\n",
-      "Thought:\u001b[32;1m\u001b[1;3mThe age raised to the power of 0.43 is approximately 4.9888126515157.\n",
-      "\n",
-      "Final Answer:\n",
-      "```json\n",
-      "{\n",
-      "  \"action\": \"Final Answer\",\n",
-      "  \"action_input\": \"The age raised to the power of 0.43 is approximately 4.9888126515157.\"\n",
-      "}\n",
-      "```\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n",
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mAction:\n",
-      "```\n",
-      "{\n",
-      "  \"action\": \"Final Answer\",\n",
-      "  \"action_input\": \"The current prime minister of the UK is Rishi Sunak. His age raised to the power of 0.43 is approximately 4.9888126515157.\"\n",
-      "}\n",
-      "```\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'The current prime minister of the UK is Rishi Sunak. His age raised to the power of 0.43 is approximately 4.9888126515157.'"
-      ]
-     },
-     "execution_count": 6,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "agent.run(\n",
-    "    \"Who is the current prime minister of the UK? What is their current age raised to the 0.43 power?\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0ef78a07-1a2a-46f8-9bc9-ae45f9bd706c",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "poetry-venv",
-   "language": "python",
-   "name": "poetry-venv"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.9.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/press_releases.ipynb

@@ -1,156 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "62ee82e4-2ad8-498b-8438-fac388afe1a2",
-   "metadata": {},
-   "source": [
-    "Press Releases Data\n",
-    "=\n",
-    "\n",
-    "Press Releases data powered by [Kay.ai](https://kay.ai).\n",
-    "\n",
-    ">Press releases are used by companies to announce something noteworthy, including product launches, financial performance reports, partnerships, and other significant news. They are widely used by analysts to track corporate strategy, operational updates and financial performance.\n",
-    "Kay.ai obtains press releases of all US public companies from a variety of sources, which include the company's official press room and partnerships with various data API providers. \n",
-    "This data is updated till Sept 30th for free access, if you want to access the real-time feed, reach out to us at hello@kay.ai or [tweet at us](https://twitter.com/vishalrohra_)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "8183d85d-365f-4672-a963-52b533547de0",
-   "metadata": {},
-   "source": [
-    "Setup\n",
-    "=\n",
-    "\n",
-    "First you will need to install the `kay` package. You will also need an API key: you can get one for free at [https://kay.ai](https://kay.ai/). Once you have an API key, you must set it as an environment variable `KAY_API_KEY`.\n",
-    "\n",
-    "In this example we're going to use the `KayAiRetriever`. Take a look at the [kay notebook](/docs/integrations/retrievers/kay) for more detailed information for the parmeters that it accepts."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "02ec21c7-49fe-4844-b58a-bf064ad40b2a",
-   "metadata": {},
-   "source": [
-    "Examples\n",
-    "="
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "bf0395f7-6ebe-4136-8b0d-00b9dea3becd",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdin",
-     "output_type": "stream",
-     "text": [
-      " ········\n",
-      " ········\n"
-     ]
-    }
-   ],
-   "source": [
-    "# Setup API keys for Kay and OpenAI\n",
-    "from getpass import getpass\n",
-    "\n",
-    "KAY_API_KEY = getpass()\n",
-    "OPENAI_API_KEY = getpass()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "f7fcaf70-29a4-444b-8f07-9784f808c300",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "os.environ[\"KAY_API_KEY\"] = KAY_API_KEY\n",
-    "os.environ[\"OPENAI_API_KEY\"] = OPENAI_API_KEY"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "ac00bf93-3635-4ffe-b9a6-a8b4f35c0c85",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.chains import ConversationalRetrievalChain\n",
-    "from langchain.retrievers import KayAiRetriever\n",
-    "from langchain_openai import ChatOpenAI\n",
-    "\n",
-    "model = ChatOpenAI(model=\"gpt-3.5-turbo\")\n",
-    "retriever = KayAiRetriever.create(\n",
-    "    dataset_id=\"company\", data_types=[\"PressRelease\"], num_contexts=6\n",
-    ")\n",
-    "qa = ConversationalRetrievalChain.from_llm(model, retriever=retriever)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "8d9d927c-35b2-4a7b-8ea7-4d0350797941",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "-> **Question**: How is the healthcare industry adopting generative AI tools? \n",
-      "\n",
-      "**Answer**: The healthcare industry is adopting generative AI tools to improve various aspects of patient care and administrative tasks. Companies like HCA Healthcare Inc, Amazon Com Inc, and Mayo Clinic have collaborated with technology providers like Google Cloud, AWS, and Microsoft to implement generative AI solutions.\n",
-      "\n",
-      "HCA Healthcare is testing a nurse handoff tool that generates draft reports quickly and accurately, which nurses have shown interest in using. They are also exploring the use of Google's medically-tuned Med-PaLM 2 LLM to support caregivers in asking complex medical questions.\n",
-      "\n",
-      "Amazon Web Services (AWS) has introduced AWS HealthScribe, a generative AI-powered service that automatically creates clinical documentation. However, integrating multiple AI systems into a cohesive solution requires significant engineering resources, including access to AI experts, healthcare data, and compute capacity.\n",
-      "\n",
-      "Mayo Clinic is among the first healthcare organizations to deploy Microsoft 365 Copilot, a generative AI service that combines large language models with organizational data from Microsoft 365. This tool has the potential to automate tasks like form-filling, relieving administrative burdens on healthcare providers and allowing them to focus more on patient care.\n",
-      "\n",
-      "Overall, the healthcare industry is recognizing the potential benefits of generative AI tools in improving efficiency, automating tasks, and enhancing patient care. \n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "# More sample questions in the Playground on https://kay.ai\n",
-    "questions = [\n",
-    "    \"How is the healthcare industry adopting generative AI tools?\",\n",
-    "    # \"What are some recent challenges faced by the renewable energy sector?\",\n",
-    "]\n",
-    "chat_history = []\n",
-    "\n",
-    "for question in questions:\n",
-    "    result = qa({\"question\": question, \"chat_history\": chat_history})\n",
-    "    chat_history.append((question, result[\"answer\"]))\n",
-    "    print(f\"-> **Question**: {question} \\n\")\n",
-    "    print(f\"**Answer**: {result['answer']} \\n\")"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.9.18"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/program_aided_language_model.ipynb

@@ -1,292 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "32e022a2",
-   "metadata": {},
-   "source": [
-    "# Program-aided language model (PAL) chain\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_experimental.pal_chain import PALChain\n",
-    "from langchain_openai import OpenAI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9a58e15e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = OpenAI(temperature=0, max_tokens=512)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "095adc76",
-   "metadata": {},
-   "source": [
-    "## Math Prompt"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "beddcac7",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "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": {
-    "scrolled": true
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new PALChain chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3mdef solution():\n",
-      "    \"\"\"Jan has three times the number of pets as Marcia. Marcia has two more pets than Cindy. If Cindy has four pets, how many total pets do the three have?\"\"\"\n",
-      "    cindy_pets = 4\n",
-      "    marcia_pets = cindy_pets + 2\n",
-      "    jan_pets = marcia_pets * 3\n",
-      "    total_pets = cindy_pets + marcia_pets + jan_pets\n",
-      "    result = total_pets\n",
-      "    return result\u001b[0m\n",
-      "\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": "markdown",
-   "id": "0269d20a",
-   "metadata": {},
-   "source": [
-    "## Colored Objects"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "e524f81f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "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 PALChain chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m# Put objects into a list to record ordering\n",
-      "objects = []\n",
-      "objects += [('booklet', 'blue')] * 2\n",
-      "objects += [('booklet', 'purple')] * 2\n",
-      "objects += [('sunglasses', 'yellow')] * 2\n",
-      "\n",
-      "# Remove all pairs of sunglasses\n",
-      "objects = [object for object in objects if object[0] != 'sunglasses']\n",
-      "\n",
-      "# Count number of purple objects\n",
-      "num_purple = len([object for object in objects if object[1] == 'purple'])\n",
-      "answer = num_purple\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished PALChain chain.\u001b[0m\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "'2'"
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "pal_chain.run(question)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fc3d7f10",
-   "metadata": {},
-   "source": [
-    "## Intermediate Steps\n",
-    "You can also use the intermediate steps flag to return the code executed that generates the answer."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "9d2d9c61",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "pal_chain = PALChain.from_colored_object_prompt(\n",
-    "    llm, verbose=True, return_intermediate_steps=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "b29b971b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "question = \"On the desk, you see two blue booklets, two purple booklets, and two yellow pairs of sunglasses. If I remove all the pairs of sunglasses from the desk, how many purple items remain on it?\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "a2c40c28",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "\u001b[1m> Entering new PALChain chain...\u001b[0m\n",
-      "\u001b[32;1m\u001b[1;3m# Put objects into a list to record ordering\n",
-      "objects = []\n",
-      "objects += [('booklet', 'blue')] * 2\n",
-      "objects += [('booklet', 'purple')] * 2\n",
-      "objects += [('sunglasses', 'yellow')] * 2\n",
-      "\n",
-      "# Remove all pairs of sunglasses\n",
-      "objects = [object for object in objects if object[0] != 'sunglasses']\n",
-      "\n",
-      "# Count number of purple objects\n",
-      "num_purple = len([object for object in objects if object[1] == 'purple'])\n",
-      "answer = num_purple\u001b[0m\n",
-      "\n",
-      "\u001b[1m> Finished chain.\u001b[0m\n"
-     ]
-    }
-   ],
-   "source": [
-    "result = pal_chain({\"question\": question})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "efddd033",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "\"# Put objects into a list to record ordering\\nobjects = []\\nobjects += [('booklet', 'blue')] * 2\\nobjects += [('booklet', 'purple')] * 2\\nobjects += [('sunglasses', 'yellow')] * 2\\n\\n# Remove all pairs of sunglasses\\nobjects = [object for object in objects if object[0] != 'sunglasses']\\n\\n# Count number of purple objects\\nnum_purple = len([object for object in objects if object[1] == 'purple'])\\nanswer = num_purple\""
-      ]
-     },
-     "execution_count": 11,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "result[\"intermediate_steps\"]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "dfd88594",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/qa_citations.ipynb

@@ -1,179 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "9b5c258f",
-   "metadata": {},
-   "source": [
-    "# Citing retrieval sources\n",
-    "\n",
-    "This notebook shows how to use OpenAI functions ability to extract citations from text."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "eae4ca3e",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/Users/harrisonchase/.pyenv/versions/3.9.1/envs/langchain/lib/python3.9/site-packages/deeplake/util/check_latest_version.py:32: UserWarning: A newer version of deeplake (3.6.4) is available. It's recommended that you update to the latest version using `pip install -U deeplake`.\n",
-      "  warnings.warn(\n"
-     ]
-    }
-   ],
-   "source": [
-    "from langchain.chains import create_citation_fuzzy_match_chain\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "id": "2c6e62ee",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "question = \"What did the author do during college?\"\n",
-    "context = \"\"\"\n",
-    "My name is Jason Liu, and I grew up in Toronto Canada but I was born in China.\n",
-    "I went to an arts highschool but in university I studied Computational Mathematics and physics. \n",
-    "As part of coop I worked at many companies including Stitchfix, Facebook.\n",
-    "I also started the Data Science club at the University of Waterloo and I was the president of the club for 2 years.\n",
-    "\"\"\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "078e0300",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = ChatOpenAI(temperature=0, model=\"gpt-3.5-turbo-0613\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "02cad6d0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain = create_citation_fuzzy_match_chain(llm)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "e3c6e7ba",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "result = chain.run(question=question, context=context)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "6f7615f2",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "question='What did the author do during college?' answer=[FactWithEvidence(fact='The author studied Computational Mathematics and physics in university.', substring_quote=['in university I studied Computational Mathematics and physics']), FactWithEvidence(fact='The author started the Data Science club at the University of Waterloo and was the president of the club for 2 years.', substring_quote=['started the Data Science club at the University of Waterloo', 'president of the club for 2 years'])]\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(result)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "3be6f366",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def highlight(text, span):\n",
-    "    return (\n",
-    "        \"...\"\n",
-    "        + text[span[0] - 20 : span[0]]\n",
-    "        + \"*\"\n",
-    "        + \"\\033[91m\"\n",
-    "        + text[span[0] : span[1]]\n",
-    "        + \"\\033[0m\"\n",
-    "        + \"*\"\n",
-    "        + text[span[1] : span[1] + 20]\n",
-    "        + \"...\"\n",
-    "    )"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "636c4528",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Statement: The author studied Computational Mathematics and physics in university.\n",
-      "Citation: ...arts highschool but *\u001b[91min university I studied Computational Mathematics and physics\u001b[0m*. \n",
-      "As part of coop I...\n",
-      "\n",
-      "Statement: The author started the Data Science club at the University of Waterloo and was the president of the club for 2 years.\n",
-      "Citation: ...x, Facebook.\n",
-      "I also *\u001b[91mstarted the Data Science club at the University of Waterloo\u001b[0m* and I was the presi...\n",
-      "Citation: ...erloo and I was the *\u001b[91mpresident of the club for 2 years\u001b[0m*.\n",
-      "...\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "for fact in result.answer:\n",
-    "    print(\"Statement:\", fact.fact)\n",
-    "    for span in fact.get_spans(context):\n",
-    "        print(\"Citation:\", highlight(context, span))\n",
-    "    print()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "8409cab0",
-   "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
-}

cookbook/qianfan_baidu_elasticesearch_RAG.ipynb

@@ -1,193 +0,0 @@
-{
- "cells": [
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# RAG based on Qianfan and BES"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "This notebook is an implementation of Retrieval augmented generation (RAG) using Baidu Qianfan Platform combined with Baidu ElasricSearch, where the original data is located on BOS.\n",
-    "## Baidu Qianfan\n",
-    "Baidu AI Cloud Qianfan Platform is a one-stop large model development and service operation platform for enterprise developers. Qianfan not only provides including the model of Wenxin Yiyan (ERNIE-Bot) and the third-party open-source models, but also provides various AI development tools and the whole set of development environment, which facilitates customers to use and develop large model applications easily.\n",
-    "\n",
-    "## Baidu ElasticSearch\n",
-    "[Baidu Cloud VectorSearch](https://cloud.baidu.com/doc/BES/index.html?from=productToDoc) is a fully managed, enterprise-level distributed search and analysis service which is 100% compatible to open source. Baidu Cloud VectorSearch provides low-cost, high-performance, and reliable retrieval and analysis platform level product services for structured/unstructured data. As a vector database , it supports multiple index types and similarity distance methods. "
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Installation and Setup\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "#!pip install qianfan\n",
-    "#!pip install bce-python-sdk\n",
-    "#!pip install elasticsearch == 7.11.0\n",
-    "#!pip install sentence-transformers"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Imports"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import sentence_transformers\n",
-    "from baidubce.auth.bce_credentials import BceCredentials\n",
-    "from baidubce.bce_client_configuration import BceClientConfiguration\n",
-    "from langchain.chains.retrieval_qa import RetrievalQA\n",
-    "from langchain_community.document_loaders.baiducloud_bos_directory import (\n",
-    "    BaiduBOSDirectoryLoader,\n",
-    ")\n",
-    "from langchain_community.embeddings.huggingface import HuggingFaceEmbeddings\n",
-    "from langchain_community.llms.baidu_qianfan_endpoint import QianfanLLMEndpoint\n",
-    "from langchain_community.vectorstores import BESVectorStore\n",
-    "from langchain_text_splitters import RecursiveCharacterTextSplitter"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Document loading"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "bos_host = \"your bos eddpoint\"\n",
-    "access_key_id = \"your bos access ak\"\n",
-    "secret_access_key = \"your bos access sk\"\n",
-    "\n",
-    "# create BceClientConfiguration\n",
-    "config = BceClientConfiguration(\n",
-    "    credentials=BceCredentials(access_key_id, secret_access_key), endpoint=bos_host\n",
-    ")\n",
-    "\n",
-    "loader = BaiduBOSDirectoryLoader(conf=config, bucket=\"llm-test\", prefix=\"llm/\")\n",
-    "documents = loader.load()\n",
-    "\n",
-    "text_splitter = RecursiveCharacterTextSplitter(chunk_size=200, chunk_overlap=0)\n",
-    "split_docs = text_splitter.split_documents(documents)"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Embedding and VectorStore"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "embeddings = HuggingFaceEmbeddings(model_name=\"shibing624/text2vec-base-chinese\")\n",
-    "embeddings.client = sentence_transformers.SentenceTransformer(embeddings.model_name)\n",
-    "\n",
-    "db = BESVectorStore.from_documents(\n",
-    "    documents=split_docs,\n",
-    "    embedding=embeddings,\n",
-    "    bes_url=\"your bes url\",\n",
-    "    index_name=\"test-index\",\n",
-    "    vector_query_field=\"vector\",\n",
-    ")\n",
-    "\n",
-    "db.client.indices.refresh(index=\"test-index\")\n",
-    "retriever = db.as_retriever()"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## QA Retriever"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "llm = QianfanLLMEndpoint(\n",
-    "    model=\"ERNIE-Bot\",\n",
-    "    qianfan_ak=\"your qianfan ak\",\n",
-    "    qianfan_sk=\"your qianfan sk\",\n",
-    "    streaming=True,\n",
-    ")\n",
-    "qa = RetrievalQA.from_chain_type(\n",
-    "    llm=llm, chain_type=\"refine\", retriever=retriever, return_source_documents=True\n",
-    ")\n",
-    "\n",
-    "query = \"什么是张量?\"\n",
-    "print(qa.run(query))"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "> 张量（Tensor）是一个数学概念，用于表示多维数据。它是一个可以表示多个数值的数组，可以是标量、向量、矩阵等。在深度学习和人工智能领域中，张量常用于表示神经网络的输入、输出和权重等。"
-   ]
-  }
- ],
- "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.12"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "aee8b7b246df8f9039afb4144a1f6fd8d2ca17a180786b69acc140d282b71a49"
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

cookbook/rag-locally-on-intel-cpu.ipynb

@@ -1,759 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "10f50955-be55-422f-8c62-3a32f8cf02ed",
-   "metadata": {},
-   "source": [
-    "# RAG application running locally on Intel Xeon CPU using langchain and open-source models"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "48113be6-44bb-4aac-aed3-76a1365b9561",
-   "metadata": {},
-   "source": [
-    "Author - Pratool Bharti (pratool.bharti@intel.com)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "8b10b54b-1572-4ea1-9c1e-1d29fcc3dcd9",
-   "metadata": {},
-   "source": [
-    "In this cookbook, we use langchain tools and open source models to execute locally on CPU. This notebook has been validated to run on Intel Xeon 8480+ CPU. Here we implement a RAG pipeline for Llama2 model to answer questions about Intel Q1 2024 earnings release."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "acadbcec-3468-4926-8ce5-03b678041c0a",
-   "metadata": {},
-   "source": [
-    "**Create a conda or virtualenv environment with python >=3.10 and install following libraries**\n",
-    "<br>\n",
-    "\n",
-    "`pip install --upgrade langchain langchain-community langchainhub langchain-chroma bs4 gpt4all pypdf pysqlite3-binary` <br>\n",
-    "`pip install llama-cpp-python   --extra-index-url https://abetlen.github.io/llama-cpp-python/whl/cpu`"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "84c392c8-700a-42ec-8e94-806597f22e43",
-   "metadata": {},
-   "source": [
-    "**Load pysqlite3 in sys modules since ChromaDB requires sqlite3.**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "145cd491-b388-4ea7-bdc8-2f4995cac6fd",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "__import__(\"pysqlite3\")\n",
-    "import sys\n",
-    "\n",
-    "sys.modules[\"sqlite3\"] = sys.modules.pop(\"pysqlite3\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "14dde7e2-b236-49b9-b3a0-08c06410418c",
-   "metadata": {},
-   "source": [
-    "**Import essential components from langchain to load and split data**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "887643ba-249e-48d6-9aa7-d25087e8dfbf",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.text_splitter import RecursiveCharacterTextSplitter\n",
-    "from langchain_community.document_loaders import PyPDFLoader"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "922c0eba-8736-4de5-bd2f-3d0f00b16e43",
-   "metadata": {},
-   "source": [
-    "**Download Intel Q1 2024 earnings release**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "id": "2d6a2419-5338-4188-8615-a40a65ff8019",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "--2024-07-15 15:04:43--  https://d1io3yog0oux5.cloudfront.net/_11d435a500963f99155ee058df09f574/intel/db/887/9014/earnings_release/Q1+24_EarningsRelease_FINAL.pdf\n",
-      "Resolving proxy-dmz.intel.com (proxy-dmz.intel.com)... 10.7.211.16\n",
-      "Connecting to proxy-dmz.intel.com (proxy-dmz.intel.com)|10.7.211.16|:912... connected.\n",
-      "Proxy request sent, awaiting response... 200 OK\n",
-      "Length: 133510 (130K) [application/pdf]\n",
-      "Saving to: ‘intel_q1_2024_earnings.pdf’\n",
-      "\n",
-      "intel_q1_2024_earni 100%[===================>] 130.38K  --.-KB/s    in 0.005s  \n",
-      "\n",
-      "2024-07-15 15:04:44 (24.6 MB/s) - ‘intel_q1_2024_earnings.pdf’ saved [133510/133510]\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "!wget  'https://d1io3yog0oux5.cloudfront.net/_11d435a500963f99155ee058df09f574/intel/db/887/9014/earnings_release/Q1+24_EarningsRelease_FINAL.pdf' -O intel_q1_2024_earnings.pdf"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e3612627-e105-453d-8a50-bbd6e39dedb5",
-   "metadata": {},
-   "source": [
-    "**Loading earning release pdf document through PyPDFLoader**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "cac6278e-ebad-4224-a062-bf6daca24cb0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "loader = PyPDFLoader(\"intel_q1_2024_earnings.pdf\")\n",
-    "data = loader.load()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a7dca43b-1c62-41df-90c7-6ed2904f823d",
-   "metadata": {},
-   "source": [
-    "**Splitting entire document in several chunks with each chunk size is 500 tokens**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 6,
-   "id": "4486adbe-0d0e-4685-8c08-c1774ed6e993",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "text_splitter = RecursiveCharacterTextSplitter(chunk_size=500, chunk_overlap=0)\n",
-    "all_splits = text_splitter.split_documents(data)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "af142346-e793-4a52-9a56-63e3be416b3d",
-   "metadata": {},
-   "source": [
-    "**Looking at the first split of the document**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "e4240fd1-898e-4bfc-a377-02c9bc25b56e",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "Document(metadata={'source': 'intel_q1_2024_earnings.pdf', 'page': 0}, page_content='Intel Corporation\\n2200 Mission College Blvd.\\nSanta Clara, CA 95054-1549\\n                                                         \\nNews Release\\n Intel Reports First -Quarter 2024  Financial Results\\nNEWS SUMMARY\\n▪First-quarter revenue of $12.7 billion , up 9%  year over year (YoY).\\n▪First-quarter GAAP earnings (loss) per share (EPS) attributable to Intel was $(0.09) ; non-GAAP EPS \\nattributable to Intel was $0.18 .')"
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "all_splits[0]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "b88d2632-7c1b-49ef-a691-c0eb67d23e6a",
-   "metadata": {},
-   "source": [
-    "**One of the major step in RAG is to convert each split of document into embeddings and store in a vector database such that searching relevant documents are efficient.** <br>\n",
-    "**For that, importing Chroma vector database from langchain. Also, importing open source GPT4All for embedding models**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 8,
-   "id": "9ff99dd7-9d47-4239-ba0a-d775792334ba",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_chroma import Chroma\n",
-    "from langchain_community.embeddings import GPT4AllEmbeddings"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "b5d1f4dd-dd8d-4a20-95d1-2dbdd204375a",
-   "metadata": {},
-   "source": [
-    "**In next step, we will download one of the most popular embedding model \"all-MiniLM-L6-v2\". Find more details of the model at this link https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 10,
-   "id": "05db3494-5d8e-4a13-9941-26330a86f5e5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "model_name = \"all-MiniLM-L6-v2.gguf2.f16.gguf\"\n",
-    "gpt4all_kwargs = {\"allow_download\": \"True\"}\n",
-    "embeddings = GPT4AllEmbeddings(model_name=model_name, gpt4all_kwargs=gpt4all_kwargs)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "4e53999e-1983-46ac-8039-2783e194c3ae",
-   "metadata": {},
-   "source": [
-    "**Store all the embeddings in the Chroma database**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 11,
-   "id": "0922951a-9ddf-4761-973d-8e9a86f61284",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "vectorstore = Chroma.from_documents(documents=all_splits, embedding=embeddings)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "29f94fa0-6c75-4a65-a1a3-debc75422479",
-   "metadata": {},
-   "source": [
-    "**Now, let's find relevant splits from the documents related to the question**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 12,
-   "id": "88c8152d-ec7a-4f0b-9d86-877789407537",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "4\n"
-     ]
-    }
-   ],
-   "source": [
-    "question = \"What is Intel CCG revenue in Q1 2024\"\n",
-    "docs = vectorstore.similarity_search(question)\n",
-    "print(len(docs))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "53330c6b-cb0f-43f9-b379-2e57ac1e5335",
-   "metadata": {},
-   "source": [
-    "**Look at the first retrieved document from the vector database**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 13,
-   "id": "43a6d94f-b5c4-47b0-a353-2db4c3d24d9c",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "Document(metadata={'page': 1, 'source': 'intel_q1_2024_earnings.pdf'}, page_content='Client Computing Group (CCG) $7.5 billion up31%\\nData Center and AI (DCAI) $3.0 billion up5%\\nNetwork and Edge (NEX) $1.4 billion down 8%\\nTotal Intel Products revenue $11.9 billion up17%\\nIntel Foundry $4.4 billion down 10%\\nAll other:\\nAltera $342 million down 58%\\nMobileye $239 million down 48%\\nOther $194 million up17%\\nTotal all other revenue $775 million down 46%\\nIntersegment eliminations $(4.4) billion\\nTotal net revenue $12.7 billion up9%\\nIntel Products Highlights')"
-      ]
-     },
-     "execution_count": 13,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "docs[0]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "64ba074f-4b36-442e-b7e2-b26d6e2815c3",
-   "metadata": {},
-   "source": [
-    "**Download Lllama-2 model from Huggingface and store locally** <br>\n",
-    "**You can download different quantization variant of Lllama-2 model from the link below. We are using Q8 version here (7.16GB).** <br>\n",
-    "https://huggingface.co/TheBloke/Llama-2-7B-Chat-GGUF"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "c8dd0811-6f43-4bc6-b854-2ab377639c9a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!huggingface-cli download TheBloke/Llama-2-7b-Chat-GGUF llama-2-7b-chat.Q8_0.gguf --local-dir . --local-dir-use-symlinks False"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "3895b1f5-f51d-4539-abf0-af33d7ca48ea",
-   "metadata": {},
-   "source": [
-    "**Import langchain components required to load downloaded LLMs model**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 14,
-   "id": "fb087088-aa62-44c0-8356-061e9b9f1186",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.callbacks.manager import CallbackManager\n",
-    "from langchain.callbacks.streaming_stdout import StreamingStdOutCallbackHandler\n",
-    "from langchain_community.llms import LlamaCpp"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "5a8a111e-2614-4b70-b034-85cd3e7304cb",
-   "metadata": {},
-   "source": [
-    "**Loading the local Lllama-2 model using Llama-cpp library**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 16,
-   "id": "fb917da2-c0d7-4995-b56d-26254276e0da",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "llama_model_loader: loaded meta data with 19 key-value pairs and 291 tensors from llama-2-7b-chat.Q8_0.gguf (version GGUF V2)\n",
-      "llama_model_loader: Dumping metadata keys/values. Note: KV overrides do not apply in this output.\n",
-      "llama_model_loader: - kv   0:                       general.architecture str              = llama\n",
-      "llama_model_loader: - kv   1:                               general.name str              = LLaMA v2\n",
-      "llama_model_loader: - kv   2:                       llama.context_length u32              = 4096\n",
-      "llama_model_loader: - kv   3:                     llama.embedding_length u32              = 4096\n",
-      "llama_model_loader: - kv   4:                          llama.block_count u32              = 32\n",
-      "llama_model_loader: - kv   5:                  llama.feed_forward_length u32              = 11008\n",
-      "llama_model_loader: - kv   6:                 llama.rope.dimension_count u32              = 128\n",
-      "llama_model_loader: - kv   7:                 llama.attention.head_count u32              = 32\n",
-      "llama_model_loader: - kv   8:              llama.attention.head_count_kv u32              = 32\n",
-      "llama_model_loader: - kv   9:     llama.attention.layer_norm_rms_epsilon f32              = 0.000001\n",
-      "llama_model_loader: - kv  10:                          general.file_type u32              = 7\n",
-      "llama_model_loader: - kv  11:                       tokenizer.ggml.model str              = llama\n",
-      "llama_model_loader: - kv  12:                      tokenizer.ggml.tokens arr[str,32000]   = [\"<unk>\", \"<s>\", \"</s>\", \"<0x00>\", \"<...\n",
-      "llama_model_loader: - kv  13:                      tokenizer.ggml.scores arr[f32,32000]   = [0.000000, 0.000000, 0.000000, 0.0000...\n",
-      "llama_model_loader: - kv  14:                  tokenizer.ggml.token_type arr[i32,32000]   = [2, 3, 3, 6, 6, 6, 6, 6, 6, 6, 6, 6, ...\n",
-      "llama_model_loader: - kv  15:                tokenizer.ggml.bos_token_id u32              = 1\n",
-      "llama_model_loader: - kv  16:                tokenizer.ggml.eos_token_id u32              = 2\n",
-      "llama_model_loader: - kv  17:            tokenizer.ggml.unknown_token_id u32              = 0\n",
-      "llama_model_loader: - kv  18:               general.quantization_version u32              = 2\n",
-      "llama_model_loader: - type  f32:   65 tensors\n",
-      "llama_model_loader: - type q8_0:  226 tensors\n",
-      "llm_load_vocab: special tokens cache size = 259\n",
-      "llm_load_vocab: token to piece cache size = 0.1684 MB\n",
-      "llm_load_print_meta: format           = GGUF V2\n",
-      "llm_load_print_meta: arch             = llama\n",
-      "llm_load_print_meta: vocab type       = SPM\n",
-      "llm_load_print_meta: n_vocab          = 32000\n",
-      "llm_load_print_meta: n_merges         = 0\n",
-      "llm_load_print_meta: vocab_only       = 0\n",
-      "llm_load_print_meta: n_ctx_train      = 4096\n",
-      "llm_load_print_meta: n_embd           = 4096\n",
-      "llm_load_print_meta: n_layer          = 32\n",
-      "llm_load_print_meta: n_head           = 32\n",
-      "llm_load_print_meta: n_head_kv        = 32\n",
-      "llm_load_print_meta: n_rot            = 128\n",
-      "llm_load_print_meta: n_swa            = 0\n",
-      "llm_load_print_meta: n_embd_head_k    = 128\n",
-      "llm_load_print_meta: n_embd_head_v    = 128\n",
-      "llm_load_print_meta: n_gqa            = 1\n",
-      "llm_load_print_meta: n_embd_k_gqa     = 4096\n",
-      "llm_load_print_meta: n_embd_v_gqa     = 4096\n",
-      "llm_load_print_meta: f_norm_eps       = 0.0e+00\n",
-      "llm_load_print_meta: f_norm_rms_eps   = 1.0e-06\n",
-      "llm_load_print_meta: f_clamp_kqv      = 0.0e+00\n",
-      "llm_load_print_meta: f_max_alibi_bias = 0.0e+00\n",
-      "llm_load_print_meta: f_logit_scale    = 0.0e+00\n",
-      "llm_load_print_meta: n_ff             = 11008\n",
-      "llm_load_print_meta: n_expert         = 0\n",
-      "llm_load_print_meta: n_expert_used    = 0\n",
-      "llm_load_print_meta: causal attn      = 1\n",
-      "llm_load_print_meta: pooling type     = 0\n",
-      "llm_load_print_meta: rope type        = 0\n",
-      "llm_load_print_meta: rope scaling     = linear\n",
-      "llm_load_print_meta: freq_base_train  = 10000.0\n",
-      "llm_load_print_meta: freq_scale_train = 1\n",
-      "llm_load_print_meta: n_ctx_orig_yarn  = 4096\n",
-      "llm_load_print_meta: rope_finetuned   = unknown\n",
-      "llm_load_print_meta: ssm_d_conv       = 0\n",
-      "llm_load_print_meta: ssm_d_inner      = 0\n",
-      "llm_load_print_meta: ssm_d_state      = 0\n",
-      "llm_load_print_meta: ssm_dt_rank      = 0\n",
-      "llm_load_print_meta: model type       = 7B\n",
-      "llm_load_print_meta: model ftype      = Q8_0\n",
-      "llm_load_print_meta: model params     = 6.74 B\n",
-      "llm_load_print_meta: model size       = 6.67 GiB (8.50 BPW) \n",
-      "llm_load_print_meta: general.name     = LLaMA v2\n",
-      "llm_load_print_meta: BOS token        = 1 '<s>'\n",
-      "llm_load_print_meta: EOS token        = 2 '</s>'\n",
-      "llm_load_print_meta: UNK token        = 0 '<unk>'\n",
-      "llm_load_print_meta: LF token         = 13 '<0x0A>'\n",
-      "llm_load_print_meta: max token length = 48\n",
-      "llm_load_tensors: ggml ctx size =    0.14 MiB\n",
-      "llm_load_tensors:        CPU buffer size =  6828.64 MiB\n",
-      "...................................................................................................\n",
-      "llama_new_context_with_model: n_ctx      = 2048\n",
-      "llama_new_context_with_model: n_batch    = 512\n",
-      "llama_new_context_with_model: n_ubatch   = 512\n",
-      "llama_new_context_with_model: flash_attn = 0\n",
-      "llama_new_context_with_model: freq_base  = 10000.0\n",
-      "llama_new_context_with_model: freq_scale = 1\n",
-      "llama_kv_cache_init:        CPU KV buffer size =  1024.00 MiB\n",
-      "llama_new_context_with_model: KV self size  = 1024.00 MiB, K (f16):  512.00 MiB, V (f16):  512.00 MiB\n",
-      "llama_new_context_with_model:        CPU  output buffer size =     0.12 MiB\n",
-      "llama_new_context_with_model:        CPU compute buffer size =   164.01 MiB\n",
-      "llama_new_context_with_model: graph nodes  = 1030\n",
-      "llama_new_context_with_model: graph splits = 1\n",
-      "AVX = 1 | AVX_VNNI = 0 | AVX2 = 1 | AVX512 = 0 | AVX512_VBMI = 0 | AVX512_VNNI = 0 | AVX512_BF16 = 0 | FMA = 1 | NEON = 0 | SVE = 0 | ARM_FMA = 0 | F16C = 1 | FP16_VA = 0 | WASM_SIMD = 0 | BLAS = 0 | SSE3 = 1 | SSSE3 = 1 | VSX = 0 | MATMUL_INT8 = 0 | LLAMAFILE = 0 | \n",
-      "Model metadata: {'tokenizer.ggml.unknown_token_id': '0', 'tokenizer.ggml.eos_token_id': '2', 'general.architecture': 'llama', 'llama.context_length': '4096', 'general.name': 'LLaMA v2', 'llama.embedding_length': '4096', 'llama.feed_forward_length': '11008', 'llama.attention.layer_norm_rms_epsilon': '0.000001', 'llama.rope.dimension_count': '128', 'llama.attention.head_count': '32', 'tokenizer.ggml.bos_token_id': '1', 'llama.block_count': '32', 'llama.attention.head_count_kv': '32', 'general.quantization_version': '2', 'tokenizer.ggml.model': 'llama', 'general.file_type': '7'}\n",
-      "Using fallback chat format: llama-2\n"
-     ]
-    }
-   ],
-   "source": [
-    "llm = LlamaCpp(\n",
-    "    model_path=\"llama-2-7b-chat.Q8_0.gguf\",\n",
-    "    n_gpu_layers=-1,\n",
-    "    n_batch=512,\n",
-    "    n_ctx=2048,\n",
-    "    f16_kv=True,  # MUST set to True, otherwise you will run into problem after a couple of calls\n",
-    "    callback_manager=CallbackManager([StreamingStdOutCallbackHandler()]),\n",
-    "    verbose=True,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "43e06f56-ef97-451b-87d9-8465ea442aed",
-   "metadata": {},
-   "source": [
-    "**Now let's ask the same question to Llama model without showing them the earnings release.**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 17,
-   "id": "1033dd82-5532-437d-a548-27695e109589",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "?\n",
-      "(NASDAQ:INTC)\n",
-      "Intel's CCG (Client Computing Group) revenue for Q1 2024 was $9.6 billion, a decrease of 35% from the previous quarter and a decrease of 42% from the same period last year."
-     ]
-    },
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "llama_print_timings:        load time =     131.20 ms\n",
-      "llama_print_timings:      sample time =      16.05 ms /    68 runs   (    0.24 ms per token,  4236.76 tokens per second)\n",
-      "llama_print_timings: prompt eval time =     131.14 ms /    16 tokens (    8.20 ms per token,   122.01 tokens per second)\n",
-      "llama_print_timings:        eval time =    3225.00 ms /    67 runs   (   48.13 ms per token,    20.78 tokens per second)\n",
-      "llama_print_timings:       total time =    3466.40 ms /    83 tokens\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "\"?\\n(NASDAQ:INTC)\\nIntel's CCG (Client Computing Group) revenue for Q1 2024 was $9.6 billion, a decrease of 35% from the previous quarter and a decrease of 42% from the same period last year.\""
-      ]
-     },
-     "execution_count": 17,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "llm.invoke(question)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "75f5cb10-746f-4e37-9386-b85a4d2b84ef",
-   "metadata": {},
-   "source": [
-    "**As you can see, model is giving wrong information. Correct asnwer is CCG revenue in Q1 2024 is $7.5B. Now let's apply RAG using the earning release document**"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "0f4150ec-5692-4756-b11a-22feb7ab88ff",
-   "metadata": {},
-   "source": [
-    "**in RAG, we modify the input prompt by adding relevent documents with the question. Here, we use one of the popular RAG prompt**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 18,
-   "id": "226c14b0-f43e-4a1f-a1e4-04731d467ec4",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[HumanMessagePromptTemplate(prompt=PromptTemplate(input_variables=['context', 'question'], template=\"You are an assistant for question-answering tasks. Use the following pieces of retrieved context to answer the question. If you don't know the answer, just say that you don't know. Use three sentences maximum and keep the answer concise.\\nQuestion: {question} \\nContext: {context} \\nAnswer:\"))]"
-      ]
-     },
-     "execution_count": 18,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from langchain import hub\n",
-    "\n",
-    "rag_prompt = hub.pull(\"rlm/rag-prompt\")\n",
-    "rag_prompt.messages"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "77deb6a0-0950-450a-916a-f2a029676c20",
-   "metadata": {},
-   "source": "**Appending all retrieved documents in a single document**"
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 19,
-   "id": "2dbc3327-6ef3-4c1f-8797-0c71964b0921",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def format_docs(docs):\n",
-    "    return \"\\n\\n\".join(doc.page_content for doc in docs)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2e2d9f18-49d0-43a3-bea8-78746ffa86b7",
-   "metadata": {},
-   "source": [
-    "**The last step is to create a chain using langchain tool that will create an e2e pipeline. It will take question and context as an input.**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 20,
-   "id": "427379c2-51ff-4e0f-8278-a45221363299",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_core.output_parsers import StrOutputParser\n",
-    "from langchain_core.runnables import RunnablePassthrough, RunnablePick\n",
-    "\n",
-    "# Chain\n",
-    "chain = (\n",
-    "    RunnablePassthrough.assign(context=RunnablePick(\"context\") | format_docs)\n",
-    "    | rag_prompt\n",
-    "    | llm\n",
-    "    | StrOutputParser()\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 21,
-   "id": "095d6280-c949-4d00-8e32-8895a82d245f",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "Llama.generate: prefix-match hit\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      " Based on the provided context, Intel CCG revenue in Q1 2024 was $7.5 billion up 31%."
-     ]
-    },
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "llama_print_timings:        load time =     131.20 ms\n",
-      "llama_print_timings:      sample time =       7.74 ms /    31 runs   (    0.25 ms per token,  4004.13 tokens per second)\n",
-      "llama_print_timings: prompt eval time =    2529.41 ms /   674 tokens (    3.75 ms per token,   266.46 tokens per second)\n",
-      "llama_print_timings:        eval time =    1542.94 ms /    30 runs   (   51.43 ms per token,    19.44 tokens per second)\n",
-      "llama_print_timings:       total time =    4123.68 ms /   704 tokens\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' Based on the provided context, Intel CCG revenue in Q1 2024 was $7.5 billion up 31%.'"
-      ]
-     },
-     "execution_count": 21,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain.invoke({\"context\": docs, \"question\": question})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "638364b2-6bd2-4471-9961-d3a1d1b9d4ee",
-   "metadata": {},
-   "source": [
-    "**Now we see the results are correct as it is mentioned in earnings release.** <br>\n",
-    "**To further automate, we will create a chain that will take input as question and retriever so that we don't need to retrieve documents separately**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 22,
-   "id": "4654e5b7-635f-4767-8b31-4c430164cdd5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "retriever = vectorstore.as_retriever()\n",
-    "qa_chain = (\n",
-    "    {\"context\": retriever | format_docs, \"question\": RunnablePassthrough()}\n",
-    "    | rag_prompt\n",
-    "    | llm\n",
-    "    | StrOutputParser()\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "0979f393-fd0a-4e82-b844-68371c6ad68f",
-   "metadata": {},
-   "source": [
-    "**Now we only need to pass the question to the chain and it will fetch the contexts directly from the vector database to generate the answer**\n",
-    "<br>\n",
-    "**Let's try with another question**"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 26,
-   "id": "3ea07b82-e6ec-4084-85f4-191373530172",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "Llama.generate: prefix-match hit\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      " According to the provided context, Intel DCAI revenue in Q1 2024 was $3.0 billion up 5%."
-     ]
-    },
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "llama_print_timings:        load time =     131.20 ms\n",
-      "llama_print_timings:      sample time =       6.28 ms /    31 runs   (    0.20 ms per token,  4937.88 tokens per second)\n",
-      "llama_print_timings: prompt eval time =    2681.93 ms /   730 tokens (    3.67 ms per token,   272.19 tokens per second)\n",
-      "llama_print_timings:        eval time =    1471.07 ms /    30 runs   (   49.04 ms per token,    20.39 tokens per second)\n",
-      "llama_print_timings:       total time =    4206.77 ms /   760 tokens\n"
-     ]
-    },
-    {
-     "data": {
-      "text/plain": [
-       "' According to the provided context, Intel DCAI revenue in Q1 2024 was $3.0 billion up 5%.'"
-      ]
-     },
-     "execution_count": 26,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "qa_chain.invoke(\"what is Intel DCAI revenue in Q1 2024?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9407f2a0-4a35-4315-8e96-02fcb80f210c",
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3.11.1 64-bit",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3",
-   "version": "3.11.1"
-  },
-  "vscode": {
-   "interpreter": {
-    "hash": "1a1af0ee75eeea9e2e1ee996c87e7a2b11a0bebd85af04bb136d915cefc0abce"
-   }
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

cookbook/rag_fusion.ipynb

@@ -1,270 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "993c2768",
-   "metadata": {},
-   "source": [
-    "# RAG Fusion\n",
-    "\n",
-    "Re-implemented from [this GitHub repo](https://github.com/Raudaschl/rag-fusion), all credit to original author\n",
-    "\n",
-    "> RAG-Fusion, a search methodology that aims to bridge the gap between traditional search paradigms and the multifaceted dimensions of human queries. Inspired by the capabilities of Retrieval Augmented Generation (RAG), this project goes a step further by employing multiple query generation and Reciprocal Rank Fusion to re-rank search results."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ebcc6791",
-   "metadata": {},
-   "source": [
-    "## Setup\n",
-    "\n",
-    "For this example, we will use Pinecone and some fake data. To configure Pinecone, set the following environment variable:\n",
-    "\n",
-    "- `PINECONE_API_KEY`: Your Pinecone API key"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "661a1c36",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_openai import OpenAIEmbeddings\n",
-    "from langchain_pinecone import PineconeVectorStore"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "48ef7e93",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "all_documents = {\n",
-    "    \"doc1\": \"Climate change and economic impact.\",\n",
-    "    \"doc2\": \"Public health concerns due to climate change.\",\n",
-    "    \"doc3\": \"Climate change: A social perspective.\",\n",
-    "    \"doc4\": \"Technological solutions to climate change.\",\n",
-    "    \"doc5\": \"Policy changes needed to combat climate change.\",\n",
-    "    \"doc6\": \"Climate change and its impact on biodiversity.\",\n",
-    "    \"doc7\": \"Climate change: The science and models.\",\n",
-    "    \"doc8\": \"Global warming: A subset of climate change.\",\n",
-    "    \"doc9\": \"How climate change affects daily weather.\",\n",
-    "    \"doc10\": \"The history of climate change activism.\",\n",
-    "}"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "fde89f0b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "vectorstore = PineconeVectorStore.from_texts(\n",
-    "    list(all_documents.values()), OpenAIEmbeddings(), index_name=\"rag-fusion\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "22ddd041",
-   "metadata": {},
-   "source": [
-    "## Define the Query Generator\n",
-    "\n",
-    "We will now define a chain to do the query generation"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 7,
-   "id": "1d547524",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain_core.output_parsers import StrOutputParser\n",
-    "from langchain_openai import ChatOpenAI"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 68,
-   "id": "af9ab4db",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain import hub\n",
-    "\n",
-    "prompt = hub.pull(\"langchain-ai/rag-fusion-query-generation\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "id": "3628b552",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# prompt = ChatPromptTemplate.from_messages([\n",
-    "#     (\"system\", \"You are a helpful assistant that generates multiple search queries based on a single input query.\"),\n",
-    "#     (\"user\", \"Generate multiple search queries related to: {original_query}\"),\n",
-    "#     (\"user\", \"OUTPUT (4 queries):\")\n",
-    "# ])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "id": "8d6cbb73",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "generate_queries = (\n",
-    "    prompt | ChatOpenAI(temperature=0) | StrOutputParser() | (lambda x: x.split(\"\\n\"))\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ee2824cd",
-   "metadata": {},
-   "source": [
-    "## Define the full chain\n",
-    "\n",
-    "We can now put it all together and define the full chain. This chain:\n",
-    "    \n",
-    "    1. Generates a bunch of queries\n",
-    "    2. Looks up each query in the retriever\n",
-    "    3. Joins all the results together using reciprocal rank fusion\n",
-    "    \n",
-    "    \n",
-    "Note that it does NOT do a final generation step"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 50,
-   "id": "ca0bfec4",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "original_query = \"impact of climate change\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 75,
-   "id": "02437d65",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "vectorstore = PineconeVectorStore.from_existing_index(\"rag-fusion\", OpenAIEmbeddings())\n",
-    "retriever = vectorstore.as_retriever()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 76,
-   "id": "46a9a0e6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from langchain.load import dumps, loads\n",
-    "\n",
-    "\n",
-    "def reciprocal_rank_fusion(results: list[list], k=60):\n",
-    "    fused_scores = {}\n",
-    "    for docs in results:\n",
-    "        # Assumes the docs are returned in sorted order of relevance\n",
-    "        for rank, doc in enumerate(docs):\n",
-    "            doc_str = dumps(doc)\n",
-    "            if doc_str not in fused_scores:\n",
-    "                fused_scores[doc_str] = 0\n",
-    "            previous_score = fused_scores[doc_str]\n",
-    "            fused_scores[doc_str] += 1 / (rank + k)\n",
-    "\n",
-    "    reranked_results = [\n",
-    "        (loads(doc), score)\n",
-    "        for doc, score in sorted(fused_scores.items(), key=lambda x: x[1], reverse=True)\n",
-    "    ]\n",
-    "    return reranked_results"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 77,
-   "id": "3f9d4502",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "chain = generate_queries | retriever.map() | reciprocal_rank_fusion"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 78,
-   "id": "d70c4fcd",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[(Document(page_content='Climate change and economic impact.'),\n",
-       "  0.06558258417063283),\n",
-       " (Document(page_content='Climate change: A social perspective.'),\n",
-       "  0.06400409626216078),\n",
-       " (Document(page_content='How climate change affects daily weather.'),\n",
-       "  0.04787506400409626),\n",
-       " (Document(page_content='Climate change and its impact on biodiversity.'),\n",
-       "  0.03306010928961749),\n",
-       " (Document(page_content='Public health concerns due to climate change.'),\n",
-       "  0.016666666666666666),\n",
-       " (Document(page_content='Technological solutions to climate change.'),\n",
-       "  0.016666666666666666),\n",
-       " (Document(page_content='Policy changes needed to combat climate change.'),\n",
-       "  0.01639344262295082)]"
-      ]
-     },
-     "execution_count": 78,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "chain.invoke({\"original_query\": original_query})"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7866e551",
-   "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.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}