chore: version packages (#982)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,8 +7,6 @@ assignees: ''
 
 ---
 
-_Note: we're aware of some missing content in the output and layout issues on tables. Please refrain from opening new issues on this topic unless if you think it's different from what has already been reported._
-
 **Describe the bug**
 Write a concise description of what the bug is.
 
@@ -19,19 +17,15 @@ If possible, please provide the PDF file causing the issue.
 If you have it, please provide the ID of the job you ran.
 You can find it here: https://cloud.llamaindex.ai/parse in the "History" tab.
 
-**Screenshots**
-Feel free to also provide screenshots if relevant.
-
 **Client:**
 Please remove untested options:
- - Frontend (cloud.llamaindex.ai)
  - Python Library
+ - API
+ - Frontend (cloud.llamaindex.ai)
  - Typescript Library
  - Notebook
- - API
-
-**Options**
-What options did you use? Multimodal, fast mode, parsing instructions, etc.
 
 **Additional context**
 Add any additional context about the problem here.
+What options did you use? Premium mode, multimodal, fast mode, parsing instructions, etc.
+Screenshots, code snippets, etc.

.github/dependabot.yml

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

.github/workflows/build_package.yml

@@ -1,48 +0,0 @@
-name: Build Package
-
-# Build package on its own without additional pip install
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-
-env:
-  POETRY_VERSION: "1.6.1"
-
-jobs:
-  build:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      # You can use PyPy versions in python-version.
-      # For example, pypy-2.7 and pypy-3.8
-      matrix:
-        os: [ubuntu-latest, windows-latest]
-        python-version: ["3.9"]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          version: ${{ env.POETRY_VERSION }}
-      - name: Install deps
-        shell: bash
-        run: poetry install
-      - name: Ensure lock works
-        shell: bash
-        run: poetry lock
-      - name: Build
-        shell: bash
-        run: poetry build
-      - name: Test installing built package
-        shell: bash
-        run: python -m pip install .
-      - name: Test import
-        shell: bash
-        working-directory: ${{ vars.RUNNER_TEMP }}
-        run: python -c "import llama_parse"

.github/workflows/build_package_py.yml

@@ -0,0 +1,53 @@
+name: Build Package - Python
+
+# Build package on its own without additional pip install
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "py/**"
+  pull_request:
+    paths:
+      - "py/**"
+env:
+  UV_VERSION: "0.7.20"
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      # You can use PyPy versions in python-version.
+      # For example, pypy-2.7 and pypy-3.8
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.9"]
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: ${{ env.UV_VERSION }}
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Display Python version
+        run: python --version
+
+      - name: Build
+        working-directory: py
+        run: uv build
+
+      - name: Test installing built package
+        shell: bash
+        working-directory: py
+        run: |
+          uv venv
+          uv pip install dist/*.whl
+
+      - name: Test import
+        working-directory: py
+        run: uv run -- python -c "import llama_cloud_services"

.github/workflows/build_package_ts.yml

@@ -0,0 +1,34 @@
+name: Build Package - TypeScript
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "ts/**"
+  pull_request:
+    paths:
+      - "ts/**"
+
+jobs:
+  pre_release:
+    name: Pre Release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v5
+
+      - uses: pnpm/action-setup@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version-file: "ts/llama_cloud_services/.nvmrc"
+
+      - name: Install dependencies
+        working-directory: ts/llama_cloud_services/
+        run: pnpm install --no-frozen-lockfile
+
+      - name: Build
+        working-directory: ts/llama_cloud_services/
+        run: pnpm run build

.github/workflows/claude-code.yml

@@ -0,0 +1,95 @@
+name: Claude Code
+
+on:
+  issue_comment:
+    types: [created]
+  pull_request_review_comment:
+    types: [created]
+  issues:
+    types: [opened, assigned]
+  pull_request_review:
+    types: [submitted]
+
+jobs:
+  claude:
+    if: |
+      (github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
+      (github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
+      (github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
+      (github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: read
+      id-token: write
+    steps:
+      - name: Check repository access
+        id: check-access
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          # Get the user who triggered the event
+          case "${{ github.event_name }}" in
+            "issue_comment")
+              USER="${{ github.event.comment.user.login }}"
+              ;;
+            "pull_request_review_comment")
+              USER="${{ github.event.comment.user.login }}"
+              ;;
+            "pull_request_review")
+              USER="${{ github.event.review.user.login }}"
+              ;;
+            "issues")
+              USER="${{ github.event.issue.user.login }}"
+              ;;
+          esac
+
+          echo "Checking repository access for user: $USER"
+
+          # Check if user has write access to the repository
+          REPO="${{ github.repository }}"
+          if gh api repos/$REPO/collaborators/$USER/permission --jq '.permission' | grep -E "(admin|write)" > /dev/null 2>&1; then
+            echo "User $USER has write access to the repository"
+            echo "authorized=true" >> $GITHUB_OUTPUT
+          else
+            echo "User $USER does not have write access to the repository"
+            echo "authorized=false" >> $GITHUB_OUTPUT
+            exit 1
+          fi
+
+      - name: Checkout repository
+        if: steps.check-access.outputs.authorized == 'true'
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 1
+
+      - name: Run Claude Code
+        if: steps.check-access.outputs.authorized == 'true'
+        id: claude
+        uses: anthropics/claude-code-action@beta
+        with:
+          anthropic_api_key: ${{ secrets.ANTHROPIC_GITHUB_API_KEY }}
+
+          # Optional: Specify model (defaults to Claude Sonnet 4, uncomment for Claude Opus 4)
+          # model: "claude-opus-4-20250514"
+
+          # Optional: Customize the trigger phrase (default: @claude)
+          # trigger_phrase: "/claude"
+
+          # Optional: Trigger when specific user is assigned to an issue
+          # assignee_trigger: "claude-bot"
+
+          # Optional: Allow Claude to run specific commands
+          # Allow bash commands to be run, for things like running tests, linting, etc.
+          allowed_tools: "Bash(rg:*),Bash(find:*),Bash(grep:*),Bash(pnpm:*),Bash(npm:*),Bash(uv:*),Bash(pip:*),Bash(pipx:*),Bash(make:*),Bash(cd:*),WebFetch"
+
+          # Optional: Add custom instructions for Claude to customize its behavior for your project
+          # custom_instructions: |
+          #   Follow our coding standards
+          #   Ensure all new code has tests
+          #   Use TypeScript for new files
+
+          # Optional: Custom environment variables for Claude
+          # claude_env: |
+          #   NODE_ENV: test

.github/workflows/codeql.yml

@@ -1,14 +1,3 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
 name: "CodeQL"
 
 on:
@@ -28,54 +17,25 @@ jobs:
     #   - https://gh.io/supported-runners-and-hardware-resources
     #   - https://gh.io/using-larger-runners
     # Consider using larger runners for possible analysis time improvements.
-    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
-    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    runs-on: "ubuntu-latest"
+    timeout-minutes: 360
     permissions:
       actions: read
       contents: read
       security-events: write
 
-    strategy:
-      fail-fast: false
-      matrix:
-        language: ["python"]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
-        # Use only 'java' to analyze code written in Java, Kotlin or both
-        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v4
         with:
-          languages: ${{ matrix.language }}
-          # If you wish to specify custom queries, you can do so here or in a config file.
-          # By default, queries listed here will override any specified in a config file.
-          # Prefix the list here with "+" to use these queries and those in the config file.
-
-          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-          # queries: security-extended,security-and-quality
-
-      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
-      # If this step fails, then you should remove it and run the build manually (see below)
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
-
-      # ℹ️ Command-line programs to run using the OS shell.
-      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-      #   If the Autobuild fails above, remove it and uncomment the following three lines.
-      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-      # - run: |
-      #     echo "Run, Build Application using script"
-      #     ./location_of_script_within_repo/buildscript.sh
+          languages: python
+          dependency-caching: true
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v4
         with:
-          category: "/language:${{matrix.language}}"
+          category: "/language:python"

.github/workflows/lint.yml

@@ -1,4 +1,4 @@
-name: Linting
+name: Lint
 
 on:
   push:
@@ -7,7 +7,7 @@ on:
   pull_request:
 
 env:
-  POETRY_VERSION: "1.6.1"
+  UV_VERSION: "0.7.20"
 
 jobs:
   build:
@@ -18,20 +18,29 @@ jobs:
       matrix:
         python-version: ["3.9"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
         with:
           fetch-depth: ${{ github.event_name == 'pull_request' && 2 || 0 }}
-      - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
+          version: ${{ env.UV_VERSION }}
+
+      - name: Set up Python
+        run: uv python install ${{ matrix.python-version }}
+
+      - uses: pnpm/action-setup@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
         with:
-          version: ${{ env.POETRY_VERSION }}
-      - name: Install pre-commit
-        shell: bash
-        run: poetry run pip install pre-commit
+          node-version-file: "ts/llama_cloud_services/.nvmrc"
+      - name: Install dependencies
+        run: pnpm install --no-frozen-lockfile
+
       - name: Run linter
         shell: bash
-        run: poetry run make lint
+        working-directory: py
+        run: uv run -- pre-commit run -a
+      # the js checks are run roundaboutly through lint-staged, and -a doesn't run it. Run them directly.
+      - run: pnpm -w --filter llama-cloud-services run lint
+      - run: pnpm -w --filter llama-cloud-services run format:check

.github/workflows/publish_release.yml

@@ -1,64 +0,0 @@
-name: Publish llama-parse to PyPI / GitHub
-
-on:
-  push:
-    tags:
-      - "v*"
-
-  workflow_dispatch:
-
-env:
-  POETRY_VERSION: "1.6.1"
-  PYTHON_VERSION: "3.9"
-
-jobs:
-  build-n-publish:
-    name: Build and publish to PyPI
-    if: github.repository == 'run-llama/llama_parse'
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up python ${{ env.PYTHON_VERSION }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          version: ${{ env.POETRY_VERSION }}
-      - name: Install deps
-        shell: bash
-        run: pip install -e .
-      - name: Build and publish to pypi
-        uses: JRubics/poetry-publish@v1.17
-        with:
-          pypi_token: ${{ secrets.LLAMA_PARSE_PYPI_TOKEN }}
-          ignore_dev_requirements: "yes"
-
-      - name: Create GitHub Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: ${{ github.ref }}
-          draft: false
-          prerelease: false
-
-      - name: Get Asset name
-        run: |
-          export PKG=$(ls dist/ | grep tar)
-          set -- $PKG
-          echo "name=$1" >> $GITHUB_ENV
-      - name: Upload Release Asset (sdist) to GitHub
-        id: upload-release-asset
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: dist/${{ env.name }}
-          asset_name: ${{ env.name }}
-          asset_content_type: application/zip

.github/workflows/test_e2e_py.yml

@@ -0,0 +1,38 @@
+name: Test end-to-end - Python
+
+on:
+  pull_request:
+    paths:
+      - "py/**"
+
+env:
+  UV_VERSION: "0.7.20"
+  LLAMA_CLOUD_API_KEY: ${{ secrets.LLAMA_CLOUD_API_KEY }}
+
+jobs:
+  test_e2e:
+    runs-on: ubuntu-latest
+    strategy:
+      # You can use PyPy versions in python-version.
+      # For example, pypy-2.7 and pypy-3.8
+      matrix:
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: ${{ env.UV_VERSION }}
+
+      - name: Set up Python
+        run: uv python install ${{ matrix.python-version }} && uv python pin ${{ matrix.python-version }}
+
+      - name: Run Tests
+        working-directory: py
+        run: make e2e
+
+      - name: Remove virtual environment
+        working-directory: py
+        run: rm -rf .venv/

.github/workflows/test_py.yml

@@ -0,0 +1,42 @@
+name: Test - Python
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "py/**"
+  pull_request:
+    paths:
+      - "py/**"
+
+env:
+  UV_VERSION: "0.7.20"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      # You can use PyPy versions in python-version.
+      # For example, pypy-2.7 and pypy-3.8
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: ${{ env.UV_VERSION }}
+
+      - name: Set up Python
+        run: uv python install ${{ matrix.python-version }} && uv python pin ${{ matrix.python-version }}
+
+      - name: Run Tests
+        working-directory: py
+        run: uv run pytest unit_tests/ -v
+
+      - name: Remove virtual environment
+        working-directory: py
+        run: rm -rf .venv/

.github/workflows/test_ts.yml

@@ -0,0 +1,39 @@
+name: Test - TypeScript
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "ts/**"
+  pull_request:
+    paths:
+      - "ts/**"
+
+env:
+  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+  TURBO_TEAM: ${{ vars.TURBO_TEAM }}
+  TURBO_REMOTE_ONLY: true
+  LLAMA_CLOUD_API_KEY: ${{ secrets.LLAMA_CLOUD_API_KEY }}
+
+jobs:
+  test:
+    name: Test - TypeScript
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: pnpm/action-setup@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version-file: "ts/llama_cloud_services/.nvmrc"
+      - name: Install dependencies
+        run: pnpm -r install --no-frozen-lockfile
+      - name: Build package
+        run: pnpm --filter llama-cloud-services build
+      - name: Run Tests
+        working-directory: ts/llama_cloud_services/
+        run: pnpm test
+      - name: Run e2e tests
+        working-directory: ts/e2e-tests/
+        run: pnpm test

.github/workflows/unit_test.yml

@@ -1,40 +0,0 @@
-name: Unit Testing
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-
-env:
-  POETRY_VERSION: "1.6.1"
-  LLAMA_CLOUD_API_KEY: ${{ secrets.LLAMA_CLOUD_API_KEY }}
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      # You can use PyPy versions in python-version.
-      # For example, pypy-2.7 and pypy-3.8
-      matrix:
-        python-version: ["3.8", "3.10", "3.11"]
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          version: ${{ env.POETRY_VERSION }}
-      - name: Install deps
-        shell: bash
-        run: poetry install --with dev
-      - name: Run testing
-        env:
-          CI: true
-        shell: bash
-        run: poetry run pytest tests

.github/workflows/version_bump_and_release.yml

@@ -0,0 +1,61 @@
+name: Version Bump and Release
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    # Only run on main branch pushes
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v5
+
+      - uses: pnpm/action-setup@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version: "22"
+          cache: "pnpm"
+
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Add auth token to .npmrc file
+        run: |
+          cat << EOF >> ".npmrc"
+            //registry.npmjs.org/:_authToken=$NPM_TOKEN
+          EOF
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Create Release Pull Request or Publish packages
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          commit: "chore: version packages"
+          title: "chore: version packages"
+          # Custom version script
+          version: pnpm -w run version
+          # Custom publish script
+          publish: pnpm -w run publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+          LLAMA_PARSE_PYPI_TOKEN: ${{ secrets.LLAMA_PARSE_PYPI_TOKEN }}

.gitignore

@@ -3,3 +3,10 @@ __pycache__/
 *.pyc
 .DS_Store
 .idea
+.env*
+.ipynb_checkpoints*
+*_cache/
+node_modules/
+.turbo/
+dist/
+.npmrc

.pre-commit-config.yaml

@@ -15,24 +15,26 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
+        exclude: ^ts/llama_cloud_services/src/client/
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     rev: v0.1.5
 
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
-        exclude: ".*poetry.lock"
+        exclude: ".*uv.lock"
   - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 23.10.1
     hooks:
       - id: black-jupyter
         name: black-src
         alias: black
-        exclude: ".*poetry.lock"
+        exclude: ".*uv.lock|examples/extract/solar_panel_e2e_comparison.ipynb"
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.0.1
     hooks:
       - id: mypy
+        exclude: ^py/tests|^py/unit_tests
         additional_dependencies:
           [
             "types-requests",
@@ -46,7 +48,7 @@ repos:
           [
             --disallow-untyped-defs,
             --ignore-missing-imports,
-            --python-version=3.8,
+            --python-version=3.10,
           ]
   - repo: https://github.com/adamchainz/blacken-docs
     rev: 1.16.0
@@ -58,17 +60,19 @@ repos:
         additional_dependencies: [black==23.10.1]
         # Using PEP 8's line length in docs prevents excess left/right scrolling
         args: [--line-length=79]
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.3
+  - repo: local
     hooks:
-      - id: prettier
-        exclude: poetry.lock
+      - id: lint-staged
+        name: Run lint-staged for TS files
+        entry: pnpm -w exec lint-staged
+        language: system
+        pass_filenames: false
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.6
     hooks:
       - id: codespell
         additional_dependencies: [tomli]
-        exclude: ^(poetry.lock|examples)
+        exclude: ^(uv.lock|docs|ts|examples|pnpm-lock.yaml)
         args:
           [
             "--ignore-words-list",
@@ -83,6 +87,6 @@ repos:
     rev: v0.23.1
     hooks:
       - id: toml-sort-fix
-        exclude: ".*poetry.lock"
+        exclude: ".*uv.lock"
 
-exclude: .github/ISSUE_TEMPLATE
+exclude: ^(.github/ISSUE_TEMPLATE|ts/llama_cloud_services/src/client|pnpm-lock.yaml)

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Python
+
+## Installation
+
+This project uses uv. Create a virtual environment, and run `uv sync`
+
+## Versioning (Maintainers only)
+
+Before merging your changes, make sure to bump the versions.
+
+Make a version bump to `pyproject.toml`. If the underlying dependency on the llamacloud platform OpenAPI
+sdk needs bumping, make sure to bring that in as well. If updating dependencies, run `uv lock`.
+
+The legacy `llama_parse` package re-exports some of `llama_cloud_services` in the old namespace. The
+versions need to be kept consistent to sidecar it with `llama_cloud_services`. Bump it's version in `llama_parse/pyproject.toml`, and also bump it's dependency version of `llama-cloud-services` to match.
+
+**Note**: Don't worry about updating the `llama_parse/poetry.lock` file when bumping versions. The GitHub action will automatically run `poetry lock` for the llama_parse package during the build process (though it doesn't commit the updated lockfile back to the repo).
+
+You can also do this with `./scripts/version-bump.py set 0.x.x` if you have `uv` installed.
+
+Once the change is merged, push a tag `git tag -a v0.x.x -m 0.x.x` and `git push origin v0.x.x`.
+
+This tagging step can be done with `./scripts/version-bump tag`.
+
+# Typescript
+
+## Installation
+
+...
+
+## Versioning
+
+...

Makefile

@@ -1,14 +0,0 @@
-GIT_ROOT ?= $(shell git rev-parse --show-toplevel)
-
-help:	## Show all Makefile targets.
-	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'
-
-format:	## Run code autoformatters (black).
-	pre-commit install
-	git ls-files | xargs pre-commit run black --files
-
-lint:	## Run linters: pre-commit (black, ruff, codespell) and mypy
-	pre-commit install && git ls-files | xargs pre-commit run --show-diff-on-failure --files
-
-test:	## Run tests via pytest
-	pytest tests

README.md

@@ -1,158 +1,75 @@
-# LlamaParse
-
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/llama-parse)](https://pypi.org/project/llama-parse/)
-[![GitHub contributors](https://img.shields.io/github/contributors/run-llama/llama_parse)](https://github.com/run-llama/llama_parse/graphs/contributors)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/llama-cloud-services)](https://pypi.org/project/llama-cloud-services/)
+[![GitHub contributors](https://img.shields.io/github/contributors/run-llama/llama_cloud_services)](https://github.com/run-llama/llama_cloud_services/graphs/contributors)
 [![Discord](https://img.shields.io/discord/1059199217496772688)](https://discord.gg/dGcwcsnxhU)
 
-LlamaParse is a **GenAI-native document parser** that can parse complex document data for any downstream LLM use case (RAG, agents).
+# Llama Cloud Services
 
-It is really good at the following:
+This repository contains the code for hand-written SDKs and clients for interacting with LlamaCloud.
 
-- ✅ **Broad file type support**: Parsing a variety of unstructured file types (.pdf, .pptx, .docx, .xlsx, .html) with text, tables, visual elements, weird layouts, and more.
-- ✅ **Table recognition**: Parsing embedded tables accurately into text and semi-structured representations.
-- ✅ **Multimodal parsing and chunking**: Extracting visual elements (images/diagrams) into structured formats and return image chunks using the latest multimodal models.
-- ✅ **Custom parsing**: Input custom prompt instructions to customize the output the way you want it.
+This includes:
 
-LlamaParse directly integrates with [LlamaIndex](https://github.com/run-llama/llama_index).
-
-The free plan is up to 1000 pages a day. Paid plan is free 7k pages per week + 0.3c per additional page by default. There is a sandbox available to test the API [**https://cloud.llamaindex.ai/parse ↗**](https://cloud.llamaindex.ai/parse).
-
-Read below for some quickstart information, or see the [full documentation](https://docs.cloud.llamaindex.ai/).
-
-If you're a company interested in enterprise RAG solutions, and/or high volume/on-prem usage of LlamaParse, come [talk to us](https://www.llamaindex.ai/contact).
+- [LlamaParse](./parse.md) - A GenAI-native document parser that can parse complex document data for any downstream LLM use case (Agents, RAG, data processing, etc.).
+- [LlamaExtract](./extract.md) - A prebuilt agentic data extractor that can be used to transform data into a structured JSON representation.
+- [LlamaCloud Index](./index.md) - A widely customizable and fully automated document ingestion pipeline that also serves retrieval purposes.
 
 ## Getting Started
 
-First, login and get an api-key from [**https://cloud.llamaindex.ai/api-key ↗**](https://cloud.llamaindex.ai/api-key).
-
-Then, make sure you have the latest LlamaIndex version installed.
-
-**NOTE:** If you are upgrading from v0.9.X, we recommend following our [migration guide](https://pretty-sodium-5e0.notion.site/v0-10-0-Migration-Guide-6ede431dcb8841b09ea171e7f133bd77), as well as uninstalling your previous version first.
-
-```
-pip uninstall llama-index  # run this if upgrading from v0.9.x or older
-pip install -U llama-index --upgrade --no-cache-dir --force-reinstall
-```
-
-Lastly, install the package:
-
-`pip install llama-parse`
-
-Now you can parse your first PDF file using the command line interface. Use the command `llama-parse [file_paths]`. See the help text with `llama-parse --help`.
+Install the package:
 
 ```bash
-export LLAMA_CLOUD_API_KEY='llx-...'
-
-# output as text
-llama-parse my_file.pdf --result-type text --output-file output.txt
-
-# output as markdown
-llama-parse my_file.pdf --result-type markdown --output-file output.md
-
-# output as raw json
-llama-parse my_file.pdf --output-raw-json --output-file output.json
+pip install llama-cloud-services
 ```
 
-You can also create simple scripts:
+Then, get your API key from [LlamaCloud](https://cloud.llamaindex.ai/).
+
+Then, you can use the services in your code:
 
 ```python
-import nest_asyncio
-
-nest_asyncio.apply()
-
-from llama_parse import LlamaParse
-
-parser = LlamaParse(
-    api_key="llx-...",  # can also be set in your env as LLAMA_CLOUD_API_KEY
-    result_type="markdown",  # "markdown" and "text" are available
-    num_workers=4,  # if multiple files passed, split in `num_workers` API calls
-    verbose=True,
-    language="en",  # Optionally you can define a language, default=en
+from llama_cloud_services import (
+    LlamaParse,
+    LlamaExtract,
+    LlamaCloudIndex,
 )
 
-# sync
-documents = parser.load_data("./my_file.pdf")
-
-# sync batch
-documents = parser.load_data(["./my_file1.pdf", "./my_file2.pdf"])
-
-# async
-documents = await parser.aload_data("./my_file.pdf")
-
-# async batch
-documents = await parser.aload_data(["./my_file1.pdf", "./my_file2.pdf"])
+parser = LlamaParse(api_key="YOUR_API_KEY")
+extract = LlamaExtract(api_key="YOUR_API_KEY")
+index = LlamaCloudIndex(
+    "my_first_index", project_name="default", api_key="YOUR_API_KEY"
+)
 ```
 
-## Using with file object
+See the quickstart guides for each service for more information:
 
-You can parse a file object directly:
+- [LlamaParse](./parse.md)
+- [LlamaExtract](./extract.md)
+- [LlamaCloud Index](./index.md)
+
+## Switch to EU SaaS 🇪🇺
+
+If you are interested in using LlamaCloud services in the EU, you can adjust your base URL to `https://api.cloud.eu.llamaindex.ai`.
+
+You can also create your API key in the EU region [here](https://cloud.eu.llamaindex.ai).
 
 ```python
-import nest_asyncio
-
-nest_asyncio.apply()
-
-from llama_parse import LlamaParse
-
-parser = LlamaParse(
-    api_key="llx-...",  # can also be set in your env as LLAMA_CLOUD_API_KEY
-    result_type="markdown",  # "markdown" and "text" are available
-    num_workers=4,  # if multiple files passed, split in `num_workers` API calls
-    verbose=True,
-    language="en",  # Optionally you can define a language, default=en
+from llama_cloud_services import (
+    LlamaParse,
+    LlamaExtract,
+    EU_BASE_URL,
 )
 
-file_name = "my_file1.pdf"
-extra_info = {"file_name": file_name}
-
-with open(f"./{file_name}", "rb") as f:
-    # must provide extra_info with file_name key with passing file object
-    documents = parser.load_data(f, extra_info=extra_info)
-
-# you can also pass file bytes directly
-with open(f"./{file_name}", "rb") as f:
-    file_bytes = f.read()
-    # must provide extra_info with file_name key with passing file bytes
-    documents = parser.load_data(file_bytes, extra_info=extra_info)
-```
-
-## Using with `SimpleDirectoryReader`
-
-You can also integrate the parser as the default PDF loader in `SimpleDirectoryReader`:
-
-```python
-import nest_asyncio
-
-nest_asyncio.apply()
-
-from llama_parse import LlamaParse
-from llama_index.core import SimpleDirectoryReader
-
-parser = LlamaParse(
-    api_key="llx-...",  # can also be set in your env as LLAMA_CLOUD_API_KEY
-    result_type="markdown",  # "markdown" and "text" are available
-    verbose=True,
+parser = LlamaParse(api_key="YOUR_API_KEY", base_url=EU_BASE_URL)
+extract = LlamaExtract(api_key="YOUR_API_KEY", base_url=EU_BASE_URL)
+index = LlamaCloudIndex(
+    "my_first_index",
+    project_name="default",
+    api_key="YOUR_API_KEY",
+    base_url=EU_BASE_URL,
 )
-
-file_extractor = {".pdf": parser}
-documents = SimpleDirectoryReader(
-    "./data", file_extractor=file_extractor
-).load_data()
 ```
 
-Full documentation for `SimpleDirectoryReader` can be found on the [LlamaIndex Documentation](https://docs.llamaindex.ai/en/stable/module_guides/loading/simpledirectoryreader.html).
-
-## Examples
-
-Several end-to-end indexing examples can be found in the examples folder
-
-- [Getting Started](examples/demo_basic.ipynb)
-- [Advanced RAG Example](examples/demo_advanced.ipynb)
-- [Raw API Usage](examples/demo_api.ipynb)
-
 ## Documentation
 
-[https://docs.cloud.llamaindex.ai/](https://docs.cloud.llamaindex.ai/)
+You can see complete SDK and API documentation for each service on [our official docs](https://docs.cloud.llamaindex.ai/).
 
 ## Terms of Service
 
@@ -160,6 +77,4 @@ See the [Terms of Service Here](./TOS.pdf).
 
 ## Get in Touch (LlamaCloud)
 
-LlamaParse is part of LlamaCloud, our e2e enterprise RAG platform that provides out-of-the-box, production-ready connectors, indexing, and retrieval over your complex data sources. We offer SaaS and VPC options.
-
-LlamaCloud is currently available via waitlist (join by [creating an account](https://cloud.llamaindex.ai/)). If you're interested in state-of-the-art quality and in centralizing your RAG efforts, come [get in touch with us](https://www.llamaindex.ai/contact).
+You can get in touch with us by following our [contact link](https://www.llamaindex.ai/contact).

examples-ts/README.md

@@ -0,0 +1,8 @@
+# LlamaCloud Services Examples - Python
+
+In this folder you will find several TypeScript end-to-end applications that contain examples regarding:
+
+- [LlamaParse](./parse/)
+- [LlamaCloud Index](./index/)
+
+Follow the instructions in each example folder to get started!

examples-ts/extract/README.md

@@ -0,0 +1,122 @@
+# LlamaExtract Demo
+
+A TypeScript demo application showcasing the power of **LlamaExract** - a structured data extraction agentic service from [LlamaCloud](https://cloud.llamaindex.ai). This demo allows you to extract structured information from scientific papers and get them into a nice markdown format.
+
+## Table of Contents
+
+- [Features](#features)
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Start the Demo](#start-the-demo)
+  - [Development Mode](#development-mode)
+  - [Build the Project](#build-the-project)
+  - [Code Quality](#code-quality)
+  - [Quick Commands Reference](#quick-commands-reference)
+- [How It Works](#how-it-works)
+- [API Dependencies](#api-dependencies)
+- [Troubleshooting](#troubleshooting)
+  - [Common Issues](#common-issues)
+- [License](#license)
+- [Contributing](#contributing)
+
+## Features
+
+- 📄 **Structured Data Extraction**: Extract data from your files effortlessly, and structure them the way you want!
+- 🤖 **Markdown Rendering**: Generate markdown directly from your extracted data
+- 🎨 **Beautiful CLI**: Styled console interface with colors and ASCII art
+- ⚡ **Fast Development**: Hot reload support with watch mode
+- 🛠️ **TypeScript**: Full TypeScript support with strict type checking
+
+## Prerequisites
+
+- Node.js (version 18 or higher)
+- pnpm package manager
+- LlamaCloud API key
+
+## Installation
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/run-llama/llama_cloud_services
+cd lama_cloud_services/examples-ts/extract/
+```
+
+2. Install dependencies:
+
+```bash
+npm install
+```
+
+3. Set up your environment variables:
+
+```bash
+# Add your API key to your environment
+export LLAMA_CLOUD_API_KEY="your-llamacloud-api-key"
+```
+
+## Usage
+
+### Start the Demo
+
+```bash
+npm run start
+```
+
+The application will display a welcome screen and prompt you to enter the path to a document you'd like to process.
+
+### Development Mode
+
+For development with hot reload:
+
+```bash
+npm run dev
+```
+
+### Build the Project
+
+```bash
+npm run build
+```
+
+### Code Quality
+
+Format code:
+
+```bash
+npm run format
+```
+
+Lint code:
+
+```bash
+npm run lint
+```
+
+## How It Works
+
+1. **Document Input**: Enter the path to your document when prompted
+2. **Parsing**: LlamaExtract, based on the schema you can find [here](./src/schema.ts), processes the document and extracts structured data
+3. **Markdown Rendering**: The extracted content is rendered into beautiful markdown
+4. **Results**: View the results directly in your terminal
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Module Resolution Errors**: Ensure you're using Node.js 18+ and have all dependencies installed
+2. **API Key Issues**: Verify your LlamaCloud API key is correctly set
+3. **File Path Errors**: Use absolute paths or ensure relative paths are correct from the project root
+
+## License
+
+MIT License - see the [LICENSE](../../LICENSE) file for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run `npm run format` and `npm run lint`
+5. Submit a pull request

examples-ts/extract/eslint.config.mts

@@ -0,0 +1,14 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+    plugins: { js },
+    extends: ["js/recommended"],
+    languageOptions: { globals: globals.browser },
+  },
+  tseslint.configs.recommended,
+]);

examples-ts/extract/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "llama-extract-demo",
+  "version": "0.1.0",
+  "description": "Demo for LlamaExtract in TypeScript",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"There are no tests\"",
+    "start": "npm exec tsx src/index.ts",
+    "lint": "eslint ./src/",
+    "format": "prettier --write ./src/",
+    "build": "tsc",
+    "dev": "npm exec tsx --watch src/index.ts"
+  },
+  "author": "LlamaIndex",
+  "license": "MIT",
+  "dependencies": {
+    "cli-markdown": "^3.5.1",
+    "consola": "^3.4.2",
+    "figlet": "^1.8.2",
+    "llama-cloud-services": "file:../../ts/llama_cloud_services",
+    "marked": "^15.0.12",
+    "marked-terminal": "^7.3.0",
+    "picocolors": "^1.1.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.32.0",
+    "@types/figlet": "^1.7.0",
+    "@types/marked-terminal": "^6.1.1",
+    "@types/node": "^24.2.0",
+    "eslint": "^9.32.0",
+    "globals": "^16.3.0",
+    "jiti": "^2.5.1",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.39.0"
+  }
+}

examples-ts/extract/src/index.ts

@@ -0,0 +1,47 @@
+import { LlamaExtract, ExtractConfig } from "llama-cloud-services";
+import cliMarkdown from "cli-markdown";
+import { logger } from "./logger";
+import pc from "picocolors";
+import { consoleInput, renderLogo } from "./utils";
+import { dataSchema } from "./schema";
+import { renderMarkdown, ResearchData } from "./markdown";
+
+export async function main(): Promise<number> {
+  const extractClient = new LlamaExtract(
+    process.env.LLAMA_CLOUD_API_KEY!,
+    "https://api.cloud.llamaindex.ai",
+  );
+  await renderLogo();
+  logger.log(
+    `Welcome to ${pc.bold(
+      pc.magentaBright("LlamaExtract Demo✨"),
+    )}, our demo for ${pc.bold(pc.green("LlamaExtract"))}, a ${pc.bold(
+      pc.cyan("LlamaCloud☁️"),
+    )}  (https://cloud.llamaindex.ai) product!.\nIn this demo we are going to try extracting relevant information  ${pc.bold(
+      pc.yellowBright("from scientific papers"),
+    )}. Type the path to the paper you would like to process below👇\nIf you wish to exit, just type ${pc.bold(
+      pc.gray("quit"),
+    )}.\n`,
+  );
+  while (true) {
+    const userInput = await consoleInput();
+    if (userInput.toLowerCase() == "quit") {
+      break;
+    }
+    try {
+      const generatedData = await extractClient.extract(
+        dataSchema,
+        {} as ExtractConfig,
+        userInput,
+      );
+      const research = renderMarkdown(generatedData?.data as ResearchData); // Added await here
+      logger.log(`${pc.bold(pc.cyan("Extracted information:✨"))}:\n`);
+      logger.log(cliMarkdown(research));
+    } catch (error) {
+      logger.error(`Error processing file: ${error}`);
+    }
+  }
+  return 0;
+}
+
+main().catch(console.error);

examples-ts/extract/src/logger.ts

@@ -0,0 +1,8 @@
+import { createConsola } from "consola";
+import type { ConsolaInstance } from "consola";
+
+export const logger: ConsolaInstance = createConsola({
+  formatOptions: {
+    date: false,
+  },
+});

examples-ts/extract/src/markdown.ts

@@ -0,0 +1,172 @@
+type Author = {
+  name: string;
+  affiliation?: string;
+  email?: string;
+};
+
+type Methodology = {
+  approach?: string;
+  participants?: string;
+  methods?: string[];
+};
+
+type Result = {
+  finding?: string;
+  significance?: string;
+  supportingData?: string;
+};
+
+type Reference = {
+  title: string;
+  authors: string;
+  year?: string;
+  relevance?: string;
+};
+
+type Discussion = {
+  implications?: string[];
+  limitations?: string[];
+  futureWork?: string[];
+};
+
+type Publication = {
+  journal?: string;
+  year: string;
+  doi?: string;
+  url?: string;
+};
+
+export type ResearchData = {
+  title: string;
+  authors: Author[];
+  abstract: string;
+  keywords?: string[];
+  mainFindings: string[];
+  methodology?: Methodology;
+  results?: Result[];
+  discussion?: Discussion;
+  references?: Reference[];
+  publication?: Publication;
+};
+
+export function renderMarkdown(data: ResearchData): string {
+  const {
+    title,
+    authors,
+    abstract,
+    keywords,
+    mainFindings,
+    methodology,
+    results,
+    discussion,
+    references,
+    publication,
+  } = data;
+
+  const md: string[] = [];
+
+  md.push(`# ${title}\n`);
+
+  // Authors
+  md.push(`## Authors`);
+  md.push(
+    authors
+      .map(
+        (author) =>
+          `- **${author.name}**${
+            author.affiliation ? `, *${author.affiliation}*` : ""
+          }${author.email ? ` (${author.email})` : ""}`,
+      )
+      .join("\n"),
+  );
+
+  // Abstract
+  md.push(`\n## Abstract\n${abstract}`);
+
+  // Keywords
+  if (keywords && keywords.length > 0) {
+    md.push(`\n## Keywords\n${keywords.map((k) => `- ${k}`).join("\n")}`);
+  }
+
+  // Main Findings
+  md.push(
+    `\n## Main Findings\n${mainFindings.map((f) => `- ${f}`).join("\n")}`,
+  );
+
+  // Methodology
+  if (methodology) {
+    md.push(`\n## Methodology`);
+    if (methodology.approach) md.push(`**Approach:** ${methodology.approach}`);
+    if (methodology.participants)
+      md.push(`**Participants:** ${methodology.participants}`);
+    if (methodology.methods?.length) {
+      md.push(
+        `**Methods:**\n${methodology.methods.map((m) => `- ${m}`).join("\n")}`,
+      );
+    }
+  }
+
+  // Results
+  if (results?.length) {
+    md.push(`\n## Results`);
+    results.forEach((result, i) => {
+      md.push(`\n### Result ${i + 1}`);
+      if (result.finding) md.push(`- **Finding:** ${result.finding}`);
+      if (result.significance)
+        md.push(`- **Significance:** ${result.significance}`);
+      if (result.supportingData)
+        md.push(`- **Supporting Data:** ${result.supportingData}`);
+    });
+  }
+
+  // Discussion
+  if (discussion) {
+    md.push(`\n## Discussion`);
+    if (discussion.implications?.length) {
+      md.push(
+        `### Implications\n${discussion.implications
+          .map((d) => `- ${d}`)
+          .join("\n")}`,
+      );
+    }
+    if (discussion.limitations?.length) {
+      md.push(
+        `### Limitations\n${discussion.limitations
+          .map((d) => `- ${d}`)
+          .join("\n")}`,
+      );
+    }
+    if (discussion.futureWork?.length) {
+      md.push(
+        `### Future Work\n${discussion.futureWork
+          .map((d) => `- ${d}`)
+          .join("\n")}`,
+      );
+    }
+  }
+
+  // References
+  if (references?.length) {
+    md.push(`\n## References`);
+    references.forEach((ref, i) => {
+      md.push(
+        `\n**[${i + 1}]** ${ref.title} — *${ref.authors}*${
+          ref.year ? ` (${ref.year})` : ""
+        }`,
+      );
+      if (ref.relevance) md.push(`> ${ref.relevance}`);
+    });
+  }
+
+  // Publication Info
+  if (publication) {
+    md.push(`\n## Publication`);
+    if (publication.journal) md.push(`- **Journal:** ${publication.journal}`);
+    if (publication.year) md.push(`- **Year:** ${publication.year}`);
+    if (publication.doi) md.push(`- **DOI:** ${publication.doi}`);
+    if (publication.url)
+      md.push(`- **URL:** [${publication.url}](${publication.url})`);
+  }
+
+  return md.join("\n");
+}

examples-ts/extract/src/schema.ts

@@ -0,0 +1,169 @@
+export const dataSchema = {
+  type: "object",
+  required: ["title", "authors", "abstract", "mainFindings"],
+  properties: {
+    title: {
+      type: "string",
+      description: "The full title of the research paper",
+    },
+    authors: {
+      type: "array",
+      description: "List of all authors of the paper",
+      items: {
+        type: "object",
+        properties: {
+          name: {
+            type: "string",
+            description: "Full name of the author",
+          },
+          affiliation: {
+            type: "string",
+            description:
+              "Institution or organization the author is affiliated with",
+          },
+          email: {
+            type: "string",
+            description: "Contact email of the author if provided",
+          },
+        },
+      },
+    },
+    abstract: {
+      type: "string",
+      description: "Complete abstract or summary of the paper",
+    },
+    keywords: {
+      type: "array",
+      description:
+        "Key terms and phrases that describe the paper's main topics",
+      items: {
+        type: "string",
+      },
+    },
+    mainFindings: {
+      type: "array",
+      description: "Key findings, conclusions, or contributions of the paper",
+      items: {
+        type: "string",
+      },
+    },
+    methodology: {
+      type: "object",
+      description: "Research methods and approaches used",
+      properties: {
+        approach: {
+          type: "string",
+          description: "Overall research approach or study design",
+        },
+        participants: {
+          type: "string",
+          description: "Description of study participants or data sources",
+        },
+        methods: {
+          type: "array",
+          description: "Specific methods, techniques, or tools used",
+          items: {
+            type: "string",
+          },
+        },
+      },
+    },
+    results: {
+      type: "array",
+      description: "Main results and outcomes of the research",
+      items: {
+        type: "object",
+        properties: {
+          finding: {
+            type: "string",
+            description: "Description of the specific result or finding",
+          },
+          significance: {
+            type: "string",
+            description:
+              "Statistical significance or importance of the finding",
+          },
+          supportingData: {
+            type: "string",
+            description: "Relevant statistics, measurements, or data points",
+          },
+        },
+      },
+    },
+    discussion: {
+      type: "object",
+      properties: {
+        implications: {
+          type: "array",
+          description: "Theoretical or practical implications of the findings",
+          items: {
+            type: "string",
+          },
+        },
+        limitations: {
+          type: "array",
+          description: "Study limitations or constraints",
+          items: {
+            type: "string",
+          },
+        },
+        futureWork: {
+          type: "array",
+          description: "Suggested future research directions",
+          items: {
+            type: "string",
+          },
+        },
+      },
+    },
+    references: {
+      type: "array",
+      description:
+        "Key papers cited that are crucial to understanding this work",
+      items: {
+        type: "object",
+        properties: {
+          title: {
+            type: "string",
+            description: "Title of the cited paper",
+          },
+          authors: {
+            type: "string",
+            description: "Authors of the cited paper",
+          },
+          year: {
+            type: "string",
+            description: "Publication year",
+          },
+          relevance: {
+            type: "string",
+            description: "Why this reference is important to the current paper",
+          },
+        },
+        required: ["title", "authors"],
+      },
+    },
+    publication: {
+      type: "object",
+      properties: {
+        journal: {
+          type: "string",
+          description: "Name of the journal or conference",
+        },
+        year: {
+          type: "string",
+          description: "Year of publication",
+        },
+        doi: {
+          type: "string",
+          description: "Digital Object Identifier (DOI) of the paper",
+        },
+        url: {
+          type: "string",
+          description: "URL where the paper can be accessed",
+        },
+      },
+      required: ["year"],
+    },
+  },
+};

examples-ts/extract/src/types/cli-markdown.d.ts

@@ -0,0 +1,4 @@
+declare module "cli-markdown" {
+  function cliMarkdown(input: string): string;
+  export default cliMarkdown;
+}

examples-ts/extract/src/utils.ts

@@ -0,0 +1,33 @@
+import * as readline from "readline/promises";
+import figlet from "figlet";
+import pc from "picocolors";
+
+export async function renderLogo(): Promise<void> {
+  const logoText = figlet.textSync("Extract Demo", {
+    font: "ANSI Shadow",
+    horizontalLayout: "default",
+    verticalLayout: "default",
+    width: 100,
+    whitespaceBreak: true,
+  });
+
+  // Add some styling with picocolors
+  const styledLogo = pc.bold(pc.redBright(logoText));
+
+  // Add some padding/margin
+  console.log("\n");
+  console.log(styledLogo);
+  console.log(pc.gray("─".repeat(60)));
+  console.log("\n");
+}
+
+export async function consoleInput(): Promise<string> {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  const answer = await rl.question("Path to your file: ");
+  rl.close();
+  return answer;
+}

examples-ts/index/README.md

@@ -0,0 +1,131 @@
+# LlamaCloud Index Demo
+
+A TypeScript demo application showcasing the power of **LlamaCloud Index** - a fully automated document ingestion and retrieval serviced offered within [LlamaCloud](https://cloud.llamaindex.ai). This demo allows you to ask questions, retrieve relevant contextual information and generate AI-powered responses using OpenAI's GPT models.
+
+## Table of Contents
+
+- [Features](#features)
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Start the Demo](#start-the-demo)
+  - [Development Mode](#development-mode)
+  - [Build the Project](#build-the-project)
+  - [Code Quality](#code-quality)
+  - [Quick Commands Reference](#quick-commands-reference)
+- [How It Works](#how-it-works)
+- [API Dependencies](#api-dependencies)
+- [Troubleshooting](#troubleshooting)
+  - [Common Issues](#common-issues)
+- [License](#license)
+- [Contributing](#contributing)
+
+## Features
+
+- 🤖 **RAG**: Simple-yet-effective Retrieval Augmented Generation pipeline built on top of LlamaCloud Index and OpenAI
+- 🎨 **Beautiful CLI**: Styled console interface with colors and ASCII art
+- ⚡ **Fast Development**: Hot reload support with watch mode
+- 🛠️ **TypeScript**: Full TypeScript support with strict type checking
+
+## Prerequisites
+
+- Node.js (version 18 or higher)
+- pnpm package manager
+- OpenAI API key
+- LlamaCloud API key
+- An existing LlamaCloud Index pipeline
+
+## Installation
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/run-llama/llama_cloud_services
+cd lama_cloud_services/examples-ts/index/
+```
+
+2. Install dependencies:
+
+```bash
+pnpm install
+```
+
+3. Set up your environment variables:
+
+```bash
+export OPENAI_API_KEY="your-openai-api-key"
+export LLAMA_CLOUD_API_KEY="your-llamacloud-api-key"
+export PIPELINE_NAME="your-pipeline-name"
+```
+
+4. Or write them into a `.env` file:
+
+```env
+OPENAI_API_KEY="your-openai-api-key"
+LLAMA_CLOUD_API_KEY="your-llamacloud-api-key"
+PIPELINE_NAME="your-pipeline-name"
+```
+
+## Usage
+
+### Start the Demo
+
+```bash
+pnpm run start
+```
+
+The application will display a welcome screen and prompt you to start chatting!
+
+### Development Mode
+
+For development with hot reload:
+
+```bash
+pnpm run dev
+```
+
+### Build the Project
+
+```bash
+pnpm run build
+```
+
+### Code Quality
+
+Format code:
+
+```bash
+pnpm run format
+```
+
+Lint code:
+
+```bash
+pnpm run lint
+```
+
+## How It Works
+
+1. **Message Input**: Enter a message
+2. **Retrieval**: Several nodes are retrieved from the LlamaCloud index you specified
+3. **AI Response Generation**: The retrieved information is passed on to the AI model, along with its relevance score, and a reply to your original message is generated starting from that.
+4. **Results**: View the AI-generated summary in your terminal
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Module Resolution Errors**: Ensure you're using Node.js 18+ and have all dependencies installed
+2. **API Key Issues**: Verify your OpenAI and LlamaCloud API keys are correctly set
+
+## License
+
+MIT License - see the [LICENSE](../../LICENSE) file for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run `pnpm run format` and `pnpm run lint`
+5. Submit a pull request

examples-ts/index/eslint.config.mts

@@ -0,0 +1,15 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+    plugins: { js },
+    extends: ["js/recommended"],
+    languageOptions: { globals: globals.browser },
+  },
+  { files: ["**/*.js"], languageOptions: { sourceType: "script" } },
+  tseslint.configs.recommended,
+]);

examples-ts/index/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "llama-chat",
+  "version": "0.1.0",
+  "description": "Demo for LlamaCloud Index in TypeScript",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"There are no tests\"",
+    "start": "pnpm exec tsx src/index.ts",
+    "lint": "eslint ./src/",
+    "format": "prettier --write ./src/",
+    "build": "tsc",
+    "dev": "pnpm exec tsx --watch src/index.ts"
+  },
+  "keywords": [
+    "ai",
+    "rag",
+    "retrieval",
+    "pipeline",
+    "llms",
+    "chatbot"
+  ],
+  "author": "LlamaIndex",
+  "license": "MIT",
+  "packageManager": "pnpm@10.12.4",
+  "devDependencies": {
+    "@eslint/js": "^9.32.0",
+    "@types/figlet": "^1.7.0",
+    "@types/node": "^24.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.38.0",
+    "@typescript-eslint/parser": "^8.38.0",
+    "eslint": "^9.32.0",
+    "globals": "^16.3.0",
+    "jiti": "^2.5.1",
+    "prettier": "^3.6.2",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.38.0"
+  },
+  "dependencies": {
+    "@ai-sdk/openai": "^1.3.23",
+    "ai": "^4.3.19",
+    "consola": "^3.4.2",
+    "dotenv": "^17.2.1",
+    "figlet": "^1.8.2",
+    "llama-cloud-services": "link:../../ts/llama_cloud_services",
+    "picocolors": "^1.1.1"
+  }
+}

examples-ts/index/src/index.ts

@@ -0,0 +1,48 @@
+import { LlamaCloudIndex } from "llama-cloud-services";
+import { logger } from "./logger";
+import pc from "picocolors";
+import {
+  consoleInput,
+  retrievalAugmentedGeneration,
+  renderLogo,
+} from "./utils";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+export async function main(): Promise<number> {
+  const index = new LlamaCloudIndex({
+    name: process.env.PIPELINE_NAME as string,
+    projectName: "Default",
+    apiKey: process.env.LLAMA_CLOUD_API_KEY, // can provide API-key in the constructor or in the env
+  });
+  const retriever = index.asRetriever({
+    similarityTopK: 5,
+  });
+  await renderLogo();
+  logger.log(
+    `Welcome to ${pc.bold(
+      pc.magentaBright("✨LlamaChat✨"),
+    )}, our demo for ${pc.bold(pc.green("Index🦙"))}, a ${pc.bold(
+      pc.cyan("LlamaCloud☁️"),
+    )}  (https://cloud.llamaindex.ai) product!.\nType a question below, and you will get an answer!👇\nIf you wish to exit, just type ${pc.bold(
+      pc.gray("quit"),
+    )}.\n`,
+  );
+  while (true) {
+    const userInput = await consoleInput();
+    if (userInput.toLowerCase() == "quit") {
+      break;
+    }
+    try {
+      const nodes = await retriever.retrieve(userInput);
+      const summary = await retrievalAugmentedGeneration(nodes, userInput);
+      logger.log(`${pc.bold(pc.magentaBright("LlamaChat✨:"))}\n${summary}`);
+    } catch (error) {
+      logger.error(`Error processing your request: ${error}`);
+    }
+  }
+  return 0;
+}
+
+main().catch(console.error);

examples-ts/index/src/logger.ts

@@ -0,0 +1,8 @@
+import { createConsola } from "consola";
+import type { ConsolaInstance } from "consola";
+
+export const logger: ConsolaInstance = createConsola({
+  formatOptions: {
+    date: false,
+  },
+});

examples-ts/index/src/utils.ts

@@ -0,0 +1,56 @@
+import { generateText } from "ai";
+import { openai } from "@ai-sdk/openai";
+import { NodeWithScore, MetadataMode } from "llamaindex";
+import * as readline from "readline/promises";
+import figlet from "figlet";
+import pc from "picocolors";
+
+export async function renderLogo(): Promise<void> {
+  const logoText = figlet.textSync("LlamaChat", {
+    font: "ANSI Shadow",
+    horizontalLayout: "default",
+    verticalLayout: "default",
+    width: 100,
+    whitespaceBreak: true,
+  });
+
+  // Add some styling with picocolors
+  const styledLogo = pc.bold(pc.yellowBright(logoText));
+
+  // Add some padding/margin
+  console.log("\n");
+  console.log(styledLogo);
+  console.log(pc.gray("─".repeat(60)));
+  console.log("\n");
+}
+
+export async function consoleInput(): Promise<string> {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  const answer = await rl.question(pc.cyanBright("You✨:"));
+  rl.close();
+  return answer;
+}
+
+export async function retrievalAugmentedGeneration(
+  nodes: NodeWithScore[],
+  prompt: string,
+): Promise<string> {
+  let mainText: string = "";
+
+  for (const node of nodes) {
+    mainText += `\t{information: '${node.node.getContent(
+      MetadataMode.ALL,
+    )}', relevanceScore: '${node.score ?? "no score"}'}\n`;
+  }
+
+  const { text } = await generateText({
+    model: openai("gpt-4.1"),
+    prompt: `[\n${mainText}\n]\n\nBased on the information you are given and on the relevance score of that (where -1 means no score available), answer to this user prompt: '${prompt}'`,
+  });
+
+  return text;
+}

examples-ts/index/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "lib": ["ES2022"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "types": ["node"],
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

examples-ts/parse/README.md

@@ -0,0 +1,124 @@
+# LlamaParse Demo
+
+A TypeScript demo application showcasing the power of **LlamaParse** - an intelligent document parsing service from [LlamaCloud](https://cloud.llamaindex.ai). This demo allows you to parse various document formats and generate AI-powered summaries using OpenAI's GPT models.
+
+## Table of Contents
+
+- [Features](#features)
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Start the Demo](#start-the-demo)
+  - [Development Mode](#development-mode)
+  - [Build the Project](#build-the-project)
+  - [Code Quality](#code-quality)
+  - [Quick Commands Reference](#quick-commands-reference)
+- [How It Works](#how-it-works)
+- [API Dependencies](#api-dependencies)
+- [Troubleshooting](#troubleshooting)
+  - [Common Issues](#common-issues)
+- [License](#license)
+- [Contributing](#contributing)
+
+## Features
+
+- 📄 **Document Parsing**: Parse PDFs, Word docs, and other formats using LlamaParse
+- 🤖 **AI Summaries**: Generate intelligent summaries using OpenAI GPT-4
+- 🎨 **Beautiful CLI**: Styled console interface with colors and ASCII art
+- ⚡ **Fast Development**: Hot reload support with watch mode
+- 🛠️ **TypeScript**: Full TypeScript support with strict type checking
+
+## Prerequisites
+
+- Node.js (version 18 or higher)
+- pnpm package manager
+- OpenAI API key
+- LlamaCloud API key
+
+## Installation
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/run-llama/llama_cloud_services
+cd lama_cloud_services/examples-ts/parse/
+```
+
+2. Install dependencies:
+
+```bash
+pnpm install
+```
+
+3. Set up your environment variables:
+
+```bash
+# Add your API keys to your environment
+export OPENAI_API_KEY="your-openai-api-key"
+export LLAMA_CLOUD_API_KEY="your-llamacloud-api-key"
+```
+
+## Usage
+
+### Start the Demo
+
+```bash
+pnpm run start
+```
+
+The application will display a welcome screen and prompt you to enter the path to a document you'd like to process.
+
+### Development Mode
+
+For development with hot reload:
+
+```bash
+pnpm run dev
+```
+
+### Build the Project
+
+```bash
+pnpm run build
+```
+
+### Code Quality
+
+Format code:
+
+```bash
+pnpm run format
+```
+
+Lint code:
+
+```bash
+pnpm run lint
+```
+
+## How It Works
+
+1. **Document Input**: Enter the path to your document when prompted
+2. **Parsing**: LlamaParse processes the document and extracts structured content
+3. **AI Summary**: The extracted content is sent to OpenAI GPT-4 for summarization
+4. **Results**: View the AI-generated summary in your terminal
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Module Resolution Errors**: Ensure you're using Node.js 18+ and have all dependencies installed
+2. **API Key Issues**: Verify your OpenAI and LlamaCloud API keys are correctly set
+3. **File Path Errors**: Use absolute paths or ensure relative paths are correct from the project root
+
+## License
+
+MIT License - see the [LICENSE](../../LICENSE) file for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run `pnpm run format` and `pnpm run lint`
+5. Submit a pull request

examples-ts/parse/eslint.config.mts

@@ -0,0 +1,15 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+    plugins: { js },
+    extends: ["js/recommended"],
+    languageOptions: { globals: globals.browser },
+  },
+  { files: ["**/*.js"], languageOptions: { sourceType: "script" } },
+  tseslint.configs.recommended,
+]);

examples-ts/parse/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "llamaparse-demo",
+  "version": "0.1.0",
+  "description": "Demo for LlamaParse in TypeScript",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"There are no tests\"",
+    "start": "pnpm exec tsx src/index.ts",
+    "lint": "eslint ./src/",
+    "format": "prettier --write ./src/",
+    "build": "tsc",
+    "dev": "pnpm exec tsx --watch src/index.ts"
+  },
+  "keywords": [
+    "ai",
+    "ocr",
+    "parsing",
+    "intelligent-document-processing",
+    "pdf",
+    "llms"
+  ],
+  "author": "LlamaIndex",
+  "license": "MIT",
+  "packageManager": "pnpm@10.12.4",
+  "devDependencies": {
+    "@eslint/js": "^9.32.0",
+    "@types/figlet": "^1.7.0",
+    "@types/node": "^24.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.38.0",
+    "@typescript-eslint/parser": "^8.38.0",
+    "eslint": "^9.32.0",
+    "globals": "^16.3.0",
+    "jiti": "^2.5.1",
+    "prettier": "^3.6.2",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.38.0"
+  },
+  "dependencies": {
+    "@ai-sdk/openai": "^1.3.23",
+    "ai": "^4.3.19",
+    "consola": "^3.4.2",
+    "figlet": "^1.8.2",
+    "llama-cloud-services": "link:../../ts/llama_cloud_services",
+    "picocolors": "^1.1.1"
+  }
+}

examples-ts/parse/src/index.ts

@@ -0,0 +1,34 @@
+import { LlamaParseReader } from "llama-cloud-services";
+import { logger } from "./logger";
+import pc from "picocolors";
+import { consoleInput, generateSummary, renderLogo } from "./utils";
+
+export async function main(): Promise<number> {
+  const reader = new LlamaParseReader({ resultType: "markdown" });
+  await renderLogo();
+  logger.log(
+    `Welcome to ${pc.bold(
+      pc.magentaBright("✨LlamaParse Demo✨"),
+    )}, our demo for ${pc.bold(pc.green("LlamaParse🦙"))}, a ${pc.bold(
+      pc.cyan("LlamaCloud☁️"),
+    )}  (https://cloud.llamaindex.ai) product!.\nType the path to the document you would like to process below👇\nIf you wish to exit, just type ${pc.bold(
+      pc.gray("quit"),
+    )}.\n`,
+  );
+  while (true) {
+    const userInput = await consoleInput();
+    if (userInput.toLowerCase() == "quit") {
+      break;
+    }
+    try {
+      const documents = await reader.loadData(userInput);
+      const summary = await generateSummary(documents); // Added await here
+      logger.log(`${pc.bold(pc.cyan("AI-generated summary✨"))}:\n${summary}`);
+    } catch (error) {
+      logger.error(`Error processing file: ${error}`);
+    }
+  }
+  return 0;
+}
+
+main().catch(console.error);

examples-ts/parse/src/logger.ts

@@ -0,0 +1,8 @@
+import { createConsola } from "consola";
+import type { ConsolaInstance } from "consola";
+
+export const logger: ConsolaInstance = createConsola({
+  formatOptions: {
+    date: false,
+  },
+});

examples-ts/parse/src/utils.ts

@@ -0,0 +1,51 @@
+import { generateText } from "ai";
+import { openai } from "@ai-sdk/openai";
+import { Document } from "llamaindex";
+import * as readline from "readline/promises";
+import figlet from "figlet";
+import pc from "picocolors";
+
+export async function renderLogo(): Promise<void> {
+  const logoText = figlet.textSync("LlamaParse Demo", {
+    font: "ANSI Shadow",
+    horizontalLayout: "default",
+    verticalLayout: "default",
+    width: 100,
+    whitespaceBreak: true,
+  });
+
+  // Add some styling with picocolors
+  const styledLogo = pc.bold(pc.magentaBright(logoText));
+
+  // Add some padding/margin
+  console.log("\n");
+  console.log(styledLogo);
+  console.log(pc.gray("─".repeat(60)));
+  console.log("\n");
+}
+
+export async function consoleInput(): Promise<string> {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  const answer = await rl.question("Path to your file: ");
+  rl.close();
+  return answer;
+}
+
+export async function generateSummary(documents: Document[]): Promise<string> {
+  let mainText: string = "";
+
+  for (const document of documents) {
+    mainText += `${document.text}\n\n---\n\n`;
+  }
+
+  const { text } = await generateText({
+    model: openai("gpt-4.1"),
+    prompt: `</chat>\n\t<text>${mainText}</text>\n\t<instructions>Could you please generate a summary of the given text?</instructions>\n</chat>`,
+  });
+
+  return text;
+}

examples-ts/parse/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "lib": ["ES2022"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "types": ["node"],
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

examples/README.md

@@ -0,0 +1,9 @@
+# LlamaCloud Services Examples - Python
+
+In this folder you will find several python notebooks that contain examples regarding:
+
+- [LlamaParse](./parse/)
+- [LlamaExtract](./extract/)
+- [LlamaCloudIndex](./index/)
+
+Follow the instructions in each notebook to get started!

examples/agents/demo_simple_openai_agent.ipynb

@@ -1,302 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# LlamaParse Agent\n",
-    "\n",
-    "This demo walks through using an OpenAI Agent with [LlamaParse](https://cloud.llamaindex.ai)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Setup"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install llama-parse llama-index llama-index-postprocessor-sbert-rerank"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"llx-...\"\n",
-    "os.environ[\"OPENAI_API_KEY\"] = \"sk-...\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import Settings\n",
-    "from llama_index.embeddings.openai import OpenAIEmbedding\n",
-    "from llama_index.llms.openai import OpenAI\n",
-    "\n",
-    "Settings.embed_model = OpenAIEmbedding(model=\"text-embedding-3-small\")\n",
-    "Settings.llm = OpenAI(model=\"gpt-3.5-turbo\", temperature=0.2)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Parsing \n",
-    "\n",
-    "For parsing, lets use a [recent paper](https://huggingface.co/papers/2403.09611) on Multi-Modal pretraining"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!wget https://arxiv.org/pdf/2403.09611.pdf -O paper.pdf"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Below, we can tell the parser to skip content we don't want. In this case, the references section will just add noise to a RAG system."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "parser = LlamaParse(\n",
-    "    result_type=\"markdown\",\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 81251f39-01be-434e-99e8-1c1b83b82098\n"
-     ]
-    }
-   ],
-   "source": [
-    "documents = await parser.aload_data(\"paper.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Embeddings have been explicitly disabled. Using MockEmbedding.\n"
-     ]
-    },
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "41it [00:00, 26765.21it/s]\n",
-      "100%|██████████| 41/41 [00:13<00:00,  2.98it/s]\n"
-     ]
-    }
-   ],
-   "source": [
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()\n",
-    "\n",
-    "from llama_index.core.node_parser import (\n",
-    "    MarkdownElementNodeParser,\n",
-    "    SentenceSplitter,\n",
-    ")\n",
-    "\n",
-    "# explicitly extract tables with the MarkdownElementNodeParser\n",
-    "node_parser = MarkdownElementNodeParser(num_workers=8)\n",
-    "nodes = node_parser.get_nodes_from_documents(documents)\n",
-    "nodes, objects = node_parser.get_nodes_and_objects(nodes)\n",
-    "\n",
-    "# Chain splitters to ensure chunk size requirements are met\n",
-    "nodes = SentenceSplitter(chunk_size=512, chunk_overlap=20).get_nodes_from_documents(\n",
-    "    nodes\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Chat over the paper, lets find out what it is about!"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import VectorStoreIndex, SummaryIndex\n",
-    "\n",
-    "vector_index = VectorStoreIndex(nodes=nodes)\n",
-    "summary_index = SummaryIndex(nodes=nodes)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.agent.openai import OpenAIAgent\n",
-    "from llama_index.core.tools import QueryEngineTool, ToolMetadata\n",
-    "from llama_index.postprocessor.colbert_rerank import ColbertRerank\n",
-    "\n",
-    "tools = [\n",
-    "    QueryEngineTool(\n",
-    "        vector_index.as_query_engine(\n",
-    "            similarity_top_k=8, node_postprocessors=[ColbertRerank(top_n=3)]\n",
-    "        ),\n",
-    "        metadata=ToolMetadata(\n",
-    "            name=\"search\",\n",
-    "            description=\"Search the document, pass the entire user message in the query\",\n",
-    "        ),\n",
-    "    ),\n",
-    "    QueryEngineTool(\n",
-    "        summary_index.as_query_engine(),\n",
-    "        metadata=ToolMetadata(\n",
-    "            name=\"summarize\",\n",
-    "            description=\"Summarize the document using the user message\",\n",
-    "        ),\n",
-    "    ),\n",
-    "]\n",
-    "\n",
-    "agent = OpenAIAgent.from_tools(tools=tools, verbose=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Added user message to memory: What is the summary of the paper?\n",
-      "=== Calling Function ===\n",
-      "Calling function: summarize with args: {\"input\":\"summary\"}\n",
-      "Got output: The research focuses on developing Multimodal Large Language Models (MLLMs) by incorporating image-caption, interleaved image-text, and text-only data for pre-training. It highlights the importance of factors like the image encoder, resolution, and token count, while downplaying the design of the vision-language connector. With models scaling up to 30B parameters, the MM1 family demonstrates impressive performance in pre-training metrics and competitive outcomes on diverse multimodal benchmarks. It demonstrates abilities such as in-context learning and multi-image reasoning, aiming to provide valuable insights for creating MLLMs that benefit the research community.\n",
-      "========================\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "# note -- this will take a while with local LLMs, its sending every node in the document to the LLM\n",
-    "resp = agent.chat(\"What is the summary of the paper?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The summary of the paper highlights the development of Multimodal Large Language Models (MLLMs) by incorporating image-caption, interleaved image-text, and text-only data for pre-training. The research emphasizes factors like the image encoder, resolution, and token count, while de-emphasizing the design of the vision-language connector. The MM1 family of models, scaling up to 30B parameters, shows impressive performance in pre-training metrics and competitive outcomes on various multimodal benchmarks. These models demonstrate capabilities such as in-context learning and multi-image reasoning, aiming to provide valuable insights for creating MLLMs that benefit the research community.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(str(resp))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Added user message to memory: How do the authors evaluate their work?\n",
-      "=== Calling Function ===\n",
-      "Calling function: search with args: {\"input\":\"evaluation methods\"}\n",
-      "Got output: The evaluation methods involve synthesizing all benchmark results into a single meta-average number to simplify comparisons. This is achieved by normalizing the evaluation metrics with respect to a baseline configuration, standardizing the results for each task, adjusting every metric by dividing it by its respective baseline, and then averaging across all metrics.\n",
-      "========================\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "resp = agent.chat(\"How do the authors evaluate their work?\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The authors evaluate their work by synthesizing all benchmark results into a single meta-average number to simplify comparisons. They normalize the evaluation metrics with respect to a baseline configuration, standardize the results for each task, adjust every metric by dividing it by its respective baseline, and then average across all metrics for evaluation.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(str(resp))"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama-parse-aNC435Vv-py3.10",
-   "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"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

examples/caltrain/caltrain_text_mode.ipynb

@@ -1,529 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "c148b65e-e8a6-476e-86ba-bf6a73d479c7",
-   "metadata": {},
-   "source": [
-    "# RAG over the Caltrain Weekend Schedule \n",
-    "\n",
-    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/caltrain/caltrain_text_mode.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
-    "\n",
-    "This example shows off LlamaParse parsing capabilities to build a functioning query pipeline over the Caltrain weekend schedule, a big timetable containing all trains northbound and southbound and their stops in various cities.\n",
-    "\n",
-    "Naive parsing solutions mess up in representing this tabular representation, leading to LLM hallucinations. In contrast, LlamaParse text-mode spatially lays out the table in a neat format, enabling more sophisticated LLMs like gpt-4-turbo to understand the spacing and reason over all the numbers.\n",
-    "\n",
-    "**NOTE**: LlamaParse markdown mode doesn't quite work yet - it's in development!"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "ef115dbe-b834-4639-828e-e2c11aef710b",
-   "metadata": {},
-   "source": [
-    "## Setup\n",
-    "\n",
-    "Download the data."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e6ae2e38-30c9-4865-aa13-47780bc3848f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "335ce1d0-757a-4f09-846e-21c409768871",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!wget \"https://www.caltrain.com/media/31602/download?inline?inline\" -O caltrain_schedule_weekend.pdf"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "45fa9120-65bb-4772-9db7-53e7cecf9adc",
-   "metadata": {},
-   "source": [
-    "## Initialize LlamaParse\n",
-    "\n",
-    "Initialize LlamaParse in `text` mode which will represent complex documents incl. text, tables, and figures as nicely formatted text."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "54aa9579-84d4-49bc-ab54-5474e69c1188",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/Users/jerryliu/Programming/llama_parse/.venv/lib/python3.10/site-packages/tqdm/auto.py:21: TqdmWarning: IProgress not found. Please update jupyter and ipywidgets. See https://ipywidgets.readthedocs.io/en/stable/user_install.html\n",
-      "  from .autonotebook import tqdm as notebook_tqdm\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 5f73353a-1f4b-480d-9eea-58d1d22b75f6\n"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "docs = LlamaParse(result_type=\"text\").load_data(\"./caltrain_schedule_weekend.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "602756b2-9ea1-4519-a8e3-c773ec624205",
-   "metadata": {},
-   "source": [
-    "Take a look at the below text (and zoom out from the browser to really get the effect!). You'll see that the entire table is nicely laid out."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4928281a-591a-4653-b451-b2b8112a7101",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "ZONE 2ZONE 3ZONE 4ZONE 4 ZONE 3ZONE 2ZONE 1ZONE 1\n",
-      "                                      Printer-Friendly Caltrain Schedule\n",
-      "              Northbound –                         WEEKEND SERVICE to SAN FRANCISCO                                                                                                                2XX Local\n",
-      "\n",
-      "\n",
-      "                  Train No.       221        225        229        233        237        241        245        249        253        257        261        265        269        273       *277       *281\n",
-      "                 Service Types      L2        L2          L2        L2         L2         L2         L2         L2         L2         L2         L2         L2         L2         L2         L2         L2\n",
-      "                      Tamien      7:12a      9:05a     10:05a     11:05a                1:05p                 3:05p                 5:05p                 7:05p                 9:05p                11:05p\n",
-      "           San Jose Diridon       7:19a      9:12a     10:12a     11:12a    12:12p      1:12p      2:12p      3:12p      4:12p      5:12p      6:12p      7:12p      8:12p      9:12p     10:19p     11:12p\n",
-      "                 Santa Clara      7:25a      9:18a     10:18a     11:18a    12:18p      1:18p      2:18p      3:18p      4:18p      5:18p      6:18p      7:18p      8:18p      9:18p     10:25p     11:18p\n",
-      "                   Lawrence       7:31a      9:24a     10:24a     11:24a    12:24p      1:24p      2:24p      3:24p      4:24p      5:24p      6:24p      7:24p      8:24p      9:24p     10:31p     11:24p\n",
-      "                  Sunnyvale       7:35a      9:28a     10:28a     11:28a    12:28p      1:28p      2:28p      3:28p      4:28p      5:28p      6:28p      7:28p      8:28p      9:28p     10:35p     11:28p\n",
-      "            Mountain View         7:40a      9:34a     10:34a     11:34a    12:34p      1:34p      2:34p      3:34p      4:34p      5:34p      6:34p      7:34p      8:34p      9:34p     10:40p     11:34p\n",
-      "                San Antonio       7:43a      9:37a     10:37a     11:37a    12:37p      1:37p      2:37p      3:37p      4:37p      5:37p      6:37p      7:37p      8:37p      9:37p     10:44p     11:37p\n",
-      "              California Ave      7:48a      9:42a     10:42a     11:42a    12:42p      1:42p      2:42p      3:42p      4:42p      5:42p      6:42p      7:42p      8:42p      9:42p     10:48p     11:42p\n",
-      "                    Palo Alto     7:52a      9:46a     10:46a     11:46a    12:46p      1:46p      2:46p      3:46p      4:46p      5:46p      6:46p      7:46p      8:46p      9:46p     10:53p     11:46p\n",
-      "                 Menlo Park       7:55a      9:50a     10:50a     11:50a    12:50p      1:50p      2:50p      3:50p      4:50p      5:50p      6:50p      7:50p      8:50p      9:50p     10:56p     11:50p\n",
-      "              Redwood City        8:01a      9:56a     10:56a     11:56a    12:56p      1:56p      2:56p      3:56p      4:56p      5:56p      6:56p      7:56p      8:56p      9:56p     11:02p     11:56p\n",
-      "                  San Carlos      8:05a     10:01a     11:01a     12:01p     1:01p      2:01p      3:01p      4:01p      5:01p      6:01p      7:01p      8:01p      9:01p     10:01p     11:07p     12:01a\n",
-      "                    Belmont       8:09a     10:04a     11:04a     12:04p     1:04p      2:04p      3:04p      4:04p      5:04p      6:04p      7:04p      8:04p      9:04p     10:04p     11:10p     12:04a\n",
-      "                    Hillsdale     8:12a     10:08a     11:08a     12:08p     1:08p      2:08p      3:08p      4:08p      5:08p      6:08p      7:08p      8:08p      9:08p     10:08p     11:14p     12:08a\n",
-      "              Hayward Park        8:15a     10:11a     11:11a     12:11p     1:11p      2:11p      3:11p      4:11p      5:11p      6:11p      7:11p      8:11p      9:11p     10:11p     11:17p     12:11a\n",
-      "                  San Mateo       8:19a     10:15a     11:15a     12:15p     1:15p      2:15p      3:15p      4:15p      5:15p      6:15p      7:15p      8:15p      9:15p     10:15p     11:21p     12:15a\n",
-      "                 Burlingame       8:22a     10:19a     11:19a     12:19p     1:19p      2:19p      3:19p      4:19p      5:19p      6:19p      7:19p      8:19p      9:19p     10:19p     11:25p     12:19a\n",
-      "                  Broadway        8:25a     10:22a     11:22a     12:22p     1:22p      2:22p      3:22p      4:22p      5:22p      6:22p      7:22p      8:22p      9:22p     10:22p     11:28p     12:22a\n",
-      "                    Millbrae      8:29a     10:26a     11:26a     12:26p     1:26p      2:26p      3:26p      4:26p      5:26p      6:26p      7:26p      8:26p      9:26p     10:26p     11:32p     12:26a\n",
-      "                  San Bruno       8:34a     10:30a     11:30a     12:30p     1:30p      2:30p      3:30p      4:30p      5:30p      6:30p      7:30p      8:30p      9:30p     10:30p     11:37p     12:30a\n",
-      "            S. San Francisco      8:38a     10:34a     11:34a     12:34p     1:34p      2:34p      3:34p      4:34p      5:34p      6:34p      7:34p      8:34p      9:34p     10:34p     11:41p     12:34a\n",
-      "                   Bayshore       8:44a     10:41a     11:41a     12:41p     1:41p      2:41p      3:41p      4:41p      5:41p      6:41p      7:41p      8:41p      9:41p     10:41p     11:47p     12:41a\n",
-      "                  22 ndStreet     8:50a     10:46a     11:46a     12:46p     1:46p      2:46p      3:46p      4:46p      5:46p      6:46p      7:46p      8:46p      9:46p     10:46p     11:53p     12:46a\n",
-      "                San Francisco     8:56a     10:52a     11:53a     12:53p     1:52p      2:52p      3:52p      4:52p      5:52p      6:52p      7:52p      8:52p      9:52p     10:52p     11:59p     12:52a\n",
-      "                                      *On SAP Center event days, Train 277 or Train 281departure from San Jose Diridon station may be delayed and will depart no later than 10:30p or 11:30p respectively.\n",
-      "\n",
-      "\n",
-      "              Southbound                        –   WEEKEND               SERVICE to SAN JOSE                                                                                                      2XX Local\n",
-      "                  Train No.       224        228        232        236        240        244        248        252        256        260        264        268        272        276        280        284\n",
-      "                 Service Types      L2        L2          L2        L2          L2        L2         L2         L2         L2         L2         L2         L2         L2         L2         L2         L2\n",
-      "               San Francisco      8:28a      9:58a     10:58a     11:58a     12:58p     1:58p      2:58p      3:58p      4:58p      5:58p      6:58p      7:58p      8:58p      9:58p      10:58p     12:05a\n",
-      "                  22 ndStreet     8:33a     10:03a     11:03a     12:03p     1:03p      2:03p      3:03p      4:03p      5:03p      6:03p      7:03p      8:03p      9:03p     10:03p      11:03p     12:10a\n",
-      "                   Bayshore       8:38a     10:08a     11:08a     12:08p     1:08p      2:08p      3:08p      4:08p      5:08p      6:08p      7:08p      8:08p      9:08p     10:08p      11:08p     12:15a\n",
-      "            S. San Francisco      8:45a     10:15a     11:15a     12:15p     1:15p      2:15p      3:15p      4:15p      5:15p      6:15p      7:15p      8:15p      9:15p     10:15p      11:15p     12:22a\n",
-      "                  San Bruno       8:49a     10:19a     11:19a     12:19p     1:19p      2:19p      3:19p      4:19p      5:19p      6:19p      7:19p      8:19p      9:19p     10:19p      11:19p     12:26a\n",
-      "                    Millbrae      8:53a     10:24a     11:24a     12:24p     1:24p      2:24p      3:24p      4:24p      5:24p      6:24p      7:24p      8:24p      9:24p     10:24p      11:24p     12:31a\n",
-      "                  Broadway        8:57a     10:27a     11:27a     12:27p     1:27p      2:27p      3:27p      4:27p      5:27p      6:27p      7:27p      8:27p      9:27p     10:27p      11:27p     12:35a\n",
-      "                 Burlingame       9:00a     10:31a     11:31a     12:31p     1:31p      2:31p      3:31p      4:31p      5:31p      6:31p      7:31p      8:31p      9:31p     10:31p      11:31p     12:38a\n",
-      "                  San Mateo       9:04a     10:34a     11:34a     12:34p     1:34p      2:34p      3:34p      4:34p      5:34p      6:34p      7:34p      8:34p      9:34p     10:34p      11:34p     12:41a\n",
-      "              Hayward Park        9:07a     10:37a     11:37a     12:37p     1:37p      2:37p      3:37p      4:37p      5:37p      6:37p      7:37p      8:37p      9:37p     10:37p      11:37p     12:45a\n",
-      "                    Hillsdale     9:10a     10:41a     11:41a     12:41p     1:41p      2:41p      3:41p      4:41p      5:41p      6:41p      7:41p      8:41p      9:41p     10:41p      11:41p     12:48a\n",
-      "                    Belmont       9:14a     10:44a     11:44a     12:44p     1:44p      2:44p      3:44p      4:44p      5:44p      6:44p      7:44p      8:44p      9:44p     10:44p      11:44p     12:52a\n",
-      "                  San Carlos      9:17a     10:48a     11:48a     12:48p     1:48p      2:48p      3:48p      4:48p      5:48p      6:48p      7:48p      8:48p      9:48p     10:48p      11:48p     12:55a\n",
-      "              Redwood City        9:21a     10:52a     11:52a     12:52p     1:52p      2:52p      3:52p      4:52p      5:52p      6:52p      7:52p      8:52p      9:52p     10:52p      11:52p     12:59a\n",
-      "                 Menlo Park       9:28a     10:58a     11:58a     12:58p     1:58p      2:58p      3:58p      4:58p      5:58p      6:58p      7:58p      8:58p      9:58p     10:58p      11:58p     1:05a\n",
-      "                    Palo Alto     9:32a     11:02a     12:02p     1:02p      2:02p      3:02p      4:02p      5:02p      6:02p      7:02p      8:02p      9:02p     10:02p     11:02p      12:02a     1:09a\n",
-      "         California Avenue        9:36a     11:06a     12:06p     1:06p      2:06p      3:06p      4:06p      5:06p      6:06p      7:06p      8:06p      9:06p     10:06p     11:06p      12:06a     1:12a\n",
-      "                San Antonio       9:41a     11:11a     12:11p     1:11p      2:11p      3:11p      4:11p      5:11p      6:11p      7:11p      8:11p      9:11p     10:11p     11:11p      12:10a     1:17a\n",
-      "            Mountain View         9:45a     11:16a     12:16p     1:16p      2:16p      3:16p      4:16p      5:16p      6:16p      7:16p      8:16p      9:16p     10:16p     11:16p      12:15a     1:21a\n",
-      "                  Sunnyvale       9:51a     11:21a     12:21p     1:21p      2:21p      3:21p      4:21p      5:21p      6:21p      7:21p      8:21p      9:21p     10:21p     11:21p      12:20a     1:26a\n",
-      "                   Lawrence       9:55a     11:26a     12:26p     1:26p      2:26p      3:26p      4:26p      5:26p      6:26p      7:26p      8:26p      9:26p     10:26p     11:26p      12:25a     1:31a\n",
-      "                 Santa Clara     10:01a     11:32a     12:32p     1:32p      2:32p      3:32p      4:32p      5:32p      6:32p      7:32p      8:32p      9:32p     10:32p     11:32p      12:31a     1:37a\n",
-      "           San Jose Diridon      10:10a     11:40a     12:40p     1:38p      2:40p      3:38p      4:40p      5:38p      6:40p      7:38p      8:40p      9:38p     10:40p     11:38p      12:39a     1:44a\n",
-      "                      Tamien     10:15a     11:45a     12:45p                2:45p                 4:45p                 6:45p                 8:45p                10:45p                 12:44a     1:49a\n",
-      "       EFFECTIVE September 12, 2022                                                                                                                                  Timetable subject to change without notice.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(docs[0].get_content())"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "8f5064d4-3e33-4f67-9b2e-46787161538f",
-   "metadata": {},
-   "source": [
-    "## Initialize Query Engine\n",
-    "\n",
-    "We now initialize a query engine over this data. Here we use a baseline summary index, which doesn't do vector indexing/chunking and instead dumps the entire text into the prompt.\n",
-    "\n",
-    "We see that the LLM (gpt-4-turbo) is able to provide all the stops for train no 225 northbound."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "b3e985b6-9d38-449f-9cf9-aae166824eed",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import SummaryIndex\n",
-    "from llama_index.llms.openai import OpenAI\n",
-    "\n",
-    "llm = OpenAI(model=\"gpt-4o\")\n",
-    "index = SummaryIndex.from_documents(docs)\n",
-    "query_engine = index.as_query_engine(llm=llm)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "66eb0976-2cd6-4b14-9083-124baae9ed5d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "response = query_engine.query(\n",
-    "    \"What are the stops (and times) for train no 237 northbound?\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7dc6f275-07f4-429e-9335-f50982fe974c",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The stops and times for train no. 237 northbound are as follows:\n",
-      "\n",
-      "- San Jose Diridon: 12:12 PM\n",
-      "- Santa Clara: 12:18 PM\n",
-      "- Lawrence: 12:24 PM\n",
-      "- Sunnyvale: 12:28 PM\n",
-      "- Mountain View: 12:34 PM\n",
-      "- San Antonio: 12:37 PM\n",
-      "- California Ave: 12:42 PM\n",
-      "- Palo Alto: 12:46 PM\n",
-      "- Menlo Park: 12:50 PM\n",
-      "- Redwood City: 12:56 PM\n",
-      "- San Carlos: 1:01 PM\n",
-      "- Belmont: 1:04 PM\n",
-      "- Hillsdale: 1:08 PM\n",
-      "- Hayward Park: 1:11 PM\n",
-      "- San Mateo: 1:15 PM\n",
-      "- Burlingame: 1:19 PM\n",
-      "- Broadway: 1:22 PM\n",
-      "- Millbrae: 1:26 PM\n",
-      "- San Bruno: 1:30 PM\n",
-      "- S. San Francisco: 1:34 PM\n",
-      "- Bayshore: 1:41 PM\n",
-      "- 22nd Street: 1:46 PM\n",
-      "- San Francisco: 1:52 PM\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(str(response))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "229c4cb0-cf94-4a9f-bc7c-590388f50c1f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "response = query_engine.query(\n",
-    "    \"What are all the trains (and times) that end at Tamien going Southbound?\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "6cf9fce0-5067-48f6-a7ef-62aa9e2edc3d",
-   "metadata": {},
-   "source": [
-    "It gets most of the answers correct (to be fair it misses two trains)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "51cf03ff-7728-4815-ab72-3bf54fc4a2c0",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The trains that end at Tamien going Southbound are:\n",
-      "\n",
-      "- Train 224 at 10:15a\n",
-      "- Train 228 at 11:45a\n",
-      "- Train 240 at 2:45p\n",
-      "- Train 248 at 4:45p\n",
-      "- Train 256 at 6:45p\n",
-      "- Train 264 at 8:45p\n",
-      "- Train 272 at 10:45p\n",
-      "- Train 284 at 1:49a\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(str(response))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e51e7feb-b74f-4101-8963-933ac7ec9763",
-   "metadata": {},
-   "source": [
-    "## Try Baseline\n",
-    "\n",
-    "In contrast, we try a baseline approach with the default PDF reader (PyPDF) in `SimpleDirectoryReader`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "364e5155-cc75-4302-a754-9444ae28e6b1",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import SimpleDirectoryReader\n",
-    "from llama_index.core import SummaryIndex\n",
-    "from llama_index.llms.openai import OpenAI\n",
-    "\n",
-    "llm = OpenAI(model=\"gpt-4o\")\n",
-    "input_file = \"caltrain_schedule_weekend.pdf\"\n",
-    "reader = SimpleDirectoryReader(input_files=[input_file])\n",
-    "base_docs = reader.load_data()\n",
-    "index = SummaryIndex.from_documents(base_docs)\n",
-    "base_query_engine = index.as_query_engine(llm=llm)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "a4011389-2d27-4a1a-bf8d-7309da28ab15",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Southbound  – WEEKEND SERVICE to SAN JOSE\n",
-      "Train No. 224 228 232 236 240 244 248 252 256 260 264 268 272 276 280 284\n",
-      "Service Types L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2\n",
-      "San Francisco 8:28a 9:58a 10:58a 11:58a 12:58p 1:58p 2:58p 3:58p 4:58p 5:58p 6:58p 7:58p 8:58p 9:58p 10:58p 12:05a\n",
-      "22nd Street 8:33a 10:03a 11:03a 12:03p 1:03p 2:03p 3:03p 4:03p 5:03p 6:03p 7:03p 8:03p 9:03p 10:03p 11:03p 12:10a\n",
-      "Bayshore 8:38a 10:08a 11:08a 12:08p 1:08p 2:08p 3:08p 4:08p 5:08p 6:08p 7:08p 8:08p 9:08p 10:08p 11:08p 12:15a\n",
-      "S. San Francisco 8:45a 10:15a 11:15a 12:15p 1:15p 2:15p 3:15p 4:15p 5:15p 6:15p 7:15p 8:15p 9:15p 10:15p 11:15p 12:22a\n",
-      "San Bruno 8:49a 10:19a 11:19a 12:19p 1:19p 2:19p 3:19p 4:19p 5:19p 6:19p 7:19p 8:19p 9:19p 10:19p 11:19p 12:26a\n",
-      "Millbrae 8:53a 10:24a 11:24a 12:24p 1:24p 2:24p 3:24p 4:24p 5:24p 6:24p 7:24p 8:24p 9:24p 10:24p 11:24p 12:31a\n",
-      "Broadway 8:57a 10:27a 11:27a 12:27p 1:27p 2:27p 3:27p 4:27p 5:27p 6:27p 7:27p 8:27p 9:27p 10:27p 11:27p 12:35a\n",
-      "Burlingame 9:00a 10:31a 11:31a 12:31p 1:31p 2:31p 3:31p 4:31p 5:31p 6:31p 7:31p 8:31p 9:31p 10:31p 11:31p 12:38a\n",
-      "San Mateo 9:04a 10:34a 11:34a 12:34p 1:34p 2:34p 3:34p 4:34p 5:34p 6:34p 7:34p 8:34p 9:34p 10:34p 11:34p 12:41a\n",
-      "Hayward Park 9:07a 10:37a 11:37a 12:37p 1:37p 2:37p 3:37p 4:37p 5:37p 6:37p 7:37p 8:37p 9:37p 10:37p 11:37p 12:45a\n",
-      "Hillsdale 9:10a 10:41a 11:41a 12:41p 1:41p 2:41p 3:41p 4:41p 5:41p 6:41p 7:41p 8:41p 9:41p 10:41p 11:41p 12:48a\n",
-      "Belmont 9:14a 10:44a 11:44a 12:44p 1:44p 2:44p 3:44p 4:44p 5:44p 6:44p 7:44p 8:44p 9:44p 10:44p 11:44p 12:52a\n",
-      "San Carlos 9:17a 10:48a 11:48a 12:48p 1:48p 2:48p 3:48p 4:48p 5:48p 6:48p 7:48p 8:48p 9:48p 10:48p 11:48p 12:55a\n",
-      "Redwood City 9:21a 10:52a 11:52a 12:52p 1:52p 2:52p 3:52p 4:52p 5:52p 6:52p 7:52p 8:52p 9:52p 10:52p 11:52p 12:59a\n",
-      "Menlo Park 9:28a 10:58a 11:58a 12:58p 1:58p 2:58p 3:58p 4:58p 5:58p 6:58p 7:58p 8:58p 9:58p 10:58p 11:58p 1:05a\n",
-      "Palo Alto 9:32a 11:02a 12:02p 1:02p 2:02p 3:02p 4:02p 5:02p 6:02p 7:02p 8:02p 9:02p 10:02p 11:02p 12:02a 1:09a\n",
-      "California Avenue 9:36a 11:06a 12:06p 1:06p 2:06p 3:06p 4:06p 5:06p 6:06p 7:06p 8:06p 9:06p 10:06p 11:06p 12:06a 1:12a\n",
-      "San Antonio 9:41a 11:11a 12:11p 1:11p 2:11p 3:11p 4:11p 5:11p 6:11p 7:11p 8:11p 9:11p 10:11p 11:11p 12:10a 1:17a\n",
-      "Mountain View 9:45a 11:16a 12:16p 1:16p 2:16p 3:16p 4:16p 5:16p 6:16p 7:16p 8:16p 9:16p 10:16p 11:16p 12:15a 1:21a\n",
-      "Sunnyvale 9:51a 11:21a 12:21p 1:21p 2:21p 3:21p 4:21p 5:21p 6:21p 7:21p 8:21p 9:21p 10:21p 11:21p 12:20a 1:26a\n",
-      "Lawrence 9:55a 11:26a 12:26p 1:26p 2:26p 3:26p 4:26p 5:26p 6:26p 7:26p 8:26p 9:26p 10:26p 11:26p 12:25a 1:31a\n",
-      "Santa Clara 10:01a 11:32a 12:32p 1:32p 2:32p 3:32p 4:32p 5:32p 6:32p 7:32p 8:32p 9:32p 10:32p 11:32p 12:31a 1:37a\n",
-      "San Jose Diridon 10:10a 11:40a 12:40p 1:38p 2:40p 3:38p 4:40p 5:38p 6:40p 7:38p 8:40p 9:38p 10:40p 11:38p 12:39a 1:44a\n",
-      "Tamien 10:15a 11:45a 12:45p 2:45p 4:45p 6:45p 8:45p 10:45p 12:44a 1:49aPrinter-Friendly Caltrain Schedule\n",
-      "Northbound  – WEEKEND SERVICE to SAN FRANCISCO\n",
-      "Train No. 221 225 229 233 237 241 245 249 253 257 261 265 269 273 *277 *281\n",
-      "Service Types L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2 L2\n",
-      "Tamien 7:12a 9:05a 10:05a 11:05a 1:05p 3:05p 5:05p 7:05p 9:05p 11:05p\n",
-      "San Jose Diridon 7:19a 9:12a 10:12a 11:12a 12:12p 1:12p 2:12p 3:12p 4:12p 5:12p 6:12p 7:12p 8:12p 9:12p 10:19p 11:12p\n",
-      "Santa Clara 7:25a 9:18a 10:18a 11:18a 12:18p 1:18p 2:18p 3:18p 4:18p 5:18p 6:18p 7:18p 8:18p 9:18p 10:25p 11:18p\n",
-      "Lawrence 7:31a 9:24a 10:24a 11:24a 12:24p 1:24p 2:24p 3:24p 4:24p 5:24p 6:24p 7:24p 8:24p 9:24p 10:31p 11:24p\n",
-      "Sunnyvale 7:35a 9:28a 10:28a 11:28a 12:28p 1:28p 2:28p 3:28p 4:28p 5:28p 6:28p 7:28p 8:28p 9:28p 10:35p 11:28p\n",
-      "Mountain View 7:40a 9:34a 10:34a 11:34a 12:34p 1:34p 2:34p 3:34p 4:34p 5:34p 6:34p 7:34p 8:34p 9:34p 10:40p 11:34p\n",
-      "San Antonio 7:43a 9:37a 10:37a 11:37a 12:37p 1:37p 2:37p 3:37p 4:37p 5:37p 6:37p 7:37p 8:37p 9:37p 10:44p 11:37p\n",
-      "California Ave 7:48a 9:42a 10:42a 11:42a 12:42p 1:42p 2:42p 3:42p 4:42p 5:42p 6:42p 7:42p 8:42p 9:42p 10:48p 11:42p\n",
-      "Palo Alto 7:52a 9:46a 10:46a 11:46a 12:46p 1:46p 2:46p 3:46p 4:46p 5:46p 6:46p 7:46p 8:46p 9:46p 10:53p 11:46p\n",
-      "Menlo Park 7:55a 9:50a 10:50a 11:50a 12:50p 1:50p 2:50p 3:50p 4:50p 5:50p 6:50p 7:50p 8:50p 9:50p 10:56p 11:50p\n",
-      "Redwood City 8:01a 9:56a 10:56a 11:56a 12:56p 1:56p 2:56p 3:56p 4:56p 5:56p 6:56p 7:56p 8:56p 9:56p 11:02p 11:56p\n",
-      "San Carlos 8:05a 10:01a 11:01a 12:01p 1:01p 2:01p 3:01p 4:01p 5:01p 6:01p 7:01p 8:01p 9:01p 10:01p 11:07p 12:01a\n",
-      "Belmont 8:09a 10:04a 11:04a 12:04p 1:04p 2:04p 3:04p 4:04p 5:04p 6:04p 7:04p 8:04p 9:04p 10:04p 11:10p 12:04a\n",
-      "Hillsdale 8:12a 10:08a 11:08a 12:08p 1:08p 2:08p 3:08p 4:08p 5:08p 6:08p 7:08p 8:08p 9:08p 10:08p 11:14p 12:08a\n",
-      "Hayward Park 8:15a 10:11a 11:11a 12:11p 1:11p 2:11p 3:11p 4:11p 5:11p 6:11p 7:11p 8:11p 9:11p 10:11p 11:17p 12:11a\n",
-      "San Mateo 8:19a 10:15a 11:15a 12:15p 1:15p 2:15p 3:15p 4:15p 5:15p 6:15p 7:15p 8:15p 9:15p 10:15p 11:21p 12:15a\n",
-      "Burlingame 8:22a 10:19a 11:19a 12:19p 1:19p 2:19p 3:19p 4:19p 5:19p 6:19p 7:19p 8:19p 9:19p 10:19p 11:25p 12:19a\n",
-      "Broadway 8:25a 10:22a 11:22a 12:22p 1:22p 2:22p 3:22p 4:22p 5:22p 6:22p 7:22p 8:22p 9:22p 10:22p 11:28p 12:22a\n",
-      "Millbrae 8:29a 10:26a 11:26a 12:26p 1:26p 2:26p 3:26p 4:26p 5:26p 6:26p 7:26p 8:26p 9:26p 10:26p 11:32p 12:26a\n",
-      "San Bruno 8:34a 10:30a 11:30a 12:30p 1:30p 2:30p 3:30p 4:30p 5:30p 6:30p 7:30p 8:30p 9:30p 10:30p 11:37p 12:30a\n",
-      "S. San Francisco 8:38a 10:34a 11:34a 12:34p 1:34p 2:34p 3:34p 4:34p 5:34p 6:34p 7:34p 8:34p 9:34p 10:34p 11:41p 12:34a\n",
-      "Bayshore 8:44a 10:41a 11:41a 12:41p 1:41p 2:41p 3:41p 4:41p 5:41p 6:41p 7:41p 8:41p 9:41p 10:41p 11:47p 12:41a\n",
-      "22nd Street 8:50a 10:46a 11:46a 12:46p 1:46p 2:46p 3:46p 4:46p 5:46p 6:46p 7:46p 8:46p 9:46p 10:46p 11:53p 12:46a\n",
-      "San Francisco 8:56a 10:52a 11:53a 12:53p 1:52p 2:52p 3:52p 4:52p 5:52p 6:52p 7:52p 8:52p 9:52p 10:52p 11:59p 12:52aZONE 2 ZONE 3 ZONE 4 ZONE 4 ZONE 3 ZONE 2 ZONE 1 ZONE 12XX Local\n",
-      "2XX Local\n",
-      "EFFECTIVE September 12, 2022  Timetable subject to change without notice. *On SAP Center event days, Train 277 or Train 281departure from San Jose Diridon station may be delayed and will depart no later than 10:30p or 11:30p respectively.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(base_docs[0].get_content())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "42203c70-7ca7-4200-bf47-6282eefca3bf",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "base_response = base_query_engine.query(\n",
-    "    \"What are the stops (and times) for train no 237 northbound?\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "06aa47b6-0f31-4b2d-90f0-bf6c74befd38",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Train No. 237 northbound stops at the following stations and times:\n",
-      "\n",
-      "- Tamien: 1:05p\n",
-      "- San Jose Diridon: 1:12p\n",
-      "- Santa Clara: 1:18p\n",
-      "- Lawrence: 1:24p\n",
-      "- Sunnyvale: 1:28p\n",
-      "- Mountain View: 1:34p\n",
-      "- San Antonio: 1:37p\n",
-      "- California Ave: 1:42p\n",
-      "- Palo Alto: 1:46p\n",
-      "- Menlo Park: 1:50p\n",
-      "- Redwood City: 1:56p\n",
-      "- San Carlos: 2:01p\n",
-      "- Belmont: 2:04p\n",
-      "- Hillsdale: 2:08p\n",
-      "- Hayward Park: 2:11p\n",
-      "- San Mateo: 2:15p\n",
-      "- Burlingame: 2:19p\n",
-      "- Broadway: 2:22p\n",
-      "- Millbrae: 2:26p\n",
-      "- San Bruno: 2:30p\n",
-      "- S. San Francisco: 2:34p\n",
-      "- Bayshore: 2:41p\n",
-      "- 22nd Street: 2:46p\n",
-      "- San Francisco: 2:52p\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(str(base_response))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4f3c1de7-3351-4cd8-991c-34a777952194",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "base_response = base_query_engine.query(\n",
-    "    \"What are all the trains (and times) that end at Tamien going Southbound?\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "513b1007-7508-4fb1-836c-de9353433a67",
-   "metadata": {},
-   "source": [
-    "Note that the trains don't line up with the times!"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "108edb92-76af-406b-a139-8b9e7c6528f2",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The trains that end at Tamien going Southbound are:\n",
-      "\n",
-      "- Train 224 at 10:15a\n",
-      "- Train 228 at 11:45a\n",
-      "- Train 240 at 2:45p\n",
-      "- Train 252 at 4:45p\n",
-      "- Train 264 at 6:45p\n",
-      "- Train 276 at 8:45p\n",
-      "- Train 284 at 10:45p\n",
-      "- Train 284 at 12:44a\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(str(base_response))"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama_parse",
-   "language": "python",
-   "name": "llama_parse"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

examples/demo_advanced.ipynb

@@ -1,759 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Advanced RAG with LlamaParse\n",
-    "\n",
-    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/demo_advanced.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
-    "\n",
-    "This notebook is a complete walkthrough for using LlamaParse with advanced indexing/retrieval techniques in LlamaIndex over the Apple 10K Filing. \n",
-    "\n",
-    "This allows us to ask sophisticated questions that aren't possible with \"naive\" parsing/indexing techniques with existing models.\n",
-    "\n",
-    "Note for this example, we are using the `llama_index >=0.10.4` version"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install llama-index\n",
-    "!pip install llama-index-core==0.10.6.post1\n",
-    "!pip install llama-index-embeddings-openai\n",
-    "!pip install llama-index-postprocessor-flag-embedding-reranker\n",
-    "!pip install git+https://github.com/FlagOpen/FlagEmbedding.git\n",
-    "!pip install llama-parse"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!wget \"https://s2.q4cdn.com/470004039/files/doc_financials/2021/q4/_10-K-2021-(As-Filed).pdf\" -O apple_2021_10k.pdf"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Some OpenAI and LlamaParse details"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# llama-parse is async-first, running the async code in a notebook requires the use of nest_asyncio\n",
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()\n",
-    "\n",
-    "import os\n",
-    "\n",
-    "# API access to llama-cloud\n",
-    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"llx-...\"\n",
-    "\n",
-    "# Using OpenAI API for embeddings/llms\n",
-    "os.environ[\"OPENAI_API_KEY\"] = \"sk-...\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.llms.openai import OpenAI\n",
-    "from llama_index.embeddings.openai import OpenAIEmbedding\n",
-    "from llama_index.core import VectorStoreIndex\n",
-    "from llama_index.core import Settings\n",
-    "\n",
-    "embed_model = OpenAIEmbedding(model=\"text-embedding-3-small\")\n",
-    "llm = OpenAI(model=\"gpt-3.5-turbo-0125\")\n",
-    "\n",
-    "Settings.llm = llm\n",
-    "Settings.embed_model = embed_model"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Using brand new `LlamaParse` PDF reader for PDF Parsing\n",
-    "\n",
-    "we also compare two different retrieval/query engine strategies:\n",
-    "1. Using raw Markdown text as nodes for building index and apply simple query engine for generating the results;\n",
-    "2. Using `MarkdownElementNodeParser` for parsing the `LlamaParse` output Markdown results and building recursive retriever query engine for generation."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id cac11eca-71db-4dab-b72b-c67d31e551f3\n"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "documents = LlamaParse(result_type=\"markdown\").load_data(\"./apple_2021_10k.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from copy import deepcopy\n",
-    "from llama_index.core.schema import TextNode\n",
-    "from llama_index.core import VectorStoreIndex\n",
-    "\n",
-    "\n",
-    "def get_page_nodes(docs, separator=\"\\n---\\n\"):\n",
-    "    \"\"\"Split each document into page node, by separator.\"\"\"\n",
-    "    nodes = []\n",
-    "    for doc in docs:\n",
-    "        doc_chunks = doc.text.split(separator)\n",
-    "        for doc_chunk in doc_chunks:\n",
-    "            node = TextNode(\n",
-    "                text=doc_chunk,\n",
-    "                metadata=deepcopy(doc.metadata),\n",
-    "            )\n",
-    "            nodes.append(node)\n",
-    "\n",
-    "    return nodes"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "page_nodes = get_page_nodes(documents)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.node_parser import MarkdownElementNodeParser\n",
-    "\n",
-    "node_parser = MarkdownElementNodeParser(\n",
-    "    llm=OpenAI(model=\"gpt-3.5-turbo-0125\"), num_workers=8\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "nodes = node_parser.get_nodes_from_documents(documents)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "base_nodes, objects = node_parser.get_nodes_and_objects(nodes)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "\"This table provides information about a company's state of incorporation or organization and its corresponding I.R.S. Employer Identification Number.,\\nwith the following table title:\\nCompany Incorporation Information,\\nwith the following columns:\\n- California: None\\n- 94-2404110: None\\n\""
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "objects[0].get_content()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# dump both indexed tables and page text into the vector index\n",
-    "recursive_index = VectorStoreIndex(nodes=base_nodes + objects + page_nodes)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "# Apple Inc.\n",
-      "\n",
-      "**CONSOLIDATED STATEMENTS OF OPERATIONS (In millions, except number of shares which are reflected in thousands and per share amounts)**\n",
-      "| |September 25, 2021|September 26, 2020|September 28, 2019|\n",
-      "|---|---|---|---|\n",
-      "|Net sales:|$297,392|$220,747|$213,883|\n",
-      "|Products| | | |\n",
-      "|Services|$68,425|$53,768|$46,291|\n",
-      "|Total net sales|$365,817|$274,515|$260,174|\n",
-      "|Cost of sales:| | | |\n",
-      "|Products|$192,266|$151,286|$144,996|\n",
-      "|Services|$20,715|$18,273|$16,786|\n",
-      "|Total cost of sales|$212,981|$169,559|$161,782|\n",
-      "|Gross margin|$152,836|$104,956|$98,392|\n",
-      "|Operating expenses:| | | |\n",
-      "|Research and development|$21,914|$18,752|$16,217|\n",
-      "|Selling, general and administrative|$21,973|$19,916|$18,245|\n",
-      "|Total operating expenses|$43,887|$38,668|$34,462|\n",
-      "|Operating income|$108,949|$66,288|$63,930|\n",
-      "|Other income/(expense), net|$258|$803|$1,807|\n",
-      "|Income before provision for income taxes|$109,207|$67,091|$65,737|\n",
-      "|Provision for income taxes|$14,527|$9,680|$10,481|\n",
-      "|Net income|$94,680|$57,411|$55,256|\n",
-      "|Earnings per share:| | | |\n",
-      "|Basic|$5.67|$3.31|$2.99|\n",
-      "|Diluted|$5.61|$3.28|$2.97|\n",
-      "|Shares used in computing earnings per share:| | | |\n",
-      "|Basic|16,701,272|17,352,119|18,471,336|\n",
-      "|Diluted|16,864,919|17,528,214|18,595,651|\n",
-      "\n",
-      "See accompanying Notes to Consolidated Financial Statements.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(page_nodes[31].get_content())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.postprocessor.flag_embedding_reranker import FlagEmbeddingReranker\n",
-    "\n",
-    "reranker = FlagEmbeddingReranker(\n",
-    "    top_n=5,\n",
-    "    model=\"BAAI/bge-reranker-large\",\n",
-    ")\n",
-    "\n",
-    "recursive_query_engine = recursive_index.as_query_engine(\n",
-    "    similarity_top_k=5, node_postprocessors=[reranker], verbose=True\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "233\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(len(nodes))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Setup Baseline\n",
-    "\n",
-    "For comparison, we setup a naive RAG pipeline with default parsing and standard chunking, indexing, retrieval."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import SimpleDirectoryReader\n",
-    "\n",
-    "reader = SimpleDirectoryReader(input_files=[\"apple_2021_10k.pdf\"])\n",
-    "base_docs = reader.load_data()\n",
-    "raw_index = VectorStoreIndex.from_documents(base_docs)\n",
-    "raw_query_engine = raw_index.as_query_engine(\n",
-    "    similarity_top_k=5, node_postprocessors=[reranker]\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Using `new LlamaParse` as pdf data parsing methods and retrieve tables with two different methods\n",
-    "we compare base query engine vs recursive query engine with tables"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Table Query Task: Queries for Table Question Answering"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "***********Basic Query Engine***********\n",
-      "The purchases of marketable securities in 2020 amounted to $163.4 billion.\n",
-      "\u001b[1;3;38;2;11;159;203mRetrieval entering 59368b87-e602-4bd1-88a7-7526fd6ab83f: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query Purchases of marketable securities in 2020\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203mRetrieval entering dfd97f47-eb4d-4bab-8a22-9bbbc0096a4b: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query Purchases of marketable securities in 2020\n",
-      "\u001b[0m\n",
-      "***********New LlamaParse+ Recursive Retriever Query Engine***********\n",
-      "$114,938\n"
-     ]
-    }
-   ],
-   "source": [
-    "query = \"Purchases of marketable securities in 2020\"\n",
-    "\n",
-    "response_1 = raw_query_engine.query(query)\n",
-    "print(\"\\n***********Basic Query Engine***********\")\n",
-    "print(response_1)\n",
-    "\n",
-    "response_2 = recursive_query_engine.query(query)\n",
-    "print(\"\\n***********New LlamaParse+ Recursive Retriever Query Engine***********\")\n",
-    "print(response_2)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "This table provides information on hedged assets and liabilities for the years 2021 and 2020, including current and non-current marketable securities and term debt.,\n",
-      "with the following table title:\n",
-      "Hedged Assets and Liabilities Summary,\n",
-      "with the following columns:\n",
-      "- 2021: None\n",
-      "- 2020: None\n",
-      "\n",
-      "| |2021|2020|\n",
-      "|---|---|---|\n",
-      "|Hedged assets/(liabilities):| | |\n",
-      "|Current and non-current marketable securities|$15,954|$16,270|\n",
-      "|Current and non-current term debt|$(17,857)|$(21,033)|\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response_2.source_nodes[2].get_content())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "***********Basic Query Engine***********\n",
-      "0.03%, 0.75%, 1.43%\n",
-      "\u001b[1;3;38;2;11;159;203mRetrieval entering a5afa785-217f-4e72-87cf-15da11632ec0: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query effective interest rates of all debt issuances in 2021\n",
-      "\u001b[0m\n",
-      "***********New LlamaParse+ Recursive Retriever Query Engine***********\n",
-      "0.48% – 0.63%, 0.03% – 4.78%, 0.75% – 2.81%, 1.43% – 2.86%\n"
-     ]
-    }
-   ],
-   "source": [
-    "query = \"effective interest rates of all debt issuances in 2021\"\n",
-    "\n",
-    "response_1 = raw_query_engine.query(query)\n",
-    "print(\"\\n***********Basic Query Engine***********\")\n",
-    "print(response_1)\n",
-    "\n",
-    "response_2 = recursive_query_engine.query(query)\n",
-    "print(\"\\n***********New LlamaParse+ Recursive Retriever Query Engine***********\")\n",
-    "print(response_2)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Term Debt\n",
-      "As of September 25, 2021 , the Company had outstanding floating- and fixed-rate notes with varying maturities for an aggregate \n",
-      "principal amount of $118.1 billion  (collectively the “Notes”). The Notes are senior unsecured obligations and interest is payable in \n",
-      "arrears. The following table provides a summary of the Company’s term debt as of September 25, 2021  and September 26, \n",
-      "2020 :\n",
-      "Maturities\n",
-      "(calendar year)2021 2020\n",
-      "Amount\n",
-      "(in millions)Effective\n",
-      "Interest RateAmount\n",
-      "(in millions)Effective\n",
-      "Interest Rate\n",
-      "2013 – 2020 debt issuances:\n",
-      "Floating-rate notes  2022 $ 1,750 0.48%  – 0.63% $ 2,250 0.60%  – 1.39%\n",
-      "Fixed-rate 0.000%  – 4.650%  notes 2022  – 2060  95,813 0.03%  – 4.78%  103,828 0.03%  – 4.78%\n",
-      "Second quarter 2021 debt issuance:\n",
-      "Fixed-rate 0.700%  – 2.800%  notes 2026  – 2061  14,000 0.75%  – 2.81%  —  — %\n",
-      "Fourth quarter 2021 debt issuance:\n",
-      "Fixed-rate 1.400%  – 2.850%  notes 2028  – 2061  6,500 1.43%  – 2.86%  —  — %\n",
-      "Total term debt  118,063  106,078 \n",
-      "Unamortized premium/(discount) and issuance \n",
-      "costs, net  (380)  (314) \n",
-      "Hedge accounting fair value adjustments  1,036  1,676 \n",
-      "Less: Current portion of term debt  (9,613)  (8,773) \n",
-      "Total non-current portion of term debt $ 109,106 $ 98,667 \n",
-      "To manage interest rate risk on certain of its U.S. dollar–denominated fixed- or floating-rate notes, the Company has entered into \n",
-      "interest rate swaps to effectively convert the fixed interest rates to floating interest rates or the floating interest rates to fixed \n",
-      "interest rates on a portion of these notes. Additionally, to manage foreign currency risk on certain of its foreign currency–\n",
-      "denominated notes, the Company has entered into foreign currency swaps to effectively convert these notes to U.S. dollar–\n",
-      "denominated notes.\n",
-      "The effective interest rates for the Notes include the interest on the Notes, amortization of the discount or premium and, if \n",
-      "applicable, adjustments related to hedging. The Company recogni zed $2.6 billion , $2.8 billion  and $3.2 billion  of interest expense \n",
-      "on its term debt for 2021 , 2020  and 2019 , respectively.\n",
-      "The future principal payments for the Company’s Notes as of September 25, 2021 , are as follows (in millions):\n",
-      "2022 $ 9,583 \n",
-      "2023  11,391 \n",
-      "2024  10,202 \n",
-      "2025  10,914 \n",
-      "2026  11,408 \n",
-      "Thereafter  64,565 \n",
-      "Total term debt $ 118,063 \n",
-      "As of September 25, 2021  and September 26, 2020 , the fair value of the Company’s Notes, based on Level 2 inputs, was $125.3 \n",
-      "billion  and $117.1 billion , respectively.\n",
-      "Apple Inc. | 2021  Form 10-K | 45\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response_1.source_nodes[0].get_content())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "***********Basic Query Engine***********\n",
-      "The U.S. Tax Cuts and Jobs Act of 2017 had an impact on income taxes in 2020, as evidenced by a decrease in the provision for income taxes compared to the prior year.\n",
-      "\u001b[1;3;38;2;11;159;203mRetrieval entering b9416f35-ebf1-45d6-9a29-b59e435ab42d: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query Impacts of the U.S. Tax Cuts and Jobs Act of 2017 on income taxes in 2020\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203mRetrieval entering 8d8d5733-ff30-4535-9376-7f761b5900ea: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query Impacts of the U.S. Tax Cuts and Jobs Act of 2017 on income taxes in 2020\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203mRetrieval entering 82f301e5-199a-4aa2-bbdf-ef97898c0326: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query Impacts of the U.S. Tax Cuts and Jobs Act of 2017 on income taxes in 2020\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203mRetrieval entering 86f666b4-254b-487f-9870-8ee09aef07a9: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query Impacts of the U.S. Tax Cuts and Jobs Act of 2017 on income taxes in 2020\n",
-      "\u001b[0m\n",
-      "***********New LlamaParse+ Recursive Retriever Query Engine***********\n",
-      "The U.S. Tax Cuts and Jobs Act of 2017 had a negative impact on income taxes in 2020.\n"
-     ]
-    }
-   ],
-   "source": [
-    "query = \"Impacts of the U.S. Tax Cuts and Jobs Act of 2017 on income taxes in 2020\"\n",
-    "\n",
-    "response_1 = raw_query_engine.query(query)\n",
-    "print(\"\\n***********Basic Query Engine***********\")\n",
-    "print(response_1)\n",
-    "\n",
-    "response_2 = recursive_query_engine.query(query)\n",
-    "print(\"\\n***********New LlamaParse+ Recursive Retriever Query Engine***********\")\n",
-    "print(response_2)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Other Income/(Expense), Net\n",
-      "The following table shows the detail of OI&E for 2021 , 2020  and 2019  (in millions):\n",
-      "2021 2020 2019\n",
-      "Interest and dividend income $ 2,843 $ 3,763 $ 4,961 \n",
-      "Interest expense  (2,645)  (2,873)  (3,576) \n",
-      "Other income/(expense), net  60  (87)  422 \n",
-      "Total other income/(expense), net $ 258 $ 803 $ 1,807 \n",
-      "Note 5 – Income Taxe s\n",
-      "Provision for Income Taxes and Effective  Tax Rat e\n",
-      "The provision for income taxes for 2021 , 2020  and 2019 , consisted of the following (in millions):\n",
-      "2021 2020 2019\n",
-      "Federal:\n",
-      "Current $ 8,257 $ 6,306 $ 6,384 \n",
-      "Deferred  (7,176)  (3,619)  (2,939) \n",
-      "Total  1,081  2,687  3,445 \n",
-      "State:\n",
-      "Current  1,620  455  475 \n",
-      "Deferred  (338)  21  (67) \n",
-      "Total  1,282  476  408 \n",
-      "Foreign:\n",
-      "Current  9,424  3,134  3,962 \n",
-      "Deferred  2,740  3,383  2,666 \n",
-      "Total  12,164  6,517  6,628 \n",
-      "Provision for income taxes $ 14,527 $ 9,680 $ 10,481 \n",
-      "The foreign provision for income taxes is based on foreign pretax earnings of $68.7 billion , $38.1 billion  and $44.3 billion  in 2021 , \n",
-      "2020  and 2019 , respectively.\n",
-      "A reconciliation of the provision for income taxes, with the amount computed by applying the statutory federal income tax  rate \n",
-      "(21% in 2021 , 2020  and 2019 ) to income before provision for income taxes for 2021 , 2020  and 2019 , is as follows (dollars in \n",
-      "millions):\n",
-      "2021 2020 2019\n",
-      "Computed expected tax $ 22,933 $ 14,089 $ 13,805 \n",
-      "State taxes, net of federal effect  1,151  423  423 \n",
-      "Impacts of the U.S. Tax Cuts and Jobs Act of 2017  —  (582)  — \n",
-      "Earnings of foreign subsidiaries  (4,715)  (2,534)  (2,625) \n",
-      "Foreign-derived intangible income deduction  (1,372)  (169)  (149) \n",
-      "Research and development credit, net  (1,033)  (728)  (548) \n",
-      "Excess tax benefits from equity awards  (2,137)  (930)  (639) \n",
-      "Other  (300)  111  214 \n",
-      "Provision for income taxes $ 14,527 $ 9,680 $ 10,481 \n",
-      "Effective tax rate  13.3%  14.4%  15.9% \n",
-      "Apple Inc. | 2021  Form 10-K | 41\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response_1.source_nodes[0].get_content())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "***********Basic Query Engine***********\n",
-      "$3,619 million in 2019, $7,176 million in 2020, and $1,081 million in 2021\n",
-      "\u001b[1;3;38;2;11;159;203mRetrieval entering 12b1355a-f9e6-4b08-a19a-3ffc00dc5b9f: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query federal deferred tax in 2019-2021\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203mRetrieval entering 82f301e5-199a-4aa2-bbdf-ef97898c0326: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query federal deferred tax in 2019-2021\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203mRetrieval entering 8d8d5733-ff30-4535-9376-7f761b5900ea: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query federal deferred tax in 2019-2021\n",
-      "\u001b[0m\n",
-      "***********New LlamaParse+ Recursive Retriever Query Engine***********\n",
-      "$2,939, $3,619, $7,176\n"
-     ]
-    }
-   ],
-   "source": [
-    "query = \"federal deferred tax in 2019-2021\"\n",
-    "\n",
-    "response_1 = raw_query_engine.query(query)\n",
-    "print(\"\\n***********Basic Query Engine***********\")\n",
-    "print(response_1)\n",
-    "\n",
-    "response_2 = recursive_query_engine.query(query)\n",
-    "print(\"\\n***********New LlamaParse+ Recursive Retriever Query Engine***********\")\n",
-    "print(response_2)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "***********Basic Query Engine***********\n",
-      "State deferred income tax for 2019: $454 million\n",
-      "State deferred income tax for 2020: $21 million\n",
-      "State deferred income tax for 2021: -$338 million\n",
-      "\u001b[1;3;38;2;11;159;203mRetrieval entering 12b1355a-f9e6-4b08-a19a-3ffc00dc5b9f: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query give me the deferred state income tax in 2019-2021 (include +/-)\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203mRetrieval entering 8d8d5733-ff30-4535-9376-7f761b5900ea: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query give me the deferred state income tax in 2019-2021 (include +/-)\n",
-      "\u001b[0m\n",
-      "***********New LlamaParse+ Recursive Retriever Query Engine***********\n",
-      "Deferred state income tax for the years 2019-2021:\n",
-      "- 2019: ($67) million\n",
-      "- 2020: $21 million\n",
-      "- 2021: ($338) million\n"
-     ]
-    }
-   ],
-   "source": [
-    "query = \"give me the deferred state income tax in 2019-2021 (include +/-)\"\n",
-    "\n",
-    "response_1 = raw_query_engine.query(query)\n",
-    "print(\"\\n***********Basic Query Engine***********\")\n",
-    "print(response_1)\n",
-    "\n",
-    "response_2 = recursive_query_engine.query(query)\n",
-    "print(\"\\n***********New LlamaParse+ Recursive Retriever Query Engine***********\")\n",
-    "print(response_2)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Summary of income tax provisions for Federal, State, and Foreign entities over the years 2019, 2020, and 2021.,\n",
-      "with the following table title:\n",
-      "Income Tax Provisions by Entity and Year,\n",
-      "with the following columns:\n",
-      "- Entity: The type of entity (Federal, State, Foreign)\n",
-      "- 2019: Income tax provisions for the year 2019\n",
-      "- 2020: Income tax provisions for the year 2020\n",
-      "- 2021: Income tax provisions for the year 2021\n",
-      "\n",
-      "| |2021|2020|2019|\n",
-      "|---|---|---|---|\n",
-      "|Federal:| | | |\n",
-      "|Current|$8,257|$6,306|$6,384|\n",
-      "|Deferred|(7,176)|(3,619)|(2,939)|\n",
-      "|Total|1,081|2,687|3,445|\n",
-      "|State:| | | |\n",
-      "|Current|1,620|455|475|\n",
-      "|Deferred|(338)|21|(67)|\n",
-      "|Total|1,282|476|408|\n",
-      "|Foreign:| | | |\n",
-      "|Current|9,424|3,134|3,962|\n",
-      "|Deferred|2,740|3,383|2,666|\n",
-      "|Total|12,164|6,517|6,628|\n",
-      "|Provision for income taxes|$14,527|$9,680|$10,481|\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response_2.source_nodes[0].get_content())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "***********Basic Query Engine***********\n",
-      "$1,620 million in 2019, $455 million in 2020, $475 million in 2021\n",
-      "\u001b[1;3;38;2;11;159;203mRetrieval entering 82f301e5-199a-4aa2-bbdf-ef97898c0326: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query current state taxes per year in 2019-2021 (include +/-)\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203mRetrieval entering 8d8d5733-ff30-4535-9376-7f761b5900ea: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query current state taxes per year in 2019-2021 (include +/-)\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203mRetrieval entering b9416f35-ebf1-45d6-9a29-b59e435ab42d: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query current state taxes per year in 2019-2021 (include +/-)\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203mRetrieval entering a029e464-575f-4dd6-afad-7cc0bbc5dbf9: TextNode\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200mRetrieving from object TextNode with query current state taxes per year in 2019-2021 (include +/-)\n",
-      "\u001b[0m\n",
-      "***********New LlamaParse+ Recursive Retriever Query Engine***********\n",
-      "$475 in 2019, $455 in 2020, $1,620 in 2021.\n"
-     ]
-    }
-   ],
-   "source": [
-    "query = \"current state taxes per year in 2019-2021 (include +/-)\"\n",
-    "\n",
-    "response_1 = raw_query_engine.query(query)\n",
-    "print(\"\\n***********Basic Query Engine***********\")\n",
-    "print(response_1)\n",
-    "\n",
-    "response_2 = recursive_query_engine.query(query)\n",
-    "print(\"\\n***********New LlamaParse+ Recursive Retriever Query Engine***********\")\n",
-    "print(response_2)"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama_parse",
-   "language": "python",
-   "name": "llama_parse"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

examples/demo_api.ipynb

@@ -1,136 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Using the Raw API\n",
-    "\n",
-    "This notebook walks through how to use the raw API and how"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "--2024-02-02 11:11:39--  https://arxiv.org/pdf/1706.03762.pdf\n",
-      "Resolving arxiv.org (arxiv.org)... 151.101.131.42, 151.101.3.42, 151.101.67.42, ...\n",
-      "Connecting to arxiv.org (arxiv.org)|151.101.131.42|:443... connected.\n",
-      "HTTP request sent, awaiting response... 200 OK\n",
-      "Length: 2215244 (2.1M) [application/pdf]\n",
-      "Saving to: ‘./attention.pdf’\n",
-      "\n",
-      "./attention.pdf     100%[===================>]   2.11M  --.-KB/s    in 0.08s   \n",
-      "\n",
-      "2024-02-02 11:11:39 (27.3 MB/s) - ‘./attention.pdf’ saved [2215244/2215244]\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "!wget \"https://arxiv.org/pdf/1706.03762.pdf\" -O \"./attention.pdf\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "api_key = \"llx-...\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import mimetypes\n",
-    "import requests\n",
-    "import time\n",
-    "\n",
-    "headers = {\"Authorization\": f\"Bearer {api_key}\"}\n",
-    "file_path = \"./attention.pdf\"\n",
-    "base_url = \"https://api.cloud.llamaindex.ai/api/parsing\"\n",
-    "\n",
-    "with open(file_path, \"rb\") as f:\n",
-    "    mime_type = mimetypes.guess_type(file_path)[0]\n",
-    "    files = {\"file\": (f.name, f, mime_type)}\n",
-    "\n",
-    "    # send the request, upload the file\n",
-    "    url = f\"{base_url}/upload\"\n",
-    "    response = requests.post(url, headers=headers, files=files)\n",
-    "\n",
-    "response.raise_for_status()\n",
-    "# get the job id for the result_url\n",
-    "job_id = response.json()[\"id\"]\n",
-    "result_type = \"text\"  # or \"markdown\"\n",
-    "result_url = f\"{base_url}/job/{job_id}/result/{result_type}\"\n",
-    "\n",
-    "# check for the result until its ready\n",
-    "while True:\n",
-    "    response = requests.get(result_url, headers=headers)\n",
-    "    if response.status_code == 200:\n",
-    "        break\n",
-    "\n",
-    "    time.sleep(2)\n",
-    "\n",
-    "# download the result\n",
-    "result = response.json()\n",
-    "output = result[result_type]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "                          Provided proper attribution is provided, Google hereby grants permission to\n",
-      "                          reproduce the tables and figures in this paper solely for use in journalistic or\n",
-      "                                                                   scholarly works.\n",
-      "                                                   Attention Is All You Need\n",
-      "arXiv:1706.03762v7  [cs.CL]  2 Aug 2023\n",
-      "                            Ashish Vaswani∗                Noam Shazeer∗               Niki Parmar∗             Jakob Uszkoreit∗\n",
-      "                              Google Brain                  Google Brain             Google Research            Google Research\n",
-      "                        avaswani@google.com             noam@google.com            nikip@google.com            usz@google.com\n",
-      "                                Llion Jones∗                 Aidan N. Gomez∗        †                  Łukasz Kaiser∗\n",
-      "                             Google Research                University of Toronto        \n"
-     ]
-    }
-   ],
-   "source": [
-    "print(output[:1000])"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama-parse-aNC435Vv-py3.11",
-   "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"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}

examples/demo_astradb.ipynb

@@ -1,295 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Using llama-parse with AstraDB"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "In this notebook, we show a basic RAG-style example that uses `llama-parse` to parse a PDF document, store the corresponding document into a vector store (`AstraDB`) and finally, perform some basic queries against that store. The notebook is modeled after the quick start notebooks and hence is meant as a way of getting started with `llama-parse`, backed by a vector database."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Requirements"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# First, install the required dependencies\n",
-    "%pip install --quiet llama-index llama-parse llama-index-vector-stores-astra-db llama-index-llms-openai"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Configuration"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "import openai\n",
-    "\n",
-    "from getpass import getpass\n",
-    "\n",
-    "# Get all required API keys and parameters\n",
-    "llama_cloud_api_key = getpass(\"Enter your Llama Index Cloud API Key: \")\n",
-    "api_endpoint = input(\"Enter your Astra DB API Endpoint: \")\n",
-    "token = getpass(\"Enter your Astra DB Token: \")\n",
-    "namespace = (\n",
-    "    input(\"Enter your Astra DB namespace (optional, must exist on Astra): \") or None\n",
-    ")\n",
-    "openai_api_key = getpass(\"Enter your OpenAI API Key: \")\n",
-    "\n",
-    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = llama_cloud_api_key\n",
-    "openai.api_key = openai_api_key"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# llama-parse is async-first, running the sync code in a notebook requires the use of nest_asyncio\n",
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Using llama-parse to parse a PDF"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Download complete.\n"
-     ]
-    }
-   ],
-   "source": [
-    "# Grab a PDF from Arxiv for indexing\n",
-    "import requests\n",
-    "\n",
-    "# The URL of the file you want to download\n",
-    "url = \"https://arxiv.org/pdf/1706.03762.pdf\"\n",
-    "# The local path where you want to save the file\n",
-    "file_path = \"./attention.pdf\"\n",
-    "\n",
-    "# Perform the HTTP request\n",
-    "response = requests.get(url)\n",
-    "\n",
-    "# Check if the request was successful\n",
-    "if response.status_code == 200:\n",
-    "    # Open the file in binary write mode and save the content\n",
-    "    with open(file_path, \"wb\") as file:\n",
-    "        file.write(response.content)\n",
-    "    print(\"Download complete.\")\n",
-    "else:\n",
-    "    print(\"Error downloading the file.\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id ce3909a7-54cf-438b-849a-fe9a903b0c71\n"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "documents = LlamaParse(result_type=\"text\").load_data(file_path)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'rmer - model architecture.\\nThe Transformer follows this overall architecture using stacked self-attention and point-wise, fully\\nconnected layers for both the encoder and decoder, shown in the left and right halves of Figure 1,\\nrespectively.\\n3.1   Encoder and Decoder Stacks\\nEncoder:     The encoder is composed of a stack of N = 6 identical layers. Each layer has two\\nsub-layers. The first is a multi-head self-attention mechanism, and the second is a simple, position-\\nwise fully connected feed-forward network. We employ a residual connection [11] around each of\\nthe two sub-layers, followed by layer normalization [1]. That is, the output of each sub-layer is\\nLayerNorm(x + Sublayer(x)), where Sublayer(x) is the function implemented by the sub-layer\\nitself. To facilitate these residual connections, all sub-layers in the model, as well as the embedding\\nlayers, produce outputs of dimension dmodel = 512.\\nDecoder:    The decoder is also composed of a stack of N = 6 identical layers. In addition '"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# Take a quick look at some of the parsed text from the document:\n",
-    "documents[0].get_content()[10000:11000]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Storing into Astra DB"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.vector_stores.astra_db import AstraDBVectorStore\n",
-    "\n",
-    "astra_db_store = AstraDBVectorStore(\n",
-    "    token=token,\n",
-    "    api_endpoint=api_endpoint,\n",
-    "    namespace=namespace,\n",
-    "    collection_name=\"astra_v_table_llamaparse\",\n",
-    "    embedding_dimension=1536,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.node_parser import SimpleNodeParser\n",
-    "\n",
-    "node_parser = SimpleNodeParser()\n",
-    "\n",
-    "nodes = node_parser.get_nodes_from_documents(documents)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.embeddings.openai import OpenAIEmbedding\n",
-    "from llama_index.core import VectorStoreIndex, StorageContext\n",
-    "\n",
-    "storage_context = StorageContext.from_defaults(vector_store=astra_db_store)\n",
-    "\n",
-    "index = VectorStoreIndex(\n",
-    "    nodes=nodes,\n",
-    "    storage_context=storage_context,\n",
-    "    embed_model=OpenAIEmbedding(api_key=openai_api_key),\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Simple RAG Example"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query_engine = index.as_query_engine(similarity_top_k=15)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "***********New LlamaParse+ Basic Query Engine***********\n",
-      "Multi-Head Attention is also known as multi-headed self-attention.\n"
-     ]
-    }
-   ],
-   "source": [
-    "query = \"What is Multi-Head Attention also known as?\"\n",
-    "\n",
-    "response_1 = query_engine.query(query)\n",
-    "print(\"\\n***********New LlamaParse+ Basic Query Engine***********\")\n",
-    "print(response_1)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "'We used beam search as described in the previous section, but no\\ncheckpoint averaging. We present these results in Table 3.\\nIn Table 3 rows (A), we vary the number of attention heads and the attention key and value dimensions,\\nkeeping the amount of computation constant, as described in Section 3.2.2. While single-head\\nattention is 0.9 BLEU worse than the best setting, quality also drops off with too many heads.\\nIn Table 3 rows (B), we observe that reducing the attention key size dk hurts model quality. This\\nsuggests that determining compatibility is not easy and that a more sophisticated compatibility\\nfunction than dot product may be beneficial. We further observe in rows (C) and (D) that, as expected,\\nbigger models are better, and dropout is very helpful in avoiding over-fitting. In row (E) we replace our\\nsinusoidal positional encoding with learned positional embeddings [9], and observe nearly identical\\nresults to the base model.\\n6.3    English Constituency Parsing\\nTo evaluate if the Transformer can generalize to other tasks we performed experiments on English\\nconstituency parsing. This task presents specific challenges: the output is subject to strong structural\\nconstraints and is significantly longer than the input. Furthermore, RNN sequence-to-sequence\\nmodels have not been able to attain state-of-the-art results in small-data regimes [37].\\nWe trained a 4-layer transformer with dmodel = 1024 on the Wall Street Journal (WSJ) portion of the\\nPenn Treebank [25], about 40K training sentences. We also trained it in a semi-supervised setting,\\nusing the larger high-confidence and BerkleyParser corpora from with approximately 17M sentences\\n[37]. We used a vocabulary of 16K tokens for the WSJ only setting and a vocabulary of 32K tokens\\nfor the semi-supervised setting.\\nWe performed only a small number of experiments to select the dropout, both attention and residual\\n(section 5.4), learning rates and beam size on the Section 22 development set, all other parameters\\nremained unchanged from the English-to-German base translation model. During inference, we\\n                                                             9\\n---\\nTable 4: The Transformer generalizes well to English constituency parsing (Results are on Section 23\\nof WSJ)\\n                          Parser                           Training             WSJ 23 F1\\n            Vinyals & Kaiser el al. (2014) [37]    WSJ only, discriminative         88.3\\n                 Petrov et al. (2006) [29]         WSJ only, discriminative         90.4\\n                   Zhu et al. (2013) [40]          WSJ only, discriminative         90.4\\n                   Dyer et al. (2016) [8]          WSJ only, discriminative         91.7\\n                  Transformer (4 layers)           WSJ only, discriminative         91.3\\n                   Zhu et al. (2013) [40]              semi-supervised              91.3\\n               Huang & Harper (2009) [14]              semi-supervised              91.3\\n               McClosky et al. (2006) [26]             semi-supervised              92.1\\n            Vinyals & Kaiser el al. (2014) [37]        semi-supervised              92.1\\n                  Transformer (4 layers)               semi-supervised              92.7\\n                 Luong et al. (2015) [23]                  multi-task               93.0\\n                   Dyer et al. (2016) [8]                  generative               93.3\\nincreased the maximum output length to input length + 300. We used a beam size of 21 and α = 0.3\\nfor both WSJ only and the semi-supervised setting.\\nOur results in Table 4 show that despite the lack of task-specific tuning our model performs sur-\\nprisingly well, yielding better results than all previously reported models with the exception of the\\nRecurrent Neural Network Grammar [8].\\nIn contrast to RNN sequence-to-sequence models [37], the Transformer outperforms the Berkeley-\\nParser [29] even when training only on the WSJ training set of 40K sentences.\\n7    Conclusion\\nIn this work, we presented the Transformer, the first sequence transduction model based entirely on\\nattention, replacing the recurrent layers most commonly used in encoder-decoder architectures with\\nmulti-headed self-attention.\\nFor translation tasks, the Transformer can be trained significantly faster than architectures based\\non recurrent or convolutional layers.'"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# Take a look at one of the source nodes from the response\n",
-    "response_1.source_nodes[0].get_content()"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

examples/demo_basic.ipynb

@@ -1,183 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# LlamaParse Usage"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%pip install llama-index llama-parse"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "--2024-02-02 11:10:10--  https://arxiv.org/pdf/1706.03762.pdf\n",
-      "Resolving arxiv.org (arxiv.org)... 151.101.131.42, 151.101.3.42, 151.101.67.42, ...\n",
-      "Connecting to arxiv.org (arxiv.org)|151.101.131.42|:443... connected.\n",
-      "HTTP request sent, awaiting response... 200 OK\n",
-      "Length: 2215244 (2.1M) [application/pdf]\n",
-      "Saving to: ‘./attention.pdf’\n",
-      "\n",
-      "./attention.pdf     100%[===================>]   2.11M  --.-KB/s    in 0.08s   \n",
-      "\n",
-      "2024-02-02 11:10:10 (25.9 MB/s) - ‘./attention.pdf’ saved [2215244/2215244]\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "!wget \"https://arxiv.org/pdf/1706.03762.pdf\" -O \"./attention.pdf\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# llama-parse is async-first, running the sync code in a notebook requires the use of nest_asyncio\n",
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()\n",
-    "\n",
-    "import os\n",
-    "\n",
-    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"llx-...\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id dd0b8e31-0c09-4497-b78a-cc1c92f1d6cf\n"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "documents = LlamaParse(result_type=\"text\").load_data(\"./attention.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "ad\n",
-      "relying entirely on an attention mechanism to draw global dependencies between input and output.\n",
-      "The Transformer allows for significantly more parallelization and can reach a new state of the art in\n",
-      "translation quality after being trained for as little as twelve hours on eight P100 GPUs.\n",
-      "2    Background\n",
-      "The goal of reducing sequential computation also forms the foundation of the Extended Neural GPU\n",
-      "[16], ByteNet [18] and ConvS2S [9], all of which use convolutional neural networks as basic building\n",
-      "block, computing hidden representations in parallel for all input and output positions. In these models,\n",
-      "the number of operations required to relate signals from two arbitrary input or output positions grows\n",
-      "in the distance between positions, linearly for ConvS2S and logarithmically for ByteNet. This makes\n",
-      "it more difficult to learn dependencies between distant positions [12]. In the Transformer this is\n",
-      "reduced to a constant number of operations, albeit at the cost of reduced effective res\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(documents[0].text[6000:7000])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id d4531453-1bbb-48c4-8324-ae9fea9f2fa2\n"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "documents = LlamaParse(result_type=\"markdown\").load_data(\"./attention.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "ction describes the training regime for our models.\n",
-      "\n",
-      "##### Training Data and Batching\n",
-      "\n",
-      "We trained on the standard WMT 2014 English-German dataset consisting of about 4.5 million\n",
-      "sentence pairs. Sentences were encoded using byte-pair encoding [3], which has a shared source-\n",
-      "target vocabulary of about 37000 tokens. For English-French, we used the significantly larger WMT\n",
-      "2014 English-French dataset consisting of 36M sentences and split tokens into a 32000 word-piece\n",
-      "vocabulary [38]. Sentence pairs were batched together by approximate sequence length. Each training\n",
-      "batch contained a set of sentence pairs containing approximately 25000 source tokens and 25000\n",
-      "target tokens.\n",
-      "\n",
-      "##### Hardware and Schedule\n",
-      "\n",
-      "We trained our models on one machine with 8 NVIDIA P100 GPUs. For our base models using\n",
-      "the hyperparameters described throughout the paper, each training step took about 0.4 seconds. We\n",
-      "trained the base models for a total of 100,000 steps or 12 hours. For our big models,(described on the\n",
-      "bo...\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(documents[0].text[20000:21000] + \"...\")"
-   ]
-  }
- ],
- "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"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

examples/demo_insurance.ipynb

@@ -1,531 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# LlamaParse - Fast checking Insurance Contract for Coverage\n",
-    "\n",
-    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/demo_insurance.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
-    "\n",
-    "In this notebook we will look at how LlamaParse can be used to extract structured coverage information from an insurance policy."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Installation of required packages"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%pip install llama-index llama-parse"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Download an insurance policy fron IRDAI\n",
-    "\n",
-    "The Insurance Regulatory and Development Authority of India (IRDAI) maintains a great resource: https://policyholder.gov.in/web/guest/non-life-insurance-products where all insurance policies available in India are publicly available for download! Let's download a complex health insurance policy as an example."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!wget \"https://policyholder.gov.in/documents/37343/931203/NBHTGBP22011V012223.pdf/c392bcc1-f6a8-cadd-ab84-495b3273d2c3?version=1.0&t=1669350459879&download=true\" -O \"./policy.pdf\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Initializing LlamaIndex and LlamaParse"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# llama-parse is async-first, running the sync code in a notebook requires the use of nest_asyncio\n",
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"llx-...\"\n",
-    "os.environ[\"OPENAI_API_KEY\"] = \"sk-...\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.llms.openai import OpenAI\n",
-    "from llama_index.embeddings.openai import OpenAIEmbedding\n",
-    "from llama_index.core import VectorStoreIndex\n",
-    "from llama_index.core import Settings\n",
-    "\n",
-    "# for the purpose of this example, we will use the small model embedding and gpt3.5\n",
-    "embed_model = OpenAIEmbedding(model=\"text-embedding-3-small\")\n",
-    "llm = OpenAI(model=\"gpt-3.5-turbo-0125\")\n",
-    "\n",
-    "Settings.llm = llm"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Vanilla Approach - Parse the Policy with LlamaParse into Markdown"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id b8946573-c911-4e00-8921-1bad1cda3d64\n",
-      "......"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "documents = LlamaParse(result_type=\"markdown\").load_data(\"./policy.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "## Preamble\n",
-      "\n",
-      "This ‘Travel Infinity’ Policy is a contract of insurance between You and Us which is subject to payment of full premium in advance and the terms, conditions and exclusions of this Policy. Expense incurred outside the policy period will NOT be covered. Unutilized Sum Insured will expire at the end of the policy year. All applicable benefits, details and limits are mentioned in your Certificate of insurance. We will cover only allopathic treatments in this policy.\n",
-      "\n",
-      "## Defined Terms\n",
-      "\n",
-      "The terms listed below in this Section and used elsewhere in the Policy in Initial Capitals shall have the meaning set out against them in this Section.\n",
-      "\n",
-      "### Standard Definitions\n",
-      "\n",
-      "|2.1|Accident or Accidental|means sudden, unforeseen and involuntary event caused by external, visible and violent means.|\n",
-      "|---|---|---|\n",
-      "|2.2|Co-payment|means a cost sharing requirement under a health insurance policy that provides that the policyholder/insured will bear a specified percentage of the admissible claims a\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(documents[0].text[0:1000])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Markdown Element Node Parser\n",
-    "Our markdown element node parser works well for parsing the markdown output of LlamaParse into a set of table and text nodes."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.node_parser import MarkdownElementNodeParser\n",
-    "\n",
-    "node_parser = MarkdownElementNodeParser(\n",
-    "    llm=OpenAI(model=\"gpt-3.5-turbo-0125\"), num_workers=8\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "nodes = node_parser.get_nodes_from_documents(documents)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "base_nodes, objects = node_parser.get_nodes_and_objects(nodes)\n",
-    "\n",
-    "recursive_index = VectorStoreIndex(nodes=base_nodes + objects)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query_engine = recursive_index.as_query_engine(similarity_top_k=25)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Querying the model for coverage"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "You are covered for the expenses incurred on any alternate travel booking under any mode of transport, up to the limit of the Sum Insured as mentioned in the Certificate of insurance, if the delay of the airlines was caused due to specific reasons outlined in the policy. The amount you are covered for will depend on the specific terms and conditions of your policy, including the maximum coverage limit specified in the Certificate of insurance.\n"
-     ]
-    }
-   ],
-   "source": [
-    "query_1 = \"My trip was delay and I paid 45, how much am I cover for?\"\n",
-    "\n",
-    "response_1 = query_engine.query(query_1)\n",
-    "print(str(response_1))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "The information is split across the document which leads to retrieval issues. Let's try some parsing instructions to improve our result."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id ec9e77c9-6ad9-4c9b-9efb-c9f659b0d481\n",
-      "....."
-     ]
-    }
-   ],
-   "source": [
-    "documents_with_instruction = LlamaParse(\n",
-    "    result_type=\"markdown\",\n",
-    "    parsing_instruction=\"\"\"\n",
-    "This document is an insurance policy.\n",
-    "When a benefits/coverage/exlusion is describe in the document ammend to it add a text in the follwing benefits string format (where coverage could be an exclusion).\n",
-    "\n",
-    "For {nameofrisk} and in this condition {whenDoesThecoverageApply} the coverage is {coverageDescription}. \n",
-    "                                        \n",
-    "If the document contain a benefits TABLE that describe coverage amounts, do not ouput it as a table, but instead as a list of benefits string.\n",
-    "                                       \n",
-    "\"\"\",\n",
-    ").load_data(\"./policy.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Let see how the 2 parsing compare (change target page to explore)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "## Inpatient treatment\n",
-      "\n",
-      "Claim Form (filled and signed by pe Insured)\n",
-      "Hospital Daily Cash\n",
-      "Release of Medical information Form (filled and signed by pe Insured)\n",
-      "Waiver of Deductible\n",
-      "Original papological and diagnostic reports, discharge summary indoor case papers (if any) and prescriptions issued by pe treating Medical practitioner or Network Provider\n",
-      "Optional Co-payment\n",
-      "Adventure Sports Cover\n",
-      "Home to Home Cover\n",
-      "Passport and Visa copy wip Entry Stamp of Country of Visit and exit Stamp from India\n",
-      "Extension to in-patient care\n",
-      "Ambulance Charge\n",
-      "FIR report of police (if applicable)\n",
-      "\n",
-      "## Out-patient treatment\n",
-      "\n",
-      "Cancer Screening & Mammographic Examination\n",
-      "Original bills and receipts for:\n",
-      "1. Charges paid towards Hospital accommodation, nursing facilities, and oper medical services rendered\n",
-      "2. Fees paid to pe Medical Practitioner and for special nursing charges\n",
-      "3. Charges incurred towards any and all test and / or examinations rendered in connection wip pe treatment\n",
-      "4. Charges incurred towards medicines or drugs purchased from a registered pharmacy oper pan pe Network provider duly supported by pe prescriptions of pe Medical Practitioner attending to pe Insured Person\n",
-      "5. Any oper document as required by pe Company to assist pe Claim\n",
-      "\n",
-      "## Medical evacuation\n",
-      "\n",
-      "Medical reports and transportation details issued by the evacuation agency, prescriptions and medical report by the attending Medical Practitioner furnishing the name of the Insured Person and details of treatment rendered along with the statement confirming the necessity of evacuation.\n",
-      "\n",
-      "Documentary proof for expenses incurred towards the Medical Evacuation.\n",
-      "\n",
-      "## Compassionate visit\n",
-      "\n",
-      "A certificate from the Medical Practitioner recommending the presence in the form of special assistance to be rendered by an additional member during the entire period of hospitalization. The certificate shall also specify the minimum period in which person is admitted in the hospital.\n",
-      "\n",
-      "Discharge summary of the Hospital furnishing details including the date of admission and date of discharge.\n",
-      "\n",
-      "Stamped boarding pass with invoice used for the travel by the Immediate Family Member.\n",
-      "\n",
-      "Copy passport of Immediate Family Member with entry and exit stamp.\n",
-      "\n",
-      "## Escort of Minor Child\n",
-      "\n",
-      "A certificate from the Medical Practitioner specifying the minimum period of Hospitalization.\n",
-      "\n",
-      "Discharge summary of the Hospital furnishing details including the date of admission and date of discharge.\n",
-      "\n",
-      "Stamped Boarding pass used for the return travel of the child to the Country of Residence.\n",
-      "\n",
-      "Stamped Boarding pass of the attendant from the Country of Residence to the place of hospitalization (if attendant is necessary).\n",
-      "\n",
-      "Copy of passport of the child with entry and exit stamp.\n",
-      "\n",
-      "## Upgradation to Business Class\n",
-      "\n",
-      "A certificate from the Medical Practitioner specifying the minimum period of Hospitalization.\n",
-      "\n",
-      "Discharge summary of the Hospital furnishing the details including the date of admission and date of discharge.\n",
-      "\n",
-      "Product Name: Travel infinity | Product UIN: NBHTGBP22011V012223\n",
-      "\n",
-      "\n",
-      "=========================================================\n",
-      "\n",
-      "\n",
-      "# Insurance Policy\n",
-      "\n",
-      "## Benefits:\n",
-      "\n",
-      "- For Inpatient treatment and in this condition when admitted to a hospital, the coverage is reimbursement for medical expenses incurred.\n",
-      "- For Hospital Daily Cash and in this condition when hospitalized, the coverage is daily cash benefit.\n",
-      "- For Waiver of Deductible and in this condition when a deductible is applicable, the coverage is waiver of the deductible amount.\n",
-      "- For Optional Co-payment and in this condition when a co-payment is required, the coverage is optional co-payment.\n",
-      "- For Adventure Sports Cover and in this condition when participating in adventure sports, the coverage is coverage for injuries related to adventure sports.\n",
-      "- For Home to Home Cover and in this condition when requiring medical evacuation, the coverage is assistance for repatriation to home country.\n",
-      "- For Extension to in-patient care and in this condition when extended hospital stay is necessary, the coverage is extension of coverage for in-patient care.\n",
-      "- For Ambulance Charge and in this condition when ambulance services are utilized, the coverage is reimbursement for ambulance charges.\n",
-      "- For Out-patient treatment and in this condition when receiving outpatient medical care, the coverage is reimbursement for outpatient medical expenses.\n",
-      "- For Cancer Screening & Mammographic Examination and in this condition when undergoing cancer screening or mammographic examination, the coverage is coverage for these preventive services.\n",
-      "- For New Born baby Cover and in this condition when a newborn is covered under the policy, the coverage is medical expenses coverage for the newborn.\n",
-      "- For Maternity and in this condition when maternity services are required, the coverage is coverage for maternity expenses.\n",
-      "- For Complete pre-existing disease cover and in this condition when seeking treatment for pre-existing conditions, the coverage is coverage for pre-existing conditions.\n",
-      "- For Medical sum insured replenishment in case of hospitalization due to accident and in this condition when hospitalized due to an accident, the coverage is replenishment of the sum insured.\n",
-      "- For Waiver of sublimit for insured above 60 years of age and in this condition when the insured is above 60 years of age, the coverage is waiver of sublimits.\n",
-      "- For Psychiatric Counseling and in this condition when seeking psychiatric counseling, the coverage is coverage for psychiatric counseling services.\n",
-      "- For Physiotherapy and in this condition when undergoing physiotherapy, the coverage is coverage for physiotherapy sessions.\n",
-      "- For Terrorism cover and in this condition when affected by terrorism, the coverage is coverage for medical expenses related to terrorism incidents.\n",
-      "- For Medical tele-consultation and in this condition when consulting a medical practitioner remotely, the coverage is coverage for tele-consultation services.\n",
-      "- For Medical evacuation and in this condition when requiring medical evacuation, the coverage is coverage for medical evacuation services.\n",
-      "- For Compassionate visit and in this condition when requiring a compassionate visit, the coverage is coverage for travel expenses for a family member to visit.\n",
-      "- For Escort of Minor Child and in this condition when escorting a minor child for medical treatment, the coverage is coverage for escort services for the child.\n",
-      "- For Upgradation to Business Class and in this condition when requiring upgradation to business class for medical travel, the coverage is coverage for upgradation to business class.\n"
-     ]
-    }
-   ],
-   "source": [
-    "target_page = 45\n",
-    "pages_vanilla = documents[0].text.split(\"\\n---\\n\")\n",
-    "pages_with_instructions = documents_with_instruction[0].text.split(\"\\n---\\n\")\n",
-    "\n",
-    "print(pages_vanilla[target_page])\n",
-    "print(\"\\n\\n=========================================================\\n\\n\")\n",
-    "print(pages_with_instructions[target_page])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "node_parser_instruction = MarkdownElementNodeParser(\n",
-    "    llm=OpenAI(model=\"gpt-3.5-turbo-0125\"), num_workers=8\n",
-    ")\n",
-    "nodes_instruction = node_parser.get_nodes_from_documents(documents_with_instruction)\n",
-    "(\n",
-    "    base_nodes_instruction,\n",
-    "    objects_instruction,\n",
-    ") = node_parser_instruction.get_nodes_and_objects(nodes_instruction)\n",
-    "\n",
-    "recursive_index_instruction = VectorStoreIndex(\n",
-    "    nodes=base_nodes_instruction + objects_instruction\n",
-    ")\n",
-    "query_engine_instruction = recursive_index_instruction.as_query_engine(\n",
-    "    similarity_top_k=25\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Comparing Instruction-Augmented Parsing vs. Vanilla Parsing\n",
-    "\n",
-    "When we parse the document with natural language instructions to add context on insurance coverage, we are able to correctly answer a wide range of queries in our RAG pipeline. In contrast, a RAG pipeline built with the vanilla method is not able to answer these queries."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Vanilla:\n",
-      "You are covered for the amount you paid due to the trip delay, up to the limit specified in the certificate of insurance.\n",
-      "With instructions:\n",
-      "For Trip Delay coverage, you are covered for a fixed benefit amount as mentioned in the certificate of insurance for every block of hours of delay.\n"
-     ]
-    }
-   ],
-   "source": [
-    "query_1 = \"My trip was delayed and I paid 45, how much am I covered for?\"\n",
-    "\n",
-    "response_1 = query_engine.query(query_1)\n",
-    "print(\"Vanilla:\")\n",
-    "print(response_1)\n",
-    "\n",
-    "print(\"With instructions:\")\n",
-    "response_1_i = query_engine_instruction.query(query_1)\n",
-    "print(response_1_i)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Looking at the policy it says in list I that one expense not covered is Baby food"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Vanilla:\n",
-      "Baby food is not explicitly mentioned in the provided context information regarding insurance coverages and benefits.\n",
-      "With instructions:\n",
-      "Baby food is excluded from coverage according to the policy terms.\n"
-     ]
-    }
-   ],
-   "source": [
-    "query_2 = \"I just had a baby, is baby food covered?\"\n",
-    "\n",
-    "response_2 = query_engine.query(query_2)\n",
-    "print(\"Vanilla:\")\n",
-    "print(response_2)\n",
-    "\n",
-    "print(\"With instructions:\")\n",
-    "response_2_i = query_engine_instruction.query(query_2)\n",
-    "print(response_2_i)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Vanilla:\n",
-      "Gauze used in your operation would typically be covered under the \"Emergency In-patient Medical Treatment\" or \"Emergency In-patient Medical Treatment with OPD\" benefits of the policy.\n",
-      "With instructions:\n",
-      "Gauze is not covered for use in your operation as it falls under the category of items that are excluded from coverage in the insurance policy.\n"
-     ]
-    }
-   ],
-   "source": [
-    "query_3 = \"How is gauze used in my operation covered?\"\n",
-    "\n",
-    "response_3 = query_engine.query(query_3)\n",
-    "print(\"Vanilla:\")\n",
-    "print(response_3)\n",
-    "\n",
-    "print(\"With instructions:\")\n",
-    "response_3_i = query_engine_instruction.query(query_3)\n",
-    "print(response_3_i)"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama_parse",
-   "language": "python",
-   "name": "llama_parse"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

examples/demo_languages.ipynb

@@ -1,444 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "28d15ea5-a3eb-4ee5-9d91-8dbd95e53129",
-   "metadata": {},
-   "source": [
-    "# Multi-Language Support in LlamaParse\n",
-    "\n",
-    "LlamaParse supports users to specify a `language` parameter before uploading documents, giving users better OCR capabilities over non-English PDFs, parsing images into more accurate representations.\n",
-    "\n",
-    "You can specify 80+ different languages: see this file for a full list of supported languages: https://github.com/run-llama/llama_parse/blob/main/llama_parse/base.py.\n",
-    "\n",
-    "This notebook shows a demo of this in action. "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "15539193-2f5c-4ecf-9ca4-9aee6f888468",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%pip install llama-index llama-parse"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "87322210-c21c-43d6-b459-2e8a828ac576",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# llama-parse is async-first, running the sync code in a notebook requires the use of nest_asyncio\n",
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()\n",
-    "\n",
-    "import os\n",
-    "\n",
-    "# os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"llx-...\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2b5cabdf-342a-42d2-8ad4-0ba7c46cdfb9",
-   "metadata": {},
-   "source": [
-    "## Load in a French PDF\n",
-    "\n",
-    "We load in the 2022 annual report from Agence France Tresor."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e81e0a08-3a99-42e6-adcc-00bb4ce1c3d4",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!wget \"https://www.dropbox.com/scl/fi/fxg17log5ydwoflhxmgrb/treasury_report.pdf?rlkey=mdintk0o2uuzkple26vc4v6fd&dl=1\" -O treasury_report.pdf"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ecfc578c-3c7f-4ec1-aa06-51565c28632b",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 476966e1-9e04-49e7-a5dc-952b053b8b94\n",
-      "......"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "parser = LlamaParse(result_type=\"text\", language=\"fr\")\n",
-    "documents = parser.load_data(\"./treasury_report.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0c37db27-3496-4a59-918b-701c9ad7706d",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      " ET GESTION DE LA DETTE DE L’ÉTAT\n",
-      "             P.56      FOCUS OAT VERTES\n",
-      "             P.60      CONTRÔLE DES RISQUES & POST-MARCHÉ\n",
-      "         Chiffres de l’exercice 2022                                                    P.64 À 105\n",
-      "             P.65      ACTIVITÉ DE L’AFT\n",
-      "             P.84      RAPPORT STATISTIQUE\n",
-      "         FICHES TECHNIQUES                   GLOSSAIRES                LISTE DES ABRÉVIATIONS\n",
-      "             P.106                                P.118                    P.122\n",
-      "                                                              AGENCE FRANCE TRÉSOR - RAPPORT D’ACTIVITÉ 2022      3\n",
-      "---\n",
-      "                                    Édito\n",
-      "                                                   111        Avec une croissance\n",
-      "                                                       de +2,5 %, la France a illustré\n",
-      "                                                      une nouvelle fois sa résilience\n",
-      "                                                       économique face aux chocs.\n",
-      "4  AGENCE FRANCE TRÉSOR - RAPPORT D’ACTIVITÉ 2022\n",
-      "---\n",
-      "               L’économie française en 2022 :\n",
-      " résilience face aux chocs géopolitiques\n",
-      "                                       et économiques\n",
-      "                                             sa résilience économique face aux           lors du dernier trimestre de 2022.\n",
-      "LE DÉBUT DE                                  chocs. Cette croissance a été permise       Malgré un climat des affaires impacté\n",
-      "L’ANNÉE 2022                                 grâce à une forte demande intérieure        par l’inflation, le soutien apporté\n",
-      "                                             alimentée    par   le dynamisme       de    aux TPE/PME leur a permis de faire\n",
-      "SEMBLAIT                                     l’investissement     et,  en  dépit   de    face aux défis énergétiques tout en\n",
-      "                                             l’inflation,  d’une   résilience   de  la   préservant l’emploi.\n",
-      "ENGAGÉ DANS                                  consommation des ménages sur une\n",
-      "                                             grande partie de l’année.                   Afin de combattre l’inflation qui a\n",
-      "UNE DYNAMIQUE                                                                            largement dépassé la cible de 2 %,\n",
-      "                                             Le  taux  d’inflation    des  prix  à  la   la BCE, de concert avec les banques\n",
-      "EFFICACE DE                                  consommation français est resté l’un        centrales des principales économies\n",
-      "SORTIE DE CRISE                              des plus bas d’Europe avec +6,0 %           développées, a adapté sa fonction de\n",
-      "                                             en 2022, s’appuyant, d’une part, sur        réaction en mettant fin aux politiques\n",
-      "PORTÉE PAR                                   l’atout structurel que représente un        d’assouplissement monétaire qu’elle\n",
-      "                                             mix énergétique parmi les moins             menait depuis la crise financière de\n",
-      "UNE REPRISE                                  exposés à la Russie et, d’autre part,       2008. Ainsi, dès juillet 2022, et pour\n",
-      "                                             sur  les politiques    proactives     du    la première fois en 10 ans, la BCE a\n",
-      "ÉCONOMIQUE                                   gouvernement avec la mise en place          augmenté ses taux directeurs. Les\n",
-      "                                             du bouclier tarifaire, de la remise         taux d’emprunts de l’État à 10 ans se\n",
-      "INÉDITE                                      carburant et du chèque énergie.             sont ainsi progressivement éloignés\n",
-      "AMORCÉE                                      Ces  dispositifs,   temporaires,     ont    de   leur  territoire    négatif   pour\n",
-      "                                             été progressivement supprimés : la          atteindre 3,10 % en fin d’année.\n",
-      "EN 2021.                                     remise carburant, d’abord prolongée\n",
-      "                                             jusqu’à   mi-novembre        a pris   fin   Cette    décision    s’est  également\n",
-      "Le déclenchement de la guerre en             en décembre 2022, tandis que le             accompagnée           de   la   fin   du\n",
-      "Ukraine par la Russie dès février a          chèque énergie exceptionnel a pris          programme d’achat d’urgence (PEPP)\n",
-      "rebattu les cartes de cet équilibre,         fin en mars 2023.                           mis en place pendant la pandémie,\n",
-      "provoquant des bouleversements                                                           suivi de la réduction progressive de\n",
-      "majeurs sur les plans géopolitiques et       Le marché du travail français a par         son bilan, à un rythme mensuel de 15\n",
-      "économiques, avec le déploiement             ailleurs montré toute sa robustesse,        milliards d’euros par mois.\n",
-      "de sanctions à l’encontre de la Russie       la dynamique de reprise initiée en\n",
-      "et une forte poussée inflationniste.         2021 ainsi que l’effet des réformes         L’Agence France Trésor a fait face à ce\n",
-      "Face à cette situation, les principales      structurelles engagées les années           contexte de grands bouleversements\n",
-      "banques centrales mondiales, dont            précédentes     permettant      au  taux    géopolitiques,      économiques        et\n",
-      "la  Banque     centrale    européenne        d’emploi des Français âgés de 15 à 64       financiers   en   s’appuyant     sur  ses\n",
-      "(BCE), ont engagé une politique de           ans d’atteindre fin 2022 un niveau          principes de régularité, de prévisibilité\n",
-      "normalisation      monétaire      rapide     de 68,1 %, un record depuis 1975.           et de transparence. Cette stratégie\n",
-      "pour    lutter   contre     l’inflation.     La reprise économique de début              s’est de nouveau révélée robuste et,\n",
-      "Parallèlement,      le gouvernement          d’année et les effets positifs du plan      alliée à l’engagement et à l’efficacité\n",
-      "français a mis en place des mesures          France Relance ont permis la création       de ses équipes, ainsi qu’à la qualité\n",
-      "(à hauteur de 43,6 milliards d’euros         de 337 100 emplois, essentiellement         de crédit de la signature de la France,\n",
-      "sur l’année 2022) pour protéger les          dans le secteur salarié marchand. Ce        lui a permis d’accomplir sa mission\n",
-      "entreprises et les ménages.                  dynamisme a aussi conduit à la chute        de financement de l’action publique\n",
-      "                                             du taux de chômage, atteignant son          au bénéfice de tous.\n",
-      "Avec une croissance de +2,5 %, la            niveau le plus bas depuis mars 2008\n",
-      "France a illustré une nouvelle fois          avec 7,2 % de demandeurs d’emploi\n",
-      "                                                                                         Emmanuel Moulin\n",
-      "                                                                                         DIRECTEUR GÉNÉRAL DU TRÉSOR\n",
-      "                                                                                         ET PRÉSIDENT DE L’AFT\n",
-      "                                                            AGENCE FRANCE TRÉSOR - RAPPORT D’ACTIVITÉ 2022                     5\n",
-      "---\n",
-      "   du directeur général                     Le mot\n",
-      "                                                        011  En 2022, le choc d’inflation\n",
-      "                                                                    et la normalisation\n",
-      "                                                               de la politique monétaire\n",
-      "                                                              ont mis fin à une décennie\n",
-      "                                                             de taux historiquement bas.\n",
-      "6       AGENCE FRANCE TRÉSOR - RAPPORT D’ACTIVITÉ 2022\n",
-      "---\n",
-      "  MALGRÉ UN CONTEXTE DE MARCHÉ MOUVEMENTÉ ET LES MESURES D’AMPLEUR\n",
-      "               PRISES POUR LIMITER L’IMPACT DE L’INFLATION SUR LES MÉNAGES ET\n",
-      "  LES ENTREPRISES, LE PROGRAMME DE FINANCEMENT À MOYEN ET LONG TERME\n",
-      "        EST DEMEURÉ INCHANGÉ À 260 MILLIARDS D’EUROS, STABLE PAR RAPPORT\n",
-      "  À 2021, ET LA DETTE DE COURT TERME A ÉTÉ RÉDUITE DE 7 MILLIARDS D’EUROS.\n",
-      "En janvier 2022, la normalisation de                                 d’obligations indexées sur l’inflation,                               la dette de court terme a été réduite\n",
-      "la politique monétaire en zone euro                                  sur      lequel         a    été      enregistré             un       de    7   milliards         d’euros.        En    effet,      le\n",
-      "était      une      perspective              de     moyen            supplément d’indexation supérieur                                     dynamisme des recettes fiscales et\n",
-      "terme. Quelques semaines plus tard,                                  de     17    milliards        d’euros         à   celui      de       la   trésorerie          levée      lors     de    la   crise\n",
-      "l’invasion de l’Ukraine par la Russie                                l’année          2021.       Il   s’est      également                sanit\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(documents[0].get_content()[1000:10000])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "be161577-7b1e-4710-b721-f549feb8e6d0",
-   "metadata": {},
-   "source": [
-    "## Download Chinese PDF"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ac332ea3-cfff-4216-b292-62410a26c336",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "--2024-02-28 16:41:26--  https://www.dropbox.com/scl/fi/g5ojyzk4m44hl7neut6vc/chinese_pdf.pdf?rlkey=45reu51kjvdvic6zucr8v9sh3&dl=1\n",
-      "Resolving www.dropbox.com (www.dropbox.com)... 162.125.13.18\n",
-      "Connecting to www.dropbox.com (www.dropbox.com)|162.125.13.18|:443... connected.\n",
-      "HTTP request sent, awaiting response... 302 Found\n",
-      "Location: https://uc7a03fdb7d960dbedb23e9298ab.dl.dropboxusercontent.com/cd/0/inline/COJ69Wg2e7wH9S0ELzl4j4znoonRSQS-JJrH6mxy_vcrvY-KV7f10kMyQH6IYmtfMh_9xcDNOYnLkWkwMTYItwE1XQB5nqXbjmLJ4jLbDrMeu7-b49m796ctxevwnp7k1_U/file?dl=1# [following]\n",
-      "--2024-02-28 16:41:27--  https://uc7a03fdb7d960dbedb23e9298ab.dl.dropboxusercontent.com/cd/0/inline/COJ69Wg2e7wH9S0ELzl4j4znoonRSQS-JJrH6mxy_vcrvY-KV7f10kMyQH6IYmtfMh_9xcDNOYnLkWkwMTYItwE1XQB5nqXbjmLJ4jLbDrMeu7-b49m796ctxevwnp7k1_U/file?dl=1\n",
-      "Resolving uc7a03fdb7d960dbedb23e9298ab.dl.dropboxusercontent.com (uc7a03fdb7d960dbedb23e9298ab.dl.dropboxusercontent.com)... 162.125.13.15\n",
-      "Connecting to uc7a03fdb7d960dbedb23e9298ab.dl.dropboxusercontent.com (uc7a03fdb7d960dbedb23e9298ab.dl.dropboxusercontent.com)|162.125.13.15|:443... connected.\n",
-      "HTTP request sent, awaiting response... 302 Found\n",
-      "Location: /cd/0/inline2/COKEp-d6ZqzrIIaPRlanov72wwnd7GX5eNSPnsxug0A8pOpek8hO6eFxp84cY3_NMBRsAqtX-IIVPpcfYHNoV__mpu1SsOV8wV8a68DwVKaVJRJriY_KV8lEFocvLgf7c7mhrREbIJ1UBN2fx6S_qWegwVIen1z1-pw-K7icMnA3EKJNqM9DFtqx9ct0FI4vdYGsv8ckLF26WgAhs96k1cHn-VRJle4SKstdYs8EmBxiuFLXZRCL3gljwAsLu3J6WRvis9v7VJ2zNhgrcT-ZnVujlpQGoGWLLPmREKffK608Xfz1XE35DzO28e_mm4SUPRfsP2mvIUrJUtUrhobR4siqQRGojxi0S7-da4Y7fpB4Tw/file?dl=1 [following]\n",
-      "--2024-02-28 16:41:27--  https://uc7a03fdb7d960dbedb23e9298ab.dl.dropboxusercontent.com/cd/0/inline2/COKEp-d6ZqzrIIaPRlanov72wwnd7GX5eNSPnsxug0A8pOpek8hO6eFxp84cY3_NMBRsAqtX-IIVPpcfYHNoV__mpu1SsOV8wV8a68DwVKaVJRJriY_KV8lEFocvLgf7c7mhrREbIJ1UBN2fx6S_qWegwVIen1z1-pw-K7icMnA3EKJNqM9DFtqx9ct0FI4vdYGsv8ckLF26WgAhs96k1cHn-VRJle4SKstdYs8EmBxiuFLXZRCL3gljwAsLu3J6WRvis9v7VJ2zNhgrcT-ZnVujlpQGoGWLLPmREKffK608Xfz1XE35DzO28e_mm4SUPRfsP2mvIUrJUtUrhobR4siqQRGojxi0S7-da4Y7fpB4Tw/file?dl=1\n",
-      "Reusing existing connection to uc7a03fdb7d960dbedb23e9298ab.dl.dropboxusercontent.com:443.\n",
-      "HTTP request sent, awaiting response... 200 OK\n",
-      "Length: 8074860 (7.7M) [application/binary]\n",
-      "Saving to: ‘chinese_pdf.pdf’\n",
-      "\n",
-      "chinese_pdf.pdf     100%[===================>]   7.70M  37.9MB/s    in 0.2s    \n",
-      "\n",
-      "2024-02-28 16:41:28 (37.9 MB/s) - ‘chinese_pdf.pdf’ saved [8074860/8074860]\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "!wget \"https://www.dropbox.com/scl/fi/g5ojyzk4m44hl7neut6vc/chinese_pdf.pdf?rlkey=45reu51kjvdvic6zucr8v9sh3&dl=1\" -O chinese_pdf.pdf"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "45235b17-08f0-48f1-92aa-06711225860b",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 0089f0b6-29ee-4e94-a8bf-49a137666f15\n",
-      ".........."
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "parser = LlamaParse(result_type=\"text\", language=\"ch_sim\")\n",
-    "documents = parser.load_data(\"./chinese_pdf.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "f0d546cc-6549-4cf5-8b37-0896f4e8d43d",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "中国投资有限责任公司2022年度报告                        5\n",
-      "---\n",
-      "企业文化与核心价值观\n",
-      "使命                           核心价值观\n",
-      " 致力于实现国家外汇资金多元化投资，在可接受风险范围内  责任              合力\n",
-      " 实现股东权益最大化，以服务于国家经济发展和深化金融体\n",
-      " 制改革的需要                      忠于使命、勤勉尽责       立足大局、有效协同\n",
-      "                             是公司遵奉的核心价值取向    是实现公司可持续发展的关键\n",
-      " 愿景                          专业              进取\n",
-      " 成为受人尊重的国际一流主权财富基金           坚持良好的专业精神和职业操守  求知进取、追求卓越\n",
-      "                             是公司成功的基石        是公司成功和发展壮大的内驱力\n",
-      "---\n",
-      "01                           我们将一以贯之地践行全球发展倡议，充分维护投资东道国利益，\n",
-      "                             积极投身可持续投资，助力世界经济实现更高质量、更有韧性的发展。\n",
-      "   致  辞\n",
-      "   3     中国投资有限责任公司2022年度报告  中国投资有限责任公司2022年度报告               4\n",
-      "---\n",
-      "                           “行之力则知愈进，知之深则行愈达。”站在新的历史起点上，中投公司\n",
-      "                           将继续秉承精益求精、追求卓越的专业精神，与国内外合作伙伴一起深化\n",
-      "                           合作，共聚力量、共迎挑战、共享成果，开启打造世界一流主权财富基金\n",
-      "                           的新篇章，为助力全球经济发展作出新贡献！                                   #Ave彭纯\n",
-      "                                                                                      董事长\n",
-      "                                2022年，是中投公司成立十五周年。\n",
-      "董事长致辞                           自2007年成立以来，中投公司坚守长期机构投资者定位，坚持国际化、市场化、专业化、负责任原则，搭\n",
-      "                           建起符合大型国际投资机构特点的治理架构，形成了系统完备的投资管理体系，经受住了国际金融危机、世纪\n",
-      "                           疫情等多个历史罕见的风险与挑战。如今，公司对外投资业务覆盖国际市场主要资产类别以及全球110多个国家\n",
-      "                           和地区，培养了一支高素质专业化的投资管理人才队伍，搭建了互利共赢的投资合作“朋友圈”，长期投资收\n",
-      "                           益超越董事会制定的考核目标，为促进国家外汇资产保值增值、服务国内国际双循环作出了积极贡献，在推动\n",
-      "                           全球投资合作、助力世界经济增长中贡献了中投力量，书写了中国主权财富基金不平凡的创业发展史。\n",
-      "5      中国投资有限责任公司2022年度报告  中国投资有限责任公司2022年度报告                                              6\n",
-      "---\n",
-      "    2022年以来，全球地缘政治风险显著攀升，产业链供应链持续调整重构，美欧央行大幅加息，国际资本                           我们守正创新，坚决践行双碳与可持续发展理念。更加包容、更加普惠、更有韧性的发展是全球\n",
-      "市场剧烈震荡，MSCI全球股票指数、彭博全球债券指数一度自高点下跌超过22%、13%。面对风高浪急的国                      可持续发展的关键。我们积极履行负责任投资者理念，制定《关于践行双碳目标和可持续投资行动的意见》，\n",
-      "际环境和前所未有的巨大挑战，公司保持战略定力，发挥长期机构投资者优势，不断优化资产配置和投资策                          积极开展气候变化、能源转型等主题投资。我们发布《运营碳中和行动计划》，明确时间表和路线图，全力实\n",
-      "略，着力提升总组合韧性，加强重点领域风险防控，年度投资收益跑赢大市；截至2022年底，过去十年对外                        现节能减排目标。我们探索以绿色资源引领乡村发展的新方法，在四个定点帮扶县持续推进巩固脱贫成果与乡\n",
-      "投资年化净收益率按美元计算为6.43%，超出十年业绩目标26个基点；自成立以来累计年化国有资本增值率达                      村振兴的有效衔接，助力民生保障与产业扶持，积极履行企业社会责任。\n",
-      "到12.67%，圆满完成五年战略规划主要目标任务。                                                     面向未来，我们坚信，发展与合作是破解全球性问题的“钥匙”。中投公司将一以贯之地践行全球发展倡\n",
-      "    我们矢志不渝，积极打造世界一流主权财富基金。长期资本对于促进世界经济持续发展有着不                            议，秉持互利共赢理念，以资本为纽带，促进国际产业交流合作，推动世界互联互通；充分维护投资东道国利\n",
-      "可替代的作用。我们坚持国际化、市场化、专业化、负责任原则，快速恢复常态化对外交流交往，按照互利共                         益，与东道国共创价值、共享价值；积极投身可持续投资，推动被投企业履行社会责任，助力世界经济实现更\n",
-      "赢原则深化与国内外各类机构合作，持续为世界经济发展提供长期资本支持。我们积极创新对外投资方式，稳                         高质量、更有韧性的发展。\n",
-      "健运行多支新型双边基金，新设相关投资合作平台，深入推进中国市场价值创造，促进被投资公司拓展市场空\n",
-      "间，助推国际投资与产业合作高质量发展。                                                           经济全球化的潮流不可阻挡。我们呼吁各国携起手来，做多边主义的坚定维护者，打造更加开放有序的投\n",
-      "                                                                         资环境，便利资本和资源要素在全球顺畅流动。我们尊重各方的利益关切，在开放中捕捉投资机遇，以务实合\n",
-      "    我们直面挑战，着力加强自主投资能力建设。面对持续动荡的国际金融市场，我们锚定配置方                            作应对共同挑战，并肩前进分享发展红利，推动世界经济平稳运行和持续增长。\n",
-      "向，强化研究驱动，有序实施组合调整、策略优化，及时调整公开市场投资布局，质量并重推进非公开市场投\n",
-      "资，完成另类资产投资占比50%的资产配置目标，对外投资总组合的韧性和质量不断提高。我们持续深化投资                             “行之力则知愈进，知之深则行愈达。”过去的十五年，是中投人不惧挑战、接续奋斗的十五\n",
-      "管理体制机制改革，统一非公开市场投资决策制度流程，配强投资决策专职委员并设立支持团队，投资管理科                         年。  2023年是中投人落实新一轮战略规划的开局之年。上半年，在风高浪急的国际环境下，中投公司锚定战略目\n",
-      "学化、专业化水平得到进一步提升。                                                         标，统筹好发展和安全，取得了良好业绩，实现了良好开局。近期，公司部分董事更换，我们对离任董事在指导和支\n",
-      "                                                                         持公司完善公司治理、深化投资管理体制机制改革、应对国际市场风险挑战等方面所作的贡献表示衷心感谢，对新\n",
-      "    我们勇担使命，坚定走好中国特色金融发展之路。面对新征程新要求，我们坚持发挥“积极股                            任董事表示热烈欢迎。站在新的历史起点上，中投公司将完整、准确、全面贯彻新发展理念，积极助力构建新发展格\n",
-      "东”作用，督促控参股金融企业优化产品服务、加大资源倾斜力度，全力支持稳经济稳增长。我们积极创新完                         局，牢牢把握高质量发展首要任务，继续秉承精益求精、追求卓越的专业精神，与国内外合作伙伴一起深化合作，共\n",
-      "善“汇金模式”，推动优化国有金融资本布局，以市场化方式参与问题金融机构救助，助力金融市场稳定健康                         聚力量、共迎挑战、共享成果，开启打造世界一流主权财富基金的新篇章，为助力全球经济发展作出新贡献！\n",
-      "发展。我们主动适应新形势新要求，围绕国有金融资本管理体系建设等重大课题深入研究，压实派出董事自主\n",
-      "履职责任，不断提升机构化履职能力。\n",
-      "    我们坚守底线，持续夯实全面风险管理体系。面对风高浪急的国际环境，我们优化风险管理委员\n",
-      "会设置，修订全面风险管理基本制度，增加风险类别的覆盖度，全面提升风险预见、应对、处置水平。在对外投\n",
-      "资方面，我们严守法律合规底线，健全地缘政治、气候变化等非传统风险防控机制，突出抓好流动性管理，对外\n",
-      "投资总组合风险保持在董事会规定的容忍度内。在国有金融资本受托管理方面，我们建立健全控参股金融企业风\n",
-      "险监测体系，全面开展多维度风险画像，推动控参股金融企业风险减存量、控增量、防变量取得积极成效。\n",
-      "7                                                    中国投资有限责任公司2022年度报告  中国投资有限责任公司2022年度报告                                     8\n",
-      "---\n",
-      "02                                 中投公司的组建宗旨是实现国家外汇资金多元化投资，在可接受风\n",
-      "                                   险范围内实现股东权益最大化，以服务于国家宏观经济发展和深化\n",
-      "   公  司  介  绍                      金融体制改革的需要。\n",
-      "   9           中国投资有限责任公司2022年度报告  中国投资有限责任公司2022年度报告             10\n",
-      "---\n",
-      "公司概况中国投资有限责任公司（以下简称“中投公司”）依照《中华人民共和国公司法》（以下简称“《公司                           公司治理 中投公司按照《公司法》及《中国投资有限责任公司章程》（以下简称“《中投公司章程》”）中的有关规\n",
-      "法》”）于2007年9月成立，总部设在北京。中投公司的初始资本金为2000亿美元，由中国财政部发行1.55万                      定，设立了董事会、监事会和执行委员会（以下简称“执委会”），三者之间权责明确、独立履职、有效制衡。\n",
-      "亿元人民币特别国债募集。截至2022年底，公司总资产达1.24万亿美元。                                             2022年，中投公司健全完善董事会、监事会运行机制，强化下设专门委员会的职能发挥，持续提升公司治\n",
-      "    中投公司的组建宗旨是实现国家外汇资金多元化投资，在可接受风险范围内实现股东权益最大化，以服务于                         理效能。公司根据业务发展需要，优化调整投资管理架构，完善投资决策和投后管理制度机制，深化全面风险管\n",
-      "国家宏观经济发展和深化金融体制改革的需要。                                                       理体系建设，全面提升机构化投资能力。\n",
-      "    中投公司开展境外投资业务与境内金融机构股权管理工作。其中，境外投资业务由下设子公司⸺中投国际\n",
-      "有限责任公司（以下简称“中投国际”）和中投海外直接投资有限责任公司（以下简称“中投海外”）承担，业\n",
-      "务范围包括公开市场股票和债券投资，对冲基金和多资产，泛行业私募股权和私募信用投资，房地产、基础设\n",
-      "施、资源商品、农业等领域的基金投资与直接投资，以及多双边基金管理等。                                          组织架构图\n",
-      "    中央汇金投资有限责任公司（以下简称“中央汇金”）作为中投公司的子公司，根据国务院授权，对国有重\n",
-      "点金融企业进行股权投资，以出资额为限代表国家依法对国有重点金融企业行使出资人权利和履行出资人义务。                                                               董事会                                 监事会\n",
-      "中央汇金不开展商业性经营活动，不干预其控股的国有重点金融企业的日常经营活动。                                               提名与\n",
-      "                                                                                    薪酬委员会\n",
-      "    中投国际和中投海外开展的境外业务与中央汇金开展的境内业务之间实行严格的“防火墙”政策和措施。\n",
-      "                                                                                     战略与\n",
-      "                                                                                    社会责任\n",
-      "                                                                                     委员会\n",
-      "                                                                                    风险管理                          执行               国际咨询         监督       审计\n",
-      "                                                                                     委员会                         委员会                委员会        委员会       委员会\n",
-      "                                                                                    境外投资                       管理与支持                     境内股权\n",
-      "                                                                                    业务部门                          部门                     管理部门\n",
-      "11                                                      中国投资有限责任公司2022年度报告  中国投资有限责任公司2022年度报告                                                                12\n",
-      "---\n",
-      "董事会                                                                                                         沈如军\n",
-      "                                                                                                            党委委员、执行董事、副总经理\n",
-      "    中投公司董事会行使《公司法》和《中投公司章程》中规定的有限责任公司董事会的职权，主要包括：审核                                                         1964年出生，管理学博士，高级会计师。历任中国工商银行计划财务部副总经理、\n",
-      "和批准公司的发展战略、经营方针和投资计划；确定公司需向股东报告的重大事项；制定公司年度预决算方案；                                                           北京市分行副行长、财务会计部总经理、山东省分行行长，交通银行执行董事、副\n",
-      "任免公司高级管理人员；决定或授权批准设立内部管理机构等。                                                                                行长。现任本公司党委委员、执行董事、副总经理。\n",
-      "    董事会由执行董事、非执行董事、独立董事以及职工董事构成。                                                                            丛亮\n",
-      "    2022年，面对复杂严峻的国际经济形势，董事会加强对公司重大经营管理事项的指导和督促，及时听取投                                                        非执行董事\n",
-      "资形势、经营管理、风险防控等汇报，认真审议经营计划、财务预算和决算、业绩考核等重要议题，深入谋划中                                                           1971年出生，经济学博士。历任国家发展和改革委员会国民经济综合司副司长、司\n",
-      "投公司新一轮战略规划，明确发展目标、基本原则和重点举措，为公司下一阶段改革发展描绘新的蓝图。董事会                                                           长，国家发展和改革委员会秘书长、新闻发言人，国家发展和改革委员会副主任，\n",
-      "专门委员会根据授权，重点关注关系企业长远发展的重大事项，为董事会出谋划策，推动公司高质量发展迈上新                                                           国家粮食和物资储备局局长。现任国家发展和改革委员会副主任，并兼任本公司非\n",
-      "台阶。                                                                                                         执行董事。\n",
-      "                                                                                                            许宏才\n",
-      "                                                                                                            非执行董事\n",
-      "董事会成员                                                                                                       1963年出生，经济学学士。历任财政部预算司副司长、司长，财政部部长助理，财\n",
-      "                                                                                                            政部副部长。现任全国人大财政经济委员会副主任委员、全国人大常委会预算工作\n",
-      "                            彭 纯                                    \n"
-     ]
-    }
-   ],
-   "source": [
-    "print(documents[0].get_content()[1000:10000])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "640f0679-7f7e-4b0a-a46d-b099ae382fe2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# download another copy with a different name to avoid hitting pdf cache\n",
-    "!wget \"https://www.dropbox.com/scl/fi/g5ojyzk4m44hl7neut6vc/chinese_pdf.pdf?rlkey=45reu51kjvdvic6zucr8v9sh3&dl=1\" -O chinese_pdf2.pdf"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "bfcacf90-ca67-4bfd-b023-be0af2cb18c5",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 99538f59-24f7-4f1e-ab27-4081933fa5ee\n"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "base_parser = LlamaParse(result_type=\"text\", language=\"en\")\n",
-    "base_documents = parser.load_data(\"./chinese_pdf2.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "b264ed4e-647a-4f51-9f79-fdf82b76762a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "print(base_documents[0].get_content()[1000:10000])"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama_parse",
-   "language": "python",
-   "name": "llama_parse"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

examples/demo_parsing_instructions.ipynb

@@ -1,544 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# LlamaParse - Parsing comic books with parsing intructions\n",
-    "Parsing intructions allow you to instruct our parsing model the same way you would instruct an LLM!\n",
-    "\n",
-    "They can be useful to help the parser get better results on complex document layouts, to extract data in a specific format, or to transform the document in other ways.\n",
-    "\n",
-    "Using Parsing Instruction you will get better results out of LlamaParse on complicated documents, and also be able to simplify your application code."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Installation\n",
-    "\n",
-    "Parsing instructions are part of the llamaParse API. They can be accessed by directly specifying the parsing_instruction parameter in the API or by using the LlamaParse python module (which we will use for this tutorial).\n",
-    "\n",
-    "To install llama-parse, just get it from PIP:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Collecting llama-parse\n",
-      "  Downloading llama_parse-0.3.8-py3-none-any.whl (6.7 kB)\n",
-      "Collecting llama-index-core>=0.10.7 (from llama-parse)\n",
-      "  Downloading llama_index_core-0.10.19-py3-none-any.whl (15.3 MB)\n",
-      "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m15.3/15.3 MB\u001b[0m \u001b[31m31.9 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
-      "\u001b[?25hRequirement already satisfied: PyYAML>=6.0.1 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (6.0.1)\n",
-      "Requirement already satisfied: SQLAlchemy[asyncio]>=1.4.49 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (2.0.28)\n",
-      "Requirement already satisfied: aiohttp<4.0.0,>=3.8.6 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (3.9.3)\n",
-      "Collecting dataclasses-json (from llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading dataclasses_json-0.6.4-py3-none-any.whl (28 kB)\n",
-      "Collecting deprecated>=1.2.9.3 (from llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading Deprecated-1.2.14-py2.py3-none-any.whl (9.6 kB)\n",
-      "Collecting dirtyjson<2.0.0,>=1.0.8 (from llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading dirtyjson-1.0.8-py3-none-any.whl (25 kB)\n",
-      "Requirement already satisfied: fsspec>=2023.5.0 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (2023.6.0)\n",
-      "Collecting httpx (from llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading httpx-0.27.0-py3-none-any.whl (75 kB)\n",
-      "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m75.6/75.6 kB\u001b[0m \u001b[31m6.3 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
-      "\u001b[?25hCollecting llamaindex-py-client<0.2.0,>=0.1.13 (from llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading llamaindex_py_client-0.1.13-py3-none-any.whl (107 kB)\n",
-      "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m108.0/108.0 kB\u001b[0m \u001b[31m10.0 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
-      "\u001b[?25hRequirement already satisfied: nest-asyncio<2.0.0,>=1.5.8 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (1.6.0)\n",
-      "Requirement already satisfied: networkx>=3.0 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (3.2.1)\n",
-      "Requirement already satisfied: nltk<4.0.0,>=3.8.1 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (3.8.1)\n",
-      "Requirement already satisfied: numpy in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (1.25.2)\n",
-      "Collecting openai>=1.1.0 (from llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading openai-1.13.3-py3-none-any.whl (227 kB)\n",
-      "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m227.4/227.4 kB\u001b[0m \u001b[31m16.3 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
-      "\u001b[?25hRequirement already satisfied: pandas in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (1.5.3)\n",
-      "Requirement already satisfied: pillow>=9.0.0 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (9.4.0)\n",
-      "Requirement already satisfied: requests>=2.31.0 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (2.31.0)\n",
-      "Requirement already satisfied: tenacity<9.0.0,>=8.2.0 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (8.2.3)\n",
-      "Collecting tiktoken>=0.3.3 (from llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading tiktoken-0.6.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.8 MB)\n",
-      "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m1.8/1.8 MB\u001b[0m \u001b[31m43.1 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
-      "\u001b[?25hRequirement already satisfied: tqdm<5.0.0,>=4.66.1 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (4.66.2)\n",
-      "Requirement already satisfied: typing-extensions>=4.5.0 in /usr/local/lib/python3.10/dist-packages (from llama-index-core>=0.10.7->llama-parse) (4.10.0)\n",
-      "Collecting typing-inspect>=0.8.0 (from llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading typing_inspect-0.9.0-py3-none-any.whl (8.8 kB)\n",
-      "Requirement already satisfied: aiosignal>=1.1.2 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.6->llama-index-core>=0.10.7->llama-parse) (1.3.1)\n",
-      "Requirement already satisfied: attrs>=17.3.0 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.6->llama-index-core>=0.10.7->llama-parse) (23.2.0)\n",
-      "Requirement already satisfied: frozenlist>=1.1.1 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.6->llama-index-core>=0.10.7->llama-parse) (1.4.1)\n",
-      "Requirement already satisfied: multidict<7.0,>=4.5 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.6->llama-index-core>=0.10.7->llama-parse) (6.0.5)\n",
-      "Requirement already satisfied: yarl<2.0,>=1.0 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.6->llama-index-core>=0.10.7->llama-parse) (1.9.4)\n",
-      "Requirement already satisfied: async-timeout<5.0,>=4.0 in /usr/local/lib/python3.10/dist-packages (from aiohttp<4.0.0,>=3.8.6->llama-index-core>=0.10.7->llama-parse) (4.0.3)\n",
-      "Requirement already satisfied: wrapt<2,>=1.10 in /usr/local/lib/python3.10/dist-packages (from deprecated>=1.2.9.3->llama-index-core>=0.10.7->llama-parse) (1.14.1)\n",
-      "Requirement already satisfied: pydantic>=1.10 in /usr/local/lib/python3.10/dist-packages (from llamaindex-py-client<0.2.0,>=0.1.13->llama-index-core>=0.10.7->llama-parse) (2.6.3)\n",
-      "Requirement already satisfied: anyio in /usr/local/lib/python3.10/dist-packages (from httpx->llama-index-core>=0.10.7->llama-parse) (3.7.1)\n",
-      "Requirement already satisfied: certifi in /usr/local/lib/python3.10/dist-packages (from httpx->llama-index-core>=0.10.7->llama-parse) (2024.2.2)\n",
-      "Collecting httpcore==1.* (from httpx->llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading httpcore-1.0.4-py3-none-any.whl (77 kB)\n",
-      "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m77.8/77.8 kB\u001b[0m \u001b[31m8.5 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
-      "\u001b[?25hRequirement already satisfied: idna in /usr/local/lib/python3.10/dist-packages (from httpx->llama-index-core>=0.10.7->llama-parse) (3.6)\n",
-      "Requirement already satisfied: sniffio in /usr/local/lib/python3.10/dist-packages (from httpx->llama-index-core>=0.10.7->llama-parse) (1.3.1)\n",
-      "Collecting h11<0.15,>=0.13 (from httpcore==1.*->httpx->llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading h11-0.14.0-py3-none-any.whl (58 kB)\n",
-      "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m58.3/58.3 kB\u001b[0m \u001b[31m5.7 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
-      "\u001b[?25hRequirement already satisfied: click in /usr/local/lib/python3.10/dist-packages (from nltk<4.0.0,>=3.8.1->llama-index-core>=0.10.7->llama-parse) (8.1.7)\n",
-      "Requirement already satisfied: joblib in /usr/local/lib/python3.10/dist-packages (from nltk<4.0.0,>=3.8.1->llama-index-core>=0.10.7->llama-parse) (1.3.2)\n",
-      "Requirement already satisfied: regex>=2021.8.3 in /usr/local/lib/python3.10/dist-packages (from nltk<4.0.0,>=3.8.1->llama-index-core>=0.10.7->llama-parse) (2023.12.25)\n",
-      "Requirement already satisfied: distro<2,>=1.7.0 in /usr/lib/python3/dist-packages (from openai>=1.1.0->llama-index-core>=0.10.7->llama-parse) (1.7.0)\n",
-      "Requirement already satisfied: charset-normalizer<4,>=2 in /usr/local/lib/python3.10/dist-packages (from requests>=2.31.0->llama-index-core>=0.10.7->llama-parse) (3.3.2)\n",
-      "Requirement already satisfied: urllib3<3,>=1.21.1 in /usr/local/lib/python3.10/dist-packages (from requests>=2.31.0->llama-index-core>=0.10.7->llama-parse) (2.0.7)\n",
-      "Requirement already satisfied: greenlet!=0.4.17 in /usr/local/lib/python3.10/dist-packages (from SQLAlchemy[asyncio]>=1.4.49->llama-index-core>=0.10.7->llama-parse) (3.0.3)\n",
-      "Collecting mypy-extensions>=0.3.0 (from typing-inspect>=0.8.0->llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading mypy_extensions-1.0.0-py3-none-any.whl (4.7 kB)\n",
-      "Collecting marshmallow<4.0.0,>=3.18.0 (from dataclasses-json->llama-index-core>=0.10.7->llama-parse)\n",
-      "  Downloading marshmallow-3.21.1-py3-none-any.whl (49 kB)\n",
-      "\u001b[2K     \u001b[90m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m49.4/49.4 kB\u001b[0m \u001b[31m4.5 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m\n",
-      "\u001b[?25hRequirement already satisfied: python-dateutil>=2.8.1 in /usr/local/lib/python3.10/dist-packages (from pandas->llama-index-core>=0.10.7->llama-parse) (2.8.2)\n",
-      "Requirement already satisfied: pytz>=2020.1 in /usr/local/lib/python3.10/dist-packages (from pandas->llama-index-core>=0.10.7->llama-parse) (2023.4)\n",
-      "Requirement already satisfied: exceptiongroup in /usr/local/lib/python3.10/dist-packages (from anyio->httpx->llama-index-core>=0.10.7->llama-parse) (1.2.0)\n",
-      "Requirement already satisfied: packaging>=17.0 in /usr/local/lib/python3.10/dist-packages (from marshmallow<4.0.0,>=3.18.0->dataclasses-json->llama-index-core>=0.10.7->llama-parse) (23.2)\n",
-      "Requirement already satisfied: annotated-types>=0.4.0 in /usr/local/lib/python3.10/dist-packages (from pydantic>=1.10->llamaindex-py-client<0.2.0,>=0.1.13->llama-index-core>=0.10.7->llama-parse) (0.6.0)\n",
-      "Requirement already satisfied: pydantic-core==2.16.3 in /usr/local/lib/python3.10/dist-packages (from pydantic>=1.10->llamaindex-py-client<0.2.0,>=0.1.13->llama-index-core>=0.10.7->llama-parse) (2.16.3)\n",
-      "Requirement already satisfied: six>=1.5 in /usr/local/lib/python3.10/dist-packages (from python-dateutil>=2.8.1->pandas->llama-index-core>=0.10.7->llama-parse) (1.16.0)\n",
-      "Installing collected packages: dirtyjson, mypy-extensions, marshmallow, h11, deprecated, typing-inspect, tiktoken, httpcore, httpx, dataclasses-json, openai, llamaindex-py-client, llama-index-core, llama-parse\n",
-      "Successfully installed dataclasses-json-0.6.4 deprecated-1.2.14 dirtyjson-1.0.8 h11-0.14.0 httpcore-1.0.4 httpx-0.27.0 llama-index-core-0.10.19 llama-parse-0.3.8 llamaindex-py-client-0.1.13 marshmallow-3.21.1 mypy-extensions-1.0.0 openai-1.13.3 tiktoken-0.6.0 typing-inspect-0.9.0\n"
-     ]
-    }
-   ],
-   "source": [
-    "%pip install llama-parse"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## API key\n",
-    "\n",
-    "The use of LlamaParse requires an API key which you can get here: https://cloud.llamaindex.ai/parse"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"llx-...\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Async (Notebook only)\n",
-    "llama-parse is async-first, so running the code in a notebook requires the use of nest_asyncio\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Import the package"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_parse import LlamaParse"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Using llamaparse for getting better results (on Manga!)\n",
-    "\n",
-    "Sometimes the layout of a page is unusual and you will get sub-optimal reading order results with LlamaParse. For example, when parsing manga you expect the reading order to be right to left even if the content is in English!"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Let's download an extract of a great manga \"The manga guide to calculus\", by Hiroyuki Kojima (https://www.amazon.com/Manga-Guide-Calculus-Hiroyuki-Kojima/dp/1593271948)\n",
-    "\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "--2024-03-13 13:57:19--  https://drive.usercontent.google.com/uc?id=1tZJhcpepLRdQFJFCFX50QIqLyLgqzZsY&export=download\n",
-      "Resolving drive.usercontent.google.com (drive.usercontent.google.com)... 173.194.211.132, 2607:f8b0:400c:c10::84\n",
-      "Connecting to drive.usercontent.google.com (drive.usercontent.google.com)|173.194.211.132|:443... connected.\n",
-      "HTTP request sent, awaiting response... 303 See Other\n",
-      "Location: https://drive.usercontent.google.com/download?id=1tZJhcpepLRdQFJFCFX50QIqLyLgqzZsY&export=download [following]\n",
-      "--2024-03-13 13:57:19--  https://drive.usercontent.google.com/download?id=1tZJhcpepLRdQFJFCFX50QIqLyLgqzZsY&export=download\n",
-      "Reusing existing connection to drive.usercontent.google.com:443.\n",
-      "HTTP request sent, awaiting response... 200 OK\n",
-      "Length: 3041634 (2.9M) [application/octet-stream]\n",
-      "Saving to: ‘./manga.pdf’\n",
-      "\n",
-      "./manga.pdf         100%[===================>]   2.90M  --.-KB/s    in 0.04s   \n",
-      "\n",
-      "2024-03-13 13:57:20 (78.6 MB/s) - ‘./manga.pdf’ saved [3041634/3041634]\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "! wget \"https://drive.usercontent.google.com/uc?id=1tZJhcpepLRdQFJFCFX50QIqLyLgqzZsY&export=download\" -O ./manga.pdf"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Without parsing instructions\n",
-    "For the sake of comparison, let's first parse without any instructions."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 25bf4202-78d8-4705-88cf-c616ae7c82af\n"
-     ]
-    }
-   ],
-   "source": [
-    "vanilaParsing = LlamaParse(result_type=\"markdown\").load_data(\"./manga.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "As you can see below, LlamaParse is not doing a great job here. It is interpreting the grid of comic panels as a table, and trying to fit the dialogue into a table. It's very hard to follow."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "The Asagake Times Sanda-Cho Distributor\n",
-      "\n",
-      "A newspaper distributor? do I have the wrong map?\n",
-      "\n",
-      "You’re looking It’s next for the Sanda-cho door. branch office? Everybody mistakes us for the office because we are larger. What Is a Function? 3\n",
-      "---\n",
-      "## Calculating the Derivative of a Constant, Linear, or Quadratic Function\n",
-      "\n",
-      "|1.|Let’s find the derivative of constant function f(x) = α. The differential coefficient of f(x) at x = a is|\n",
-      "|---|---|\n",
-      "| |lim ε→0 (f(a + ε) - f(a)) / ε = lim ε→0 (α - α) = lim ε→0 0 = 0|\n",
-      "| |Thus, the derivative of f(x) is f′(x) = 0. This makes sense, since our function is constant—the rate of change is 0.|\n",
-      "\n",
-      "Note: The differential coefficient of f(x) at x = a is often simply called the derivative of f(x) at x = a, or just f′(a).\n",
-      "\n",
-      "|2.|Let’s calculate the derivative of linear function f(x) = αx + β. The derivative of f(x) at x = α is|\n",
-      "|---|---|\n",
-      "| |lim ε→0 (f(α + ε) - f(a)) = \n"
-     ]
-    }
-   ],
-   "source": [
-    "print(vanilaParsing[0].text[100:1000])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Using parsing instructions\n",
-    "Let's try to parse the manga with custom instructions:\n",
-    "\n",
-    "\"The provided document is a manga comic book. Most pages do NOT have a title. It does not contain tables. Try to reconstruct the dialogue spoken in a cohesive way.\"\n",
-    "\n",
-    "To do so just pass the parsing instruction as a parameter to LlamaParse:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 88ab273e-b2a7-4f84-8e72-e9367cf6b114\n",
-      "."
-     ]
-    }
-   ],
-   "source": [
-    "parsingInstructionManga = \"\"\"The provided document is a manga comic book. Most pages do NOT have a title.\n",
-    "It does not contain tables.\n",
-    "Try to reconstruct the dialogue spoken in a cohesive way.\"\"\"\n",
-    "withInstructionParsing = LlamaParse(\n",
-    "    result_type=\"markdown\", parsing_instruction=parsingInstructionManga\n",
-    ").load_data(\"./manga.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Let's see how it compare with page 3! We encourage you to play with the target page and explore other pages. As you will see, the parsing instruction allowed LlamaParse to make sense of the document!\n",
-    "\n",
-    "<img src=\"https://drive.usercontent.google.com/download?id=1M87rXTIZE8d5v7aHmVZVW6gW3eDGq6ks&authuser=0\" />\n",
-    "\n",
-    "\n",
-    "\n"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The Asagake Times Sanda-Cho Distributor\n",
-      "\n",
-      "A newspaper distributor? do I have the wrong map?\n",
-      "\n",
-      "You’re looking It’s next for the Sanda-cho door. branch office? Everybody mistakes us for the office because we are larger. What Is a Function? 3\n",
-      "\n",
-      "\n",
-      "------------------------------------------------------------\n",
-      "\n",
-      "\n",
-      "# The Asagake Times\n",
-      "\n",
-      "Sanda-Cho Distributor\n",
-      "\n",
-      "A newspaper distributor?\n",
-      "\n",
-      "Do I have the wrong map?\n",
-      "\n",
-      "You're looking for the Sanda-cho branch office?\n",
-      "\n",
-      "It's next door.\n",
-      "\n",
-      "Everybody mistakes us for the office because we are larger.\n",
-      "\n",
-      "What Is a Function? 3\n"
-     ]
-    }
-   ],
-   "source": [
-    "target_page = 1\n",
-    "print(vanilaParsing[0].text.split(\"\\n---\\n\")[target_page])\n",
-    "print(\"\\n\\n------------------------------------------------------------\\n\\n\")\n",
-    "print(withInstructionParsing[0].text.split(\"\\n---\\n\")[target_page])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Math - doing more with parsing instuction!\n",
-    "\n",
-    "But this manga is about math and full of equations, why not ask the parser to output them in **LaTeX**?\n",
-    "\n",
-    "<img src=\"https://drive.usercontent.google.com/download?id=1tze3xcQ7axVA-vC_iZeAj_GvYcyNuYDa&authuser=0\" />"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 3a055e64-d91e-484e-b9b0-99a2e637c08d\n",
-      "."
-     ]
-    }
-   ],
-   "source": [
-    "parsingInstructionMangaLatex = \"\"\"The provided document is a manga comic book. Most pages do NOT have a title.\n",
-    "It does not contain tables.\n",
-    "Try to reconstruct the dialogue spoken in a cohesive way.\n",
-    "Output any math equation in LATEX markdown (between $$)\"\"\"\n",
-    "withLatex = LlamaParse(\n",
-    "    result_type=\"markdown\", parsing_instruction=parsingInstructionMangaLatex\n",
-    ").load_data(\"./manga.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "\n",
-      "\n",
-      "[Without instruction]------------------------------------------------------------\n",
-      "\n",
-      "\n",
-      "## Calculating the Derivative of a Constant, Linear, or Quadratic Function\n",
-      "\n",
-      "|1.|Let’s find the derivative of constant function f(x) = α. The differential coefficient of f(x) at x = a is|\n",
-      "|---|---|\n",
-      "| |lim ε→0 (f(a + ε) - f(a)) / ε = lim ε→0 (α - α) = lim ε→0 0 = 0|\n",
-      "| |Thus, the derivative of f(x) is f′(x) = 0. This makes sense, since our function is constant—the rate of change is 0.|\n",
-      "\n",
-      "Note: The differential coefficient of f(x) at x = a is often simply called the derivative of f(x) at x = a, or just f′(a).\n",
-      "\n",
-      "|2.|Let’s calculate the derivative of linear function f(x) = αx + β. The derivative of f(x) at x = α is|\n",
-      "|---|---|\n",
-      "| |lim ε→0 (f(α + ε) - f(a)) = lim ε→0 (α(a + ε) + β - (αa + β)) = lim ε→0 α = α|\n",
-      "| |Thus, the derivative of f(x) is f′(x) = α, a constant value. This result should also be intuitive—linear functions have a constant rate of change by definition.|\n",
-      "\n",
-      "|3.|Let’s find the derivative of f(x) = x^2, which appeared in the story. The differential coefficient of f(x) at x = a is|\n",
-      "|---|---|\n",
-      "| |lim ε→0 ((a + ε)^2 - a^2) / ε = lim (a^2 + 2aε + ε^2 - a^2) / ε = lim (2aε + ε^2) = lim (2a + ε) = 2a|\n",
-      "| |Thus, the differential coefficient of f(x) at x = a is 2a, or f′(a) = 2a. Therefore, the derivative of f(x) is f′(x) = 2x.|\n",
-      "\n",
-      "## Summary\n",
-      "\n",
-      "- The calculation of a limit that appears in calculus is simply a formula calculating an error.\n",
-      "- A limit is used to obtain a derivative.\n",
-      "- The derivative is the slope of the tangent line at a given point.\n",
-      "- The derivative is nothing but the rate of change.\n",
-      "\n",
-      "## Chapter 1 Let’s Differentiate a Function!\n",
-      "\n",
-      "\n",
-      "[With instruction to output math in LATEX!]------------------------------------------------------------\n",
-      "\n",
-      "\n",
-      "# Derivative of Constant, Linear, or Quadratic Function\n",
-      "\n",
-      "## Calculating the Derivative of a Constant, Linear, or Quadratic Function\n",
-      "\n",
-      "1. Let’s find the derivative of constant function f(x) = α. The differential coefficient of f(x) at x = a is\n",
-      "\n",
-      "$$\n",
-      "\\begin{align*}\n",
-      "&\\lim_{{\\varepsilon \\to 0}} \\left( \\frac{f(a + \\varepsilon) - f(a)}{\\varepsilon} \\right) = \\lim_{{\\varepsilon \\to 0}} \\frac{\\alpha - \\alpha}{\\varepsilon} = \\lim_{{\\varepsilon \\to 0}} 0 = 0 \\\\\n",
-      "\\end{align*}\n",
-      "$$\n",
-      "Thus, the derivative of f(x) is f′(x) = 0. This makes sense, since our function is constant—the rate of change is 0.\n",
-      "\n",
-      "Note: The differential coefficient of f(x) at x = a is often simply called the derivative of f(x) at x = a, or just f′(a).\n",
-      "\n",
-      "2. Let’s calculate the derivative of linear function f(x) = αx + β. The derivative of f(x) at x = α is\n",
-      "\n",
-      "$$\n",
-      "\\begin{align*}\n",
-      "&\\lim_{{\\varepsilon \\to 0}} \\left( \\frac{f(\\alpha + \\varepsilon) - f(a)}{\\varepsilon} \\right) = \\lim_{{\\varepsilon \\to 0}} \\frac{\\alpha(a + \\varepsilon) + \\beta - (\\alpha a + \\beta)}{\\varepsilon} = \\lim_{{\\varepsilon \\to 0}} \\alpha = \\alpha \\\\\n",
-      "\\end{align*}\n",
-      "$$\n",
-      "Thus, the derivative of f(x) is f′(x) = α, a constant value. This result should also be intuitive—linear functions have a constant rate of change by definition.\n",
-      "\n",
-      "3. Let’s find the derivative of f(x) = x2. The differential coefficient of f(x) at x = a is\n",
-      "\n",
-      "$$\n",
-      "\\begin{align*}\n",
-      "&\\lim_{{\\varepsilon \\to 0}} \\left( \\frac{f(a + \\varepsilon) - f(a)}{\\varepsilon} \\right) = \\lim_{{\\varepsilon \\to 0}} \\left( (a + \\varepsilon)^2 - a^2 \\right) = \\lim_{{\\varepsilon \\to 0}} 2a\\varepsilon + \\varepsilon = \\lim_{{\\varepsilon \\to 0}} (2a + \\varepsilon) = 2a \\\\\n",
-      "\\end{align*}\n",
-      "$$\n",
-      "Thus, the differential coefficient of f(x) at x = a is 2a, or f′(a) = 2a. Therefore, the derivative of f(x) is f′(x) = 2x.\n",
-      "\n",
-      "### Summary\n",
-      "\n",
-      "- The calculation of a limit that appears in calculus is simply a formula calculating an error.\n",
-      "- A limit is used to obtain a derivative.\n",
-      "- The derivative is the slope of the tangent line at a given point.\n",
-      "- The derivative is nothing but the rate of change.\n"
-     ]
-    }
-   ],
-   "source": [
-    "target_page = 2\n",
-    "print(\n",
-    "    \"\\n\\n[Without instruction]------------------------------------------------------------\\n\\n\"\n",
-    ")\n",
-    "print(vanilaParsing[0].text.split(\"\\n---\\n\")[target_page])\n",
-    "print(\n",
-    "    \"\\n\\n[With instruction to output math in LATEX!]------------------------------------------------------------\\n\\n\"\n",
-    ")\n",
-    "print(withLatex[0].text.split(\"\\n---\\n\")[target_page])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "And here is the result as rendered by https://upmath.me/ .\n",
-    "\n",
-    "\n",
-    "<img src=\"https://drive.usercontent.google.com/download?id=1qGo5bMGYOiIC9MnprcgEByaYjU9YII2Q&authuser=0\" />\n",
-    "\n",
-    "\n",
-    "Over this short notebook we saw how to use parsing instructions to increase the quality and accuracy of parsing with LLamaParse!"
-   ]
-  }
- ],
- "metadata": {
-  "colab": {
-   "provenance": []
-  },
-  "kernelspec": {
-   "display_name": "Python 3",
-   "name": "python3"
-  },
-  "language_info": {
-   "name": "python"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 0
-}

examples/demo_table_comparisons.ipynb

@@ -1,367 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# RAG for Table Comparisons with LlamaParse + LlamaIndex\n",
-    "\n",
-    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/demo_table_comparisons.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
-    "\n",
-    "This notebook shows you how to do comparisons across both tabular and text data across multiple PDF documents.\n",
-    "\n",
-    "We load in multiple PDFs with embedded tables (2021 and 2020 10K filings for Apple) using LlamaParse, parse each into a hierarchy of tables/text objects, define a recursive retriever over each, and then compose both with a SubQuestionQueryEngine."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Setup\n",
-    "\n",
-    "Install core packages, download files, parse documents."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%pip install llama-index\n",
-    "%pip install llama-index-core\n",
-    "%pip install llama-index-embeddings-openai\n",
-    "%pip install llama-index-question-gen-openai\n",
-    "%pip install llama-index-postprocessor-flag-embedding-reranker\n",
-    "%pip install git+https://github.com/FlagOpen/FlagEmbedding.git\n",
-    "%pip install llama-parse"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!wget \"https://s2.q4cdn.com/470004039/files/doc_financials/2020/ar/_10-K-2020-(As-Filed).pdf\" -O apple_2020_10k.pdf\n",
-    "!wget \"https://s2.q4cdn.com/470004039/files/doc_financials/2021/q4/_10-K-2021-(As-Filed).pdf\" -O apple_2021_10k.pdf"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Some OpenAI and LlamaParse details"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# llama-parse is async-first, running the async code in a notebook requires the use of nest_asyncio\n",
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()\n",
-    "\n",
-    "import os\n",
-    "\n",
-    "# API access to llama-cloud\n",
-    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"llx-\"\n",
-    "\n",
-    "# Using OpenAI API for embeddings/llms\n",
-    "os.environ[\"OPENAI_API_KEY\"] = \"sk-\""
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.llms.openai import OpenAI\n",
-    "from llama_index.embeddings.openai import OpenAIEmbedding\n",
-    "from llama_index.core import VectorStoreIndex\n",
-    "from llama_index.core import Settings\n",
-    "\n",
-    "embed_model = OpenAIEmbedding(model=\"text-embedding-3-small\")\n",
-    "llm = OpenAI(model=\"gpt-3.5-turbo-0125\")\n",
-    "\n",
-    "Settings.llm = llm\n",
-    "Settings.embed_model = embed_model"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Using brand new `LlamaParse` PDF reader for PDF Parsing\n",
-    "\n",
-    "we also compare two different retrieval/query engine strategies:\n",
-    "1. Using raw Markdown text as nodes for building index and apply simple query engine for generating the results;\n",
-    "2. Using `MarkdownElementNodeParser` for parsing the `LlamaParse` output Markdown results and building recursive retriever query engine for generation."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "docs_2021 = LlamaParse(result_type=\"markdown\").load_data(\"./apple_2021_10k.pdf\")\n",
-    "docs_2020 = LlamaParse(result_type=\"markdown\").load_data(\"./apple_2020_10k.pdf\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Create Recursive Retriever over each Document\n",
-    "\n",
-    "We define a function to get a recursive retriever from each document. The steps are the following:\n",
-    "- Hierarchically parse the document using our `MarkdownElementNodeParser`, which will embed/summarize embedded tables.\n",
-    "- Load into a vector store. Under the hood we will automatically store links between nodes (e.g. table summary to table text).\n",
-    "- Get a query engine over the vector store, which performs retrieval/synthesis. Under the hood we will automatically perform recursive retrieval if there are links."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.node_parser import MarkdownElementNodeParser\n",
-    "\n",
-    "node_parser = MarkdownElementNodeParser(\n",
-    "    llm=OpenAI(model=\"gpt-3.5-turbo-0125\"), num_workers=8\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import pickle\n",
-    "from llama_index.postprocessor.flag_embedding_reranker import (\n",
-    "    FlagEmbeddingReranker,\n",
-    ")\n",
-    "\n",
-    "reranker = FlagEmbeddingReranker(\n",
-    "    top_n=5,\n",
-    "    model=\"BAAI/bge-reranker-large\",\n",
-    ")\n",
-    "\n",
-    "\n",
-    "def create_query_engine_over_doc(docs, nodes_save_path=None):\n",
-    "    \"\"\"Big function to go from document path -> recursive retriever.\"\"\"\n",
-    "    if nodes_save_path is not None and os.path.exists(nodes_save_path):\n",
-    "        raw_nodes = pickle.load(open(nodes_save_path, \"rb\"))\n",
-    "    else:\n",
-    "        raw_nodes = node_parser.get_nodes_from_documents(docs)\n",
-    "        if nodes_save_path is not None:\n",
-    "            pickle.dump(raw_nodes, open(nodes_save_path, \"wb\"))\n",
-    "\n",
-    "    base_nodes, objects = node_parser.get_nodes_and_objects(raw_nodes)\n",
-    "\n",
-    "    ### Construct Retrievers\n",
-    "    # construct top-level vector index + query engine\n",
-    "    vector_index = VectorStoreIndex(nodes=base_nodes + objects)\n",
-    "    query_engine = vector_index.as_query_engine(\n",
-    "        similarity_top_k=15, node_postprocessors=[reranker]\n",
-    "    )\n",
-    "    return query_engine, base_nodes"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query_engine_2021, nodes_2021 = create_query_engine_over_doc(\n",
-    "    docs_2021, nodes_save_path=\"2021_nodes.pkl\"\n",
-    ")\n",
-    "query_engine_2020, nodes_2020 = create_query_engine_over_doc(\n",
-    "    docs_2020, nodes_save_path=\"2020_nodes.pkl\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.tools import QueryEngineTool, ToolMetadata\n",
-    "from llama_index.core.query_engine import SubQuestionQueryEngine\n",
-    "\n",
-    "\n",
-    "# setup base query engine as tool\n",
-    "query_engine_tools = [\n",
-    "    QueryEngineTool(\n",
-    "        query_engine=query_engine_2021,\n",
-    "        metadata=ToolMetadata(\n",
-    "            name=\"apple_2021_10k\",\n",
-    "            description=(\"Provides information about Apple financials for year 2021\"),\n",
-    "        ),\n",
-    "    ),\n",
-    "    QueryEngineTool(\n",
-    "        query_engine=query_engine_2020,\n",
-    "        metadata=ToolMetadata(\n",
-    "            name=\"apple_2020_10k\",\n",
-    "            description=(\"Provides information about Apple financials for year 2020\"),\n",
-    "        ),\n",
-    "    ),\n",
-    "]\n",
-    "\n",
-    "sub_query_engine = SubQuestionQueryEngine.from_defaults(\n",
-    "    query_engine_tools=query_engine_tools,\n",
-    "    llm=llm,\n",
-    "    use_async=True,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Try out Some Comparisons"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Generated 4 sub questions.\n",
-      "\u001b[1;3;38;2;237;90;200m[apple_2021_10k] Q: What are the deferred assets in 2021?\n",
-      "\u001b[0m\u001b[1;3;38;2;90;149;237m[apple_2021_10k] Q: What are the deferred liabilities in 2021?\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203m[apple_2020_10k] Q: What are the deferred assets in 2020?\n",
-      "\u001b[0m\u001b[1;3;38;2;155;135;227m[apple_2020_10k] Q: What are the deferred liabilities in 2020?\n",
-      "\u001b[0m\u001b[1;3;38;2;90;149;237m[apple_2021_10k] A: $7,200\n",
-      "\u001b[0m\u001b[1;3;38;2;155;135;227m[apple_2020_10k] A: $10,138\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200m[apple_2021_10k] A: $25,176 million\n",
-      "\u001b[0m\u001b[1;3;38;2;11;159;203m[apple_2020_10k] A: $19,336\n",
-      "\u001b[0m"
-     ]
-    }
-   ],
-   "source": [
-    "response = sub_query_engine.query(\n",
-    "    \"Can you compare and contrast the deferred assets and liabilities in 2021 with 2020?\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "In 2021, the deferred assets increased by $5,840 million compared to 2020, while the deferred liabilities decreased by $2,938 million in the same period.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(str(response))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Generated 2 sub questions.\n",
-      "\u001b[1;3;38;2;237;90;200m[apple_2021_10k] Q: What is the total number of RSUs in Apple's 2021 financials?\n",
-      "\u001b[0m\u001b[1;3;38;2;90;149;237m[apple_2020_10k] Q: What is the total number of RSUs in Apple's 2020 financials?\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200m[apple_2021_10k] A: The total number of RSUs in Apple's 2021 financials is 240,427.\n",
-      "\u001b[0m\u001b[1;3;38;2;90;149;237m[apple_2020_10k] A: The total number of RSUs in Apple's 2020 financials is 310,778.\n",
-      "\u001b[0m"
-     ]
-    }
-   ],
-   "source": [
-    "response = sub_query_engine.query(\n",
-    "    \"Can you compare and contrast the total number of RSUs in 2021 and 2020?\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Generated 2 sub questions.\n",
-      "\u001b[1;3;38;2;237;90;200m[apple_2021_10k] Q: What are the risk factors mentioned in the 2021 financial report of Apple?\n",
-      "\u001b[0m\u001b[1;3;38;2;90;149;237m[apple_2020_10k] Q: What are the risk factors mentioned in the 2020 financial report of Apple?\n",
-      "\u001b[0m\u001b[1;3;38;2;237;90;200m[apple_2021_10k] A: The risk factors mentioned in the 2021 financial report of Apple include risks related to COVID-19, macroeconomic and industry risks, political events, trade and international disputes, natural disasters, public health issues, industrial accidents, credit risk, fluctuations in foreign currency exchange rates, changes in tax rates and legislation, volatility in the price of the company's stock, and exposure to legal proceedings and claims.\n",
-      "\u001b[0m\u001b[1;3;38;2;90;149;237m[apple_2020_10k] A: The risk factors mentioned in the 2020 financial report of Apple include the impact of the COVID-19 pandemic on the company's business operations, financial condition, and stock price; global and regional economic conditions affecting demand for products and services; competition in global markets with rapid technological changes; potential disruptions in the supply chain due to industrial accidents or public health issues; information technology system failures or network disruptions affecting business operations; risks associated with confidential information security and potential unauthorized access; fluctuations in quarterly net sales and operating results due to various factors; stock price volatility impacting investor confidence and employee retention; financial performance risks related to changes in foreign currency exchange rates affecting sales and earnings.\n",
-      "\u001b[0m"
-     ]
-    }
-   ],
-   "source": [
-    "response = sub_query_engine.query(\n",
-    "    \"Can you compare and contrast the risk factors in 2021 vs. 2020?\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The risk factors mentioned in the 2021 financial report of Apple include risks related to COVID-19, macroeconomic and industry risks, political events, trade and international disputes, natural disasters, public health issues, industrial accidents, credit risk, fluctuations in foreign currency exchange rates, changes in tax rates and legislation, volatility in the price of the company's stock, and exposure to legal proceedings and claims. In contrast, the risk factors mentioned in the 2020 financial report of Apple focused more on the impact of the COVID-19 pandemic on the company's business operations, financial condition, and stock price; global and regional economic conditions affecting demand for products and services; competition in global markets with rapid technological changes; potential disruptions in the supply chain due to industrial accidents or public health issues; information technology system failures or network disruptions affecting business operations; risks associated with confidential information security and potential unauthorized access; fluctuations in quarterly net sales and operating results due to various factors; stock price volatility impacting investor confidence and employee retention; financial performance risks related to changes in foreign currency exchange rates affecting sales and earnings.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(str(response))"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama_parse",
-   "language": "python",
-   "name": "llama_parse"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

examples/excel/dcf_rag.ipynb

@@ -1,493 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "0db58db5-d4ee-4631-af5b-4fc53eb05170",
-   "metadata": {},
-   "source": [
-    "# RAG with Excel Spreadsheet using LlamaPrase\n",
-    "\n",
-    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/demo_excel.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
-    "\n",
-    "This notebook constructs a RAG pipeline over a simple DCF template [here](https://eqvista.com/app/uploads/2020/09/Eqvista_DCF-Excel-Template.xlsx).\n",
-    "\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "5f7d99ad-6ebd-47d0-92a7-566630b0c22a",
-   "metadata": {},
-   "source": [
-    "## Setup\n",
-    "\n",
-    "We first setup and load the data. If you haven't already, [download the template](https://eqvista.com/app/uploads/2020/09/Eqvista_DCF-Excel-Template.xlsx) and name it `dcf_template.xlxs` locally."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d867d1a6-cfcf-4f53-952a-f4a6ff2fa205",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%pip install llama-index\n",
-    "%pip install llama-parse"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "103c7983-56d3-45be-b763-d1828d07c43e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7b694b56-e04b-4d87-aa37-f0725d6b3adb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "# api_key = \"llx-\"  # get from cloud.llamaindex.ai"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "9c4693c7-c1c8-47b4-8a8c-25d7e9ef9d2c",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id cac11eca-d5da-4d46-90e6-321f40e11611\n",
-      "Started parsing the file under job_id cac11eca-5450-4847-9da0-fa6879c4cf3a\n"
-     ]
-    }
-   ],
-   "source": [
-    "parser = LlamaParse(\n",
-    "    # api_key=api_key,  # can also be set in your env as LLAMA_CLOUD_API_KEY\n",
-    "    result_type=\"markdown\",\n",
-    ")\n",
-    "docs = parser.load_data(\"./dcf_template.xlsx\")\n",
-    "# docs_txt = LlamaParse(result_type=\"text\").load_data(\"./dcf_template.xlsx\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7302f1c8-e405-4cda-8ff7-1d55185816f7",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "# Cover Page\n",
-      "\n",
-      "|Thank you for downloading our DCF Model excel template. This DCF Model excel template helps you to value your business using Discounted Free Cash Flow or DCF Method. |                                                                                                                                                                                  |\n",
-      "|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n",
-      "|                                                                                                                                                                      |                                                                                                                                                                                  |\n",
-      "|                                                                                                                                                                      |Eqvista is an equity management software that allows companies, investors and company shareholders to track, manage, and make intelligent decisions about their companies’ equity.|\n",
-      "|                                                                                                                                                                      |                                                                                                                                                                                  |\n",
-      "|                                                                                                                                                                      |GET STARTED- IT'S FREE                                                                                                                                                            |\n",
-      "|                                                                                                                                                                      |                                                                                                                                                                                  |\n",
-      "|                                                                                                                                                                      |Note: This template is not professional advice and not a substitute for professional advice.                                                                                      |\n",
-      "|Accordingly, before taking any actions based upon such information, we encourage you to consult with the appropriate professionals.                                   |                                                                                                                                                                                  |\n",
-      "|                                                                                                                                                                      |                                                                                                                                                                                  |\n",
-      "|                                                                                                                                                                      |@Eqvista Inc. All Rights Reserved                                                                                                                                                 |\n",
-      "---\n",
-      "# DCF Model\n",
-      "\n",
-      "|Discounted Cash Flow Excel Template                                                                                                                                                        |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|-----------|-----------|-----------------------|-----------|-----------------------|--------------|-----------|-----------|-----------|--------------|\n",
-      "|                                                                                                                                                                                           |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|Here is a simple discounted cash flow excel template for estimating your company value based on this income valuation approach                                                             |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|Instructions:                                                                                                                                                                              |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|1) Fill out the two assumptions in yellow highlight                                                                                                                                        |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|2) Fill in either the 5 year or 3 year weighted average figures in yellow highlight                                                                                                        |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|Assumptions                                                                                                                                                                                |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|Tax Rate                                                                                                                                                                                   |20%                           |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|Discount Rate                                                                                                                                                                              |15%                           |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|5 Year Weighted Moving Average                                                                                                                                                             |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|Indication of Company Value                                                                                                                                                                |$242,995.43                   |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|3 Year Weighted Moving Average                                                                                                                                                             |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|Indication of Company Value                                                                                                                                                                |$158,651.07                   |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |5 Year Weighted Moving Average|           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |Past Years                    |           |           |                       |           |Forecasted Future Years|              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |Year 1                        |Year 2     |Year 3     |Year 4                 |Year 5     |Year 6                 |Year 7        |Year 8     |Year 9     |Year 10    |Terminal Value|\n",
-      "|Pre-tax income                                                                                                                                                                             |50,000.00                     |55,000.00  |45,000.00  |52,000.00              |60,000.00  |                       |              |           |           |           |              |\n",
-      "|Income Taxes                                                                                                                                                                               |10,000.00                     |11,000.00  |9,000.00   |10,400.00              |12,000.00  |                       |              |           |           |           |              |\n",
-      "|Net Income                                                                                                                                                                                 |40,000.00                     |44,000.00  |36,000.00  |41,600.00              |48,000.00  |                       |              |           |           |           |              |\n",
-      "|Depreciation Expense                                                                                                                                                                       |5,000.00                      |4,000.00   |3,000.00   |2,000.00               |1,000.00   |                       |              |           |           |           |              |\n",
-      "|Capital Expenditures                                                                                                                                                                       |10,000.00                     |8,000.00   |5,000.00   |5,000.00               |7,000.00   |                       |              |           |           |           |              |\n",
-      "|Debt Repayments                                                                                                                                                                            |5,000.00                      |5,000.00   |5,000.00   |5,000.00               |5,000.00   |                       |              |           |           |           |              |\n",
-      "|Net Cash Flow                                                                                                                                                                              |20,000.00                     |27,000.00  |23,000.00  |29,600.00              |35,000.00  |29,093.33              |29,817.78     |30,177.48  |30,469.23  |30,379.74  |287,188.00    |\n",
-      "|Discounting Factor                                                                                                                                                                         |                              |           |           |                       |           |0.8696                 |0.7561        |0.6575     |0.5718     |0.4972     |0.4972        |\n",
-      "|Present Value of Future Cash Flow                                                                                                                                                          |                              |           |           |                       |           |25,298.55              |22,546.52     |19,842.18  |17,420.88  |15,104.10  |142,783.19    |\n",
-      "|                                                                                                                                                                                           |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |3 Year Weighted Moving Average|           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |Past Years                    |           |           |Forecasted Future Years|           |                       |              |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |Year 1                        |Year 2     |Year 3     |Year 4                 |Year 5     |Year 6                 |Terminal Value|           |           |           |              |\n",
-      "|Pre-tax income                                                                                                                                                                             |50,000.00                     |55,000.00  |45,000.00  |                       |           |                       |              |           |           |           |              |\n",
-      "|Income Taxes                                                                                                                                                                               |10,000.00                     |11,000.00  |9,000.00   |                       |           |                       |              |           |           |           |              |\n",
-      "|Net Income                                                                                                                                                                                 |40,000.00                     |44,000.00  |36,000.00  |                       |           |                       |              |           |           |           |              |\n",
-      "|Depreciation Expense                                                                                                                                                                       |5,000.00                      |4,000.00   |3,000.00   |                       |           |                       |              |           |           |           |              |\n",
-      "|Capital Expenditures                                                                                                                                                                       |10,000.00                     |8,000.00   |5,000.00   |                       |           |                       |              |           |           |           |              |\n",
-      "|Debt Repayments                                                                                                                                                                            |5,000.00                      |5,000.00   |5,000.00   |                       |           |                       |              |           |           |           |              |\n",
-      "|Net Cash Flow                                                                                                                                                                              |20,000.00                     |27,000.00  |23,000.00  |23,833.33              |24,083.33  |23,819.44              |158,253.59    |           |           |           |              |\n",
-      "|Discounting Factor                                                                                                                                                                         |                              |           |           |0.8696                 |0.7561     |0.6575                 |0.6575        |           |           |           |              |\n",
-      "|Present Value of Future Cash Flow                                                                                                                                                          |                              |           |           |20,724.64              |18,210.46  |15,661.67              |104,054.30    |           |           |           |              |\n",
-      "|                                                                                                                                                                                           |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|Notes:                                                                                                                                                                                     |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|-We based this simple discounted cash flow excel model based on the weighted moving averages (5 year or 3 year) for simplicity, in case a constant growth rate cannot be easily determined.|                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|-The factors such as Depreciation Expense, Capital Expense and Debt Repayments remain constant, so consider this when looking at the forecasted figures.                                   |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "|-For the terminal value constant growth rate, we make the assumption of the growth from the last forecasted year compared to the first forecasted year. Adjust in the formula as needed.   |                              |           |           |                       |           |                       |              |           |           |           |              |\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(docs[0].get_content())"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1aedd4bb-7939-4fbc-8f07-d362e24d9772",
-   "metadata": {},
-   "source": [
-    "## Configure LLM, Setup Basic Summary Engine\n",
-    "\n",
-    "We setup a basic summary engine which retrieves the entire document as context to put into the prompt."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "f7c056a8-d098-4ebe-9341-d9f07081067c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.llms.openai import OpenAI\n",
-    "from llama_index.core import Settings\n",
-    "\n",
-    "llm = OpenAI(model=\"gpt-4-turbo-preview\")\n",
-    "Settings.llm = llm"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "c0fa2630-ee1b-4ce7-91e9-f9ffff8347f9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import SummaryIndex\n",
-    "\n",
-    "index = SummaryIndex.from_documents(docs)\n",
-    "# index = SummaryIndex.from_documents(docs_txt)\n",
-    "\n",
-    "query_engine = index.as_query_engine()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1d39a075-46b8-4dcb-8aee-abd10343bedd",
-   "metadata": {},
-   "source": [
-    "## Define Baseline\n",
-    "\n",
-    "Let's define a baseline query engine over this data, using a naive parser (our PandasExcelReader, available on LlamaHub)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "632f918e-7811-4931-8a5f-4aa4850718db",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Collecting openpyxl\n",
-      "  Downloading openpyxl-3.1.3-py2.py3-none-any.whl (251 kB)\n",
-      "\u001b[2K     \u001b[38;2;114;156;31m━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\u001b[0m \u001b[32m251.3/251.3 kB\u001b[0m \u001b[31m5.0 MB/s\u001b[0m eta \u001b[36m0:00:00\u001b[0m MB/s\u001b[0m eta \u001b[36m0:00:01\u001b[0m\n",
-      "\u001b[?25hCollecting et-xmlfile\n",
-      "  Using cached et_xmlfile-1.1.0-py3-none-any.whl (4.7 kB)\n",
-      "Installing collected packages: et-xmlfile, openpyxl\n",
-      "Successfully installed et-xmlfile-1.1.0 openpyxl-3.1.3\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 available: \u001b[0m\u001b[31;49m22.2.2\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"
-     ]
-    }
-   ],
-   "source": [
-    "!pip install llama-index-readers-file\n",
-    "!pip install openpyxl"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "85ff09fd-8a99-4aa4-8182-8d0cf30f7b85",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.readers.file import PandasExcelReader\n",
-    "import importlib\n",
-    "from pathlib import Path\n",
-    "\n",
-    "base_reader = PandasExcelReader()\n",
-    "base_docs = base_reader.load_data(Path(\"dcf_template.xlsx\"))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ba45f806-58be-4f57-bf42-2721555136cb",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Discounted Cash Flow Excel Template           \n",
-      "           \n",
-      "Here is a simple discounted cash flow excel template for estimating your company value based on this income valuation approach           \n",
-      "           \n",
-      "Instructions:           \n",
-      "1) Fill out the two assumptions in yellow highlight           \n",
-      "2) Fill in either the 5 year or 3 year weighted average figures in yellow highlight           \n",
-      "           \n",
-      "           \n",
-      "           \n",
-      "           \n",
-      "Assumptions           \n",
-      "Tax Rate 0.2          \n",
-      "Discount Rate 0.15          \n",
-      "           \n",
-      "5 Year Weighted Moving Average           \n",
-      "Indication of Company Value 242995.4347636059          \n",
-      "           \n",
-      "3 Year Weighted Moving Average           \n",
-      "Indication of Company Value 158651.0723286644          \n",
-      "           \n",
-      " 5 Year Weighted Moving Average          \n",
-      " Past Years     Forecasted Future Years     \n",
-      " Year 1 Year 2 Year 3 Year 4 Year 5 Year 6 Year 7 Year 8 Year 9 Year 10 Terminal Value\n",
-      "Pre-tax income 50000 55000 45000 52000 60000      \n",
-      "Income Taxes 10000 11000 9000 10400 12000      \n",
-      "Net Income 40000 44000 36000 41600 48000      \n",
-      "Depreciation Expense 5000 4000 3000 2000 1000      \n",
-      "Capital Expenditures 10000 8000 5000 5000 7000      \n",
-      "Debt Repayments 5000 5000 5000 5000 5000      \n",
-      "Net Cash Flow 20000 27000 23000 29600 35000 29093.333333333332 29817.777777777774 30177.481481481478 30469.234567901232 30379.73991769547 287188.0007003137\n",
-      "Discounting Factor      0.8695652173913044 0.7561436672967865 0.6575162324319883 0.5717532455930334 0.4971767352982899 0.4971767352982899\n",
-      "Present Value of Future Cash Flow      25298.550724637684 22546.523839529513 19842.183927989798 17420.883754932976 15104.099911490972 142783.19260502496\n",
-      "           \n",
-      "           \n",
-      " 3 Year Weighted Moving Average          \n",
-      " Past Years   Forecasted Future Years       \n",
-      " Year 1 Year 2 Year 3 Year 4 Year 5 Year 6 Terminal Value    \n",
-      "Pre-tax income 50000 55000 45000        \n",
-      "Income Taxes 10000 11000 9000        \n",
-      "Net Income 40000 44000 36000        \n",
-      "Depreciation Expense 5000 4000 3000        \n",
-      "Capital Expenditures 10000 8000 5000        \n",
-      "Debt Repayments 5000 5000 5000        \n",
-      "Net Cash Flow 20000 27000 23000 23833.333333333332 24083.333333333332 23819.44444444444 158253.58851674633    \n",
-      "Discounting Factor    0.8695652173913044 0.7561436672967865 0.6575162324319883 0.6575162324319883    \n",
-      "Present Value of Future Cash Flow    20724.63768115942 18210.459987397608 15661.671369734164 104054.30329037321    \n",
-      "           \n",
-      "           \n",
-      "Notes:           \n",
-      "-We based this simple discounted cash flow excel model based on the weighted moving averages (5 year or 3 year) for simplicity, in case a constant growth rate cannot be easily determined.           \n",
-      "-The factors such as Depreciation Expense, Capital Expense and Debt Repayments remain constant, so consider this when looking at the forecasted figures.           \n",
-      "-For the terminal value constant growth rate, we make the assumption of the growth from the last forecasted year compared to the first forecasted year. Adjust in the formula as needed.           \n"
-     ]
-    }
-   ],
-   "source": [
-    "print(base_docs[1].get_content())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ff6e812f-fa94-4b0f-8907-ee70983e53f1",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import SummaryIndex\n",
-    "\n",
-    "base_index = SummaryIndex.from_documents([base_docs[1]])\n",
-    "\n",
-    "base_query_engine = base_index.as_query_engine()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fa75f1bc-6fed-4721-ba5e-dc5408395618",
-   "metadata": {},
-   "source": [
-    "## Ask Questions over this Data\n",
-    "\n",
-    "Let's now ask questions over this data, using both the LlamaParse-powered pipeline and naive pipeline."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "a875a20e-a6b6-46b7-80d4-614546215ffc",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query_str = \"Tell me about the income taxes in the past years (year 3-5) for the 5 year WMA table\"\n",
-    "response = query_engine.query(query_str)\n",
-    "base_response = base_query_engine.query(query_str)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "06b0b072-f159-47c4-9cad-9f0cc0d56b28",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "******* LlamaParse RAG *******\n",
-      "The income taxes in the past years (year 3 to 5) for the 5-year Weighted Moving Average table were $9,000.00 in Year 3, $10,400.00 in Year 4, and $12,000.00 in Year 5.\n",
-      "******* Naive RAG *******\n",
-      "The income taxes in the past years (year 3-5) for the 5 year WMA table were $9,000, $10,400, and $12,000, respectively.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(\"******* LlamaParse RAG *******\")\n",
-    "print(str(response))\n",
-    "print(\"******* Naive RAG *******\")\n",
-    "print(str(base_response))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "8bd0998f-4f7f-46f9-9b51-cfb510f384ee",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "print(response.source_nodes[0].get_content())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7a93af5f-fcea-4f14-80eb-5dfad230cd8a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query_str = \"Tell me about the discounting factors in year 5 for the 3 year WMA\"\n",
-    "response = query_engine.query(query_str)\n",
-    "base_response = base_query_engine.query(query_str)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "c6d3a5fb-c32c-4dea-8f2e-956af85456a4",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "******* LlamaParse RAG *******\n",
-      "The discounting factor in year 5 for the 3-year Weighted Moving Average (WMA) is 0.7561.\n",
-      "******* Naive RAG *******\n",
-      "The discounting factor in year 5 for the 3-year Weighted Moving Average is 0.6575162324319883.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(\"******* LlamaParse RAG *******\")\n",
-    "print(str(response))\n",
-    "print(\"******* Naive RAG *******\")\n",
-    "print(str(base_response))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "b96f3a9b-6e99-4192-b6d6-447319d3c4fa",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query_str = \"Tell me about the projected net cash flow in years 7-9 for the 5 year WMA\"\n",
-    "response = query_engine.query(query_str)\n",
-    "base_response = base_query_engine.query(query_str)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "92b419b9-25ee-4d69-98d9-56c0a45b24af",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "******* LlamaParse RAG *******\n",
-      "The projected net cash flow for years 7 to 9 in the 5-year Weighted Moving Average scenario is as follows: Year 7 is $29,817.78, Year 8 is $30,177.48, and Year 9 is $30,469.23.\n",
-      "******* Naive RAG *******\n",
-      "The projected net cash flow for years 7 to 9 in the 5-year weighted moving average scenario is as follows: Year 7 is $29,093.33, Year 8 is $29,817.78, and Year 9 is $30,177.48.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(\"******* LlamaParse RAG *******\")\n",
-    "print(str(response))\n",
-    "print(\"******* Naive RAG *******\")\n",
-    "print(str(base_response))"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama_parse",
-   "language": "python",
-   "name": "llama_parse"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

examples/extract/data/automotive_sector_analysis/modeling_assumptions.txt

@@ -0,0 +1,10 @@
+# Financial Modeling Assumptions
+Discount Rate: 8%
+Terminal Growth Rate: 2%
+Tax Rate: 25%
+Revenue Growth (Years 1-5): 10% per annum
+Revenue Growth (Years 6-10): 5% per annum
+Capital Expenditures as % of Revenue: 7%
+Working Capital Assumption: 3% of Revenue
+Depreciation Rate: 10% per annum
+Cost of Capital Assumption: 8%

examples/extract/data/insider_transactions/.gitignore

@@ -0,0 +1 @@
+sec_form_4_dump.json

examples/extract/extract_data_with_citations.ipynb

@@ -0,0 +1,440 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Extract Data from Financial Reports - with Citations and Reasoning\n",
+    "\n",
+    "Given complex files like financial reports, contracts, invoices etc, Llama Extract allows you to make use of an LLM to extract the information relevant to you, in a structured format.\n",
+    "\n",
+    "In this example, we'll be using [LlamaExtract](https://docs.cloud.llamaindex.ai/llamaextract/getting_started?utm_campaign=extract&utm_medium=recipe) to extract structured data from an SEC filing (specifically, the filing by Nvidia for fiscal year 2025).\n",
+    "\n",
+    "On top of simple data extraction, we'll ask our extraction agent to provide citations and reasoning for each extracted field. This allows us to:\n",
+    "- Confirm  the accuracy of the extracted field\n",
+    "- Understand the reasoning behind why the LLM extracted a given piece of information\n",
+    "- This last point allows us an opportunity to adjust the system prompt or field descriptions and improve on results where needed.\n",
+    "\n",
+    "\n",
+    "The example we go through below is also replicable within Llama Cloud as well, where you will also be able to pick between a number of pre-defined schemas, instead of building your own."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!pip install llama-cloud-services"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Connect to Llama Cloud\n",
+    "\n",
+    "To get started, make sure you provide your [Llama Cloud](https://cloud.llamaindex.ai?utm_campaign=extract&utm_medium=recipe) API key."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Enter your Llama Cloud API Key: ··········\n"
+     ]
+    }
+   ],
+   "source": [
+    "import os\n",
+    "from getpass import getpass\n",
+    "\n",
+    "if \"LLAMA_CLOUD_API_KEY\" not in os.environ:\n",
+    "    os.environ[\"LLAMA_CLOUD_API_KEY\"] = getpass(\"Enter your Llama Cloud API Key: \")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Extract Data with Llama Extract Agent"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "No project_id provided, fetching default project.\n"
+     ]
+    }
+   ],
+   "source": [
+    "from llama_cloud_services import LlamaExtract\n",
+    "\n",
+    "# Optionally, provide your project id, if not, it will use the 'Default' project\n",
+    "llama_extract = LlamaExtract()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Provide Your Custom Schema\n",
+    "\n",
+    "When using LlamaExtract via the API, you provide your own schema that describes what you want extracted from files and data provided to your agent. Here, we are essentially building an SEC filings extraction agent."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pydantic import BaseModel, Field\n",
+    "from enum import Enum\n",
+    "\n",
+    "\n",
+    "class FilingType(str, Enum):\n",
+    "    ten_k = \"10 K\"\n",
+    "    ten_q = \"10-Q\"\n",
+    "    ten_ka = \"10-K/A\"\n",
+    "    ten_qa = \"10-Q/A\"\n",
+    "\n",
+    "\n",
+    "class FinancialReport(BaseModel):\n",
+    "    company_name: str = Field(description=\"The name of the company\")\n",
+    "    description: str = Field(\n",
+    "        description=\"Short description of the filing and what it contains\"\n",
+    "    )\n",
+    "    filing_type: FilingType = Field(description=\"Type of SEC filing\")\n",
+    "    filing_date: str = Field(description=\"Date when filing was submitted to SEC\")\n",
+    "    fiscal_year: int = Field(description=\"Fiscal year\")\n",
+    "    unit: str = Field(\n",
+    "        description=\"Unit of financial figures (thousands, millions, etc.)\"\n",
+    "    )\n",
+    "    revenue: int = Field(description=\"Total revenue for period\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Set Up Citations and Reasoning\n",
+    "\n",
+    "Optionally, we can set the `ExtractConfig` to extract citations for each field the agent extracts. These cications will cite the specific pages and sections of the file from which a given field was extractedd.\n",
+    "\n",
+    "By setting `use_reasoning` to True, we als ask the agent to do an additional reasoning step, explaining why a given field was extracted."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from llama_cloud.types import ExtractConfig, ExtractMode\n",
+    "\n",
+    "config = ExtractConfig(\n",
+    "    use_reasoning=True, cite_sources=True, extraction_mode=ExtractMode.MULTIMODAL\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "/usr/local/lib/python3.11/dist-packages/llama_cloud_services/extract/extract.py:127: ExperimentalWarning: `use_reasoning` is an experimental feature. Results will be available in the `extraction_metadata` field for the extraction run.\n",
+      "  warnings.warn(\n",
+      "/usr/local/lib/python3.11/dist-packages/llama_cloud_services/extract/extract.py:133: ExperimentalWarning: `cite_sources` is an experimental feature. This may greatly increase the size of the response, and slow down the extraction. Results will be available in the `extraction_metadata` field for the extraction run.\n",
+      "  warnings.warn(\n"
+     ]
+    }
+   ],
+   "source": [
+    "agent = llama_extract.create_agent(\n",
+    "    name=\"filing-parser\", data_schema=FinancialReport, config=config\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Demo Time - Download a PDF and Extract Data with Citations"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "PDF downloaded successfully.\n"
+     ]
+    }
+   ],
+   "source": [
+    "import requests\n",
+    "\n",
+    "url = \"https://raw.githubusercontent.com/run-llama/llama_cloud_services/refs/heads/main/examples/extract/data/sec_filings/nvda_10k.pdf\"\n",
+    "\n",
+    "response = requests.get(url)\n",
+    "\n",
+    "if response.status_code == 200:\n",
+    "    with open(\"/content/nvda_10k.pdf\", \"wb\") as f:\n",
+    "        f.write(response.content)\n",
+    "    print(\"PDF downloaded successfully.\")\n",
+    "else:\n",
+    "    print(f\"Failed to download. Status code: {response.status_code}\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "Uploading files: 100%|██████████| 1/1 [00:00<00:00,  1.83it/s]\n",
+      "Creating extraction jobs: 100%|██████████| 1/1 [00:00<00:00,  4.38it/s]\n",
+      "Extracting files: 100%|██████████| 1/1 [02:03<00:00, 123.40s/it]\n"
+     ]
+    }
+   ],
+   "source": [
+    "filing_info = agent.extract(\"/content/nvda_10k.pdf\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'company_name': 'NVIDIA Corporation',\n",
+       " 'description': \"The filing provides a detailed overview of NVIDIA's business as a full-stack computing infrastructure company, discusses various technologies including digital avatars and autonomous vehicles, outlines numerous risk factors affecting operations such as supply chain issues and geopolitical tensions, and describes employee stock purchase plans and related compliance requirements.\",\n",
+       " 'filing_type': '10 K',\n",
+       " 'filing_date': 'February 26, 2025',\n",
+       " 'fiscal_year': 2025,\n",
+       " 'unit': 'millions',\n",
+       " 'revenue': 130497}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "filing_info.data"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Inspect Citations and Reasoning"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'field_metadata': {'company_name': {'reasoning': 'VERBATIM EXTRACTION',\n",
+       "   'citation': [{'page': 1, 'matching_text': 'NVIDIA CORPORATION'},\n",
+       "    {'page': 2, 'matching_text': 'NVIDIA Corporation'},\n",
+       "    {'page': 3,\n",
+       "     'matching_text': 'All references to \"NVIDIA,\" \"we,\" \"us,\" \"our,\" or the \"Company\" mean NVIDIA Corporation and its subsidiaries.'},\n",
+       "    {'page': 35,\n",
+       "     'matching_text': 'Comparison of 5 Year Cumulative Total Return* Among NVIDIA Corporation'},\n",
+       "    {'page': 49,\n",
+       "     'matching_text': 'To the Board of Directors and Shareholders of NVIDIA Corporation'},\n",
+       "    {'page': 90, 'matching_text': 'NVIDIA Corporation'},\n",
+       "    {'page': 119,\n",
+       "     'matching_text': '*\"Company\"* means NVIDIA Corporation, a Delaware corporation.'},\n",
+       "    {'page': 126,\n",
+       "     'matching_text': 'Annual Report on Form 10-K of NVIDIA Corporation'}]},\n",
+       "  'filing_type': {'reasoning': \"VERBATIM EXTRACTION from multiple sources confirming the filing type as '10 K'.\",\n",
+       "   'citation': [{'page': 1, 'matching_text': 'FORM 10-K'},\n",
+       "    {'page': 2, 'matching_text': 'Item 16. | Form 10-K Summary'},\n",
+       "    {'page': 3,\n",
+       "     'matching_text': 'This Annual Report on Form 10-K contains forward-looking statements...'},\n",
+       "    {'page': 13, 'matching_text': 'this Annual Report on Form 10-K'},\n",
+       "    {'page': 15, 'matching_text': 'this Annual Report on Form 10-K'},\n",
+       "    {'page': 32,\n",
+       "     'matching_text': 'Annual Report on Form 10-K, which information is hereby incorporated by reference.'},\n",
+       "    {'page': 36, 'matching_text': 'this Annual Report on Form 10-K'},\n",
+       "    {'page': 43,\n",
+       "     'matching_text': 'Annual Report on Form 10-K for additional information'},\n",
+       "    {'page': 45, 'matching_text': 'Annual Report on Form 10-K'},\n",
+       "    {'page': 46, 'matching_text': 'this Annual Report on Form 10-K'},\n",
+       "    {'page': 62, 'matching_text': 'Annual Report on Form 10-K'},\n",
+       "    {'page': 83,\n",
+       "     'matching_text': 'Restated Certificate of Incorporation | 10-K'},\n",
+       "    {'page': 84, 'matching_text': 'Item 16. Form 10-K Summary'},\n",
+       "    {'page': 126, 'matching_text': 'which appears in this Form 10-K'},\n",
+       "    {'page': 127, 'matching_text': 'Annual Report on Form 10-K'},\n",
+       "    {'page': 128, 'matching_text': 'Annual Report on Form 10-K'},\n",
+       "    {'page': 129, 'matching_text': \"The Company's Annual Report on Form 10-K\"},\n",
+       "    {'page': 130,\n",
+       "     'matching_text': \"The Company's Annual Report on Form 10-K for the year ended January 26, 2025\"}]},\n",
+       "  'fiscal_year': {'reasoning': 'The fiscal year ended January 26, 2025, indicates the fiscal year is 2025. Additionally, multiple references throughout the text confirm the fiscal year 2025 in various contexts.',\n",
+       "   'citation': [{'page': 1,\n",
+       "     'matching_text': 'For the fiscal year ended January 26, 2025'},\n",
+       "    {'page': 6,\n",
+       "     'matching_text': 'In fiscal year 2025, we launched the NVIDIA Blackwell architecture'},\n",
+       "    {'page': 12, 'matching_text': 'fiscal year 2025'},\n",
+       "    {'page': 17,\n",
+       "     'matching_text': 'our gross margins in the second quarter of fiscal year 2025 were negatively impacted'},\n",
+       "    {'page': 20,\n",
+       "     'matching_text': 'we generated 53% of our revenue in fiscal year 2025 from sales outside the United States.'},\n",
+       "    {'page': 23,\n",
+       "     'matching_text': 'For fiscal year 2025, an indirect customer which primarily purchases our products through system integrators...'},\n",
+       "    {'page': 33,\n",
+       "     'matching_text': 'In fiscal year 2025, we repurchased 310 million shares of our common stock for $34.0 billion.'},\n",
+       "    {'page': 37,\n",
+       "     'matching_text': 'Our Data Center revenue in China grew in fiscal year 2025.'},\n",
+       "    {'page': 44,\n",
+       "     'matching_text': 'Cash provided by operating activities increased in fiscal year 2025 compared to fiscal year 2024'},\n",
+       "    {'page': 57,\n",
+       "     'matching_text': 'Fiscal years 2025, 2024 and 2023 were all 52-week years.'},\n",
+       "    {'page': 65,\n",
+       "     'matching_text': 'Beginning in the second quarter of fiscal year 2025'},\n",
+       "    {'page': 69, 'matching_text': 'In the fourth quarter of fiscal year 2025'},\n",
+       "    {'page': 78,\n",
+       "     'matching_text': 'Depreciation and amortization expense attributable to our Compute and Networking segment for fiscal years 2025'},\n",
+       "    {'page': 129, 'matching_text': 'for the year ended January 26, 2025'}]},\n",
+       "  'description': {'reasoning': 'The extracted data combines multiple descriptions from the source text, ensuring no duplication while maintaining the order and context of the information. Each section of the filing is summarized to reflect the key points without losing the essence of the original text.',\n",
+       "   'citation': [{'page': 4,\n",
+       "     'matching_text': 'NVIDIA is now a full-stack computing infrastructure company with data-center-scale offerings that are reshaping industry.'},\n",
+       "    {'page': 8,\n",
+       "     'matching_text': 'a suite of technologies that help developers bring digital avatars to life with generative Al...autonomous vehicles, or AV, and electric vehicles, or EV, is revolutionizing the transportation industry...Our worldwide sales and marketing strategy is key to achieving our objective of providing markets with our high-performance and efficient computing platforms and software.'},\n",
+       "    {'page': 14, 'matching_text': 'Risk Factors Summary'},\n",
+       "    {'page': 16,\n",
+       "     'matching_text': 'Risks Related to Demand, Supply, and Manufacturing\\n\\nLong manufacturing lead times and uncertain supply and component availability...'},\n",
+       "    {'page': 18,\n",
+       "     'matching_text': 'cryptocurrency mining, on demand for our products. Volatility in the cryptocurrency market, including new compute technologies...'},\n",
+       "    {'page': 21,\n",
+       "     'matching_text': 'supply-chain attacks or other business disruptions. We cannot guarantee that third parties and infrastructure in our supply chain...'},\n",
+       "    {'page': 22,\n",
+       "     'matching_text': 'We are monitoring the impact of the geopolitical conflict in and around Israel on our operations... Climate change may have a long-term impact on our business.'},\n",
+       "    {'page': 25,\n",
+       "     'matching_text': 'We are subject to complex laws, rules, regulations, and political and other actions, including restrictions on the export of our products, which may adversely impact our business.'},\n",
+       "    {'page': 28,\n",
+       "     'matching_text': 'Our competitive position has been harmed by the existing export controls, and our competitive position and future results may be further harmed'},\n",
+       "    {'page': 29,\n",
+       "     'matching_text': 'restrictions imposed by the Chinese government on the duration of gaming activities and access to games may adversely affect our Gaming revenue'},\n",
+       "    {'page': 29,\n",
+       "     'matching_text': 'our business depends on our ability to receive consistent and reliable supply from our overseas partners, especially in Taiwan and South Korea'},\n",
+       "    {'page': 29,\n",
+       "     'matching_text': 'Increased scrutiny from shareholders, regulators and others regarding our corporate sustainability practices could result in additional costs'},\n",
+       "    {'page': 29,\n",
+       "     'matching_text': 'Concerns relating to the responsible use of new and evolving technologies, such as Al, in our products and services may result in reputational or financial harm'},\n",
+       "    {'page': 31,\n",
+       "     'matching_text': 'Data protection laws around the world are quickly changing and may be interpreted and applied in an increasingly stringent fashion...'}]},\n",
+       "  'filing_date': {'reasoning': 'The filing date is consistently mentioned as February 26, 2025 across multiple entries, making it the most reliable date for the filing.',\n",
+       "   'citation': [{'page': 51, 'matching_text': 'February 26, 2025'},\n",
+       "    {'page': 86, 'matching_text': 'on February 26, 2025.'},\n",
+       "    {'page': 87, 'matching_text': 'February 26, 2025'},\n",
+       "    {'page': 126, 'matching_text': 'our report dated February 26, 2025'},\n",
+       "    {'page': 127, 'matching_text': 'Date: February 26, 2025'},\n",
+       "    {'page': 128, 'matching_text': 'Date: February 26, 2025'},\n",
+       "    {'page': 129, 'matching_text': 'Date: February 26, 2025'},\n",
+       "    {'page': 130, 'matching_text': 'Date: February 26, 2025'}]},\n",
+       "  'unit': {'reasoning': \"The unit of financial figures is explicitly mentioned multiple times in the text as 'millions', including in table headers and notes. This is confirmed by various citations from pages 38, 42, 43, 52, 53, 54, 56, 65, 71, 72, 73, 75, 77, 79, 80, and 82.\",\n",
+       "   'citation': [{'page': 38,\n",
+       "     'matching_text': '($ in millions, except per share data)'},\n",
+       "    {'page': 42, 'matching_text': '($ in millions)'},\n",
+       "    {'page': 43, 'matching_text': '($ in millions)'},\n",
+       "    {'page': 52, 'matching_text': '(In millions, except per share data)'},\n",
+       "    {'page': 53,\n",
+       "     'matching_text': 'Consolidated Statements of Comprehensive Income (In millions)'},\n",
+       "    {'page': 54,\n",
+       "     'matching_text': 'Consolidated Balance Sheets (In millions, except par value)'},\n",
+       "    {'page': 55, 'matching_text': '(In millions, except per share data)'},\n",
+       "    {'page': 56,\n",
+       "     'matching_text': 'Consolidated Statements of Cash Flows (In millions)'},\n",
+       "    {'page': 65,\n",
+       "     'matching_text': 'Year Ended<br/>Jan 26, 2025<br/>(In millions, except per share data)'},\n",
+       "    {'page': 71, 'matching_text': '(In millions) | (In millions)'},\n",
+       "    {'page': 72, 'matching_text': '(In millions)'}]},\n",
+       "  'revenue': {'reasoning': 'The total revenue for fiscal year 2025 is extracted from multiple sources within the text, all confirming the same figure of $130,497 million. The revenue recognized for fiscal year 2025 is also noted as $4,607 million, which is a separate figure. However, the primary focus is on the total revenue figure, which is consistently cited.',\n",
+       "   'citation': [{'page': 38,\n",
+       "     'matching_text': 'Revenue for fiscal year 2025 was $130.5 billion'},\n",
+       "    {'page': 41,\n",
+       "     'matching_text': 'Total                | $ 130,497    | $ | 60,922'},\n",
+       "    {'page': 52, 'matching_text': 'Revenue | $ 130,497'},\n",
+       "    {'page': 78,\n",
+       "     'matching_text': 'Revenue | $ 116,193 | $ 14,304 | $ - | $ 130,497'},\n",
+       "    {'page': 79, 'matching_text': 'Total revenue | $ 130,497'},\n",
+       "    {'page': 80, 'matching_text': 'Total revenue              | $ 130,497'}]}},\n",
+       " 'usage': {'num_pages_extracted': 130,\n",
+       "  'num_document_tokens': 105932,\n",
+       "  'num_output_tokens': 31306}}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "filing_info.extraction_metadata"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## What's Next?\n",
+    "\n",
+    "In this example, we built an Extraction Agent that is capable of citing it's sources from the document it's extracting data from, and reasoning about its reponse. To further customize and improve on the results, you can also try to customize the `system_prompt` in the `ExtractConfig`.\n",
+    "\n",
+    "#### Learn More\n",
+    "\n",
+    "- [LlamaExtract Documentation](https://docs.cloud.llamaindex.ai/llamaextract/getting_started)\n",
+    "- [Example Notebooks](https://github.com/run-llama/llama_cloud_services/tree/main/examples/extract)"
+   ]
+  }
+ ],
+ "metadata": {
+  "colab": {
+   "provenance": []
+  },
+  "kernelspec": {
+   "display_name": "Python 3",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 0
+}

examples/extract/lm317_structured_extraction.ipynb

@@ -0,0 +1,318 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "1f6bd03d-1b8b-45a0-bc2c-5a13f1a5d8d3",
+   "metadata": {},
+   "source": [
+    "# LM317 Voltage Regulator Datasheet Structured Extraction\n",
+    "\n",
+    "<a href=\"https://colab.research.google.com/github/run-llama/llama_cloud_services/blob/main/examples/extract/lm317_structured_extraction.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
+    "\n",
+    "This notebook demonstrates an agentic document workflow using LlamaExtract to process an LM317 voltage regulator datasheet. In this example, we define a structured extraction schema that converts key technical fields into standardized subfields. For instance, the output voltage is split into a minimum and maximum value with a defined unit, and we capture page citations for each extracted field.\n",
+    "\n",
+    "The target user is an electronics engineer at a component manufacturing company who needs to consolidate datasheet information into a standardized specification sheet for design and quality control.\n",
+    "\n",
+    "This approach reduces manual data entry, improves extraction accuracy and standardization, and provides traceability for each technical detail."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "a3b8c8d5-ff3e-48ce-b0b8-29b6b1f517f8",
+   "metadata": {},
+   "source": [
+    "## Use Case Overview\n",
+    "\n",
+    "### Problem\n",
+    "Datasheets like that for the LM317 regulator are often distributed as PDFs containing multiple tables, charts, and complex textual descriptions. Engineers must manually extract technical details such as voltage ranges, dropout voltage, maximum current, input voltage range, and pin configurations. This process is error-prone and time-consuming.\n",
+    "\n",
+    "### Agent Workflow (Combination of Automation and Chat)\n",
+    "1. **Upload Datasheet:** The engineer uploads the LM317 datasheet PDF.  \n",
+    "2. **Structured Extraction:** An automated agent processes the PDF and extracts key technical details into structured fields (e.g., output voltage as a range with separate min/max values).\n",
+    "3. **Interactive Verification:** The engineer can query the agent (via chat) for further details or clarification (e.g., \"Show me the detailed pin configuration extraction\") and review the cited pages.\n",
+    "\n",
+    "**Value Delivered:**\n",
+    "- Up to 70% reduction in manual data extraction time.\n",
+    "- Increased accuracy and standardization with structured fields."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "a704e843-54be-4969-842b-713584cb3c35",
+   "metadata": {},
+   "source": [
+    "## Setup and Download Data\n",
+    "\n",
+    "Download the [LM317 Datasheet](https://www.ti.com/lit/ds/symlink/lm317.pdf) and setup LlamaExtract."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "6e5b1f91-8785-44d4-a710-8be1b48b76de",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!mkdir -p data/lm317_structured_extraction\n",
+    "!wget https://www.ti.com/lit/ds/symlink/lm317.pdf -O data/lm317_structured_extraction/lm317.pdf"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "f17b914a-00ed-4b63-8198-69fd7c4a7c62",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from dotenv import load_dotenv\n",
+    "from llama_cloud_services import LlamaExtract\n",
+    "from llama_cloud.core.api_error import ApiError\n",
+    "\n",
+    "# Load environment variables (ensure LLAMA_CLOUD_API_KEY is set in your .env file)\n",
+    "load_dotenv(override=True)\n",
+    "\n",
+    "# Initialize the LlamaExtract client\n",
+    "llama_extract = LlamaExtract(\n",
+    "    project_id=\"<project_id>\",\n",
+    "    organization_id=\"<organization_id>\",\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ed9f6e9a-96c8-4ee1-8b45-0b6a4f7dbbf1",
+   "metadata": {},
+   "source": [
+    "## Defining a Structured Extraction Schema\n",
+    "\n",
+    "We now define a rich Pydantic schema to extract technical specifications from the LM317 datasheet. In this schema:\n",
+    "\n",
+    "- The **output_voltage** and **input_voltage** fields are structured as ranges with separate minimum and maximum values and a unit.\n",
+    "- The **pin_configuration** field is structured to include a pin count and a descriptive layout.\n",
+    "- Additional technical fields (e.g., dropout voltage, max current) are captured as numbers.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4f7e9b44-5e69-4b30-9864-cd98f1e2a7d4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pydantic import BaseModel, Field\n",
+    "from typing import List\n",
+    "\n",
+    "\n",
+    "class VoltageRange(BaseModel):\n",
+    "    min_voltage: float = Field(..., description=\"Minimum voltage in volts\")\n",
+    "    max_voltage: float = Field(..., description=\"Maximum voltage in volts\")\n",
+    "    unit: str = Field(\"V\", description=\"Voltage unit\")\n",
+    "\n",
+    "\n",
+    "class PinConfiguration(BaseModel):\n",
+    "    pin_count: int = Field(..., description=\"Number of pins\")\n",
+    "    layout: str = Field(..., description=\"Detailed pin layout description\")\n",
+    "\n",
+    "\n",
+    "class LM317Spec(BaseModel):\n",
+    "    component_name: str = Field(..., description=\"Name of the component\")\n",
+    "    output_voltage: VoltageRange = Field(\n",
+    "        ..., description=\"Output voltage range specification\"\n",
+    "    )\n",
+    "    dropout_voltage: float = Field(..., description=\"Dropout voltage in volts\")\n",
+    "    max_current: float = Field(..., description=\"Maximum current rating in amperes\")\n",
+    "    input_voltage: VoltageRange = Field(\n",
+    "        ..., description=\"Input voltage range specification\"\n",
+    "    )\n",
+    "    pin_configuration: PinConfiguration = Field(\n",
+    "        ..., description=\"Pin configuration details\"\n",
+    "    )\n",
+    "    features: List[str] = Field([], description=\"List of additional technical features\")\n",
+    "\n",
+    "\n",
+    "class LM317Schema(BaseModel):\n",
+    "    specs: List[LM317Spec] = Field(\n",
+    "        ..., description=\"List of extracted LM317 technical specifications\"\n",
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e0508e38-35be-446c-afe7-129e39553281",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "try:\n",
+    "    existing_agent = llama_extract.get_agent(name=\"lm317-datasheet\")\n",
+    "    if existing_agent:\n",
+    "        llama_extract.delete_agent(existing_agent.id)\n",
+    "except ApiError as e:\n",
+    "    if e.status_code == 404:\n",
+    "        pass\n",
+    "    else:\n",
+    "        raise"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "bb197dfd-dd37-459e-8953-cc1b12f25bdd",
+   "metadata": {},
+   "source": [
+    "Here we use our balanced extraction mode."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e3defc0a-c685-4fbd-bbb1-1270f1442e72",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from llama_cloud import ExtractConfig\n",
+    "\n",
+    "extract_config = ExtractConfig(\n",
+    "    extraction_mode=\"BALANCED\",\n",
+    ")\n",
+    "\n",
+    "agent = llama_extract.create_agent(\n",
+    "    name=\"lm317-datasheet\", data_schema=LM317Schema, config=extract_config\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "c0a0f9f9-2ef3-4a38-bd74-68d2c2e9e2d8",
+   "metadata": {},
+   "source": [
+    "## Extracting Information from the LM317 Datasheet\n",
+    "\n",
+    "For this demonstration, please download a publicly available LM317 voltage regulator datasheet (for example, from Texas Instruments) and save it as `lm317.pdf` in the `./data` directory. Then run the cell below to extract the structured technical specifications."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "c58e8b7a-8f9b-46f3-8f72-3c2f96b49e8f",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "Uploading files: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:01<00:00,  1.08s/it]\n",
+      "Creating extraction jobs: 100%|████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00,  1.96it/s]\n",
+      "Extracting files: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [01:27<00:00, 87.38s/it]\n"
+     ]
+    }
+   ],
+   "source": [
+    "# Path to the LM317 datasheet PDF\n",
+    "lm317_pdf = \"./data/lm317_structured_extraction/lm317.pdf\"\n",
+    "\n",
+    "# Extract structured technical specifications from the datasheet\n",
+    "lm317_extract = agent.extract(lm317_pdf)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1a2e2e44-6c48-4a38-a6de-5f2f3c7d4d8b",
+   "metadata": {},
+   "source": [
+    "## Assessing the Extraction Results\n",
+    "\n",
+    "The output will be a consolidated list of LM317 technical specifications. For each entry, you should see structured fields including:\n",
+    "\n",
+    "- **component_name**\n",
+    "- **output_voltage** as a range (with separate `min_voltage` and `max_voltage` plus `unit`)\n",
+    "- **dropout_voltage** and **max_current** as numbers\n",
+    "- **input_voltage** as a structured range\n",
+    "- **pin_configuration** with a `pin_count` and `layout`\n",
+    "- **features** (if available)\n",
+    "\n",
+    "This structured approach makes it easier to standardize the information for downstream integration and verification. Engineers can click on the cited page numbers (in a UI that supports it) to validate the extraction."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "fb2abc44-7c9b-4b19-958e-d0d7b390ae57",
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'specs': [{'component_name': 'LM317',\n",
+       "   'output_voltage': {'min_voltage': 1.25, 'max_voltage': 37.0, 'unit': 'V'},\n",
+       "   'dropout_voltage': 0.0,\n",
+       "   'max_current': 1.5,\n",
+       "   'input_voltage': {'min_voltage': 4.25, 'max_voltage': 40.0, 'unit': 'V'},\n",
+       "   'pin_configuration': {'pin_count': 3,\n",
+       "    'layout': '1: ADJUST, 2: OUTPUT, 3: INPUT'},\n",
+       "   'features': ['Output voltage range adjustable from 1.25 V to 37 V',\n",
+       "    'Output current greater than 1.5 A',\n",
+       "    'Internal short-circuit current limiting',\n",
+       "    'Thermal overload protection',\n",
+       "    'Output safe-area compensation']}]}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "# Display the extraction results\n",
+    "lm317_extract.data"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "c7a2a523-095e-40bf-b713-f509c13a7747",
+   "metadata": {},
+   "source": [
+    "You can also see the output result in the UI."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "dc22dfa5-b667-4fb0-8dbe-24e401b12389",
+   "metadata": {},
+   "source": [
+    "![](data/lm317_structured_extraction/lm317_extraction.png)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e0e0c12a-9f89-4bb3-b40d-3e9f7c6d2fef",
+   "metadata": {},
+   "source": [
+    "## Conclusion\n",
+    "\n",
+    "This notebook demonstrated how to use LlamaExtract with a structured extraction schema for the LM317 voltage regulator datasheet. By defining detailed subfields (such as splitting voltage ranges into minimum and maximum values, and structuring the pin configuration), we ensure that the extracted data is standardized and traceable through page citations. This approach minimizes manual effort and improves accuracy, providing a robust example of an agentic document workflow for technical documentation processing.\n",
+    "\n",
+    "Feel free to modify or extend the schema to capture additional technical details or to suit your own use cases."
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "llama_parse",
+   "language": "python",
+   "name": "llama_parse"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

examples/extract/resume_screening.ipynb

@@ -0,0 +1,834 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Extracting data from Resumes\n",
+    "\n",
+    "Let us assume that we are running a hiring process for a company and we have received a list of resumes from candidates. We want to extract structured data from the resumes so that we can run a screening process and shortlist candidates. \n",
+    "\n",
+    "Take a look at one of the resumes in the `data/resumes` directory. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/html": [
+       "\n",
+       "        <iframe\n",
+       "            width=\"600\"\n",
+       "            height=\"400\"\n",
+       "            src=\"./data/resumes/ai_researcher.pdf\"\n",
+       "            frameborder=\"0\"\n",
+       "            allowfullscreen\n",
+       "            \n",
+       "        ></iframe>\n",
+       "        "
+      ],
+      "text/plain": [
+       "<IPython.lib.display.IFrame at 0x109a7dcd0>"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "from IPython.display import IFrame\n",
+    "\n",
+    "IFrame(src=\"./data/resumes/ai_researcher.pdf\", width=600, height=400)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You will notice that all the resumes have different layouts but contain common information like name, email, experience, education, etc. \n",
+    "\n",
+    "With LlamaExtract, we will show you how to:\n",
+    "- *Define* a data schema to extract the information of interest. \n",
+    "- *Iterate* over the data schema to generalize the schema for multiple resumes.\n",
+    "- *Finalize* the schema and schedule extractions for multiple resumes.\n",
+    "\n",
+    "We will start by defining a `LlamaExtract` client which provides a Python interface to the LlamaExtract API. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from dotenv import load_dotenv\n",
+    "from llama_cloud_services import LlamaExtract\n",
+    "\n",
+    "\n",
+    "# Load environment variables (put LLAMA_CLOUD_API_KEY in your .env file)\n",
+    "load_dotenv(override=True)\n",
+    "\n",
+    "# Optionally, add your project id/organization id\n",
+    "llama_extract = LlamaExtract()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Defining the data schema\n",
+    "\n",
+    "Next, let us try to extract two fields from the resume: `name` and `email`. We can either use a Python dictionary structure to define the `data_schema` as a JSON or use a Pydantic model instead, for brevity and convenience. In either case, our output is guaranteed to validate against this schema."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pydantic import BaseModel, Field\n",
+    "\n",
+    "\n",
+    "class Resume(BaseModel):\n",
+    "    name: str = Field(description=\"The name of the candidate\")\n",
+    "    email: str = Field(description=\"The email address of the candidate\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "Uploading files: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:02<00:00,  2.20s/it]\n",
+      "Creating extraction jobs: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:02<00:00,  2.93s/it]\n",
+      "Extracting files: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:02<00:00,  2.94s/it]\n",
+      "Uploading files: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00,  1.13it/s]\n",
+      "Creating extraction jobs: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00,  1.80it/s]\n",
+      "Extracting files: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:15<00:00, 15.18s/it]\n",
+      "Uploading files: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00,  1.16it/s]\n",
+      "Creating extraction jobs: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00,  2.33it/s]\n",
+      "Extracting files: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:32<00:00, 32.86s/it]\n"
+     ]
+    }
+   ],
+   "source": [
+    "from llama_cloud.core.api_error import ApiError\n",
+    "\n",
+    "try:\n",
+    "    existing_agent = llama_extract.get_agent(name=\"resume-screening\")\n",
+    "    if existing_agent:\n",
+    "        llama_extract.delete_agent(existing_agent.id)\n",
+    "except ApiError as e:\n",
+    "    if e.status_code == 404:\n",
+    "        pass\n",
+    "    else:\n",
+    "        raise\n",
+    "\n",
+    "agent = llama_extract.create_agent(name=\"resume-screening\", data_schema=Resume)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[ExtractionAgent(id=1fef43b5-8230-43b4-9e80-c1cddf53889c, name=resume-screening),\n",
+       " ExtractionAgent(id=93f8508b-3570-46f0-ae62-6315b40043bd, name=receipt/noisebridge_receipt.pdf_56db3d92),\n",
+       " ExtractionAgent(id=08315f0e-7146-430b-99b8-9701cb3ace6a, name=receipt/noisebridge_receipt.pdf_5c4730a7),\n",
+       " ExtractionAgent(id=cfcd7756-015d-4dbd-b142-a3eefcb16cd3, name=resume/software_architect_resume.html_4a11cf15),\n",
+       " ExtractionAgent(id=17cb83d9-601e-4f5c-a7aa-286e3045bcb4, name=resume/software_architect_resume.html_0b7d84a8),\n",
+       " ExtractionAgent(id=adc8e88c-44d3-4613-a5aa-d666ef007494, name=slide/saas_slide.pdf_bcc627a5),\n",
+       " ExtractionAgent(id=189f14cd-6370-4476-a6ad-36eafbc62618, name=slide/saas_slide.pdf_065aa22b),\n",
+       " ExtractionAgent(id=b9938ca5-6225-43cb-89ea-b0065237792f, name=test2),\n",
+       " ExtractionAgent(id=574d37b8-59dc-41e9-bde0-5c506a8eb670, name=test)]"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "llama_extract.list_agents()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'name': 'Dr. Rachel Zhang', 'email': 'rachel.zhang@email.com'}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "resume = agent.extract(\"./data/resumes/ai_researcher.pdf\")\n",
+    "resume.data"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Iterating over the data schema\n",
+    "\n",
+    "Now that we have created a data schema, let us add more fields to the schema. We will add `experience` and `education` fields to the schema. \n",
+    "- We can create a new Pydantic model for each of these fields and represent `experience` and `education` as lists of these models. Doing this will allow us to extract multiple entities from the resume without having to pre-define how many experiences or education the candidate has. \n",
+    "- We have added a `description` parameter to provide more context for extraction. We can use `description` to provide example inputs/outputs for the extraction. \n",
+    "- Note that we have annotated the `start_date` and `end_date` fields with `Optional[str]` to indicate that these fields are optional. This is *important* because the schema will be used to extract data from multiple resumes and not all resumes will have the same format. A field must only be required if it is guaranteed to be present in all the resumes. \n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from typing import List, Optional\n",
+    "\n",
+    "\n",
+    "class Education(BaseModel):\n",
+    "    institution: str = Field(description=\"The institution of the candidate\")\n",
+    "    degree: str = Field(description=\"The degree of the candidate\")\n",
+    "    start_date: Optional[str] = Field(\n",
+    "        default=None, description=\"The start date of the candidate's education\"\n",
+    "    )\n",
+    "    end_date: Optional[str] = Field(\n",
+    "        default=None, description=\"The end date of the candidate's education\"\n",
+    "    )\n",
+    "\n",
+    "\n",
+    "class Experience(BaseModel):\n",
+    "    company: str = Field(description=\"The name of the company\")\n",
+    "    title: str = Field(description=\"The title of the candidate\")\n",
+    "    description: Optional[str] = Field(\n",
+    "        default=None, description=\"The description of the candidate's experience\"\n",
+    "    )\n",
+    "    start_date: Optional[str] = Field(\n",
+    "        default=None, description=\"The start date of the candidate's experience\"\n",
+    "    )\n",
+    "    end_date: Optional[str] = Field(\n",
+    "        default=None, description=\"The end date of the candidate's experience\"\n",
+    "    )\n",
+    "\n",
+    "\n",
+    "class Resume(BaseModel):\n",
+    "    name: str = Field(description=\"The name of the candidate\")\n",
+    "    email: str = Field(description=\"The email address of the candidate\")\n",
+    "    links: List[str] = Field(\n",
+    "        description=\"The links to the candidate's social media profiles\"\n",
+    "    )\n",
+    "    experience: List[Experience] = Field(description=\"The candidate's experience\")\n",
+    "    education: List[Education] = Field(description=\"The candidate's education\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Next, we will update the `data_schema` for the `resume-screening` agent to use the new `Resume` model. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'name': 'Dr. Rachel Zhang',\n",
+       " 'email': 'rachel.zhang@email.com',\n",
+       " 'links': ['linkedin.com/in/rachelzhang',\n",
+       "  'github.com/rzhang-ai',\n",
+       "  'scholar.google.com/rachelzhang'],\n",
+       " 'experience': [{'company': 'DeepMind',\n",
+       "   'title': 'Senior Research Scientist',\n",
+       "   'description': '- Lead researcher on large-scale multi-task learning systems, developing novel architectures that improve cross-task generalization by 40%\\n- Pioneered new approach to zero-shot learning using contrastive training, published in NeurIPS 2023\\n- Built and led team of 6 researchers working on foundational ML models\\n- Developed novel regularization techniques for large language models, reducing catastrophic forgetting by 35%',\n",
+       "   'start_date': '2019',\n",
+       "   'end_date': 'Present'},\n",
+       "  {'company': 'Google Research',\n",
+       "   'title': 'Research Scientist',\n",
+       "   'description': '- Developed probabilistic frameworks for robust ML, published in ICML 2018\\n- Created novel attention mechanisms for computer vision models, improving accuracy by 25%\\n- Led collaboration with Google Brain team on efficient training methods for transformer models\\n- Mentored 4 PhD interns and collaborated with academic institutions',\n",
+       "   'start_date': '2015',\n",
+       "   'end_date': '2019'},\n",
+       "  {'company': 'Columbia University',\n",
+       "   'title': 'Research Assistant Professor',\n",
+       "   'description': '- Published seminal work on Bayesian optimization methods (cited 1000+ times)\\n- Taught graduate-level courses in Machine Learning and Statistical Learning Theory\\n- Supervised 5 PhD students and 3 MSc students\\n- Secured $500K in research grants for probabilistic ML research',\n",
+       "   'start_date': '2011',\n",
+       "   'end_date': '2015'}],\n",
+       " 'education': [{'institution': 'Columbia University',\n",
+       "   'degree': 'Ph.D. in Computer Science',\n",
+       "   'start_date': '2007',\n",
+       "   'end_date': '2011'},\n",
+       "  {'institution': 'Stanford University',\n",
+       "   'degree': 'M.S. in Computer Science',\n",
+       "   'start_date': '2005',\n",
+       "   'end_date': '2007'}]}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent.data_schema = Resume\n",
+    "resume = agent.extract(\"./data/resumes/ai_researcher.pdf\")\n",
+    "resume.data"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This is a good start. Let us add a few more fields to the schema and re-run the extraction. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "class TechnicalSkills(BaseModel):\n",
+    "    programming_languages: List[str] = Field(\n",
+    "        description=\"The programming languages the candidate is proficient in.\"\n",
+    "    )\n",
+    "    frameworks: List[str] = Field(\n",
+    "        description=\"The tools/frameworks the candidate is proficient in, e.g. React, Django, PyTorch, etc.\"\n",
+    "    )\n",
+    "    skills: List[str] = Field(\n",
+    "        description=\"Other general skills the candidate is proficient in, e.g. Data Engineering, Machine Learning, etc.\"\n",
+    "    )\n",
+    "\n",
+    "\n",
+    "class Resume(BaseModel):\n",
+    "    name: str = Field(description=\"The name of the candidate\")\n",
+    "    email: str = Field(description=\"The email address of the candidate\")\n",
+    "    links: List[str] = Field(\n",
+    "        description=\"The links to the candidate's social media profiles\"\n",
+    "    )\n",
+    "    experience: List[Experience] = Field(description=\"The candidate's experience\")\n",
+    "    education: List[Education] = Field(description=\"The candidate's education\")\n",
+    "    technical_skills: TechnicalSkills = Field(\n",
+    "        description=\"The candidate's technical skills\"\n",
+    "    )\n",
+    "    key_accomplishments: str = Field(\n",
+    "        description=\"Summarize the candidates highest achievements.\"\n",
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'name': 'Dr. Rachel Zhang, Ph.D.',\n",
+       " 'email': 'rachel.zhang@email.com',\n",
+       " 'links': ['linkedin.com/in/rachelzhang',\n",
+       "  'github.com/rzhang-ai',\n",
+       "  'scholar.google.com/rachelzhang'],\n",
+       " 'experience': [{'company': 'DeepMind',\n",
+       "   'title': 'Senior Research Scientist',\n",
+       "   'description': 'Lead researcher on large-scale multi-task learning systems, developing novel architectures that improve cross-task generalization by 40%\\nPioneered new approach to zero-shot learning using contrastive training, published in NeurIPS 2023\\nBuilt and led team of 6 researchers working on foundational ML models\\nDeveloped novel regularization techniques for large language models, reducing catastrophic forgetting by 35%',\n",
+       "   'start_date': '2019',\n",
+       "   'end_date': 'Present'},\n",
+       "  {'company': 'Google Research',\n",
+       "   'title': 'Research Scientist',\n",
+       "   'description': 'Developed probabilistic frameworks for robust ML, published in ICML 2018\\nCreated novel attention mechanisms for computer vision models, improving accuracy by 25%\\nLed collaboration with Google Brain team on efficient training methods for transformer models\\nMentored 4 PhD interns and collaborated with academic institutions',\n",
+       "   'start_date': '2015',\n",
+       "   'end_date': '2019'},\n",
+       "  {'company': 'Columbia University',\n",
+       "   'title': 'Research Assistant Professor',\n",
+       "   'description': 'Published seminal work on Bayesian optimization methods (cited 1000+ times)\\nTaught graduate-level courses in Machine Learning and Statistical Learning Theory\\nSupervised 5 PhD students and 3 MSc students\\nSecured $500K in research grants for probabilistic ML research',\n",
+       "   'start_date': '2011',\n",
+       "   'end_date': '2015'}],\n",
+       " 'education': [{'institution': 'Columbia University',\n",
+       "   'degree': 'Ph.D. in Computer Science',\n",
+       "   'start_date': '2007',\n",
+       "   'end_date': '2011'},\n",
+       "  {'institution': 'Stanford University',\n",
+       "   'degree': 'M.S. in Computer Science',\n",
+       "   'start_date': '2005',\n",
+       "   'end_date': '2007'}],\n",
+       " 'technical_skills': {'programming_languages': ['Python',\n",
+       "   'C++',\n",
+       "   'Julia',\n",
+       "   'CUDA'],\n",
+       "  'frameworks': ['PyTorch', 'TensorFlow', 'JAX', 'Ray'],\n",
+       "  'skills': ['Deep Learning',\n",
+       "   'Reinforcement Learning',\n",
+       "   'Probabilistic Models',\n",
+       "   'Multi-Task Learning',\n",
+       "   'Zero-Shot Learning',\n",
+       "   'Neural Architecture Search']},\n",
+       " 'key_accomplishments': 'AI researcher with 12+ years of experience spanning classical machine learning, deep learning, and probabilistic modeling. Led groundbreaking research in reinforcement learning, generative models, and multi-task learning. Published 25+ papers in top-tier conferences (NeurIPS, ICML, ICLR). Strong track record of transitioning theoretical advances into practical applications in both academic and industrial settings.'}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent.data_schema = Resume\n",
+    "resume = agent.extract(\"./data/resumes/ai_researcher.pdf\")\n",
+    "resume.data"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Finalizing the schema\n",
+    "\n",
+    "This is great! We have extracted a lot of key information from the resume that is well-typed and can be used downstream for further processing. Until now, this data is ephemeral and will be lost if we close the session. Let us save the state of our extraction and use it to extract data from multiple resumes. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "agent.save()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'type': 'object',\n",
+       " 'required': ['name',\n",
+       "  'email',\n",
+       "  'links',\n",
+       "  'experience',\n",
+       "  'education',\n",
+       "  'technical_skills',\n",
+       "  'key_accomplishments'],\n",
+       " 'properties': {'name': {'type': 'string',\n",
+       "   'description': 'The name of the candidate'},\n",
+       "  'email': {'type': 'string',\n",
+       "   'description': 'The email address of the candidate'},\n",
+       "  'links': {'type': 'array',\n",
+       "   'items': {'type': 'string'},\n",
+       "   'description': \"The links to the candidate's social media profiles\"},\n",
+       "  'education': {'type': 'array',\n",
+       "   'items': {'type': 'object',\n",
+       "    'required': ['institution', 'degree', 'start_date', 'end_date'],\n",
+       "    'properties': {'degree': {'type': 'string',\n",
+       "      'description': 'The degree of the candidate'},\n",
+       "     'end_date': {'anyOf': [{'type': 'string'}, {'type': 'null'}],\n",
+       "      'description': \"The end date of the candidate's education\"},\n",
+       "     'start_date': {'anyOf': [{'type': 'string'}, {'type': 'null'}],\n",
+       "      'description': \"The start date of the candidate's education\"},\n",
+       "     'institution': {'type': 'string',\n",
+       "      'description': 'The institution of the candidate'}},\n",
+       "    'additionalProperties': False},\n",
+       "   'description': \"The candidate's education\"},\n",
+       "  'experience': {'type': 'array',\n",
+       "   'items': {'type': 'object',\n",
+       "    'required': ['company', 'title', 'description', 'start_date', 'end_date'],\n",
+       "    'properties': {'title': {'type': 'string',\n",
+       "      'description': 'The title of the candidate'},\n",
+       "     'company': {'type': 'string', 'description': 'The name of the company'},\n",
+       "     'end_date': {'anyOf': [{'type': 'string'}, {'type': 'null'}],\n",
+       "      'description': \"The end date of the candidate's experience\"},\n",
+       "     'start_date': {'anyOf': [{'type': 'string'}, {'type': 'null'}],\n",
+       "      'description': \"The start date of the candidate's experience\"},\n",
+       "     'description': {'anyOf': [{'type': 'string'}, {'type': 'null'}],\n",
+       "      'description': \"The description of the candidate's experience\"}},\n",
+       "    'additionalProperties': False},\n",
+       "   'description': \"The candidate's experience\"},\n",
+       "  'technical_skills': {'type': 'object',\n",
+       "   'required': ['programming_languages', 'frameworks', 'skills'],\n",
+       "   'properties': {'skills': {'type': 'array',\n",
+       "     'items': {'type': 'string'},\n",
+       "     'description': 'Other general skills the candidate is proficient in, e.g. Data Engineering, Machine Learning, etc.'},\n",
+       "    'frameworks': {'type': 'array',\n",
+       "     'items': {'type': 'string'},\n",
+       "     'description': 'The tools/frameworks the candidate is proficient in, e.g. React, Django, PyTorch, etc.'},\n",
+       "    'programming_languages': {'type': 'array',\n",
+       "     'items': {'type': 'string'},\n",
+       "     'description': 'The programming languages the candidate is proficient in.'}},\n",
+       "   'description': \"The candidate's technical skills\",\n",
+       "   'additionalProperties': False},\n",
+       "  'key_accomplishments': {'type': 'string',\n",
+       "   'description': 'Summarize the candidates highest achievements.'}},\n",
+       " 'additionalProperties': False}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "agent = llama_extract.get_agent(\"resume-screening\")\n",
+    "agent.data_schema  # Latest schema should be returned"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Queueing extractions"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "For multiple resumes, we can use the `queue_extraction` method to run extractions asynchronously. This is ideal for processing batch extraction jobs."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "Uploading files: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 3/3 [00:01<00:00,  2.13it/s]\n",
+      "Creating extraction jobs: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 3/3 [00:00<00:00,  5.83it/s]\n"
+     ]
+    }
+   ],
+   "source": [
+    "import os\n",
+    "\n",
+    "# All resumes in the data/resumes directory\n",
+    "resumes = []\n",
+    "\n",
+    "with os.scandir(\"./data/resumes\") as entries:\n",
+    "    for entry in entries:\n",
+    "        if entry.is_file():\n",
+    "            resumes.append(entry.path)\n",
+    "\n",
+    "jobs = await agent.queue_extraction(resumes)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "To get the latest status of the extractions for any `job_id`, we can use the `get_extraction_job` method. \n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[<StatusEnum.PENDING: 'PENDING'>,\n",
+       " <StatusEnum.PENDING: 'PENDING'>,\n",
+       " <StatusEnum.PENDING: 'PENDING'>]"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "[agent.get_extraction_job(job_id=job.id).status for job in jobs]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We notice that all extraction runs are in a PENDING state. We can check back again to see if the extractions have completed. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[<StatusEnum.SUCCESS: 'SUCCESS'>,\n",
+       " <StatusEnum.SUCCESS: 'SUCCESS'>,\n",
+       " <StatusEnum.SUCCESS: 'SUCCESS'>]"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "[agent.get_extraction_job(job_id=job.id).status for job in jobs]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Retrieving results\n",
+    "\n",
+    "Let us now retrieve the results of the extractions. If the status of the extraction is `SUCCESS`, we can retrieve the data from the `data` field. In case there are errors (status = `ERROR`), we can retrieve the error message from the `error` field. \n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "results = []\n",
+    "for job in jobs:\n",
+    "    extract_run = agent.get_extraction_run_for_job(job.id)\n",
+    "    if extract_run.status == \"SUCCESS\":\n",
+    "        results.append(extract_run.data)\n",
+    "    else:\n",
+    "        print(f\"Extraction status for job {job.id}: {extract_run.status}\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'name': 'Dr. Rachel Zhang, Ph.D.',\n",
+       " 'email': 'rachel.zhang@email.com',\n",
+       " 'links': ['linkedin.com/in/rachelzhang',\n",
+       "  'github.com/rzhang-ai',\n",
+       "  'scholar.google.com/rachelzhang'],\n",
+       " 'education': [{'degree': 'Ph.D. in Computer Science',\n",
+       "   'end_date': '2011',\n",
+       "   'start_date': '2007',\n",
+       "   'institution': 'Columbia University'},\n",
+       "  {'degree': 'M.S. in Computer Science',\n",
+       "   'end_date': '2007',\n",
+       "   'start_date': '2005',\n",
+       "   'institution': 'Stanford University'}],\n",
+       " 'experience': [{'title': 'Senior Research Scientist',\n",
+       "   'company': 'DeepMind',\n",
+       "   'end_date': None,\n",
+       "   'start_date': '2019',\n",
+       "   'description': '- Lead researcher on large-scale multi-task learning systems, developing novel architectures that improve cross-task generalization by 40%\\n- Pioneered new approach to zero-shot learning using contrastive training, published in NeurIPS 2023\\n- Built and led team of 6 researchers working on foundational ML models\\n- Developed novel regularization techniques for large language models, reducing catastrophic forgetting by 35%'},\n",
+       "  {'title': 'Research Scientist',\n",
+       "   'company': 'Google Research',\n",
+       "   'end_date': '2019',\n",
+       "   'start_date': '2015',\n",
+       "   'description': '- Developed probabilistic frameworks for robust ML, published in ICML 2018\\n- Created novel attention mechanisms for computer vision models, improving accuracy by 25%\\n- Led collaboration with Google Brain team on efficient training methods for transformer models\\n- Mentored 4 PhD interns and collaborated with academic institutions'},\n",
+       "  {'title': 'Research Assistant Professor',\n",
+       "   'company': 'Columbia University',\n",
+       "   'end_date': '2015',\n",
+       "   'start_date': '2011',\n",
+       "   'description': '- Published seminal work on Bayesian optimization methods (cited 1000+ times)\\n- Taught graduate-level courses in Machine Learning and Statistical Learning Theory\\n- Supervised 5 PhD students and 3 MSc students\\n- Secured $500K in research grants for probabilistic ML research'}],\n",
+       " 'technical_skills': {'skills': ['Deep Learning',\n",
+       "   'Reinforcement Learning',\n",
+       "   'Probabilistic Models',\n",
+       "   'Multi-Task Learning',\n",
+       "   'Zero-Shot Learning',\n",
+       "   'Neural Architecture Search'],\n",
+       "  'frameworks': ['PyTorch', 'TensorFlow', 'JAX', 'Ray'],\n",
+       "  'programming_languages': ['Python', 'C++', 'Julia', 'CUDA']},\n",
+       " 'key_accomplishments': 'AI researcher with 12+ years of experience spanning classical machine learning, deep learning, and probabilistic modeling. Led groundbreaking research in reinforcement learning, generative models, and multi-task learning. Published 25+ papers in top-tier conferences (NeurIPS, ICML, ICLR). Strong track record of transitioning theoretical advances into practical applications in both academic and industrial settings.'}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "results[0]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'name': 'Alex Park',\n",
+       " 'email': 'alex park@email.com',\n",
+       " 'links': ['linkedin.com/in/alexpark'],\n",
+       " 'education': [{'degree': 'M.S. Computer Science',\n",
+       "   'end_date': None,\n",
+       "   'start_date': None,\n",
+       "   'institution': 'University of California, Berkeley'},\n",
+       "  {'degree': 'B.S. Computer Science',\n",
+       "   'end_date': None,\n",
+       "   'start_date': None,\n",
+       "   'institution': 'University of California, Berkeley'}],\n",
+       " 'experience': [{'title': 'Senior Machine Learning Engineer',\n",
+       "   'company': 'SearchTech AI',\n",
+       "   'end_date': None,\n",
+       "   'start_date': None,\n",
+       "   'description': 'Led development of next-generation learning-to-rank system using BER\\nArchitected and deployed real-time personalization system processing 10\\nIncreasing CTR by 15%\\nImproving search relevance by 24% (NDCG@10)'},\n",
+       "  {'title': '',\n",
+       "   'company': 'Commerce Corp',\n",
+       "   'end_date': None,\n",
+       "   'start_date': None,\n",
+       "   'description': 'Developed semantic search system using transformer models and approximate nearest neighbors, reducing null search results by 35%'},\n",
+       "  {'title': 'Machine Learning Engineer',\n",
+       "   'company': 'Tech Solutions Inc',\n",
+       "   'end_date': None,\n",
+       "   'start_date': None,\n",
+       "   'description': 'Implemented query understanding pipeline'},\n",
+       "  {'title': 'Software Engineer',\n",
+       "   'company': '',\n",
+       "   'end_date': None,\n",
+       "   'start_date': None,\n",
+       "   'description': 'Built data pipelines and Flasticsearch'}],\n",
+       " 'technical_skills': {'skills': ['Elasticsearch',\n",
+       "   'Solr',\n",
+       "   'Lucene',\n",
+       "   'Python',\n",
+       "   'SQL',\n",
+       "   'Java',\n",
+       "   'Scala',\n",
+       "   'Shell Scripting'],\n",
+       "  'frameworks': ['PyTorch',\n",
+       "   'TensorFlow',\n",
+       "   'Scikit-learn',\n",
+       "   'BERT',\n",
+       "   'Word2Vec',\n",
+       "   'FastAI',\n",
+       "   'BM25',\n",
+       "   'FAISS',\n",
+       "   'Docker',\n",
+       "   'Kubernetes'],\n",
+       "  'programming_languages': []},\n",
+       " 'key_accomplishments': 'Machine Learning Engineer with 5 years of experience building and deploying large-scale search and relevance systems: Specialized in developing personalized search algorithms, learning-to-rank models; and recommendation systems. Strong track record of improving search relevance metrics and user engagement through ML-driven solutions:'}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "results[1]"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'name': 'Sarah Chen',\n",
+       " 'email': 'sarah.chen@email.com',\n",
+       " 'links': [],\n",
+       " 'education': [{'degree': 'Master of Science in Computer Science',\n",
+       "   'end_date': '2013',\n",
+       "   'start_date': None,\n",
+       "   'institution': 'Stanford University'},\n",
+       "  {'degree': 'Bachelor of Science in Computer Engineering',\n",
+       "   'end_date': '2011',\n",
+       "   'start_date': None,\n",
+       "   'institution': 'University of California, Berkeley'}],\n",
+       " 'experience': [{'title': 'Senior Software Architect',\n",
+       "   'company': 'TechCorp Solutions',\n",
+       "   'end_date': None,\n",
+       "   'start_date': '2020',\n",
+       "   'description': '- Led architectural design and implementation of a cloud-native platform serving 2M+ users\\n- Established architectural guidelines and best practices adopted across 12 development teams\\n- Reduced system latency by 40% through implementation of event-driven architecture\\n- Mentored 15+ senior developers in cloud-native development practices'},\n",
+       "  {'title': 'Lead Software Engineer',\n",
+       "   'company': 'DataFlow Systems',\n",
+       "   'end_date': '2020',\n",
+       "   'start_date': '2016',\n",
+       "   'description': '- Architected and led development of distributed data processing platform handling 5TB daily\\n- Designed microservices architecture reducing deployment time by 65%\\n- Led migration of legacy monolith to cloud-native architecture\\n- Managed team of 8 engineers across 3 international locations'},\n",
+       "  {'title': 'Senior Software Engineer',\n",
+       "   'company': 'InnovateTech',\n",
+       "   'end_date': '2016',\n",
+       "   'start_date': '2013',\n",
+       "   'description': '- Developed high-performance trading platform processing 100K transactions per second\\n- Implemented real-time analytics engine reducing processing latency by 75%\\n- Led adoption of container orchestration reducing deployment costs by 35%'}],\n",
+       " 'technical_skills': {'skills': ['Architecture & Design',\n",
+       "   'Microservices',\n",
+       "   'Event-Driven Architecture',\n",
+       "   'Domain-Driven Design',\n",
+       "   'REST APIs',\n",
+       "   'Cloud Platforms'],\n",
+       "  'frameworks': ['AWS (Advanced)', 'Azure', 'Google Cloud Platform'],\n",
+       "  'programming_languages': ['Java', 'Python', 'Go', 'JavaScript/TypeScript']},\n",
+       " 'key_accomplishments': '- Co-inventor on three patents for distributed systems architecture\\n- Published paper on \"Scalable Microservices Architecture\" at IEEE Cloud Computing Conference 2022\\n- Keynote Speaker, CloudCon 2023: \"Future of Cloud-Native Architecture\"\\n- Regular presenter at local tech meetups and conferences'}"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "results[2]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Congratulations! You now have an agent that can extract structured data from resumes. \n",
+    "- You can now use this agent to extract data from more resumes and use the extracted data for further processing. \n",
+    "- To update the schema, you can simply update the `data_schema` attribute of the agent and re-run the extraction. \n",
+    "- You can also use the `save` method to save the state of the agent and persist changes to the schema for future use. \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"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/extract/solar_panel_e2e_comparison.ipynb

@@ -0,0 +1,450 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "00f6713b-2a32-4f8f-80e5-9a7d9b6e3b90",
+   "metadata": {},
+   "source": [
+    "# Solar Panel Datasheet Comparison Workflow\n",
+    "\n",
+    "<a href=\"https://colab.research.google.com/github/run-llama/llama_cloud_services/blob/main/examples/extract/solar_panel_e2e_comparison.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
+    "\n",
+    "\n",
+    "This notebook demonstrates an end‑to‑end agentic workflow using LlamaExtract and the LlamaIndex event‑driven workflow framework. In this workflow, we:\n",
+    "\n",
+    "1. **Extract** structured technical specifications from a solar panel datasheet (e.g. a PDF downloaded from a vendor).\n",
+    "2. **Load** design requirements (provided as a text blob) for a lab‑grade solar panel.\n",
+    "3. **Generate** a detailed comparison report by triggering an event that injects both the extracted data and the requirements into an LLM prompt.\n",
+    "\n",
+    "The workflow is designed for renewable energy engineers who need to quickly validate that a solar panel meets specific design criteria.\n",
+    "\n",
+    "The following notebook uses the event‑driven syntax (with custom events, steps, and a workflow class) adapted from the technical datasheet and contract review examples."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "36d8e34e-ed98-46ac-b744-1642f6e253d5",
+   "metadata": {},
+   "source": [
+    "## Setup and Load Data\n",
+    "\n",
+    "We download the [Honey M TSM-DE08M.08(II) datasheet](https://static.trinasolar.com/sites/default/files/EU_Datasheet_HoneyM_DE08M.08%28II%29_2021_A.pdf) as a PDF.\n",
+    "\n",
+    "**NOTE**: The design requirements are already stored in `data/solar_panel_e2e_comparison/design_reqs.txt`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1de7b1b3-c285-492c-8b2e-b37974b4fc63",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "--2025-04-01 14:47:56--  https://static.trinasolar.com/sites/default/files/EU_Datasheet_HoneyM_DE08M.08%28II%29_2021_A.pdf\n",
+      "Resolving static.trinasolar.com (static.trinasolar.com)... 47.246.23.232, 47.246.23.234, 47.246.23.227, ...\n",
+      "Connecting to static.trinasolar.com (static.trinasolar.com)|47.246.23.232|:443... connected.\n",
+      "WARNING: cannot verify static.trinasolar.com's certificate, issued by ‘CN=DigiCert Global G2 TLS RSA SHA256 2020 CA1,O=DigiCert Inc,C=US’:\n",
+      "  Unable to locally verify the issuer's authority.\n",
+      "HTTP request sent, awaiting response... 200 OK\n",
+      "Length: 1888183 (1.8M) [application/pdf]\n",
+      "Saving to: ‘data/solar_panel_e2e_comparison/datasheet.pdf’\n",
+      "\n",
+      "data/solar_panel_e2 100%[===================>]   1.80M  7.47MB/s    in 0.2s    \n",
+      "\n",
+      "2025-04-01 14:47:56 (7.47 MB/s) - ‘data/solar_panel_e2e_comparison/datasheet.pdf’ saved [1888183/1888183]\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "!wget https://static.trinasolar.com/sites/default/files/EU_Datasheet_HoneyM_DE08M.08%28II%29_2021_A.pdf -O data/solar_panel_e2e_comparison/datasheet.pdf --no-check-certificate"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "89d2f4c9-f785-424d-a409-3381796c457c",
+   "metadata": {},
+   "source": [
+    "## Define the Structured Extraction Schema\n",
+    "\n",
+    "We define a new, rich schema called `SolarPanelSchema` to capture key technical details from the datasheet. This schema includes:\n",
+    "\n",
+    "- **PowerRange:** Structured as minimum and maximum power output (in Watts).\n",
+    "- **SolarPanelSpec:** Includes module name, power output range, maximum efficiency, certifications, and a mapping of page citations.\n",
+    "\n",
+    "This schema replaces the earlier LM317 schema and will be used when creating our extraction agent."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "bfb40d48-36e0-4b1c-97a1-32a1704c582b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from pydantic import BaseModel, Field\n",
+    "from typing import List\n",
+    "\n",
+    "\n",
+    "class PowerRange(BaseModel):\n",
+    "    min_power: float = Field(..., description=\"Minimum power output in Watts\")\n",
+    "    max_power: float = Field(..., description=\"Maximum power output in Watts\")\n",
+    "    unit: str = Field(\"W\", description=\"Power unit\")\n",
+    "\n",
+    "\n",
+    "class SolarPanelSpec(BaseModel):\n",
+    "    module_name: str = Field(..., description=\"Name or model of the solar panel module\")\n",
+    "    power_output: PowerRange = Field(..., description=\"Power output range\")\n",
+    "    maximum_efficiency: float = Field(\n",
+    "        ..., description=\"Maximum module efficiency in percentage\"\n",
+    "    )\n",
+    "    temperature_coefficient: float = Field(\n",
+    "        ..., description=\"Temperature coefficient in %/°C\"\n",
+    "    )\n",
+    "    certifications: List[str] = Field([], description=\"List of certifications\")\n",
+    "    page_citations: dict = Field(\n",
+    "        ..., description=\"Mapping of each extracted field to its page numbers\"\n",
+    "    )\n",
+    "\n",
+    "\n",
+    "class SolarPanelSchema(BaseModel):\n",
+    "    specs: List[SolarPanelSpec] = Field(\n",
+    "        ..., description=\"List of extracted solar panel specifications\"\n",
+    "    )"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "19dc309e-7cec-43c1-8f6c-72e14df58f8f",
+   "metadata": {},
+   "source": [
+    "## Initialize Extraction Agent\n",
+    "\n",
+    "Here we initialize our extraction agent that will be responsible for extracting the schema from the solar panel datasheet."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "c9d9f4a2-2e14-493d-8a7e-d01159d38b8f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from dotenv import load_dotenv\n",
+    "from llama_cloud_services import LlamaExtract\n",
+    "from llama_cloud.core.api_error import ApiError\n",
+    "from llama_cloud import ExtractConfig\n",
+    "\n",
+    "# Initialize the LlamaExtract client\n",
+    "llama_extract = LlamaExtract(\n",
+    "    project_id=\"2fef999e-1073-40e6-aeb3-1f3c0e64d99b\",\n",
+    "    organization_id=\"43b88c8f-e488-46f6-9013-698e3d2e374a\",\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ec0eb2a7-6e02-45da-a6af-227e2f7c81f2",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "try:\n",
+    "    existing_agent = llama_extract.get_agent(name=\"solar-panel-datasheet\")\n",
+    "    if existing_agent:\n",
+    "        llama_extract.delete_agent(existing_agent.id)\n",
+    "except ApiError as e:\n",
+    "    if e.status_code == 404:\n",
+    "        pass\n",
+    "    else:\n",
+    "        raise\n",
+    "\n",
+    "extract_config = ExtractConfig(\n",
+    "    extraction_mode=\"BALANCED\",\n",
+    ")\n",
+    "\n",
+    "agent = llama_extract.create_agent(\n",
+    "    name=\"solar-panel-datasheet\", data_schema=SolarPanelSchema, config=extract_config\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b4d7bb60-0456-4a2d-8d48-14f9bb3e71d2",
+   "metadata": {},
+   "source": [
+    "## Workflow Overview\n",
+    "\n",
+    "The workflow consists of four main steps:\n",
+    "\n",
+    "1. **parse_datasheet:** Reads the solar panel datasheet (PDF) and converts its content into text (with page citations).\n",
+    "2. **load_requirements:** Loads the design requirements (as a text blob) that will be injected into the prompt.\n",
+    "3. **generate_comparison_report:** Constructs a prompt using the extracted datasheet content and design requirements and triggers the LLM to generate a comparison report.\n",
+    "4. **output_result:** Logs and returns the final report as the workflow’s result.\n",
+    "\n",
+    "Each step is implemented as an asynchronous function decorated with `@step`, and the workflow is built by subclassing `Workflow`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "7c482e3a-66b4-4e1b-8d2d-9a9c6b3967f3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from llama_index.core.workflow import (\n",
+    "    Event,\n",
+    "    StartEvent,\n",
+    "    StopEvent,\n",
+    "    Context,\n",
+    "    Workflow,\n",
+    "    step,\n",
+    ")\n",
+    "from llama_index.llms.openai import OpenAI\n",
+    "from llama_index.core.prompts import ChatPromptTemplate\n",
+    "from llama_cloud_services import LlamaExtract\n",
+    "from llama_cloud.core.api_error import ApiError\n",
+    "from pydantic import BaseModel, Field\n",
+    "from typing import List\n",
+    "\n",
+    "\n",
+    "# Define output schema for the comparison report (for reference)\n",
+    "class ComparisonReportOutput(BaseModel):\n",
+    "    component_name: str = Field(\n",
+    "        ..., description=\"The name of the component being evaluated.\"\n",
+    "    )\n",
+    "    meets_requirements: bool = Field(\n",
+    "        ...,\n",
+    "        description=\"Overall indicator of whether the component meets the design criteria.\",\n",
+    "    )\n",
+    "    summary: str = Field(..., description=\"A brief summary of the evaluation results.\")\n",
+    "    details: dict = Field(\n",
+    "        ..., description=\"Detailed comparisons for each key parameter.\"\n",
+    "    )\n",
+    "\n",
+    "\n",
+    "# Define custom events\n",
+    "\n",
+    "\n",
+    "class DatasheetParseEvent(Event):\n",
+    "    datasheet_content: dict\n",
+    "\n",
+    "\n",
+    "class RequirementsLoadEvent(Event):\n",
+    "    requirements_text: str\n",
+    "\n",
+    "\n",
+    "class ComparisonReportEvent(Event):\n",
+    "    report: ComparisonReportOutput\n",
+    "\n",
+    "\n",
+    "class LogEvent(Event):\n",
+    "    msg: str\n",
+    "    delta: bool = False\n",
+    "\n",
+    "\n",
+    "# For our demonstration, we assume that LlamaExtract is used to parse the datasheet into text.\n",
+    "# We'll also use OpenAI (via LlamaIndex) as our LLM for generating the report.\n",
+    "\n",
+    "llm = OpenAI(model=\"gpt-4o\")  # or your preferred model"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "67a0c391-c7f5-4b93-8d6b-9e31b2d7a817",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "class SolarPanelComparisonWorkflow(Workflow):\n",
+    "    \"\"\"\n",
+    "    Workflow to extract data from a solar panel datasheet and generate a comparison report\n",
+    "    against provided design requirements.\n",
+    "    \"\"\"\n",
+    "\n",
+    "    def __init__(self, agent: LlamaExtract, requirements_path: str, **kwargs):\n",
+    "        super().__init__(**kwargs)\n",
+    "        self.agent = agent\n",
+    "        # Load design requirements from file as a text blob\n",
+    "        with open(requirements_path, \"r\") as f:\n",
+    "            self.requirements_text = f.read()\n",
+    "\n",
+    "    @step\n",
+    "    async def parse_datasheet(\n",
+    "        self, ctx: Context, ev: StartEvent\n",
+    "    ) -> DatasheetParseEvent:\n",
+    "        # datasheet_path is provided in the StartEvent\n",
+    "        datasheet_path = (\n",
+    "            ev.datasheet_path\n",
+    "        )  # e.g., \"./data/solar_panel_comparison/datasheet.pdf\"\n",
+    "        extraction_result = await self.agent.aextract(datasheet_path)\n",
+    "        datasheet_dict = (\n",
+    "            extraction_result.data\n",
+    "        )  # assumed to be a string with page citations\n",
+    "        await ctx.set(\"datasheet_content\", datasheet_dict)\n",
+    "        ctx.write_event_to_stream(LogEvent(msg=\"Datasheet parsed successfully.\"))\n",
+    "        return DatasheetParseEvent(datasheet_content=datasheet_dict)\n",
+    "\n",
+    "    @step\n",
+    "    async def load_requirements(\n",
+    "        self, ctx: Context, ev: DatasheetParseEvent\n",
+    "    ) -> RequirementsLoadEvent:\n",
+    "        # Use the pre-loaded requirements text from __init__\n",
+    "        req_text = self.requirements_text\n",
+    "        ctx.write_event_to_stream(LogEvent(msg=\"Design requirements loaded.\"))\n",
+    "        return RequirementsLoadEvent(requirements_text=req_text)\n",
+    "\n",
+    "    @step\n",
+    "    async def generate_comparison_report(\n",
+    "        self, ctx: Context, ev: RequirementsLoadEvent\n",
+    "    ) -> StopEvent:\n",
+    "        # Build a prompt that injects both the extracted datasheet content and the design requirements\n",
+    "        datasheet_content = await ctx.get(\"datasheet_content\")\n",
+    "        prompt_str = \"\"\"\n",
+    "You are an expert renewable energy engineer.\n",
+    "\n",
+    "Compare the following solar panel datasheet information with the design requirements.\n",
+    "\n",
+    "Design Requirements:\n",
+    "{requirements_text}\n",
+    "\n",
+    "Extracted Datasheet Information:\n",
+    "{datasheet_content}\n",
+    "\n",
+    "Generate a detailed comparison report in JSON format with the following schema:\n",
+    "  - component_name: string\n",
+    "  - meets_requirements: boolean\n",
+    "  - summary: string\n",
+    "  - details: dictionary of comparisons for each parameter\n",
+    "\n",
+    "For each parameter (Maximum Power, Open-Circuit Voltage, Short-Circuit Current, Efficiency, Temperature Coefficient),\n",
+    "indicate PASS or FAIL and provide brief explanations and recommendations.\n",
+    "\"\"\"\n",
+    "\n",
+    "        # extract from contract\n",
+    "        prompt = ChatPromptTemplate.from_messages([(\"user\", prompt_str)])\n",
+    "\n",
+    "        # Call the LLM to generate the report using the prompt\n",
+    "        report_output = await llm.astructured_predict(\n",
+    "            ComparisonReportOutput,\n",
+    "            prompt,\n",
+    "            requirements_text=ev.requirements_text,\n",
+    "            datasheet_content=str(datasheet_content),\n",
+    "        )\n",
+    "        ctx.write_event_to_stream(LogEvent(msg=\"Comparison report generated.\"))\n",
+    "        return StopEvent(\n",
+    "            result={\"report\": report_output, \"datasheet_content\": datasheet_content}\n",
+    "        )"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "d205f532-1a11-4a48-b5a8-87a7f85e9ce7",
+   "metadata": {},
+   "source": [
+    "## Running the Workflow\n",
+    "\n",
+    "Below, we instantiate and run the workflow. We inject the design requirements as a text blob (no custom code to load) and pass the path to the solar panel datasheet (the HoneyM datasheet from Trina).\n",
+    "\n",
+    "The design requirements are:\n",
+    "\n",
+    "```\n",
+    "Solar Panel Design Requirements:\n",
+    "- Power Output Range: ≥ 350 W\n",
+    "- Maximum Efficiency: ≥ 18%\n",
+    "- Certifications: Must include IEC61215 and UL1703\n",
+    "```\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "6b24fa61-a2f5-4ebb-84eb-1c9b48683b1b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import nest_asyncio\n",
+    "\n",
+    "nest_asyncio.apply()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "be3ebad5-1f70-4671-a2ec-17bf9e4d788f",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Path to design requirements file (e.g., a text file with design criteria for solar panels)\n",
+    "requirements_path = \"./data/solar_panel_e2e_comparison/design_reqs.txt\"\n",
+    "\n",
+    "# Instantiate the workflow\n",
+    "workflow = SolarPanelComparisonWorkflow(\n",
+    "    agent=agent, requirements_path=requirements_path, verbose=True, timeout=120\n",
+    ")\n",
+    "\n",
+    "# Run the workflow; pass the datasheet path in the StartEvent\n",
+    "result = await workflow.run(\n",
+    "    datasheet_path=\"./data/solar_panel_e2e_comparison/datasheet.pdf\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "e1e61f1e-8701-4acc-8f99-cc89d8aae535",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "********Final Comparison Report:********\n",
+      "\n",
+      "{\n",
+      "    \"component_name\": \"TSM-DE08M.08(II)\",\n",
+      "    \"meets_requirements\": true,\n",
+      "    \"summary\": \"The solar panel TSM-DE08M.08(II) meets all the design requirements, making it a suitable choice for the intended application.\",\n",
+      "    \"details\": {\n",
+      "        \"Maximum Power Output\": \"PASS - The panel's power output ranges from 360 W to 385 W, exceeding the minimum requirement of 350 W.\",\n",
+      "        \"Open-Circuit Voltage\": \"PASS - The datasheet does not specify Voc, but the panel meets other critical requirements. Verification of Voc is recommended.\",\n",
+      "        \"Short-Circuit Current\": \"PASS - The datasheet does not specify Isc, but the panel meets other critical requirements. Verification of Isc is recommended.\",\n",
+      "        \"Efficiency\": \"PASS - The panel's efficiency is 21.0%, which is above the required 18%.\",\n",
+      "        \"Temperature Coefficient\": \"PASS - The temperature coefficient is -0.34%/°C, which is better than the maximum allowable -0.5%/°C.\"\n",
+      "    }\n",
+      "}\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(\"\\n********Final Comparison Report:********\\n\")\n",
+    "print(result[\"report\"].model_dump_json(indent=4))\n",
+    "# print(\"\\n********Datasheet Content:********\\n\", result[\"datasheet_content\"])"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "llama_parse",
+   "language": "python",
+   "name": "llama_parse"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

examples/misc/parse_classify_extract_workflow.ipynb

@@ -0,0 +1,765 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Complete Parse → Classify → Extract Workflow with LlamaCloud Services\n",
+    "\n",
+    "This notebook demonstrates the complete workflow for processing documents using LlamaCloud services:\n",
+    "1. **Parse** - Extract and convert documents to markdown\n",
+    "2. **Classify** - Categorize documents based on their content\n",
+    "3. **Extract** - Extract structured data using the markdown as input via SourceText\n",
+    "\n",
+    "## Overview of the Workflow\n",
+    "\n",
+    "### 1. Parse Phase\n",
+    "- Use `LlamaParse` to convert documents (PDFs, Word docs, etc.) into structured formats\n",
+    "- Extract markdown content that preserves document structure\n",
+    "- Get both raw text and markdown representations\n",
+    "\n",
+    "### 2. Classify Phase\n",
+    "- Use `ClassifyClient` to categorize documents based on content\n",
+    "- Apply classification rules to route documents appropriately\n",
+    "- Handle different document types with specific processing logic\n",
+    "\n",
+    "### 3. Extract Phase\n",
+    "- Use `LlamaExtract` with `SourceText` to extract structured data\n",
+    "- Pass the markdown content as input for more accurate extraction\n",
+    "- Define custom schemas for structured data extraction\n",
+    "\n",
+    "Let's walk through each step with practical examples."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Setup and Installation"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Install required packages\n",
+    "!pip install llama-cloud-services\n",
+    "!pip install python-dotenv"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "✅ API key configured\n"
+     ]
+    }
+   ],
+   "source": [
+    "import os\n",
+    "import nest_asyncio\n",
+    "from getpass import getpass\n",
+    "from dotenv import load_dotenv\n",
+    "\n",
+    "# Load environment variables\n",
+    "load_dotenv()\n",
+    "nest_asyncio.apply()\n",
+    "\n",
+    "# Set up API key\n",
+    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"\"  # edit it\n",
+    "\n",
+    "# Setup Base URL\n",
+    "# os.envrion[\"LLAMA_CLOUD_BASE_URL\"] = \"https://api.cloud.eu.llamaindex.ai/\" # update if necessay\n",
+    "\n",
+    "print(\"✅ API key configured\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Download Sample Documents\n",
+    "\n",
+    "Let's download some sample documents to work with:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "📁 financial_report.pdf already exists\n",
+      "📁 technical_spec.pdf already exists\n",
+      "\n",
+      "📂 Sample documents ready!\n"
+     ]
+    }
+   ],
+   "source": [
+    "import requests\n",
+    "import os\n",
+    "\n",
+    "# Create directory for sample documents\n",
+    "os.makedirs(\"sample_docs\", exist_ok=True)\n",
+    "\n",
+    "# Download sample documents\n",
+    "docs_to_download = {\n",
+    "    \"financial_report.pdf\": \"https://raw.githubusercontent.com/run-llama/llama_index/main/docs/docs/examples/data/10k/uber_2021.pdf\",\n",
+    "    \"technical_spec.pdf\": \"https://www.ti.com/lit/ds/symlink/lm317.pdf\",\n",
+    "}\n",
+    "\n",
+    "for filename, url in docs_to_download.items():\n",
+    "    filepath = f\"sample_docs/{filename}\"\n",
+    "    if not os.path.exists(filepath):\n",
+    "        print(f\"Downloading {filename}...\")\n",
+    "        response = requests.get(url)\n",
+    "        if response.status_code == 200:\n",
+    "            with open(filepath, \"wb\") as f:\n",
+    "                f.write(response.content)\n",
+    "            print(f\"✅ Downloaded {filename}\")\n",
+    "        else:\n",
+    "            print(f\"❌ Failed to download {filename}\")\n",
+    "    else:\n",
+    "        print(f\"📁 {filename} already exists\")\n",
+    "\n",
+    "print(\"\\n📂 Sample documents ready!\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Phase 1: Document Parsing\n",
+    "\n",
+    "First, let's parse our documents using LlamaParse to extract clean markdown content."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "🔄 Parsing documents...\n",
+      "Started parsing the file under job_id 8a8c76f9-354d-4275-91d8-312ff1adc762\n",
+      "...✅ Parsed financial report (Job ID: 8a8c76f9-354d-4275-91d8-312ff1adc762)\n",
+      "Started parsing the file under job_id 7e603448-ed80-4d18-948b-6801ed51c41b\n",
+      "✅ Parsed technical spec (Job ID: 7e603448-ed80-4d18-948b-6801ed51c41b)\n",
+      "\n",
+      "📄 Parsing complete!\n"
+     ]
+    }
+   ],
+   "source": [
+    "from llama_cloud_services.parse.base import LlamaParse\n",
+    "from llama_cloud_services.parse.utils import ResultType\n",
+    "import asyncio\n",
+    "\n",
+    "# Initialize the parser\n",
+    "parser = LlamaParse(\n",
+    "    result_type=ResultType.MD,  # Get markdown output\n",
+    "    verbose=True,\n",
+    "    language=\"en\",\n",
+    "    # Premium mode for better accuracy\n",
+    "    premium_mode=True,\n",
+    "    # Extract tables as HTML for better structure\n",
+    "    output_tables_as_HTML=True,\n",
+    "    # Parse only first few pages for demo\n",
+    ")\n",
+    "\n",
+    "print(\"🔄 Parsing documents...\")\n",
+    "\n",
+    "# Parse the financial report\n",
+    "financial_result = await parser.aparse(\"sample_docs/financial_report.pdf\")\n",
+    "print(f\"✅ Parsed financial report (Job ID: {financial_result.job_id})\")\n",
+    "\n",
+    "# Parse the technical specification\n",
+    "technical_result = await parser.aparse(\"sample_docs/technical_spec.pdf\")\n",
+    "print(f\"✅ Parsed technical spec (Job ID: {technical_result.job_id})\")\n",
+    "\n",
+    "print(\"\\n📄 Parsing complete!\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Extract Markdown Content\n",
+    "\n",
+    "Now let's get the markdown content from our parsed documents:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "📋 Financial Report Markdown (first 500 chars):\n",
+      "\n",
+      "\n",
+      "# UNITED STATES\n",
+      "# SECURITIES AND EXCHANGE COMMISSION\n",
+      "Washington, D.C. 20549\n",
+      "\n",
+      "## FORM 10-K\n",
+      "\n",
+      "(Mark One)\n",
+      "\n",
+      "☒ ANNUAL REPORT PURSUANT TO SECTION 13 OR 15(d) OF THE SECURITIES EXCHANGE ACT OF 1934\n",
+      "For the fiscal year ended December 31, 2021\n",
+      "OR\n",
+      "☐ TRANSITION REPORT PURSUANT TO SECTION 13 OR 15(d) OF THE SECURITIES EXCHANGE ACT OF 1934\n",
+      "For the transition period from_____ to _____\n",
+      "Commission File Number: 001-38902\n",
+      "\n",
+      "# UBER TECHNOLOGIES, INC.\n",
+      "(Exact name of registrant as specified in its charter)\n",
+      "\n",
+      "Delaware\n",
+      "...\n",
+      "\n",
+      "📋 Technical Spec Markdown (first 500 chars):\n",
+      "\n",
+      "\n",
+      "LM317\n",
+      "SLVS044Z – SEPTEMBER 1997 – REVISED APRIL 2025\n",
+      "\n",
+      "# LM317 3-Pin Adjustable Regulator\n",
+      "\n",
+      "## 1 Features\n",
+      "\n",
+      "• Output voltage range:\n",
+      "  – Adjustable: 1.25V to 37V\n",
+      "• Output current: 1.5A\n",
+      "• Line regulation: 0.01%/V (typ)\n",
+      "• Load regulation: 0.1% (typ)\n",
+      "• Internal short-circuit current limiting\n",
+      "• Thermal overload protection\n",
+      "• Output safe-area compensation (new chip)\n",
+      "• PSRR: 80dB at 120Hz for CADJ = 10μF (new chip)\n",
+      "• Packages:\n",
+      "  – 4-pin, SOT-223 (DCY)\n",
+      "  – 3-pin, TO-263 (KTT)\n",
+      "  – 3-pin, TO-220 (KCS, KCT),\n",
+      "...\n",
+      "\n",
+      "📏 Financial report markdown length: 1348671 characters\n",
+      "📏 Technical spec markdown length: 90971 characters\n"
+     ]
+    }
+   ],
+   "source": [
+    "# Get markdown content from parsed documents\n",
+    "financial_markdown = await financial_result.aget_markdown()\n",
+    "technical_markdown = await technical_result.aget_markdown()\n",
+    "\n",
+    "print(\"📋 Financial Report Markdown (first 500 chars):\")\n",
+    "print(financial_markdown[:500])\n",
+    "print(\"...\\n\")\n",
+    "\n",
+    "print(\"📋 Technical Spec Markdown (first 500 chars):\")\n",
+    "print(technical_markdown[:500])\n",
+    "print(\"...\\n\")\n",
+    "\n",
+    "print(f\"📏 Financial report markdown length: {len(financial_markdown)} characters\")\n",
+    "print(f\"📏 Technical spec markdown length: {len(technical_markdown)} characters\")\n",
+    "\n",
+    "document_texts = [financial_markdown, technical_markdown]"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Phase 2: Document Classification\n",
+    "\n",
+    "Next, let's classify our documents based on their content using the ClassifyClient."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "🏷️  Setting up document classification...\n",
+      "📝 Created 3 classification rules\n"
+     ]
+    }
+   ],
+   "source": [
+    "from llama_cloud_services.beta.classifier.client import ClassifyClient\n",
+    "from llama_cloud.types import ClassifierRule\n",
+    "from llama_cloud_services.files.client import FileClient\n",
+    "from llama_cloud.client import AsyncLlamaCloud\n",
+    "\n",
+    "# Initialize the classify client\n",
+    "api_key = os.environ[\"LLAMA_CLOUD_API_KEY\"]\n",
+    "classify_client = ClassifyClient.from_api_key(api_key)\n",
+    "\n",
+    "print(\"🏷️  Setting up document classification...\")\n",
+    "\n",
+    "# Define classification rules\n",
+    "classification_rules = [\n",
+    "    ClassifierRule(\n",
+    "        type=\"financial_document\",\n",
+    "        description=\"Documents containing financial data, revenue, expenses, SEC filings, or financial statements\",\n",
+    "    ),\n",
+    "    ClassifierRule(\n",
+    "        type=\"technical_specification\",\n",
+    "        description=\"Technical datasheets, component specifications, engineering documents, or technical manuals\",\n",
+    "    ),\n",
+    "    ClassifierRule(\n",
+    "        type=\"general_document\",\n",
+    "        description=\"General business documents, contracts, or other unspecified document types\",\n",
+    "    ),\n",
+    "]\n",
+    "\n",
+    "print(f\"📝 Created {len(classification_rules)} classification rules\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Phase 3: Structured Data Extraction using SourceText\n",
+    "\n",
+    "Now comes the key part - using the markdown content as input for structured data extraction via SourceText."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "⚙️  LlamaExtract initialized\n"
+     ]
+    }
+   ],
+   "source": [
+    "from llama_cloud_services.extract.extract import LlamaExtract, SourceText\n",
+    "from llama_cloud.types import ExtractConfig, ExtractMode\n",
+    "from pydantic import BaseModel, Field\n",
+    "from typing import List, Optional\n",
+    "\n",
+    "# Initialize LlamaExtract\n",
+    "llama_extract = LlamaExtract(api_key=api_key, verbose=True)\n",
+    "\n",
+    "print(\"⚙️  LlamaExtract initialized\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Define Extraction Schemas\n",
+    "\n",
+    "Let's define different schemas for different document types:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "📋 Extraction schemas defined\n"
+     ]
+    }
+   ],
+   "source": [
+    "# Schema for financial documents\n",
+    "class FinancialMetrics(BaseModel):\n",
+    "    company_name: str = Field(description=\"Name of the company\")\n",
+    "    document_type: str = Field(\n",
+    "        description=\"Type of financial document (10-K, 10-Q, annual report, etc.)\"\n",
+    "    )\n",
+    "    fiscal_year: int = Field(description=\"Fiscal year of the report\")\n",
+    "    revenue_2021: str = Field(description=\"Total revenue in 2021\")\n",
+    "    net_income_2021: str = Field(description=\"Net income in 2021\")\n",
+    "    key_business_segments: List[str] = Field(\n",
+    "        default=[], description=\"Main business segments or divisions\"\n",
+    "    )\n",
+    "    risk_factors: List[str] = Field(\n",
+    "        default=[], description=\"Key risk factors mentioned\"\n",
+    "    )\n",
+    "\n",
+    "\n",
+    "# Schema for technical specifications\n",
+    "class VoltageRange(BaseModel):\n",
+    "    min_voltage: Optional[float] = Field(description=\"Minimum voltage\")\n",
+    "    max_voltage: Optional[float] = Field(description=\"Maximum voltage\")\n",
+    "    unit: str = Field(default=\"V\", description=\"Voltage unit\")\n",
+    "\n",
+    "\n",
+    "class TechnicalSpec(BaseModel):\n",
+    "    component_name: str = Field(description=\"Name of the technical component\")\n",
+    "    manufacturer: Optional[str] = Field(description=\"Manufacturer name\")\n",
+    "    part_number: Optional[str] = Field(description=\"Part or model number\")\n",
+    "    description: str = Field(description=\"Brief description of the component\")\n",
+    "    operating_voltage: Optional[VoltageRange] = Field(\n",
+    "        description=\"Operating voltage range\"\n",
+    "    )\n",
+    "    maximum_current: Optional[float] = Field(\n",
+    "        description=\"Maximum current rating in amperes\"\n",
+    "    )\n",
+    "    key_features: List[str] = Field(\n",
+    "        default=[], description=\"Key features and capabilities\"\n",
+    "    )\n",
+    "    applications: List[str] = Field(default=[], description=\"Typical applications\")\n",
+    "\n",
+    "\n",
+    "print(\"📋 Extraction schemas defined\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Complete Workflow Summary\n",
+    "\n",
+    "Let's create a function that demonstrates the complete workflow:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "🔧 Workflow function defined!\n"
+     ]
+    }
+   ],
+   "source": [
+    "import tempfile\n",
+    "from pathlib import Path\n",
+    "from llama_cloud import ExtractConfig\n",
+    "\n",
+    "\n",
+    "async def complete_document_workflow(markdown_content: str):\n",
+    "    \"\"\"\n",
+    "    Complete workflow: Parse → Classify → Extract\n",
+    "    \"\"\"\n",
+    "    print(f\"🚀 Starting complete workflow\")\n",
+    "    print(\"=\" * 60)\n",
+    "\n",
+    "    # Step 1: Classify\n",
+    "    print(\"🏷️  Step 2: Classifying document...\")\n",
+    "\n",
+    "    with tempfile.NamedTemporaryFile(\n",
+    "        mode=\"w\", suffix=\".md\", delete=False, encoding=\"utf-8\"\n",
+    "    ) as tmp:\n",
+    "        tmp.write(markdown_content)\n",
+    "        temp_path = Path(tmp.name)\n",
+    "\n",
+    "    print(temp_path)\n",
+    "\n",
+    "    classification = await classify_client.aclassify_file_path(\n",
+    "        rules=classification_rules, file_input_path=str(temp_path)\n",
+    "    )\n",
+    "    doc_type = classification.items[0].result.type\n",
+    "    confidence = classification.items[0].result.confidence\n",
+    "    print(f\"   ✅ Classified as: {doc_type} (confidence: {confidence:.2f})\")\n",
+    "\n",
+    "    # Step 2: Extract based on classification\n",
+    "    print(\"🔍 Step 3: Extracting structured data using SourceText...\")\n",
+    "    source_text = SourceText(\n",
+    "        text_content=markdown_content,\n",
+    "        filename=f\"{os.path.basename(temp_path)}_markdown.md\",\n",
+    "    )\n",
+    "\n",
+    "    # Choose schema based on classification\n",
+    "    if \"financial\" in doc_type.lower():\n",
+    "        schema = FinancialMetrics\n",
+    "        print(\"   📊 Using FinancialMetrics schema\")\n",
+    "    elif \"technical\" in doc_type.lower():\n",
+    "        schema = TechnicalSpec\n",
+    "        print(\"   🔧 Using TechnicalSpec schema\")\n",
+    "    else:\n",
+    "        schema = FinancialMetrics  # Default fallback\n",
+    "        print(\"   📊 Using default FinancialMetrics schema\")\n",
+    "\n",
+    "    extract_config = ExtractConfig(\n",
+    "        extraction_mode=\"BALANCED\",\n",
+    "    )\n",
+    "\n",
+    "    extraction_result = llama_extract.extract(\n",
+    "        data_schema=schema, config=extract_config, files=source_text\n",
+    "    )\n",
+    "\n",
+    "    print(\"   ✅ Extraction complete!\")\n",
+    "\n",
+    "    return {\n",
+    "        \"file_path\": temp_path,\n",
+    "        \"markdown_length\": len(markdown_content),\n",
+    "        \"classification\": doc_type,\n",
+    "        \"confidence\": confidence,\n",
+    "        \"extracted_data\": extraction_result.data,\n",
+    "        \"markdown_sample\": markdown_content[:200] + \"...\"\n",
+    "        if len(markdown_content) > 200\n",
+    "        else markdown_content,\n",
+    "    }\n",
+    "\n",
+    "\n",
+    "print(\"🔧 Workflow function defined!\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Run Complete Workflow on Both Documents"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "🚀 Starting complete workflow\n",
+      "============================================================\n",
+      "🏷️  Step 2: Classifying document...\n",
+      "/var/folders/g6/4b5lpp5974gcpr890ybhbw4r0000gn/T/tmpos3b62tm.md\n",
+      "   ✅ Classified as: financial_document (confidence: 1.00)\n",
+      "🔍 Step 3: Extracting structured data using SourceText...\n",
+      "   📊 Using FinancialMetrics schema\n",
+      "..   ✅ Extraction complete!\n",
+      "\n",
+      "============================================================\n",
+      "\n",
+      "🚀 Starting complete workflow\n",
+      "============================================================\n",
+      "🏷️  Step 2: Classifying document...\n",
+      "/var/folders/g6/4b5lpp5974gcpr890ybhbw4r0000gn/T/tmpppz9ub_m.md\n",
+      "   ✅ Classified as: technical_specification (confidence: 1.00)\n",
+      "🔍 Step 3: Extracting structured data using SourceText...\n",
+      "   🔧 Using TechnicalSpec schema\n",
+      "   ✅ Extraction complete!\n",
+      "\n",
+      "============================================================\n",
+      "\n",
+      "📋 Processed 2 documents successfully!\n"
+     ]
+    }
+   ],
+   "source": [
+    "# Process both documents through the complete workflow\n",
+    "results = []\n",
+    "\n",
+    "for doc_text in document_texts:\n",
+    "    try:\n",
+    "        result = await complete_document_workflow(doc_text)\n",
+    "        results.append(result)\n",
+    "        print(\"\\n\" + \"=\" * 60 + \"\\n\")\n",
+    "    except Exception as e:\n",
+    "        print(f\"❌ Error processing {doc_path}: {str(e)}\")\n",
+    "        print(\"\\n\" + \"=\" * 60 + \"\\n\")\n",
+    "\n",
+    "print(f\"📋 Processed {len(results)} documents successfully!\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Final Results Summary"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "📈 COMPLETE WORKFLOW RESULTS SUMMARY\n",
+      "======================================================================\n",
+      "\n",
+      "📄 Document 1: tmpos3b62tm.md\n",
+      "   📊 Classification: financial_document (confidence: 1.00)\n",
+      "   📝 Markdown length: 1,348,671 characters\n",
+      "   📋 Markdown sample: \n",
+      "\n",
+      "# UNITED STATES\n",
+      "# SECURITIES AND EXCHANGE COMMISSION\n",
+      "Washington, D.C. 20549\n",
+      "\n",
+      "## FORM 10-K\n",
+      "\n",
+      "(Mark O...\n",
+      "   🎯 Extracted fields: 7 fields\n",
+      "   • company_name: Uber Technologies, Inc.\n",
+      "   • document_type: Annual Report on Form 10-K\n",
+      "   • fiscal_year: 2021\n",
+      "   • revenue_2021: $21,764\n",
+      "   • net_income_2021: $(496)\n",
+      "   • key_business_segments: ['Mobility', 'Delivery', 'Freight', 'All Other (including former New Mobility, e-bikes, e-scooters, Advanced Technologies Group and other technology programs)']\n",
+      "   • risk_factors: [\"The company faces numerous risk factors across its business operations and environment. The COVID-19 pandemic and related mitigation measures have adversely affected parts of the business, including reduced demand for Mobility offerings and creating ongoing uncertainties. The company's operational and financial performance is influenced by competitive pressure in the mobility, delivery, and logistics industries, characterized by well-established alternatives, low barriers to entry, and low switching costs. Driver classification risks exist if Drivers are deemed employees, workers, or quasi-employees rather than independent contractors, exposing the company to legal actions and financial liabilities globally. Competition challenges require the company to sometimes lower fares, offer incentives, and promotions, which impacts profitability. There are significant operating losses historically with substantial future operating expense increases anticipated, and the ability to achieve or maintain profitability is uncertain. Network value depends on maintaining critical mass among Drivers, consumers, merchants, shippers, and carriers, and failures to do so diminish platform attractiveness. Brand and reputation maintenance is critical, with exposure to negative publicity, media coverage, and risks from associated companies' brands or licensed brands in joint ventures.\\n\\nOperational risks include historical workplace culture and compliance challenges, management complexity due to rapid growth, technological infrastructure issues potentially causing disruptions or poor user experience, and security or data privacy breaches that could impact revenue and reputation. Platform users may engage in or be subjected to criminal, violent, or dangerous activity leading to safety incidents and legal actions. New offerings and technologies investments are inherently risky without guaranteed benefits. Economic conditions, inflation, and increased costs (fuel, food, labor, energy) may negatively impact results. Regulatory risks are extensive and global, involving payment and financial services compliance, licensing, anti-money laundering laws, data privacy (GDPR, CCPA, LGPD), and labor laws. Legal and regulatory investigations and inquiries, including antitrust, FCPA, labor classification, data protection, and intellectual property matters, pose risks of fines, penalties, operational changes, and increased costs.\\n\\nGeopolitical and jurisdictional risks include operating limitations or bans in some locations, currency exchange risk, and complex evolving regulations with the potential for fines and loss of licenses or permits. Insurance risks include potential inadequacy of reserves, liability exposure from accidents or impersonation, and insurer insolvency. Driver qualification requirements and background checks may increase costs or fail to expose all relevant information, with associated insurance cost risks and potential for courtroom or regulatory challenges to pricing models.\\n\\nFinancial risks comprise significant accumulated deficits, requirement for additional capital with uncertain availability, debt obligations, tax exposure including uncertain positions and observed changes in tax laws, and volatility in common stock price with no expected cash dividends. Accounting judgments and estimates involve critical assumptions affecting reported financial metrics related to goodwill, revenue recognition, incentive accruals, and stock-based compensation. Cybersecurity risks include exposures to malware, ransomware, phishing, and other cyberattacks. Climate change presents physical and transitional risks that may impact operations and costs, and failure to meet climate commitments may have operational and reputational consequences.\\n\\nOther risks include potential liability under anti-corruption and anti-terrorism laws, adverse effects from defaults under debt agreements, limitations in takeover actions due to corporate governance provisions, and the impact of non-GAAP financial measure limitations. Overall, these diverse and interconnected risk factors contribute to significant uncertainty regarding the company's future business prospects, operating results, and financial condition.\"]\n",
+      "\n",
+      "📄 Document 2: tmpppz9ub_m.md\n",
+      "   📊 Classification: technical_specification (confidence: 1.00)\n",
+      "   📝 Markdown length: 90,971 characters\n",
+      "   📋 Markdown sample: \n",
+      "\n",
+      "LM317\n",
+      "SLVS044Z – SEPTEMBER 1997 – REVISED APRIL 2025\n",
+      "\n",
+      "# LM317 3-Pin Adjustable Regulator\n",
+      "\n",
+      "## 1 Fea...\n",
+      "   🎯 Extracted fields: 8 fields\n",
+      "   • component_name: LM317\n",
+      "   • manufacturer: Texas Instruments\n",
+      "   • part_number: LM317\n",
+      "   • description: The LM317 is an adjustable three-pin, positive-voltage regulator capable of supplying up to 1.5A over an output voltage range of 1.25V to 37V. It features line and load regulation, internal current limiting, thermal overload protection, and safe operating area compensation.\n",
+      "   • operating_voltage: {'min_voltage': 1.25, 'max_voltage': 37.0, 'unit': 'V'}\n",
+      "   • maximum_current: 1.5\n",
+      "   • key_features: ['Adjustable output voltage: 1.25V to 37V', 'Output current up to 1.5A', 'Line regulation: 0.01%/V (typical)', 'Load regulation: 0.1% (typical)', 'Internal short-circuit current limiting', 'Thermal overload protection', 'Output safe-area compensation', 'High power supply rejection ratio (PSRR): 80dB at 120Hz (new chip)', 'Available in SOT-223, TO-263, and TO-220 packages']\n",
+      "   • applications: ['Multifunction printers', 'AC drive power stage modules', 'Electricity meters', 'Servo drive control modules', 'Merchant network and server power supply units']\n",
+      "\n",
+      "✨ Workflow completed successfully!\n",
+      "\n",
+      "📚 Key Learnings:\n",
+      "   • Parse: Converted documents to clean markdown format\n",
+      "   • Classify: Automatically categorized document types\n",
+      "   • Extract: Used SourceText with markdown for structured data extraction\n",
+      "   • The markdown content provides much better context for extraction than raw PDFs\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(\"📈 COMPLETE WORKFLOW RESULTS SUMMARY\")\n",
+    "print(\"=\" * 70)\n",
+    "\n",
+    "for i, result in enumerate(results, 1):\n",
+    "    print(f\"\\n📄 Document {i}: {os.path.basename(result['file_path'])}\")\n",
+    "    print(\n",
+    "        f\"   📊 Classification: {result['classification']} (confidence: {result['confidence']:.2f})\"\n",
+    "    )\n",
+    "    print(f\"   📝 Markdown length: {result['markdown_length']:,} characters\")\n",
+    "    print(f\"   📋 Markdown sample: {result['markdown_sample'][:100]}...\")\n",
+    "    print(f\"   🎯 Extracted fields: {len(result['extracted_data'])} fields\")\n",
+    "\n",
+    "    # Print all key–value pairs\n",
+    "    extracted = result[\"extracted_data\"]\n",
+    "    for key, value in extracted.items():\n",
+    "        print(f\"   • {key}: {value}\")\n",
+    "\n",
+    "print(\"\\n✨ Workflow completed successfully!\")\n",
+    "print(\"\\n📚 Key Learnings:\")\n",
+    "print(\"   • Parse: Converted documents to clean markdown format\")\n",
+    "print(\"   • Classify: Automatically categorized document types\")\n",
+    "print(\"   • Extract: Used SourceText with markdown for structured data extraction\")\n",
+    "print(\n",
+    "    \"   • The markdown content provides much better context for extraction than raw PDFs\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Conclusion\n",
+    "\n",
+    "This notebook demonstrated the complete **Parse → Classify → Extract** workflow using LlamaCloud services:\n",
+    "\n",
+    "### Key Components:\n",
+    "\n",
+    "1. **LlamaParse** (`llama_cloud_services.parse.base.LlamaParse`):\n",
+    "   - Converts documents to clean, structured markdown\n",
+    "   - Preserves document structure and formatting\n",
+    "   - Handles various file types (PDF, DOCX, etc.)\n",
+    "\n",
+    "2. **ClassifyClient** (`llama_cloud_services.beta.classifier.client.ClassifyClient`):\n",
+    "   - Automatically categorizes documents based on content\n",
+    "   - Uses customizable rules for classification\n",
+    "   - Provides confidence scores for classifications\n",
+    "\n",
+    "3. **LlamaExtract with SourceText** (`llama_cloud_services.extract.extract.LlamaExtract`, `SourceText`):\n",
+    "   - Extracts structured data using custom Pydantic schemas\n",
+    "   - **SourceText** allows using markdown content as input instead of raw files\n",
+    "   - Provides much better extraction accuracy when using processed markdown\n",
+    "\n",
+    "### Workflow Benefits:\n",
+    "\n",
+    "- **Better Accuracy**: Using markdown from parsing provides cleaner, more structured input for extraction\n",
+    "- **Automatic Routing**: Classification allows different processing logic for different document types\n",
+    "- **Structured Output**: Custom schemas ensure consistent, structured data extraction\n",
+    "- **Flexible Input**: SourceText supports text content, file paths, and bytes\n",
+    "\n",
+    "### Key Insights:\n",
+    "\n",
+    "1. **SourceText is the bridge**: It allows you to pass the clean markdown content from parsing directly to extraction\n",
+    "2. **Markdown improves extraction**: Pre-processed markdown provides much better context than raw PDFs\n",
+    "3. **Classification enables smart routing**: Different document types can use different extraction schemas\n",
+    "4. **End-to-end automation**: The entire workflow can be automated for production use\n",
+    "\n",
+    "This approach is ideal for production document processing pipelines where you need to:\n",
+    "- Process various document types automatically\n",
+    "- Extract structured data consistently\n",
+    "- Maintain high accuracy and reliability\n",
+    "- Handle documents at scale\n",
+    "\n",
+    "The combination of these three services provides a powerful, flexible document processing pipeline that can handle complex, real-world document processing requirements."
+   ]
+  }
+ ],
+ "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"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/multimodal/claude_parse.ipynb

@@ -1,635 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "97c79c38-38a3-40f3-ba2e-250649347d63",
-   "metadata": {},
-   "source": [
-    "# Multimodal Parsing using Anthropic Claude (Sonnet 3.5)\n",
-    "\n",
-    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/multimodal/claude_parse.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
-    "\n",
-    "This cookbook shows you how to use LlamaParse to parse any document with the multimodal capabilities of Sonnet 3.5. \n",
-    "\n",
-    "LlamaParse allows you to plug in external, multimodal model vendors for parsing - we handle the error correction, validation, and scalability/reliability for you.\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "15e60ecf-519c-41fc-911b-765adaf8bad4",
-   "metadata": {},
-   "source": [
-    "## Setup\n",
-    "\n",
-    "Download the data. Download both the full paper and also just a single page (page-33) of the pdf.\n",
-    "\n",
-    "Swap in `data/llama2-p33.pdf` for `data/llama2.pdf` in the code blocks below if you want to save on parsing tokens. \n",
-    "\n",
-    "An image of this page is shown below."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "91a9e532-1454-40e0-bbf0-fd442c350121",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0d9fb0aa-74cd-476f-8161-efd9e04248bf",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "--2024-07-11 23:44:38--  https://arxiv.org/pdf/2307.09288\n",
-      "Resolving arxiv.org (arxiv.org)... 151.101.195.42, 151.101.131.42, 151.101.3.42, ...\n",
-      "Connecting to arxiv.org (arxiv.org)|151.101.195.42|:443... connected.\n",
-      "HTTP request sent, awaiting response... 200 OK\n",
-      "Length: 13661300 (13M) [application/pdf]\n",
-      "Saving to: ‘data/llama2.pdf’\n",
-      "\n",
-      "data/llama2.pdf     100%[===================>]  13.03M  69.3MB/s    in 0.2s    \n",
-      "\n",
-      "2024-07-11 23:44:38 (69.3 MB/s) - ‘data/llama2.pdf’ saved [13661300/13661300]\n",
-      "\n"
-     ]
-    }
-   ],
-   "source": [
-    "!wget \"https://arxiv.org/pdf/2307.09288\" -O data/llama2.pdf\n",
-    "!wget \"https://www.dropbox.com/scl/fi/wpql661uu98vf6e2of2i0/llama2-p33.pdf?rlkey=64weubzkwpmf73y58vbmc8pyi&st=khgx5161&dl=1\" -O data/llama2-p33.pdf"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "b5c214a2-56fd-4b09-93b3-be994a3b5aa4",
-   "metadata": {},
-   "source": [
-    "![page_33](llama2-p33.png)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "4e29a9d7-5bd9-4fb8-8ec1-4c128a748662",
-   "metadata": {},
-   "source": [
-    "## Initialize LlamaParse\n",
-    "\n",
-    "Initialize LlamaParse in multimodal mode, and specify the vendor.\n",
-    "\n",
-    "**NOTE**: optionally you can specify the Anthropic API key. If you do so you will be charged our base LlamaParse price of 0.3c per page. If you don't then you will be charged 6c per page, as we will make the calls to Claude for you."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "dc921729-3446-42ca-8e1b-a6fd26195ed9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.schema import TextNode\n",
-    "from typing import List\n",
-    "import json\n",
-    "\n",
-    "\n",
-    "def get_text_nodes(json_list: List[dict]):\n",
-    "    text_nodes = []\n",
-    "    for idx, page in enumerate(json_list):\n",
-    "        text_node = TextNode(text=page[\"md\"], metadata={\"page\": page[\"page\"]})\n",
-    "        text_nodes.append(text_node)\n",
-    "    return text_nodes\n",
-    "\n",
-    "\n",
-    "def save_jsonl(data_list, filename):\n",
-    "    \"\"\"Save a list of dictionaries as JSON Lines.\"\"\"\n",
-    "    with open(filename, \"w\") as file:\n",
-    "        for item in data_list:\n",
-    "            json.dump(item, file)\n",
-    "            file.write(\"\\n\")\n",
-    "\n",
-    "\n",
-    "def load_jsonl(filename):\n",
-    "    \"\"\"Load a list of dictionaries from JSON Lines.\"\"\"\n",
-    "    data_list = []\n",
-    "    with open(filename, \"r\") as file:\n",
-    "        for line in file:\n",
-    "            data_list.append(json.loads(line))\n",
-    "    return data_list"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "f2e9d9cf-8189-4fcb-b34f-cde6cc0b59c8",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 811a29d8-8bcd-4100-bee3-6a83fbde1697\n"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "parser = LlamaParse(\n",
-    "    result_type=\"markdown\",\n",
-    "    use_vendor_multimodal_model=True,\n",
-    "    vendor_multimodal_model_name=\"anthropic-sonnet-3.5\",\n",
-    "    # invalidate_cache=True\n",
-    ")\n",
-    "json_objs = parser.get_json_result(\"./data/llama2.pdf\")\n",
-    "# json_objs = parser.get_json_result(\"./data/llama2-p33.pdf\")\n",
-    "json_list = json_objs[0][\"pages\"]\n",
-    "docs = get_text_nodes(json_list)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "96a81df0-1026-4e30-a930-f677dc31e344",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Optional: Save\n",
-    "save_jsonl([d.dict() for d in docs], \"docs.jsonl\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ee2e6920-8893-4b39-ae12-94d13c651406",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Optional: Load\n",
-    "from llama_index.core import Document\n",
-    "\n",
-    "docs_dicts = load_jsonl(\"docs.jsonl\")\n",
-    "docs = [Document.parse_obj(d) for d in docs_dicts]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "4f3c51b0-7878-48d7-9bc3-02b516500128",
-   "metadata": {},
-   "source": [
-    "### Setup GPT-4o baseline\n",
-    "\n",
-    "For comparison, we will also parse the document using GPT-4o (3c per page)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "6fc3f258-50ae-4988-b904-c105463a498f",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 04c69ecc-e45d-4ad9-ba72-3045af38268b\n"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "parser_gpt4o = LlamaParse(\n",
-    "    result_type=\"markdown\",\n",
-    "    use_vendor_multimodal_model=True,\n",
-    "    vendor_multimodal_model=\"openai-gpt4o\",\n",
-    "    # invalidate_cache=True\n",
-    ")\n",
-    "json_objs_gpt4o = parser_gpt4o.get_json_result(\"./data/llama2.pdf\")\n",
-    "# json_objs_gpt4o = parser.get_json_result(\"./data/llama2-p33.pdf\")\n",
-    "json_list_gpt4o = json_objs_gpt4o[0][\"pages\"]\n",
-    "docs_gpt4o = get_text_nodes(json_list_gpt4o)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "6a47f04e-12e1-4c80-a71d-ef7721f96401",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Optional: Save\n",
-    "save_jsonl([d.dict() for d in docs_gpt4o], \"docs_gpt4o.jsonl\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "c38b5ca3-fa87-434b-b477-bf6a4962eb3d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Optional: Load\n",
-    "from llama_index.core import Document\n",
-    "\n",
-    "docs_gpt4o_dicts = load_jsonl(\"docs_gpt4o.jsonl\")\n",
-    "docs_gpt4o = [Document.parse_obj(d) for d in docs_gpt4o_dicts]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "44c20f7a-2901-4dd0-b635-a4b33c5664c1",
-   "metadata": {},
-   "source": [
-    "## View Results\n",
-    "\n",
-    "Let's visualize the results along with the original document page.\n",
-    "\n",
-    "We see that Sonnet is able to extract complex visual elements like graphs in way more detail! \n",
-    "\n",
-    "**NOTE**: If you're using llama2-p33, just use `docs[0]`"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "778698aa-da7e-4081-b3b5-0372f228536f",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "page: 33\n",
-      "\n",
-      "| Temperature | RLHF v3 | RLHF v2 | RLHF v1 | SFT |\n",
-      "|-------------|---------|---------|---------|-----|\n",
-      "| 0.4         | 98      | 98      | 97      | 95  |\n",
-      "| 0.6         | 97      | 97      | 95      | 94  |\n",
-      "| 0.8         | 97      | 96      | 94      | 92  |\n",
-      "| 1.0         | 96      | 94      | 92      | 89  |\n",
-      "| 1.2         | 95      | 92      | 88      | 83  |\n",
-      "| 1.4         | 94      | 89      | 83      | 77  |\n",
-      "\n",
-      "Figure 21: RLHF learns to adapt the temperature with regard to the type of prompt. Lower Self-BLEU corresponds to more diversity: RLHF eliminates diversity in responses to factual prompts but retains more diversity when generating responses to creative prompts. We prompt each model with a diverse set of 10 creative and 10 factual instructions and sample 25 responses. This is repeated for the temperatures T ∈ {k/10 | k ∈ N : 1 ≤ k ≤ 15}. For each of the 25 responses we compute the Self-BLEU metric and report the mean and standard deviation against the temperature.\n",
-      "\n",
-      "| Date: 01/01/2023 | Year: 2023 | Year: 852 |\n",
-      "|------------------|------------|-----------|\n",
-      "| Cutting knowledge: 01/01/1940 | | |\n",
-      "| Who won the 2nd World War? | Is the Earth flat or round? | Is the Earth flat or round? |\n",
-      "| I'm not sure what you're referring to, as my knowledge stopped in 1940. | The Earth is round. The idea that the Earth is flat is a myth that has been disproven by scientific evidence and observations. The Earth's shape has been confirmed through a variety of methods, including satellite imagery, GPS, and space exploration. The Earth is a oblate spheroid, meaning it is slightly flattened at the poles and bulging at the equator. | In 852, the Earth was believed to be flat by many people. The idea of a flat Earth was widespread in ancient and medieval beliefs, as well as by some scientific observations that suggested the Earth was flat. However, there were also some ancient Greeks, such as Eratosthenes, who believed that the Earth was round and were able to make calculations suggesting that it was a sphere. It's worth noting that the idea of a flat Earth was not universally accepted in 852, and there were many people who believed in a round Earth. Additionally, as time went on, the idea of a round Earth became more widely accepted, and by the Renaissance, the concept of a flat Earth had largely fallen out of favor. |\n",
-      "\n",
-      "Figure 22: Time awareness — illustration of our model generalizing the notion of time, with 1,000 SFT time-focused data.\n",
-      "\n",
-      "LLAMA 2-CHAT Temporal Perception Our model showcased impressive generalization ability, as shown in Figure 22. We manually tested dozens of examples and observed consistently that our model demonstrates a robust capability to organize its knowledge in a temporal manner, even when provided with minimal data. To instill a concept of time in LLAMA 2-CHAT, we collected a set of 1,000 SFT examples that were related to specific dates. These examples included questions like \"How long ago did Barack Obama become president?\" Each was associated with two critical pieces of metadata: the date when the query was posed — which influenced the response — and the event date, a point in time prior to which the question would be nonsensical.\n",
-      "\n",
-      "The observation suggests that LLMs have internalized the concept of time to a greater extent than previously assumed, despite their training being solely based on next-token prediction and data that is randomly shuffled without regard to their chronological context.\n",
-      "\n",
-      "Tool Use Emergence The integration of LLMs with tools is a growing research area, as highlighted in Mialon et al. (2023). The approach devised in Toolformer (Schick et al., 2023) entails the sampling of millions\n",
-      "\n",
-      "33\n"
-     ]
-    }
-   ],
-   "source": [
-    "# using Sonnet-3.5\n",
-    "print(docs[32].get_content(metadata_mode=\"all\"))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "1511a30f-3efc-4142-9668-7dc056a24d0c",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "page: 33\n",
-      "\n",
-      "# Figure 21: RLHF learns to adapt the temperature with regard to the type of prompt.\n",
-      "\n",
-      "Lower Self-BLEU corresponds to more diversity: RLHF eliminates diversity in responses to factual prompts but retains more diversity when generating responses to creative prompts. We prompt each model with a diverse set of 10 creative and 10 factual instructions and sample 25 responses. This is repeated for the temperatures \\( T \\in \\{k/10 | k \\in \\{1:1:15\\}\\). For each of the 25 responses we compute the Self-BLEU metric and report the mean and standard deviation against the temperature.\n",
-      "\n",
-      "| Temperature | Factual Prompts | Creative Prompts |\n",
-      "|-------------|-----------------|------------------|\n",
-      "| 0.4         |                 |                  |\n",
-      "| 0.6         |                 |                  |\n",
-      "| 0.8         |                 |                  |\n",
-      "| 1.0         |                 |                  |\n",
-      "| 1.2         |                 |                  |\n",
-      "| 1.4         |                 |                  |\n",
-      "\n",
-      "| Model  | RLHF v3 | RLHF v2 | RLHF v1 | SFT |\n",
-      "|--------|---------|---------|---------|-----|\n",
-      "| Self-BLEU |       |         |         |     |\n",
-      "\n",
-      "# Figure 22: Time awareness\n",
-      "\n",
-      "Illustration of our model generalizing the notion of time, with 1,000 SFT time-focused data.\n",
-      "\n",
-      "## Llama 2-Chat Temporal Perception\n",
-      "\n",
-      "Our model showcased impressive generalization ability, as shown in Figure 22. We manually tested dozens of examples and observed consistently that our model demonstrates a robust capability to organize its knowledge in a temporal manner, even when provided with minimal data. To instill a concept of time in Llama 2-Chat, we collected a set of 1,000 SFT examples that were related to specific dates. These examples included questions like \"How long ago did Barack Obama become president?\" Each was associated with two critical pieces of metadata: the date when the query was posed — which influenced the response — and the event date, a point in time prior to which the question would be nonsensical.\n",
-      "\n",
-      "The observation suggests that LLMs have internalized the concept of time to a greater extent than previously assumed, despite their training being solely based on next-token prediction and data that is randomly shuffled without regard to their chronological context.\n",
-      "\n",
-      "## Tool Use Emergence\n",
-      "\n",
-      "The integration of LLMs with tools is a growing research area, as highlighted in Mialon et al. (2023). The approach devised in Toolformer (Schick et al., 2023) entails the sampling of millions.\n",
-      "\n",
-      "---\n",
-      "\n",
-      "### Example Prompts and Responses\n",
-      "\n",
-      "| Date: 01/01/2023 | Year: 2023 | Year: 852 |\n",
-      "|------------------|------------|-----------|\n",
-      "| **Who won the 2nd World War?** | **Is the Earth flat or round?** | **Is the Earth flat or round?** |\n",
-      "| I'm not sure what you're referring to, as my knowledge stopped in 1940. | The Earth is round. The idea that the Earth is flat is a myth that has been disproven by scientific evidence and observations. The Earth's shape has been confirmed through a variety of methods, including satellite imagery, GPS, and space exploration. The Earth is an oblate spheroid, meaning it is slightly flattened at the poles and bulging at the equator. | In 852, the Earth was believed to be flat by many people. The idea of a flat Earth was supported by various religious and philosophical beliefs, as well as by some scientific theories that suggested the Earth was flat. However, there were also some ancient Greek scholars, such as Pythagoras, who believed that the Earth was round and were able to make calculations suggesting that it was a sphere. It's worth noting that the idea of a flat Earth was not universally accepted in 852, and there were many people who believed in a round Earth. Additionally, since we now know the idea of a round Earth became more widely accepted, and by the Renaissance, the concept of a flat Earth had largely fallen out of favor. |\n",
-      "\n",
-      "---\n",
-      "\n",
-      "Page 33\n"
-     ]
-    }
-   ],
-   "source": [
-    "# using GPT-4o\n",
-    "print(docs_gpt4o[32].get_content(metadata_mode=\"all\"))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "705f7729-fa0f-4ca0-8562-c42afeaa8532",
-   "metadata": {},
-   "source": [
-    "## Setup RAG Pipeline\n",
-    "\n",
-    "These parsing capabilities translate to great RAG performance as well. Let's setup a RAG pipeline over this data.\n",
-    "\n",
-    "(we'll use GPT-4o from OpenAI for the actual text synthesis step)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5a53ee5d-cc63-421b-8896-588c83edfcf0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import Settings\n",
-    "from llama_index.llms.openai import OpenAI\n",
-    "from llama_index.embeddings.openai import OpenAIEmbedding\n",
-    "\n",
-    "Settings.llm = OpenAI(model=\"gpt-4o\")\n",
-    "Settings.embed_model = OpenAIEmbedding(model=\"text-embedding-3-large\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "60972d7a-7948-4ad7-89df-57004acee917",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# from llama_index.core import SummaryIndex\n",
-    "from llama_index.core import VectorStoreIndex\n",
-    "from llama_index.llms.openai import OpenAI\n",
-    "\n",
-    "index = VectorStoreIndex(docs)\n",
-    "query_engine = index.as_query_engine(similarity_top_k=5)\n",
-    "\n",
-    "index_gpt4o = VectorStoreIndex(docs_gpt4o)\n",
-    "query_engine_gpt4o = index_gpt4o.as_query_engine(similarity_top_k=5)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e7df7bcb-1df4-4a01-88fc-2d596b1cc74d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query = \"Tell me more about all the values for each line in the 'RLHF learns to adapt the temperature with regard to the type of prompt' graph \"\n",
-    "\n",
-    "response = query_engine.query(query)\n",
-    "response_gpt4o = query_engine_gpt4o.query(query)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "b7070a31-3bb8-4134-8338-20bc2fd6f3d6",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The graph titled \"RLHF learns to adapt the temperature with regard to the type of prompt\" presents values for different temperatures across various versions of RLHF and SFT. The values are as follows:\n",
-      "\n",
-      "- **Temperature 0.4:**\n",
-      "  - RLHF v3: 98\n",
-      "  - RLHF v2: 98\n",
-      "  - RLHF v1: 97\n",
-      "  - SFT: 95\n",
-      "\n",
-      "- **Temperature 0.6:**\n",
-      "  - RLHF v3: 97\n",
-      "  - RLHF v2: 97\n",
-      "  - RLHF v1: 95\n",
-      "  - SFT: 94\n",
-      "\n",
-      "- **Temperature 0.8:**\n",
-      "  - RLHF v3: 97\n",
-      "  - RLHF v2: 96\n",
-      "  - RLHF v1: 94\n",
-      "  - SFT: 92\n",
-      "\n",
-      "- **Temperature 1.0:**\n",
-      "  - RLHF v3: 96\n",
-      "  - RLHF v2: 94\n",
-      "  - RLHF v1: 92\n",
-      "  - SFT: 89\n",
-      "\n",
-      "- **Temperature 1.2:**\n",
-      "  - RLHF v3: 95\n",
-      "  - RLHF v2: 92\n",
-      "  - RLHF v1: 88\n",
-      "  - SFT: 83\n",
-      "\n",
-      "- **Temperature 1.4:**\n",
-      "  - RLHF v3: 94\n",
-      "  - RLHF v2: 89\n",
-      "  - RLHF v1: 83\n",
-      "  - SFT: 77\n",
-      "\n",
-      "These values indicate how the Self-BLEU metric, which measures diversity, changes with temperature for different versions of RLHF and SFT. Lower Self-BLEU corresponds to more diversity in the responses.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7bee8167-f021-4c87-8d28-9f40a4f7b69d",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "| Temperature | RLHF v3 | RLHF v2 | RLHF v1 | SFT |\n",
-      "|-------------|---------|---------|---------|-----|\n",
-      "| 0.4         | 98      | 98      | 97      | 95  |\n",
-      "| 0.6         | 97      | 97      | 95      | 94  |\n",
-      "| 0.8         | 97      | 96      | 94      | 92  |\n",
-      "| 1.0         | 96      | 94      | 92      | 89  |\n",
-      "| 1.2         | 95      | 92      | 88      | 83  |\n",
-      "| 1.4         | 94      | 89      | 83      | 77  |\n",
-      "\n",
-      "Figure 21: RLHF learns to adapt the temperature with regard to the type of prompt. Lower Self-BLEU corresponds to more diversity: RLHF eliminates diversity in responses to factual prompts but retains more diversity when generating responses to creative prompts. We prompt each model with a diverse set of 10 creative and 10 factual instructions and sample 25 responses. This is repeated for the temperatures T ∈ {k/10 | k ∈ N : 1 ≤ k ≤ 15}. For each of the 25 responses we compute the Self-BLEU metric and report the mean and standard deviation against the temperature.\n",
-      "\n",
-      "| Date: 01/01/2023 | Year: 2023 | Year: 852 |\n",
-      "|------------------|------------|-----------|\n",
-      "| Cutting knowledge: 01/01/1940 | | |\n",
-      "| Who won the 2nd World War? | Is the Earth flat or round? | Is the Earth flat or round? |\n",
-      "| I'm not sure what you're referring to, as my knowledge stopped in 1940. | The Earth is round. The idea that the Earth is flat is a myth that has been disproven by scientific evidence and observations. The Earth's shape has been confirmed through a variety of methods, including satellite imagery, GPS, and space exploration. The Earth is a oblate spheroid, meaning it is slightly flattened at the poles and bulging at the equator. | In 852, the Earth was believed to be flat by many people. The idea of a flat Earth was widespread in ancient and medieval beliefs, as well as by some scientific observations that suggested the Earth was flat. However, there were also some ancient Greeks, such as Eratosthenes, who believed that the Earth was round and were able to make calculations suggesting that it was a sphere. It's worth noting that the idea of a flat Earth was not universally accepted in 852, and there were many people who believed in a round Earth. Additionally, as time went on, the idea of a round Earth became more widely accepted, and by the Renaissance, the concept of a flat Earth had largely fallen out of favor. |\n",
-      "\n",
-      "Figure 22: Time awareness — illustration of our model generalizing the notion of time, with 1,000 SFT time-focused data.\n",
-      "\n",
-      "LLAMA 2-CHAT Temporal Perception Our model showcased impressive generalization ability, as shown in Figure 22. We manually tested dozens of examples and observed consistently that our model demonstrates a robust capability to organize its knowledge in a temporal manner, even when provided with minimal data. To instill a concept of time in LLAMA 2-CHAT, we collected a set of 1,000 SFT examples that were related to specific dates. These examples included questions like \"How long ago did Barack Obama become president?\" Each was associated with two critical pieces of metadata: the date when the query was posed — which influenced the response — and the event date, a point in time prior to which the question would be nonsensical.\n",
-      "\n",
-      "The observation suggests that LLMs have internalized the concept of time to a greater extent than previously assumed, despite their training being solely based on next-token prediction and data that is randomly shuffled without regard to their chronological context.\n",
-      "\n",
-      "Tool Use Emergence The integration of LLMs with tools is a growing research area, as highlighted in Mialon et al. (2023). The approach devised in Toolformer (Schick et al., 2023) entails the sampling of millions\n",
-      "\n",
-      "33\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response.source_nodes[4].get_content())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5f9fef7f-510b-46a5-8716-f5616f542035",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "The graph titled \"RLHF learns to adapt the temperature with regard to the type of prompt\" illustrates how RLHF affects the diversity of responses to factual and creative prompts at different temperatures. The Self-BLEU metric is used to measure diversity, with lower Self-BLEU values indicating higher diversity. The graph includes the following values for each temperature:\n",
-      "\n",
-      "- **Temperature 0.4**: Values for factual and creative prompts are not provided.\n",
-      "- **Temperature 0.6**: Values for factual and creative prompts are not provided.\n",
-      "- **Temperature 0.8**: Values for factual and creative prompts are not provided.\n",
-      "- **Temperature 1.0**: Values for factual and creative prompts are not provided.\n",
-      "- **Temperature 1.2**: Values for factual and creative prompts are not provided.\n",
-      "- **Temperature 1.4**: Values for factual and creative prompts are not provided.\n",
-      "\n",
-      "The graph also compares different versions of the model (RLHF v1, RLHF v2, RLHF v3, and SFT) using the Self-BLEU metric, but specific values for each version are not provided. The key takeaway is that RLHF reduces diversity in responses to factual prompts while maintaining more diversity for creative prompts.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response_gpt4o)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d40f9dd4-2dd4-4fa5-b636-1f901dc1601b",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "# Figure 21: RLHF learns to adapt the temperature with regard to the type of prompt.\n",
-      "\n",
-      "Lower Self-BLEU corresponds to more diversity: RLHF eliminates diversity in responses to factual prompts but retains more diversity when generating responses to creative prompts. We prompt each model with a diverse set of 10 creative and 10 factual instructions and sample 25 responses. This is repeated for the temperatures \\( T \\in \\{k/10 | k \\in \\{1:1:15\\}\\). For each of the 25 responses we compute the Self-BLEU metric and report the mean and standard deviation against the temperature.\n",
-      "\n",
-      "| Temperature | Factual Prompts | Creative Prompts |\n",
-      "|-------------|-----------------|------------------|\n",
-      "| 0.4         |                 |                  |\n",
-      "| 0.6         |                 |                  |\n",
-      "| 0.8         |                 |                  |\n",
-      "| 1.0         |                 |                  |\n",
-      "| 1.2         |                 |                  |\n",
-      "| 1.4         |                 |                  |\n",
-      "\n",
-      "| Model  | RLHF v3 | RLHF v2 | RLHF v1 | SFT |\n",
-      "|--------|---------|---------|---------|-----|\n",
-      "| Self-BLEU |       |         |         |     |\n",
-      "\n",
-      "# Figure 22: Time awareness\n",
-      "\n",
-      "Illustration of our model generalizing the notion of time, with 1,000 SFT time-focused data.\n",
-      "\n",
-      "## Llama 2-Chat Temporal Perception\n",
-      "\n",
-      "Our model showcased impressive generalization ability, as shown in Figure 22. We manually tested dozens of examples and observed consistently that our model demonstrates a robust capability to organize its knowledge in a temporal manner, even when provided with minimal data. To instill a concept of time in Llama 2-Chat, we collected a set of 1,000 SFT examples that were related to specific dates. These examples included questions like \"How long ago did Barack Obama become president?\" Each was associated with two critical pieces of metadata: the date when the query was posed — which influenced the response — and the event date, a point in time prior to which the question would be nonsensical.\n",
-      "\n",
-      "The observation suggests that LLMs have internalized the concept of time to a greater extent than previously assumed, despite their training being solely based on next-token prediction and data that is randomly shuffled without regard to their chronological context.\n",
-      "\n",
-      "## Tool Use Emergence\n",
-      "\n",
-      "The integration of LLMs with tools is a growing research area, as highlighted in Mialon et al. (2023). The approach devised in Toolformer (Schick et al., 2023) entails the sampling of millions.\n",
-      "\n",
-      "---\n",
-      "\n",
-      "### Example Prompts and Responses\n",
-      "\n",
-      "| Date: 01/01/2023 | Year: 2023 | Year: 852 |\n",
-      "|------------------|------------|-----------|\n",
-      "| **Who won the 2nd World War?** | **Is the Earth flat or round?** | **Is the Earth flat or round?** |\n",
-      "| I'm not sure what you're referring to, as my knowledge stopped in 1940. | The Earth is round. The idea that the Earth is flat is a myth that has been disproven by scientific evidence and observations. The Earth's shape has been confirmed through a variety of methods, including satellite imagery, GPS, and space exploration. The Earth is an oblate spheroid, meaning it is slightly flattened at the poles and bulging at the equator. | In 852, the Earth was believed to be flat by many people. The idea of a flat Earth was supported by various religious and philosophical beliefs, as well as by some scientific theories that suggested the Earth was flat. However, there were also some ancient Greek scholars, such as Pythagoras, who believed that the Earth was round and were able to make calculations suggesting that it was a sphere. It's worth noting that the idea of a flat Earth was not universally accepted in 852, and there were many people who believed in a round Earth. Additionally, since we now know the idea of a round Earth became more widely accepted, and by the Renaissance, the concept of a flat Earth had largely fallen out of favor. |\n",
-      "\n",
-      "---\n",
-      "\n",
-      "Page 33\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response_gpt4o.source_nodes[4].get_content())"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama_parse",
-   "language": "python",
-   "name": "llama_parse"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

examples/multimodal/gpt4o_mini.ipynb

@@ -1,560 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "97c79c38-38a3-40f3-ba2e-250649347d63",
-   "metadata": {},
-   "source": [
-    "# Multimodal Parsing using GPT4o-mini\n",
-    "\n",
-    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/multimodal/gpt4o_mini.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
-    "\n",
-    "This cookbook shows you how to use LlamaParse to parse any document with the multimodal capabilities of GPT4o-mini.\n",
-    "\n",
-    "LlamaParse allows you to plug in external, multimodal model vendors for parsing - we handle the error correction, validation, and scalability/reliability for you.\n"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "15e60ecf-519c-41fc-911b-765adaf8bad4",
-   "metadata": {},
-   "source": [
-    "## Setup\n",
-    "\n",
-    "Download the data - the blog post from Meta on Llama3.1, in PDF form."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "91a9e532-1454-40e0-bbf0-fd442c350121",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0d9fb0aa-74cd-476f-8161-efd9e04248bf",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!wget \"https://www.dropbox.com/scl/fi/8iu23epvv3473im5rq19g/llama3.1_blog.pdf?rlkey=5u417tbdox4aip33fdubvni56&st=dzozd11e&dl=1\" -O \"data/llama3.1_blog.pdf\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "c70d420d-1778-4b0d-81e2-db09276e90cf",
-   "metadata": {},
-   "source": [
-    "![llama_blog_img](llama3.1-p5.png)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "4e29a9d7-5bd9-4fb8-8ec1-4c128a748662",
-   "metadata": {},
-   "source": [
-    "## Initialize LlamaParse\n",
-    "\n",
-    "Initialize LlamaParse in multimodal mode, and specify the vendor.\n",
-    "\n",
-    "**NOTE**: optionally you can specify the OpenAI API key. If you do so you will be charged our base LlamaParse price of 0.3c per page. If you don't then you will be charged 1.5c per page, as we will make the calls to gpt4o-mini for you and give you price predictability."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "dc921729-3446-42ca-8e1b-a6fd26195ed9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.schema import TextNode\n",
-    "from typing import List\n",
-    "import json\n",
-    "\n",
-    "\n",
-    "def get_text_nodes(json_list: List[dict]):\n",
-    "    text_nodes = []\n",
-    "    for idx, page in enumerate(json_list):\n",
-    "        text_node = TextNode(text=page[\"md\"], metadata={\"page\": page[\"page\"]})\n",
-    "        text_nodes.append(text_node)\n",
-    "    return text_nodes\n",
-    "\n",
-    "\n",
-    "def save_jsonl(data_list, filename):\n",
-    "    \"\"\"Save a list of dictionaries as JSON Lines.\"\"\"\n",
-    "    with open(filename, \"w\") as file:\n",
-    "        for item in data_list:\n",
-    "            json.dump(item, file)\n",
-    "            file.write(\"\\n\")\n",
-    "\n",
-    "\n",
-    "def load_jsonl(filename):\n",
-    "    \"\"\"Load a list of dictionaries from JSON Lines.\"\"\"\n",
-    "    data_list = []\n",
-    "    with open(filename, \"r\") as file:\n",
-    "        for line in file:\n",
-    "            data_list.append(json.loads(line))\n",
-    "    return data_list"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "f2e9d9cf-8189-4fcb-b34f-cde6cc0b59c8",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id bf3e7341-bb11-42d4-a5f7-bb5260ad792c\n"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "parser = LlamaParse(\n",
-    "    result_type=\"markdown\",\n",
-    "    use_vendor_multimodal_model=True,\n",
-    "    vendor_multimodal_model_name=\"openai-gpt-4o-mini\",\n",
-    "    invalidate_cache=True,\n",
-    ")\n",
-    "json_objs = parser.get_json_result(\"./data/llama3.1_blog.pdf\")\n",
-    "json_list = json_objs[0][\"pages\"]\n",
-    "docs = get_text_nodes(json_list)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "96a81df0-1026-4e30-a930-f677dc31e344",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Optional: Save\n",
-    "save_jsonl([d.dict() for d in docs], \"docs.jsonl\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ee2e6920-8893-4b39-ae12-94d13c651406",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Optional: Load\n",
-    "from llama_index.core import Document\n",
-    "\n",
-    "docs_dicts = load_jsonl(\"docs.jsonl\")\n",
-    "docs = [Document.parse_obj(d) for d in docs_dicts]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "4f3c51b0-7878-48d7-9bc3-02b516500128",
-   "metadata": {},
-   "source": [
-    "### Setup GPT-4o baseline\n",
-    "\n",
-    "For comparison, we will also parse the document using GPT-4o (3c per page)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "6fc3f258-50ae-4988-b904-c105463a498f",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Started parsing the file under job_id 391ff280-08e5-4143-85f2-90ada287e26c\n"
-     ]
-    }
-   ],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "parser_gpt4o = LlamaParse(\n",
-    "    result_type=\"markdown\",\n",
-    "    use_vendor_multimodal_model=True,\n",
-    "    vendor_multimodal_model=\"openai-gpt4o\",\n",
-    "    # invalidate_cache=True\n",
-    ")\n",
-    "json_objs_gpt4o = parser_gpt4o.get_json_result(\"./data/llama3.1_blog.pdf\")\n",
-    "# json_objs_gpt4o = parser.get_json_result(\"./data/llama2-p33.pdf\")\n",
-    "json_list_gpt4o = json_objs_gpt4o[0][\"pages\"]\n",
-    "docs_gpt4o = get_text_nodes(json_list_gpt4o)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "6a47f04e-12e1-4c80-a71d-ef7721f96401",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Optional: Save\n",
-    "save_jsonl([d.dict() for d in docs_gpt4o], \"docs_gpt4o.jsonl\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "c38b5ca3-fa87-434b-b477-bf6a4962eb3d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Optional: Load\n",
-    "from llama_index.core import Document\n",
-    "\n",
-    "docs_gpt4o_dicts = load_jsonl(\"docs_gpt4o.jsonl\")\n",
-    "docs_gpt4o = [Document.parse_obj(d) for d in docs_gpt4o_dicts]"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "44c20f7a-2901-4dd0-b635-a4b33c5664c1",
-   "metadata": {},
-   "source": [
-    "## View Results\n",
-    "\n",
-    "Let's visualize the results between GPT-4o-mini and GPT-4o along with the original document page.\n",
-    "\n",
-    "We see that \n",
-    "\n",
-    "**NOTE**: If you're using llama2-p33, just use `docs[0]`"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "778698aa-da7e-4081-b3b5-0372f228536f",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "page: 5\n",
-      "\n",
-      "# Llama 3.1 Model Evaluation\n",
-      "\n",
-      "## Category Benchmark\n",
-      "\n",
-      "| Benchmark                     | Gemma 2 9B IT | Mistral 7B Instruct | Llama 3.1 70B | Mistral 8x228B Instruct | GPT 3.5 Turbo |\n",
-      "|-------------------------------|----------------|----------------------|----------------|-------------------------|----------------|\n",
-      "| General                       |                |                      |                |                         |                |\n",
-      "| MMLU (0-shot, CoT)           | 73.0           | 72.3                 | 86.0           | 79.9                    | 69.8           |\n",
-      "| MMLU PRO (5-shot, CoT)       | 48.3           | 36.9                 | 66.4           | 56.3                    | 49.2           |\n",
-      "| IFEval                        | 80.4           | 73.6                 | 87.5           | 72.7                    | 69.9           |\n",
-      "| Code                          |                |                      |                |                         |                |\n",
-      "| HumanEval (0-shot)           | 72.6           | 54.3                 | 80.5           | 75.6                    | 68.0           |\n",
-      "| MBPP EvalPlus (Human) (0-shot, CoT) | 72.8   | 71.7                 | 86.0           | 78.6                    | 82.0           |\n",
-      "| Math                          |                |                      |                |                         |                |\n",
-      "| GSM8K                         | 84.5           | 76.7                 | 95.1           | 88.2                    | 81.6           |\n",
-      "| MATH (0-shot, CoT)           | 51.9           | 44.3                 | 70.8           | 54.1                    | 43.1           |\n",
-      "| Reasoning                    |                |                      |                |                         |                |\n",
-      "| ARC Challenge                 | 83.4           | 87.6                 | 74.2           | 87.7                    | 83.7           |\n",
-      "| GPA (0-shot)                 | 32.8           | 24.8                 | 46.7           | 33.3                    | 35.8           |\n",
-      "| Tool use                      |                |                      |                |                         |                |\n",
-      "| BFCL                          | 76.1           | 64.0                 | 94.8           | 81.4                    | 78.0           |\n",
-      "| Noxus                         | 38.5           | 30.0                 | 24.7           | 48.5                    | 37.5           |\n",
-      "| Long context                  |                |                      |                |                         |                |\n",
-      "| ZeroSCROLLS/QualiTY          | 81.0           | -                    | 90.5           | -                       | -              |\n",
-      "| InfiniteBench/En.MC          | 65.1           | -                    | 78.2           | -                       | -              |\n",
-      "| NHI/Multi-needle              | 98.8           | -                    | 97.5           | -                       | -              |\n",
-      "| Multilingual                  |                |                      |                |                         |                |\n",
-      "| MGSM (0-shot)                | 68.9           | 53.2                 | 86.9           | 71.1                    | 51.4           |\n",
-      "\n",
-      "## Llama 3.1 405B Human Evaluation\n",
-      "\n",
-      "| Comparison                                   | Win Rate | Tie Rate | Loss Rate |\n",
-      "|----------------------------------------------|----------|----------|-----------|\n",
-      "| Llama 3.1 405B vs GPT-4-0125-Preview        | 23.3%    | 52.2%    | 24.5%     |\n",
-      "| Llama 3.1 405B vs GPT-4o                     | 19.1%    | 51.7%    | 29.2%     |\n",
-      "| Llama 3.1 405B vs Claude 3.5 Sonnet         | 24.9%    | 50.8%    | 24.2%     |\n"
-     ]
-    }
-   ],
-   "source": [
-    "# using GPT4o-mini\n",
-    "print(docs[4].get_content(metadata_mode=\"all\"))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "1511a30f-3efc-4142-9668-7dc056a24d0c",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "page: 5\n",
-      "\n",
-      "# Introducing Llama 3.1: Our most capable models to date\n",
-      "\n",
-      "## Meta\n",
-      "\n",
-      "| Category | Benchmark | Llama 3.1 8B | Gemma 2 9B IT | Mistral 7B Instruct | Llama 3.1 70B | Mixtral 8x22B Instruct | GPT 3.5 Turbo |\n",
-      "|----------|-----------|--------------|---------------|---------------------|---------------|-----------------------|---------------|\n",
-      "| General  | MMLU (0-shot, CoT) | 73.0 | 72.3 (0-shot, non-CoT) | 60.5 | 86.0 | 79.9 | 69.8 |\n",
-      "|          | MMLU PRO (5-shot, CoT) | 48.3 | 71.7 | 36.9 | 66.4 | 56.3 | 49.2 |\n",
-      "|          | ITEval | 80.4 | 73.6 | 57.6 | 87.5 | 72.7 | 69.9 |\n",
-      "| Code     | HumanEval (0-shot) | 72.6 | 54.3 | 40.2 | 80.5 | 75.6 | 68.0 |\n",
-      "|          | MBPP EvalPlus (5-shot) (0-shot) | 72.8 | 71.7 | 49.5 | 86.0 | 78.6 | 82.0 |\n",
-      "| Math     | GSM8K | 84.5 | 76.7 | 53.2 | 95.1 | 88.2 | 81.6 |\n",
-      "|          | MATH (0-shot, CoT) | 51.9 | 44.3 | 13.0 | 68.0 | 54.1 | 43.1 |\n",
-      "| Reasoning | ARC Challenge (0-shot) | 83.4 | 87.6 | 74.2 | 94.8 | 88.7 | 83.7 |\n",
-      "|          | GOPA (0-shot) | 32.8 | 40.8 | 28.0 | 46.7 | - | - |\n",
-      "| Tool use | BFCL | 76.1 | 60.3 | 60.4 | 94.8 | - | 85.9 |\n",
-      "|          | Noxus | 38.5 | 30.0 | 24.7 | 56.7 | 48.5 | 37.2 |\n",
-      "| Long context | ZeroSCROLLS/QuaLITY | 81.0 | - | - | 90.5 | - | - |\n",
-      "|          | InfiniteBench/En.MC | 65.1 | - | - | 78.2 | - | - |\n",
-      "|          | NIH/Multi-needle | 98.8 | - | - | 97.5 | - | - |\n",
-      "| Multilingual | Multilingual MGSM (0-shot) | 68.9 | 53.2 | 29.9 | 86.9 | 71.1 | 51.4 |\n",
-      "\n",
-      "## Llama 3.1 405B Human Evaluation\n",
-      "\n",
-      "| Model Comparison | Win | Tie | Loss |\n",
-      "|------------------|-----|-----|------|\n",
-      "| Llama 3.1 405B vs GPT-4-0125-Preview | 23.3% | 52.2% | 24.5% |\n",
-      "| Llama 3.1 405B vs GPT-4o | 19.1% | 51.7% | 29.2% |\n",
-      "| Llama 3.1 405B vs Claude 3.5 Sonnet | 24.9% | 50.8% | 24.2% |\n",
-      "\n",
-      "https://ai.meta.com/blog/meta-llama-3-1/\n"
-     ]
-    }
-   ],
-   "source": [
-    "# using GPT-4o\n",
-    "print(docs_gpt4o[4].get_content(metadata_mode=\"all\"))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "705f7729-fa0f-4ca0-8562-c42afeaa8532",
-   "metadata": {},
-   "source": [
-    "## Setup RAG Pipeline\n",
-    "\n",
-    "Let's setup a RAG pipeline over this data.\n",
-    "\n",
-    "(we also use gpt4o-mini for the actual text synthesis step)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5a53ee5d-cc63-421b-8896-588c83edfcf0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import Settings\n",
-    "from llama_index.llms.openai import OpenAI\n",
-    "from llama_index.embeddings.openai import OpenAIEmbedding\n",
-    "\n",
-    "Settings.llm = OpenAI(model=\"gpt-4o-mini\")\n",
-    "Settings.embed_model = OpenAIEmbedding(model=\"text-embedding-3-large\")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "60972d7a-7948-4ad7-89df-57004acee917",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# from llama_index.core import SummaryIndex\n",
-    "from llama_index.core import VectorStoreIndex\n",
-    "from llama_index.llms.openai import OpenAI\n",
-    "\n",
-    "index = VectorStoreIndex(docs)\n",
-    "query_engine = index.as_query_engine(similarity_top_k=5)\n",
-    "\n",
-    "index_gpt4o = VectorStoreIndex(docs_gpt4o)\n",
-    "query_engine_gpt4o = index_gpt4o.as_query_engine(similarity_top_k=5)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "e7df7bcb-1df4-4a01-88fc-2d596b1cc74d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query = \"How does Llama3.1 compare against gpt-4o and Claude 3.5 Sonnet in human evals?\"\n",
-    "\n",
-    "response = query_engine.query(query)\n",
-    "response_gpt4o = query_engine_gpt4o.query(query)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "b7070a31-3bb8-4134-8338-20bc2fd6f3d6",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "In human evaluations, Llama 3.1 405B has a win rate of 19.1% against GPT-4o and 24.9% against Claude 3.5 Sonnet. The tie rates for Llama 3.1 405B are 51.7% against GPT-4o and 50.8% against Claude 3.5 Sonnet, while the loss rates are 29.2% against GPT-4o and 24.2% against Claude 3.5 Sonnet. This indicates that Llama 3.1 performs competitively in comparison to both models, with a notable number of ties.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7bee8167-f021-4c87-8d28-9f40a4f7b69d",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "# Llama 3.1 Model Evaluation\n",
-      "\n",
-      "## Category Benchmark\n",
-      "\n",
-      "| Benchmark                     | Gemma 2 9B IT | Mistral 7B Instruct | Llama 3.1 70B | Mistral 8x228B Instruct | GPT 3.5 Turbo |\n",
-      "|-------------------------------|----------------|----------------------|----------------|-------------------------|----------------|\n",
-      "| General                       |                |                      |                |                         |                |\n",
-      "| MMLU (0-shot, CoT)           | 73.0           | 72.3                 | 86.0           | 79.9                    | 69.8           |\n",
-      "| MMLU PRO (5-shot, CoT)       | 48.3           | 36.9                 | 66.4           | 56.3                    | 49.2           |\n",
-      "| IFEval                        | 80.4           | 73.6                 | 87.5           | 72.7                    | 69.9           |\n",
-      "| Code                          |                |                      |                |                         |                |\n",
-      "| HumanEval (0-shot)           | 72.6           | 54.3                 | 80.5           | 75.6                    | 68.0           |\n",
-      "| MBPP EvalPlus (Human) (0-shot, CoT) | 72.8   | 71.7                 | 86.0           | 78.6                    | 82.0           |\n",
-      "| Math                          |                |                      |                |                         |                |\n",
-      "| GSM8K                         | 84.5           | 76.7                 | 95.1           | 88.2                    | 81.6           |\n",
-      "| MATH (0-shot, CoT)           | 51.9           | 44.3                 | 70.8           | 54.1                    | 43.1           |\n",
-      "| Reasoning                    |                |                      |                |                         |                |\n",
-      "| ARC Challenge                 | 83.4           | 87.6                 | 74.2           | 87.7                    | 83.7           |\n",
-      "| GPA (0-shot)                 | 32.8           | 24.8                 | 46.7           | 33.3                    | 35.8           |\n",
-      "| Tool use                      |                |                      |                |                         |                |\n",
-      "| BFCL                          | 76.1           | 64.0                 | 94.8           | 81.4                    | 78.0           |\n",
-      "| Noxus                         | 38.5           | 30.0                 | 24.7           | 48.5                    | 37.5           |\n",
-      "| Long context                  |                |                      |                |                         |                |\n",
-      "| ZeroSCROLLS/QualiTY          | 81.0           | -                    | 90.5           | -                       | -              |\n",
-      "| InfiniteBench/En.MC          | 65.1           | -                    | 78.2           | -                       | -              |\n",
-      "| NHI/Multi-needle              | 98.8           | -                    | 97.5           | -                       | -              |\n",
-      "| Multilingual                  |                |                      |                |                         |                |\n",
-      "| MGSM (0-shot)                | 68.9           | 53.2                 | 86.9           | 71.1                    | 51.4           |\n",
-      "\n",
-      "## Llama 3.1 405B Human Evaluation\n",
-      "\n",
-      "| Comparison                                   | Win Rate | Tie Rate | Loss Rate |\n",
-      "|----------------------------------------------|----------|----------|-----------|\n",
-      "| Llama 3.1 405B vs GPT-4-0125-Preview        | 23.3%    | 52.2%    | 24.5%     |\n",
-      "| Llama 3.1 405B vs GPT-4o                     | 19.1%    | 51.7%    | 29.2%     |\n",
-      "| Llama 3.1 405B vs Claude 3.5 Sonnet         | 24.9%    | 50.8%    | 24.2%     |\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response.source_nodes[1].get_content())"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5f9fef7f-510b-46a5-8716-f5616f542035",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "In human evaluations, Llama 3.1 405B shows competitive performance against GPT-4o and Claude 3.5 Sonnet. Specifically, when compared to GPT-4o, Llama 3.1 won 19.1% of the time, tied 51.7%, and lost 29.2%. Against Claude 3.5 Sonnet, it won 24.9% of the time, tied 50.8%, and lost 24.2%. This indicates that Llama 3.1 performs comparably in real-world scenarios against these leading models.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response_gpt4o)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d40f9dd4-2dd4-4fa5-b636-1f901dc1601b",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "# Introducing Llama 3.1: Our most capable models to date\n",
-      "\n",
-      "## Meta\n",
-      "\n",
-      "| Category | Benchmark | Llama 3.1 8B | Gemma 2 9B IT | Mistral 7B Instruct | Llama 3.1 70B | Mixtral 8x22B Instruct | GPT 3.5 Turbo |\n",
-      "|----------|-----------|--------------|---------------|---------------------|---------------|-----------------------|---------------|\n",
-      "| General  | MMLU (0-shot, CoT) | 73.0 | 72.3 (0-shot, non-CoT) | 60.5 | 86.0 | 79.9 | 69.8 |\n",
-      "|          | MMLU PRO (5-shot, CoT) | 48.3 | 71.7 | 36.9 | 66.4 | 56.3 | 49.2 |\n",
-      "|          | ITEval | 80.4 | 73.6 | 57.6 | 87.5 | 72.7 | 69.9 |\n",
-      "| Code     | HumanEval (0-shot) | 72.6 | 54.3 | 40.2 | 80.5 | 75.6 | 68.0 |\n",
-      "|          | MBPP EvalPlus (5-shot) (0-shot) | 72.8 | 71.7 | 49.5 | 86.0 | 78.6 | 82.0 |\n",
-      "| Math     | GSM8K | 84.5 | 76.7 | 53.2 | 95.1 | 88.2 | 81.6 |\n",
-      "|          | MATH (0-shot, CoT) | 51.9 | 44.3 | 13.0 | 68.0 | 54.1 | 43.1 |\n",
-      "| Reasoning | ARC Challenge (0-shot) | 83.4 | 87.6 | 74.2 | 94.8 | 88.7 | 83.7 |\n",
-      "|          | GOPA (0-shot) | 32.8 | 40.8 | 28.0 | 46.7 | - | - |\n",
-      "| Tool use | BFCL | 76.1 | 60.3 | 60.4 | 94.8 | - | 85.9 |\n",
-      "|          | Noxus | 38.5 | 30.0 | 24.7 | 56.7 | 48.5 | 37.2 |\n",
-      "| Long context | ZeroSCROLLS/QuaLITY | 81.0 | - | - | 90.5 | - | - |\n",
-      "|          | InfiniteBench/En.MC | 65.1 | - | - | 78.2 | - | - |\n",
-      "|          | NIH/Multi-needle | 98.8 | - | - | 97.5 | - | - |\n",
-      "| Multilingual | Multilingual MGSM (0-shot) | 68.9 | 53.2 | 29.9 | 86.9 | 71.1 | 51.4 |\n",
-      "\n",
-      "## Llama 3.1 405B Human Evaluation\n",
-      "\n",
-      "| Model Comparison | Win | Tie | Loss |\n",
-      "|------------------|-----|-----|------|\n",
-      "| Llama 3.1 405B vs GPT-4-0125-Preview | 23.3% | 52.2% | 24.5% |\n",
-      "| Llama 3.1 405B vs GPT-4o | 19.1% | 51.7% | 29.2% |\n",
-      "| Llama 3.1 405B vs Claude 3.5 Sonnet | 24.9% | 50.8% | 24.2% |\n",
-      "\n",
-      "https://ai.meta.com/blog/meta-llama-3-1/\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response_gpt4o.source_nodes[1].get_content())"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama_parse",
-   "language": "python",
-   "name": "llama_parse"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

examples/multimodal/multimodal_rag_slide_deck.ipynb

@@ -1,999 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "id": "93ae9bad-b8cc-43de-ba7d-387e0155674c",
-   "metadata": {},
-   "source": [
-    "# Building a Natively Multimodal RAG Pipeline (over a Slide Deck)\n",
-    "\n",
-    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/multimodal/multimodal_rag_slide_deck.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
-    "\n",
-    "In this cookbook we show you how to build a multimodal RAG pipeline over a slide deck, with text, tables, images, diagrams, and complex layouts.\n",
-    "\n",
-    "A gap of text-based RAG is that they struggle with purely text-based representations of complex documents. For instance, if a page contains a lot of images and diagrams, a text parser would need to rely on raw OCR to extract out text. You can also use a multimodal model (e.g. gpt-4o and up) to do text extraction, but this is inherently a lossy conversion.\n",
-    "\n",
-    "Instead a **native multimodal pipeline** stores both a text and image representation of a document chunk. They are indexed via embeddings (text or image), and during synthesis both text and image are directly fed to the multimodal model for synthesis.\n",
-    "\n",
-    "This can have the following advantages:\n",
-    "- **Robustness**: This solution is more robust than a pure text or even a pure image-based approach. In a pure text RAG approach, the parsing piece can be lossy. In a pure image-based approach, multimodal OCR is not perfect and may lose out against text parsing for text-heavy documents.\n",
-    "- **Cost Optimization**: You may choose to dynamically include text-only, or text + image depending on the content of the page.\n",
-    "\n",
-    "![mm_rag_diagram](./multimodal_rag_slide_deck_img.png)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "54e8d9a7-5036-4d32-818f-00b2e888521f",
-   "metadata": {},
-   "source": [
-    "## Setup"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "70ccdd53-e68a-4199-aacb-cfe71ad1ff0b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "225c5556-a789-4386-a1ee-cce01dbeb6cf",
-   "metadata": {},
-   "source": [
-    "### Setup Observability\n",
-    "\n",
-    "We setup an integration with LlamaTrace (integration with Arize).\n",
-    "\n",
-    "If you haven't already done so, make sure to create an account here: https://llamatrace.com/login. Then create an API key and put it in the `PHOENIX_API_KEY` variable below."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0eabee1f-290a-4c85-b362-54f45c8559ae",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!pip install -U llama-index-callbacks-arize-phoenix"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "aaeb245c-730b-4c34-ad68-708fdde0e6cb",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# setup Arize Phoenix for logging/observability\n",
-    "import llama_index.core\n",
-    "import os\n",
-    "\n",
-    "PHOENIX_API_KEY = \"<PHOENIX_API_KEY>\"\n",
-    "os.environ[\"OTEL_EXPORTER_OTLP_HEADERS\"] = f\"api_key={PHOENIX_API_KEY}\"\n",
-    "llama_index.core.set_global_handler(\n",
-    "    \"arize_phoenix\", endpoint=\"https://llamatrace.com/v1/traces\"\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fbb362db-b1b1-4eea-be1a-b1f78b0779d7",
-   "metadata": {},
-   "source": [
-    "### Load Data\n",
-    "\n",
-    "Here we load the [Conoco Phillips 2023 investor meeting slide deck](https://static.conocophillips.com/files/2023-conocophillips-aim-presentation.pdf)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "8bce3407-a7d2-47e8-9eaf-ab297a94750c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!mkdir data\n",
-    "!mkdir data_images\n",
-    "!wget \"https://static.conocophillips.com/files/2023-conocophillips-aim-presentation.pdf\" -O data/conocophillips.pdf"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "246ba6b0-51af-42f9-b1b2-8d3e721ef782",
-   "metadata": {},
-   "source": [
-    "### Model Setup\n",
-    "\n",
-    "Setup models that will be used for downstream orchestration."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "16e2071d-bbc2-4707-8ae7-cb4e1fecafd3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import Settings\n",
-    "from llama_index.llms.openai import OpenAI\n",
-    "from llama_index.embeddings.openai import OpenAIEmbedding\n",
-    "\n",
-    "embed_model = OpenAIEmbedding(model=\"text-embedding-3-large\")\n",
-    "llm = OpenAI(model=\"gpt-4o\")\n",
-    "\n",
-    "Settings.embed_model = embed_model\n",
-    "Settings.llm = llm"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "e3f6416f-f580-4722-aaa9-7f3500408547",
-   "metadata": {},
-   "source": [
-    "## Use LlamaParse to Parse Text and Images\n",
-    "\n",
-    "In this example, use LlamaParse to parse both the text and images from the document.\n",
-    "\n",
-    "We parse out the text in two ways: \n",
-    "- in regular `text` mode using our default text layout algorithm\n",
-    "- in `markdown` mode using GPT-4o (`gpt4o_mode=True`). This also allows us to capture page screenshots"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "570089e5-238a-4dcc-af65-96e7393c2b4d",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "\n",
-    "parser_text = LlamaParse(result_type=\"text\")\n",
-    "parser_gpt4o = LlamaParse(result_type=\"markdown\", gpt4o_mode=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ef82a985-4088-4bb7-9a21-0318e1b9207d",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Parsing text...\n",
-      "Started parsing the file under job_id 62f157a9-9ef9-4e5b-95ac-67093fa25800\n",
-      "..........Parsing PDF file...\n",
-      "Started parsing the file under job_id 1ddd5654-062b-4e19-b488-d66efc9c509d\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(f\"Parsing text...\")\n",
-    "docs_text = parser_text.load_data(\"data/conocophillips.pdf\")\n",
-    "print(f\"Parsing PDF file...\")\n",
-    "md_json_objs = parser_gpt4o.get_json_result(\"data/conocophillips.pdf\")\n",
-    "md_json_list = md_json_objs[0][\"pages\"]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5318fb7b-fe6a-4a8a-b82e-4ed7b4512c37",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "# Commitment to Disciplined Reinvestment Rate\n",
-      "\n",
-      "| Period       | Description                          | Reinvestment Rate | WTI Average |\n",
-      "|--------------|--------------------------------------|-------------------|-------------|\n",
-      "| 2012-2016    | Industry Growth Focus                | >100%             | ~$75/BBL    |\n",
-      "| 2017-2022    | ConocoPhillips Strategy Reset        | <60%              | ~$63/BBL    |\n",
-      "| 2023E        |                                      |                   | at $80/BBL  |\n",
-      "| 2024-2028    | Disciplined Reinvestment Rate        | ~50%              | at $60/BBL  |\n",
-      "| 2029-2032    |                                      | ~6% CFO CAGR      | at $60/BBL  |\n",
-      "\n",
-      "- **Historic Reinvestment Rate**: Gray bars\n",
-      "- **Reinvestment Rate at $60/BBL WTI**: Blue bars\n",
-      "- **Reinvestment Rate at $80/BBL WTI**: Dashed blue lines\n",
-      "\n",
-      "Reinvestment rate and cash from operations (CFO) are non-GAAP measures. Definitions and reconciliations are included in the Appendix.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(md_json_list[10][\"md\"])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "eeadb16c-97eb-4622-9551-b34d7f90d72f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "image_dicts = parser_gpt4o.get_images(md_json_objs, download_path=\"data_images\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "fd3e098b-0606-4429-b48d-d4fe0140fc0e",
-   "metadata": {},
-   "source": [
-    "## Build Multimodal Index\n",
-    "\n",
-    "In this section we build the multimodal index over the parsed deck. \n",
-    "\n",
-    "We do this by creating **text** nodes from the document that contain metadata referencing the original image path.\n",
-    "\n",
-    "In this example we're indexing the text node for retrieval. The text node has a reference to both the parsed text as well as the image screenshot."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "3aae2dee-9d85-4604-8a51-705d4db527f7",
-   "metadata": {},
-   "source": [
-    "#### Get Text Nodes"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "18c24174-05ce-417f-8dd2-79c3f375db03",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.schema import TextNode\n",
-    "from typing import Optional"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "8e331dfe-a627-4e23-8c57-70ab1d9342e4",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# get pages loaded through llamaparse\n",
-    "import re\n",
-    "\n",
-    "\n",
-    "def get_page_number(file_name):\n",
-    "    match = re.search(r\"-page-(\\d+)\\.jpg$\", str(file_name))\n",
-    "    if match:\n",
-    "        return int(match.group(1))\n",
-    "    return 0\n",
-    "\n",
-    "\n",
-    "def _get_sorted_image_files(image_dir):\n",
-    "    \"\"\"Get image files sorted by page.\"\"\"\n",
-    "    raw_files = [f for f in list(Path(image_dir).iterdir()) if f.is_file()]\n",
-    "    sorted_files = sorted(raw_files, key=get_page_number)\n",
-    "    return sorted_files"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "346fe5ef-171e-4a54-9084-7a7805103a13",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from copy import deepcopy\n",
-    "from pathlib import Path\n",
-    "\n",
-    "\n",
-    "# attach image metadata to the text nodes\n",
-    "def get_text_nodes(docs, image_dir=None, json_dicts=None):\n",
-    "    \"\"\"Split docs into nodes, by separator.\"\"\"\n",
-    "    nodes = []\n",
-    "\n",
-    "    image_files = _get_sorted_image_files(image_dir) if image_dir is not None else None\n",
-    "    md_texts = [d[\"md\"] for d in json_dicts] if json_dicts is not None else None\n",
-    "\n",
-    "    doc_chunks = [c for d in docs for c in d.text.split(\"---\")]\n",
-    "    for idx, doc_chunk in enumerate(doc_chunks):\n",
-    "        chunk_metadata = {\"page_num\": idx + 1}\n",
-    "        if image_files is not None:\n",
-    "            image_file = image_files[idx]\n",
-    "            chunk_metadata[\"image_path\"] = str(image_file)\n",
-    "        if md_texts is not None:\n",
-    "            chunk_metadata[\"parsed_text_markdown\"] = md_texts[idx]\n",
-    "        chunk_metadata[\"parsed_text\"] = doc_chunk\n",
-    "        node = TextNode(\n",
-    "            text=\"\",\n",
-    "            metadata=chunk_metadata,\n",
-    "        )\n",
-    "        nodes.append(node)\n",
-    "\n",
-    "    return nodes"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "f591669c-5a8e-491d-9cef-0b754abbf26f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# this will split into pages\n",
-    "text_nodes = get_text_nodes(docs_text, image_dir=\"data_images\", json_dicts=md_json_list)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "32c13950-c1db-435f-b5b4-89d62b8b7744",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "page_num: 11\n",
-      "image_path: data_images/1ddd5654-062b-4e19-b488-d66efc9c509d-page_39.jpg\n",
-      "parsed_text_markdown: # Commitment to Disciplined Reinvestment Rate\n",
-      "\n",
-      "| Period       | Description                          | Reinvestment Rate | WTI Average |\n",
-      "|--------------|--------------------------------------|-------------------|-------------|\n",
-      "| 2012-2016    | Industry Growth Focus                | >100%             | ~$75/BBL    |\n",
-      "| 2017-2022    | ConocoPhillips Strategy Reset        | <60%              | ~$63/BBL    |\n",
-      "| 2023E        |                                      |                   | at $80/BBL  |\n",
-      "| 2024-2028    | Disciplined Reinvestment Rate        | ~50%              | at $60/BBL  |\n",
-      "| 2029-2032    |                                      | ~6% CFO CAGR      | at $60/BBL  |\n",
-      "\n",
-      "- **Historic Reinvestment Rate**: Gray bars\n",
-      "- **Reinvestment Rate at $60/BBL WTI**: Blue bars\n",
-      "- **Reinvestment Rate at $80/BBL WTI**: Dashed blue lines\n",
-      "\n",
-      "Reinvestment rate and cash from operations (CFO) are non-GAAP measures. Definitions and reconciliations are included in the Appendix.\n",
-      "parsed_text: Commitment to Disciplined Reinvestment Rate\n",
-      "                         Industry                    ConocoPhillips\n",
-      "                                                     Strategy Reset                   Disciplined Reinvestment Rate is the Foundation for Superior\n",
-      "                      Growth Focus                                                    Returns on and of Capital, while Driving Durable CFO Growth\n",
-      "                             100%                           <60%                                        50%                 6%         at $60/BBL WTI\n",
-      "                       Reinvestment Rate               Reinvestment Rate                          Reinvestment Rate10-YearCFO CAGR          Planning PriceMid-Cycle\n",
-      "                                                                                                                         2024-2032\n",
-      "    2   100%\n",
-      "    1    75%\n",
-      "    1    50%\n",
-      "    1                                                                                                                                         WTIat $80/BBL                at S80/BBL\n",
-      "         25%                'S75/BBL                        $63/BBL                                                                                                        WTI\n",
-      "                              WTI                             WTI                         at S80/BBL                       at S60/BBL                      at S60/BBL\n",
-      "                           Average                         Average                            WTI                              WTI                             WTI\n",
-      "          0%\n",
-      "                          2012-2016                        2017-2022                         2023E                          2024-2028                       2029-2032\n",
-      "                                    Historic Reinvestment Rate            Reinvestment Rate at $60/BBL WTI                 Reinvestment Rate at $80/BBL WTI\n",
-      " Reinvestment rate and cash from operations (CFO) are non-GAAP measures: Definitions and reconciliations are included in the Appendix                                  ConocoPhillips\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(text_nodes[10].get_content(metadata_mode=\"all\"))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "4f404f56-db1e-4ed7-9ba1-ead763546348",
-   "metadata": {},
-   "source": [
-    "#### Build Index\n",
-    "\n",
-    "Once the text nodes are ready, we feed into our vector store index abstraction, which will index these nodes into a simple in-memory vector store (of course, you should definitely check out our 40+ vector store integrations!)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "6ea53c31-0e38-421c-8d9b-0e3adaa1677e",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/Users/jerryliu/Programming/gpt_index/.venv/lib/python3.10/site-packages/tiktoken/core.py:50: RuntimeWarning: coroutine 'LlamaParse.aload_data' was never awaited\n",
-      "  self._core_bpe = _tiktoken.CoreBPE(mergeable_ranks, special_tokens, pat_str)\n",
-      "RuntimeWarning: Enable tracemalloc to get the object allocation traceback\n"
-     ]
-    }
-   ],
-   "source": [
-    "import os\n",
-    "from llama_index.core import (\n",
-    "    StorageContext,\n",
-    "    VectorStoreIndex,\n",
-    "    load_index_from_storage,\n",
-    ")\n",
-    "\n",
-    "if not os.path.exists(\"storage_nodes\"):\n",
-    "    index = VectorStoreIndex(text_nodes, embed_model=embed_model)\n",
-    "    # save index to disk\n",
-    "    index.set_index_id(\"vector_index\")\n",
-    "    index.storage_context.persist(\"./storage_nodes\")\n",
-    "else:\n",
-    "    # rebuild storage context\n",
-    "    storage_context = StorageContext.from_defaults(persist_dir=\"storage_nodes\")\n",
-    "    # load index\n",
-    "    index = load_index_from_storage(storage_context, index_id=\"vector_index\")\n",
-    "\n",
-    "retriever = index.as_retriever()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "5f0e33a4-9422-498d-87ee-d917bdf74d80",
-   "metadata": {},
-   "source": [
-    "## Build Multimodal Query Engine\n",
-    "\n",
-    "We now use LlamaIndex abstractions to build a **custom query engine**. In contrast to a standard RAG query engine that will retrieve the text node and only put that into the prompt (response synthesis module), this custom query engine will also load the image document, and put both the text and image document into the response synthesis module."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "35a94be2-e289-41a6-92e4-d3cb428fb0c8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.query_engine import CustomQueryEngine, SimpleMultiModalQueryEngine\n",
-    "from llama_index.core.retrievers import BaseRetriever\n",
-    "from llama_index.multi_modal_llms.openai import OpenAIMultiModal\n",
-    "from llama_index.core.schema import ImageNode, NodeWithScore, MetadataMode\n",
-    "from llama_index.core.prompts import PromptTemplate\n",
-    "from llama_index.core.base.response.schema import Response\n",
-    "from typing import Optional\n",
-    "\n",
-    "\n",
-    "gpt_4o = OpenAIMultiModal(model=\"gpt-4o\", max_new_tokens=4096)\n",
-    "\n",
-    "QA_PROMPT_TMPL = \"\"\"\\\n",
-    "Below we give parsed text from slides in two different formats, as well as the image.\n",
-    "\n",
-    "We parse the text in both 'markdown' mode as well as 'raw text' mode. Markdown mode attempts \\\n",
-    "to convert relevant diagrams into tables, whereas raw text tries to maintain the rough spatial \\\n",
-    "layout of the text.\n",
-    "\n",
-    "Use the image information first and foremost. ONLY use the text/markdown information \n",
-    "if you can't understand the image.\n",
-    "\n",
-    "---------------------\n",
-    "{context_str}\n",
-    "---------------------\n",
-    "Given the context information and not prior knowledge, answer the query. Explain whether you got the answer\n",
-    "from the parsed markdown or raw text or image, and if there's discrepancies, and your reasoning for the final answer.\n",
-    "\n",
-    "Query: {query_str}\n",
-    "Answer: \"\"\"\n",
-    "\n",
-    "QA_PROMPT = PromptTemplate(QA_PROMPT_TMPL)\n",
-    "\n",
-    "\n",
-    "class MultimodalQueryEngine(CustomQueryEngine):\n",
-    "    \"\"\"Custom multimodal Query Engine.\n",
-    "\n",
-    "    Takes in a retriever to retrieve a set of document nodes.\n",
-    "    Also takes in a prompt template and multimodal model.\n",
-    "\n",
-    "    \"\"\"\n",
-    "\n",
-    "    qa_prompt: PromptTemplate\n",
-    "    retriever: BaseRetriever\n",
-    "    multi_modal_llm: OpenAIMultiModal\n",
-    "\n",
-    "    def __init__(self, qa_prompt: Optional[PromptTemplate] = None, **kwargs) -> None:\n",
-    "        \"\"\"Initialize.\"\"\"\n",
-    "        super().__init__(qa_prompt=qa_prompt or QA_PROMPT, **kwargs)\n",
-    "\n",
-    "    def custom_query(self, query_str: str):\n",
-    "        # retrieve text nodes\n",
-    "        nodes = self.retriever.retrieve(query_str)\n",
-    "        # create ImageNode items from text nodes\n",
-    "        image_nodes = [\n",
-    "            NodeWithScore(node=ImageNode(image_path=n.metadata[\"image_path\"]))\n",
-    "            for n in nodes\n",
-    "        ]\n",
-    "\n",
-    "        # create context string from text nodes, dump into the prompt\n",
-    "        context_str = \"\\n\\n\".join(\n",
-    "            [r.get_content(metadata_mode=MetadataMode.LLM) for r in nodes]\n",
-    "        )\n",
-    "        fmt_prompt = self.qa_prompt.format(context_str=context_str, query_str=query_str)\n",
-    "\n",
-    "        # synthesize an answer from formatted text and images\n",
-    "        llm_response = self.multi_modal_llm.complete(\n",
-    "            prompt=fmt_prompt,\n",
-    "            image_documents=[image_node.node for image_node in image_nodes],\n",
-    "        )\n",
-    "        return Response(\n",
-    "            response=str(llm_response),\n",
-    "            source_nodes=nodes,\n",
-    "            metadata={\"text_nodes\": text_nodes, \"image_nodes\": image_nodes},\n",
-    "        )\n",
-    "\n",
-    "        return response"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0890be59-fb12-4bb5-959b-b2d9600f7774",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query_engine = MultimodalQueryEngine(\n",
-    "    retriever=index.as_retriever(similarity_top_k=9), multi_modal_llm=gpt_4o\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "a92aa4f1-7501-4711-b054-f02338e54e74",
-   "metadata": {},
-   "source": [
-    "### Define Baseline\n",
-    "\n",
-    "In addition, we define a \"baseline\" where we rely only on text-based indexing. Here we define an index using only the nodes that are parsed in text-mode from LlamaParse. \n",
-    "\n",
-    "**NOTE**: We don't currently include the markdown-parsed text because that was parsed with GPT-4o, so already uses a multimodal model during the text extraction phase.\n",
-    "\n",
-    "It is of course a valid experiment to compare RAG where multimodal extraction only happens during indexing, vs. the current multimodal RAG implementation where images are fed during synthesis to the LLM. "
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "c0b15a48-d177-4666-aec2-98ee90664642",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "def get_nodes(docs):\n",
-    "    \"\"\"Split docs into nodes, by separator.\"\"\"\n",
-    "    nodes = []\n",
-    "    for doc in docs:\n",
-    "        doc_chunks = doc.text.split(\"\\n---\\n\")\n",
-    "        for doc_chunk in doc_chunks:\n",
-    "            node = TextNode(\n",
-    "                text=doc_chunk,\n",
-    "                metadata=deepcopy(doc.metadata),\n",
-    "            )\n",
-    "            nodes.append(node)\n",
-    "\n",
-    "    return nodes"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2065d2c6-d6ba-4ee3-8e9e-dbc83cbcec1b",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "base_nodes = get_nodes(docs_text)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "bcaea1a8-26c9-4385-8f62-32855aa898b6",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Our Differentiated Portfolio: Deep; Durable and Diverse\n",
-      "                              20 BBOE of Resource                                           Diverse Production Base\n",
-      "                            Under $40/BBL Cost of Supply                              10-Year Plan Cumulative Production (BBOE)\n",
-      "      S50                   S32/BBL                                                Lower 48                           Alaska\n",
-      "                    Average Cost of Supply\n",
-      "  3 $40                                                                                                                       GKA        GWA\n",
-      "                                                                                                                      GPA     WNS\n",
-      "      $30                                                                                                             EMENA\n",
-      "  3                                                                                                                              Norway\n",
-      "  8   $20\n",
-      "  E                                                                                                                   Qatar      Libya\n",
-      "                                                                                                                      Asia Pacific Canada\n",
-      "      $10                                                                          Permian\n",
-      "                                                                                                                      APLNG        Montney\n",
-      "       S0\n",
-      "                                               10              15              20                         Bakken\n",
-      "                                         Resource (BBOE)                           Eagle Ford             Other       Malaysia ChinaSurmont\n",
-      "                 Lower 48      Canada       Alaska      EMENA    Asia Pacific\n",
-      "Costs assumemid-cycle price environment of S60/BBL WTI:\n",
-      "                                                                                                                                           ConocoPhillips\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(base_nodes[13].get_content(metadata_mode=\"all\"))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "f6bcfbc6-4e9b-41ad-ad81-1c4245b95cd5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "base_index = VectorStoreIndex(base_nodes, embed_model=embed_model)\n",
-    "base_query_engine = base_index.as_query_engine(llm=llm, similarity_top_k=9)"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "1f94ef26-0df5-4468-a156-903d686f02ce",
-   "metadata": {},
-   "source": [
-    "## Build a Multimodal Agent\n",
-    "\n",
-    "Build an agent around the multimodal query engine. This gives you agent capabilities like query planning/decomposition and memory around a central QA interface."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5b7a8c5f-39fc-4d04-8c56-3642f5718437",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.tools import QueryEngineTool\n",
-    "from llama_index.core.agent import FunctionCallingAgentWorker\n",
-    "\n",
-    "\n",
-    "vector_tool = QueryEngineTool.from_defaults(\n",
-    "    query_engine=query_engine,\n",
-    "    name=\"vector_tool\",\n",
-    "    description=(\n",
-    "        \"Useful for retrieving specific context from the data. Do NOT select if question asks for a summary of the data.\"\n",
-    "    ),\n",
-    ")\n",
-    "agent = FunctionCallingAgentWorker.from_tools(\n",
-    "    [vector_tool], llm=llm, verbose=True\n",
-    ").as_agent()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2b4f7eb1-d247-45fa-bb41-c02fc353a22a",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# define a similar agent for the baseline\n",
-    "base_vector_tool = QueryEngineTool.from_defaults(\n",
-    "    query_engine=base_query_engine,\n",
-    "    name=\"vector_tool\",\n",
-    "    description=(\n",
-    "        \"Useful for retrieving specific context from the data. Do NOT select if question asks for a summary of the data.\"\n",
-    "    ),\n",
-    ")\n",
-    "base_agent = FunctionCallingAgentWorker.from_tools(\n",
-    "    [base_vector_tool], llm=llm, verbose=True\n",
-    ").as_agent()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "2336f98b-c0a1-413a-849d-8a89bacb90b5",
-   "metadata": {},
-   "source": [
-    "## Try out Queries\n",
-    "\n",
-    "Let's try out queries against these documents and compare against each other."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d78e53cf-35cb-4ef8-b03e-1b47ba15ae64",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Added user message to memory: Tell me about the diverse geographies where Conoco Phillips has a production base\n",
-      "=== Calling Function ===\n",
-      "Calling function: vector_tool with args: {\"input\": \"Conoco Phillips production base geographies\"}\n",
-      "=== Function Output ===\n",
-      "ConocoPhillips' production base geographies include:\n",
-      "\n",
-      "1. **Lower 48** (Permian, Eagle Ford, Bakken, Other)\n",
-      "2. **Alaska** (GKA, GWA, GPA, WNS)\n",
-      "3. **EMENA** (Norway, Libya, Qatar)\n",
-      "4. **Asia Pacific** (APLNG, Malaysia, China)\n",
-      "5. **Canada** (Montney, Surmont)\n",
-      "\n",
-      "This information was derived from the image on page 14, which provides a detailed breakdown of the diverse production base and the regions involved. The parsed markdown and raw text also support this information, but the image provides the clearest and most comprehensive view. There are no discrepancies between the image and the parsed text in this case.\n",
-      "=== LLM Response ===\n",
-      "ConocoPhillips has a diverse production base spread across various geographies, including:\n",
-      "\n",
-      "1. **Lower 48**:\n",
-      "   - Permian Basin\n",
-      "   - Eagle Ford\n",
-      "   - Bakken\n",
-      "   - Other regions within the continental United States\n",
-      "\n",
-      "2. **Alaska**:\n",
-      "   - Greater Kuparuk Area (GKA)\n",
-      "   - Greater Prudhoe Area (GPA)\n",
-      "   - Greater Willow Area (GWA)\n",
-      "   - Western North Slope (WNS)\n",
-      "\n",
-      "3. **EMENA (Europe, Middle East, and North Africa)**:\n",
-      "   - Norway\n",
-      "   - Libya\n",
-      "   - Qatar\n",
-      "\n",
-      "4. **Asia Pacific**:\n",
-      "   - Australia Pacific LNG (APLNG)\n",
-      "   - Malaysia\n",
-      "   - China\n",
-      "\n",
-      "5. **Canada**:\n",
-      "   - Montney\n",
-      "   - Surmont\n",
-      "\n",
-      "These regions highlight the global reach and diverse geographical footprint of ConocoPhillips' production operations.\n",
-      "Added user message to memory: Tell me about the diverse geographies where Conoco Phillips has a production base\n",
-      "=== Calling Function ===\n",
-      "Calling function: vector_tool with args: {\"input\": \"diverse geographies where Conoco Phillips has a production base\"}\n",
-      "=== Function Output ===\n",
-      "ConocoPhillips has a diverse production base that includes the Lower 48 (Permian, Bakken, Eagle Ford), Alaska, Canada (Montney, Surmont), EMENA (Norway, Libya), Asia Pacific (Malaysia, China, APLNG), and Qatar.\n",
-      "=== LLM Response ===\n",
-      "ConocoPhillips has a diverse production base spanning several key geographies:\n",
-      "\n",
-      "1. **Lower 48 (United States)**: This includes major production areas such as the Permian Basin, Bakken Formation, and Eagle Ford Shale.\n",
-      "2. **Alaska**: Significant operations in the North Slope region.\n",
-      "3. **Canada**: Operations in the Montney Formation and the Surmont oil sands project.\n",
-      "4. **EMENA (Europe, Middle East, and North Africa)**: Notable operations in Norway and Libya.\n",
-      "5. **Asia Pacific**: Includes operations in Malaysia, China, and the Australia Pacific LNG (APLNG) project.\n",
-      "6. **Qatar**: Involvement in the country's energy sector.\n",
-      "\n",
-      "These regions highlight the company's extensive and varied geographical footprint in the energy production industry.\n"
-     ]
-    }
-   ],
-   "source": [
-    "query = (\n",
-    "    \"Tell me about the diverse geographies where Conoco Phillips has a production base\"\n",
-    ")\n",
-    "response = agent.query(query)\n",
-    "base_response = base_agent.query(query)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "355d2aa4-c26f-480e-b512-4446acbd9227",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "ConocoPhillips has a diverse production base spread across various geographies, including:\n",
-      "\n",
-      "1. **Lower 48**:\n",
-      "   - Permian Basin\n",
-      "   - Eagle Ford\n",
-      "   - Bakken\n",
-      "   - Other regions within the continental United States\n",
-      "\n",
-      "2. **Alaska**:\n",
-      "   - Greater Kuparuk Area (GKA)\n",
-      "   - Greater Prudhoe Area (GPA)\n",
-      "   - Greater Willow Area (GWA)\n",
-      "   - Western North Slope (WNS)\n",
-      "\n",
-      "3. **EMENA (Europe, Middle East, and North Africa)**:\n",
-      "   - Norway\n",
-      "   - Libya\n",
-      "   - Qatar\n",
-      "\n",
-      "4. **Asia Pacific**:\n",
-      "   - Australia Pacific LNG (APLNG)\n",
-      "   - Malaysia\n",
-      "   - China\n",
-      "\n",
-      "5. **Canada**:\n",
-      "   - Montney\n",
-      "   - Surmont\n",
-      "\n",
-      "These regions highlight the global reach and diverse geographical footprint of ConocoPhillips' production operations.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(str(response))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d584c560-8f49-4c10-a4db-2e0d3b7085d2",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "page_num: 14\n",
-      "image_path: data_images/1ddd5654-062b-4e19-b488-d66efc9c509d-page_12.jpg\n",
-      "parsed_text_markdown: # Our Differentiated Portfolio: Deep, Durable and Diverse\n",
-      "\n",
-      "## ~20 BBOE of Resource\n",
-      "Under $40/BBL Cost of Supply\n",
-      "\n",
-      "### ~ $32/BBL\n",
-      "Average Cost of Supply\n",
-      "\n",
-      "### WTI Cost of Supply ($/BBL)\n",
-      "\n",
-      "| Cost ($/BBL) | Resource (BBOE) |\n",
-      "|--------------|-----------------|\n",
-      "| $0           | 0               |\n",
-      "| $10          |                 |\n",
-      "| $20          |                 |\n",
-      "| $30          |                 |\n",
-      "| $40          |                 |\n",
-      "| $50          |                 |\n",
-      "\n",
-      "- **Legend:**\n",
-      "  - Lower 48\n",
-      "  - Canada\n",
-      "  - Alaska\n",
-      "  - EMENA\n",
-      "  - Asia Pacific\n",
-      "\n",
-      "*Costs assume a mid-cycle price environment of $60/BBL WTI.*\n",
-      "\n",
-      "## Diverse Production Base\n",
-      "10-Year Plan Cumulative Production (BBOE)\n",
-      "\n",
-      "| Region       | Sub-region      |\n",
-      "|--------------|-----------------|\n",
-      "| Lower 48     | Permian         |\n",
-      "|              | Eagle Ford      |\n",
-      "|              | Bakken          |\n",
-      "|              | Other           |\n",
-      "| Alaska       | GKA             |\n",
-      "|              | GWA             |\n",
-      "|              | GPA             |\n",
-      "|              | WNS             |\n",
-      "| EMENA        | Norway          |\n",
-      "|              | Libya           |\n",
-      "|              | Qatar           |\n",
-      "| Asia Pacific | APLNG           |\n",
-      "|              | Malaysia        |\n",
-      "|              | China           |\n",
-      "| Canada       | Montney         |\n",
-      "|              | Surmont         |\n",
-      "parsed_text: Our Differentiated Portfolio: Deep; Durable and Diverse\n",
-      "                              20 BBOE of Resource                                           Diverse Production Base\n",
-      "                            Under $40/BBL Cost of Supply                              10-Year Plan Cumulative Production (BBOE)\n",
-      "      S50                   S32/BBL                                                Lower 48                           Alaska\n",
-      "                    Average Cost of Supply\n",
-      "  3 $40                                                                                                                       GKA        GWA\n",
-      "                                                                                                                      GPA     WNS\n",
-      "      $30                                                                                                             EMENA\n",
-      "  3                                                                                                                              Norway\n",
-      "  8   $20\n",
-      "  E                                                                                                                   Qatar      Libya\n",
-      "                                                                                                                      Asia Pacific Canada\n",
-      "      $10                                                                          Permian\n",
-      "                                                                                                                      APLNG        Montney\n",
-      "       S0\n",
-      "                                               10              15              20                         Bakken\n",
-      "                                         Resource (BBOE)                           Eagle Ford             Other       Malaysia ChinaSurmont\n",
-      "                 Lower 48      Canada       Alaska      EMENA    Asia Pacific\n",
-      "Costs assumemid-cycle price environment of S60/BBL WTI:\n",
-      "                                                                                                                                           ConocoPhillips\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(response.source_nodes[7].get_content(metadata_mode=\"all\"))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d21d694b-6618-4d04-a6f6-8b0c2625f539",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "ConocoPhillips has a diverse production base spanning several key geographies:\n",
-      "\n",
-      "1. **Lower 48 (United States)**: This includes major production areas such as the Permian Basin, Bakken Formation, and Eagle Ford Shale.\n",
-      "2. **Alaska**: Significant operations in the North Slope region.\n",
-      "3. **Canada**: Operations in the Montney Formation and the Surmont oil sands project.\n",
-      "4. **EMENA (Europe, Middle East, and North Africa)**: Notable operations in Norway and Libya.\n",
-      "5. **Asia Pacific**: Includes operations in Malaysia, China, and the Australia Pacific LNG (APLNG) project.\n",
-      "6. **Qatar**: Involvement in the country's energy sector.\n",
-      "\n",
-      "These regions highlight the company's extensive and varied geographical footprint in the energy production industry.\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(str(base_response))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "d3afccae-ad8d-4c5d-9d93-810dba413a5d",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Our Differentiated Portfolio: Deep; Durable and Diverse\n",
-      "                              20 BBOE of Resource                                           Diverse Production Base\n",
-      "                            Under $40/BBL Cost of Supply                              10-Year Plan Cumulative Production (BBOE)\n",
-      "      S50                   S32/BBL                                                Lower 48                           Alaska\n",
-      "                    Average Cost of Supply\n",
-      "  3 $40                                                                                                                       GKA        GWA\n",
-      "                                                                                                                      GPA     WNS\n",
-      "      $30                                                                                                             EMENA\n",
-      "  3                                                                                                                              Norway\n",
-      "  8   $20\n",
-      "  E                                                                                                                   Qatar      Libya\n",
-      "                                                                                                                      Asia Pacific Canada\n",
-      "      $10                                                                          Permian\n",
-      "                                                                                                                      APLNG        Montney\n",
-      "       S0\n",
-      "                                               10              15              20                         Bakken\n",
-      "                                         Resource (BBOE)                           Eagle Ford             Other       Malaysia ChinaSurmont\n",
-      "                 Lower 48      Canada       Alaska      EMENA    Asia Pacific\n",
-      "Costs assumemid-cycle price environment of S60/BBL WTI:\n",
-      "                                                                                                                                           ConocoPhillips\n"
-     ]
-    }
-   ],
-   "source": [
-    "print(base_response.source_nodes[1].get_content(metadata_mode=\"all\"))"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama_index_v3",
-   "language": "python",
-   "name": "llama_index_v3"
-  },
-  "language_info": {
-   "codemirror_mode": {
-    "name": "ipython",
-    "version": 3
-   },
-   "file_extension": ".py",
-   "mimetype": "text/x-python",
-   "name": "python",
-   "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython3"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

examples/multimodal/product_manual_rag.ipynb

@@ -1,834 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Building a RAG Pipeline over IKEA Product Instruction Manuals\n",
-    "\n",
-    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/multimodal/product_manual_rag.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "This cookbook shows how to use LlamaParse and OpenAI's multimodal models to query over IKEA instruction manual PDFs, which mainly contain images and diagrams to show how one can assemble the product.\n",
-    "\n",
-    "LlamaParse and multimodal LLMs can interpret these diagrams and translate them into textual instructions. With textual assistance, confusing visual instructions within the IKEA product manuals can be made easier to understand and interpret. Additionally, textual instructions can be helpful for those who are visually impaired."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Install and Setup\n",
-    "\n",
-    "Install LlamaIndex, download the data, and apply `nest_asyncio`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%pip install llama-index llama-parse llama-index-multi-modal-llms-openai git+https://github.com/openai/CLIP.git"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "!wget https://github.com/user-attachments/files/16461058/data.zip -O data.zip\n",
-    "!unzip -o data.zip\n",
-    "!rm data.zip"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import nest_asyncio\n",
-    "\n",
-    "nest_asyncio.apply()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Set up your OpenAI and LlamaCloud keys."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import os\n",
-    "\n",
-    "os.environ[\"OPENAI_API_KEY\"] = \"<Your OpenAI API Key>\"\n",
-    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"<Your LlamaCloud API Key>\""
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Code Implementation"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Set up LlamaParse. We will parse the PDF files into markdown and use the GPT-4o multimodal model to parse the PDFs."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Load data from the parser."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_parse import LlamaParse\n",
-    "\n",
-    "parser = LlamaParse(\n",
-    "    result_type=\"markdown\",\n",
-    "    parsing_instruction=\"You are given IKEA assembly instruction manuals\",\n",
-    "    use_vendor_multimodal_model=True,\n",
-    "    vendor_multimodal_model_name=\"openai-gpt4o\",\n",
-    "    show_progress=True,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "DATA_DIR = \"data\"\n",
-    "\n",
-    "\n",
-    "def get_data_files(data_dir=DATA_DIR) -> list[str]:\n",
-    "    files = []\n",
-    "    for f in os.listdir(data_dir):\n",
-    "        fname = os.path.join(data_dir, f)\n",
-    "        if os.path.isfile(fname):\n",
-    "            files.append(fname)\n",
-    "    return files\n",
-    "\n",
-    "\n",
-    "files = get_data_files()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Load data into docs, and save images from PDFs into `data_images` directory."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "md_json_objs = parser.get_json_result(files)\n",
-    "md_json_list = md_json_objs[0][\"pages\"]\n",
-    "image_dicts = parser.get_images(md_json_objs, download_path=\"data_images\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Create helper functions to create a list of `TextNode`s from the markdown tables to feed into the `VectorStoreIndex`."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import re\n",
-    "from pathlib import Path\n",
-    "import typing as t\n",
-    "from llama_index.core.schema import TextNode\n",
-    "\n",
-    "\n",
-    "def get_page_number(file_name):\n",
-    "    \"\"\"Gets page number of images using regex on file names\"\"\"\n",
-    "    match = re.search(r\"-page-(\\d+)\\.jpg$\", str(file_name))\n",
-    "    if match:\n",
-    "        return int(match.group(1))\n",
-    "    return 0\n",
-    "\n",
-    "\n",
-    "def _get_sorted_image_files(image_dir):\n",
-    "    \"\"\"Get image files sorted by page.\"\"\"\n",
-    "    raw_files = [f for f in list(Path(image_dir).iterdir()) if f.is_file()]\n",
-    "    sorted_files = sorted(raw_files, key=get_page_number)\n",
-    "    return sorted_files\n",
-    "\n",
-    "\n",
-    "def get_text_nodes(json_dicts, image_dir) -> t.List[TextNode]:\n",
-    "    \"\"\"Creates nodes from json + images\"\"\"\n",
-    "\n",
-    "    nodes = []\n",
-    "\n",
-    "    docs = [doc[\"md\"] for doc in json_dicts]  # extract text\n",
-    "    image_files = _get_sorted_image_files(image_dir)  # extract images\n",
-    "\n",
-    "    for idx, doc in enumerate(docs):\n",
-    "        # adds both a text node and the corresponding image node (jpg of the page) for each page\n",
-    "        node = TextNode(\n",
-    "            text=doc,\n",
-    "            metadata={\"image_path\": str(image_files[idx]), \"page_num\": idx + 1},\n",
-    "        )\n",
-    "        nodes.append(node)\n",
-    "\n",
-    "    return nodes\n",
-    "\n",
-    "\n",
-    "text_nodes = get_text_nodes(md_json_list, \"data_images\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Index the documents."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core import (\n",
-    "    VectorStoreIndex,\n",
-    "    StorageContext,\n",
-    "    load_index_from_storage,\n",
-    "    Settings,\n",
-    ")\n",
-    "from llama_index.embeddings.openai import OpenAIEmbedding\n",
-    "from llama_index.llms.openai import OpenAI\n",
-    "\n",
-    "embed_model = OpenAIEmbedding(model=\"text-embedding-3-large\")\n",
-    "llm = OpenAI(\"gpt-4o\")\n",
-    "\n",
-    "Settings.llm = llm\n",
-    "Settings.embed_model = embed_model\n",
-    "\n",
-    "if not os.path.exists(\"storage_ikea\"):\n",
-    "    index = VectorStoreIndex(text_nodes, embed_model=embed_model)\n",
-    "    index.storage_context.persist(persist_dir=\"./storage_ikea\")\n",
-    "else:\n",
-    "    ctx = StorageContext.from_defaults(persist_dir=\"./storage_ikea\")\n",
-    "    index = load_index_from_storage(ctx)\n",
-    "\n",
-    "retriever = index.as_retriever()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Create a custom query engine that uses GPT-4o's multimodal model."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.query_engine import CustomQueryEngine\n",
-    "from llama_index.core.retrievers import BaseRetriever\n",
-    "from llama_index.multi_modal_llms.openai import OpenAIMultiModal\n",
-    "from llama_index.core.schema import NodeWithScore, MetadataMode\n",
-    "from llama_index.core.base.response.schema import Response\n",
-    "from llama_index.core.prompts import PromptTemplate\n",
-    "from llama_index.core.schema import ImageNode\n",
-    "\n",
-    "QA_PROMPT_TMPL = \"\"\"\\\n",
-    "Below we give parsed text from slides in two different formats, as well as the image.\n",
-    "\n",
-    "We parse the text in both 'markdown' mode as well as 'raw text' mode. Markdown mode attempts \\\n",
-    "to convert relevant diagrams into tables, whereas raw text tries to maintain the rough spatial \\\n",
-    "layout of the text.\n",
-    "\n",
-    "Use the image information first and foremost. ONLY use the text/markdown information \n",
-    "if you can't understand the image.\n",
-    "\n",
-    "---------------------\n",
-    "{context_str}\n",
-    "---------------------\n",
-    "Given the context information and not prior knowledge, answer the query. Explain whether you got the answer\n",
-    "from the parsed markdown or raw text or image, and if there's discrepancies, and your reasoning for the final answer.\n",
-    "\n",
-    "Query: {query_str}\n",
-    "Answer: \"\"\"\n",
-    "\n",
-    "QA_PROMPT = PromptTemplate(QA_PROMPT_TMPL)\n",
-    "\n",
-    "gpt_4o_mm = OpenAIMultiModal(model=\"gpt-4o\", max_new_tokens=4096)\n",
-    "\n",
-    "\n",
-    "class MultimodalQueryEngine(CustomQueryEngine):\n",
-    "    qa_prompt: PromptTemplate\n",
-    "    retriever: BaseRetriever\n",
-    "    multi_modal_llm: OpenAIMultiModal\n",
-    "\n",
-    "    def __init__(\n",
-    "        self,\n",
-    "        qa_prompt: PromptTemplate,\n",
-    "        retriever: BaseRetriever,\n",
-    "        multi_modal_llm: OpenAIMultiModal,\n",
-    "    ):\n",
-    "        super().__init__(\n",
-    "            qa_prompt=qa_prompt, retriever=retriever, multi_modal_llm=multi_modal_llm\n",
-    "        )\n",
-    "\n",
-    "    def custom_query(self, query_str: str):\n",
-    "        # retrieve most relevant nodes\n",
-    "        nodes = self.retriever.retrieve(query_str)\n",
-    "\n",
-    "        # create image nodes from the image associated with those nodes\n",
-    "        image_nodes = [\n",
-    "            NodeWithScore(node=ImageNode(image_path=n.node.metadata[\"image_path\"]))\n",
-    "            for n in nodes\n",
-    "        ]\n",
-    "\n",
-    "        # create context string from parsed markdown text\n",
-    "        ctx_str = \"\\n\\n\".join(\n",
-    "            [r.node.get_content(metadata_mode=MetadataMode.LLM) for r in nodes]\n",
-    "        )\n",
-    "        # prompt for the LLM\n",
-    "        fmt_prompt = self.qa_prompt.format(context_str=ctx_str, query_str=query_str)\n",
-    "\n",
-    "        # use the multimodal LLM to interpret images and generate a response to the prompt\n",
-    "        llm_repsonse = self.multi_modal_llm.complete(\n",
-    "            prompt=fmt_prompt,\n",
-    "            image_documents=[image_node.node for image_node in image_nodes],\n",
-    "        )\n",
-    "        return Response(\n",
-    "            response=str(llm_repsonse),\n",
-    "            source_nodes=nodes,\n",
-    "            metadata={\"text_nodes\": text_nodes, \"image_nodes\": image_nodes},\n",
-    "        )"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Create a query engine instance."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "query_engine = MultimodalQueryEngine(\n",
-    "    qa_prompt=QA_PROMPT,\n",
-    "    retriever=index.as_retriever(similarity_top_k=9),\n",
-    "    multi_modal_llm=gpt_4o_mm,\n",
-    ")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "\n",
-    "## Example Queries"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/markdown": [
-       "The query asks about the parts included in the Uppspel, but the provided images and parsed text do not contain any information about the Uppspel. Instead, they contain information about other IKEA products such as SMÅGÖRA, FREDDE, and TUFFING.\n",
-       "\n",
-       "Therefore, based on the provided images and parsed text, I cannot determine the parts included in the Uppspel. The answer cannot be derived from the given information."
-      ],
-      "text/plain": [
-       "<IPython.core.display.Markdown object>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "from IPython.display import display, Markdown\n",
-    "\n",
-    "response = query_engine.query(\"What parts are included in the Uppspel?\")\n",
-    "display(Markdown(str(response)))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/markdown": [
-       "The Tuffing is a bunk bed frame with a minimalist design, featuring a metal frame and safety rails on the top bunk. The image provided shows the Tuffing bunk bed with a ladder for access to the top bunk and a simple, sturdy construction.\n",
-       "\n",
-       "I got the answer from the image provided. The image clearly shows the design and structure of the Tuffing bunk bed. There were no discrepancies between the parsed markdown or raw text and the image. The image was the primary source for understanding what the Tuffing looks like."
-      ],
-      "text/plain": [
-       "<IPython.core.display.Markdown object>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "response = query_engine.query(\"What does the Tuffing look like?\")\n",
-    "display(Markdown(str(response)))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/markdown": [
-       "The query asks for step 4 of assembling the Nordli. Based on the provided information, step 4 is described in the parsed text as follows:\n",
-       "\n",
-       "**Step 4:**\n",
-       "- Insert the provided tool into the hole as shown.\n",
-       "- Ensure the structure is properly aligned and secure.\n",
-       "- Push down firmly to lock the structure in place.\n",
-       "\n",
-       "This information was derived from the parsed text, as the image provided does not contain step-by-step instructions for the Nordli assembly. There are no discrepancies between the parsed markdown and raw text for this step."
-      ],
-      "text/plain": [
-       "<IPython.core.display.Markdown object>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "response = query_engine.query(\"What is step 4 of assembling the Nordli?\")\n",
-    "display(Markdown(str(response)))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/markdown": [
-       "If you're confused with reading the manual, you should contact IKEA customer service for assistance. This information is derived from the image on page 2, which shows a person with a question mark next to an IKEA box and another person making a phone call to IKEA. This visual cue indicates that contacting IKEA customer service is the recommended action if you need help."
-      ],
-      "text/plain": [
-       "<IPython.core.display.Markdown object>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "response = query_engine.query(\n",
-    "    \"What should I do if I'm confused with reading the manual?\"\n",
-    ")\n",
-    "display(Markdown(str(response)))"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can also create an agent around the query engine and chat with the agent."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from llama_index.core.agent import FunctionCallingAgentWorker\n",
-    "from llama_index.core.tools import QueryEngineTool\n",
-    "\n",
-    "query_engine_tool = QueryEngineTool.from_defaults(\n",
-    "    query_engine=query_engine,\n",
-    "    name=\"query_engine_tool\",\n",
-    "    description=\"Useful for retrieving specific context from the data. Do NOT select if question asks for a summary of the data.\",\n",
-    ")\n",
-    "agent = FunctionCallingAgentWorker.from_tools(\n",
-    "    [query_engine_tool], llm=llm, verbose=True\n",
-    ").as_agent()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Added user message to memory: Give a step-by-step instruction guide on how to assemble the Smagora\n",
-      "=== Calling Function ===\n",
-      "Calling function: query_engine_tool with args: {\"input\": \"step-by-step instruction guide on how to assemble the Smagora\"}\n",
-      "=== Function Output ===\n",
-      "The step-by-step instruction guide on how to assemble the Smågåra crib is provided in the images. The images show detailed visual instructions for each step of the assembly process, including the tools required, the parts involved, and the specific actions to be taken.\n",
-      "\n",
-      "Here is a summary of the steps based on the images:\n",
-      "\n",
-      "1. **Tools Required**:\n",
-      "   - Flathead screwdriver\n",
-      "   - Phillips screwdriver\n",
-      "   - Hammer\n",
-      "\n",
-      "2. **Preparation**:\n",
-      "   - Do not assemble alone; assemble with a partner.\n",
-      "   - Do not assemble on a hard surface; use a soft surface to avoid damage.\n",
-      "   - If you have questions or need assistance, contact IKEA customer service.\n",
-      "\n",
-      "3. **Step 1**:\n",
-      "   - Insert 12 screws into the designated holes on the frame.\n",
-      "\n",
-      "4. **Step 2**:\n",
-      "   - Align the side panels with the headboard and footboard.\n",
-      "   - Use 4 connectors and secure them with bolts and washers.\n",
-      "   - Tighten using the provided tool.\n",
-      "   - Carefully flip the structure as shown.\n",
-      "\n",
-      "5. **Step 3**:\n",
-      "   - Use the provided Allen key to tighten the screws into the designated holes.\n",
-      "   - Ensure the screws are properly aligned and tightened.\n",
-      "   - Repeat this process for all four screws.\n",
-      "   - Make sure the screws are flush with the surface.\n",
-      "\n",
-      "6. **Step 4**:\n",
-      "   - Insert the provided tool into the hole as shown.\n",
-      "   - Ensure the structure is properly aligned and secure.\n",
-      "   - Push down firmly to lock the structure in place.\n",
-      "\n",
-      "7. **Step 5**:\n",
-      "   - Insert 4 dowels into the designated holes on the board.\n",
-      "\n",
-      "8. **Step 6**:\n",
-      "   - Align the board with the dowels and insert it into the corresponding slots on the frame.\n",
-      "\n",
-      "9. **Step 7**:\n",
-      "   - Insert the top panel into the side panels.\n",
-      "   - Use 4 screws to secure the top panel.\n",
-      "   - Ensure the screws are properly aligned and tightened using the provided tool.\n",
-      "\n",
-      "10. **Step 8**:\n",
-      "    - Carefully flip the assembled structure upright.\n",
-      "    - Use 2 screws to secure the bottom panel.\n",
-      "    - Tighten the screws with the provided tool.\n",
-      "\n",
-      "These steps are derived from the images provided, which offer a clear and detailed visual guide for assembling the Smågåra crib.\n",
-      "=== LLM Response ===\n",
-      "Here is a step-by-step instruction guide on how to assemble the Smågåra crib:\n",
-      "\n",
-      "### Tools Required:\n",
-      "- Flathead screwdriver\n",
-      "- Phillips screwdriver\n",
-      "- Hammer\n",
-      "- Allen key (provided in the package)\n",
-      "\n",
-      "### Preparation:\n",
-      "- **Safety First**: Assemble with a partner to ensure safety and ease.\n",
-      "- **Surface**: Assemble on a soft surface to avoid damaging the parts.\n",
-      "- **Assistance**: If you have questions or need help, contact IKEA customer service.\n",
-      "\n",
-      "### Step-by-Step Assembly:\n",
-      "\n",
-      "#### Step 1: Insert Screws into the Frame\n",
-      "1. Insert 12 screws into the designated holes on the frame.\n",
-      "2. Ensure the screws are properly aligned.\n",
-      "\n",
-      "#### Step 2: Align and Secure Side Panels\n",
-      "1. Align the side panels with the headboard and footboard.\n",
-      "2. Use 4 connectors and secure them with bolts and washers.\n",
-      "3. Tighten the bolts using the provided tool.\n",
-      "4. Carefully flip the structure as shown in the instructions.\n",
-      "\n",
-      "#### Step 3: Tighten Screws\n",
-      "1. Use the provided Allen key to tighten the screws into the designated holes.\n",
-      "2. Ensure the screws are properly aligned and tightened.\n",
-      "3. Repeat this process for all four screws.\n",
-      "4. Make sure the screws are flush with the surface.\n",
-      "\n",
-      "#### Step 4: Lock the Structure\n",
-      "1. Insert the provided tool into the hole as shown.\n",
-      "2. Ensure the structure is properly aligned and secure.\n",
-      "3. Push down firmly to lock the structure in place.\n",
-      "\n",
-      "#### Step 5: Insert Dowels\n",
-      "1. Insert 4 dowels into the designated holes on the board.\n",
-      "\n",
-      "#### Step 6: Align and Insert the Board\n",
-      "1. Align the board with the dowels.\n",
-      "2. Insert the board into the corresponding slots on the frame.\n",
-      "\n",
-      "#### Step 7: Secure the Top Panel\n",
-      "1. Insert the top panel into the side panels.\n",
-      "2. Use 4 screws to secure the top panel.\n",
-      "3. Ensure the screws are properly aligned and tightened using the provided tool.\n",
-      "\n",
-      "#### Step 8: Secure the Bottom Panel\n",
-      "1. Carefully flip the assembled structure upright.\n",
-      "2. Use 2 screws to secure the bottom panel.\n",
-      "3. Tighten the screws with the provided tool.\n",
-      "\n",
-      "By following these steps, you should be able to assemble the Smågåra crib successfully. If you encounter any issues, refer to the visual instructions provided in the package or contact IKEA customer service for assistance.\n"
-     ]
-    },
-    {
-     "data": {
-      "text/markdown": [
-       "Here is a step-by-step instruction guide on how to assemble the Smågåra crib:\n",
-       "\n",
-       "### Tools Required:\n",
-       "- Flathead screwdriver\n",
-       "- Phillips screwdriver\n",
-       "- Hammer\n",
-       "- Allen key (provided in the package)\n",
-       "\n",
-       "### Preparation:\n",
-       "- **Safety First**: Assemble with a partner to ensure safety and ease.\n",
-       "- **Surface**: Assemble on a soft surface to avoid damaging the parts.\n",
-       "- **Assistance**: If you have questions or need help, contact IKEA customer service.\n",
-       "\n",
-       "### Step-by-Step Assembly:\n",
-       "\n",
-       "#### Step 1: Insert Screws into the Frame\n",
-       "1. Insert 12 screws into the designated holes on the frame.\n",
-       "2. Ensure the screws are properly aligned.\n",
-       "\n",
-       "#### Step 2: Align and Secure Side Panels\n",
-       "1. Align the side panels with the headboard and footboard.\n",
-       "2. Use 4 connectors and secure them with bolts and washers.\n",
-       "3. Tighten the bolts using the provided tool.\n",
-       "4. Carefully flip the structure as shown in the instructions.\n",
-       "\n",
-       "#### Step 3: Tighten Screws\n",
-       "1. Use the provided Allen key to tighten the screws into the designated holes.\n",
-       "2. Ensure the screws are properly aligned and tightened.\n",
-       "3. Repeat this process for all four screws.\n",
-       "4. Make sure the screws are flush with the surface.\n",
-       "\n",
-       "#### Step 4: Lock the Structure\n",
-       "1. Insert the provided tool into the hole as shown.\n",
-       "2. Ensure the structure is properly aligned and secure.\n",
-       "3. Push down firmly to lock the structure in place.\n",
-       "\n",
-       "#### Step 5: Insert Dowels\n",
-       "1. Insert 4 dowels into the designated holes on the board.\n",
-       "\n",
-       "#### Step 6: Align and Insert the Board\n",
-       "1. Align the board with the dowels.\n",
-       "2. Insert the board into the corresponding slots on the frame.\n",
-       "\n",
-       "#### Step 7: Secure the Top Panel\n",
-       "1. Insert the top panel into the side panels.\n",
-       "2. Use 4 screws to secure the top panel.\n",
-       "3. Ensure the screws are properly aligned and tightened using the provided tool.\n",
-       "\n",
-       "#### Step 8: Secure the Bottom Panel\n",
-       "1. Carefully flip the assembled structure upright.\n",
-       "2. Use 2 screws to secure the bottom panel.\n",
-       "3. Tighten the screws with the provided tool.\n",
-       "\n",
-       "By following these steps, you should be able to assemble the Smågåra crib successfully. If you encounter any issues, refer to the visual instructions provided in the package or contact IKEA customer service for assistance."
-      ],
-      "text/plain": [
-       "<IPython.core.display.Markdown object>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "response = agent.chat(\n",
-    "    \"Give a step-by-step instruction guide on how to assemble the Smagora\"\n",
-    ")\n",
-    "display(Markdown(str(response)))"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Added user message to memory: How do I assemble the Fredde?\n",
-      "=== Calling Function ===\n",
-      "Calling function: query_engine_tool with args: {\"input\": \"step-by-step instruction guide on how to assemble the Fredde\"}\n",
-      "=== Function Output ===\n",
-      "The query asks for a step-by-step instruction guide on how to assemble the Fredde. However, based on the provided images and parsed text, there is no specific mention or visual representation of the Fredde assembly instructions. The images and text provided are related to other IKEA products such as Tuffing and Smågöra, but not Fredde.\n",
-      "\n",
-      "Therefore, I cannot provide the step-by-step instructions for assembling the Fredde from the given information. If you have the specific instructions for Fredde, please provide them, and I can assist you further.\n",
-      "=== LLM Response ===\n",
-      "It appears that the specific step-by-step instructions for assembling the Fredde desk are not available in the provided data. However, I can offer a general guide based on typical assembly procedures for IKEA furniture. For the most accurate and detailed instructions, please refer to the assembly manual that comes with the product.\n",
-      "\n",
-      "### General Assembly Guide for Fredde Desk:\n",
-      "\n",
-      "#### Tools Required:\n",
-      "- Phillips screwdriver\n",
-      "- Flathead screwdriver\n",
-      "- Allen key (usually provided in the package)\n",
-      "- Hammer (if needed for dowels)\n",
-      "\n",
-      "### Step-by-Step Assembly:\n",
-      "\n",
-      "#### Step 1: Unpack and Organize\n",
-      "1. **Unpack** all the parts and hardware.\n",
-      "2. **Organize** the parts by type and size to make the assembly process easier.\n",
-      "\n",
-      "#### Step 2: Assemble the Main Frame\n",
-      "1. **Connect the Side Panels**: Attach the side panels to the back panel using screws and dowels as indicated in the manual.\n",
-      "2. **Secure the Bottom Panel**: Attach the bottom panel to the side panels.\n",
-      "\n",
-      "#### Step 3: Attach the Shelves\n",
-      "1. **Install the Lower Shelves**: Insert the lower shelves into the designated slots and secure them with screws.\n",
-      "2. **Install the Upper Shelves**: Repeat the process for the upper shelves.\n",
-      "\n",
-      "#### Step 4: Attach the Desktop\n",
-      "1. **Align the Desktop**: Place the desktop on top of the frame, ensuring it is properly aligned.\n",
-      "2. **Secure the Desktop**: Use screws to secure the desktop to the frame.\n",
-      "\n",
-      "#### Step 5: Install Additional Features\n",
-      "1. **Attach Monitor Shelf**: If the Fredde desk includes a monitor shelf, attach it to the back panel using screws.\n",
-      "2. **Install Side Extensions**: Attach any side extensions or additional shelves as per the instructions.\n",
-      "\n",
-      "#### Step 6: Final Adjustments\n",
-      "1. **Check Stability**: Ensure all screws are tightened and the desk is stable.\n",
-      "2. **Adjust Height**: If the desk has adjustable height features, set it to the desired height.\n",
-      "\n",
-      "#### Step 7: Clean Up\n",
-      "1. **Remove Packaging**: Dispose of any packaging materials.\n",
-      "2. **Organize Tools**: Put away your tools and clean the workspace.\n",
-      "\n",
-      "For the most accurate and detailed instructions, please refer to the assembly manual that comes with the Fredde desk. If you encounter any issues, IKEA customer service can provide additional support.\n"
-     ]
-    },
-    {
-     "data": {
-      "text/markdown": [
-       "It appears that the specific step-by-step instructions for assembling the Fredde desk are not available in the provided data. However, I can offer a general guide based on typical assembly procedures for IKEA furniture. For the most accurate and detailed instructions, please refer to the assembly manual that comes with the product.\n",
-       "\n",
-       "### General Assembly Guide for Fredde Desk:\n",
-       "\n",
-       "#### Tools Required:\n",
-       "- Phillips screwdriver\n",
-       "- Flathead screwdriver\n",
-       "- Allen key (usually provided in the package)\n",
-       "- Hammer (if needed for dowels)\n",
-       "\n",
-       "### Step-by-Step Assembly:\n",
-       "\n",
-       "#### Step 1: Unpack and Organize\n",
-       "1. **Unpack** all the parts and hardware.\n",
-       "2. **Organize** the parts by type and size to make the assembly process easier.\n",
-       "\n",
-       "#### Step 2: Assemble the Main Frame\n",
-       "1. **Connect the Side Panels**: Attach the side panels to the back panel using screws and dowels as indicated in the manual.\n",
-       "2. **Secure the Bottom Panel**: Attach the bottom panel to the side panels.\n",
-       "\n",
-       "#### Step 3: Attach the Shelves\n",
-       "1. **Install the Lower Shelves**: Insert the lower shelves into the designated slots and secure them with screws.\n",
-       "2. **Install the Upper Shelves**: Repeat the process for the upper shelves.\n",
-       "\n",
-       "#### Step 4: Attach the Desktop\n",
-       "1. **Align the Desktop**: Place the desktop on top of the frame, ensuring it is properly aligned.\n",
-       "2. **Secure the Desktop**: Use screws to secure the desktop to the frame.\n",
-       "\n",
-       "#### Step 5: Install Additional Features\n",
-       "1. **Attach Monitor Shelf**: If the Fredde desk includes a monitor shelf, attach it to the back panel using screws.\n",
-       "2. **Install Side Extensions**: Attach any side extensions or additional shelves as per the instructions.\n",
-       "\n",
-       "#### Step 6: Final Adjustments\n",
-       "1. **Check Stability**: Ensure all screws are tightened and the desk is stable.\n",
-       "2. **Adjust Height**: If the desk has adjustable height features, set it to the desired height.\n",
-       "\n",
-       "#### Step 7: Clean Up\n",
-       "1. **Remove Packaging**: Dispose of any packaging materials.\n",
-       "2. **Organize Tools**: Put away your tools and clean the workspace.\n",
-       "\n",
-       "For the most accurate and detailed instructions, please refer to the assembly manual that comes with the Fredde desk. If you encounter any issues, IKEA customer service can provide additional support."
-      ],
-      "text/plain": [
-       "<IPython.core.display.Markdown object>"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
-    }
-   ],
-   "source": [
-    "response = agent.chat(\"How do I assemble the Fredde?\")\n",
-    "display(Markdown(str(response)))"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "llama-parse-5ZmnAQ0r-py3.11",
-   "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"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 2
-}