# 项目管理相关api

大体流程如下

# 创建项目

云平台可以调用此接口进行项目的创建。

# 请求路径

【POST】https://nice.zebra-c.com/api/project/create (opens new window)

# 请求参数

参数	类型	必须	说明
project_name	string	是	参数支持中文，数字，英文字母大小写，下划线"_"，中横线"-"，&符号，中英文的小括号；长度100字符
data_type	int	是	项目数据类型：1单角色语音、2多角色语音、3单角色文本、4多角色文本

# 请求示例

{     
    "project_name": "测试项目名称1", 
    "data_type": 1
}

# 请求CURL命令

curl --location --request POST 'https://nice.zebra-c.com/api/project/create' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ "project_name"="项目名称1-测试项目a","data_type"=1 }';

# 成功返回参数（body）

参数	类型	必须	说明
project_key	string	是	生成的项目ID

# 成功返回示例

{ 
    "errcode": 0,
    "message":"成功",
    "data": {
        "project_key":"81134d28006c2b92830c4de3335cfc45b54cfd32"
    }
 }

# 修改项目名称

云平台可以调用此接口对项目名称进行修改。

# 请求路径

【POST】https://nice.zebra-c.com/api/project/modify (opens new window)

# 请求参数

参数	类型	必须	说明
project_key	string	是	项目key标识
project_name	string	是	参数支持中文，数字，英文字母大小写，下划线"_"，中横线"-"，&符号，中英文的小括号；长度100字符

# 请求示例

{     
    "project_key": "81134d28006c2b92830c4de3335cfc45b54cfd32", 
    "project_name": "测试项目名称1", 
}

# 请求CURL命令

curl --location --request POST 'https://nice.zebra-c.com/api/project/modify' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ "project_key"="81134d28006c2b92830c4de3335cfc45b54cfd32","project_name"="项目名称1-测试项目a" }';

# 成功返回参数（body）

参数	类型	必须	说明
project_key	string	是	返回项目key
project_name	string	是	修改后的项目名称

# 成功返回示例

{ 
    "errcode": 0,
    "message":"成功",
    "data": {
        "project_key":"81134d28006c2b92830c4de3335cfc45b54cfd32",
        "project_name":"修改后的项目名称"
    }
 }

# 获取项目列表

云平台可以调用此接口获取在NICE综合管理平台含有的项目列表。

# 请求路径

【POST/GET】https://nice.zebra-c.com/api/project/list (opens new window)

# 请求参数

无

# 请求示例

{ }

# 请求 CURL 命令

curl --location --request GET 'https://nice.zebra-c.com/api/project/list' \
--header 'Content-Type: application/json'

# 成功返回参数（body）

参数	类型	必须	说明
project_key	string	是	项目ID
project_name	string	是	项目名称

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": [
        { 
            "project_name": "项目1", 
            "project_key": "fe22f61668123284c3e86b34edd7b011fe6b2fd3" 
        }, 
        { 
            "project_name": "项目2", 
            "project_key": "81134d28006c2b92830c4de3335cfc45b54cfd32" 
        },
    ]
 }

# 获取项目可用执行方式

云平台可以调用此接口获取在NICE综合管理平台可用执行方式，该执行方式列表为项目提供执行方式选项。

# 请求路径

【POST/GET】https://nice.zebra-c.com/api/project/executeModeList (opens new window)

# 请求参数

无

# 请求示例

{}

# 请求CURL命令

curl --location --request GET 'https://nice.zebra-c.com/api/project/executeModeList' \ 
--header 'Content-Type: application/json'

# 成功返回参数（body）

参数	类型	必须	说明
id	int	是	执行方式ID
name	string	是	执行方式名称

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": [
        { "id": 1, "name": "ASR+ASR复核" }, 
        { "id": "2", "name": "NLP" },
    ] 
}

# 设置项目使用执行方式

云平台可以调用此接口设定项目使用执行方式，a，通过项目列表接口获取项目project_key信息；b，通过执行方式列表接口获取可用执行方式id。

# 请求路径

【POST】https://nice.zebra-c.com/api/project/executeModeSet (opens new window)

# 请求参数

参数	类型	必须	说明
project_key	string	是	项目列表中返回的项目ID标识
execute_id	int	是	项目可用执行方式列表中返回的执行方式ID标识

# 请求示例

