TypeScript API 参考 | JoyToken

导入

1 import {
2   JoyTokenAPIError,
3   JoyTokenClient,
4   type ChatCompletionRequest,
5   type ChatCompletionResponse,
6   type ChatCompletionChunk,
7   type ChatMessage,
8   type ChatTool,
9   type JoyTokenClientOptions,
10   type ModelListResponse,
11 } from "@joytoken/client-sdk-ts";

JoyTokenClient

1 new JoyTokenClient(options?: JoyTokenClientOptions)

选项	类型	说明
`apiKey`	`string`	JoyToken API Key。默认读取 `JOY_TOKEN_API_KEY`
`apiBaseUrl`	`string`	非 OpenAI 接口的基础 URL。默认 `https://api-dev.joytokens.ai`
`openAIBaseUrl`	`string`	聊天补全基础 URL。默认 `${apiBaseUrl}/openai/v1`
`fetch`	`typeof fetch`	自定义 fetch 实现
`defaultHeaders`	`Record<string, string>`	每个请求都会携带的请求头
`timeoutMs`	`number`	请求超时，单位毫秒

chat.completions.create

1 client.chat.completions.create(request: ChatCompletionRequest): Promise<ChatCompletionResponse>

向 POST /openai/v1/chat/completions 发送非流式请求。

必填字段：

字段	类型
`model`	`string`
`messages`	`ChatMessage[]`

常用可选字段包括 temperature、max_tokens、top_p、stop、tools、tool_choice、tier 和 metadata。

chat.completions.stream

1 client.chat.completions.stream(request): AsyncIterable<ChatCompletionChunk>

向 POST /openai/v1/chat/completions 发送 stream: true 的流式请求。

1 for await (const chunk of client.chat.completions.stream(request)) {
2   // chunk.choices 是 assistant delta
3   // chunk.metadata 是 JoyToken metadata
4 }

models.list

1 client.models.list(): Promise<ModelListResponse>

调用 GET /api/v1/models 并返回：

1 interface ModelListResponse {
2   object?: string;
3   data: ModelInfo[];
4 }

JoyTokenAPIError

非 2xx 响应会抛出 JoyTokenAPIError。

字段	类型
`status`	`number`
`requestId`	`string
`responseHeaders`	`Headers`
`body`	`unknown`

核心类型

1 type ChatRole = "system" | "user" | "assistant" | "tool";
2 
3 interface ChatMessage {
4   role: ChatRole;
5   content?: string | Array<Record<string, unknown>> | null;
6   name?: string;
7   tool_call_id?: string;
8   tool_calls?: ToolCall[];
9 }

1 interface ChatTool {
2   type: "function";
3   function: {
4     name: string;
5     description?: string;
6     parameters?: Record<string, unknown>;
7   };
8 }