Skip to content

文本补全接口 ​

使用 OpenAI Legacy Completions 兼容格式生成文本。

http
POST /v1/completions

Legacy Completions 使用 作为输入,适合仍在使用旧 OpenAI SDK 或简单补全文本的业务。新对话场景建议使用 对话接口。

默认示例模型为 。

当前可用模型 ​

模型说明
Legacy Completions 指令模型

请求头 ​

名称类型必填说明
string是请求身份认证。使用 Bearer Token,示例:
string是请求内容类型,必须设置为

请求体 ​

名称类型必填说明
string是模型 ID,默认示例 ;可选值见上方「当前可用模型」
string | array是输入提示词。可为字符串、字符串数组、token 数组或 token 数组的数组;官方默认从文档起始标记生成
string否插入文本补全之后出现的后缀;仅 支持
integer否最大生成 token 数,官方默认 ;与 prompt token 之和不能超过模型上下文长度
number否采样温度,范围 –,默认 ;通常只调 或 其一
number否核采样,范围 –,默认
integer否每个 prompt 生成多少条补全,范围 –,默认
boolean否是否流式返回,默认 ;开启后以 SSE 推送,结束返回
object否流式附加选项,仅 时生效
integer否返回最可能 token 的对数概率数量,最大
boolean否是否在补全结果之外回显 prompt,默认
string | array否最多 4 个停止序列,遇到后停止生成
number否范围 –,默认
number否范围 –,默认
integer否服务端生成多条后取最优一条,默认 ,最大 ;不可与流式同用;与 同用时须大于
object否指定 token 出现概率偏置;键为 token ID,值 –
integer否随机种子,尽力确定性采样
string否终端用户唯一标识,用于滥用监测

stream_options ​

名称类型必填说明
boolean否在 前额外推送含 的片段

请求示例 ​

bash
curl -X POST https://octopusx.ai/v1/completions \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-3.5-turbo-instruct",
    "prompt": "把下面一句话改写得更正式:这个接口挺好用。",
    "max_tokens": 120,
    "temperature": 0.3
  }'
bash
curl -X POST https://octopusx.ai/v1/completions \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-3.5-turbo-instruct",
    "prompt": "用一句话介绍文本补全接口。",
    "max_tokens": 64,
    "stream": true,
    "stream_options": {
      "include_usage": true
    }
  }'

响应示例 ​

非流式成功 ​

json
{
  "id": "cmpl_abc123",
  "object": "text_completion",
  "created": 1735689600,
  "model": "gpt-3.5-turbo-instruct",
  "choices": [
    {
      "index": 0,
      "text": "该接口具备良好的易用性。",
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 22,
    "completion_tokens": 10,
    "total_tokens": 32
  }
}

流式片段(示意) ​

text
data: {"id":"cmpl_abc123","object":"text_completion","choices":[{"index":0,"text":"该","finish_reason":null}]}

data: {"id":"cmpl_abc123","object":"text_completion","choices":[{"index":0,"text":"接口","finish_reason":null}]}

data: [DONE]

响应字段 ​

名称类型说明
string补全响应 ID
string对象类型,固定为
integer响应创建时间戳(秒)
string生成响应的模型
array候选结果数组
integer候选结果序号
string模型生成的文本内容
string结束原因,例如
objecttoken 用量统计
integer输入 token 数
integer输出 token 数
integer总 token 数

相关接口 ​