{ "project_key":"7pmb23ff206f61501c61768fdhc5c09eq6c354c5", "execute_id":2 }

# 请求CURL 命令

curl --location --request POST 'https://nice.zebra-c.com/api/project/executeModeSet' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ "project_key"="b9bb233f296f61b01c63768fd5c5c09ef6c354c4" , "execute_id"=1 }'

# 成功返回参数（body）

参数	类型	必须	说明

# 成功返回示例

{ "errcode": 0, "message": "成功", "data": [] }

# 设置项目使用指标

云平台可以调用此接口设定项目使用指标，a，通过"可用指标列表"接口获取项目可使用的指标信息；b，然后设定指定项目应用的指标集合。请求成功则返回该项目当前使用中的指标列表，失败则返回失败原因。

# 请求路径

【POST】https://nice.zebra-c.com/api/project/kpiSet (opens new window)

# 请求参数

参数	类型	必须	说明
project_key	string	是	项目列表中返回的项目ID标识
kpi_code_list	array	是	项目可用指标列表中kpi_code字段组合的数组，如["A00000025","A00000026"]

# 请求示例

{ "project_key":"7pmb23ff206f61501c61768fdhc5c09eq6c354c5", "kpi_code_list":["A00000025","A00000026"] }

# 请求 CURL命令

curl --location --request POST 'https://nice.zebra-c.com/api/project/kpiSet' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ "project_key"="b9bb233f296f61b01c63768fd5c5c09ef6c354c4" , "kpi_code_list"=["A00000025","A00000026"] }'

# 成功返回参数（body）

参数	类型	必须	说明
kpi2	string	是	返回项目当前使用指标的指标名称
kpi_code	string	是	返回项目当前使用指标的指标编码
description	string	是	返回项目当前使用指标的指标描述

# 成功返回示例

{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "kpi2": "指标名称示例2",
            "kpi_code": "A00000013",
            "description": "指标描述示例2"
        },
        {
            "kpi2": "指标名称示例6",
            "kpi_code": "A00000017",
            "description": "指标描述示例6"
        },
        {
            "kpi2": "指标名称示例8",
            "kpi_code": "A00000019",
            "description": "指标描述示例8"
        },
        {
            "kpi2": "指标名称示例3",
            "kpi_code": "A00000014",
            "description": "指标描述示例3"
        }
    ]
}

# 获取项目使用中指标

云平台可以调用此接口获取当前项目使用中的指标列表。

# 请求路径

【GET】https://nice.zebra-c.com/api/project/kpiList (opens new window)

# 请求参数

参数	类型	必须	说明
project_key	string	是	项目列表中返回的项目ID标识
version	string	否	版本，最新1.1（默认），可选：1.1，1.0

# 请求示例

{ "project_key":"7pmb23ff206f61501c61768fdhc5c09eq6c354c5" }

# 请求 CURL命令

curl --location --request POST 'https://nice.zebra-c.com/api/project/kpiList?project_key=7d3c538a20cad9f62e146b1227b0b5f968540618' \ 
--header 'Content-Type: application/json' \

# 成功返回参数（body）V1.1

参数	类型	必须	说明
rule	string	是	指标规则（具体说明见示例）
kpi_list	array	是	命中指标数组（具体说明见示例）
long_filter	array	否	长过滤码
short_filter	array	否	短过滤码
delete_retain	array	否	删除码&保留码
filtration_tag	array	否	过滤码
processed_tag_list	array	否	改变后码
untreated_tag_list	array	否	改变前码
changetag_words_list	array	否	改变码关键词

# 成功返回示例V1.1

