v0.6.0 (#603)

* v0.6.0

* nit release

* nit

.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/workflows/build_package.yml

@@ -45,4 +45,4 @@ jobs:
       - name: Test import
         shell: bash
         working-directory: ${{ vars.RUNNER_TEMP }}
-        run: python -c "import llama_parse"
+        run: python -c "import llama_cloud_services"

.github/workflows/publish_release.yml

@@ -23,18 +23,32 @@ jobs:
         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
+
+      - name: Build and publish llama-cloud-services
+        uses: JRubics/poetry-publish@v2.1
         with:
+          poetry_version: ${{ env.POETRY_VERSION }}
+          python_version: ${{ env.PYTHON_VERSION }}
           pypi_token: ${{ secrets.LLAMA_PARSE_PYPI_TOKEN }}
-          ignore_dev_requirements: "yes"
+          poetry_install_options: "--without dev"
+
+      - name: Build and publish llama-parse
+        uses: JRubics/poetry-publish@v2.1
+        with:
+          poetry_version: ${{ env.POETRY_VERSION }}
+          python_version: ${{ env.PYTHON_VERSION }}
+          working_directory: "llama_parse"
+          pypi_token: ${{ secrets.LLAMA_PARSE_PYPI_TOKEN }}
+          poetry_install_options: "--without dev"
 
       - name: Create GitHub Release
         id: create_release
@@ -52,6 +66,7 @@ jobs:
           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

.github/workflows/unit_test.yml

@@ -17,7 +17,7 @@ jobs:
       # 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"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
       - uses: actions/checkout@v3
         with:

.pre-commit-config.yaml

@@ -33,6 +33,7 @@ repos:
     rev: v1.0.1
     hooks:
       - id: mypy
+        exclude: ^tests/
         additional_dependencies:
           [
             "types-requests",
@@ -46,7 +47,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

README.md

@@ -1,138 +1,45 @@
-# 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.).
+- [LlamaReport (beta/invite-only)](./report.md) - A prebuilt agentic report builder that can be used to build reports from a variety of data sources.
+- [LlamaExtract (coming soon!)]() - A prebuilt agentic data extractor that can be used to transform data into a structured JSON representation.
 
 ## Getting Started
 
-First, login and get an api-key from [**https://cloud.llamaindex.ai/api-key ↗**](https://cloud.llamaindex.ai/api-key).
+Install the package:
 
-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
+```bash
+pip install llama-cloud-services
 ```
 
-Lastly, install the package:
+Then, get your API key from [LlamaCloud](https://cloud.llamaindex.ai/).
 
-`pip install llama-parse`
-
-Now you can run the following to parse your first PDF file:
+Then, you can use the services in your code:
 
 ```python
-import nest_asyncio
+from llama_cloud_services import LlamaParse, LlamaReport
 
-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
-)
-
-# 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")
+report = LlamaReport(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:
-
-```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
-)
-
-with open("./my_file1.pdf", "rb") as f:
-    documents = parser.load_data(f)
-
-# you can also pass file bytes directly
-with open("./my_file1.pdf", "rb") as f:
-    file_bytes = f.read()
-    documents = parser.load_data(file_bytes)
-```
-
-## 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,
-)
-
-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)
+- [LlamaParse](./parse.md)
+- [LlamaReport (beta/invite-only)](./report.md)
+- [LlamaExtract (coming soon!)]()
 
 ## 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
 
@@ -140,6 +47,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/parse/agents/demo_simple_openai_agent.ipynb

@@ -22,7 +22,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install llama-parse llama-index llama-index-postprocessor-sbert-rerank"
+    "!pip install llama-cloud-services llama-index llama-index-postprocessor-sbert-rerank"
    ]
   },
   {
@@ -82,7 +82,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(\n",
     "    result_type=\"markdown\",\n",

examples/parse/caltrain/caltrain_text_mode.ipynb

@@ -81,7 +81,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "docs = LlamaParse(result_type=\"text\").load_data(\"./caltrain_schedule_weekend.pdf\")"
    ]

examples/parse/demo_advanced.ipynb

@@ -26,7 +26,7 @@
     "!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"
+    "!pip install llama-cloud-services"
    ]
   },
   {
@@ -108,7 +108,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "documents = LlamaParse(result_type=\"markdown\").load_data(\"./apple_2021_10k.pdf\")"
    ]

examples/parse/demo_advanced_astradb.ipynb

@@ -22,7 +22,7 @@
     "%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\n",
+    "%pip install llama-cloud-services\n",
     "%pip install llama-index-vector-stores-astra-db"
    ]
   },
@@ -107,7 +107,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "documents = LlamaParse(result_type=\"markdown\").load_data(\"./uber_10q_march_2022.pdf\")"
    ]

examples/parse/demo_advanced_weaviate.ipynb

@@ -176,7 +176,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "documents = LlamaParse(result_type=\"markdown\").load_data(\"./uber_10q_march_2022.pdf\")"
    ]

examples/parse/demo_astradb.ipynb

@@ -130,7 +130,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "documents = LlamaParse(result_type=\"text\").load_data(file_path)"
    ]

examples/parse/demo_basic.ipynb

@@ -73,7 +73,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "documents = LlamaParse(result_type=\"text\").load_data(\"./attention.pdf\")"
    ]
@@ -120,7 +120,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "documents = LlamaParse(result_type=\"markdown\").load_data(\"./attention.pdf\")"
    ]

examples/parse/demo_elasticsearch_vectordb.ipynb

@@ -142,7 +142,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "documents = LlamaParse(result_type=\"text\").load_data(file_path)"
    ]

examples/parse/demo_excel.ipynb

@@ -21,7 +21,7 @@
    "outputs": [],
    "source": [
     "%pip install llama-index\n",
-    "%pip install llama-parse"
+    "%pip install llama-cloud-services"
    ]
   },
   {
@@ -41,7 +41,7 @@
     "\n",
     "nest_asyncio.apply()\n",
     "\n",
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "api_key = \"llx-\"  # get from cloud.llamaindex.ai"
    ]

examples/parse/demo_insurance.ipynb

@@ -116,7 +116,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "documents = LlamaParse(result_type=\"markdown\").load_data(\"./policy.pdf\")"
    ]

examples/parse/demo_json.ipynb

@@ -35,7 +35,7 @@
     "!pip install llama-index-core\n",
     "!pip install llama-index-llms-anthropic llama-index-multi-modal-llms-anthropic\n",
     "!pip install llama-index-embeddings-huggingface\n",
-    "!pip install llama-parse"
+    "!pip install llama-cloud-services"
    ]
   },
   {
@@ -129,7 +129,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(verbose=True)\n",
     "json_objs = parser.get_json_result(\"./uber_10q_march_2022.pdf\")\n",
@@ -342,7 +342,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "llama-parse-aNC435Vv-py3.10",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },

examples/parse/demo_json_parsing.ipynb

@@ -37,7 +37,7 @@
     "%pip install llama-index-core\n",
     "%pip install llama-index-llms-anthropic llama-index-multi-modal-llms-anthropic\n",
     "%pip install llama-index-embeddings-huggingface\n",
-    "%pip install llama-parse"
+    "%pip install llama-cloud-services"
    ]
   },
   {
@@ -110,7 +110,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(verbose=True)\n",
     "json_objs = parser.get_json_result(\"./uber_10q_march_2022.pdf\")\n",

examples/parse/demo_languages.ipynb

@@ -77,7 +77,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(result_type=\"text\", language=\"fr\")\n",
     "documents = parser.load_data(\"./treasury_report.pdf\")"
@@ -250,7 +250,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(result_type=\"text\", language=\"ch_sim\")\n",
     "documents = parser.load_data(\"./chinese_pdf.pdf\")"
@@ -404,7 +404,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "base_parser = LlamaParse(result_type=\"text\", language=\"en\")\n",
     "base_documents = parser.load_data(\"./chinese_pdf2.pdf\")"

examples/parse/demo_mongodb.ipynb

@@ -69,7 +69,7 @@
     "import pymongo\n",
     "\n",
     "from llama_index.vector_stores.mongodb import MongoDBAtlasVectorSearch\n",
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "from llama_index.embeddings.openai import OpenAIEmbedding\n",
     "from llama_index.core import VectorStoreIndex, StorageContext\n",
     "from llama_index.core.node_parser import SimpleNodeParser"

examples/parse/demo_parsing_instructions.ipynb

@@ -114,7 +114,7 @@
     }
    ],
    "source": [
-    "%pip install llama-parse"
+    "%pip install llama-cloud-services"
    ]
   },
   {
@@ -169,7 +169,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse"
+    "from llama_cloud_services import LlamaParse"
    ]
   },
   {

examples/parse/demo_starter_multimodal.ipynb

@@ -0,0 +1,357 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "97c79c38-38a3-40f3-ba2e-250649347d63",
+   "metadata": {},
+   "source": [
+    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/demo_starter_multimodal.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "4e081457",
+   "metadata": {},
+   "source": [
+    "# Multimodal Parsing using LlamaParse\n",
+    "\n",
+    "This cookbook shows you how to use LlamaParse to parse any document with the multimodal capabilities of Multi-Modal LLMs from Anthropic/ OpenAI.\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": "qOdqBxCS51Ow",
+   "metadata": {},
+   "source": [
+    "### Installation"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "H_Vqcylb50vm",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!pip install llama-cloud-services"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "15e60ecf-519c-41fc-911b-765adaf8bad4",
+   "metadata": {},
+   "source": [
+    "### Setup\n",
+    "\n",
+    "Here we setup `LLAMA_CLOUD_API_KEY` for using `LlamaParse`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "91a9e532-1454-40e0-bbf0-fd442c350121",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "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\"] = \"<YOUR LLAMACLOUD API KEY>\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "LGwBNPNotZRQ",
+   "metadata": {},
+   "source": [
+    "## Download Data\n",
+    "\n",
+    "For this demonstration, we will use OpenAI's recent paper `Evaluation of OpenAI o1: Opportunities and Challenges of AGI`."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "IjtKDQRLrylI",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "--2024-12-05 18:54:24--  https://arxiv.org/pdf/2409.18486\n",
+      "Resolving arxiv.org (arxiv.org)... 151.101.67.42, 151.101.131.42, 151.101.3.42, ...\n",
+      "Connecting to arxiv.org (arxiv.org)|151.101.67.42|:443... connected.\n",
+      "HTTP request sent, awaiting response... 200 OK\n",
+      "Length: 13986265 (13M) [application/pdf]\n",
+      "Saving to: ‘o1.pdf’\n",
+      "\n",
+      "o1.pdf              100%[===================>]  13.34M  11.8MB/s    in 1.1s    \n",
+      "\n",
+      "2024-12-05 18:54:26 (11.8 MB/s) - ‘o1.pdf’ saved [13986265/13986265]\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "!wget \"https://arxiv.org/pdf/2409.18486\" -O \"o1.pdf\""
+   ]
+  },
+  {
+   "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/ OpenAI API key. If you choose to do so LlamaParse will only charge you 1 credit (0.3c) per page. \n",
+    "\n",
+    "\n",
+    "Using your own API key may incur additional costs from your model provider and could result in failed pages or documents if you do not have sufficient usage limits."
+   ]
+  },
+  {
+   "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",
+    "\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"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1b5d6da6",
+   "metadata": {},
+   "source": [
+    "### With anthropic-sonnet-3.5"
+   ]
+  },
+  {
+   "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 dd9d5e0f-160e-486a-89a2-6005e5a1c2ac\n"
+     ]
+    }
+   ],
+   "source": [
+    "from llama_cloud_services 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",
+    "    target_pages=\"24\"\n",
+    "    # invalidate_cache=True\n",
+    ")\n",
+    "json_objs = parser.get_json_result(\"o1.pdf\")\n",
+    "json_list = json_objs[0][\"pages\"]\n",
+    "docs = get_text_nodes(json_list)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "4f3c51b0-7878-48d7-9bc3-02b516500128",
+   "metadata": {},
+   "source": [
+    "### With GPT-4o\n",
+    "\n",
+    "For comparison, we will also parse the document using GPT-4o."
+   ]
+  },
+  {
+   "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 6a4dea44-4f90-406b-b290-9e98620b1232\n"
+     ]
+    }
+   ],
+   "source": [
+    "from llama_cloud_services import LlamaParse\n",
+    "\n",
+    "parser_gpt4o = LlamaParse(\n",
+    "    result_type=\"markdown\",\n",
+    "    use_vendor_multimodal_model=True,\n",
+    "    vendor_multimodal_model=\"openai-gpt4o\",\n",
+    "    target_pages=\"24\",\n",
+    "    # invalidate_cache=True\n",
+    ")\n",
+    "json_objs_gpt4o = parser_gpt4o.get_json_result(\"o1.pdf\")\n",
+    "json_list_gpt4o = json_objs_gpt4o[0][\"pages\"]\n",
+    "docs_gpt4o = get_text_nodes(json_list_gpt4o)"
+   ]
+  },
+  {
+   "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."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "778698aa-da7e-4081-b3b5-0372f228536f",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "page: 25\n",
+      "\n",
+      "| Participant_ID | clinical Description Reference |\n",
+      "|-----------------|----------------------------------|\n",
+      "| Attribute | Value | Basic Personal Information: Subject 098_S_0896 is a 72.0-year-old Female who has completed 15 years of education. The ethnicity is Not Hisp/Latino and race is White. Marital status is Married. Initially diagnosed as AD, as of the date 2007-10-24, the final diagnosis was Dementia. |\n",
+      "| Age | 72.0 |\n",
+      "| Sex | Female |\n",
+      "| Education | 15 |\n",
+      "| Race | White | Biomarker Measurements: The subject's genetic profile includes an ApoE4 status of 0.0... |\n",
+      "| DX_bl | AD |\n",
+      "| DX | Dementia |\n",
+      "| ... | ... | Cognitive and Neurofunctional Assessments: The Mini-Mental State Examination score stands at 29.0. The Clinical Dementia Rating, sum of boxes, is 1.0. ADAS 11 and 13 scores are 4.67 and 4.67 respectively, with a score of 1.0 in delayed word recall... |\n",
+      "| APOE4 | 1.0 |\n",
+      "| TAU | 212.5 |\n",
+      "| ... | ... |\n",
+      "| MMSE | 29.0 | Volumetric Data: Under MRI conditions at a field strength of 1.5 Tesla MRI Tesla, using Cross Sectional FreeSurfer (FreeSurfer Version 4.3), the imaging data recorded includes ventricles volume at 54422.0, hippocampus volume at 6677.0, whole brain volume at 1147980.0, entorhinal cortex volume at 2782.0, fusiform gyrus volume at 19432.0, and middle temporal area volume at 24951.0. The intracranial volume measured is 1799580.0.... |\n",
+      "| CDRSB | 0.0 |\n",
+      "| ... | ... |\n",
+      "| FLDSTRENG | 1.5 Tesla MRI |\n",
+      "| Ventricles | 84599 |\n",
+      "| Hippocampus | 5319 |\n",
+      "| ... | ... |\n",
+      "\n",
+      "Figure 2: An example of a patient table and its corresponding clinical description.\n",
+      "\n",
+      "skills. Mathematics, as a highly structured and logic-driven discipline, provides an ideal testing ground for evaluating this reasoning ability. To investigate o1-preview's performance, we designed a series of tests covering various difficulty levels. We begin with high school-level math competition problems in this section, followed by college-level mathematics problems in the next section, allowing us to observe the model's logical reasoning across varying levels of complexity.\n",
+      "\n",
+      "In this section, we selected two primary areas of mathematics: algebra and counting and probability in this section. We chose these two topics because of their heavy reliance on problem-solving skills and their frequent use in assessing logical and abstract thinking [46]. The dataset used in testing is from the MATH dataset [46]. The problems in the dataset cover a wide range of subjects, including Prealgebra, Intermediate Algebra, Algebra, Geometry, Counting and Probability, Number Theory, and Precalculus. Each problem is categorized based on difficulty, ranked from level 1 to 5, according to the Art of Problem Solving (AoPS). The dataset mainly comprises problems from various high school math competitions, including the American Mathematics Competitions (AMC) 10 and 12, as well as the American Invitational Mathematics Examination (AIME), and other similar contests. Each problem comes with detailed reference solutions, allowing for a comprehensive comparison of o1-preview's solutions.\n",
+      "\n",
+      "In addition to evaluating the final answers produced by o1-preview, our analysis delves into the step-by-step reasoning process of the o1-preview's solutions. By comparing o1-preview's solutions with the dataset's solutions, we assess its ability to engage in logical reasoning, handle abstract problem-solving tasks, and apply structured approaches to reach correct answers. This deeper analysis offers insights into o1-preview's overall reasoning capabilities, using mathematics as a reliable indicator for logical and structured thought processes.\n"
+     ]
+    }
+   ],
+   "source": [
+    "# using Sonnet-3.5\n",
+    "print(docs[0].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: 25\n",
+      "\n",
+      "\n",
+      "| Participant_ID | clinical Description Reference |\n",
+      "|----------------|--------------------------------|\n",
+      "| **Attribute**  | **Value**                      |\n",
+      "| Age            | 72.0                           |\n",
+      "| Sex            | Female                         |\n",
+      "| Education      | 15                             |\n",
+      "| Race           | White                          |\n",
+      "| DX_bl          | AD                             |\n",
+      "| DX             | Dementia                       |\n",
+      "| ...            | ...                            |\n",
+      "| APOE4          | 1.0                            |\n",
+      "| TAU            | 212.5                          |\n",
+      "| ...            | ...                            |\n",
+      "| MMSE           | 29.0                           |\n",
+      "| CDRSB          | 0.0                            |\n",
+      "| ...            | ...                            |\n",
+      "| FLDSTRENG      | 1.5 Tesla MRI                  |\n",
+      "| Ventricles     | 84599                          |\n",
+      "| Hippocampus    | 5319                           |\n",
+      "| ...            | ...                            |\n",
+      "\n",
+      "**Basic Personal Information:** Subject 098_S_0896 is a 72.0-year-old Female who has completed 15 years of education. The ethnicity is Not Hisp/Latino and race is White. Marital status is Married. Initially diagnosed as AD, as of the date 2007-10-24, the final diagnosis was Dementia.\n",
+      "\n",
+      "**Biomarker Measurements:** The subject's genetic profile includes an ApoE4 status of 0.0...\n",
+      "\n",
+      "**Cognitive and Neurofunctional Assessments:** The Mini-Mental State Examination score stands at 29.0. The Clinical Dementia Rating, sum of boxes, is 1.0. ADAS 11 and 13 scores are 4.67 and 4.67 respectively, with a score of 1.0 in delayed word recall...\n",
+      "\n",
+      "**Volumetric Data:** Under MRI conditions at a field strength of 1.5 Tesla MRI Tesla, using Cross-Sectional FreeSurfer (FreeSurfer Version 4.3), the imaging data recorded includes ventricles volume at 84422.0, hippocampus volume at 6677.0, whole brain volume at 1147980.0, entorhinal cortex volume at 27820.0, fusiform gyrus volume at 19432.0, and middle temporal area volume at 24951.0. The intracranial volume measured is 1799580.0...\n",
+      "\n",
+      "Figure 2: An example of a patient table and its corresponding clinical description.\n",
+      "\n",
+      "----\n",
+      "\n",
+      "Skills. Mathematics, as a highly structured and logic-driven discipline, provides an ideal testing ground for evaluating this reasoning ability. To investigate o1-preview’s performance, we designed a series of tests covering various difficulty levels. We begin with high school-level math competition problems in this section, followed by college-level mathematics problems in the next section, allowing us to observe the model’s logical reasoning across varying levels of complexity.\n",
+      "\n",
+      "In this section, we selected two primary areas of mathematics: algebra and counting and probability in this section. We chose these two topics because of their heavy reliance on problem-solving skills and their frequent use in assessing logical and abstract thinking [46]. The dataset used in testing is from the MATH dataset [46]. The problems in the dataset cover a wide range of subjects, including Prealgebra, Intermediate Algebra, Algebra, Geometry, Counting and Probability, Number Theory, and Precalculus. Each problem is categorized based on difficulty, ranked from level 1 to 5, according to the Art of Problem Solving (AoPS). The dataset mainly comprises problems from various high school math competitions, including the American Mathematics Competitions (AMC) 10 and 12, as well as the American Invitational Mathematics Examination (AIME), and other similar contests. Each problem comes with detailed reference solutions, allowing for a comprehensive comparison of o1-preview’s solutions.\n",
+      "\n",
+      "In addition to evaluating the final answers produced by o1-preview, our analysis delves into the step-by-step reasoning process of the o1-preview’s solutions. By comparing o1-preview’s solutions with the dataset’s solutions, we assess its ability to engage in logical reasoning, handle abstract problem-solving tasks, and apply structured approaches to reach correct answers. This deeper analysis offers insights into o1-preview’s overall reasoning capabilities, using mathematics as a reliable indicator for logical and structured thought processes.\n"
+     ]
+    }
+   ],
+   "source": [
+    "# using GPT-4o\n",
+    "print(docs_gpt4o[0].get_content(metadata_mode=\"all\"))"
+   ]
+  }
+ ],
+ "metadata": {
+  "colab": {
+   "provenance": []
+  },
+  "kernelspec": {
+   "display_name": "llamacloud",
+   "language": "python",
+   "name": "llamacloud"
+  },
+  "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/parse/demo_starter_parse_selected_pages.ipynb

@@ -0,0 +1,170 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/demo_starter_parse_selected_pages.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Parse Selected Pages \n",
+    "\n",
+    "In this notebook we will demonstrate how to parse selected pages in a document using LlamaParse."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Installation\n",
+    "\n",
+    "Here we install `llama-parse` used for parsing the document"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!pip install llama-cloud-services"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Set API Key"
+   ]
+  },
+  {
+   "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\"] = \"<YOUR LLAMACLOUD API KEY>\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Download Data\n",
+    "\n",
+    "Here we download Uber 2021 10K SEC filings data for the demonstration."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "--2024-12-05 11:40:59--  https://raw.githubusercontent.com/run-llama/llama_index/main/docs/docs/examples/data/10k/uber_2021.pdf\n",
+      "Resolving raw.githubusercontent.com (raw.githubusercontent.com)... 2606:50c0:8000::154, 2606:50c0:8002::154, 2606:50c0:8003::154, ...\n",
+      "Connecting to raw.githubusercontent.com (raw.githubusercontent.com)|2606:50c0:8000::154|:443... connected.\n",
+      "HTTP request sent, awaiting response... 200 OK\n",
+      "Length: 1880483 (1.8M) [application/octet-stream]\n",
+      "Saving to: ‘./uber_2021.pdf’\n",
+      "\n",
+      "./uber_2021.pdf     100%[===================>]   1.79M  --.-KB/s    in 0.1s    \n",
+      "\n",
+      "2024-12-05 11:40:59 (14.2 MB/s) - ‘./uber_2021.pdf’ saved [1880483/1880483]\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "!wget 'https://raw.githubusercontent.com/run-llama/llama_index/main/docs/docs/examples/data/10k/uber_2021.pdf' -O './uber_2021.pdf'"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Parse the PDF file in selected pages\n",
+    "\n",
+    "Here we will parse the PDF file in selected pages and get the text in `markdown` format."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Started parsing the file under job_id ad1087c1-b085-4dc7-9aa8-d13cdd440f2b\n"
+     ]
+    }
+   ],
+   "source": [
+    "from llama_cloud_services import LlamaParse\n",
+    "\n",
+    "parser = LlamaParse(target_pages=\"0,1,2\", result_type=\"markdown\")\n",
+    "\n",
+    "documents = parser.load_data(\"./uber_2021.pdf\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Document(id_='d0b34f4a-27ef-48e2-a92a-386e5e265f4c', embedding=None, metadata={}, excluded_embed_metadata_keys=[], excluded_llm_metadata_keys=[], relationships={}, metadata_template='{key}: {value}', metadata_separator='\\n', text='# UNITED STATES SECURITIES AND EXCHANGE COMMISSION\\n\\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\\nFor the fiscal year ended December 31, 2021\\n\\nOR\\n\\n☐ TRANSITION REPORT PURSUANT TO SECTION 13 OR 15(d) OF THE SECURITIES EXCHANGE ACT OF 1934\\n\\nFor the transition period from _____ to _____\\n\\nCommission File Number: 001-38902\\n\\n# UBER TECHNOLOGIES, INC.\\n\\n(Exact name of registrant as specified in its charter)\\n\\nDelaware\\n\\n45-2647441\\n\\n(State or other jurisdiction of incorporation or organization) (I.R.S. Employer Identification No.)\\n\\n1515 3rd Street\\n\\nSan Francisco, California 94158\\n\\n(Address of principal executive offices, including zip code)\\n\\n(415) 612-8582\\n\\n(Registrant’s telephone number, including area code)\\n\\n# Securities registered pursuant to Section 12(b) of the Act:\\n\\n|Title of each class|Trading Symbol(s)|Name of each exchange on which registered|\\n|---|---|---|\\n|Common Stock, par value $0.00001 per share|UBER|New York Stock Exchange|\\n\\nSecurities registered pursuant to Section 12(g) of the Act: None\\n\\nIndicate by check mark whether the registrant is a well-known seasoned issuer, as defined in Rule 405 of the Securities Act. Yes ☒ No ☐\\n\\nIndicate by check mark whether the registrant is not required to file reports pursuant to Section 13 or Section 15(d) of the Act. Yes ☐ No ☒\\n\\nIndicate by check mark whether the registrant (1) has filed all reports required to be filed by Section 13 or 15(d) of the Securities Exchange Act of 1934 during the preceding 12 months (or for such shorter period that the registrant was required to file such reports), and (2) has been subject to such filing requirements for the past 90 days. Yes ☒ No ☐\\n\\nIndicate by check mark whether the registrant has submitted electronically every Interactive Data File required to be submitted pursuant to Rule 405 of Regulation S-T (§232.405 of this chapter) during the preceding 12 months (or for such shorter period that the registrant was required to submit such files). Yes ☒ No ☐\\n\\nIndicate by check mark whether the registrant is a large accelerated filer, an accelerated filer, a non-accelerated filer, a smaller reporting company, or an emerging growth company. See the definitions of “large accelerated filer,” “accelerated filer,” “smaller reporting company,” and “emerging growth company” in Rule 12b-2 of the Exchange Act.', mimetype='text/plain', start_char_idx=None, end_char_idx=None, metadata_seperator='\\n', text_template='{metadata_str}\\n\\n{content}'),\n",
+       " Document(id_='253b1141-a260-466e-b164-b39df67ef799', embedding=None, metadata={}, excluded_embed_metadata_keys=[], excluded_llm_metadata_keys=[], relationships={}, metadata_template='{key}: {value}', metadata_separator='\\n', text=\"# Large accelerated filer\\n\\n☒\\n\\n# Accelerated filer\\n\\n☐\\n\\n# Non-accelerated filer\\n\\n☐\\n\\n# Smaller reporting company\\n\\n☐\\n\\n# Emerging growth company\\n\\n☐\\n\\nIf an emerging growth company, indicate by check mark if the registrant has elected not to use the extended transition period for complying with any new or revised financial accounting standards provided pursuant to Section 13(a) of the Exchange Act.\\n\\n☐\\n\\nIndicate by check mark whether the registrant has filed a report on and attestation to its management’s assessment of the effectiveness of its internal control over financial reporting under Section 404(b) of the Sarbanes-Oxley Act (15 U.S.C. 7262(b)) by the registered public accounting firm that prepared or issued\\n\\n☒\\n\\nIndicate by check mark whether the registrant is a shell company (as defined in Rule 12b-2 of the Exchange Act). Yes\\n\\n☐\\n\\nNo\\n\\n☒\\n\\nThe aggregate market value of the voting and non-voting common equity held by non-affiliates of the registrant as of June 30, 2021, the last business day of the registrant's most recently completed second fiscal quarter, was approximately $90.5 billion based upon the closing price reported for such date on the New York Stock Exchange.\\n\\nThe number of shares of the registrant's common stock outstanding as of February 22, 2022 was 1,954,464,088.\\n\\n# DOCUMENTS INCORPORATED BY REFERENCE\\n\\nPortions of the registrant’s Definitive Proxy Statement relating to the Annual Meeting of Stockholders are incorporated by reference into Part III of this Annual Report on Form 10-K where indicated. Such Definitive Proxy Statement will be filed with the Securities and Exchange Commission within 120 days after the end of the registrant’s fiscal year ended December 31, 2021.\", mimetype='text/plain', start_char_idx=None, end_char_idx=None, metadata_seperator='\\n', text_template='{metadata_str}\\n\\n{content}'),\n",
+       " Document(id_='ad988239-3ab5-498d-85ba-a29241db24d4', embedding=None, metadata={}, excluded_embed_metadata_keys=[], excluded_llm_metadata_keys=[], relationships={}, metadata_template='{key}: {value}', metadata_separator='\\n', text='# UBER TECHNOLOGIES, INC.\\n\\n# TABLE OF CONTENTS\\n\\n|Special Note Regarding Forward-Looking Statements|2|\\n|---|---|\\n|PART I|PART I|\\n|Item 1. Business|4|\\n|Item 1A. Risk Factors|11|\\n|Item 1B. Unresolved Staff Comments|46|\\n|Item 2. Properties|46|\\n|Item 3. Legal Proceedings|46|\\n|Item 4. Mine Safety Disclosures|47|\\n|PART II|PART II|\\n|Item 5. Market for Registrant’s Common Equity, Related Stockholder Matters and Issuer Purchases of Equity Securities|47|\\n|Item 6. [Reserved]|48|\\n|Item 7. Management’s Discussion and Analysis of Financial Condition and Results of Operations|48|\\n|Item 7A. Quantitative and Qualitative Disclosures About Market Risk|69|\\n|Item 8. Financial Statements and Supplementary Data|70|\\n|Item 9. Changes in and Disagreements with Accountants on Accounting and Financial Disclosure|146|\\n|Item 9A. Controls and Procedures|147|\\n|Item 9B. Other Information|147|\\n|Item 9C. Disclosure Regarding Foreign Jurisdictions that Prevent Inspections|147|\\n|PART III|PART III|\\n|Item 10. Directors, Executive Officers and Corporate Governance|147|\\n|Item 11. Executive Compensation|147|\\n|Item 12. Security Ownership of Certain Beneficial Owners and Management and Related Stockholder Matters|148|\\n|Item 13. Certain Relationships and Related Transactions, and Director Independence|148|\\n|Item 14. Principal Accounting Fees and Services|148|\\n|PART IV|PART IV|\\n|Item 15. Exhibits, Financial Statement Schedules|148|\\n|Item 16. Form 10-K Summary|148|\\n|Exhibit Index|149|\\n|Signatures|152|', mimetype='text/plain', start_char_idx=None, end_char_idx=None, metadata_seperator='\\n', text_template='{metadata_str}\\n\\n{content}')]"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "documents"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "llamacloud",
+   "language": "python",
+   "name": "llamacloud"
+  },
+  "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/parse/demo_table_comparisons.ipynb

@@ -34,7 +34,7 @@
     "%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"
+    "%pip install llama-cloud-services"
    ]
   },
   {
@@ -109,7 +109,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services 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\")"

examples/parse/excel/dcf_rag.ipynb

@@ -31,7 +31,7 @@
    "outputs": [],
    "source": [
     "%pip install llama-index\n",
-    "%pip install llama-parse"
+    "%pip install llama-cloud-services"
    ]
   },
   {
@@ -53,7 +53,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "# api_key = \"llx-\"  # get from cloud.llamaindex.ai"
    ]

examples/parse/knowledge_graphs/kg_agent.ipynb

@@ -33,7 +33,7 @@
     "!pip install llama-index-postprocessor-flag-embedding-reranker\n",
     "!pip install git+https://github.com/FlagOpen/FlagEmbedding.git\n",
     "!pip install llama-index-graph-stores-neo4j\n",
-    "!pip install llama-parse"
+    "!pip install llama-cloud-services"
    ]
   },
   {
@@ -125,7 +125,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "docs = LlamaParse(result_type=\"text\").load_data(\"./data/budget_2023.pdf\")"
    ]

examples/parse/multimodal/claude_parse.ipynb

@@ -141,7 +141,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(\n",
     "    result_type=\"markdown\",\n",
@@ -205,7 +205,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser_gpt4o = LlamaParse(\n",
     "    result_type=\"markdown\",\n",

examples/parse/multimodal/gpt4o_mini.ipynb

@@ -118,7 +118,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(\n",
     "    result_type=\"markdown\",\n",
@@ -181,7 +181,7 @@
     }
    ],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser_gpt4o = LlamaParse(\n",
     "    result_type=\"markdown\",\n",

examples/parse/multimodal/insurance_rag.ipynb

@@ -99,7 +99,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(\n",
     "    result_type=\"markdown\",\n",

examples/parse/multimodal/legal_rag.ipynb

@@ -102,7 +102,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(\n",
     "    result_type=\"markdown\",\n",

examples/parse/multimodal/multimodal_rag_slide_deck.ipynb

@@ -153,7 +153,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "\n",
     "parser_text = LlamaParse(result_type=\"text\")\n",
@@ -165,7 +165,18 @@
    "execution_count": null,
    "id": "ef82a985-4088-4bb7-9a21-0318e1b9207d",
    "metadata": {},
-   "outputs": [],
+   "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",
@@ -174,42 +185,36 @@
     "md_json_list = md_json_objs[0][\"pages\"]"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7506b603-c01f-45de-b354-4a0728dde03c",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "print(docs_text[0].get_content())"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
    "id": "5318fb7b-fe6a-4a8a-b82e-4ed7b4512c37",
    "metadata": {},
-   "outputs": [],
-   "source": [
-    "print(md_json_list[10][\"md\"])"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7a46a73e-c6e2-4b0b-bd10-31b0d3e4b70f",
-   "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "dict_keys(['page', 'text', 'md', 'images', 'items'])\n"
+      "# 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[1].keys())"
+    "print(md_json_list[10][\"md\"])"
    ]
   },
   {
@@ -299,7 +304,7 @@
     "    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 = docs[0].text.split(\"---\")\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",
@@ -339,25 +344,23 @@
      "output_type": "stream",
      "text": [
       "page_num: 11\n",
-      "image_path: data_images/d9137e19-3974-4b5d-998f-dac0cf29dd9d-page-10.jpg\n",
+      "image_path: data_images/1ddd5654-062b-4e19-b488-d66efc9c509d-page_39.jpg\n",
       "parsed_text_markdown: # Commitment to Disciplined Reinvestment Rate\n",
       "\n",
-      "| Year       | Reinvestment Rate | WTI Average Price | Reinvestment Rate at $60/BBL WTI | Reinvestment Rate at $80/BBL WTI |\n",
-      "|------------|-------------------|-------------------|----------------------------------|----------------------------------|\n",
-      "| 2012-2016  | >100%             | ~$75/BBL          |                                  |                                  |\n",
-      "| 2017-2022  | <60%              | ~$63/BBL          |                                  |                                  |\n",
-      "| 2023E      |                   |                   |                                  | at $80/BBL WTI                   |\n",
-      "| 2024-2028  |                   |                   | at $60/BBL WTI                   | at $80/BBL WTI                   |\n",
-      "| 2029-2032  |                   |                   | at $60/BBL WTI                   | at $80/BBL WTI                   |\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",
-      "**Disciplined Reinvestment Rate is the Foundation for Superior Returns on and of Capital, while Driving Durable CFO Growth**\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",
-      "- ~50% 10-Year Reinvestment Rate\n",
-      "- ~6% CFO CAGR 2024-2032 at $60/BBL WTI Mid-Cycle Planning Price\n",
-      "\n",
-      "**Note:** Reinvestment rate and cash from operations (CFO) are non-GAAP measures. Definitions and reconciliations are included in the Appendix.\n",
-      "parsed_text: \n",
-      "Commitment to Disciplined Reinvestment Rate\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",
@@ -374,7 +377,7 @@
       "          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 andcashfrom operations (CFO) are non-GAAP measures: Definitions and reconciliations are included in the Appendix                                    ConocoPhillips\n"
+      " Reinvestment rate and cash from operations (CFO) are non-GAAP measures: Definitions and reconciliations are included in the Appendix                                  ConocoPhillips\n"
      ]
     }
    ],
@@ -397,7 +400,17 @@
    "execution_count": null,
    "id": "6ea53c31-0e38-421c-8d9b-0e3adaa1677e",
    "metadata": {},
-   "outputs": [],
+   "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",
@@ -588,7 +601,7 @@
       "                            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",
+      "  3 $40                                                                                                                       GKA        GWA\n",
       "                                                                                                                      GPA     WNS\n",
       "      $30                                                                                                             EMENA\n",
       "  3                                                                                                                              Norway\n",
@@ -599,7 +612,7 @@
       "                                                                                                                      APLNG        Montney\n",
       "       S0\n",
       "                                               10              15              20                         Bakken\n",
-      "                                         Resource (BBOE)                           Eagle Ford             Other       MalaysiaChina Surmont\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"
@@ -687,70 +700,126 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "1cdce5d8-6bb3-4cd3-929d-1cec249d9052",
+   "id": "d78e53cf-35cb-4ef8-b03e-1b47ba15ae64",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Added user message to memory: How does the Conoco Phillips capex/EUR in the delaware basin compare against other competitors?\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\": \"Conoco Phillips capex/EUR in the Delaware Basin\"}\n",
+      "Calling function: vector_tool with args: {\"input\": \"Conoco Phillips production base geographies\"}\n",
       "=== Function Output ===\n",
-      "The ConocoPhillips capex/EUR in the Delaware Basin is $10/BOE.\n",
+      "ConocoPhillips' production base geographies include:\n",
       "\n",
-      "I obtained this information from the image provided. The image clearly shows a bar chart under the section \"Delaware Basin Well Capex/EUR ($/BOE)\" where ConocoPhillips is listed with a capex/EUR of $10/BOE. This information is consistent with the parsed markdown text, which also lists ConocoPhillips' capex/EUR as $10/BOE in the Delaware Basin. There are no discrepancies between the image and the parsed markdown text in this case.\n",
-      "=== Calling Function ===\n",
-      "Calling function: vector_tool with args: {\"input\": \"competitors capex/EUR in the Delaware Basin\"}\n",
-      "=== Function Output ===\n",
-      "The competitors' Capex/EUR in the Delaware Basin can be found in the image on the slide titled \"Delaware: Vast Inventory with Proven Track Record of Performance.\" The relevant information is presented in a bar chart under the section \"Delaware Basin Well Capex/EUR ($/BOE)\".\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",
-      "Here are the details:\n",
-      "\n",
-      "- ConocoPhillips: $10/BOE\n",
-      "- Competitor 1: $15/BOE\n",
-      "- Competitor 2: $20/BOE\n",
-      "- Competitor 3: $25/BOE\n",
-      "- Competitor 4: $30/BOE\n",
-      "- Competitor 5: $35/BOE\n",
-      "- Competitor 6: $40/BOE\n",
-      "- Competitor 7: $45/BOE\n",
-      "\n",
-      "This information was obtained directly from the image, which provides a clear visual representation of the Capex/EUR values for ConocoPhillips and its competitors in the Delaware Basin. The parsed markdown text also confirms these values, ensuring consistency between the image and the text.\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",
-      "The capital expenditure per estimated ultimate recovery (capex/EUR) for ConocoPhillips in the Delaware Basin is $10 per barrel of oil equivalent (BOE). When compared to its competitors, ConocoPhillips has a significantly lower capex/EUR. Here are the capex/EUR values for ConocoPhillips and its competitors:\n",
+      "ConocoPhillips has a diverse production base spread across various geographies, including:\n",
       "\n",
-      "- **ConocoPhillips**: $10/BOE\n",
-      "- **Competitor 1**: $15/BOE\n",
-      "- **Competitor 2**: $20/BOE\n",
-      "- **Competitor 3**: $25/BOE\n",
-      "- **Competitor 4**: $30/BOE\n",
-      "- **Competitor 5**: $35/BOE\n",
-      "- **Competitor 6**: $40/BOE\n",
-      "- **Competitor 7**: $45/BOE\n",
+      "1. **Lower 48**:\n",
+      "   - Permian Basin\n",
+      "   - Eagle Ford\n",
+      "   - Bakken\n",
+      "   - Other regions within the continental United States\n",
       "\n",
-      "This data indicates that ConocoPhillips has a more cost-efficient operation in the Delaware Basin compared to its competitors.\n",
-      "The capital expenditure per estimated ultimate recovery (capex/EUR) for ConocoPhillips in the Delaware Basin is $10 per barrel of oil equivalent (BOE). When compared to its competitors, ConocoPhillips has a significantly lower capex/EUR. Here are the capex/EUR values for ConocoPhillips and its competitors:\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",
-      "- **ConocoPhillips**: $10/BOE\n",
-      "- **Competitor 1**: $15/BOE\n",
-      "- **Competitor 2**: $20/BOE\n",
-      "- **Competitor 3**: $25/BOE\n",
-      "- **Competitor 4**: $30/BOE\n",
-      "- **Competitor 5**: $35/BOE\n",
-      "- **Competitor 6**: $40/BOE\n",
-      "- **Competitor 7**: $45/BOE\n",
+      "3. **EMENA (Europe, Middle East, and North Africa)**:\n",
+      "   - Norway\n",
+      "   - Libya\n",
+      "   - Qatar\n",
       "\n",
-      "This data indicates that ConocoPhillips has a more cost-efficient operation in the Delaware Basin compared to its competitors.\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": [
-    "# response = agent.query(\"Tell me about the different regions and subregions where Conoco Phillips has a production base.\")\n",
-    "response = agent.query(\n",
-    "    \"How does the Conoco Phillips capex/EUR in the delaware basin compare against other competitors?\"\n",
+    "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))"
    ]
   },
@@ -764,85 +833,82 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "page_num: 38\n",
-      "image_path: data_images/d9137e19-3974-4b5d-998f-dac0cf29dd9d-page-37.jpg\n",
-      "parsed_text_markdown: # Delaware: Vast Inventory with Proven Track Record of Performance\n",
+      "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",
-      "## Prolific Acreage Spanning Over ~659,000 Net Acres¹\n",
+      "## ~20 BBOE of Resource\n",
+      "Under $40/BBL Cost of Supply\n",
       "\n",
-      "![Map of Delaware Basin](image)\n",
+      "### ~ $32/BBL\n",
+      "Average Cost of Supply\n",
       "\n",
-      "### Total 10-Year Operated Permian Inventory\n",
+      "### WTI Cost of Supply ($/BBL)\n",
       "\n",
-      "- Delaware Basin: 65%\n",
-      "- Midland Basin: 35%\n",
+      "| Cost ($/BBL) | Resource (BBOE) |\n",
+      "|--------------|-----------------|\n",
+      "| $0           | 0               |\n",
+      "| $10          |                 |\n",
+      "| $20          |                 |\n",
+      "| $30          |                 |\n",
+      "| $40          |                 |\n",
+      "| $50          |                 |\n",
       "\n",
-      "### High Single-Digit Production Growth\n",
+      "- **Legend:**\n",
+      "  - Lower 48\n",
+      "  - Canada\n",
+      "  - Alaska\n",
+      "  - EMENA\n",
+      "  - Asia Pacific\n",
       "\n",
-      "## 12-Month Cumulative Production³ (BOE/FT)\n",
+      "*Costs assume a mid-cycle price environment of $60/BBL WTI.*\n",
       "\n",
-      "| Months | 2019 | 2020 | 2021 | 2022 |\n",
-      "|--------|------|------|------|------|\n",
-      "| 1      | 0    | 0    | 0    | 0    |\n",
-      "| 2      | 5    | 6    | 7    | 8    |\n",
-      "| 3      | 10   | 12   | 14   | 16   |\n",
-      "| 4      | 15   | 18   | 21   | 24   |\n",
-      "| 5      | 20   | 24   | 28   | 32   |\n",
-      "| 6      | 25   | 30   | 35   | 40   |\n",
-      "| 7      | 30   | 36   | 42   | 48   |\n",
-      "| 8      | 35   | 42   | 49   | 56   |\n",
-      "| 9      | 40   | 48   | 56   | 64   |\n",
-      "| 10     | 45   | 54   | 63   | 72   |\n",
-      "| 11     | 50   | 60   | 70   | 80   |\n",
-      "| 12     | 55   | 66   | 77   | 88   |\n",
+      "## Diverse Production Base\n",
+      "10-Year Plan Cumulative Production (BBOE)\n",
       "\n",
-      "~30% Improved Performance from 2019 to 2022\n",
-      "\n",
-      "## Delaware Basin Well Capex/EUR⁴ ($/BOE)\n",
-      "\n",
-      "| Company          | Capex/EUR |\n",
-      "|------------------|-----------|\n",
-      "| ConocoPhillips   | 10        |\n",
-      "| Competitor 1     | 15        |\n",
-      "| Competitor 2     | 20        |\n",
-      "| Competitor 3     | 25        |\n",
-      "| Competitor 4     | 30        |\n",
-      "| Competitor 5     | 35        |\n",
-      "| Competitor 6     | 40        |\n",
-      "| Competitor 7     | 45        |\n",
-      "\n",
-      "---\n",
-      "\n",
-      "¹ Unconventional acres.  \n",
-      "² Source: Enverus and ConocoPhillips (March 2023).  \n",
-      "³ Source: Enverus (March 2023) based on wells online year.  \n",
-      "⁴ Source: Enverus (March 2023). Average single well capex/EUR. Top eight public operators based on wells online in years 2021-2022, greater than 50% oil weight. COP based on COP well design. Competitors include: CVX, DVN, EOG, MTDR, OXY, PR and XOM.\n",
-      "parsed_text: \n",
-      "Delaware: Vast Inventory with Proven Track Record of Performance\n",
-      "        New                       Prolific Acreage Spanning Over                                                        12-Month Cumulative Production? (BOE/FT)\n",
-      "       Mexico                                 659,000 Net Acres'                                             40\n",
-      "                       Texas                                                                                                                                                                       3828\n",
-      "                                                                                                             30                                                                                    2019\n",
-      "                                                                                                             20                                                                            30%\n",
-      "                                                                                                             10                                                         Improved Performancefrom 2019 to 2022\n",
-      "           Total\n",
-      "   Permian Inventory\n",
-      "                    10-Year Operated\n",
-      "                                                                                                                            2                                                      10     11     12\n",
-      "                                                                                                                                                        Months\n",
-      "                                                                                                                         Delaware Basin Well Capex/EUR4 (S/BOE)\n",
-      "                      65%                                                                                     25\n",
-      "          Delaware Basin                                                                                      20\n",
-      "          Midland Basin                                                                                       15\n",
-      "                                              Low         HighCost of Supplyz                                 10  ConocoPhillips\n",
-      "     High Single-Digit Production Growth\n",
-      " \"Unconventional acres. 2Source: Enverus and ConocoPhillips (March 2023). 3SourceEnverus (March 2023) based on wells online year: \"Source; Enverus (March 2023). Average single well capex/EUR Top eight public operators based on\n",
-      "wells online in years 2021-2022, greater than 50% oil weight; COP based on COP well design: Competitors include; CVX DVN, EOG; MTDR, OXY, PR and XOM:                                     ConocoPhillips\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[0].get_content(metadata_mode=\"all\"))"
+    "print(response.source_nodes[7].get_content(metadata_mode=\"all\"))"
    ]
   },
   {
@@ -855,26 +921,20 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Added user message to memory: How does the Conoco Phillips capex/EUR in the delaware basin compare against other competitors?\n",
-      "=== Calling Function ===\n",
-      "Calling function: vector_tool with args: {\"input\": \"Conoco Phillips capex/EUR in the Delaware Basin\"}\n",
-      "=== Function Output ===\n",
-      "ConocoPhillips' capex/EUR in the Delaware Basin is approximately $20/BOE.\n",
-      "=== Calling Function ===\n",
-      "Calling function: vector_tool with args: {\"input\": \"competitors capex/EUR in the Delaware Basin\"}\n",
-      "=== Function Output ===\n",
-      "The average single well capex/EUR for competitors in the Delaware Basin is between $10 and $25 per BOE.\n",
-      "=== LLM Response ===\n",
-      "ConocoPhillips' capex/EUR in the Delaware Basin is approximately $20 per BOE. In comparison, the average capex/EUR for competitors in the Delaware Basin ranges between $10 and $25 per BOE. This places ConocoPhillips' capex/EUR towards the higher end of the competitive range.\n",
-      "ConocoPhillips' capex/EUR in the Delaware Basin is approximately $20 per BOE. In comparison, the average capex/EUR for competitors in the Delaware Basin ranges between $10 and $25 per BOE. This places ConocoPhillips' capex/EUR towards the higher end of the competitive range.\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": [
-    "# base_response = base_agent.query(\"Tell me about the different regions and subregions where Conoco Phillips has a production base.\")\n",
-    "base_response = base_agent.query(\n",
-    "    \"How does the Conoco Phillips capex/EUR in the delaware basin compare against other competitors?\"\n",
-    ")\n",
     "print(str(base_response))"
    ]
   },
@@ -888,30 +948,31 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Deep, Durable and Diverse Portfolio with Significant Growth Runway\n",
-      "    1,2002022 Lower 48 Unconventional Production' (MBOED                                                  S50     ~S32/BBL\n",
-      "     000 ConocoPhillips                                                                                                   Cost of SupplyAverage\n",
-      "       00                                                                                                 S40\n",
-      "      500                                                                                            3\n",
-      "      400                                                                                            1    S30\n",
-      "     200\n",
-      "                                                                                                      5\n",
-      "   15,000ConocoPhillipsNet Remaining Well Inventory?                                                  1   S20\n",
-      "   12,000                                                                                                 S10\n",
-      "      000\n",
-      "      0o0                                                                                                  SO\n",
-      "     3,000                                                                                                                                                                         10\n",
-      "                                                                                                                                                Resource (BBOE)\n",
-      "                                                                                                                    Delaware Basin      Midland Basin      Eagle Ford       Bakken        Other\n",
-      "                        Largest Lower 48 Unconventional Producer; Growing into the Next Decade\n",
-      " onshore operated inventory that achieves 15% IRR at $SO/BBL WTI, Competitors include CVX, DVN, EOG, FANG, MRO, OXY, PXD,and XOM:\n",
-      "                                                                                                                                 Source: Wood Mackenzie Lower 48 Unconventional Plays 2022 ProductionCompetitors include CVX, DVN; EOG, FANG, MRO, OXY, PXD and XOM; greaterthan50% liquids weight: ?Source: Wood Mackenzie (March 2023), Lower 48\n",
-      "                                                                                                                                                                                  ConocoPhillips\n"
+      "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[0].get_content(metadata_mode=\"llm\"))"
+    "print(base_response.source_nodes[1].get_content(metadata_mode=\"all\"))"
    ]
   }
  ],

examples/parse/multimodal/multimodal_report_generation.ipynb

@@ -143,7 +143,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(\n",
     "    result_type=\"markdown\",\n",

examples/parse/multimodal/multimodal_report_generation_agent.ipynb

@@ -11,6 +11,8 @@
     "\n",
     "In this cookbook we show you how to build a multimodal report generation agent from a bank of research reports. We use the a set of ICLR papers (which were also used as the dataset in our [DeepLearning.ai course](https://www.deeplearning.ai/short-courses/building-agentic-rag-with-llamaindex/?utm_campaign=llamaindexC2-launch&utm_medium=headband&utm_source=dlai-homepage).\n",
     "\n",
+    "![](multimodal_report_generation_agent_img.png)\n",
+    "\n",
     "We use our workflow abstraction to define an agentic system that contains two main phases: a research phase that pulls in relevant files through chunk-level or file-level retrieval, and then a blog generation phase that synthesizes the final report."
    ]
   },
@@ -170,7 +172,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(\n",
     "    result_type=\"markdown\",\n",

examples/parse/multimodal/product_manual_rag.ipynb

@@ -104,7 +104,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser = LlamaParse(\n",
     "    result_type=\"markdown\",\n",

examples/parse/other_files/demo_ppt_basic.ipynb

@@ -25,7 +25,7 @@
     "\n",
     "nest_asyncio.apply()\n",
     "\n",
-    "from llama_parse import LlamaParse"
+    "from llama_cloud_services import LlamaParse"
    ]
   },
   {

examples/parse/other_files/demo_ppt_financial.ipynb

@@ -27,7 +27,7 @@
    "outputs": [],
    "source": [
     "%pip install llama-index\n",
-    "%pip install llama-parse\n",
+    "%pip install llama-cloud-services\n",
     "%pip install torch transformers python-pptx Pillow"
    ]
   },
@@ -85,7 +85,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse"
+    "from llama_cloud_services import LlamaParse"
    ]
   },
   {

examples/parse/parsing_instructions/parsing_instructions.ipynb

@@ -0,0 +1,602 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<a href=\"https://colab.research.google.com/github/run-llama/llama_parse/blob/main/examples/parsing_instructions.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>\n",
+    "\n",
+    "# Parsing documents with Instructions\n",
+    "\n",
+    "Parsing instructions allow you to guide our parsing model in the same way you would instruct an LLM.\n",
+    "\n",
+    "These instructions can be useful for improving the parser's performance on complex document layouts, extracting data in a specific format, or transforming the document in other ways.\n",
+    "\n",
+    "### Why This Matters:\n",
+    "Traditional document parsing can be rigid and error-prone, often missing crucial context and nuances in complex layouts. Our instruction-based parsing allows you to:\n",
+    "\n",
+    "1. Extract specific information with pinpoint accuracy\n",
+    "2. Handle complex document layouts with ease\n",
+    "3. Transform unstructured data into structured formats effortlessly\n",
+    "4. Save hours of manual data entry and verification\n",
+    "5. Reduce errors in document processing workflows\n",
+    "\n",
+    "In this demonstration, we showcase how parsing instructions can be used to extract specific information from unstructured documents. Below are the documents we use for testing:\n",
+    "\n",
+    "1. McDonald's Receipt - Extracting the price of each order and the final amount to be paid.\n",
+    "\n",
+    "2. Expense Report Document - Extracting employee name, employee ID, position, department, date ranges, individual expense items with dates, categories, and amounts.\n",
+    "\n",
+    "3. Purchase Order Document - Identifying the PO number, vendor details, shipping terms, and an itemized list of products with quantities and unit prices.\n",
+    "\n",
+    "Let's jump into these real-world examples and see how parsing instructions can help us extract specific information."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Installation"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!pip install llama-cloud-services"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Setup API Key"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import nest_asyncio\n",
+    "\n",
+    "nest_asyncio.apply()\n",
+    "\n",
+    "import os\n",
+    "\n",
+    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"llx-...\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### McDonald's Receipt\n",
+    "\n",
+    "Here we extract the price of each order and the final amount to be paid."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<img src=\"mcdonalds_receipt.png\" alt=\"Alt Text\" width=\"500\">"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Started parsing the file under job_id 66643b81-e2f4-408b-890b-8e116472210b\n"
+     ]
+    }
+   ],
+   "source": [
+    "from llama_cloud_services import LlamaParse\n",
+    "\n",
+    "vanilaParsing = LlamaParse(result_type=\"markdown\").load_data(\"./mcdonalds_receipt.png\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "# Rate us HIGHLY SATISFIED\n",
+      "\n",
+      "Purchase any sandwich and receive a FREE ITEM\n",
+      "\n",
+      "Go to WWW.mcdvoice.com within 7 days of purchase of equal or lesser value and tell us about your visit.\n",
+      "\n",
+      "Validation Code: 31278-01121-21018-20481-00081-0\n",
+      "\n",
+      "Valid at participating US McDonald's\n",
+      "\n",
+      "Expires 30 days after receipt date\n",
+      "\n",
+      "# McDonald's Restaurant #312782378\n",
+      "\n",
+      "PINE RD NW\n",
+      "\n",
+      "RICE MN 56367-9740\n",
+      "\n",
+      "TEL# 320 393 4600\n",
+      "\n",
+      "KS# 12/08/2022 08:48 PM\n",
+      "\n",
+      "# Order\n",
+      "\n",
+      "|Happy Meal 6 Pc|$4.89|\n",
+      "|---|---|\n",
+      "|Creamy Ranch Cup| |\n",
+      "|Extra Kids Fry| |\n",
+      "|Wreck It Ralph 2 Snack| |\n",
+      "|Oreo McFlurry|$2.69|\n",
+      "\n",
+      "# Summary\n",
+      "\n",
+      "|Subtotal|$7.58|\n",
+      "|---|---|\n",
+      "|Tax|$0.52|\n",
+      "|Take-Out Total|$8.10|\n",
+      "|Cash Tendered|$10.00|\n",
+      "|Change|$1.90|\n",
+      "\n",
+      "### Not ACCEPTING APPLICATIONS *++ McDonald's Restaurant Rice\n",
+      "\n",
+      "Text to #36453 apply 31278\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(vanilaParsing[0].text)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Started parsing the file under job_id 1a04fdbb-5415-4a36-a1bd-26bfb5d618fa\n"
+     ]
+    }
+   ],
+   "source": [
+    "parsingInstruction = \"\"\"The provided document is a McDonald's receipt.\n",
+    " Provide the price of each order and final amount to be paid.\"\"\"\n",
+    "withInstructionParsing = LlamaParse(\n",
+    "    result_type=\"markdown\", parsing_instruction=parsingInstruction\n",
+    ").load_data(\"./mcdonalds_receipt.png\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Here are the prices for each order from the McDonald's receipt:\n",
+      "\n",
+      "1. Happy Meal 6 Pc: $4.89\n",
+      "2. Snack Oreo McFlurry: $2.69\n",
+      "\n",
+      "**Subtotal:** $7.58\n",
+      "**Tax:** $0.52\n",
+      "**Total Amount to be Paid:** $8.10\n",
+      "\n",
+      "The cash tendered was $10.00, and the change given was $1.90.\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(withInstructionParsing[0].text)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Expense Report Document\n",
+    "\n",
+    "Here we extract employee name, employee ID, position, department, date ranges, individual expense items with dates, categories, and amounts."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<img src=\"expense_report_document.png\" alt=\"Alt Text\" width=\"500\">"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Started parsing the file under job_id b6bcc6e1-7d30-4522-9abd-ace196781a70\n"
+     ]
+    }
+   ],
+   "source": [
+    "vanilaParsing = LlamaParse(result_type=\"markdown\").load_data(\n",
+    "    \"./expense_report_document.pdf\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "# QUANTUM DYNAMICS CORPORATION\n",
+      "\n",
+      "# EMPLOYEE EXPENSE REPORT\n",
+      "\n",
+      "# FISCAL YEAR 2024\n",
+      "\n",
+      "# EMPLOYEE INFORMATION:\n",
+      "\n",
+      "Name: Dr. Alexandra Chen-Martinez, PhD\n",
+      "\n",
+      "Employee ID: QD-2022-1457\n",
+      "\n",
+      "Department: Advanced Research & Development\n",
+      "\n",
+      "Cost Center: CC-ARD-NA-003\n",
+      "\n",
+      "Project Codes: QD-QUANTUM-2024-01, QD-AI-2024-03\n",
+      "\n",
+      "Position: Principal Research Scientist\n",
+      "\n",
+      "Reporting Manager: Dr. James Thompson\n",
+      "\n",
+      "# TRIP/EXPENSE PERIOD:\n",
+      "\n",
+      "Start Date: November 15, 2024\n",
+      "\n",
+      "End Date: December 10, 2024\n",
+      "\n",
+      "Purpose: International Conference Attendance & Client Meetings\n",
+      "\n",
+      "Locations: Tokyo, Japan → Singapore → Sydney, Australia\n",
+      "\n",
+      "# CURRENCY CONVERSION RATES APPLIED:\n",
+      "\n",
+      "JPY (¥) → USD: 0.0068 (as of 11/15/2024)\n",
+      "\n",
+      "SGD (S$) → USD: 0.74 (as of 11/28/2024)\n",
+      "\n",
+      "AUD (A$) → USD: 0.65 (as of 12/03/2024)\n",
+      "\n",
+      "# ITEMIZED EXPENSES:\n",
+      "\n",
+      "|Date|Category|Description|Original|Currency|USD|\n",
+      "|---|---|---|---|---|---|\n",
+      "|11/15/2024|Transportation|JFK → NRT Business Class|4,250.00|USD|4,250.00|\n",
+      "|Booking Ref: QF78956 - Corporate Rate Applied|Booking Ref: QF78956 - Corporate Rate Applied|Booking Ref: QF78956 - Corporate Rate Applied|Booking Ref: QF78956 - Corporate Rate Applied|Booking Ref: QF78956 - Corporate Rate Applied|Booking Ref: QF78956 - Corporate Rate Applied|\n",
+      "|Project Code: QD-QUANTUM-2024-01|Project Code: QD-QUANTUM-2024-01|Project Code: QD-QUANTUM-2024-01|Project Code: QD-QUANTUM-2024-01|Project Code: QD-QUANTUM-2024-01|Project Code: QD-QUANTUM-2024-01|\n",
+      "|11/16/2024|Accommodation|Hilton Tokyo - 5 nights|225,000|JPY|1,530.00|\n",
+      "|Confirmation: HTK-2024-78956|Confirmation: HTK-2024-78956|Confirmation: HTK-2024-78956|Confirmation: HTK-2024-78956|Confirmation: HTK-2024-78956|Confirmation: HTK-2024-78956|\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(vanilaParsing[0].text)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Started parsing the file under job_id 7b0d05bb-947b-4475-8d0f-f10386f7446e\n"
+     ]
+    }
+   ],
+   "source": [
+    "parsingInstruction = \"\"\"You are provided with an expense report. \n",
+    "Extract employee name, employee id, position, department, date ranges, individual expense items with dates, categories, and amounts.\"\"\"\n",
+    "\n",
+    "withInstructionParsing = LlamaParse(\n",
+    "    result_type=\"markdown\", parsing_instruction=parsingInstruction\n",
+    ").load_data(\"./expense_report_document.pdf\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "**Employee Information:**\n",
+      "- **Name:** Dr. Alexandra Chen-Martinez, PhD\n",
+      "- **Employee ID:** QD-2022-1457\n",
+      "- **Position:** Principal Research Scientist\n",
+      "- **Department:** Advanced Research & Development\n",
+      "\n",
+      "**Trip/Expense Period:**\n",
+      "- **Start Date:** November 15, 2024\n",
+      "- **End Date:** December 10, 2024\n",
+      "\n",
+      "**Expense Items:**\n",
+      "1. **Date:** 11/15/2024\n",
+      "- **Category:** Transportation\n",
+      "- **Description:** JFK → NRT Business Class\n",
+      "- **Original Amount:** $4,250.00\n",
+      "- **Currency:** USD\n",
+      "- **USD Amount:** $4,250.00\n",
+      "- **Booking Reference:** QF78956 - Corporate Rate Applied\n",
+      "- **Project Code:** QD-QUANTUM-2024-01\n",
+      "\n",
+      "2. **Date:** 11/16/2024\n",
+      "- **Category:** Accommodation\n",
+      "- **Description:** Hilton Tokyo - 5 nights\n",
+      "- **Original Amount:** ¥225,000\n",
+      "- **Currency:** JPY\n",
+      "- **USD Amount:** $1,530.00\n",
+      "- **Confirmation:** HTK-2024-78956\n",
+      "\n",
+      "**Locations:**\n",
+      "- Tokyo, Japan\n",
+      "- Singapore\n",
+      "- Sydney, Australia\n",
+      "\n",
+      "**Currency Conversion Rates Applied:**\n",
+      "- JPY (¥) → USD: 0.0068 (as of 11/15/2024)\n",
+      "- SGD (S$) → USD: 0.74 (as of 11/28/2024)\n",
+      "- AUD (A$) → USD: 0.65 (as of 12/03/2024)\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(withInstructionParsing[0].text)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Purchase Order Document \n",
+    "\n",
+    "Here we identify the PO number, vendor details, shipping terms, and an itemized list of products with quantities and unit prices."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<img src=\"purchase_order_document.png\" alt=\"Alt Text\" width=\"500\">"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Started parsing the file under job_id b8cb11c3-7dce-4e6a-94bb-1a4e50e45e55\n"
+     ]
+    }
+   ],
+   "source": [
+    "vanilaParsing = LlamaParse(result_type=\"markdown\").load_data(\n",
+    "    \"./purchase_order_document.pdf\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "# GLOBAL TECH SOLUTIONS, INC.\n",
+      "\n",
+      "# PURCHASE ORDER\n",
+      "\n",
+      "Document Reference: PO-2024-GT-9876/REV.2\n",
+      "\n",
+      "[Original: PO-2024-GT-9876]\n",
+      "\n",
+      "Amendment Date: 12/10/2024\n",
+      "\n",
+      "# VENDOR INFORMATION:\n",
+      "\n",
+      "Quantum Electronics Manufacturing\n",
+      "\n",
+      "DUNS: 78-456-7890\n",
+      "\n",
+      "Tax ID: EU8976543210\n",
+      "\n",
+      "Hoofdorp, Netherlands\n",
+      "\n",
+      "Vendor #: QEM-EU-2024-001\n",
+      "\n",
+      "# SHIP TO:\n",
+      "\n",
+      "Global Tech Solutions, Inc.\n",
+      "\n",
+      "Building 7A, Innovation Park\n",
+      "\n",
+      "2100 Technology Drive\n",
+      "\n",
+      "Austin, TX 78701\n",
+      "\n",
+      "USA\n",
+      "\n",
+      "Attn: Sarah Martinez, Receiving Manager\n",
+      "\n",
+      "Tel: +1 (512) 555-0123\n",
+      "\n",
+      "# PAYMENT TERMS:\n",
+      "\n",
+      "Net 45\n",
+      "\n",
+      "2% discount if paid within 15 days\n",
+      "\n",
+      "# SHIPPING TERMS:\n",
+      "\n",
+      "DDP (Delivered Duty Paid) - Incoterms 2020\n",
+      "\n",
+      "Insurance Required: Yes\n",
+      "\n",
+      "Preferred Carrier: DHL/FedEx\n",
+      "\n",
+      "Required Delivery Date: 01/15/2025\n",
+      "\n",
+      "# SPECIAL INSTRUCTIONS:\n",
+      "\n",
+      "1. All shipments must include Certificate of Conformance\n",
+      "2. ESD-sensitive items must be properly packaged\n",
+      "3. Temperature logging required for items marked with *\n",
+      "4. Partial shipments accepted with prior approval\n",
+      "5. Quote PO number on all correspondence\n",
+      "\n",
+      "# ITEM DETAILS:\n",
+      "\n",
+      "|Line|Part Number|Description|Qty|UOM|Unit Price|Total|\n",
+      "|---|---|---|---|---|---|---|\n",
+      "|1|QE-MCU-5590|Microcontroller Unit|500|EA|$12.50|$6,250.00|\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(vanilaParsing[0].text)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Started parsing the file under job_id d2731305-984d-4633-8a52-0493748cf10b\n"
+     ]
+    }
+   ],
+   "source": [
+    "parsingInstruction = \"\"\"You are provided with a purchase order. \n",
+    "Identify the PO number, vendor details, shipping terms, and itemized list of products with quantities and unit prices.\"\"\"\n",
+    "\n",
+    "withInstructionParsing = LlamaParse(\n",
+    "    result_type=\"markdown\", parsing_instruction=parsingInstruction\n",
+    ").load_data(\"./purchase_order_document.pdf\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Here are the details extracted from the purchase order:\n",
+      "\n",
+      "**PO Number:** PO-2024-GT-9876/REV.2\n",
+      "\n",
+      "**Vendor Details:**\n",
+      "- **Vendor Name:** Quantum Electronics Manufacturing\n",
+      "- **DUNS:** 78-456-7890\n",
+      "- **Tax ID:** EU8976543210\n",
+      "- **Address:** Hoofdorp, Netherlands\n",
+      "- **Vendor Number:** QEM-EU-2024-001\n",
+      "- **Contact Person:** Sarah Martinez, Receiving Manager\n",
+      "- **Phone:** +1 (512) 555-0123\n",
+      "\n",
+      "**Shipping Terms:**\n",
+      "- **Terms:** DDP (Delivered Duty Paid) - Incoterms 2020\n",
+      "- **Insurance Required:** Yes\n",
+      "- **Preferred Carrier:** DHL/FedEx\n",
+      "- **Required Delivery Date:** 01/15/2025\n",
+      "\n",
+      "**Itemized List of Products:**\n",
+      "1. **Part Number:** QE-MCU-5590\n",
+      "- **Description:** Microcontroller Unit\n",
+      "- **Quantity:** 500 EA\n",
+      "- **Unit Price:** $12.50\n",
+      "- **Total:** $6,250.00\n",
+      "\n",
+      "**Payment Terms:**\n",
+      "- Net 45\n",
+      "- 2% discount if paid within 15 days\n",
+      "\n",
+      "**Special Instructions:**\n",
+      "1. All shipments must include Certificate of Conformance\n",
+      "2. ESD-sensitive items must be properly packaged\n",
+      "3. Temperature logging required for items marked with *\n",
+      "4. Partial shipments accepted with prior approval\n",
+      "5. Quote PO number on all correspondence\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(withInstructionParsing[0].text)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "llamacloud",
+   "language": "python",
+   "name": "llamacloud"
+  },
+  "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/parse/test_tesla_impact_report/test_gpt4o.ipynb

@@ -46,7 +46,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"<LLAMA_CLOUD_API_KEY>"
+    "os.environ[\"LLAMA_CLOUD_API_KEY\"] = \"<LLAMA_CLOUD_API_KEY>\""
    ]
   },
   {
@@ -107,7 +107,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from llama_parse import LlamaParse\n",
+    "from llama_cloud_services import LlamaParse\n",
     "\n",
     "parser_gpt4o = LlamaParse(\n",
     "    result_type=\"markdown\",\n",

examples/report/basic_report.ipynb

@@ -0,0 +1,762 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Report Generation with LlamaReport\n",
+    "\n",
+    "In this notebook, we'll walk through the basic process of generating a report with LlamaReport, and highlight some of the key features of the library.\n",
+    "\n",
+    "TLDR:\n",
+    "1. Download source data to use as knowledge base for the report\n",
+    "2. Kick off report generation with a template\n",
+    "3. Get the plan and review/accept/reject suggestions\n",
+    "4. Get the final report\n",
+    "5. Review/accept/reject suggestions to edit the final report\n",
+    "6. Print the final report"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%pip install llama-cloud-services"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 1. Download Source Data\n",
+    "\n",
+    "Here, we download the `Attention is All You Need` paper as a PDF.\n",
+    "\n",
+    "LlamaReport currently supports up to 5 files as input, and essentially any file type that can be parsed by LlamaParse.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!wget \"https://arxiv.org/pdf/1706.03762.pdf\" -O \"./attention.pdf\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 2. Kick off Report Generation\n",
+    "\n",
+    "Here, we kick off report generation with a template.\n",
+    "\n",
+    "The template can either be a string or a file path, but here we'll use a string.\n",
+    "\n",
+    "In our experiments, anything works as a template, but some general guidelines:\n",
+    "\n",
+    "- Use markdown formatting + instructions in each section to guide the report generation\n",
+    "- If using an existing file as a template, provide extra instructions to guide the report generation\n",
+    "\n",
+    "**NOTE:** Since we are in a notebook, we will use async functions and `await` throughout. Synchronous methods that work without `await` are available by just removing the `a` from the method name and removing the `await` keyword."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from llama_cloud_services import LlamaReport\n",
+    "\n",
+    "llama_report = LlamaReport(\n",
+    "    api_key=\"llx-...\",\n",
+    ")\n",
+    "\n",
+    "report_client = await llama_report.acreate_report(\n",
+    "    name=\"my_cool_report_on_attention\",\n",
+    "    # can pass in file paths or bytes\n",
+    "    input_files=[\"./attention.pdf\"],\n",
+    "    template_text=\"\"\"\\\n",
+    "# [Some title]\\n\\n\n",
+    "## TLDR\\n\n",
+    "A quick summary of the paper.\\n\\n\n",
+    "## Details\\n\n",
+    "More details about the paper, possibly more than one section here.\\n\n",
+    "\"\"\",\n",
+    "    # optional additional instructions for the report generation\n",
+    "    # template_instructions=None,\n",
+    "    # optional file path to an existing template instead of template_text\n",
+    "    # template_file=None,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The returned `ReportClient` object is used to interact with the report generation process for this specific report."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Report(id=0a394b33-1a3e-463c-b5cb-7ff8ab827d0a, name=my_cool_report_on_attention)\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(report_client)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 3. Get the plan\n",
+    "\n",
+    "The first phases of report generation involve ingesting the source data and generating a plan.\n",
+    "\n",
+    "The plan is a list of instructions for the report generation, and can be reviewed/accepted/rejected by the user.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "plan = await report_client.await_for_plan(\n",
+    "    timeout=10000,\n",
+    "    poll_interval=10,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "# {title}\n",
+      "[ReportQuery(field='title', prompt='Generate a clear and concise title for this paper about the Transformer model and attention mechanisms', context='The paper discusses the Transformer architecture for sequence transduction using attention mechanisms, focusing on machine translation applications')]\n",
+      "==================\n",
+      "## TLDR\n",
+      "\n",
+      "{tldr_content}\n",
+      "[ReportQuery(field='tldr_content', prompt='Write a brief, clear summary of the key points about the Transformer model', context='Focus on the main innovations: attention mechanisms, efficiency improvements, and state-of-the-art results in machine translation')]\n",
+      "==================\n",
+      "## Details\n",
+      "\n",
+      "{details_content}\n",
+      "[ReportQuery(field='details_content', prompt='Provide detailed information about the Transformer model architecture and its applications', context='Include information about:\\n- The attention mechanism implementation\\n- Advantages over recurrent and convolutional models\\n- Performance in machine translation tasks\\n- Training efficiency improvements')]\n",
+      "==================\n"
+     ]
+    }
+   ],
+   "source": [
+    "for plan_block in plan.blocks:\n",
+    "    print(plan_block.block.template)\n",
+    "    print(plan_block.queries)\n",
+    "    print(\"==================\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "With the plan, we can either use it to kick off generation of the final report, or we can edit the plan and adjust it as needed.\n",
+    "\n",
+    "While we could manually edit the objects here and use `await report_client.aupdate_plan(action=\"edit\", updated_plan=plan)`, we can also use `LlamaReport` to agentically edit the plan."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "suggestions = await report_client.asuggest_edits(\n",
+    "    \"Can you split the details section into two sections?\"\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Justification for change: \n",
+      "I'll help you break down the details section into two distinct parts - one focusing on the architecture and another on the practical applications and performance. This will make the content more organized and easier to follow. The original block at index 2 will be replaced with these two new sections.\n",
+      "\n",
+      "Proposed changes:\n",
+      "\n",
+      "## Architecture Details\n",
+      "\n",
+      "{architecture_content}\n",
+      "\n",
+      "[ReportQuery(field='architecture_content', prompt='Describe the technical details of the Transformer model architecture', context='Focus on:\\n- Core components of the Transformer architecture\\n- Self-attention mechanism implementation\\n- Multi-head attention details\\n- Position encoding approach\\n- Feed-forward network structure')]\n",
+      "==================\n",
+      "\n",
+      "## Performance and Applications\n",
+      "\n",
+      "{applications_content}\n",
+      "\n",
+      "[ReportQuery(field='applications_content', prompt='Explain the practical applications and performance advantages of the Transformer model', context='Cover:\\n- Comparison with RNN and CNN models\\n- Machine translation results and benchmarks\\n- Training efficiency improvements\\n- Real-world applications and use cases\\n- Scalability benefits')]\n",
+      "==================\n"
+     ]
+    }
+   ],
+   "source": [
+    "for suggestion in suggestions:\n",
+    "    print(\"Justification for change:\", suggestion.justification)\n",
+    "    print(\"Proposed changes:\")\n",
+    "    for plan_block in suggestion.blocks:\n",
+    "        print(plan_block.block.template)\n",
+    "        print(plan_block.queries)\n",
+    "        print(\"==================\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This looks pretty good! We can also use the client to automatically accept and apply, or reject, these suggestions.\n",
+    "\n",
+    "This will (locally) keep track of the history of changes, so that future suggestions can be based on the previous changes."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "for suggestion in suggestions:\n",
+    "    await report_client.aaccept_edit(suggestion)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "What effect did that have on the tracked local history? Let's see!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[EditAction(block_idx=2, old_content='## Details\\n\\n{details_content}\\n\\nField: details_content, Prompt: Provide detailed information about the Transformer model architecture and its applications, Context: Include information about:\\n- The attention mechanism implementation\\n- Advantages over recurrent and convolutional models\\n- Performance in machine translation tasks\\n- Training efficiency improvements\\nDepends on: none', new_content='\\n## Architecture Details\\n\\n{architecture_content}\\n\\n\\nField: architecture_content, Prompt: Describe the technical details of the Transformer model architecture, Context: Focus on:\\n- Core components of the Transformer architecture\\n- Self-attention mechanism implementation\\n- Multi-head attention details\\n- Position encoding approach\\n- Feed-forward network structure\\nDepends on: none', action='approved', timestamp=datetime.datetime(2025, 2, 4, 20, 59, 55, 773558)),\n",
+       " EditAction(block_idx=3, old_content='[No old content]', new_content='\\n## Performance and Applications\\n\\n{applications_content}\\n\\n\\nField: applications_content, Prompt: Explain the practical applications and performance advantages of the Transformer model, Context: Cover:\\n- Comparison with RNN and CNN models\\n- Machine translation results and benchmarks\\n- Training efficiency improvements\\n- Real-world applications and use cases\\n- Scalability benefits\\nDepends on: previous', action='approved', timestamp=datetime.datetime(2025, 2, 4, 20, 59, 55, 773687))]"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "report_client.edit_history"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Message(role=<MessageRole.USER: 'user'>, content='Can you split the details section into two sections?', timestamp=datetime.datetime(2025, 2, 4, 20, 59, 47, 754848)),\n",
+       " Message(role=<MessageRole.ASSISTANT: 'assistant'>, content=\"\\nI'll help you break down the details section into two distinct parts - one focusing on the architecture and another on the practical applications and performance. This will make the content more organized and easier to follow. The original block at index 2 will be replaced with these two new sections.\\n\", timestamp=datetime.datetime(2025, 2, 4, 20, 59, 55, 482070))]"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "report_client.chat_history"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "These two items are used to provide context for future suggestions! You can always clear this, or provide your own history."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# report_client.suggest_edits(\"....\", chat_history=[{\"role\": \"user\", \"content\": \"...\"}, ...])"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 4. Get the final report\n",
+    "\n",
+    "Now that we have a plan, we can kick off generation of the final report."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# kicks off report generation\n",
+    "await report_client.aupdate_plan(action=\"approve\")\n",
+    "\n",
+    "# waits for report generation to complete\n",
+    "report = await report_client.await_completion(\n",
+    "    timeout=10000,\n",
+    "    poll_interval=10,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "# Attention Is All You Need: A Pure Attention-Based Architecture for Neural Machine Translation\n",
+      "\n",
+      "## TLDR\n",
+      "\n",
+      "The Transformer introduced a revolutionary architecture that relies entirely on attention mechanisms, eliminating the need for recurrence or convolution in sequence processing. Its key innovations include multi-head self-attention for parallel processing of input sequences, scaled dot-product attention for efficient computation, and positional encodings for sequence order awareness. The model achieved breakthrough results in machine translation (28.4 BLEU on English-to-German, 41.8 BLEU on English-to-French) while requiring significantly less training time than previous approaches, training in 3.5 days on 8 GPUs. This architecture demonstrated that attention mechanisms alone are sufficient for state-of-the-art sequence modeling, setting a new direction for natural language processing.\n",
+      "\n",
+      "\n",
+      "## Architecture Details\n",
+      "\n",
+      "The Transformer architecture represents a groundbreaking approach to sequence processing, built entirely on attention mechanisms without recurrence or convolution. Here are its key technical details:\n",
+      "\n",
+      "Core Components:\n",
+      "- Encoder-decoder architecture with stacked self-attention and point-wise feed-forward layers\n",
+      "- Each layer contains two main sub-layers: multi-head self-attention mechanism and position-wise feed-forward network\n",
+      "- Layer normalization and residual connections between sub-layers\n",
+      "- No recurrent or convolutional elements, enabling parallel processing\n",
+      "\n",
+      "Self-Attention Mechanism:\n",
+      "- Processes relationships between all positions in a sequence simultaneously\n",
+      "- Computes attention weights using queries, keys, and values derived from input representations\n",
+      "- Implements scaled dot-product attention to prevent gradient issues with large input dimensions\n",
+      "- Allows direct modeling of dependencies regardless of positional distance\n",
+      "- Uses masking in decoder to prevent leftward information flow and maintain auto-regressive property\n",
+      "\n",
+      "Multi-Head Attention:\n",
+      "- Employs multiple attention heads operating in parallel\n",
+      "- Each head processes information in different representation subspaces\n",
+      "- Three types of attention applications:\n",
+      "  1. Encoder self-attention (all positions attend to each other)\n",
+      "  2. Decoder self-attention (each position attends to previous positions)\n",
+      "  3. Encoder-decoder attention (decoder queries attend to encoder outputs)\n",
+      "- Counteracts reduced resolution from attention averaging through parallel processing\n",
+      "\n",
+      "Position-wise Feed-Forward Network:\n",
+      "- Applied identically to each position separately\n",
+      "- Consists of two linear transformations with ReLU activation\n",
+      "- Structure: FFN(x) = max(0, xW1 + b1)W2 + b2\n",
+      "- Input and output dimensionality: dmodel = 512\n",
+      "- Inner-layer dimensionality: dff = 2048\n",
+      "- Parameters vary between layers but remain constant across positions\n",
+      "\n",
+      "Position Encoding:\n",
+      "- Adds positional information to input embeddings\n",
+      "- Enables the model to consider sequential order without recurrence\n",
+      "- Implements sinusoidal position encodings to allow model to attend to relative positions\n",
+      "- Maintains constant number of operations between any two positions, unlike convolutional approaches\n",
+      "- Allows effective modeling of both local and long-range dependencies\n",
+      "\n",
+      "\n",
+      "\n",
+      "## Performance and Applications\n",
+      "\n",
+      "The Transformer model demonstrates significant performance advantages and practical applications across multiple domains:\n",
+      "\n",
+      "Performance Advantages over RNN/CNN Models:\n",
+      "- Eliminates sequential computation constraints present in RNNs, enabling superior parallelization\n",
+      "- Reduces operations needed for relating distant positions to a constant number, compared to linear/logarithmic scaling in CNNs\n",
+      "- Processes all input and output positions simultaneously through self-attention mechanisms\n",
+      "- Achieves state-of-the-art results while requiring significantly less computational resources\n",
+      "\n",
+      "Machine Translation Benchmarks:\n",
+      "- WMT 2014 English-to-German: 28.4 BLEU score, exceeding previous best results by over 2 BLEU points\n",
+      "- WMT 2014 English-to-French: 41.8 BLEU score (single-model state-of-the-art)\n",
+      "- Surpasses performance of existing model ensembles in translation tasks\n",
+      "\n",
+      "Training Efficiency:\n",
+      "- Requires only 3.5 days of training on eight GPUs for state-of-the-art performance\n",
+      "- Achieves superior results at \"a small fraction of the training costs\" compared to previous models\n",
+      "- Enables significantly faster training through parallel processing of input/output sequences\n",
+      "- Can reach production-quality performance in as little as twelve hours on modern GPU hardware\n",
+      "\n",
+      "Real-world Applications:\n",
+      "- Machine translation systems\n",
+      "- Natural language understanding tasks\n",
+      "- Reading comprehension\n",
+      "- Abstractive summarization\n",
+      "- Text entailment analysis\n",
+      "- Constituency parsing (achieving 92.7 F1 score in semi-supervised settings)\n",
+      "- Adaptable to both large and limited training data scenarios\n",
+      "\n",
+      "Scalability Benefits:\n",
+      "- Highly parallelizable architecture enables efficient scaling across multiple GPUs\n",
+      "- Constant computational complexity for relating any input/output positions\n",
+      "- Effective handling of long-range dependencies in sequences\n",
+      "- Maintains performance quality while scaling to larger datasets and model sizes\n",
+      "- Generalizes well across different tasks and domains without architectural changes\n",
+      "- Supports efficient inference and deployment in production environments\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "report_text = \"\\n\\n\".join([block.template for block in report.blocks])\n",
+    "print(report_text)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 5. Edit the final report\n",
+    "\n",
+    "Now that we have a report, we can edit it.\n",
+    "\n",
+    "We can use the `asuggest_edits` method to get suggestions for edits, and then use the `aaccept_edit`/`areject_edit` methods to apply them.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Justification for change: \n",
+      "I'd suggest changing \"TLDR\" to \"Executive Summary\" which is more appropriate for a professional or academic report. This term is widely used in formal documents and better reflects the nature of this concise overview section while maintaining the same function of providing a quick summary of the key points.\n",
+      "\n",
+      "Proposed changes:\n",
+      "## Executive Summary\n",
+      "\n",
+      "The Transformer introduced a revolutionary architecture that relies entirely on attention mechanisms, eliminating the need for recurrence or convolution in sequence processing. Its key innovations include multi-head self-attention for parallel processing of input sequences, scaled dot-product attention for efficient computation, and positional encodings for sequence order awareness. The model achieved breakthrough results in machine translation (28.4 BLEU on English-to-German, 41.8 BLEU on English-to-French) while requiring significantly less training time than previous approaches, training in 3.5 days on 8 GPUs. This architecture demonstrated that attention mechanisms alone are sufficient for state-of-the-art sequence modeling, setting a new direction for natural language processing.\n",
+      "==================\n"
+     ]
+    }
+   ],
+   "source": [
+    "suggestions = await report_client.asuggest_edits(\n",
+    "    \"Can you change the TLDR header to something more professional?\"\n",
+    ")\n",
+    "for suggestion in suggestions:\n",
+    "    print(\"Justification for change:\", suggestion.justification)\n",
+    "    print(\"Proposed changes:\")\n",
+    "    for block in suggestion.blocks:\n",
+    "        print(block.template)\n",
+    "        print(\"==================\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Changing to \"Executive Summary\" sounds reasonable, lets accept that!\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "for suggestion in suggestions:\n",
+    "    await report_client.aaccept_edit(suggestion)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 7. Print the final report\n",
+    "\n",
+    "Now that we have a report, we can print it."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "# Attention Is All You Need: A Pure Attention-Based Architecture for Neural Machine Translation\n",
+      "\n",
+      "## Executive Summary\n",
+      "\n",
+      "The Transformer introduced a revolutionary architecture that relies entirely on attention mechanisms, eliminating the need for recurrence or convolution in sequence processing. Its key innovations include multi-head self-attention for parallel processing of input sequences, scaled dot-product attention for efficient computation, and positional encodings for sequence order awareness. The model achieved breakthrough results in machine translation (28.4 BLEU on English-to-German, 41.8 BLEU on English-to-French) while requiring significantly less training time than previous approaches, training in 3.5 days on 8 GPUs. This architecture demonstrated that attention mechanisms alone are sufficient for state-of-the-art sequence modeling, setting a new direction for natural language processing.\n",
+      "\n",
+      "\n",
+      "## Architecture Details\n",
+      "\n",
+      "The Transformer architecture represents a groundbreaking approach to sequence processing, built entirely on attention mechanisms without recurrence or convolution. Here are its key technical details:\n",
+      "\n",
+      "Core Components:\n",
+      "- Encoder-decoder architecture with stacked self-attention and point-wise feed-forward layers\n",
+      "- Each layer contains two main sub-layers: multi-head self-attention mechanism and position-wise feed-forward network\n",
+      "- Layer normalization and residual connections between sub-layers\n",
+      "- No recurrent or convolutional elements, enabling parallel processing\n",
+      "\n",
+      "Self-Attention Mechanism:\n",
+      "- Processes relationships between all positions in a sequence simultaneously\n",
+      "- Computes attention weights using queries, keys, and values derived from input representations\n",
+      "- Implements scaled dot-product attention to prevent gradient issues with large input dimensions\n",
+      "- Allows direct modeling of dependencies regardless of positional distance\n",
+      "- Uses masking in decoder to prevent leftward information flow and maintain auto-regressive property\n",
+      "\n",
+      "Multi-Head Attention:\n",
+      "- Employs multiple attention heads operating in parallel\n",
+      "- Each head processes information in different representation subspaces\n",
+      "- Three types of attention applications:\n",
+      "  1. Encoder self-attention (all positions attend to each other)\n",
+      "  2. Decoder self-attention (each position attends to previous positions)\n",
+      "  3. Encoder-decoder attention (decoder queries attend to encoder outputs)\n",
+      "- Counteracts reduced resolution from attention averaging through parallel processing\n",
+      "\n",
+      "Position-wise Feed-Forward Network:\n",
+      "- Applied identically to each position separately\n",
+      "- Consists of two linear transformations with ReLU activation\n",
+      "- Structure: FFN(x) = max(0, xW1 + b1)W2 + b2\n",
+      "- Input and output dimensionality: dmodel = 512\n",
+      "- Inner-layer dimensionality: dff = 2048\n",
+      "- Parameters vary between layers but remain constant across positions\n",
+      "\n",
+      "Position Encoding:\n",
+      "- Adds positional information to input embeddings\n",
+      "- Enables the model to consider sequential order without recurrence\n",
+      "- Implements sinusoidal position encodings to allow model to attend to relative positions\n",
+      "- Maintains constant number of operations between any two positions, unlike convolutional approaches\n",
+      "- Allows effective modeling of both local and long-range dependencies\n",
+      "\n",
+      "\n",
+      "\n",
+      "## Performance and Applications\n",
+      "\n",
+      "The Transformer model demonstrates significant performance advantages and practical applications across multiple domains:\n",
+      "\n",
+      "Performance Advantages over RNN/CNN Models:\n",
+      "- Eliminates sequential computation constraints present in RNNs, enabling superior parallelization\n",
+      "- Reduces operations needed for relating distant positions to a constant number, compared to linear/logarithmic scaling in CNNs\n",
+      "- Processes all input and output positions simultaneously through self-attention mechanisms\n",
+      "- Achieves state-of-the-art results while requiring significantly less computational resources\n",
+      "\n",
+      "Machine Translation Benchmarks:\n",
+      "- WMT 2014 English-to-German: 28.4 BLEU score, exceeding previous best results by over 2 BLEU points\n",
+      "- WMT 2014 English-to-French: 41.8 BLEU score (single-model state-of-the-art)\n",
+      "- Surpasses performance of existing model ensembles in translation tasks\n",
+      "\n",
+      "Training Efficiency:\n",
+      "- Requires only 3.5 days of training on eight GPUs for state-of-the-art performance\n",
+      "- Achieves superior results at \"a small fraction of the training costs\" compared to previous models\n",
+      "- Enables significantly faster training through parallel processing of input/output sequences\n",
+      "- Can reach production-quality performance in as little as twelve hours on modern GPU hardware\n",
+      "\n",
+      "Real-world Applications:\n",
+      "- Machine translation systems\n",
+      "- Natural language understanding tasks\n",
+      "- Reading comprehension\n",
+      "- Abstractive summarization\n",
+      "- Text entailment analysis\n",
+      "- Constituency parsing (achieving 92.7 F1 score in semi-supervised settings)\n",
+      "- Adaptable to both large and limited training data scenarios\n",
+      "\n",
+      "Scalability Benefits:\n",
+      "- Highly parallelizable architecture enables efficient scaling across multiple GPUs\n",
+      "- Constant computational complexity for relating any input/output positions\n",
+      "- Effective handling of long-range dependencies in sequences\n",
+      "- Maintains performance quality while scaling to larger datasets and model sizes\n",
+      "- Generalizes well across different tasks and domains without architectural changes\n",
+      "- Supports efficient inference and deployment in production environments\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "report_response = await report_client.aget()\n",
+    "report_text = \"\\n\\n\".join([block.template for block in report_response.report.blocks])\n",
+    "print(report_text)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We can also see the sources for each block!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "0.99687636\n",
+      "# Abstract\n",
+      "\n",
+      "The dominant sequence transduction models are based on complex recurrent or convolutiona\n",
+      "==================\n",
+      "0.99591404\n",
+      "# 2 Background\n",
+      "\n",
+      "The goal of reducing sequential computation also forms the foundation of the Extende\n",
+      "==================\n",
+      "0.9951325\n",
+      "# 1 Introduction\n",
+      "\n",
+      "Recurrent neural networks, long short-term memory [13] and gated recurrent [7] neu\n",
+      "==================\n",
+      "0.99442345\n",
+      "# 7 Conclusion\n",
+      "\n",
+      "In this work, we presented the Transformer, the first sequence transduction model ba\n",
+      "==================\n",
+      "0.9967649\n",
+      "# 3.2.3 Applications of Attention in our Model\n",
+      "\n",
+      "The Transformer uses multi-head attention in three d\n",
+      "==================\n",
+      "0.99533635\n",
+      "# 2 Background\n",
+      "\n",
+      "The goal of reducing sequential computation also forms the foundation of the Extende\n",
+      "==================\n",
+      "0.9935868\n",
+      "# Abstract\n",
+      "\n",
+      "The dominant sequence transduction models are based on complex recurrent or convolutiona\n",
+      "==================\n",
+      "0.98780584\n",
+      "# Outputs\n",
+      "\n",
+      "(shifted right)\n",
+      "\n",
+      "Figure 1: The Transformer - model architecture.\n",
+      "\n",
+      "The Transformer follows\n",
+      "==================\n",
+      "0.9205043\n",
+      "# 3.3 Position-wise Feed-Forward Networks\n",
+      "\n",
+      "In addition to attention sub-layers, each of the layers i\n",
+      "==================\n",
+      "0.79581684\n",
+      "# 1 Introduction\n",
+      "\n",
+      "Recurrent neural networks, long short-term memory [13] and gated recurrent [7] neu\n",
+      "==================\n",
+      "0.9946774\n",
+      "# Abstract\n",
+      "\n",
+      "The dominant sequence transduction models are based on complex recurrent or convolutiona\n",
+      "==================\n",
+      "0.97079873\n",
+      "# 7 Conclusion\n",
+      "\n",
+      "In this work, we presented the Transformer, the first sequence transduction model ba\n",
+      "==================\n",
+      "0.9535353\n",
+      "# 6.3 English Constituency Parsing\n",
+      "\n",
+      "To evaluate if the Transformer can generalize to other tasks we \n",
+      "==================\n",
+      "0.9514138\n",
+      "# 2 Background\n",
+      "\n",
+      "The goal of reducing sequential computation also forms the foundation of the Extende\n",
+      "==================\n",
+      "0.9790758\n",
+      "# 1 Introduction\n",
+      "\n",
+      "Recurrent neural networks, long short-term memory [13] and gated recurrent [7] neu\n",
+      "==================\n",
+      "0.92262185\n",
+      "# Outputs\n",
+      "\n",
+      "(shifted right)\n",
+      "\n",
+      "Figure 1: The Transformer - model architecture.\n",
+      "\n",
+      "The Transformer follows\n",
+      "==================\n"
+     ]
+    }
+   ],
+   "source": [
+    "for block in report_response.report.blocks:\n",
+    "    # Each block has a list of sources, which are the nodes that were used to generate the block\n",
+    "    for source in block.sources:\n",
+    "        print(source.score)\n",
+    "        print(source.node.text[:100])\n",
+    "        print(\"==================\")"
+   ]
+  }
+ ],
+ "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
+}

