首页
/ AutoSurveyGPT 使用指南

AutoSurveyGPT 使用指南

2024-09-12 18:42:01作者:凤尚柏Louis

1. 项目目录结构及介绍

AutoSurveyGPT 是一个利用GPT-3.5 Turbo或GPT-4智能分析学术文献的开源工具,旨在自动化文献调研过程。下面是该仓库的主要目录结构及各部分功能简介:

  • main.py - 核心脚本,负责执行整个文献搜索、分析流程。
  • config.py - 配置文件,用于存放OpenAI API密钥等重要设置。
  • gpt_config.py - 控制GPT模型调用的相关配置,如选择GPT-3.5 Turbo还是GPT-4。
  • scholar_parser.py - 解析Google Scholar搜索结果的模块。
  • pdf_finder.py, pdf_processor.py - 用于查找和处理PDF文档的部分(开发中)。
  • query_generator.py, query_processor.py - 生成和处理查询请求的脚本。
  • output, input, logs - 存放输入数据、输出报告和日志的文件夹。
  • requirements.txt - Python依赖列表,确保环境兼容性。
  • LICENSE, README.md - 许可证信息和项目说明。

2. 项目启动文件介绍

主要启动文件: main.py

  • 运行此脚本之前,你需要准备好一个JSON格式的输入文件,它包含了搜索查询、相关主题描述以及其他配置选项。
  • 通过命令行运行时提供这个JSON文件的路径,如:python main.py -i path/to/your/input.json
  • 此脚本会基于用户的配置进行Google Scholar搜索,使用GPT进行论文的相关性和重要性评估,并生成报告。

3. 项目的配置文件介绍

配置文件: config.py, gpt_config.py

  • config.py 中需设置你的OpenAI API密钥 (openai_api_key),这是使用GPT服务的前提条件。

    openai_api_key = "your_openai_api_key"
    
  • gpt_config.py 决定了GPT模型的选择,默认使用GPT-3.5 Turbo,如果你想使用成本更高但更强大的GPT-4,你需要在这里更改调用的模型名称。

    model_engine = "gpt-3.5-turbo"  # 若要使用GPT-4,改为 "gpt-4"
    

为了正确使用AutoSurveyGPT,确保你已经安装了所有必要的Python库,并且理解如何构建你的搜索查询和配置文件以引导系统找到相关的学术文献。在实际操作过程中,遵循提供的步骤和示例输入文件格式是关键。

登录后查看全文
热门项目推荐