{
  "errcode": 0,
  "message": "成功",
  "data": {
    "long_filter": [],
    "short_filter": [],
    "delete_retain": [],
    "filtration_tag": [],
    "processed_tag_list": [],
    "untreated_tag_list": [],
    "changetag_words_list": [],
    "rule": [
      {
        "kpi_code": "P00004594",
        "source_code": "A00003499",
        "code_attributes": "mention",
        "version": 1.1,
        "find_length": 2,
        "key_word": [
          {
            "key_id": 1,
            "key_word": [
              "测试15",
              "人员",
              "客户"
            ],
            "good_pre": [
              "测试20",
              "测试17",
              "测试"
            ],
            "good_pos": [
              "测试18",
              "不满"
            ]
          },
          {
            "key_id": 2,
            "key_word": [
              "客户",
              "人员",
              "测试15"
            ],
            "good_pre": [
              "测试20",
              "测试",
              "测试17"
            ],
            "good_pos": [
              "不满",
              "测试18"
            ]
          },
          {
            "key_id": 4,
            "key_word": [
              "客户",
              "测试15",
              "人员"
            ],
            "good_pre": [
              "测试",
              "测试17",
              "测试20"
            ],
            "good_pos": [
              "测试18",
              "不满"
            ]
          },
          {
            "key_id": 5,
            "key_word": [
              "客户",
              "人员",
              "测试15"
            ],
            "good_pre": [
              "测试",
              "测试17",
              "测试20"
            ],
            "good_pos": [
              "测试18",
              "不满"
            ]
          },
          {
            "key_id": 7,
            "key_word": [
              "人员",
              "客户",
              "测试15"
            ],
            "good_pre": [
              "测试17",
              "测试",
              "测试20"
            ],
            "good_pos": [
              "测试18",
              "不满"
            ]
          },
          {
            "key_id": 8,
            "key_word": [
              "客户",
              "人员",
              "测试15"
            ],
            "good_pre": [
              "测试",
              "测试17",
              "测试20"
            ],
            "good_pos": [
              "测试18",
              "不满"
            ]
          },
          {
            "key_id": 10,
            "key_word": [
              "客户",
              "测试15",
              "人员"
            ],
            "good_pre": [
              "测试",
              "测试20",
              "测试17"
            ],
            "good_pos": [
              "测试18",
              "不满"
            ]
          },
          {
            "key_id": 11,
            "key_word": [
              "测试15",
              "人员",
              "客户"
            ],
            "good_pre": [
              "测试20",
              "测试17",
              "测试"
            ],
            "good_pos": [
              "测试18",
              "不满"
            ]
          }
        ],
        "independent": {
          "good_indep": [
            "此问题得不到解决",
            "此问题未得到解决",
            "要求投诉"
          ]
        }
      },
      {
        "kpi_code": "P00004596",
        "source_code": "A00000269",
        "code_attributes": "mention",
        "version": 1.1,
        "find_length": 2,
        "key_word": [
          {
            "key_id": 3,
            "key_word": [
              "联系"
            ],
            "good_pre": [
              "号码"
            ],
            "good_pos": [
              "电话",
              "号码"
            ]
          },
          {
            "key_id": 6,
            "key_word": [
              "联系"
            ],
            "good_pre": [
              "号码"
            ],
            "good_pos": [
              "电话",
              "号码"
            ]
          },
          {
            "key_id": 9,
            "key_word": [
              "联系"
            ],
            "good_pre": [
              "号码"
            ],
            "good_pos": [
              "号码",
              "电话"
            ]
          },
          {
            "key_id": 12,
            "key_word": [
              "联系"
            ],
            "good_pre": [
              "号码"
            ],
            "good_pos": [
              "电话",
              "号码"
            ]
          }
        ],
        "independent": {
          "good_indep": [
            "联系方式",
            "手机号码",
            "联系的电话",
            "联系的手机",
            "来电电话",
            "来电手机",
            "手机号"
          ]
        }
      }
    ],
    "kpi_list": [
      {
        "kpi2": "测试万能指标（情感）",
        "kpi_code": "P00004593",
        "description": "测试万能指标（情感）",
        "source_code": "A00003971",
        "industry_name": "汽车行业",
        "brand_name": "公共测试",
        "group_name": "公共测试场景",
        "status_name": "训练中",
        "type_name": "情感极向",
        "attribute_name": "个性",
        "platform_name": "汽车体验云demo",
        "dimension_name": null,
        "created_at": "2022-04-22 14:16:48",
        "updated_at": "2022-04-22 14:23:11",
        "create_user_name": "niceadmin"
      }
    ]
  }
}

# 成功返回参数（body）V1.0

参数	类型	必须	说明
kpi2	string	是	返回项目当前使用指标的指标名称
kpi_code	string	是	返回项目当前使用指标的指标编码
source_code	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	是	指标规则（具体说明见下文）

# 成功返回示例V1.0

{
    "errcode": 0,
    "message": "成功",
    "data": [
        {

            "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\"]}}}"
        },
        {

            "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\"]}}}"
        },
    ]
}

