Skip to main content

PDF to markdown using Azure OpenAI batch processing

Project description

Parallex

What it does

  • Converts PDF into images
  • Makes requests to Azure OpenAI to convert the images to markdown using Batch API
  • Polls for batch completion and then converts AI responses in structured output based on the page of the corresponding PDF
  • Post batch processing to do what you wish with the resulting markdown

Requirements

Parallex uses graphicsmagick for the conversion of PDF to images.

brew install graphicsmagick

Installation

pip install parallex

Example usage

import os
from parallex.models.parallex_callable_output import ParallexCallableOutput
from parallex.parallex import parallex

os.environ["AZURE_API_KEY"] = "key"
os.environ["AZURE_API_BASE"] = "your-endpoint.com"
os.environ["AZURE_API_VERSION"] = "deployment_version"
os.environ["AZURE_API_DEPLOYMENT"] = "deployment_name"

model = "gpt-4o"

async def some_operation(file_url: str) -> None:
  response_data: ParallexCallableOutput = await parallex(
    model=model,
    pdf_source_url=file_url,
    post_process_callable=example_post_process, # Optional
    concurrency=2, # Optional
    prompt_text="Turn images into markdown", # Optional
    log_level="ERROR" # Optional
  )
  pages = response_data.pages

def example_post_process(output: ParallexCallableOutput) -> None:
    file_name = output.file_name
    pages = output.pages
    for page in pages:
        markdown_for_page = page.output_content
        pdf_page_number = page.page_number
        

Responses have the following structure;

class ParallexCallableOutput(BaseModel):
    file_name: str = Field(description="Name of file that is processed")
    pdf_source_url: str = Field(description="Given URL of the source of output")
    trace_id: UUID = Field(description="Unique trace for each file")
    pages: list[PageResponse] = Field(description="List of PageResponse objects")

class PageResponse(BaseModel):
    output_content: str = Field(description="Markdown generated for the page")
    page_number: int = Field(description="Page number of the associated PDF")

Default prompt is

"""
    Convert the following PDF page to markdown.
    Return only the markdown with no explanation text.
    Leave out any page numbers and redundant headers or footers.
    Do not include any code blocks (e.g. "```markdown" or "```") in the response.
    If unable to parse, return an empty string.
"""

Batch processing for list of prompts

If you do not need to process images, but just want to process prompts using the Batch API, you can call;

response_data: ParallexPromptsCallableOutput = await parallex_simple_prompts(
    model=model,
    prompts=["Some prompt", "Some other prompt"],
    post_process_callable=example_post_process
)
responses = response_data.responses

This will create a batch that includes all the prompts in prompts and responses can be tied back to the prompt by index.

Responses have the following structure;

class ParallexPromptsCallableOutput(BaseModel):
    original_prompts: list[str] = Field(description="List of given prompts")
    trace_id: UUID = Field(description="Unique trace for each file")
    responses: list[PromptResponse] = Field(description="List of PromptResponse objects")

class PromptResponse(BaseModel):
    output_content: str = Field(description="Response from the model")
    prompt_index: int = Field(description="Index corresponding to the given prompts")

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

parallex-0.3.3.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

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

parallex-0.3.3-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file parallex-0.3.3.tar.gz.

File metadata

  • Download URL: parallex-0.3.3.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.6 Darwin/21.6.0

File hashes

Hashes for parallex-0.3.3.tar.gz
Algorithm Hash digest
SHA256 306071db995565efc6eefe749162a81092fb023d293af19f59221fac1203d98f
MD5 60d8907c9d782d76f60a411acb6b96a3
BLAKE2b-256 bb7c4c1d0170d8ca3f97d0a96172345c55609c0317b0c4d989fd7f6240c4b7f1

See more details on using hashes here.

File details

Details for the file parallex-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: parallex-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.6 Darwin/21.6.0

File hashes

Hashes for parallex-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5ec59a0a2666510a9a1d128b3ce5bfba7c08dc76127ca2625385ca2ec2212f66
MD5 35d01516787cef84a71f37cf9d1cd491
BLAKE2b-256 6e5018caf2f728d12e8c5ab490dcc9d6b75414b01fe92396c7a3d6f340af3c7c

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