doctran

doctran

基于LLM的智能文档转换和处理框架

Doctran是一个基于大型语言模型的文档转换框架,通过自然语言指令处理复杂字符串。该框架提供模块化和声明式的方法,充分利用OpenAI的功能调用特性。Doctran支持提取、编辑、总结、精炼、翻译和问答生成等多种操作,简化了非结构化文本的处理过程。这个开源项目主要应用于需要高级判断的文档解析场景,例如交易标记和语义信息提取。

Doctran文档转换LLM自然语言处理OpenAIGithub开源项目
<h2 align="center"> 🐛 Doctran </h2> <p align="center"> <p align="center"><b>文档</b>转换框架 - 使用大语言模型通过自然语言指令处理复杂字符串。</p> </p> <p align="center"> </a> <a href="https://github.com/psychic-api/doctran/blob/main/LICENSE" target="_blank"> <img src="https://img.shields.io/static/v1?label=license&message=MIT&color=blue" alt="许可证"> </a> <a href="https://github.com/psychic-api/doctran/issues" target="_blank"> <img src="https://img.shields.io/github/issues/psychic-api/doctran?color=blue" alt="问题"> </a> </p>

某些应用需要解析文档,其中人类级别的判断比速度更重要。例如标记交易或从文本中提取语义信息。在这些情况下,正则表达式可能过于不灵活,而大语言模型则是理想的选择。可以将Doctran视为一个由大语言模型驱动的黑盒,杂乱的字符串进入,整洁、干净、带标签的字符串输出。另一种理解方式是,它是OpenAI函数调用功能的模块化、声明式封装,显著改善了开发者体验。

Doctran由jasonwcfan轻度维护。

示例

克隆或下载examples.ipynb以获取交互式演示。

Doctran将杂乱、非结构化的文本

