按指标 code 更新指标定义

POST

/metric:update

根据 URL 里的指标 code 更新指标定义，只允许更新 name、description、unit、prompt、syno。

服务端会先在 yiask_property 中查找同 code 记录；如果命中，则只更新 yiask_property，不再查询 yiask_custom_metric。只有当 yiask_property 未命中时，才会回退查询并更新 yiask_custom_metric。

查询和更新都只作用于当前用户有权限访问的空间。

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

Header 参数

Body 参数application/json必填

示例

更新 Property 指标更新自定义指标

{
    "name": "GMV",
    "description": "成交金额",
    "unit": "元",
    "prompt": "用于分析成交额",
    "syno": [
        "销售额",
        "成交额"
    ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

更新 Property 指标更新自定义指标

curl --location '/metric:update?code=undefined&filterByTk=undefined' \
--header 'X-SPACES: default' \
--header 'X-SPACES: {{space}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "GMV",
    "description": "成交金额",
    "unit": "元",
    "prompt": "用于分析成交额",
    "syno": [
        "销售额",
        "成交额"
    ]
}'

返回响应

🟢200

application/json

更新成功

Bodyapplication/json

示例

命中 yiask_property命中 yiask_custom_metric

{
    "success": true,
    "code": "gmv",
    "updated": {
        "yiask_property": 2,
        "yiask_custom_metric": 0
    },
    "values": {
        "name": "GMV",
        "description": "成交金额",
        "unit": "元",
        "prompt": "用于分析成交额",
        "syno": [
            "销售额",
            "成交额"
        ]
    }
}

🟠400

🟠404

修改于 2026-05-12 01:33:48

获取当前空间的指标视图列表

获取当前用户在 YiAsk 聊天页可见的 AI 员工列表