SDK 导出全部类型,方便你在项目中做类型标注。

导入类型

import {
  RouterBrain,
  RouterBrainConfigs,
  ModelItem,
  ModelsQueryParams,
  ModelsResponse,
  ModelEndpointItem,
  ModelEndpointResponse,
  RerankCreateParams,
  RerankResponse,
  RerankResultItem,
  ImageResponse,
  ImageResponseJson,
  ImageTaskResponseJson,
  ImageResponseUsage,
  ImageAdapterProps,
  ImageAdapterImage,
  ImageData,
} from '@router-brain/sdk';

常见用法

// 给函数参数加类型
function handleModelResult(model: ModelItem) {
  console.log(model.id, model.pricing.prompt);
}

// 标注 API 响应类型
const result: ModelsResponse = await rb.models({ q: 'gpt' });

// 标注图片生成结果
const img: ImageResponseJson = await rb.image({
  model: 'dall-e-3',
  prompt: '...',
}).json();

// 访问字段时有自动补全
img.data.forEach((d: ImageData) => {
  console.log(d.url);
});

类型一览

类型描述
RouterBrain主入口类
RouterBrainConfigs构造参数(apiKeybaseUrl?
ModelsQueryParams模型搜索参数
ModelsResponse模型列表响应
ModelItem单个模型信息(定价、模态等)
ModelEndpointResponse模型端点响应
ModelEndpointItem单条路由详情
RerankCreateParamsRerank 请求参数
RerankResponseRerank 响应
RerankResultItem单条重排结果
ImageResponse图片响应的包装类
ImageResponseJson非流式图片结果
ImageTaskResponseJson异步任务轮询结果
ImageResponseUsage图片生成用量
ImageAdapterProps图片生成请求参数
ImageAdapterImage参考图输入类型
ImageData单张图片数据

相关

SDK 概览 · 模型与 Rerank