llama_cloud_services/__init__.py

@@ -0,0 +1,8 @@
+from llama_cloud_services.parse import LlamaParse
+from llama_cloud_services.report import ReportClient, LlamaReport
+
+__all__ = [
+    "LlamaParse",
+    "ReportClient",
+    "LlamaReport",
+]

llama_cloud_services/parse/__init__.py

@@ -0,0 +1,3 @@
+from llama_cloud_services.parse.base import LlamaParse, ResultType
+
+__all__ = ["LlamaParse", "ResultType"]

llama_cloud_services/parse/cli/main.py

@@ -0,0 +1,92 @@
+import click
+import json
+from enum import Enum
+from pathlib import Path
+from pydantic.fields import FieldInfo
+from typing import Any, Callable, List
+
+from llama_cloud_services.parse.base import LlamaParse
+
+
+def pydantic_field_to_click_option(name: str, field: FieldInfo) -> click.Option:
+    """Convert a Pydantic field to a Click option."""
+    kwargs = {
+        "default": field.default if field.default else None,
+        "help": field.description,
+    }
+
+    if isinstance(kwargs["default"], Enum):
+        kwargs["default"] = kwargs["default"].value
+
+    if field.annotation is bool:
+        kwargs["is_flag"] = True
+        if field.default and field.default is True:
+            name = f"no-{name}"
+    return click.option(f'--{name.replace("_", "-")}', **kwargs)
+
+
+def add_options(options: List[click.Option]) -> Callable:
+    def _add_options(func: Callable) -> Callable:
+        for option in reversed(options):
+            func = option(func)
+        return func
+
+    return _add_options
+
+
+@click.command()
+@click.argument("file_paths", nargs=-1, type=click.Path(exists=True, path_type=Path))
+@click.option(
+    "--output-file", type=click.Path(path_type=Path), help="Path to save the output"
+)
+@click.option("--output-raw-json", is_flag=True, help="Output the raw JSON result")
+@add_options(
+    [
+        pydantic_field_to_click_option(name, field)
+        for name, field in LlamaParse.model_fields.items()
+        if name not in ["custom_client"]
+    ]
+)
+def parse(**kwargs: Any) -> None:
+    """Parse files using LlamaParse and output the results."""
+    file_paths = kwargs.pop("file_paths")
+    output_file = kwargs.pop("output_file")
+    output_raw_json = kwargs.pop("output_raw_json")
+
+    # Remove None values to use LlamaParse defaults
+    kwargs = {k: v for k, v in kwargs.items() if v is not None}
+
+    # Remove no- prefix for boolean flags
+    kwargs = {k.replace("no_", ""): v for k, v in kwargs.items()}
+
+    parser = LlamaParse(**kwargs)
+    if output_raw_json:
+        results = parser.get_json_result(list(file_paths))
+
+        if output_file:
+            with output_file.open("w") as f:
+                json.dump(results, f)
+            click.echo(f"Results saved to {output_file}")
+        else:
+            click.echo(results)
+    else:
+        results = parser.load_data(list(file_paths))
+
+        if output_file:
+            with output_file.open("w") as f:
+                for i, doc in enumerate(results):
+                    f.write(f"File: {doc.metadata.get('file_path', 'Unknown')}\n")  # type: ignore
+                    f.write(doc.text)  # type: ignore
+                    if i < len(results) - 1:
+                        f.write("\n\n---\n\n")
+            click.echo(f"Results saved to {output_file}")
+        else:
+            for i, doc in enumerate(results):
+                click.echo(f"File: {doc.metadata.get('file_path', 'Unknown')}")  # type: ignore
+                click.echo(doc.text)  # type: ignore
+                if i < len(results) - 1:
+                    click.echo("\n---\n")
+
+
+if __name__ == "__main__":
+    parse()

