从OpenAI API JSON响应中高效提取生成文本内容

本教程详细指导开发者如何从openai api返回的json格式响应中准确提取生成的文本。通过利用`json.parse()`方法解析响应字符串，并访问`choices[0].text`属性，可以安全、高效地获取核心文本内容，从而避免直接字符串操作的潜在问题，确保api数据处理的健壮性。

OpenAI API是现代应用程序中集成人工智能能力的重要工具，其响应通常以JSON（JavaScript Object Notation）格式返回。JSON是一种轻量级的数据交换格式，具有易于阅读和机器解析的优点。理解并正确解析这些JSON响应，是有效利用OpenAI API获取生成文本的关键步骤。直接对原始响应字符串进行基于索引或特定字符的截取操作，不仅不够灵活，也极易因API响应结构的变化而导致错误。

理解OpenAI API响应结构

OpenAI的文本生成API（例如text-davinci-002模型）在成功完成请求后，会返回一个包含多个字段的JSON对象。其中，我们最关注的是choices数组，它包含了模型实际生成的文本内容。

以下是一个典型的OpenAI API响应示例：

{
  "id": "cmpl-61dshxu43ecbrqir187yilz9mdhsj",
  "object": "text_completion",
  "created": 1665749707,
  "model": "text-davinci-002",
  "choices": [{
    "text": "?\n\nthere is no simple answer to these questions. each person's individual experiences and perspectives will shape their understanding of who they are and what life is. in general, however, people often think of themselves as unique individuals with specific talents, interests, and goals. they may also think of life as a journey full of challenges and opportunities for growth.",
    "index": 0,
    "logprobs": null,
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 7,
    "completion_tokens": 71,
    "total_tokens": 78
  }
}

从上述JSON结构可以看出，模型生成的实际文本内容嵌套在choices数组的第一个元素（索引为0）的text属性中。

正确的文本提取方法

为了从JSON响应中安全、准确地提取文本，我们需要利用编程语言提供的JSON解析功能。在JavaScript环境中，这通常通过JSON.parse()方法实现。

步骤一：解析JSON响应字符串

当XMLHttpRequest（或fetch等其他HTTP客户端）接收到完整的API响应后，xhr.responseText会包含原始的JSON字符串。我们需要将其转换为一个JavaScript对象，以便能够访问其内部属性。

在xhr.onreadystatechange事件处理器中，当xhr.readyState为4（表示请求已完成）且xhr.status为200（表示请求成功）时，即可安全地解析响应。

Bandy AI

全球领先的电商设计Agent

下载

xhr.onreadystatechange = function() {
  if (xhr.readyState === 4) { // 确保请求已完成
    if (xhr.status === 200) { // 确保HTTP状态码为200，表示请求成功
      var responseData = JSON.parse(xhr.responseText);
      // ... 后续操作，如步骤二
    } else {
      console.error("API请求失败，状态码:", xhr.status);
      console.error("错误响应:", xhr.responseText);
    }
  }
};

注意事项： 在实际应用中，检查xhr.status以确认请求成功至关重要。这有助于避免在网络错误或服务器返回错误时尝试解析无效的JSON字符串，从而增强应用程序的健壮性。

步骤二：访问目标文本属性

一旦xhr.responseText被JSON.parse()成功解析为一个JavaScript对象（例如命名为responseData），我们就可以通过点符号（.）或方括号（[]）语法来访问其嵌套属性，从而获取所需的生成文本。

xhr.onreadystatechange = function() {
  if (xhr.readyState === 4) {
    if (xhr.status === 200) {
      var responseData = JSON.parse(xhr.responseText);
      // 访问 choices 数组的第一个元素，并获取其 text 属性
      let generatedText = responseData.choices[0].text;
      console.log("成功提取的文本内容:");
      console.log(generatedText);
      // 现在，generatedText 变量中存储的就是OpenAI模型生成的纯文本，可以用于后续处理
    } else {
      console.error("API请求失败，状态码:", xhr.status);
      console.error("错误响应:", xhr.responseText);
    }
  }
};

完整示例代码

结合上述解析逻辑，以下是修改后的JavaScript代码片段，展示了如何从OpenAI API响应中正确提取文本：

let open_ai_response_text; // 用于存储提取到的文本

async function openai_test() {
  var prompt_text = "who am i?";
  var prompt_text2 = "what is life?"; // 建议将两个问题合并为一个更清晰的prompt
  var url = "https://api.openai.com/v1/engines/text-davinci-002/completions";

  var xhr = new XMLHttpRequest();
  xhr.open("POST", url);
  xhr.setRequestHeader("Content-Type", "application/json");
  // 替换为您的实际API密钥，注意安全存储
  xhr.setRequestHeader("Authorization", "Bearer sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"); 

  xhr.onreadystatechange = function() {
    if (xhr.readyState === 4) {
      if (xhr.status === 200) {
        console.log("HTTP状态码:", xhr.status);
        console.log("原始API响应:", xhr.responseText);

        try {
          // 步骤一：解析JSON响应
          var responseData = JSON.parse(xhr.responseText);
          // 步骤二：访问目标文本属性
          open_ai_response_text = responseData.choices[0].text;
          console.log("提取到的生成文本:");
          console.log(open_ai_response_text);

          // 此处可以对 open_ai_response_text 进行进一步处理，例如显示在页面上
          // var edit = open_ai_response_text[0].toUpperCase() + open_ai_response_text.slice(1).toLowerCase();
          // console.log("处理后的文本（示例）:", edit);

        } catch (e) {
          console.error("JSON解析失败或数据结构不符合预期:", e);
          console.error("尝试解析的响应文本:", xhr.responseText);
        }

      } else {
        console.error("API请求失败，状态码:", xhr.status);
        console.error("错误响应:", xhr.responseText);
      }
    }
  };

  var data = `{
    "prompt": "${prompt_text + " " + prompt_text2}",
    "temperature": 0.7,
    "max_tokens": 256,
    "top_p": 1,
    "frequency_penalty": 0.75,
    "presence_penalty": 0
  }`;

  xhr.send(data);
}

// 调用函数启动API请求
openai_test();

处理多条选择（进阶）

OpenAI API的choices字段是一个数组，这意味着模型理论上可能返回多个不同的文本生成结果。虽然在许多简单用例中它只包含一个元素，但如果需要处理所有可能的选择，可以使用循环遍历choices数组：

xhr.onreadystatechange = function() {
  if (xhr.readyState === 4 && xhr.status === 200) {
    try {
      var responseData = JSON.parse(xhr.responseText);
      if (responseData.choices && responseData.choices.length > 0) {
        responseData.choices.forEach((choice, index) => {
          console.log(`第 ${index + 1} 个选择的文本:`, choice.text);
          // 在这里对每个 choice.text 进行单独处理
          // 例如，可以将所有文本收集到一个数组中
        });
      } else {
        console.warn("API响应中未找到有效的文本选择。");
      }
    } catch (e) {
      console.error("JSON解析失败或数据结构不符合预期:", e);
    }
  } else if (xhr.readyState === 4) {
    console.error("API请求失败，状态码:", xhr.status);
  }
};

总结

从OpenAI API响应中提取生成文本的核心在于理解其JSON结构并采用标准的JSON解析方法。JSON.parse(xhr.responseText)是JavaScript中将API返回的JSON字符串转换为可操作对象的基础步骤。随后，通过访问responseObject.choices[0].text可以安全、准确地获取模型的输出文本。在开发过程中，务必加入完善的错误处理机制，例如检查HTTP状态码和处理JSON解析可能抛出的异常，以确保应用程序的健壮性和用户体验。通过遵循这些最佳实践，开发者可以高效且可靠地集成OpenAI的强大功能。