spiderpan/doc-gpt

用于文档GPT的PHP库

维护者

详细信息

github.com/spiderPan/docGPT

源代码

问题

安装: 127

依赖: 0

建议者: 0

安全: 0

星级: 0

关注者: 2

分支: 0

开放问题: 1

v0.5.0 2024-07-12 13:49 UTC

Requires

Requires (Dev)

MIT 177aae01da2446000b79f39fbe288dc36b4b118b

  • Banglanfeng Pan <panbanglanfeng.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-23 14:54:53 UTC

README

DocGPT项目是一个基于PHP的应用程序，旨在使用向量数据库和OpenAI API索引和检索文档中的信息。该项目允许用户上传文档，将内容转换为向量嵌入，并将这些嵌入存储在向量数据库中。用户可以提出问题，系统将检索和解释索引内容，使用高级语言模型提供相关答案。

主要特性

  • 文档索引：从各种文档格式（PDF、DOCX、TXT）中提取文本，并将其转换为向量嵌入。
  • 向量存储：将向量嵌入存储在向量数据库中，以便高效检索。
  • 问答：使用OpenAI API查找最相关的文档，并根据索引内容生成准确的答案。

技术栈

  • PHP：后端脚本语言，用于处理文件上传、API交互和数据库操作。
  • OpenAI API：使用高级语言模型生成嵌入和回答问题。
  • pgvector：一个PostgreSQL扩展，可启用高效存储和检索向量嵌入。

安装

要安装DocGPT库，您需要在系统上安装Composer。如果您尚未安装Composer，可以从此处下载。

安装Composer后，您可以通过在终端运行以下命令来安装DocGPT库：

composer require spiderpan/doc-gpt

使用方法

有关示例，请参阅example.php。

开发

  1. 克隆仓库
  2. 运行./dev start以启动Docker容器

常见CLI命令

  • ./dev reset - 重建容器
  • ./dev stop - 停止应用
  • ./dev test - 使用PHPUnit运行单元测试
  • ./dev test path/to/Test.php - 运行特定的测试文件
  • ./dev shell - 在容器中打开shell
  • ./dev lint - 运行PHP CS Fixer