文档索引

在以下地址获取完整的文档索引：https://docs.typesafe.ai/llms.txt 使用此文件可以在进一步探索之前发现所有可用页面。

类：TypeSafeClient

TypeSafe AI API 的客户端。

构造函数

构造函数

new TypeSafeClient(config?): TypeSafeClient;

创建 TypeSafe AI API 客户端。

显式选项优先于环境变量，然后是 SDK 默认值。空或仅包含空白字符的环境变量值将被忽略。

参数

config?

TypeSafeClientConfig = {}

返回值

TypeSafeClient

抛出

API 密钥缺失、配置无效或运行时不受支持。

属性

baseURL

readonly baseURL: string;

移除尾部斜杠的 API 根路径。

defaultHeaders

readonly defaultHeaders: Readonly<Record<string, string>>;

每次请求发送的附加标头。

defaultModel

readonly defaultModel: string;

当请求省略 model 时使用的模型。

fetch

readonly fetch: Fetch;

HTTP fetch 实现。

logger

readonly logger: Logger;

经过筛选以匹配 logLevel 的配置记录器。

logLevel

readonly logLevel: LogLevel;

配置的日志详细程度。

models

readonly models: Models;

账户可用的模型。

retry

readonly retry: RetryPolicy;

应用构造函数覆盖后的重试设置。

timeout

readonly timeout: number;

每次尝试的超时时间（毫秒）。

方法

systemOne()

systemOne<Q>(request, options?): APIPromise<SystemOneResult<Q>>;

回答关于文本或结构化状态的具名问题。

类型参数

Q

Q extends Questions

参数

request

SystemOneRequest<Q>

状态、问题以及可选的模型覆盖设置。

options?

RequestOptions = {}

每个调用的超时、重试、标头和取消设置。

返回值

APIPromise&lt;SystemOneResult<Q>>

包含模型和 token 使用情况的按问题名称和标准分型的回答。

抛出

问题为空，或评分标准不是至少包含两个条目的列表。

抛出

重试后服务器返回非 2xx 响应。

抛出

重试后请求无法连接或超时。

抛出

调用方中止请求。

示例

const { answers } = await client.systemOne({
  state: "I was charged twice. Please help.",
  questions: { billing: noul("Is this about billing?") },
});
console.log(answers.billing.noul);