API文档

请求说明

基本信息

调用本接口，发起一次对话请求。

注意事项

本文接口返回不支持图片内容，图片内容的请求返回会在后续支持，敬请期待！

请求地址：

https://brain-llm-saas.emotibot.com/api/v1/model/chat_completions_stream_endpoint?apiKey={key}

请求方式： POST

Header参数

名称	值
Content-Type	application/json

Query参数

名称	类型	必填	描述
apiKey	String	是	通过apiKey鉴权后调用接口

Body参数

名称	类型	必填	描述
model_uid	String	是	模型对应的uuid
runtime_parameters	runtime_parameters	是	模型生成参数

runtime_parameters说明

名称	类型	描述
max_tokens	Integer	生成结果最长字符限制
top_p	Float	指模型对输出每个词过滤的概率分值
temperature	Float	生成温度，用于控制生成文本的多样性和创造力。数值越低表示越低的随机性。一般来说，temperature越低，适合完成确定性的任务。temperature越高，适合完成创造性的任务。
top_k	Integer	生成采样的最大前n个token
repetition_penalty	Float	重复惩罚，用于控制生成文本中的重复程度。
messages	message[]	对话信息

message说明

名称	类型	描述
role	String	角色，user: 表示用户assistant: 表示对话助手
content	String	对话内容，不能为空

响应说明

名称	类型	描述
code	Integer	响应码，成功返回200
message	String	响应描述，成功返回success
data	data[]	响应返回数据

data说明

名称	类型	描述
delta	delta	返回的content内容
logprobs	String	None
index	Integer	位置信息
finish_reason	String	结束原因

delta说明

名称	类型	描述
content	String	文本内容

请求示例

请求格式

curl --location 'https://brain-llm-saas.emotibot.com/api/v1/model/chat_completions_stream_endpoint?apiKey={key}' \
--header 'Content-Type: application/json' \
--data '{
  "model_uid": "DokGt2E3jLrFWhyOsTcmKCif4RIu790glYanNVzpxSqdevPwbX",
  "runtime_parameters": {
    "temperature": 0.2,
    "max_tokens": 200,
    "top_k": 10,
    "top_p": 0.85,
    "repetition_penalty": 1.2,
    "messages": [{
      "role": "user",
      "content": "你好，北京什么气候"
    },
    {
      "role": "assistant",
      "content": "北京是亚热带气候。"
    },
    {
      "role": "user",
      "content": "那上海呢?"
    }]
  }
}'

响应示例

{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": ""}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "上"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "海"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "属"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "于"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "亚"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "热"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "带"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "海"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "洋"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "性"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "气"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "候"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": "。"}, "logprobs": null, "index": 0, "finish_reason": null}]
}
{
  "code": 200,
  "message": "success",
  "data": [{"delta": {"content": ""}, "logprobs": null, "index": 0, "finish_reason": null}]
}

错误码

错误码	错误信息	描述
200	success	接口调用成功
401	invalid api key	apiKey非法