PPAgent 文档

Appearance

Coze ​

Coze是字节跳动旗下的AI智能体平台，通过PPAgent的Coze集成，可以快速接入Coze平台上构建的智能体。

特点 ​

  • 支持Coze平台上自己构建的各类智能体
  • 支持图片和文件上传功能
  • 支持自定义变量传递
  • 可选择使用本地文件或上传至Coze服务器

使用代码配置 ​

根据Coze后端模型的接口定义，你可以通过以下方式配置Coze智能体：

typescript
const ppagent = new PPAgent({
  bots: [
    {
      name: "coze-bot",
      options: {
        instanceName: "my-coze-bot", // 实例名称，需保证唯一性
        appId: "your-app-id", // Coze平台上的应用ID
        privateKey: "your-private-key", // 应用私钥
        botId: "your-bot-id", // Coze平台上的BotID
        apiKey: "your-api-key", // 应用公钥
        apiBase: "https://api.coze.cn", // 可选，服务URL
        preferLocalAttach: false, // 可选，是否优先使用本地文件
        customVars: { // 可选，自定义变量
          key1: "value1",
          key2: "value2"
        }
      }
    }
  ],
  source: {...},
  agents: {...}
});

服务器运行请参考 install_code 文件。

配置注意事项 ​

  1. 必填字段说明：

    • appId: 在Coze平台应用发布页面，发布为API后，从OAuth选项卡中获得
    • botId: 应用编辑页面中，浏览器地址中的bot/xxx，xxx部分就是botId
    • apiKey: 应用公钥，应用发布为API后可获得
    • privateKey: 应用私钥，填入pem文件中的所有内容

  2. 文件处理：如果设置preferLocalAttach为true，系统会优先使用本地文件地址，而不上传到Coze服务器。但请注意，这可能导致某些平台无法进行后续追问。

  3. 自定义变量：通过customVars可以向Coze Bot传递自定义变量，这些变量可以在Coze平台上的智能体中被访问和使用。