# 指标管理相关api
# 获取可用的指标列表
通过此接口可以获取能够在项目中使用的指标列表
# 请求路径
【GET】https://nice.zebra-c.com/api/kpi/list
# 请求参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| project_key | string | 是 | 项目唯一标识 |
| page | number | 否 | 当前页数,默认为1 |
| size | number | 否 | 获取条数,默认为10,最大不能超过100 |
# 请求示例
project_key=cf73f51475c9004b9e35c73126f45b9d&page=1&size=10
# 请求 CURL 命令
curl --location --request GET 'https://nice.zebra-c.com/api/kpi/list?project_key=cf73f51475c9004b9e35c73126f45b9d&page=1&size=10' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHBfaWQiOiJOOTkxODA4MjU4IiwiaWF0IjoxNjI5NDU3OTM3fQ.HFKufGC9oLoeNecGEPel_UNP4fFWyYI6Lahz4z1rOuY'
# 成功返回参数( body )
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| kpi_code | string | 是 | 指标ID |
| kpi2 | string | 是 | 指标名称 |
| description | string | 是 | 指标描述 |
| industry_name | string | 是 | 行业名称 |
| brand_name | string | 是 | 品牌名称 |
| group_name | string | 是 | 场景名称 |
| status_name | string | 是 | 状态名称 |
| type_name | string | 是 | 属性名称 |
| attribute_name | string | 是 | 类型名称 |
| platform_name | string | 是 | 所属平台名称 |
| dimension_name | string | 是 | 分析维度名称 |
| created_at | string | 是 | 创建时间 |
| updated_at | string | 是 | 更新时间 |
| create_user_name | string | 是 | 创建用户的用户名 |
| rule | string | 是 | 指标规则(具体说明见下文) |
# 成功返回示例
{
"errcode": 0,
"message": "成功",
"data": {
"total": 1,
"list": [
{
"industry_name": "汽车行业",
"brand_name": "宝马",
"group_name": "汽车体验",
"kpi2": "1",
"kpi_code": "A00000025",
"description": "12",
"type_name": "提及类",
"attribute_name": "标准",
"platform_name": "体验云平台",
"dimension_name": "标签归一化",
"created_at": "2021-07-28 11:02:34",
"updated_at": "2021-07-28 11:02:34",
"status_name": "训练中",
"create_user_name": "gyy",
"rule": "{\"key_word\":{\"\u4ecb\u7ecd\":{\"key_word\":\"\u4ecb\u7ecd\",\"good_pre\":[\"\u5e26\u4f60\",\"\u7ed9\u4f60\",\"\u5e2e\u4f60\",\"\u5e2e\u60a8\",\"\u7ed9\u60a8\",\"\u4e3a\u4f60\",\"\u5e26\u60a8\",\"\u4e3a\u60a8\"]}}}"
}
]
}
}
# 返回参数规则:rule 具体说明
# dimension_name 分析维度为“-”的指标说明
{
"key_word":{
"沟通":{
"key_word":"沟通",//关键词
"bad_pre":["不主动"],//前置负向调性词
"bad_pos":["不顺畅","需要提高"],//后置负向调性词
"good_pre":["主动","积极"],//前置正向调性词
"good_pos":["很好","满意","挺好"],//后置正向调性词
"mid_pre":[],//前置中性调性词
"mid_pos":[]//后置中性调性词
},
"independent":{
"bad_indep":[],//负向独立词
"good_indep":["随时沟通"],//正向独立词
"mid_indep":[]//中性独立词
},
"untreated_tag_list":[],//存放修改之后的码与changetag_words_list对应
"processed_tag_list":[],//存放修改之前的码与untreated_tag_list对应
"changetag_words_list":[],//存放根据什么关键字来修改码与untreated_tag_list,processed_tag_list对应
"delete_retain":[],//delete_retain存放需要互斥的码,两两对应
"filtration_tag":[],//filtration_tag存放不使用模型结果的码
"confused_tag":[],//存放只在当前句找调性词的码
"short_filter":[],//存放正则过滤短句
"long_filter":[],//存放正则过滤长句
"regex":[],//存放根据正则表达式编码规则
"rule9":[]//暂时未使用,占位
}
}
# dimension_name 分析维度为“标准分析”/“标签归一化”/“关联场景挖掘”的指标说明
- 标准分析
无规则
- 标签归一化
{
"nomalization_rule": [
{
"first_label": "产品体验", //一级指标
"second_label": "口味体验", //二级指标
"third_label": "整体口味", //三级指标
"seed_word": "口味/味道", //判断三级指标的种子词,以'/'分割
"des": "" //指标描述
},
{
"first_label": "产品体验",
"second_label": "口味体验",
"third_label": "膻味",
"seed_word": "膻味",
"des": ""
}
]
}
- 关联场景挖掘
{
"scene_rule": [
{
"first_label": "人群",//一级指标
"second_label": "性别",//二级指标
"seed_word": "男人/女人"//指标判断的种子词,以'/'分割
},
{
"first_label": "人群",
"second_label": "人生阶段",
"seed_word": "婴幼儿/宝宝/孩子/小孩/青少年/少年/成年人/中年人/中老年/老年人/老人/学生"
}
]
}