llama_cloud_services/parse/utils.py

@@ -11,6 +11,7 @@ class ResultType(str, Enum):
     TXT = "text"
     MD = "markdown"
     JSON = "json"
+    STRUCTURED = "structured"
 
 
 class Language(str, Enum):
@@ -190,4 +191,11 @@ SUPPORTED_FILE_TYPES = [
     ".xlr",
     ".eth",
     ".tsv",
+    ".mp3",
+    ".mp4",
+    ".mpeg",
+    ".mpga",
+    ".m4a",
+    ".wav",
+    ".webm",
 ]

llama_cloud_services/report/__init__.py

@@ -0,0 +1,4 @@
+from llama_cloud_services.report.report import ReportClient
+from llama_cloud_services.report.base import LlamaReport
+
+__all__ = ["ReportClient", "LlamaReport"]

llama_cloud_services/report/base.py

@@ -0,0 +1,269 @@
+import asyncio
+import httpx
+import os
+import io
+from concurrent.futures import ThreadPoolExecutor
+from typing import Optional, List, Union, Any, Coroutine, TypeVar
+from urllib.parse import urljoin
+
+from llama_cloud.types import ReportMetadata
+from llama_cloud_services.report.report import ReportClient
+
+T = TypeVar("T")
+
+
+class LlamaReport:
+    """Client for managing reports and general report operations."""
+
+    def __init__(
+        self,
+        api_key: Optional[str] = None,
+        project_id: Optional[str] = None,
+        organization_id: Optional[str] = None,
+        base_url: Optional[str] = None,
+        timeout: Optional[int] = None,
+        async_httpx_client: Optional[httpx.AsyncClient] = None,
+    ):
+        self.api_key = api_key or os.getenv("LLAMA_CLOUD_API_KEY", None)
+        if not self.api_key:
+            raise ValueError("No API key provided.")
+
+        self.base_url = base_url or os.getenv(
+            "LLAMA_CLOUD_BASE_URL", "https://api.cloud.llamaindex.ai"
+        )
+        self.timeout = timeout or 60
+
+        # Initialize HTTP clients
+        self._aclient = async_httpx_client or httpx.AsyncClient(timeout=self.timeout)
+
+        # Set auth headers
+        self.headers = {
+            "Authorization": f"Bearer {self.api_key}",
+        }
+
+        self.organization_id = organization_id
+        self.project_id = project_id
+        self._client_params = {
+            "timeout": self._aclient.timeout,
+            "headers": self._aclient.headers,
+            "base_url": self._aclient.base_url,
+            "auth": self._aclient.auth,
+            "event_hooks": self._aclient.event_hooks,
+            "cookies": self._aclient.cookies,
+            "max_redirects": self._aclient.max_redirects,
+            "params": self._aclient.params,
+            "trust_env": self._aclient.trust_env,
+        }
+        self._thread_pool = ThreadPoolExecutor(
+            max_workers=min(10, (os.cpu_count() or 1) + 4)
+        )
+
+    @property
+    def aclient(self) -> httpx.AsyncClient:
+        if self._aclient is None:
+            self._aclient = httpx.AsyncClient(**self._client_params)
+        return self._aclient
+
+    def _run_sync(self, coro: Coroutine[Any, Any, T]) -> T:
+        """Run coroutine in a separate thread to avoid event loop issues"""
+
+        # force a new client for this thread/event loop
+        original_client = self._aclient
+        self._aclient = None
+
+        def run_coro() -> T:
+            async def wrapped_coro() -> T:
+                return await coro
+
+            return asyncio.run(wrapped_coro())
+
+        result = self._thread_pool.submit(run_coro).result()
+
+        # restore the original client
+        self._aclient = original_client
+
+        return result
+
+    async def _get_default_project(self) -> str:
+        response = await self.aclient.get(
+            urljoin(str(self.base_url), "/api/v1/projects"), headers=self.headers
+        )
+        response.raise_for_status()
+        projects = response.json()
+        default_project = [p for p in projects if p.get("is_default")]
+        return default_project[0]["id"]
+
+    async def _build_url(
+        self, endpoint: str, extra_params: Optional[List[str]] = None
+    ) -> str:
+        """Helper method to build URLs with common query parameters."""
+        url = urljoin(str(self.base_url), endpoint)
+
+        if not self.project_id:
+            self.project_id = await self._get_default_project()
+
+        query_params = []
+        if self.organization_id:
+            query_params.append(f"organization_id={self.organization_id}")
+        if self.project_id:
+            query_params.append(f"project_id={self.project_id}")
+        if extra_params:
+            query_params.extend([p for p in extra_params if p is not None])
+
+        if query_params:
+            url += "?" + "&".join(query_params)
+
+        return url
+
+    async def acreate_report(
+        self,
+        name: str,
+        template_instructions: Optional[str] = None,
+        template_text: Optional[str] = None,
+        template_file: Optional[Union[str, tuple[str, bytes]]] = None,
+        input_files: Optional[List[Union[str, tuple[str, bytes]]]] = None,
+        existing_retriever_id: Optional[str] = None,
+    ) -> ReportClient:
+        """Create a new report asynchronously."""
+        url = await self._build_url("/api/v1/reports/")
+        open_files: List[io.BufferedReader] = []
+
+        data = {"name": name}
+        if template_instructions:
+            data["template_instructions"] = template_instructions
+        if template_text:
+            data["template_text"] = template_text
+        if existing_retriever_id:
+            data["existing_retriever_id"] = str(existing_retriever_id)
+
+        files: List[tuple[str, io.BufferedReader | bytes]] = []
+        if template_file:
+            if isinstance(template_file, str):
+                open_files.append(open(template_file, "rb"))
+                files.append(("template_file", open_files[-1]))
+            else:
+                files.append(("template_file", template_file[1]))
+
+        if input_files:
+            for f in input_files:
+                if isinstance(f, str):
+                    open_files.append(open(f, "rb"))
+                    files.append(("files", open_files[-1]))
+                else:
+                    files.append(("files", f[1]))
+
+        response = await self.aclient.post(
+            url, headers=self.headers, data=data, files=files
+        )
+        try:
+            response.raise_for_status()
+            report_id = response.json()["id"]
+            return ReportClient(report_id, name, self)
+        except httpx.HTTPStatusError as e:
+            raise ValueError(
+                f"Failed to create report: {e.response.text}\nError Code: {e.response.status_code}"
+            )
+        finally:
+            for open_file in open_files:
+                open_file.close()
+
+    def create_report(
+        self,
+        name: str,
+        template_instructions: Optional[str] = None,
+        template_text: Optional[str] = None,
+        template_file: Optional[Union[str, tuple[str, bytes]]] = None,
+        input_files: Optional[List[Union[str, tuple[str, bytes]]]] = None,
+        existing_retriever_id: Optional[str] = None,
+    ) -> ReportClient:
+        """Create a new report."""
+        return self._run_sync(
+            self.acreate_report(
+                name=name,
+                template_instructions=template_instructions,
+                template_text=template_text,
+                template_file=template_file,
+                input_files=input_files,
+                existing_retriever_id=existing_retriever_id,
+            )
+        )
+
+    async def alist_reports(
+        self, state: Optional[str] = None, limit: int = 100, offset: int = 0
+    ) -> List[ReportClient]:
+        """List all reports asynchronously."""
+        params = []
+        if state:
+            params.append(f"state={state}")
+        if limit:
+            params.append(f"limit={limit}")
+        if offset:
+            params.append(f"offset={offset}")
+
+        url = await self._build_url(
+            "/api/v1/reports/list",
+            extra_params=params,
+        )
+
+        response = await self.aclient.get(url, headers=self.headers)
+        response.raise_for_status()
+        data = response.json()
+
+        return [
+            ReportClient(r["report_id"], r["name"], self)
+            for r in data["report_responses"]
+        ]
+
+    def list_reports(
+        self, state: Optional[str] = None, limit: int = 100, offset: int = 0
+    ) -> List[ReportClient]:
+        """Synchronous wrapper for listing reports."""
+        return self._run_sync(self.alist_reports(state, limit, offset))
+
+    async def aget_report(self, report_id: str) -> ReportClient:
+        """Get a Report instance for working with a specific report."""
+        url = await self._build_url(f"/api/v1/reports/{report_id}")
+
+        response = await self.aclient.get(url, headers=self.headers)
+        response.raise_for_status()
+        data = response.json()
+
+        return ReportClient(data["report_id"], data["name"], self)
+
+    def get_report(self, report_id: str) -> ReportClient:
+        """Synchronous wrapper for getting a report."""
+        return self._run_sync(self.aget_report(report_id))
+
+    async def aget_report_metadata(self, report_id: str) -> ReportMetadata:
+        """Get metadata for a specific report asynchronously.
+
+        Returns:
+            dict containing:
+            - id: Report ID
+            - name: Report name
+            - state: Current report state
+            - report_metadata: Additional metadata
+            - template_file: Name of template file if used
+            - template_instructions: Template instructions if provided
+            - input_files: List of input file names
+        """
+        url = await self._build_url(f"/api/v1/reports/{report_id}/metadata")
+
+        response = await self.aclient.get(url, headers=self.headers)
+        response.raise_for_status()
+        return ReportMetadata(**response.json())
+
+    def get_report_metadata(self, report_id: str) -> ReportMetadata:
+        """Synchronous wrapper for getting report metadata."""
+        return self._run_sync(self.aget_report_metadata(report_id))
+
+    async def adelete_report(self, report_id: str) -> None:
+        """Delete a specific report asynchronously."""
+        url = await self._build_url(f"/api/v1/reports/{report_id}")
+
+        response = await self.aclient.delete(url, headers=self.headers)
+        response.raise_for_status()
+
+    def delete_report(self, report_id: str) -> None:
+        """Synchronous wrapper for deleting a report."""
+        return self._run_sync(self.adelete_report(report_id))

