NXAI 文档

Appearance

深度研究 ​

POST  v1/responses

请求参数 ​

Authorization ​

在 Header 添加参数 Authorization，其值为在 Bearer 之后拼接 Token。

Authorization: Bearer ******************

Body 参数 ​

Content-Type: application/json

参数名类型必填说明
modelstring必需要使用的模型 ID。
toolsarray[object]必需工具
inputarray [object]必需输入消息列表。包含 role (可选), content (可选) 等字段。
reasoningobject必需仅适用于o系列模型
truncationstring必需用于模型响应的截断策略
includearray[string]可选指定要在模型响应中包含的附加输出数据。
instructionsstring可选作为系统消息插入到模型上下文的最前面。注意：当使用 previous_response_id 时，之前的指令不会自动带入，方便切换指令。
max_output_tokensinteger可选响应生成的最大 token 数（包含可见输出和推理 token）。
metadataobject可选最多包含 16 个键值对的元数据对象，用于存储额外信息。键最长 64 字符，值最长 512 字符。
parallel_tool_callsboolean可选是否在工具调用期间启用并行执行。
previous_response_idstring可选前一次响应的唯一 ID，用于创建多轮对话。
reasoningobject可选仅适用于 o 系列模型。配置模型的推理行为。
service_tierstring可选指定处理请求的延迟层级（如 auto, default, flex）。未设置时默认为 auto。
storeboolean可选是否将此请求的输出存储用于模型蒸馏或评估。
streamboolean可选如果为 true，将通过服务器发送事件流式返回响应。
temperaturenumber可选采样温度 (0-2)。值越高输出越随机，值越低越确定。建议只调整此参数或 top_p 其中之一。
textobject可选文本响应的配置。可配置 { "type": "json_schema" } 以启用结构化输出。
tool_choicearray[string]可选模型可调用的工具列表（目前仅支持函数）。最多支持 128 个函数。
top_pnumber可选核采样参数 (0-1)。例如 0.1 意味着只考虑概率质量前 10% 的 token。
truncationstring可选用于模型响应的截断策略。
userstring可选最终用户的唯一标识符，有助于 OpenAI 监控和检测滥用行为。

请求示例 (JSON) ​

{
    "model": "o3-deep-research",
    "tools": [
        {
            "type": "web_search_preview"
        }
    ],
    "input": [
        {
            "role": "user",
            "content": "讲一个三句话的关于独角兽的睡前故事。"
        }
    ]
}

返回响应 ​

200 成功

Content-Type: application/json

响应参数 ​

参数类型必填说明
idstring必需聊天补全对象的唯一标识符。
objectstring必需对象类型，通常为 "chat.completion"。
createdinteger必需补全创建时的 Unix 时间戳（秒）。
choicesarray [object]必需模型生成的补全列表。
└─indexinteger可选此补全在其列表中的索引。
└─messageobject可选包含模型生成的响应消息的对象。
└─finish_reasonstring可选模型停止生成补全的原因。可能是 "stop"、"length" 或 "tool_calls"。
usageobject必需此补全请求使用的令牌统计信息。
└─prompt_tokensinteger必需提示中使用的令牌数量。
└─completion_tokensinteger必需补全中生成的令牌数量。
└─total_tokensinteger必需使用的总令牌数（提示 + 补全）。

响应示例 ​

{
    "id": "chatcmpl-123",
    "object": "chat.completion",
    "created": 1677652288,
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "\n\nHello there, how may I assist you today?"
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 9,
        "completion_tokens": 12,
        "total_tokens": 21
    }
}

示例代码 ​

python
import http.client
import json

conn = http.client.HTTPSConnection("nxaiapp.com")
payload = json.dumps({
   "model": "o3-deep-research",
   "tools": [
      {
         "type": "web_search_preview"
      }
   ],
   "input": [
      {
         "role": "user",
         "content": "讲一个三句话的关于独角兽的睡前故事。"
      }
   ]
})
headers = {
   'Authorization': 'Bearer <token>',
   'Content-Type': 'application/json'
}
conn.request("POST", "/v1//responses", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))