Nonebot_plugin_naturel_gpt 使用教程

Nonebot_plugin_naturel_gpt 使用教程

nonebot_plugin_naturel_gpt 一个基于NoneBot框架的Ai聊天插件，对接OpenAi文本生成接口，实现了机器人的人格 自定义/切换，聊天记忆等功能 项目地址: https://gitcode.com/gh_mirrors/no/nonebot_plugin_naturel_gpt

1. 项目目录结构及介绍

nonebot_plugin_naturel_gpt/
├── .github/              # GitHub 工作流文件
│   ├── workflows/
│   │   └── static.yml
├── backups/              # 备份目录
├── docs/                 # 文档目录
├── extensions/           # 扩展目录
├── image/                # 图片处理目录
│   └── README
├── nonebot_plugin_naturel_gpt/ # 插件主目录
│   ├── .gitignore
│   ├── LICENSE
│   ├── README.md
│   ├── memory_draft.md
│   ├── poetry.lock
│   ├── pyproject.toml
│   └── ...
└── ...

• .github/: 存放 GitHub Actions 工作流文件，用于自动化处理例如代码审查、构建等流程。
• backups/: 用于存放备份文件。
• docs/: 存放项目文档。
• extensions/: 存放项目扩展模块。
• image/: 与图片处理相关的文件和目录。
• nonebot_plugin_naturel_gpt/: 插件主目录，包含项目的核心代码和配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 pyproject.toml 文件来配置和管理。以下是 pyproject.toml 文件的一个基本示例：

[tool.poetry]
name = "nonebot_plugin_naturel_gpt"
version = "0.1.0"
description = "A Naturel GPT plugin for Nonebot2"
authors = ["KroMiose"]

[tool.poetry.dependencies]
python = "^3.10"

[tool.poetry.dev-dependencies]
pytest = "^6.2"
pre-commit = "^2.17.0"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

这个文件定义了项目的名称、版本、描述、作者和依赖关系。使用 Poetry 来管理项目依赖和构建。

3. 项目的配置文件介绍

项目的配置主要通过 config.py 文件来设置。以下是 config.py 文件的一个基本示例：

# config.py
from pydantic import BaseSettings

class Settings(BaseSettings):
    openai_api_key: str
    # 其他配置项...

    class Config:
        env_file = ".env"

settings = Settings()

在这个配置文件中，我们定义了一个 Settings 类，它包含所有项目所需的配置项。使用 pydantic 库来提供类型注解和配置验证。配置值可以从环境变量中读取，这有助于保护敏感信息，例如 API 密钥。

在项目启动时，会加载这个配置文件，并根据配置项来初始化和设置插件的行为。

nonebot_plugin_naturel_gpt 一个基于NoneBot框架的Ai聊天插件，对接OpenAi文本生成接口，实现了机器人的人格 自定义/切换，聊天记忆等功能 项目地址: https://gitcode.com/gh_mirrors/no/nonebot_plugin_naturel_gpt