导入
聊天补全
学习如何使用 OpenAI API 的聊天补全端点生成或处理文本。
...
Chat completions
代码示例
1https://api.openai.com/v1/chat/completions
| 字段 | 格式 | 类型 | 说明 |
|---|---|---|---|
| messages | 数组 | 必填 | 当前对话消息的列表。 |
| model | 字符串 | 必填 | 指定用于生成聊天回复的模型ID。 |
| max_tokens | 整数 | 可选 | 生成回复时的最大token数量。 |
| temperature | 浮点数 | 可选 | 采样温度,取值范围为0到2,默认值为1。较高的值(如0.8)会增加输出的随机性,较低的值(如0.2)会使输出更集中、更具确定性。 |
| top_p | 浮点数 | 可选 | 使用核采样(nucleus sampling)方法,模型仅考虑累计概率质量达到top_p的那些token。例如,0.1表示只考虑概率最高的前10%的token。默认值为1。 |
| response_format | 对象 | 可选 | 指定输出格式,该参数适用于较新的模型。设置为 { "type": "json_object" } 可确保返回有效的JSON对象。 |
| n | 整数 | 可选 | 要生成的聊天回复数量。默认值为1。 |
| logprobs | 整数 | 可选 | 是否返回输出token的对数概率。此功能在gpt-4-vision-preview模型上不可用。默认值为false。 |
| stop | 字符串/数组 | 可选 | 最多可提供四个序列,当API生成的内容包含这些序列时将停止继续生成。默认值为null。 |
| presence_penalty | 浮点数 | 可选 | 取值范围为-2.0至2.0。正值会惩罚已在文本中出现过的新token,从而鼓励生成新内容。默认值为0。 |
| frequency_penalty | 浮点数 | 可选 | 取值范围为-2.0至2.0。正值会根据token在文本中的出现频率进行惩罚,减少重复词语的可能性。默认值为0。 |
| 字段 | 格式 | 说明 |
|---|---|---|
| id | 字符串 | 聊天补全请求的唯一标识ID。 |
| choices | 数组 | 包含响应信息的对象数组。数组长度等于请求参数中的n值。 |
| model | 字符串 | 返回本次使用的模型名称。 |
| created | 时间戳(秒) | 表示聊天补全创建时间的Unix时间戳。 |
| usage | 对象 | 使用统计信息,包括prompt_tokens(提示词token数)、completion_tokens(生成回复token数)和total_tokens(总token数)。 |
| 字段 | 格式 | 说明 |
|---|---|---|
| choices[i].finish_reason | 字符串 | 模型停止生成token的原因。可能的取值包括: stop:自然结束; length:达到指定的最大token数; content_filter:因内容过滤机制触发而中断; tool_calls:模型调用了工具。 |
| choices[i].index | 整数 | 当前选项在choices数组中的索引位置。 |
| choices[i].message | 对象 | 模型生成的聊天回复消息。 |
| choices[i].logprobs | 对象 | 当前选择的对数概率信息。 |
...
Completions: input and output model
...
Prompt设计
代码示例
1写一句关于人工智能的宣传语。
代码示例
1释放人工智能潜能,每一次创新都在改变未来。
1// 定义接口URL 2const endpointUrl = "https://api.openai.com/v1/chat/completions"; 3 4// 定义请求头参数 5const headerParameters = { 6 "Authorization": "Bearer {{SECRET_KEY}}", 7 "Content-Type": "application/json" 8}; 9 10// 请求体参数 11const bodyParameters = JSON.stringify({ 12 model: "gpt-3.5-turbo", 13 messages: [ 14 {role:"system", content:"你是一个有用的助手"}, 15 {role:"user", content:"写一句关于人工智能的宣传语。"} 16 ], 17 temperature: 0.9 18}); 19 20// 设置API调用选项 21const options = { 22 method: "POST", 23 headers: headerParameters, 24 body: bodyParameters 25}; 26 27// 发起API调用的函数 28async function createCompletion() { 29 try { 30 const response = await fetch(`${endpointUrl}`, options); 31 // 打印响应结果 32 printResponse(response); 33 } catch (error) { 34 // 打印错误信息 35 printError(error); 36 } 37} 38 39// 调用函数发起请求 40createCompletion();
代码示例
1推荐一个适合猫的名字。
代码示例
1推荐两个适合猫的名字。
代码示例
1推荐一些适合猫的名字。