API reference
🇨🇳 Chinese
  • 🇨🇳 Chinese
  • 🇺🇸 English
  1. Completions
API reference
🇨🇳 Chinese
  • 🇨🇳 Chinese
  • 🇺🇸 English
  • 系统内部接口
    • 用户查询账号信息
    • 查询Key信息
  • OpenAI
    • 聊天
      • 文本聊天
      • 识图
    • Responses
      • 创建模型响应
    • OpenAI-Realtime
      • Realtime
    • Completions
      • Instruct
        POST
    • 音频接口(Audio)
      • 音频转文本
      • 创建翻译
      • 文本转音频
    • 图像
      • 创建图像
      • 创建图像编辑
      • 创建图像变化
    • 嵌入
      • 创建嵌入
    • 审核
      • 创建审核
    • 模型
      • 获取模型列表
    • 帮助中心
      • 常见问题及解决办法
  • Anthropic
    • Anthropic Claude
  • Suno(音乐)
    • 场景一:续写音乐并获取完整音乐
    • 场景二:Cover 音乐:音乐翻版\修改风格
    • 场景三:Replace Section:替换片段
    • 场景四:Persona:歌手风格
    • 场景五:stems:声曲分离(仅限chirp_auk)
    • 场景六:Timing:歌词、音频时间线(仅限chirp_auk)
    • 场景七:wav:获取 wav 格式文件
    • 场景八:mp4:生成 mp4 mv 视频(仅限chirp_auk)
    • 生成音乐
    • 上传音乐
    • 歌曲拼接
    • 新建 Persona
    • 声曲分离
    • Timing:歌词、音频时间线
    • 获取 wav 格式文件
    • 生成 mp4 mv 视频
    • 生成歌词
    • 查询单个任务
    • 批量查询任务
    • 批量查询歌曲
  • Udio(音乐)
    • 官方格式
      • 生成音乐
      • 查询单个任务
  • Midjourney API文档(生图)
    • 快速教学-完整流程一遍过
    • 怎么切换不同的速度
    • 任务提交
      • 提交Imagine任务
      • 提交Action任务
      • 提交Blend任务
      • 提交Describe任务
      • 提交Modal
      • 提交Shorten任务
      • 提交swap_face任务
      • 上传文件到discord
    • 任务查询
      • 指定ID获取任务
      • 根据ID列表查询任务
      • 根据ID列表查询任务-字段displays
      • 获取任务图片的seed
      • 查询所有任务
      • 分页查询任务
      • 查询任务队列
      • 取消任务
  • Flux(生图)
    • 官方格式
      • 生成图片
      • 微调
      • 查询任务
    • OpenAI Dalle3格式
  • Recraft(生图)
    • 官方格式
      • 附录
      • Generate Image(生成图片)
      • Vectorize Image(矢量化图片)
      • Remove Background(删除背景)
      • Clarity Upscale(清晰度提升)
      • Generative Upscale(生成高清)
      • Create style(创建样式)
    • OpenAI Dalle3格式-生成图片
  • Ideogram(生图)
    • 官方文档(实时更新)
    • Generate with Ideogram 3.0
    • Edit with Ideogram 3.0
    • Remix with Ideogram 3.0
    • Reframe with Ideogram 3.0
    • Replace Background with Ideogram 3.0
    • Upscale
    • Describe
    • Generate(legacy)
    • Edit(legacy)
    • Remix(legacy)
  • Luma(视频)
    • 官方API格式接口
      • 生成视频
      • 单个查询任务
    • RixAPI格式接口
      • 任务提交
        • 文生视频
        • 图生视频
        • 扩展视频
        • 视频生成音频
        • 获取视频无水印链接
      • 任务查询
        • 单个查询任务
        • 批量查询任务
  • Runway(视频)
    • 官方API接口格式
      • 从图像生成视频
      • 获取任务详细信息
    • 逆向格式
      • generate(文本)
      • generate(参考图片)
      • video2video 视频转视频 风格重绘
      • Act-one 表情迁移
      • feed-获取任务
  • PIKA(视频)
    • generate(文本)
    • generate(参考图片)
    • generate(参考视频/扩展视频)
    • feed
  • 可灵API(官方接口)
    • 建议直接看官方文档
    • Callback协议
    • 生成图像
    • 文生视频
    • 图生视频
    • 多图参考生视频
    • 视频特效
    • 视频延长
    • 对口型
    • 虚拟试穿
    • 查询任务(单个)
  • Replicate 通用接口
    • 创建任务
    • 查询任务
  • MiniMax海螺
    • 官方文档
    • 图片生成
    • 视频生成
    • 查询任务
    • 文件下载
  • 火山方舟
    • 创建视频
    • 查询视频状态
  • Pixverse
    • 生成任务
    • 查询任务
  • Viggle
    • 上传图片模板
    • 上传舞蹈视频模板
    • 创建舞蹈视频任务
    • 获取任务结果
    • 获取官方舞蹈视频TAG
    • 获取官方舞蹈视频TAG下的模板
  1. Completions