# 获取云平台可用指标场景列表

云平台可以调用此接口获取该平台可用场景的列表信息，通过将场景信息作为参数，可以调用指标创建接口创建指标。

# 请求路径

【GET】https://nice.zebra-c.com/api/project/groupList (opens new window)

# 请求参数

无

# 请求示例

{ }

# 请求CURL 命令

curl --location --request GET 'https://nice.zebra-c.com/api/project/groupList' \ 
--header 'Content-Type: application/json'

# 成功返回参数（body）

参数	类型	说明
group_key	string	场景key，创建指标时传参使用
group_name	string	场景名称
brand_name	string	场景所属品牌名称

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": [
        { "group_key": "场景key，用于创建指标时传参", "group_name": "场景名称", "brand_name":"所属品牌名称" }, 
        { "group_key": "2j6Ko8", "group_name": "电冰箱售后" , "brand_name":"所属品牌名称"},
    ]
 }

# 云平台创建指标

云平台可以调用此接口创建指标。（注：需要该云平台开通“训练平台”能力）

# 请求路径

【POST】https://nice.zebra-c.com/api/project/kpiCreate (opens new window)

# 请求参数

参数	类型	必须	说明
group_key	string	是	获取场景接口返回数据的group_key属性
type	int	是	指标属性：1，提及类；2，数值类；3，情感极向
kpi2	string/int	是	指标名称，长度限制1~20
description	string	是	指标描述信息，长度1~100
dimension	int	否	指标分析维度，范围：1默认，2标准分析，3标签归一化，4关联场景挖掘

# 请求示例

{ "group_key":"2j6Ko9", "type":1, "kpi2":"指标名称", "description":"指标描述信息" }

# 请求CURL 命令

curl --location --request POST 'https://nice.zebra-c.com/api/project/kpiCreate' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ "group_key"="2j6Ko9" , "type"=1, "kpi2"="指标名称", "description"="指标描述", }'

# 成功返回参数（body）

参数	类型	必须	说明
kpi_code	string		返回创建指标的指标编码

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": { "kpi_code": "A00000149","kpi2": "指标名称" }
 }

# 云平台批量创建指标

云平台可以调用此接口批量创建指标。（注：需要该云平台开通“训练平台”能力）

# 请求路径

【POST】https://nice.zebra-c.com/api/project/kpiBatchCreate (opens new window)

# 请求参数

参数	类型	必须	说明
kpi_list	array	是	批量创建的指标数组,数组内对象的group_key,type,kpi2,description,dimension等字段含义请参见：【云平台批量创建指标】接口

# kpi_list数组内内容

[
  { "group_key":"2j6Ko9", "type":1, "kpi2":"指标名称1", "description":"指标描述信息1" }, 
  { "group_key":"2j6Ko1", "type":1, "kpi2":"指标名称2", "description":"指标描述信息2" }
]

# 请求示例

[{ "group_key":"2j6Ko9", "type":1, "kpi2":"指标名称", "description":"指标描述信息" },{ "group_key":"2j6Ko9", "type":1, "kpi2":"指标名称", "description":"指标描述信息" }]

# 请求CURL 命令

curl --location --request POST 'https://nice.zebra-c.com/api/project/kpiBatchCreate' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{"kpi_list":[
  
  {"group_key":"2j6KpX","type":1,"kpi2":"指标名称1","description":"指标描述","dimension":1},
  {"group_key":"2j6KpX","type":1,"kpi2":"指标名称2","description":"指标描述","dimension":1},
  {"group_key":"2j6KpX","type":1,"kpi2":"指标名称3","description":"指标描述","dimension":1},
  {"group_key":"2j6KpX","type":1,"kpi2":"指标名称4","description":"指标描述","dimension":1},
  {"group_key":"2j6KpX","type":1,"kpi2":"指标名称5","description":"指标描述","dimension":1},
  {"group_key":"2j6KpX","type":1,"kpi2":"指标名称6","description":"指标描述","dimension":1}
  
]}'

# 成功返回示例