<doc type="Confidential Document - For Internal Use Only">
<metadata>
<date> &#x004A; &#x0075; &#x006C; &#x0079; &#x0020; &#x0031; , &#x0032; &#x0030; &#x0032; &#x0033; </date>
<subject> Updates and Discussions on Various Topics; </subject>
</metadata>
<body>
<p>Dear Team,</p>
<p>I hope this email finds you well. In this document, I would like to provide you with some important updates and discuss various topics that require our attention. Please treat the information contained herein as highly confidential.</p>
<section>
<header>Security and Privacy Measures</header>
<p>As part of our ongoing commitment to ensure the security and privacy of our customers' data, we have implemented robust measures across all our systems. We would like to commend John Doe (email: john.doe&#64;example.com) from the IT department for his diligent work in enhancing our network security. Moving forward, we kindly remind everyone to strictly adhere to our data protection policies and guidelines. Additionally, if you come across any potential security risks or incidents, please report them immediately to our dedicated team at security&#64;example.com.</p>
</section>
<section>
<header>HR Updates and Employee Benefits</header>
<p>Recently, we welcomed several new team members who have made significant contributions to their respective departments. I would like to recognize Jane Smith (SSN: &#x0030; &#x0034; &#x0039; - &#x0034; &#x0035; - &#x0035; &#x0039; &#x0032; &#x0038;) for her outstanding performance in customer service. Jane has consistently received positive feedback from our clients. Furthermore, please remember that the open enrollment period for our employee benefits program is fast approaching. Should you have any questions or require assistance, please contact our HR representative, Michael Johnson (phone: &#x0034; &#x0031; 
...

转换为针对向量搜索优化的半结构化文档。

{
  "topics": ["安全和隐私", "人力资源更新", "营销", "研发"],
  "summary": "该文档讨论了安全措施、人力资源、营销计划和研发项目的更新。表扬了John Doe增强网络安全的工作,欢迎新团队成员,并表彰了Jane Smith在客户服务方面的表现。还提到了员工福利计划的开放注册期,感谢Sarah Thompson在社交媒体方面的努力,并宣布7月15日的产品发布会。David Rodriguez在研发方面的贡献得到了认可。文档强调了保密的重要性。",
  "contact_info": [
    {
      "name": "John Doe",
      "contact_info": {
        "phone": "",
        "email": "john.doe@example.com"
      }
    },
    {
      "name": "Michael Johnson",
      "contact_info": {
        "phone": "418-492-3850",
        "email": "michael.johnson@example.com"
      }
    },
    {
      "name": "Sarah Thompson",
      "contact_info": {
        "phone": "415-555-1234",
        "email": ""
      }
    }
  ],
  "questions_and_answers": [
    {
      "question": "这份文档的目的是什么?",
      "answer": "这份文档的目的是提供重要更新并讨论需要团队关注的各种主题。"
    },
    {
      "question": "谁因增强公司网络安全而受到表扬?",
      "answer": "IT部门的John Doe因增强公司网络安全而受到表扬。"
    }
  ]
}

开始使用

pip install doctran

from doctran import Doctran doctran = Doctran(openai_api_key=OPENAI_API_KEY) document = doctran.parse(content="你的内容字符串")

链式转换

Doctran旨在使文档转换的链式操作变得简单。例如,你可能希望先对文档中的所有个人身份信息进行编辑,然后再将其发送给OpenAI进行摘要。

链式转换中的顺序很重要——首先调用的转换将首先执行,其结果将传递给下一个转换。

document = await document.redact(entities=["EMAIL_ADDRESS", "PHONE_NUMBER"]).extract(properties).summarize().execute()

Doctran转换器

提取

给定任何有效的JSON模式,使用OpenAI函数调用从文档中提取结构化数据。

from doctran import ExtractProperty properties = ExtractProperty( name="millenial_or_boomer", description="预测这份文档是由千禧一代还是婴儿潮一代撰写的", type="string", enum=["millenial", "boomer"], required=True ) document = await document.extract(properties=properties).execute()

编辑

使用spaCy模型从文档中删除姓名、电子邮件、电话号码和其他敏感信息。在本地运行以避免将敏感数据发送到第三方API。

document = await document.redact(entities=["PERSON", "EMAIL_ADDRESS", "PHONE_NUMBER", "US_SSN"]).execute()

摘要

总结文档中的信息。可以传递token_limit来配置摘要的大小,但OpenAI可能不会严格遵守。

document = await document.summarize().execute()

精炼

从文档中删除所有信息,除非与特定主题集相关。

document = await document.refine(topics=['marketing', 'meetings']).execute()

翻译

将文本翻译成另一种语言

document = await document.translate(language="spanish").execute()

问答

将文档中的信息转换为问答格式。最终用户查询通常以问题的形式出现,因此将信息转换为问题并从这些问题创建索引,在使用向量数据库进行上下文检索时通常会产生更好的结果。

document = await document.interrogate().execute()

贡献

Doctran欢迎贡献!最好的开始方式是贡献一个新的文档转换器。不依赖API调用(例如OpenAI)的转换器特别有价值,因为它们可以快速运行且不需要任何外部依赖。

添加新的doctran转换器

贡献新的转换器很简单。

  1. 添加一个新的类,扩展DocumentTransformerOpenAIDocumentTransformer
  2. 实现__init__transform方法
  3. DocumentTransformationBuilderDocument类中添加相应的方法以启用链式操作

编辑推荐精选

扣子-AI办公

扣子-AI办公

职场AI,就用扣子

AI办公助手,复杂任务高效处理。办公效率低?扣子空间AI助手支持播客生成、PPT制作、网页开发及报告写作,覆盖科研、商业、舆情等领域的专家Agent 7x24小时响应,生活工作无缝切换,提升50%效率!

堆友

堆友

多风格AI绘画神器

堆友平台由阿里巴巴设计团队创建,作为一款AI驱动的设计工具,专为设计师提供一站式增长服务。功能覆盖海量3D素材、AI绘画、实时渲染以及专业抠图,显著提升设计品质和效率。平台不仅提供工具,还是一个促进创意交流和个人发展的空间,界面友好,适合所有级别的设计师和创意工作者。

图像生成AI工具AI反应堆AI工具箱AI绘画GOAI艺术字堆友相机AI图像热门
码上飞

码上飞

零代码AI应用开发平台

零代码AI应用开发平台,用户只需一句话简单描述需求,AI能自动生成小程序、APP或H5网页应用,无需编写代码。

Vora

Vora

免费创建高清无水印Sora视频

Vora是一个免费创建高清无水印Sora视频的AI工具

Refly.AI

Refly.AI

最适合小白的AI自动化工作流平台

无需编码,轻松生成可复用、可变现的AI自动化工作流

酷表ChatExcel

酷表ChatExcel

大模型驱动的Excel数据处理工具

基于大模型交互的表格处理系统,允许用户通过对话方式完成数据整理和可视化分析。系统采用机器学习算法解析用户指令,自动执行排序、公式计算和数据透视等操作,支持多种文件格式导入导出。数据处理响应速度保持在0.8秒以内,支持超过100万行数据的即时分析。

AI工具酷表ChatExcelAI智能客服AI营销产品使用教程
TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
AIWritePaper论文写作

AIWritePaper论文写作

AI论文写作指导平台

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

AI辅助写作AI工具AI论文工具论文写作智能生成大纲数据安全AI助手热门
博思AIPPT

博思AIPPT

AI一键生成PPT,就用博思AIPPT!

博思AIPPT,新一代的AI生成PPT平台,支持智能生成PPT、AI美化PPT、文本&链接生成PPT、导入Word/PDF/Markdown文档生成PPT等,内置海量精美PPT模板,涵盖商务、教育、科技等不同风格,同时针对每个页面提供多种版式,一键自适应切换,完美适配各种办公场景。

AI办公办公工具AI工具博思AIPPTAI生成PPT智能排版海量精品模板AI创作热门
潮际好麦

潮际好麦

AI赋能电商视觉革命,一站式智能商拍平台

潮际好麦深耕服装行业,是国内AI试衣效果最好的软件。使用先进AIGC能力为电商卖家批量提供优质的、低成本的商拍图。合作品牌有Shein、Lazada、安踏、百丽等65个国内外头部品牌,以及国内10万+淘宝、天猫、京东等主流平台的品牌商家,为卖家节省将近85%的出图成本,提升约3倍出图效率,让品牌能够快速上架。

下拉加载更多