本文旨在指导开发者如何正确解析OpenAI API返回的JSON格式响应，并从中提取所需的生成文本内容。通过详细的步骤和代码示例，我们将展示如何使用`JSON.parse()`方法处理API响应，并精确访问`choices[0].text`属性以获取核心文本输出，同时探讨处理多条生成结果的方法及相关注意事项。
在与OpenAI API进行交互时，无论是使用text-davinci-002还是其他模型，API的响应通常都是一个结构化的JSON对象。理解并正确解析这个JSON结构是高效利用API生成内容的关键。直接对原始字符串进行截取或正则匹配来提取文本是一种不推荐且容易出错的方法，因为它忽略了JSON作为数据交换格式的内在结构。
理解OpenAI API响应结构
OpenAI API的成功响应通常包含一个JSON对象，其核心生成文本位于choices数组的第一个元素的text属性中。以下是一个典型的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
}
}从上述结构可以看出，我们感兴趣的生成文本位于choices数组内部，具体路径是choices[0].text。
正确提取生成文本的方法
要从OpenAI API的JSON响应中提取文本，正确的步骤是先将原始响应字符串解析为JavaScript对象，然后通过属性访问来获取所需内容。
1. JSON解析
当XMLHttpRequest（或fetch等其他HTTP客户端）接收到API响应时，xhr.responseText属性会包含一个JSON格式的字符串。我们需要使用JSON.parse()方法将其转换为一个可操作的JavaScript对象。
xhr.onreadystatechange = function() {
if (xhr.readyState === 4) { // 确保请求已完成
if (xhr.status === 200) { // 检查HTTP状态码是否为成功
var response = JSON.parse(xhr.responseText);
// 后续操作
} else {
console.error("API请求失败，状态码: " + xhr.status);
console.error("错误信息: " + xhr.responseText);
}
}
};2. 访问生成文本
一旦响应字符串被解析为JavaScript对象response，我们就可以通过链式属性访问来获取生成文本：
let generatedText = response.choices[0].text; console.log(generatedText);
这段代码会获取choices数组中的第一个元素（索引为0），然后访问该元素的text属性。
处理多个生成结果（Choices）
OpenAI API允许您通过在请求中设置n参数来生成多个不同的完成结果。在这种情况下，choices数组将包含多个元素。如果您需要处理所有这些结果，可以遍历choices数组：
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
var response = JSON.parse(xhr.responseText);
if (response.choices && response.choices.length > 0) {
response.choices.forEach((choice, index) => {
console.log(`Choice ${index + 1}:`);
console.log(choice.text);
// 可以在这里对每个生成的文本进行进一步处理
});
} else {
console.log("未找到任何生成文本。");
}
} else if (xhr.readyState === 4) {
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-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4) {
if (xhr.status === 200) {
try {
var response = JSON.parse(xhr.responseText);
// 检查 choices 数组是否存在且不为空
if (response.choices && response.choices.length > 0) {
open_ai_response_text = response.choices[0].text;
console.log("提取到的OpenAI响应文本:");
console.log(open_ai_response_text);
// 示例：对提取的文本进行处理（如首字母大写，其他字符小写）
// 注意：API返回的文本可能包含换行符，需要根据实际需求处理
// let processedText = open_ai_response_text.trim(); // 移除首尾空白符
// if (processedText.length > 0) {
// processedText = processedText[0].toUpperCase() + processedText.slice(1).toLowerCase();
// }
// console.log("处理后的文本:");
// console.log(processedText);
} else {
console.warn("OpenAI API响应中未找到生成文本。");
}
} catch (e) {
console.error("解析JSON响应失败:", e);
console.error("原始响应文本:", xhr.responseText);
}
} else {
console.error("OpenAI API请求失败，HTTP状态码:", xhr.status);
console.error("错误详情:", xhr.responseText);
}
}
};
var data = JSON.stringify({ // 使用JSON.stringify将JavaScript对象转换为JSON字符串
"prompt": prompt_text + " " + prompt_text2, // 合并prompt
"temperature": 0.7,
"max_tokens": 256,
"top_p": 1,
"frequency_penalty": 0.75,
"presence_penalty": 0
});
xhr.send(data);
}
// 调用函数以启动API请求
openai_test();注意事项
- API Key 安全: 您的API密钥（sk-xxxxxxxx）是敏感信息，不应直接暴露在客户端代码中。在生产环境中，应通过后端服务器代理API请求，或使用环境变量安全地管理密钥。
- 错误处理: 务必检查xhr.status以确保HTTP请求成功（通常是200）。同时，使用try-catch块来处理JSON.parse()可能因响应格式不正确而抛出的错误。
- 响应内容检查: 在访问response.choices[0].text之前，最好检查response对象、response.choices数组以及其长度，以避免在API未返回预期结构时出现运行时错误。
- 文本后处理: OpenAI返回的text内容可能包含前导或尾随的换行符（\n）或其他空白字符。根据您的应用需求，可能需要使用trim()、replace()等字符串方法进行清理和格式化。
- prompt构建: 在原始问题中，prompt_text + prompt_text2可能会导致两个问题之间没有空格，影响模型理解。建议在合并时添加适当的连接符，如prompt_text + " " + prompt_text2。
总结
正确地从OpenAI API响应中提取生成文本，关键在于理解API返回的是JSON格式数据，并利用JSON.parse()将其转换为可操作的JavaScript对象。随后，通过访问response.choices[0].text即可轻松获取核心生成内容。对于需要处理多个生成结果的场景，遍历choices数组是标准做法。遵循这些指导原则，并结合健壮的错误处理机制，将确保您的应用程序能够稳定、高效地与OpenAI API进行交互。
