DocumentGPT 项目使用教程

DocumentGPT 项目使用教程

DocumentGPTDocumentGPT is a web application that allows you to chat over your research document using OpenAI's chat API and perform semantic search using vector databases. This tool provides a seamless interface for interacting with your research document, exploring search results, and engaging in a conversation with an AI chatbot.项目地址:https://gitcode.com/gh_mirrors/do/DocumentGPT

1. 项目的目录结构及介绍

DocumentGPT 项目的目录结构如下：

DocumentGPT/
├── LICENSE
├── README.md
├── app.py
├── requirements.txt
├── utils.py
├── streamlit/
│   ├── Conversation.py
│   ├── CustomTools.py
│   ├── FileReader.py
│   ├── Serp.py
│   ├── img/
│   └── pages/
├── static/
└── ...

目录结构介绍

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• app.py: 项目的主启动文件。
• requirements.txt: 项目依赖文件。
• utils.py: 项目工具函数文件。
• streamlit/: 包含项目的主要功能模块。
  • Conversation.py: 对话功能模块。
  • CustomTools.py: 自定义工具模块。
  • FileReader.py: 文件读取模块。
  • Serp.py: 搜索引擎模块。
  • img/: 图片资源文件夹。
  • pages/: 页面模块文件夹。
• static/: 静态资源文件夹。

2. 项目的启动文件介绍

项目的启动文件是 app.py。该文件是整个应用的入口点，负责初始化应用并启动服务器。

app.py 文件介绍

# app.py
import streamlit as st
from streamlit.components.v1 import html
from utils import load_document, chat_with_document, semantic_search

def main():
    st.title("DocumentGPT")
    uploaded_file = st.file_uploader("上传PDF文档", type="pdf")
    if uploaded_file is not None:
        document_content = load_document(uploaded_file)
        st.write("文档内容:")
        st.write(document_content)
        
        query = st.text_input("输入查询问题")
        if query:
            answer = chat_with_document(document_content, query)
            st.write("AI回答:")
            st.write(answer)
            
            search_results = semantic_search(document_content, query)
            st.write("语义搜索结果:")
            st.write(search_results)

if __name__ == "__main__":
    main()

功能介绍

• main(): 主函数，负责初始化页面并处理用户上传的PDF文档。
• load_document(): 加载文档内容。
• chat_with_document(): 与文档进行对话。
• semantic_search(): 进行语义搜索。

3. 项目的配置文件介绍

项目的配置文件主要是 requirements.txt，该文件列出了项目运行所需的所有依赖包及其版本。

requirements.txt 文件介绍

streamlit==1.0.0
openai==0.27.0
langchain==0.1.0
...

功能介绍

• streamlit: 用于构建Web应用的框架。
• openai: OpenAI的API库。
• langchain: 语言模型链库。

通过安装这些依赖包，可以确保项目在本地或服务器上正常运行。

---

以上是 DocumentGPT 项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。

DocumentGPTDocumentGPT is a web application that allows you to chat over your research document using OpenAI's chat API and perform semantic search using vector databases. This tool provides a seamless interface for interacting with your research document, exploring search results, and engaging in a conversation with an AI chatbot.项目地址:https://gitcode.com/gh_mirrors/do/DocumentGPT