添加 LLM 配置¶
POST /api/v1/llm_cfg/add
概述¶
创建一个新的 LLM 应用配置,并返回实际生效的 appId 与 clientToken
Body 请求参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| appId | string | 自定义 appId,按字符长度最大 128 个字符;仅支持字母、数字、下划线;不传则自动生成 允许为空: False 允许为空字符串: True $maxCharacterLength: 128 |
|
| jsonContent | json | Y | JSON 格式内容 允许为空: False |
| jsonContent.name | string | Y | 应用名称,同一工作空间内唯一 允许为空: False 最大长度: 256 |
| jsonContent.type | string | Y | 应用类型,当前仅支持 Langfuse允许为空: False 可选值: ['Langfuse'] |
| jsonContent.site | string | 站点地址,例如 https://cloud.langfuse.com允许为空: False |
|
| jsonContent.extend | json | 其他扩展设置,原样存入 jsonContent.extend允许为空: False |
|
| clientToken | string | 自定义 clientToken,不传则自动生成;若传入且系统中已存在,会复用已有 token 记录 允许为空: False 允许为空字符串: True |
参数补充说明¶
接口说明¶
创建新的 LLM 应用配置。
创建规则¶
appId可选,不传时后端自动生成clientToken可选,不传时后端自动生成- 若传
appId,仅支持字母、数字、下划线 - 同一工作空间内,
appId不允许重复 - 同一工作空间内,
jsonContent.name不允许重复
jsonContent 字段说明¶
| 字段 | 说明 |
|---|---|
name |
应用名称,对外展示名 |
type |
应用类型,当前固定为 Langfuse |
site |
站点地址,例如 https://cloud.langfuse.com |
extend |
扩展配置,结构按业务需要透传 |
调用成功后¶
- 会持久化应用配置
- 会为应用绑定或复用
clientToken - 会通知下游 LLM 统计/接入侧刷新应用信息
错误语义¶
ft.InvalidLlmAppId:appId包含非法字符ft.SignNameRepeat:appId重复ft.LlmCfgNameRepeat:应用名称重复
请求例子¶
curl 'https://openapi.guance.com/api/v1/llm_cfg/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"appId":"llm_app_demo","jsonContent":{"name":"Langfuse Prod","type":"Langfuse","site":"https://cloud.langfuse.com","extend":{"service":"prod"}}}' \
--compressed
响应¶
{
"code": 200,
"content": {
"appId": "llm_app_demo",
"createAt": 1690813059,
"creator": "acnt_xxxx32",
"deleteAt": -1,
"id": 1,
"jsonContent": {
"name": "Langfuse Prod",
"type": "Langfuse",
"site": "https://cloud.langfuse.com",
"extend": {
"service": "prod"
}
},
"status": 0,
"updateAt": 1690813059,
"updator": "acnt_xxxx32",
"uuid": "llm_app_demo",
"workspaceUUID": "wksp_xxxx32",
"clientToken": "token_xxx"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-68EEEB4A-9ABC-4DDB-A72B-40F07F2699A5"
}