根式嵌入模型创建后端¶
保存嵌入模型后端配置并取得新后端 ID。
POST https://api.moi.matrixorigin.cn/v5/embedding/backends
调用前准备¶
BASE_URL 使用产品 API 前缀 https://api.moi.matrixorigin.cn/v5;专有部署填写对应的产品 API 地址。
请求¶
curl --request POST \
"$BASE_URL/embedding/backends" \
--header "X-API-Key: $MOI_KEY" \
--header "X-Workspace-ID: $WORKSPACE_ID" \
--header "Content-Type: application/json" \
--data-raw '{"name":"临时后端","type":"OPENAI","api_key":"provider-key-example","models":["bge-m3"],"address":"https://provider.example.invalid/v1"}'
参数 |
位置 |
类型 |
必填 |
说明 |
|---|---|---|---|---|
|
请求头 |
string |
是 |
同环境工作区 ID。 |
|
请求体 |
string |
是 |
去掉前后空白后的非空名称。 |
|
请求体 |
string |
否 |
OPENAI/OLLAMA/VLLM/QIANWEN/DOUBAO/DEV_LLM/HTTP;省略或非法按 OPENAI,Embedding 拒绝 DEV_LLM。 |
|
请求体 |
string |
条件必填 |
OPENAI/QIANWEN/DOUBAO 必填;与 MOI_KEY 分开。 |
|
请求体 |
array(字符串数组) |
是 |
至少一项有效模型名。 |
|
请求体 |
integer |
否 |
正数秒值;省略或非正按 30。 |
|
请求体 |
string |
否 |
LLM 推理控制协议;省略为 NONE,Embedding 不用于推理控制。 |
|
请求体 |
string |
否 |
Embedding 非空地址可同时建端点;LLM 此创建动作忽略地址,需另建端点。 |
需要工作区 model_backend.create。保存返回 id 后再读详情和端点;配置不验证模型连通性或推理能力。普通工作区式创建不自动创建端点;DEV 适配器存在特殊内部行为,不作为生产接入方式。
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"id": 12,
"name": "临时后端",
"type": "OPENAI",
"timeout_seconds": 30,
"models": [
"bge-m3"
],
"created_at": 1794445200,
"updated_at": 1794445200,
"reasoning_control_protocol": "REASONING_CONTROL_NONE",
"endpoints": [
{
"id": 21,
"backend_id": 12,
"address": "https://provider.example.invalid/v1",
"status": "ONLINE",
"created_at": 1794445200,
"updated_at": 1794445200
}
]
}
}
HTTP 200。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功OK。 |
|
string |
成功为 OK。 |
|
object |
错误响应¶
错误与结果确认按两套协议区分。省略字段、SDK 零值和 HTTP 空响应分别解析,写后使用对应读取动作确认。
最后更新于