llmbackend/doc/userflow.md

LLM API 转发平台使用者操作流程说明书

---

目录

1. 简介
2. 角色与权限
3. 操作流程概览
4. 管理员操作指南
   • 4.1 登录后台管理系统
   • 4.2 管理LLM提供商
     • 4.2.1 新增LLM提供商
     • 4.2.2 修改LLM提供商
     • 4.2.3 删除LLM提供商
   • 4.3 管理客户用户
     • 4.3.1 新增客户用户
     • 4.3.2 修改客户用户
     • 4.3.3 删除客户用户
   • 4.4 生成和管理认证令牌
5. 客户用户操作指南
   • 5.1 获取访问令牌
   • 5.2 发送提示词请求
6. 常见问题与解答
7. 技术支持

---

1. 简介

本说明书旨在指导管理员和客户用户如何使用LLM API转发平台。平台提供了基于令牌的LLM（大型语言模型）调用服务，支持多层级管理员管理和LLM提供商的动态配置。

---

2. 角色与权限

• 超级管理员：
  • 拥有系统最高权限。
  • 可以管理所有管理员、客户用户和LLM提供商。
• 管理员：
  • 可以管理分配给他们的客户用户和LLM提供商。
  • 无法访问其他管理员的资源。
• 客户用户：
  • 通过认证令牌和访问令牌与系统交互。
  • 只能使用绑定的LLM提供商进行提示词请求。

---

3. 操作流程概览

1. 管理员登录后台管理系统。
2. 管理员管理LLM提供商：
   • 新增、修改或删除LLM提供商。
3. 管理员管理客户用户：
   • 新增客户用户并绑定LLM提供商。
   • 为客户用户生成认证令牌。
4. 客户用户使用认证令牌获取访问令牌。
5. 客户用户使用访问令牌发送提示词请求。

---

4. 管理员操作指南

4.1 登录后台管理系统

1. 打开浏览器，访问后台管理系统URL。
2. 在登录页面输入用户名和密码。
3. 点击“登录”按钮进入后台管理界面。

4.2 管理LLM提供商

管理员可以通过后台管理界面，管理LLM提供商。

4.2.1 新增LLM提供商

1. 在左侧导航栏选择“LLM提供商管理”。
2. 点击“新增提供商”按钮。
3. 填写提供商信息：
   • 提供商名称：如OpenAI、Anthropic等。
   • 服务名称：对应后端服务逻辑的名称。
   • API URL：提供商的API接口地址。
   • 访问Token：调用提供商API所需的令牌。
4. 确认信息无误后，点击“保存”按钮。

4.2.2 修改LLM提供商

1. 在“LLM提供商管理”列表中，找到需要修改的提供商。
2. 点击对应行的“编辑”按钮。
3. 修改需要更新的提供商信息。
4. 点击“保存”按钮。

4.2.3 删除LLM提供商

1. 在“LLM提供商管理”列表中，找到需要删除的提供商。
2. 点击对应行的“删除”按钮。
3. 系统会弹出确认提示，点击“确认”进行删除。

注意：删除LLM提供商会影响绑定了该提供商的客户用户，请谨慎操作。

4.3 管理客户用户

4.3.1 新增客户用户

1. 在左侧导航栏选择“客户用户管理”。
2. 点击“新增客户用户”按钮。
3. 填写客户用户信息：
   • 用户名称：客户用户的名称或标识。
   • 绑定LLM提供商：从下拉列表中选择一个LLM提供商。
4. 点击“保存”按钮。

4.3.2 修改客户用户

1. 在“客户用户管理”列表中，找到需要修改的客户用户。
2. 点击对应行的“编辑”按钮。
3. 修改客户用户的信息或更换绑定的LLM提供商。
4. 点击“保存”按钮。

4.3.3 删除客户用户

1. 在“客户用户管理”列表中，找到需要删除的客户用户。
2. 点击对应行的“删除”按钮。
3. 系统会弹出确认提示，点击“确认”进行删除。

4.4 生成和管理认证令牌

1. 在“客户用户管理”列表中，找到需要生成令牌的客户用户。
2. 点击对应行的“生成认证令牌”按钮。
3. 系统将生成一个新的认证令牌，并显示在页面上。
4. 将认证令牌安全地发送给客户用户。

提示：认证令牌是客户用户获取访问令牌的凭证，请确保安全传输。

---

5. 客户用户操作指南

5.1 获取访问令牌

客户用户需要使用认证令牌获取短期有效的访问令牌。

1. 发送请求：
   • URL：https://api.yourdomain.com/auth/token
   • 方法：POST
   • 请求头：
     • Content-Type: application/json
   • 请求体：

     {
       "auth_token": "您的认证令牌"
     }
     

2. 接收响应：
   • 成功时，返回：

     {
       "access_token": "您的访问令牌",
       "expires_in": 3600
     }
     

   • access_token：短期访问令牌，有效期一般为1小时。
   • expires_in：令牌有效期，单位为秒。

5.2 发送提示词请求

使用获取的访问令牌，向平台发送提示词请求。

1. 发送请求：
   • URL：https://api.yourdomain.com/llm/request
   • 方法：POST
   • 请求头：
     • Content-Type: application/json
     • Authorization: Bearer 您的访问令牌
   • 请求体：

     {
       "prompt": "您的提示词内容"
     }
     

2. 接收响应：
   • 成功时，返回LLM提供商处理后的响应内容。
   • 失败时，返回错误信息，如令牌失效、权限不足等。

注意：请确保在访问令牌有效期内发送请求，过期后需要重新获取访问令牌。

---

6. 常见问题与解答

Q1：访问令牌过期了怎么办？

• A：访问令牌有效期一般为1小时，过期后需要使用认证令牌重新获取新的访问令牌。

Q2：提示“认证令牌无效”如何处理？

• A：请确认您使用的认证令牌是否正确，若仍有问题，请联系管理员重新生成认证令牌。

Q3：无法获取LLM响应或响应异常？

• A：可能是绑定的LLM提供商配置有误，或LLM服务暂时不可用，请联系管理员检查LLM提供商设置。

Q4：如何保证令牌的安全性？

• A：请妥善保管您的认证令牌和访问令牌，避免泄露。令牌仅应在HTTPS加密的环境下传输。

---

7. 技术支持

如在使用过程中遇到任何问题，请联系技术支持：

• 邮箱：support@yourdomain.com
• 电话：+86-123-4567-890
• 工作时间：周一至周五 9:00 - 18:00

---

感谢您使用LLM API转发平台，您的满意是我们最大的动力！