APIQIKAPIQIK
文档导航
功能特性

JSON 输出模式

让支持该能力的模型返回可解析 JSON,并在应用侧完成结构校验。

JSON 模式适合分类、抽取、路由决策和配置生成。它提高输出的机器可读性,但应用仍需验证字段和业务规则。

请求示例

import json
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["APIQIK_API_KEY"],
    base_url="https://api.dimleap.cn/v1",
)

response = client.chat.completions.create(
    model="glm-5.1",
    messages=[
        {
            "role": "system",
            "content": (
                "只返回 JSON 对象,必须包含 category、priority、summary。"
                "priority 只能是 low、medium、high。"
            ),
        },
        {
            "role": "user",
            "content": "生产环境接口从十分钟前开始持续超时。",
        },
    ],
    response_format={"type": "json_object"},
    temperature=0,
)

result = json.loads(response.choices[0].message.content)
print(result)

响应示例

{
  "category": "availability",
  "priority": "high",
  "summary": "生产环境接口持续超时"
}

正确使用

  • 提示词中明确要求输出 JSON,并说明字段、类型与枚举。
  • 捕获解析失败,必要时进行有限的格式修复重试。
  • 用 JSON Schema 或数据模型验证字段,而不是只调用 json.loads。
  • JSON 字段中若包含用户输入,仍需做转义、权限与内容检查。
  • 目标模型不支持 JSON 模式时,改用函数调用或经过验证的提示词方案。

可解析不等于事实正确 JSON 模式解决的是格式问题,不会自动保证模型抽取的事实、数字或判断正确。