1 请求参数
model可选值:
spark-x2.6 / spark-x2.6-4b / spark-x2.6-preview / spark-x2.5 / spark-x2.5-4b / spark-x2.5-1.7b本次请求使用的 model。
user可选值:建议仅使用
a-z、A-Z、0-9、-、_,最大 512 字符业务侧自定义的终端用户标识,可用于区分不同用户。请勿传入用户隐私信息。
messages可选值:至少包含 1 条消息
对话消息列表,按时间顺序组成当前会话上下文。
role可选值:
system / user / assistant / tool消息的发起角色。
content可选值:字符串或 Content Part 数组
消息内容。字符串表示纯文本;数组形式当前仅支持
type=text 的文本内容。type可选值:
textContent Part 类型,当前仅支持文本。
stream可选值:
true / false默认值:
false是否开启流式输出。设为
true 时,服务端通过 SSE 持续返回消息增量,并以 data: [DONE] 结束。max_tokens可选值:正整数,
< 256K该字段已废弃,仅用于兼容旧版调用,请改用
max_completion_tokens。max_completion_tokens可选值:正整数;实际上限受模型上下文长度和最大输出长度限制
单次 completion 可生成的 Token 数上限,包括最终可见输出 Token 和推理过程中使用的 reasoning tokens。
temperature可选值:
1默认值:
1固定值
1 生效,建议不要显式传入该参数。top_p可选值:
0.95默认值:
0.95固定值
0.95 生效,建议不要显式传入该参数。presence_penalty该参数已不再支持。传入该参数将不会产生任何效果。
frequency_penalty该参数已不再支持。传入该参数将不会产生任何效果。
tool_choice可选值:
none / auto / required / 指定函数对象 / allowed_tools 对象默认值:未提供
tools 时为 none;提供 tools 时为 auto控制模型是否调用工具以及调用哪些工具。
tools可选值:最多 128 个工具;支持
function / web_search模型可调用的工具列表。
type可选值:
function / web_search工具类型。自定义函数使用
function;内置网络搜索使用 web_search。functionFunction Calling 的函数定义。
name可选值:仅允许字母、数字、
_、-,最大 64 字符要调用的 Function 名称。
descriptionFunction 的功能说明,用于帮助模型判断何时以及如何调用该函数。
parameters可选值:JSON Schema object
Function 的输入参数定义。省略时表示该 Function 不要求输入参数。
required可选值:JSON Schema 字段名数组
指定 Function 调用时必须生成的参数字段。
web_search当
tools[].type=web_search 时使用。enable可选值:
true / false网络搜索开关。
thinking深度思考控制配置。
type可选值:
enabled / disabled / auto默认值:
enabled控制思考模式。
enabled 强制开启,disabled 强制关闭,auto 由模型自行判断;其中 auto 为本服务扩展取值。2 调用示例
bash
curl https://maas-api.cn-huabei-1.xf-yun.com/v2/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $APIKEY" \
-d '{
"model": "spark-x2.6",
"messages": [
{"role": "user", "content": "你好。"}
],
"stream": false
}'python
import requests
response = requests.post(
"https://maas-api.cn-huabei-1.xf-yun.com/v2/chat/completions",
headers={
"Authorization": "Bearer <你的 APIKEY>",
"Content-Type": "application/json",
},
json={
"model": "spark-x2.6",
"messages": [{"role": "user", "content": "你好。"}],
"stream": False,
},
)
print(response.json())go
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
)
func main() {
body := map[string]any{
"model": "spark-x2.6",
"messages": []map[string]string{
{"role": "user", "content": "你好。"},
},
"stream": false,
}
data, err := json.Marshal(body)
if err != nil {
panic(err)
}
req, err := http.NewRequest(
http.MethodPost,
"https://maas-api.cn-huabei-1.xf-yun.com/v2/chat/completions",
bytes.NewReader(data),
)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer <你的 APIKEY>")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
result, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(result))
}javascript
const response = await fetch("https://maas-api.cn-huabei-1.xf-yun.com/v2/chat/completions", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.APIKEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
model: "spark-x2.6",
messages: [{ role: "user", content: "你好。" }],
stream: false,
}),
});
console.log(await response.json());3 响应
3.1 非流式
code可选值:
0 表示成功,非 0 表示错误业务错误码;发生业务错误时使用。
message业务错误描述信息。
id本次 Chat Completion 的唯一标识。
object可选值:固定为
chat.completion响应对象类型。
created可选值:Unix 时间戳,单位为秒
Chat Completion 的创建时间。
model实际用于生成 completion 的模型 ID。
choices模型生成的 completion 结果列表。
index可选值:
>= 0当前 completion 在
choices 中的索引。finish_reason可选值:
stop / length / tool_calls模型停止生成的原因:自然结束、达到长度限制,或模型生成了工具调用。
message模型生成的 assistant 消息。
role可选值:固定为
assistant生成消息的角色。
content模型最终生成的正文内容。工具调用场景下可能为空。
reasoning_content思考模式下,在最终答案之前生成的推理内容。
tool_calls模型生成的工具调用列表。
id工具调用 ID。
type可选值:固定为
function工具调用类型。
function.name模型选择调用的 Function 名称。
function.arguments可选值:JSON 字符串
模型生成的 Function 调用参数。执行 Function 前应由调用方校验 JSON 和参数合法性。
usage本次请求的 Token 使用统计。
prompt_tokens可选值:
>= 0输入消息消耗的 Token 数。
prompt_tokens_details输入 Token 的详细统计。
cached_tokens可选值:
>= 0输入中命中缓存的 Token 数。
completion_tokens可选值:
>= 0模型生成 completion 消耗的 Token 数。
completion_tokens_detailscompletion Token 的详细统计。
reasoning_tokens可选值:
>= 0思考模式产生的推理 Token 数。
total_tokens可选值:
>= 0输入 Token 与输出 Token 的总和。
3.2 流式
code可选值:
0 表示成功,非 0 表示错误业务错误码;发生业务错误时使用。
message业务错误描述信息。
id本次 Chat Completion 的唯一标识,同一次流式请求中的 chunk 使用同一请求标识。
object可选值:固定为
chat.completion.chunk流式响应对象类型。
created可选值:Unix 时间戳,单位为秒
当前 chunk 的创建时间。
model实际用于生成 completion 的模型 ID。
choices当前流式 chunk 中的 completion 增量列表。
delta当前流式结果增量。
role可选值:
assistant / null生成消息的角色,通常在首个 chunk 中返回。
reasoning_content思考模式下的推理内容增量。
content最终正文内容增量。
index可选值:
>= 0当前 completion 在
choices 中的索引。finish_reason可选值:
stop / length / tool_calls / null生成过程中通常为
null;生成结束时支持 stop、length 或 tool_calls。usageToken 使用统计,通常在结束阶段返回。
prompt_tokens可选值:
>= 0输入 Token 数。
prompt_tokens_details输入 Token 详细统计。
cached_tokens可选值:
>= 0输入中命中缓存的 Token 数。
completion_tokens可选值:
>= 0输出 Token 数。
completion_tokens_detailscompletion Token 详细统计。
reasoning_tokens可选值:
>= 0思考模式产生的推理 Token 数。
total_tokens可选值:
>= 0输入 Token 与输出 Token 的总和。