ChatAnywhere API 帮助文档
  1. 自动补全接口(Completions)
ChatAnywhere API 帮助文档
  • 帮助中心
    • 常用软件使用教程
    • 费用标准及模型列表
    • 常见问题及解决办法
    • 更新日志: 2025-04-25
  • 模型接口
    • 发出请求
    • 模型(Models)
      • 列出模型
    • 聊天接口(Chat)
      • 聊天接口
    • 自动补全接口(Completions)
      • 内容补全接口
        POST
    • 图像接口(Images)
      • 图像变化
      • 图像编辑
      • 创建图像
    • 向量生成接口(Embeddings)
      • 创建嵌入
    • 音频接口(Audio)
      • tts文本转语音
      • 创建转录
      • 创建翻译
    • 查询接口
      • 查询用量详情(小时粒度)
  1. 自动补全接口(Completions)

内容补全接口

POST
/v1/completions
给定一个提示,该模型将返回一个或多个预测的完成,并且还可以返回每个位置的替代标记的概率。
为提供的提示和参数创建完成

请求参数

Header 参数
Authorization
string 
必需
示例值:
Bearer {{YOUR_API_KEY}}
Content-Type
string 
必需
示例值:
application/json
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 --request POST 'https://api.chatanywhere.tech/v1/completions' \
--header 'Authorization: Bearer sk-xxxxxxx' \
--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
  }
}
修改于 2024-07-17 10:10:20
上一页
聊天接口
下一页
图像变化
Built with