Skip to content

Latest commit

 

History

History
98 lines (69 loc) · 3.4 KB

初阶-简单接入机器人.md

File metadata and controls

98 lines (69 loc) · 3.4 KB
Raw

Gensokyo-LLM (gsk-llm) 初阶教程

名词介绍

gsk-llm：在本教程中，我们将 Gensokyo-LLM 缩写为 gsk-llm。

OneBot v11 实现端：实现了 OneBot v11 标准的应用。在教程中使用 Gensokyo，任何采用 OneBot v11 的实现端均可成功对接使用。

支持实现端列表

访问 OneBot 生态系统 查看支持实现端的完整列表。

接入方法

使用ob11反向 WebSocket 接入

  1. 直接让机器人连接到以下本程序地址的 port 上：
    • 反向链接地址：ws://127.0.0.1:46233
    • Port：46233

连接成功后，机器人便可收发信息。

使用ob11 HTTP API 接入方法

  1. 运行 gsk-llm 的 exe 可执行程序。

  2. 打开 config.yml 文件并进行以下设置：

    • 通用配置项： 
      allApi: true  # 同时开启全部 API
useSse: true  # 通过 stream 方式发送信息
port: 46233
path: "http://192.168.0.102:33800"
    • 配置监听地址：确保没有端口冲突，可以保持默认。
    • 上报消息地址(在onebotv11实现端配置,指向gsk-llm)： 
      path: "http://127.0.0.1:46233/gensokyo"
    • 配置 OneBot v11 的正向 HTTP API 地址(在gsk-llm配置,指向onebotv11实现端)： 
      http://192.168.0.102:33800(该地址是onebotv11实现端的所在ip地址:http监听端口)
    • API 类型选择： 
      apiType: 5  # 选择适合的 API 类型,文末对api类型有讲解
    • API Key 设置：填入对应平台的 API Key。

  3. 设置 systemPrompt 为需要的人设提示词。

  4. 根据注释完成其他必要配置。

一旦配置完成，你的机器人将作为一个基本的 AI 聊天对话机器人运行。

特别配置解释

  • useSse: true：API 通过 stream 方式发送信息，机器人将流式地发送信息。
  • splitByPuntuations: 40 #私聊截断率
  • splitByPuntuationsGroup: 40 #群聊截断率，仅在 SSE 时有效，100 表示每句截断。

建议截断率取值范围为 30-40，以便优化信息流的连贯性。

API apiType 类型选择

在配置文件中，apiType 用于指定使用的 API 类型。您可以根据需要选择以下编号对应的 API 类型：

  • 0：混元
  • 1：文心
  • 2：GPT
  • 3：RWKV
  • 4：TYQW
  • 5：GLm

确保您有对应平台的 API key。

特殊配置：API Type 2

当 apiType 设置为 2（GPT） 时，本程序支持兼容包括但不限于以下项目，以及所有采用 OpenAI 格式的 API 或中转项目：

对于完全标准的 OpenAI 格式 API，调整配置如下：

  • standardGptApi: true 表示启用原生的 OpenAI 格式

对于特殊的 OpenAI API 格式（api2d），则使用：

  • standardGptApi: false

API2d 提供了一些额外的配置，如安全模式和腾讯云审核等：

网络代理设置

可以通过设置 proxy: "http://192.168.0.113:7890" 来使本程序通过网络代理。

使用须知

请注意，部分平台如 QQ 开放平台和微信开放平台要求模型需要通过算法备案。请不要在这些平台使用未备案的模型。由此产生的服务号或机器人被下线的问题，本项目已尽到提醒的责任，概不负责。