llama_cloud_services/report/report.py

@@ -0,0 +1,527 @@
+import asyncio
+import httpx
+import time
+from typing import Optional, List, Literal, Union, TYPE_CHECKING
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+
+from llama_cloud.types import (
+    ReportEventItemEventData_Progress,
+    ReportMetadata,
+    EditSuggestion,
+    ReportResponse,
+    ReportPlan,
+    ReportBlock,
+    ReportPlanBlock,
+    Report,
+)
+
+if TYPE_CHECKING:
+    from llama_cloud_services.report.base import LlamaReport
+
+
+class MessageRole(str, Enum):
+    USER = "user"
+    ASSISTANT = "assistant"
+
+
+@dataclass
+class Message:
+    role: MessageRole
+    content: str
+    timestamp: datetime
+
+
+@dataclass
+class EditAction:
+    block_idx: int
+    old_content: str
+    new_content: Optional[str]
+    action: Literal["approved", "rejected"]
+    timestamp: datetime
+
+
+DEFAULT_POLL_INTERVAL = 5
+DEFAULT_TIMEOUT = 600
+
+
+class ReportClient:
+    """Client for operations on a specific report."""
+
+    def __init__(self, report_id: str, name: str, parent_client: "LlamaReport"):
+        self.report_id = report_id
+        self.name = name
+        self._client = parent_client
+        self._headers = parent_client.headers
+        self._run_sync = parent_client._run_sync
+        self._build_url = parent_client._build_url
+        self.chat_history: List[Message] = []
+        self.edit_history: List[EditAction] = []
+
+    @property
+    def aclient(self) -> httpx.AsyncClient:
+        return self._client.aclient
+
+    def __str__(self) -> str:
+        return f"Report(id={self.report_id}, name={self.name})"
+
+    def __repr__(self) -> str:
+        return f"Report(id={self.report_id}, name={self.name})"
+
+    def _get_block_content(self, block: Union[ReportBlock, ReportPlanBlock]) -> str:
+        if isinstance(block, ReportBlock):
+            return block.template
+        elif isinstance(block, ReportPlanBlock):
+            return block.block.template
+        else:
+            raise ValueError(f"Invalid block type: {type(block)}")
+
+    def _get_block_idx(self, block: Union[ReportBlock, ReportPlanBlock]) -> int:
+        if isinstance(block, ReportBlock):
+            return block.idx
+        elif isinstance(block, ReportPlanBlock):
+            return block.block.idx
+        else:
+            raise ValueError(f"Invalid block type: {type(block)}")
+
+    async def aget(self, version: Optional[int] = None) -> ReportResponse:
+        """Get this report's details asynchronously."""
+        extra_params = []
+        if version is not None:
+            extra_params.append(f"version={version}")
+
+        url = await self._build_url(f"/api/v1/reports/{self.report_id}", extra_params)
+
+        response = await self.aclient.get(url, headers=self._headers)
+        response.raise_for_status()
+        return ReportResponse(**response.json())
+
+    def get(self, version: Optional[int] = None) -> ReportResponse:
+        """Synchronous wrapper for getting this report's details."""
+        return self._run_sync(self.aget(version))
+
+    async def aupdate_report(self, updated_report: Report) -> ReportResponse:
+        """Update this report's content asynchronously."""
+        url = await self._build_url(f"/api/v1/reports/{self.report_id}")
+        response = await self.aclient.patch(
+            url, headers=self._headers, json={"content": updated_report.dict()}
+        )
+        response.raise_for_status()
+        return ReportResponse(**response.json())
+
+    def update_report(self, updated_report: Report) -> ReportResponse:
+        """Synchronous wrapper for updating this report's content."""
+        return self._run_sync(self.aupdate_report(updated_report))
+
+    async def aupdate_plan(
+        self,
+        action: Literal["approve", "reject", "edit"],
+        updated_plan: Optional[ReportPlan] = None,
+    ) -> ReportResponse:
+        """Update this report's plan asynchronously."""
+        if action == "edit" and not updated_plan:
+            raise ValueError("updated_plan is required when action is 'edit'")
+
+        url = await self._build_url(
+            f"/api/v1/reports/{self.report_id}/plan", [f"action={action}"]
+        )
+
+        data = None
+        if updated_plan is not None:
+            plan_dict = updated_plan.dict()
+            plan_dict.pop("generated_at", None)
+            data = plan_dict
+
+        if updated_plan is None and action == "edit":
+            raise ValueError("updated_plan is required when action is 'edit'")
+
+        response = await self.aclient.patch(url, headers=self._headers, json=data)
+        response.raise_for_status()
+        return ReportResponse(**response.json())
+
+    def update_plan(
+        self,
+        action: Literal["approve", "reject", "edit"],
+        updated_plan: Optional[ReportPlan] = None,
+    ) -> ReportResponse:
+        """Synchronous wrapper for updating this report's plan."""
+        return self._run_sync(self.aupdate_plan(action, updated_plan))
+
+    async def asuggest_edits(
+        self,
+        user_query: str,
+        auto_history: bool = True,
+        chat_history: Optional[List[dict]] = None,
+    ) -> List[EditSuggestion]:
+        """Get AI suggestions for edits to this report asynchronously.
+
+        Args:
+            user_query: The user's request/question about what to edit
+            auto_history: Whether to automatically add the user's message to the chat history
+            chat_history:
+                A list of chat messages to include in the chat history.
+                The format being a list of dictionaries with "role" and "content" keys.
+        """
+        # Add user message to history
+        self.chat_history.append(
+            Message(role=MessageRole.USER, content=user_query, timestamp=datetime.now())
+        )
+
+        # Format chat history with edit summaries
+        chat_history_dicts = []
+        for msg in self.chat_history[:-1]:  # Exclude current message
+            content = msg.content
+            if msg.role == MessageRole.USER:
+                # Add edit summary for user messages
+                edit_summary = self._get_edit_summary_after_message(msg.timestamp)
+                if edit_summary:
+                    content = f"{content}\n\nActions taken:\n{edit_summary}"
+
+            chat_history_dicts.append({"role": msg.role.value, "content": content})
+
+        # decide whether to include chat history or not
+        if chat_history:
+            chat_history_dicts = chat_history
+        elif auto_history:
+            chat_history_dicts = chat_history_dicts
+        else:
+            chat_history_dicts = []
+
+        # Make the API call
+        url = await self._build_url(f"/api/v1/reports/{self.report_id}/suggest_edits")
+        data = {"user_query": user_query, "chat_history": chat_history_dicts}
+
+        response = await self.aclient.post(url, headers=self._headers, json=data)
+        response.raise_for_status()
+        suggestions = response.json()
+        suggestions = [EditSuggestion(**suggestion) for suggestion in suggestions]
+
+        # Add assistant response to history
+        if suggestions:
+            for suggestion in suggestions:
+                self.chat_history.append(
+                    Message(
+                        role=MessageRole.ASSISTANT,
+                        content=suggestion.justification,
+                        timestamp=datetime.now(),
+                    )
+                )
+
+        return suggestions
+
+    def suggest_edits(
+        self,
+        user_query: str,
+        auto_history: bool = True,
+        chat_history: Optional[List[dict]] = None,
+    ) -> List[EditSuggestion]:
+        """Synchronous wrapper for getting edit suggestions."""
+        return self._run_sync(
+            self.asuggest_edits(user_query, auto_history, chat_history)
+        )
+
+    async def await_completion(
+        self, timeout: int = DEFAULT_TIMEOUT, poll_interval: int = DEFAULT_POLL_INTERVAL
+    ) -> Report:
+        """Wait for this report to complete processing."""
+        start_time = time.time()
+        while True:
+            report_response = await self.aget()
+            status = report_response.status
+
+            if status == "completed":
+                return report_response.report
+            elif status == "error":
+                events = await self.aget_events()
+                raise ValueError(f"Report entered error state: {events[-1].msg}")
+            elif time.time() - start_time > timeout:
+                raise TimeoutError(f"Report did not complete within {timeout} seconds")
+
+            await asyncio.sleep(poll_interval)
+
+    def wait_for_completion(
+        self, timeout: int = DEFAULT_TIMEOUT, poll_interval: int = DEFAULT_POLL_INTERVAL
+    ) -> Report:
+        """Synchronous wrapper for awaiting report completion."""
+        return self._run_sync(self.await_completion(timeout, poll_interval))
+
+    async def await_for_plan(
+        self, timeout: int = DEFAULT_TIMEOUT, poll_interval: int = DEFAULT_POLL_INTERVAL
+    ) -> ReportPlan:
+        """Wait for this report's plan to be ready for review."""
+        start_time = time.time()
+        while True:
+            report_metadata = await self.aget_metadata()
+            state = report_metadata.state
+
+            if state == "waiting_approval":
+                report_response = await self.aget()
+                return report_response.plan
+            elif state == "error":
+                events = await self.aget_events()
+                raise ValueError(f"Report entered error state: {events[-1].msg}")
+            elif time.time() - start_time > timeout:
+                raise TimeoutError(f"Plan was not ready within {timeout} seconds")
+
+            await asyncio.sleep(poll_interval)
+
+    def wait_for_plan(
+        self, timeout: int = DEFAULT_TIMEOUT, poll_interval: int = DEFAULT_POLL_INTERVAL
+    ) -> ReportPlan:
+        """Synchronous wrapper for awaiting plan readiness."""
+        return self._run_sync(self.await_for_plan(timeout, poll_interval))
+
+    async def aget_metadata(self) -> ReportMetadata:
+        """Get this report's metadata asynchronously."""
+        return await self._client.aget_report_metadata(self.report_id)
+
+    def get_metadata(self) -> ReportMetadata:
+        """Synchronous wrapper for getting this report's metadata."""
+        return self._run_sync(self.aget_metadata())
+
+    async def adelete(self) -> None:
+        """Delete this report asynchronously."""
+        return await self._client.adelete_report(self.report_id)
+
+    def delete(self) -> None:
+        """Synchronous wrapper for deleting this report."""
+        return self._run_sync(self.adelete())
+
+    async def aaccept_edit(self, suggestion: EditSuggestion) -> None:
+        """Accept a suggested edit.
+
+        Args:
+            suggestion: The EditSuggestion to accept, typically from suggest_edits()
+        """
+        if len(suggestion.blocks) == 0:
+            return
+
+        # Determine if we're editing a plan or report based on first block type
+        is_plan_edit = isinstance(suggestion.blocks[0], ReportPlanBlock)
+
+        # Get current content
+        report_response = await self.aget()
+        current_blocks = (
+            report_response.plan.blocks
+            if is_plan_edit
+            else report_response.report.blocks
+        )
+
+        # Track the edit
+        new_blocks = []
+        for edit_block in suggestion.blocks:
+            # Find matching block in current content
+            old_block = next(
+                (
+                    b
+                    for b in current_blocks
+                    if self._get_block_idx(b) == self._get_block_idx(edit_block)
+                ),
+                None,
+            )
+
+            old_content = (
+                self._get_block_content(old_block) if old_block else "[No old content]"
+            )
+            new_content = self._get_block_content(edit_block)
+
+            if is_plan_edit:
+                new_queries_str = "\n".join(
+                    [
+                        f"Field: {q.field}, Prompt: {q.prompt}, Context: {q.context}"
+                        for q in edit_block.queries
+                    ]
+                )
+                new_dependency_str = (
+                    f"Depends on: {edit_block.dependency}"
+                    if edit_block.dependency
+                    else ""
+                )
+                new_content += f"\n\n{new_queries_str}\n{new_dependency_str}"
+
+                if old_block:
+                    old_queries_str = "\n".join(
+                        [
+                            f"Field: {q.field}, Prompt: {q.prompt}, Context: {q.context}"
+                            for q in old_block.queries
+                        ]
+                    )
+                    old_dependency_str = (
+                        f"Depends on: {old_block.dependency}"
+                        if old_block.dependency
+                        else ""
+                    )
+                    old_content += f"\n\n{old_queries_str}\n{old_dependency_str}"
+
+            self.edit_history.append(
+                EditAction(
+                    block_idx=self._get_block_idx(edit_block),
+                    old_content=old_content,
+                    new_content=new_content,
+                    action="approved",
+                    timestamp=datetime.now(),
+                )
+            )
+
+            # Create updated block
+            if is_plan_edit:
+                new_blocks.append(
+                    ReportPlanBlock(
+                        block=ReportBlock(
+                            idx=edit_block.block.idx,
+                            template=self._get_block_content(edit_block),
+                            sources=edit_block.block.sources,
+                        ),
+                        queries=edit_block.queries,
+                        dependency=edit_block.dependency,
+                    )
+                )
+            else:
+                new_blocks.append(
+                    ReportBlock(
+                        idx=edit_block.idx,
+                        template=self._get_block_content(edit_block),
+                        sources=edit_block.sources,
+                    )
+                )
+
+        if new_blocks:
+            if is_plan_edit:
+                # Update plan in place
+                plan = report_response.plan
+
+                # Replace edited blocks and add new ones
+                for new_block in new_blocks:
+                    block_idx = self._get_block_idx(new_block)
+                    existing_block_idx = next(
+                        (
+                            i
+                            for i, b in enumerate(plan.blocks)
+                            if b.block.idx == block_idx
+                        ),
+                        None,
+                    )
+
+                    if existing_block_idx is not None:
+                        # Replace existing block
+                        plan.blocks[existing_block_idx] = new_block
+                    else:
+                        # Add new block to end
+                        plan.blocks.append(new_block)
+
+                await self.aupdate_plan("edit", plan)
+            else:
+                # Update report in place
+                report = report_response.report
+
+                # Replace edited blocks and add new ones
+                for new_block in new_blocks:
+                    block_idx = self._get_block_idx(new_block)
+                    existing_block_idx = next(
+                        (i for i, b in enumerate(report.blocks) if b.idx == block_idx),
+                        None,
+                    )
+
+                    if existing_block_idx is not None:
+                        # Replace existing block
+                        report.blocks[existing_block_idx] = new_block
+                    else:
+                        # Add new block to end
+                        report.blocks.append(new_block)
+
+                await self.aupdate_report(report)
+
+    def accept_edit(self, suggestion: EditSuggestion) -> None:
+        """Synchronous wrapper for accepting an edit."""
+        return self._run_sync(self.aaccept_edit(suggestion))
+
+    async def areject_edit(self, suggestion: EditSuggestion) -> None:
+        """Reject a suggested edit.
+
+        Args:
+            suggestion: The EditSuggestion to reject, typically from suggest_edits()
+        """
+        # Track the rejections
+        for edit_block in suggestion.blocks:
+            self.edit_history.append(
+                EditAction(
+                    block_idx=self._get_block_idx(edit_block),
+                    old_content=self._get_block_content(edit_block),
+                    new_content=None,
+                    action="rejected",
+                    timestamp=datetime.now(),
+                )
+            )
+
+    def reject_edit(self, suggestion: EditSuggestion) -> None:
+        """Synchronous wrapper for rejecting an edit."""
+        return self._run_sync(self.areject_edit(suggestion))
+
+    def _get_edit_summary_after_message(
+        self, message_timestamp: datetime
+    ) -> Optional[str]:
+        """Get a summary of edits that occurred after a specific message."""
+        relevant_edits = [
+            edit for edit in self.edit_history if edit.timestamp > message_timestamp
+        ]
+
+        if not relevant_edits:
+            return None
+
+        approved = [edit for edit in relevant_edits if edit.action == "approved"]
+        rejected = [edit for edit in relevant_edits if edit.action == "rejected"]
+
+        summary = []
+
+        if approved:
+            summary.append("Approved edits:")
+            for edit in approved:
+                summary.append(
+                    f'Block {edit.block_idx}: "{edit.old_content}" -> "{edit.new_content}"'
+                )
+
+        if rejected:
+            if approved:  # Add spacing if we had approved edits
+                summary.append("")
+            summary.append("Rejected edits:")
+            for edit in rejected:
+                summary.append(f'Block {edit.block_idx}: "{edit.old_content}"')
+
+        return "\n".join(summary)
+
+    async def aget_events(
+        self, last_sequence: Optional[int] = None
+    ) -> List[ReportEventItemEventData_Progress]:
+        """Get all events for this report asynchronously.
+
+        Args:
+            last_sequence: If provided, only get events after this sequence number
+
+        Returns:
+            List of ReportEvent objects
+        """
+        extra_params = []
+        if last_sequence is not None:
+            extra_params.append(f"last_sequence={last_sequence}")
+
+        url = await self._build_url(
+            f"/api/v1/reports/{self.report_id}/events", extra_params
+        )
+
+        response = await self.aclient.get(url, headers=self._headers)
+        response.raise_for_status()
+        progress_events = []
+        for event in response.json():
+            if event["event_type"] == "progress":
+                progress_events.append(
+                    ReportEventItemEventData_Progress(**event["event_data"])
+                )
+
+        return progress_events
+
+    def get_events(
+        self, last_sequence: Optional[int] = None
+    ) -> List[ReportEventItemEventData_Progress]:
+        """Synchronous wrapper for getting report events."""
+        return self._run_sync(self.aget_events(last_sequence))

