Skip to content

Latest commit

 

History

History
144 lines (95 loc) · 4.79 KB

README_CN.md

File metadata and controls

144 lines (95 loc) · 4.79 KB

gptpdf

CN doc EN doc

使用视觉大语言模型(如 GPT-4o)将 PDF 解析为 markdown。

我们的方法非常简单(只有293行代码),但几乎可以完美地解析排版、数学公式、表格、图片、图表等。

每页平均价格:0.013 美元

我们使用 GeneralAgent lib 与 OpenAI API 交互。

pdfgpt-ui 是一个基于 gptpdf 的可视化工具。

处理流程

  1. 使用 PyMuPDF 库,对 PDF 进行解析出所有非文本区域,并做好标记,比如:

  1. 使用视觉大模型(如 GPT-4o)进行解析,得到 markdown 文件。

样例

有关 PDF,请参阅 examples/attention_is_all_you_need/output.md examples/attention_is_all_you_need.pdf

安装

pip install gptpdf

使用

本地安装使用

from gptpdf import parse_pdf

api_key = 'Your OpenAI API Key'
content, image_paths = parse_pdf(pdf_path, api_key=api_key)
print(content)

更多内容请见 test/test.py

Google Colab

详情见 examples/gptpdf_Quick_Tour.ipynb

API

parse_pdf

函数

def parse_pdf(
        pdf_path: str,
        output_dir: str = './',
        prompt: Optional[Dict] = None,
        api_key: Optional[str] = None,
        base_url: Optional[str] = None,
        model: str = 'gpt-4o',
        verbose: bool = False,
        gpt_worker: int = 1,
        **args
) -> Tuple[str, List[str]]:

将 PDF 文件解析为 Markdown 文件,并返回 Markdown 内容和所有图片路径列表。

参数

  • pdf_pathstr
    PDF 文件路径

  • output_dirstr,默认值:'./'
    输出目录,存储所有图片和 Markdown 文件

  • api_keyOptional[str],可选
    OpenAI API 密钥。如果未提供,则使用 OPENAI_API_KEY 环境变量。

  • base_urlOptional[str],可选
    OpenAI 基本 URL。如果未提供,则使用 OPENAI_BASE_URL 环境变量。可以通过修改该环境变量调用 OpenAI API 类接口的其他大模型服务,例如GLM-4V

  • modelstr,默认值:'gpt-4o'。OpenAI API 格式的多模态大模型。如果需要使用其他模型,例如

    • qwen-vl-max
    • GLM-4V
    • Yi-Vision
    • Azure OpenAI,通过将 base_url 指定为 https://xxxx.openai.azure.com/ 来使用 Azure OpenAI,api_key 是 Azure API 密钥,模型类似于 azure_xxxx,其中 xxxx 是部署的模型名称(已测试)。
  • verbosebool,默认值:False,详细模式,开启后会在命令行显示大模型解析的内容。

  • gpt_workerint,默认值:1
    GPT 解析工作线程数。如果您的机器性能较好,可以适当调高,以提高解析速度。

  • prompt: dict, 可选,如果您使用的模型与本仓库默认的提示词不匹配,无法发挥出最佳效果,我们支持自定义加入提示词。 仓库中,提示词分为三个部分,分别是:

    • prompt:主要用于指导模型如何处理和转换图片中的文本内容。
    • rect_prompt:用于处理图片中标注了特定区域(例如表格或图片)的情况。
    • role_prompt:定义了模型的角色,确保模型理解它在执行PDF文档解析任务。 您可以用字典的形式传入自定义的提示词,实现对任意提示词的替换,这是一个例子:
    prompt = {
        "prompt": "自定义提示词语",
        "rect_prompt": "自定义提示词",
        "role_prompt": "自定义提示词"
    }
    
    content, image_paths = parse_pdf(
        pdf_path=pdf_path,
        output_dir='./output',
        model="gpt-4o",
        prompt="",
        verbose=False,
    )

    您不需要替换所有的提示词,如果您没有传入自定义提示词,仓库会自动使用默认的提示词。默认提示词使用的是中文,如果您的PDF文档是英文的,或者您的模型不支持中文,建议您自定义提示词。

  • **args"": LLM 中其他参数,例如 temperaturemax_tokens, top_p, frequency_penalty, presence_penalty 等。

加入我们👏🏻

使用微信扫描下方二维码,加入微信群聊,或参与贡献。

wechat