StarCoder

开发环境

http://dev-cn.your-api-server.com

POST

https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/completions/{申请发布时填写的API地址}

StarCoder由BigCode研发的15.5B参数模型，基于The Stack (v1.2)的80+编程语言训练，训练语料来自Github。本文介绍了相关API。

创建completion

调用本接口，发起一次文本续写请求。

错误码

如果请求错误，服务器返回的JSON文本包含以下参数。

名称	描述
error_code	错误码
error_msg	错误描述信息，帮助理解和解决发生的错误

例如Access Token失效返回以下内容，需要重新获取新的Access Token再次请求。

{
  "error_code": 110,
  "error_msg": "Access token invalid or no longer valid"
}

千帆大模型平台相关错误码，请查看错误码说明。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/completions/?access_token	=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "prompt": "string",
    "stream": true,
    "temperature\t": 0,
    "top_k\t": 0,
    "top_p\t": 0,
    "penalty_score": 0,
    "stop\t": [
        "string"
    ],
    "user_id": "string"
}'

响应示例

{
    "id": "as-rq3wwusja8",
    "object": "completion",
    "created": 1693811110,
    "result": "# python计算数组最大值和最小值的函数\ndef max_min(a):\n    return a.max(), a.min()\n",
    "is_safe": 1,
    "usage": {
        "prompt_tokens": 5,
        "completion_tokens": 92,
        "total_tokens": 97
    }
}

请求参数

Path 参数

申请发布时填写的API地址

string

必需

Query 参数

access_token

string

必需

通过API Key和Secret Key获取的access_token，参考Access Token获取

Body 参数application/json

prompt

string

请求信息

必需

stream

boolean

可选

是否以流式接口的形式返回数据，默认false

temperature

number

可选

说明：（1）较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定（2）范围 (0, 1.0]，不能为0 （3）建议该参数和top_p只设置1个

top_k

integer

可选

Top-K 采样参数，在每轮token生成时，保留k个概率最高的token作为候选。说明：（1）影响输出文本的多样性，取值越大，生成文本的多样性越强（2）取值范围：正整数

top_p

number

可选

说明：（1）影响输出文本的多样性，取值越大，生成文本的多样性越强（2）取值范围 [0, 1.0] （3）建议该参数和temperature只设置1个

penalty_score

number

可选

通过对已生成的token增加惩罚，减少重复生成的现象。说明：（1）值越大表示惩罚越大（2）取值范围：[1.0, 2.0]

stop

array[string]

可选

生成停止标识。当模型生成结果以stop中某个元素结尾时，停止文本生成。说明：（1）每个元素长度不超过20字符。（2）最多4个元素

user_id

string

可选

表示最终用户的唯一标识符，可以监视和检测滥用行为，防止接口恶意调用

示例

返回响应

🟢200成功

application/json

Body

string

本轮对话的id

必需

object

string

必需

回包类型。 chat.completion：多轮对话返回

created

integer

时间戳

必需

result

string

对话返回结果

必需

need_clear_history

boolean

必需

表示用户输入是否存在安全，是否关闭当前会话，清理历史会话信息 true：是，表示用户输入存在安全风险，建议关闭当前会话，清理历史会话信息 false：否，表示用户输入无安全风险

usage

object

必需

token统计信息，token数 = 汉字数+单词数*1.3 （仅为估算逻辑）

prompt_tokens

integer

问题tokens数

必需

completion_tokens

integer

回答tokens数

必需

total_tokens

integer

tokens总数

必需

修改于 2023-11-16 02:23:00

GPT4All-J

StableLM-Alpha -7B

StarCoder

创建completion#

错误码#

请求参数

返回响应

创建completion

错误码