Skip to content

网络搜索工具

POST  v1/responses

请求参数

Authorization

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

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

Body 参数

Content-Type: application/json

参数名类型必填说明
modelstring必需要使用的模型 ID。
toolsarray[object]必需工具
inputarray [object]必需输入消息列表。包含 role (可选), content (可选) 等字段。
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": "gpt-4.1",
    "tools": [
        {
            "type": "web_search_preview"
        }
    ],
    "input": "今天有什么积极正面的新闻?"
}

返回响应

200 成功

Content-Type: application/json

响应参数

字段名类型必填说明
idstring必需响应的唯一标识符。
objectstring必需对象类型。
created_atinteger必需创建时间的 Unix 时间戳。
statusstring必需响应的当前状态。
backgroundboolean必需是否在后台运行。
modelstring必需使用的模型名称。
parallel_tool_callsboolean必需是否启用了并行工具调用。
service_tierstring必需服务层级(如 default, flex 等)。
storeboolean必需是否存储了输出用于训练/评估。
temperatureinteger必需采样温度。
tool_choicestring必需工具选择策略。
toolsarray[string]必需可用的工具列表。
top_logprobsinteger必需返回的对数概率数量。
top_pinteger必需核采样概率阈值。
truncationstring必需截断策略。
usernull必需用户标识(此处显示为 null,通常用于审计)。
metadataobject必需用户自定义的元数据。
createdinteger必需另一个时间戳字段(可能是兼容旧版字段)。

响应示例

{
    "id": "resp_67ccf18ef5fc8190b16dbee19bc54e5f087bb177ab789d5c",
    "object": "response",
    "created_at": 1741484430,
    "status": "completed",
    "error": null,
    "incomplete_details": null,
    "instructions": null,
    "max_output_tokens": null,
    "model": "gpt-4.1",
    "output": [
        {
            "type": "web_search_call",
            "id": "ws_67ccf18f64008190a39b619f4c8455ef087bb177ab789d5c",
            "status": "completed"
        },
        {
            "type": "message",
            "id": "msg_67ccf190ca3881909d433c50b1f6357e087bb177ab789d5c",
            "status": "completed",
            "role": "assistant",
            "content": [
                {
                    "type": "output_text",
                    "text": "截至今天,2025年3月9日,一则值得关注的积极新闻是中国科学家在可再生能源领域取得重大突破,成功研发出一种新型高效太阳能电池,转化率达到了创纪录的35%,这可能会极大推动清洁能源的普及和应用。这项技术预计将使太阳能发电成本降低约40%,为全球减少碳排放提供了新的解决方案。",
                    "annotations": [
                        {
                            "type": "url_citation",
                            "start_index": 42,
                            "end_index": 100,
                            "url": "https://example.com/renewable-energy-breakthrough/?utm_source=chatgpt.com",
                            "title": "中国科学家在可再生能源领域取得重大突破"
                        },
                        {
                            "type": "url_citation",
                            "start_index": 101,
                            "end_index": 150,
                            "url": "https://example.com/solar-cell-efficiency-record/?utm_source=chatgpt.com",
                            "title": "新型高效太阳能电池转化率创纪录"
                        },
                        {
                            "type": "url_citation",
                            "start_index": 151,
                            "end_index": 200,
                            "url": "https://example.com/clean-energy-cost-reduction/?utm_source=chatgpt.com",
                            "title": "太阳能发电成本有望降低40%"
                        }
                    ]
                }
            ]
        }
    ],
    "parallel_tool_calls": true,
    "previous_response_id": null,
    "reasoning": {
        "effort": null,
        "summary": null
    },
    "store": true,
    "temperature": 1,
    "text": {
        "format": {
            "type": "text"
        }
    },
    "tool_choice": "auto",
    "tools": [
        {
            "type": "web_search_preview",
            "domains": [],
            "search_context_size": "medium",
            "user_location": {
                "type": "approximate",
                "city": null,
                "country": "US",
                "region": null,
                "timezone": null
            }
        }
    ],
    "top_p": 1,
    "truncation": "disabled",
    "usage": {
        "input_tokens": 328,
        "input_tokens_details": {
            "cached_tokens": 0
        },
        "output_tokens": 356,
        "output_tokens_details": {
            "reasoning_tokens": 0
        },
        "total_tokens": 684
    },
    "user": null,
    "metadata": {}
}

示例代码

python
import http.client
import json

conn = http.client.HTTPSConnection("nxaiapp.com")
payload = json.dumps({
   "model": "gpt-4.1",
   "tools": [
      {
         "type": "web_search_preview"
      }
   ],
   "input": "今天有什么积极正面的新闻?"
})
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"))