API

Completions

传统文本补全接口,适用于仍依赖 prompt 字段的 legacy 客户端。

概述

Completions 是 legacy 文本补全接口。新项目建议优先使用 Chat Completions;如果已有客户端只能发送 `prompt`,可以继续通过 `/v1/completions` 接入。

请求

`POST https://api.example.com/v1/completions`

Headers

Header必需说明
Authorization`Bearer $UOUODUO_API_KEY`
Content-Type`application/json`

Body 参数

参数类型必需默认说明
modelstring-补全模型 ID
promptstring 或 array<string>-输入提示词
max_tokensinteger-最大输出 token 数
temperaturenumber1采样温度
top_pnumber1nucleus sampling
ninteger1返回候选数量
streambooleanfalse是否流式输出
stopstring 或 array<string>-停止序列
suffixstring-插入式补全后缀,模型需支持
echobooleanfalse是否回显 prompt

示例

curl https://api.example.com/v1/completions \
  -H "Authorization: Bearer $UOUODUO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-3.5-turbo-instruct",
    "prompt": "给这段告警写一句简短摘要:CPU saturation on route group A",
    "max_tokens": 80,
    "temperature": 0.2
  }'

响应

字段类型说明
idstring补全 ID
objectstring`text_completion`
createdinteger创建时间
modelstring实际模型
choicesarray<object>文本结果列表
choices[].textstring输出文本
choices[].finish_reasonstring结束原因
usageobjecttoken 统计
{
  "id": "cmpl_abc",
  "object": "text_completion",
  "created": 1779483000,
  "model": "gpt-3.5-turbo-instruct",
  "choices": [
    { "text": "Route group A 出现 CPU 饱和,需要扩容或降级。", "index": 0, "finish_reason": "stop" }
  ],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 18,
    "total_tokens": 38
  }
}

流式响应

`stream=true` 时返回 data-only SSE,chunk 中的增量文本通常位于 `choices[].text`,并以 `data: [DONE]` 终止。

注意事项

  • legacy 补全接口通常不支持多模态、tools 或结构化输出。
  • 如果你能控制客户端,迁移到 `/v1/chat/completions` 会获得更好的模型兼容性。
  • 旧模型可能在可用性和价格上变化更频繁,上线前应在 `/models` 确认可用状态。