Skip to main content

No project description provided

Project description

 ___      _______  __   __  _______  ___   ______  
|   |    |       ||  |_|  ||       ||   | |      | 
|   |    |    ___||       ||   _   ||   | |  _    |
|   |    |   |___ |       ||  | |  ||   | | | |   |
|   |___ |    ___| |     | |  |_|  ||   | | |_|   |
|       ||   |___ |   _   ||       ||   | |       |
|_______||_______||__| |__||_______||___| |______| 
                                                                                                    

Open In Colab GitHub license PyPI Docs

Lexoid is an efficient document parsing library that supports both LLM-based and non-LLM-based (static) PDF document parsing.

Documentation

Motivation:

  • Use the multi-modal advancement of LLMs
  • Enable convenience for users
  • Collaborate with a permissive license

Installation

Installing with pip

pip install lexoid

To use LLM-based parsing, define the following environment variables or create a .env file with the following definitions

OPENAI_API_KEY=""
GOOGLE_API_KEY=""

Optionally, to use Playwright for retrieving web content (instead of the requests library):

playwright install --with-deps --only-shell chromium

Building .whl from source

make build

Creating a local installation

To install dependencies:

make install

or, to install with dev-dependencies:

make dev

To activate virtual environment:

source .venv/bin/activate

Usage

Example Notebook

Example Colab Notebook

Here's a quick example to parse documents using Lexoid:

from lexoid.api import parse
from lexoid.api import ParserType

parsed_md = parse("https://www.justice.gov/eoir/immigration-law-advisor", parser_type="LLM_PARSE")["raw"]
# or
pdf_path = "path/to/immigration-law-advisor.pdf"
parsed_md = parse(pdf_path, parser_type="LLM_PARSE")["raw"]

print(parsed_md)

Parameters

  • path (str): The file path or URL.
  • parser_type (str, optional): The type of parser to use ("LLM_PARSE" or "STATIC_PARSE"). Defaults to "AUTO".
  • pages_per_split (int, optional): Number of pages per split for chunking. Defaults to 4.
  • max_threads (int, optional): Maximum number of threads for parallel processing. Defaults to 4.
  • **kwargs: Additional arguments for the parser.

Supported API Providers

  • Google
  • OpenAI
  • Hugging Face
  • Together AI
  • OpenRouter

Benchmark

Results aggregated across 5 iterations each for 5 documents.

Note: Benchmarks are currently done in the zero-shot setting.

Rank Model Mean Similarity Std. Dev. Time (s) Cost($)
1 gemini-2.0-flash 0.829 0.102 7.41 0.000480
2 gemini-2.0-flash-001 0.814 0.176 6.85 0.000421
3 gemini-1.5-flash 0.797 0.143 9.54 0.000238
4 gemini-2.0-pro-exp 0.764 0.227 11.95 TBA
5 gemini-2.0-flash-thinking-exp 0.746 0.266 10.46 TBA
6 gemini-1.5-pro 0.732 0.265 11.44 0.003332
7 gpt-4o 0.687 0.247 10.16 0.004736
8 gpt-4o-mini 0.642 0.213 9.71 0.000275
9 gemma-3-27b-it (via OpenRouter) 0.628 0.299 18.79 0.000096
10 gemini-1.5-flash-8b 0.551 0.223 3.91 0.000055
11 Llama-Vision-Free (via Together AI) 0.531 0.198 6.93 0
12 Llama-3.2-11B-Vision-Instruct-Turbo (via Together AI) 0.524 0.192 3.68 0.000060
13 qwen/qwen-2.5-vl-7b-instruct (via OpenRouter) 0.482 0.209 11.53 0.000052
14 Llama-3.2-90B-Vision-Instruct-Turbo (via Together AI) 0.461 0.306 19.26 0.000426
15 Llama-3.2-11B-Vision-Instruct (via Hugging Face) 0.451 0.257 4.54 0
16 microsoft/phi-4-multimodal-instruct (via OpenRouter) 0.366 0.287 10.80 0.000019

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lexoid-0.1.13.tar.gz (27.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lexoid-0.1.13-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

Details for the file lexoid-0.1.13.tar.gz.

File metadata

  • Download URL: lexoid-0.1.13.tar.gz
  • Upload date:
  • Size: 27.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.3 Linux/6.8.0-57-generic

File hashes

Hashes for lexoid-0.1.13.tar.gz
Algorithm Hash digest
SHA256 1f6d1906a5a5e9588298aad2210e468407255709ee74ac4ec4df45c5e13be59f
MD5 7ab75bc190f4d8e049fb692260f9c175
BLAKE2b-256 7eb9b424ce328befe7de6c43f1db97de32a41541720b92acc84da527904bb886

See more details on using hashes here.

File details

Details for the file lexoid-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: lexoid-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 28.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.3 Linux/6.8.0-57-generic

File hashes

Hashes for lexoid-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 88ae807399a6abdbd3a76a68d53e48344c80c291e639afeac392e0732339c68b
MD5 cbb9a8736287b34cf2a62493ad414d33
BLAKE2b-256 8521e32d092b90593f6f06d79035673f236e73dd0ac61abbc39f0fbb0d3aa222

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page