{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "kpi_code": "A00006203",
            "kpi2": "指标名称1"
        },
        {
            "kpi_code": "A00006204",
            "kpi2": "指标名称2"
        },
        {
            "kpi_code": "A00006205",
            "kpi2": "指标名称3"
        },
        {
            "kpi_code": "A00006206",
            "kpi2": "指标名称4"
        },
        {
            "kpi_code": "A00006207",
            "kpi2": "指标名称5"
        },
        {
            "kpi_code": "A00006208",
            "kpi2": "指标名称5"
        }
    ]
}

# 获取项目使用中指标规则

云平台可以调用此接口获取项目或指定指标的规则信息。（注：需要该云平台开通“训练平台”能力）

# 请求路径

【GET】https://nice.zebra-c.com/api/kpi/ruleInfo (opens new window)

# 请求参数

参数	类型	必须	说明
project_key	string	否	获取项目下指标规则数组
kpi_code	string	否	获取项目下指定指标的规则数组

# 请求示例

{}

# 请求CURL 命令

curl --location --request GET 'https://nice.zebra-c.com/api/project/kpiCreate?project_key=xxx&kpi_code=xxx'

# 成功返回参数（body）

参数	类型	必须	说明
rule	array		返回指标规则

# 成功返回示例

{
    "errcode": 0,
    "message": "成功",
    "data": {
        "rule": [
            {   ##注：此为情感类规则格式
                "kpi_code": "P00000244", ##指标编码
                "code_attributes": "emotion", ##类型标识：emotion（情感），mention（提及），value_extract（数值提取）
                "version": 1.1, ##版本信息，不需要调整
                "find_length": 2, ## 前后置词作用范围，默认值2
                "key_word": [ ## 关键词对象列表数组
                    {  ##关键词对象
                        "key_word": [
                            "买车",
                            "买票"
                        ],
                        "bad_pre": [], ## 负向前置
                        "bad_pos": [], ## 负向后置
                        "good_pre": [  ## 正向前置
                            "近期",
                            "什么时间",
                            "什么时候"
                        ],
                        "good_pos": [  ## 正向后置
                            "近期",
                            "什么时间",
                            "什么时候"
                        ],
                        "mid_pre": [], ## 中立前置
                        "mid_pos": []  ## 中立后置
                    }
                ],
                "independent": {  ## 独立词
                    "bad_indep": [],   ##负向独立词
                    "good_indep": [    ##正向独立词
                        "更新内容",
                        "更新2"
                    ],
                    "mid_indep": []    ##中立独立词
                }
            },
            {   ##注：此为提及类规则格式【内容类情感，key_word下只需要good_pre，good_pos，independent下通常只需要修改good_indep】
                "kpi_code": "P00000244",
                "code_attributes": "mention",
                "version": 1.1,
                "find_length": 2,
                "key_word": [
                    {
                        "key_word": [
                            "买车"
                        ],
                        "good_pre": [
                            "近期",
                            "什么时间",
                            "什么时候"
                        ],
                        "good_pos": [
                            "近期",
                            "什么时间",
                            "什么时候"
                        ]
                    },
                    {
                        "key_word": [
                            "卖车"
                        ],
                        "good_pre": [
                            "近期",
                            "什么时间",
                            "什么时候"
                        ],
                        "good_pos": [
                            "近期",
                            "什么时间",
                            "什么时候"
                        ]
                    }
                ],
                "independent": {
                    "bad_indep": [],
                    "good_indep": [
                        "更新内容",
                        "更新2"
                    ],
                    "mid_indep": []
                }
            },
            {   ##注：此为数值提取规则格式
                "kpi_code": "10103",
                "code_attributes": "value_extract",
                "version": 1.1,
                "find_length": 2,
                "regex_extractor": [ ##正则判断
                    "定位词_数值_单位",
                    "单位_数值_定位词"
                ],
                "locate_word": [ ## 实体词
                    [
                        "词1",
                        "词2"
                    ],
                    [
                        "词1",
                        "词2"
                    ]
                ],
                "unit": [  ## 单位
                    [
                        "单位1",
                        "单位2"
                    ],
                    [
                        "单位1",
                        "单位2"
                    ]
                ]
            }
        ]
    }
}

# 同步保存指标规则

云平台可以调用此接口更新项目指标规则，云平台的指标池指标规则。

# 请求路径

【POST】 https://nice.zebra-c.com/api/kpi/ruleSave

# 请求参数

参数	类型	必须	说明
project_key	string	是	关键热词所属项目
rule	json	是	json格式的数组
sync	int	是	同步规则：1同步到项目指标，2同步到云平台指标池指标

