异步客户端

使用 AsyncTypeSafeClient 提出问题、列出模型，并配置异步的 TypeSafe API 请求。

#typesafe_sdk.AsyncTypeSafeClient

为 TypeSafe AI API 创建一个异步 HTTP 客户端。

显式选项优先于环境变量；空的环境变量值或只含空白的环境变量值会被忽略。

参数：

• api_key (str | None, default: None ) –

  必需的 API key；可通过 TYPESAFE_API_KEY 环境变量设置。首尾空白会被去除。空 key、内部空白、控制字符以及非 ASCII 字符都会被拒绝。

• model (str | None, default: None ) –

  模型名称；可通过 TYPESAFE_DEFAULT_MODEL 环境变量设置。

• retry (RetryPolicy | None, default: None ) –

  一个控制重试行为的 RetryPolicy；可用选项及其默认值见 RetryPolicy。传入 RetryPolicy(max_retries=0) 可禁用重试。

• timeout (float | httpx2.Timeout | None, default: None ) –

  HTTP 操作的超时。提供 http_client 时继承 http_client.timeout，否则使用 SDK 默认值。

• headers (Mapping[str, str] | None, default: None ) –

  要设置的额外请求头。

• transport (httpx2.AsyncBaseTransport | None, default: None ) –

  可选的自定义 HTTP 传输层，在本 SDK 客户端关闭时一并关闭。

• http_client (httpx2.AsyncClient | None, default: None ) –

  可选的 httpx2.AsyncClient；与 transport 互斥。在本 SDK 客户端关闭时一并关闭。

• base_url (str | None, default: None ) –

  API 根地址；可通过 TYPESAFE_BASE_URL 环境变量设置。

抛出：

• TypeSafeError –

  API key 缺失或无效，或者超时无效。

• ValueError –

  同时提供了 transport 和 http_client。

示例：

import asyncio
 
from typesafe_sdk import AsyncTypeSafeClient, Choice, Noul
 
 
async def main() -> None:
    async with AsyncTypeSafeClient() as client:
        result = await client.system_one(
            state="I was charged twice. Please help.",
            questions={
                "billing": Noul(instructions="Is this about billing?"),
                "tone": Choice(
                    instructions="What is the tone?",
                    criteria={"calm": None, "angry": None},
                ),
            },
        )
        assert 0 <= result.nouls["billing"].noul <= 1
        assert result.choices["tone"].choice in {"calm", "angry"}
 
 
asyncio.run(main())
 

#models

cached property

Models API 资源的访问器。

示例：

async def main() -> None:
    async with AsyncTypeSafeClient() as client:
        models = await client.models.list()
 

#system_one

async

针对文本或结构化状态回答具名问题。

详见 System One。

参数：

• state (JSONContent) –

  要评估的文本、JSON 对象或数组。详见 state。

• questions (Mapping[str, Question]) –

  名称到问题对象或原始字典的非空映射。

• model (str | None, default: None ) –

  模型覆盖；None 继承客户端默认值。

• retry (RetryPolicy | None, default: None ) –

  可选的重试策略，仅覆盖本次调用的客户端级取值。

• timeout (float | httpx2.Timeout | None, default: None ) –

  可选的 http 操作超时，仅覆盖本次调用的客户端级取值，单位为秒。

• extra_headers (Mapping[str, str] | None, default: None ) –

  要设置的额外请求头。

• extra_body (Mapping[str, JSONValue | None] | None, default: None ) –

  额外的顶层请求体字段，在设置好 state、model 和 questions 之后浅合并到请求体之上。合并遵循后写覆盖：与 state、model 或 questions 冲突的键会覆盖它们，并且对象值会被整体替换，而不是深度合并。

• response_model (type[ResponseT] | None, default: None ) –

  可选的 Pydantic BaseModel 类型，用于描述 JSON 响应体，包括任何嵌套的答案模型。

返回：

• SystemOneResponse | ResponseT –

  response_model 的一个实例，或者以问题名为键存放答案的 SystemOneResponse

• SystemOneResponse | ResponseT –

  以及未提供自定义模型时的名称、模型和 token 用量细节。

抛出：

• TypeSafeError –

  问题为空，或者某个 score 问题的 criteria 列表为空。

• TypeSafeAPIError –

  在任何重试之后，服务器仍返回不成功的 HTTP 响应。

• TypeSafeAPIConnectionError –

  在任何重试之后，请求仍无法连接或超时。

• TypeSafeAPIResponseValidationError –

  响应体与响应模型不匹配。

示例：

用具名参数创建问题：

async def main() -> None:
    async with AsyncTypeSafeClient() as client:
        result = await client.system_one(
            state="I was charged twice. Please help.",
            questions={
                "billing": Noul(instructions="Is this about billing?"),
                "tone": Choice(
                    instructions="What is the tone?",
                    criteria={"calm": None, "angry": None},
                ),
            },
        )
        assert 0 <= result.nouls["billing"].noul <= 1
        assert result.choices["tone"].choice in {"calm", "angry"}
 

以字典形式传入问题：

async def main() -> None:
    async with AsyncTypeSafeClient() as client:
        result = await client.system_one(
            state={"message": "I was charged twice. Please help."},
            questions={
                "billing": {"type": "noul", "instructions": "Is this about billing?"},
                "tone": {
                    "type": "choice",
                    "instructions": "What is the tone?",
                    "criteria": {"calm": None, "angry": None},
                },
            },
        )
        assert 0 <= result.nouls["billing"].noul <= 1
        assert result.choices["tone"].choice in {"calm", "angry"}
 

#aclose

async

aclose() -> None
 

释放网络资源并关闭底层的 HTTP 客户端，包括外部传入的那个。

#Models 资源

通过 AsyncTypeSafeClient.models 访问。

#typesafe_sdk.AsyncModels

访问账户可用的模型，通过 AsyncTypeSafeClient.models 抵达。

#list

async

列出账户可用的模型。

参数：

• retry (RetryPolicy | None, default: None ) –

  可选的重试策略，仅覆盖本次调用的客户端级取值。

• timeout (float | httpx2.Timeout | None, default: None ) –

  单次操作的超时覆盖；None 继承客户端设置。

• extra_headers (Mapping[str, str] | None, default: None ) –

  对额外请求头的覆盖；认证、SDK 标识以及 Accept 仍受保护。

返回：

• ListModelsResponse –

  一个 ListModelsResponse，其 models 保存每个模型的名称、描述，

• ListModelsResponse –

  以及发布日期。

抛出：

• TypeSafeAPIError –

  在任何重试之后，服务器仍返回不成功的 HTTP 响应。

• TypeSafeAPIConnectionError –

  在任何重试之后，请求仍无法连接或超时。

示例：

from typesafe_sdk import AsyncTypeSafeClient
 
 
async def main() -> None:
    async with AsyncTypeSafeClient() as client:
        models = await client.models.list()