Instruct

POST
/v1/completions
最后修改时间:2025-02-27 10:36:03
给定一个提示,该模型将返回一个或多个预测的完成,并且还可以返回每个位置的替代标记的概率。
为提供的提示和参数创建完成

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Header 参数
Authorization
string 
可选
默认值:
{{YOUR_API_KEY}}
Body 参数application/json
model
string 
必需
要使用的模型的 ID。您可以使用List models API 来查看所有可用模型,或查看我们的模型概述以了解它们的描述。
prompt
string 
可选

生成完成的提示,编码为字符串、字符串数组、标记数组或标记数组数组。 请注意,<|endoftext|> 是模型在训练期间看到的文档分隔符,因此如果未指定提示,模型将生成新文档的开头。

max_tokens
integer 
可选
完成时生成的最大令牌数。 您的提示加上的令牌计数max_tokens不能超过模型的上下文长度。大多数模型的上下文长度为 2048 个标记(最新模型除外,它支持 4096)。
temperature
integer 
可选
使用什么采样温度,介于 0 和 2 之间。较高的值(如 0.8)将使输出更加随机,而较低的值(如 0.2)将使输出更加集中和确定。 我们通常建议改变这个或top_p但不是两者。
top_p
integer 
可选
一种替代温度采样的方法,称为核采样,其中模型考虑具有 top_p 概率质量的标记的结果。所以 0.1 意味着只考虑构成前 10% 概率质量的标记。 我们通常建议改变这个或temperature但不是两者。
n
integer 
可选
为每个提示生成多少完成。 **注意:**因为这个参数会产生很多完成,它会很快消耗你的令牌配额。请谨慎使用并确保您对max_tokens和进行了合理的设置stop。
stream
boolean 
可选
是否回流部分进度。如果设置,令牌将在可用时作为仅数据服务器发送事件发送,流由data: [DONE]消息终止。
logprobs
null 
可选
包括最有可能标记的对数概率logprobs,以及所选标记。例如,如果logprobs是 5,API 将返回 5 个最有可能的标记的列表。API 将始终返回采样令牌的 ,因此响应中logprob最多可能有元素。logprobs+1 的最大值logprobs为 5。如果您需要更多,请通过我们的帮助中心联系我们并描述您的用例。
stop
string 
可选
API 将停止生成更多令牌的最多 4 个序列。返回的文本将不包含停止序列。
示例
{
  "model": "gpt-3.5-turbo-instruct",
  "prompt": "Say this is a test",
  "max_tokens": 7,
  "temperature": 0,
  "top_p": 1,
  "n": 1,
  "stream": false,
  "logprobs": null,
  "stop": "\n"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST '/v1/completions' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "model": "gpt-3.5-turbo-instruct",
  "prompt": "Say this is a test",
  "max_tokens": 7,
  "temperature": 0,
  "top_p": 1,
  "n": 1,
  "stream": false,
  "logprobs": null,
  "stop": "\n"
}'

返回响应

🟢200Ok
application/json
Body
id
string 
必需
object
string 
必需
created
integer 
必需
model
string 
必需
choices
array [object {4}] 
必需
text
string 
可选
index
integer 
可选
logprobs
null 
可选
finish_reason
string 
可选
usage
object 
必需
prompt_tokens
integer 
必需
completion_tokens
integer 
必需
total_tokens
integer 
必需
示例
{
    "id": "cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7",
    "object": "text_completion",
    "created": 1589478378,
    "model": "text-davinci-003",
    "choices": [
        {
            "text": "\n\nThis is indeed a test",
            "index": 0,
            "logprobs": null,
            "finish_reason": "length"
        }
    ],
    "usage": {
        "prompt_tokens": 5,
        "completion_tokens": 7,
        "total_tokens": 12
    }
}
上一页
Realtime
下一页
音频转文本
Built with