# 请求示例

{
    "project_key":"6ecc17750bf3e9b",
    "rule":'[{"kpi_code":"P00000244","code_attributes":"emotion","version":1.1,"find_length":2,"key_word":[{"key_word":["买车","买票","购票"],"bad_pre":[],"bad_pos":[],"good_pre":["近期","什么时间","什么时候"],"good_pos":["近期","什么时间","什么时候"],"mid_pre":[],"mid_pos":[]}],"independent":{"bad_indep":[],"good_indep":["更新内容","更新2"],"mid_indep":[]}}]',
    "sync":1
}

# 请求CURL 命令

curl -X POST \
  https://nice.zebra-c.com/api/kpi_rule/save \
  -H 'cache-control: no-cache' \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -H 'postman-token: 9191aa33-c6c4-dbfe-e502-f61d3230f805' \
  -F project_key=33a5d3f7f9462166d9a489f74f0de90fec0b2c5a \
  -F 'rule=[{"kpi_code":"P00000244","code_attributes":"emotion","version":1.1,"find_length":2,"key_word":[{"key_word":["买车","买票","购票"],"bad_pre":[],"bad_pos":[],"good_pre":["近期","什么时间","什么时候"],"good_pos":["近期","什么时间","什么时候"],"mid_pre":[],"mid_pos":[]}],"independent":{"bad_indep":[],"good_indep":["更新内容","更新2"],"mid_indep":[]}}]' \
  -F sync=2

# 成功返回参数（body）

参数	类型	必须	说明
error	array		返回有错误的数据的指标code及错误原因

# 成功返回示例

error信息回返回无法更新的指标code及对应的失败原因，正常时该信息为[]空数组
{ 
  "errcode": 0, 
  "message": "成功", 
  "data": { "error": [] }
 }

# 新增或修改项目关键热词

云平台可以调用此接口新增或修改关键热词。

# 请求路径

【POST】 https://nice.zebra-c.com/api/project/saveKeywords

# 请求参数

参数	类型	必须	说明
project_key	string	是	关键热词所属项目
keyword_list	array	是	数组，详情参见如下示例

# keyword_list示例

[    //keyword关键词典。search_word词典值，多个词用英文逗号分隔。
     { "keyword":"方便", "search_word":"便利,简单,不麻烦" },
     { "keyword":"快速", "search_word":"很快,快速,挺快" }
]

# 请求示例

{
    "project_key":"6ecc17750bf3e9b",
    "keyword_list":[
         { "keyword":"方便", "search_word":"便利,简单,不麻烦" },
         { "keyword":"快速", "search_word":"很快,快速,挺快" }
    ]
}

# 请求CURL 命令

curl --location --request POST 'https://nice.zebra-c.com/api/project/saveKeywords' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ "project_key":"6ecc17750bf3e9b", "keyword_list":[ { "keyword":"方便", "search_word":"便利,简单,不麻烦" },{ "keyword":"快速", "search_word":"很快,快速,挺快" }] }'

# 成功返回参数（body）

参数	类型	必须	说明
message	string		返回有错误的数据的行号

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": {
            "message": "keyword_list中第2行的数据错误，保存失败"
        }
    }
 }

# 删除项目关键热词

云平台可以调用此接口删除关键热词。

# 请求路径

【POST】 https://nice.zebra-c.com/api/project/deleteKeywords

# 请求参数

参数	类型	必须	说明
project_key	string	是	关键热词所属项目
keywords	array	是	数组，由关键词典组成的数组

# 请求示例

{
    "project_key":"6ecc17750bf3e9b",
    "keywords":["方便","快速"]
}

# 请求CURL 命令

curl --location --request POST 'https://nice.zebra-c.com/api/project/deleteKeywords' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ "project_key":"6ecc17750bf3e9b", "keywords":["方便", "快速"] }'

# 成功返回参数（body）

参数	类型	必须	说明
message	string		返回有错误的数据的行号

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": {
            "message": "keywords中第2行的数据错误，删除失败"
        }
    }
 }

# 设置项目使用平台关键热词

云平台可以调用此接口设置项目开启热词配置，启用云平台热词及使用哪些关键词。

# 请求路径

【POST】 https://nice-train.zebra-c.com/api/platform/applyKeywords

