README.zh-CN.md

🧭 扣子罗盘 SDK

English | 简体中文

扣子罗盘 平台官方 Node.js SDK.

快速开始

1. 安装

npm install @cozeloop/ai
# 或
pnpm install @cozeloop/ai

2. 基础用法

import { ApiClient, PromptHub, PromptAsAService } from '@cozeloop/ai';

// 1. 设置 ApiClient
const apiClient = new ApiClient({
  baseURL: 'https://api.coze.cn',
  token: 'your_access_token',
});

// 2. 使用 `PromptHub` 或 `PromptAsAService`
const promptHub = new PromptHub({
  // 或设置环境变量 process.env.COZELOOP_WORKSPACE_ID,
  workspaceId: 'your_workspace_id',
  apiClient,
});
// hub.getPrompt(key, version);
// hub.formatPrompt(prompt);

const model = new PromptAsAService({
  // 或设置环境变量 process.env.COZELOOP_WORKSPACE_ID,
  workspaceId: 'your_workspace_id',
  // 要调用的 prompt
  prompt: {
    prompt_key: 'your_prompt_key',
  },
  apiClient,
});
// model.invoke({
//   messages: [{ role: 'user', content: 'hi' }],
// });
// model.stream({
//   messages: [{ role: 'user', content: 'hi' }],
// });

主要特性

• 🗂️ Prompt Hub: 在 CozeLoop 平台开发、提交和发布 Prompt，使用 PromptHub 访问 Prompt。
• 🛠️ Prompt as a Service: 在 CozeLoop 平台开发、提交和发布 Prompt，并作为服务调用。
• 🔐 多种鉴权方式: PAT and JWT
• ⚙️ 可配置: 超时、请求头、信号、调试

鉴权方式

1. 个人访问令牌（PAT，最简单）

const apiClient = new ApiClient({
  baseURL: 'https://api.coze.cn',
  token: 'your_pat_token',
});

2. JWT 鉴权

const authFlow = new OAuthJWTFlow({
  baseURL: 'https://api.coze.cn',
  appId: '1177045121217', // 授权应用 App Id
  aud: 'api.coze.cn', //  使用 api.coze.cn
  keyid: 'public_key_id of Auth App',
  privateKey: 'private_key_content',
});

const tokenResp = await authFlow.getToken();
const apiClient = new ApiClient({
  baseURL: 'https://api.coze.cn',
  token: tokenResp.access_token,
});