llama_parse/README.md

@@ -0,0 +1,165 @@
+# 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)
+[![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).
+
+It is really good at the following:
+
+- ✅ **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.
+
+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).
+
+## 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`.
+
+```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
+```
+
+You can also create simple scripts:
+
+```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
+)
+
+# 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"])
+```
+
+## Using with file object
+
+You can parse a file object directly:
+
+```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
+)
+
+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,
+)
+
+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/)
+
+## Terms of Service
+
+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).

llama_parse/__init__.py

@@ -1,3 +0,0 @@
-from llama_parse.base import LlamaParse, ResultType
-
-__all__ = ["LlamaParse", "ResultType"]

llama_parse/base.py

@@ -1,551 +0,0 @@
-import os
-import asyncio
-from io import TextIOWrapper
-
-import httpx
-import mimetypes
-import time
-from pathlib import Path, PurePath, PurePosixPath
-from typing import AsyncGenerator, Any, Dict, List, Optional, Union
-from contextlib import asynccontextmanager
-from io import BufferedIOBase
-
-from fsspec import AbstractFileSystem
-from fsspec.spec import AbstractBufferedFile
-from llama_index.core.async_utils import run_jobs
-from llama_index.core.bridge.pydantic import Field, field_validator
-from llama_index.core.constants import DEFAULT_BASE_URL
-from llama_index.core.readers.base import BasePydanticReader
-from llama_index.core.readers.file.base import get_default_fs
-from llama_index.core.schema import Document
-from llama_parse.utils import (
-    nest_asyncio_err,
-    nest_asyncio_msg,
-    ResultType,
-    Language,
-    SUPPORTED_FILE_TYPES,
-)
-from copy import deepcopy
-
-# can put in a path to the file or the file bytes itself
-# if passing as bytes or a buffer, must provide the file_name in extra_info
-FileInput = Union[str, bytes, BufferedIOBase]
-
-_DEFAULT_SEPARATOR = "\n---\n"
-
-
-class LlamaParse(BasePydanticReader):
-    """A smart-parser for files."""
-
-    api_key: str = Field(
-        default="",
-        description="The API key for the LlamaParse API.",
-        validate_default=True,
-    )
-    base_url: str = Field(
-        default=DEFAULT_BASE_URL,
-        description="The base URL of the Llama Parsing API.",
-    )
-    result_type: ResultType = Field(
-        default=ResultType.TXT, description="The result type for the parser."
-    )
-    num_workers: int = Field(
-        default=4,
-        gt=0,
-        lt=10,
-        description="The number of workers to use sending API requests for parsing.",
-    )
-    check_interval: int = Field(
-        default=1,
-        description="The interval in seconds to check if the parsing is done.",
-    )
-    max_timeout: int = Field(
-        default=2000,
-        description="The maximum timeout in seconds to wait for the parsing to finish.",
-    )
-    verbose: bool = Field(
-        default=True, description="Whether to print the progress of the parsing."
-    )
-    show_progress: bool = Field(
-        default=True, description="Show progress when parsing multiple files."
-    )
-    language: Language = Field(
-        default=Language.ENGLISH, description="The language of the text to parse."
-    )
-    parsing_instruction: Optional[str] = Field(
-        default="", description="The parsing instruction for the parser."
-    )
-    skip_diagonal_text: Optional[bool] = Field(
-        default=False,
-        description="If set to true, the parser will ignore diagonal text (when the text rotation in degrees modulo 90 is not 0).",
-    )
-    invalidate_cache: Optional[bool] = Field(
-        default=False,
-        description="If set to true, the cache will be ignored and the document re-processes. All document are kept in cache for 48hours after the job was completed to avoid processing the same document twice.",
-    )
-    do_not_cache: Optional[bool] = Field(
-        default=False,
-        description="If set to true, the document will not be cached. This mean that you will be re-charged it you reprocess them as they will not be cached.",
-    )
-    fast_mode: Optional[bool] = Field(
-        default=False,
-        description="Note: Non compatible with gpt-4o. If set to true, the parser will use a faster mode to extract text from documents. This mode will skip OCR of images, and table/heading reconstruction.",
-    )
-    do_not_unroll_columns: Optional[bool] = Field(
-        default=False,
-        description="If set to true, the parser will keep column in the text according to document layout. Reduce reconstruction accuracy, and LLM's/embedings performances in most case.",
-    )
-    page_separator: Optional[str] = Field(
-        default=None,
-        description="A templated  page separator to use to split the text.  If it contain `{page_number}`,it will be replaced by the next page number. If not set will the default separator '\\n---\\n' will be used.",
-    )
-    page_prefix: Optional[str] = Field(
-        default=None,
-        description="A templated prefix to add to the beginning of each page. If it contain `{page_number}`, it will be replaced by the page number.",
-    )
-    page_suffix: Optional[str] = Field(
-        default=None,
-        description="A templated suffix to add to the beginning of each page. If it contain `{page_number}`, it will be replaced by the page number.",
-    )
-    gpt4o_mode: bool = Field(
-        default=False,
-        description="Whether to use gpt-4o extract text from documents.",
-    )
-    gpt4o_api_key: Optional[str] = Field(
-        default=None,
-        description="The API key for the GPT-4o API. Lowers the cost of parsing.",
-    )
-    bounding_box: Optional[str] = Field(
-        default=None,
-        description="The bounding box to use to extract text from documents describe as a string containing the bounding box margins",
-    )
-    target_pages: Optional[str] = Field(
-        default=None,
-        description="The target pages to extract text from documents. Describe as a comma separated list of page numbers. The first page of the document is page 0",
-    )
-    ignore_errors: bool = Field(
-        default=True,
-        description="Whether or not to ignore and skip errors raised during parsing.",
-    )
-    split_by_page: bool = Field(
-        default=True,
-        description="Whether to split by page using the page separator",
-    )
-    vendor_multimodal_api_key: Optional[str] = Field(
-        default=None,
-        description="The API key for the multimodal API.",
-    )
-    use_vendor_multimodal_model: bool = Field(
-        default=False,
-        description="Whether to use the vendor multimodal API.",
-    )
-    vendor_multimodal_model_name: Optional[str] = Field(
-        default=None,
-        description="The model name for the vendor multimodal API.",
-    )
-    take_screenshot: bool = Field(
-        default=False,
-        description="Whether to take screenshot of each page of the document.",
-    )
-    custom_client: Optional[httpx.AsyncClient] = Field(
-        default=None, description="A custom HTTPX client to use for sending requests."
-    )
-
-    @field_validator("api_key", mode="before", check_fields=True)
-    @classmethod
-    def validate_api_key(cls, v: str) -> str:
-        """Validate the API key."""
-        if not v:
-            import os
-
-            api_key = os.getenv("LLAMA_CLOUD_API_KEY", None)
-            if api_key is None:
-                raise ValueError("The API key is required.")
-            return api_key
-
-        return v
-
-    @field_validator("base_url", mode="before", check_fields=True)
-    @classmethod
-    def validate_base_url(cls, v: str) -> str:
-        """Validate the base URL."""
-        url = os.getenv("LLAMA_CLOUD_BASE_URL", None)
-        return url or v or DEFAULT_BASE_URL
-
-    @asynccontextmanager
-    async def client_context(self) -> AsyncGenerator[httpx.AsyncClient, None]:
-        """Create a context for the HTTPX client."""
-        if self.custom_client is not None:
-            yield self.custom_client
-        else:
-            async with httpx.AsyncClient(timeout=self.max_timeout) as client:
-                yield client
-
-    # upload a document and get back a job_id
-    async def _create_job(
-        self,
-        file_input: FileInput,
-        extra_info: Optional[dict] = None,
-        fs: Optional[AbstractFileSystem] = None,
-    ) -> str:
-        headers = {"Authorization": f"Bearer {self.api_key}"}
-        url = f"{self.base_url}/api/parsing/upload"
-        files = None
-        file_handle = None
-
-        if isinstance(file_input, (bytes, BufferedIOBase)):
-            if not extra_info or "file_name" not in extra_info:
-                raise ValueError(
-                    "file_name must be provided in extra_info when passing bytes"
-                )
-            file_name = extra_info["file_name"]
-            mime_type = mimetypes.guess_type(file_name)[0]
-            files = {"file": (file_name, file_input, mime_type)}
-        elif isinstance(file_input, (str, Path, PurePosixPath, PurePath)):
-            file_path = str(file_input)
-            file_ext = os.path.splitext(file_path)[1].lower()
-            if file_ext not in SUPPORTED_FILE_TYPES:
-                raise Exception(
-                    f"Currently, only the following file types are supported: {SUPPORTED_FILE_TYPES}\n"
-                    f"Current file type: {file_ext}"
-                )
-            mime_type = mimetypes.guess_type(file_path)[0]
-            # Open the file here for the duration of the async context
-            # load data, set the mime type
-            fs = fs or get_default_fs()
-            file_handle = fs.open(file_input, "rb")
-            files = {"file": (os.path.basename(file_path), file_handle, mime_type)}
-        else:
-            raise ValueError(
-                "file_input must be either a file path string, file bytes, or buffer object"
-            )
-
-        data = {
-            "language": self.language.value,
-            "parsing_instruction": self.parsing_instruction,
-            "invalidate_cache": self.invalidate_cache,
-            "skip_diagonal_text": self.skip_diagonal_text,
-            "do_not_cache": self.do_not_cache,
-            "fast_mode": self.fast_mode,
-            "do_not_unroll_columns": self.do_not_unroll_columns,
-            "gpt4o_mode": self.gpt4o_mode,
-            "gpt4o_api_key": self.gpt4o_api_key,
-            "vendor_multimodal_api_key": self.vendor_multimodal_api_key,
-            "use_vendor_multimodal_model": self.use_vendor_multimodal_model,
-            "vendor_multimodal_model_name": self.vendor_multimodal_model_name,
-            "take_screenshot": self.take_screenshot,
-        }
-
-        # only send page separator to server if it is not None
-        # as if a null, "" string is sent the server will then ignore the page separator instead of using the default
-        if self.page_separator is not None:
-            data["page_separator"] = self.page_separator
-
-        if self.page_prefix is not None:
-            data["page_prefix"] = self.page_prefix
-
-        if self.page_suffix is not None:
-            data["page_suffix"] = self.page_suffix
-
-        if self.bounding_box is not None:
-            data["bounding_box"] = self.bounding_box
-
-        if self.target_pages is not None:
-            data["target_pages"] = self.target_pages
-
-        try:
-            async with self.client_context() as client:
-                response = await client.post(
-                    url,
-                    files=files,
-                    headers=headers,
-                    data=data,
-                )
-                if not response.is_success:
-                    raise Exception(f"Failed to parse the file: {response.text}")
-                job_id = response.json()["id"]
-                return job_id
-        finally:
-            if file_handle is not None:
-                file_handle.close()
-
-    @staticmethod
-    def __get_filename(f: Union[TextIOWrapper, AbstractBufferedFile]) -> str:
-        if isinstance(f, TextIOWrapper):
-            return f.name
-        return f.full_name
-
-    async def _get_job_result(
-        self, job_id: str, result_type: str, verbose: bool = False
-    ) -> Dict[str, Any]:
-        result_url = f"{self.base_url}/api/parsing/job/{job_id}/result/{result_type}"
-        status_url = f"{self.base_url}/api/parsing/job/{job_id}"
-        headers = {"Authorization": f"Bearer {self.api_key}"}
-
-        start = time.time()
-        tries = 0
-        while True:
-            await asyncio.sleep(self.check_interval)
-            async with self.client_context() as client:
-                tries += 1
-
-                result = await client.get(status_url, headers=headers)
-
-                if result.status_code != 200:
-                    end = time.time()
-                    if end - start > self.max_timeout:
-                        raise Exception(f"Timeout while parsing the file: {job_id}")
-                    if verbose and tries % 10 == 0:
-                        print(".", end="", flush=True)
-
-                    await asyncio.sleep(self.check_interval)
-
-                    continue
-
-                # Allowed values "PENDING", "SUCCESS", "ERROR", "CANCELED"
-                status = result.json()["status"]
-                if status == "SUCCESS":
-                    parsed_result = await client.get(result_url, headers=headers)
-                    return parsed_result.json()
-                elif status == "PENDING":
-                    end = time.time()
-                    if end - start > self.max_timeout:
-                        raise Exception(f"Timeout while parsing the file: {job_id}")
-                    if verbose and tries % 10 == 0:
-                        print(".", end="", flush=True)
-
-                    await asyncio.sleep(self.check_interval)
-
-    async def _aload_data(
-        self,
-        file_path: FileInput,
-        extra_info: Optional[dict] = None,
-        fs: Optional[AbstractFileSystem] = None,
-        verbose: bool = False,
-    ) -> List[Document]:
-        """Load data from the input path."""
-        try:
-            job_id = await self._create_job(file_path, extra_info=extra_info, fs=fs)
-            if verbose:
-                print("Started parsing the file under job_id %s" % job_id)
-
-            result = await self._get_job_result(
-                job_id, self.result_type.value, verbose=verbose
-            )
-
-            docs = [
-                Document(
-                    text=result[self.result_type.value],
-                    metadata=extra_info or {},
-                )
-            ]
-            if self.split_by_page:
-                return self._get_sub_docs(docs)
-            else:
-                return docs
-
-        except Exception as e:
-            file_repr = file_path if isinstance(file_path, str) else "<bytes/buffer>"
-            print(f"Error while parsing the file '{file_repr}':", e)
-            if self.ignore_errors:
-                return []
-            else:
-                raise e
-
-    async def aload_data(
-        self,
-        file_path: Union[List[FileInput], FileInput],
-        extra_info: Optional[dict] = None,
-        fs: Optional[AbstractFileSystem] = None,
-    ) -> List[Document]:
-        """Load data from the input path."""
-        if isinstance(file_path, (str, Path, bytes, BufferedIOBase)):
-            return await self._aload_data(
-                file_path, extra_info=extra_info, fs=fs, verbose=self.verbose
-            )
-        elif isinstance(file_path, list):
-            jobs = [
-                self._aload_data(
-                    f,
-                    extra_info=extra_info,
-                    fs=fs,
-                    verbose=self.verbose and not self.show_progress,
-                )
-                for f in file_path
-            ]
-            try:
-                results = await run_jobs(
-                    jobs,
-                    workers=self.num_workers,
-                    desc="Parsing files",
-                    show_progress=self.show_progress,
-                )
-
-                # return flattened results
-                return [item for sublist in results for item in sublist]
-            except RuntimeError as e:
-                if nest_asyncio_err in str(e):
-                    raise RuntimeError(nest_asyncio_msg)
-                else:
-                    raise e
-        else:
-            raise ValueError(
-                "The input file_path must be a string or a list of strings."
-            )
-
-    def load_data(
-        self,
-        file_path: Union[List[FileInput], FileInput],
-        extra_info: Optional[dict] = None,
-        fs: Optional[AbstractFileSystem] = None,
-    ) -> List[Document]:
-        """Load data from the input path."""
-        try:
-            return asyncio.run(self.aload_data(file_path, extra_info, fs=fs))
-        except RuntimeError as e:
-            if nest_asyncio_err in str(e):
-                raise RuntimeError(nest_asyncio_msg)
-            else:
-                raise e
-
-    async def _aget_json(
-        self, file_path: FileInput, extra_info: Optional[dict] = None
-    ) -> List[dict]:
-        """Load data from the input path."""
-        try:
-            job_id = await self._create_job(file_path, extra_info=extra_info)
-            if self.verbose:
-                print("Started parsing the file under job_id %s" % job_id)
-
-            result = await self._get_job_result(job_id, "json")
-            result["job_id"] = job_id
-            result["file_path"] = file_path
-            return [result]
-
-        except Exception as e:
-            file_repr = file_path if isinstance(file_path, str) else "<bytes/buffer>"
-            print(f"Error while parsing the file '{file_repr}':", e)
-            if self.ignore_errors:
-                return []
-            else:
-                raise e
-
-    async def aget_json(
-        self,
-        file_path: Union[List[FileInput], FileInput],
-        extra_info: Optional[dict] = None,
-    ) -> List[dict]:
-        """Load data from the input path."""
-        if isinstance(file_path, (str, Path)):
-            return await self._aget_json(file_path, extra_info=extra_info)
-        elif isinstance(file_path, list):
-            jobs = [self._aget_json(f, extra_info=extra_info) for f in file_path]
-            try:
-                results = await run_jobs(
-                    jobs,
-                    workers=self.num_workers,
-                    desc="Parsing files",
-                    show_progress=self.show_progress,
-                )
-
-                # return flattened results
-                return [item for sublist in results for item in sublist]
-            except RuntimeError as e:
-                if nest_asyncio_err in str(e):
-                    raise RuntimeError(nest_asyncio_msg)
-                else:
-                    raise e
-        else:
-            raise ValueError(
-                "The input file_path must be a string or a list of strings."
-            )
-
-    def get_json_result(
-        self,
-        file_path: Union[List[FileInput], FileInput],
-        extra_info: Optional[dict] = None,
-    ) -> List[dict]:
-        """Parse the input path."""
-        try:
-            return asyncio.run(self.aget_json(file_path, extra_info))
-        except RuntimeError as e:
-            if nest_asyncio_err in str(e):
-                raise RuntimeError(nest_asyncio_msg)
-            else:
-                raise e
-
-    async def aget_images(
-        self, json_result: List[dict], download_path: str
-    ) -> List[dict]:
-        """Download images from the parsed result."""
-        headers = {"Authorization": f"Bearer {self.api_key}"}
-
-        # make the download path
-        if not os.path.exists(download_path):
-            os.makedirs(download_path)
-
-        try:
-            images = []
-            for result in json_result:
-                job_id = result["job_id"]
-                for page in result["pages"]:
-                    if self.verbose:
-                        print(f"> Image for page {page['page']}: {page['images']}")
-                    for image in page["images"]:
-                        image_name = image["name"]
-
-                        # get the full path
-                        image_path = os.path.join(
-                            download_path, f"{job_id}-{image_name}"
-                        )
-
-                        # get a valid image path
-                        if not image_path.endswith(".png"):
-                            if not image_path.endswith(".jpg"):
-                                image_path += ".png"
-
-                        image["path"] = image_path
-                        image["job_id"] = job_id
-                        image["original_pdf_path"] = result["file_path"]
-                        image["page_number"] = page["page"]
-                        with open(image_path, "wb") as f:
-                            image_url = f"{self.base_url}/api/parsing/job/{job_id}/result/image/{image_name}"
-                            async with self.client_context() as client:
-                                res = await client.get(
-                                    image_url, headers=headers, timeout=self.max_timeout
-                                )
-                                res.raise_for_status()
-                                f.write(res.content)
-                        images.append(image)
-            return images
-        except Exception as e:
-            print("Error while downloading images from the parsed result:", e)
-            if self.ignore_errors:
-                return []
-            else:
-                raise e
-
-    def get_images(self, json_result: List[dict], download_path: str) -> List[dict]:
-        """Download images from the parsed result."""
-        try:
-            return asyncio.run(self.aget_images(json_result, download_path))
-        except RuntimeError as e:
-            if nest_asyncio_err in str(e):
-                raise RuntimeError(nest_asyncio_msg)
-            else:
-                raise e
-
-    def _get_sub_docs(self, docs: List[Document]) -> List[Document]:
-        """Split docs into pages, by separator."""
-        sub_docs = []
-        separator = self.page_separator or _DEFAULT_SEPARATOR
-        for doc in docs:
-            doc_chunks = doc.text.split(separator)
-            for doc_chunk in doc_chunks:
-                sub_doc = Document(
-                    text=doc_chunk,
-                    metadata=deepcopy(doc.metadata),
-                )
-                sub_docs.append(sub_doc)
-
-        return sub_docs

llama_parse/llama_parse/__init__.py

@@ -0,0 +1,3 @@
+from llama_cloud_services.parse import LlamaParse, ResultType
+
+__all__ = ["LlamaParse", "ResultType"]

llama_parse/llama_parse/base.py

@@ -0,0 +1,19 @@
+from llama_cloud_services.parse.base import (
+    LlamaParse,
+    ResultType,
+    FileInput,
+    _DEFAULT_SEPARATOR,
+    JOB_RESULT_URL,
+    JOB_STATUS_ROUTE,
+    JOB_UPLOAD_ROUTE,
+)
+
+__all__ = [
+    "LlamaParse",
+    "ResultType",
+    "FileInput",
+    "_DEFAULT_SEPARATOR",
+    "JOB_RESULT_URL",
+    "JOB_STATUS_ROUTE",
+    "JOB_UPLOAD_ROUTE",
+]

llama_parse/llama_parse/cli/main.py

@@ -0,0 +1,4 @@
+from llama_cloud_services.parse.cli.main import parse
+
+if __name__ == "__main__":
+    parse()

llama_parse/llama_parse/utils.py

@@ -0,0 +1,11 @@
+from llama_cloud_services.parse.utils import (
+    SUPPORTED_FILE_TYPES,
+    Language,
+    ResultType,
+)
+
+__all__ = [
+    "SUPPORTED_FILE_TYPES",
+    "Language",
+    "ResultType",
+]

llama_parse/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "llama-parse"
+version = "0.6.0"
+description = "Parse files into RAG-Optimized formats."
+authors = ["Logan Markewich <logan@llamaindex.ai>"]
+license = "MIT"
+readme = "README.md"
+packages = [{include = "llama_parse"}]
+
+[tool.poetry.dependencies]
+python = ">=3.9,<4.0"
+llama-cloud-services = "*"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.0.0"
+pytest-asyncio = "*"
+ipykernel = "^6.29.0"
+
+[tool.poetry.scripts]
+llama-parse = "llama_parse.cli.main:parse"