# 请求参数

参数	类型	必须	说明
project_key	string	是	项目的ID
keyword_list	array	是	数组，由关键词典组成的数组

# 请求示例

{
    "project_key": "6ecc17750bf3e9b",
    "keyword_list":["方便","快速"]
}

# 请求CURL 命令

curl --location --request POST 'https://nice-train.zebra-c.com/api/platform/applyKeywords' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{"project_key":"6ecc17750bf3e9b","keyword_list":["方便","快速"]}'

# 成功返回参数（body）

参数	类型	必须	说明
message	string

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": {}
 }

# 获取项目关键热词列表

云平台可以调用此接口获取项目关键热词列表。

# 请求路径

【POST】 https://nice.zebra-c.com/api/project/getKeywords

# 请求参数

参数	类型	必须	说明
project_key	string	是	关键热词所属项目

# 请求示例

{
    "project_key":"6ecc17750bf3e9b"
}

# 请求CURL 命令

curl --location --request POST 'https://nice.zebra-c.com/api/project/getKeywords' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ "project_key":"6ecc17750bf3e9b" }'

# 成功返回参数（body）

参数	类型	说明
keyword	string	关键词典
search_word	string	词典值
created_at	string	生成时间

# 成功返回示例

{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "keyword": "方便",
            "search_word": "便利,简单,不麻烦",
            "created_at": "2021-12-02 16:07:15"
        },
        {
            "keyword": "诚实",
            "search_word": "守信用,诚实,真诚",
            "created_at": "2021-12-06 15:42:49"
        }
    ]
}

# 新增或修改平台热词

云平台可以调用此接口新增或修改平台关键热词。

# 请求路径

【POST】 https://nice-train.zebra-c.com/api/platform/saveKeywords

# 请求参数

参数	类型	必须	说明
keyword_list	array	是	数组，详情参见如下示例

# keyword_list示例

[    //keyword关键词典。search_word词典值，多个词用英文逗号分隔。
     { "keyword":"方便", "search_word":"便利,简单,不麻烦" },
     { "keyword":"快速", "search_word":"很快,快速,挺快" }
]

# 请求示例

{
    "keyword_list":[
         { "keyword":"方便", "search_word":"便利,简单,不麻烦" },
         { "keyword":"快速", "search_word":"很快,快速,挺快" }
    ]
}

# 请求CURL 命令

curl --location --request POST 'https://nice-train.zebra-c.com/api/platform/saveKeywords' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ "keyword_list":[ { "keyword":"方便", "search_word":"便利,简单,不麻烦" },{ "keyword":"快速", "search_word":"很快,快速,挺快" }] }'

# 成功返回参数（body）

参数	类型	必须	说明
message	string

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": {}
 }

# 删除平台关键热词

云平台可以调用此接口删除平台关键热词。

# 请求路径

【POST】 https://nice-train.zebra-c.com/api/platform/deleteKeywords

# 请求参数

参数	类型	必须	说明
keywords	array	是	数组，由关键词典组成的数组

# 请求示例

{
    "keywords":["方便","快速"]
}

# 请求CURL 命令

curl --location --request POST 'https://nice-train.zebra-c.com/api/platform/deleteKeywords' \ 
--header 'Content-Type: application/json' \ 
--data-raw '{ keywords":["方便", "快速"] }'

# 成功返回参数（body）

参数	类型	必须	说明
message	string

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": {}
 }

# 获取平台关键热词列表

云平台可以调用此接口获取平台关键热词列表。

# 请求路径

【GET】 https://nice-train.zebra-c.com/api/platform/getKeywords

# 请求参数

无

# 请求示例

无

# 请求CURL 命令

curl --location --request GET 'http://nice-train.zebra-c.com/api/platform/getKeywords' \ 
--header 'Content-Type: application/json' \ 
--data-raw ''

# 成功返回参数（body）

参数	类型	说明
keyword	string	关键词典
search_word	string	词典值
created_at	string	生成时间

# 成功返回示例

{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "keyword": "方便",
            "search_word": "便利,简单,不麻烦",
            "created_at": "2021-12-02 16:07:15"
        },
        {
            "keyword": "诚实",
            "search_word": "守信用,诚实,真诚",
            "created_at": "2021-12-06 15:42:49"
        }
    ]
}

← API调用统一说明指标管理相关api →