简介

OpenAI 最近推出了一个接口,用于生成模型响应。这个 API 支持文本或图像输入,并可以生成文本或图像输出。用户可以通过调用自定义代码或使用内置工具(例如网页搜索或文件搜索),将自己的数据作为输入,以便模型生成响应。

本文主要介绍 OpenAI Responses API 的使用流程,帮助开发者轻松利用 OpenAI 模型的响应创建功能。

环境准备/前置条件

在使用 OpenAI Responses API 之前,请确保您已完成以下准备工作:

  1. 注册并登录 Ace Data Cloud 平台。
  2. 获取 API 访问凭证。
  3. 确保您的开发环境支持 Python 和相关库(如 requests)。

详细步骤

申请访问 API

首先,访问 OpenAI Responses API 页面,点击“获取”按钮以申请访问凭证:

如果您尚未登录或注册,将自动重定向到登录页面。完成登录或注册后,您将返回到当前页面。

首次申请时,您将获得免费配额,允许您免费使用 API。

基本用法

接下来,您可以在界面上填写相应内容,如下图所示:

在首次使用此接口时,您需要填写至少三项信息:authorization(可以从下拉列表中选择),model(您选择使用的 OpenAI ChatGPT 模型类型,主要有 20 种),以及 input(一个包含输入问题的数组)。每个问题都包含 rolecontent,其中 role 表示提问者的角色,可以是 userassistantsystem,而 content 则是具体问题的内容。

界面右侧会生成相应的代码,您可以直接复制代码进行运行,或者点击“尝试”按钮进行测试。

常见的可选参数包括:

  • max_tokens:限制单个响应的最大令牌数。
  • temperature:生成随机性,范围在 0 到 2 之间,数值越大,结果越多样。
  • n:一次生成多少个候选响应。
  • response_format:设置返回格式。
  • tools:功能/工具调用定义。
  • background:是否在后台异步运行。

调用并处理返回结果

调用后,您会收到类似以下的返回结果:

{
  "id": "resp_68a98322e3c88191a027de2711a02a490554cad0b36c0400",
  "object": "response",
  "created_at": 1755939618,
  "status": "completed",
  "output": [
    {
      "id": "msg_68a98323422c8191a7f383eea48ba5160554cad0b36c0400",
      "type": "message",
      "content": [
        {
          "type": "output_text",
          "text": "Hello! How can I assist you today?"
        }
      ],
      "role": "assistant"
    }
  ]
}

返回结果中包含多个字段,主要字段如下:

  • id:对话任务的唯一标识符。
  • model:所选的 OpenAI ChatGPT 模型。
  • output:ChatGPT 的响应信息。
  • usage:此问答的令牌统计。

流式响应

该接口还支持流式响应,非常适合网页集成,允许网页逐字显示结果。若希望以流式方式返回响应,可以将请求头中的 stream 参数设置为 true

下面是如何进行设置的示例:

更改 stream 参数后,API 将逐行返回 JSON 数据,您需要在代码中进行相应的修改以获取逐行结果。

Python 示例调用代码:

import requests

url = "https://api.acedata.cloud/openai/responses"
headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}
payload = {
    "model": "gpt-4.1",
    "input": [{"role":"user","content":"Hello"}],
    "stream": True
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)

错误处理

在调用 API 时,如果发生错误,API 将返回相应的错误代码和消息。例如:

  • 400 token_mismatched:请求错误,可能由于缺少或无效的参数。
  • 401 invalid_token:未授权,令牌无效或缺失。
  • 429 too_many_requests:请求过多,超过速率限制。

错误返回示例:

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  }
}

总结

通过本文,您学习了如何轻松实现 OpenAI 的响应创建功能,利用 OpenAI Responses API。如果您有任何疑问,欢迎联系技术支持团队。

Ace Data Cloud 官网 | API 文档


标签:#OpenAI #API #Python #数据处理 #流式响应

Logo

欢迎加入DeepSeek 技术社区。在这里,你可以找到志同道合的朋友,共同探索AI技术的奥秘。

更多推荐