华为云用户手册

  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0412000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 消息体参数说明 参数名 数据类型 选取原则 说明 say(可以修改) object True 请求报文,代码中不会对这个报文做任何处理,会回写到响应消息体中。
  • 报文样例 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "say": "Hello world!"} 该接口的响应消息体举例如下: { "request": { "say": "Hello world!" }, "status": "UP"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 id string True 设置档唯一标识 1.2 name string True 设置档名称 1.3 lower_bound number True 下限分数 1.4 upper_bound number True 上限分数 1.5 base number True 起始分数
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0412000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:修改质检评分设置档。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"id": "1980058583","name": "1","lower_bound": 10,"upper_bound": 100,"base": 10,} 响应参数: {"resultCode": "0412000","resultDesc": "操作成功"}
  • 报文样例 场景描述:质检评分设置档查询。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"page": 1,"limit": 10000} 响应参数: {"fundamental_score": [{"lower_bound": 1,"name": "default","upper_bound": 100,"id": "0","base": 60}, {"lower_bound": 10,"name": "1","upper_bound": 100,"id": "1980058583","base": 10}, {"lower_bound": 11,"name": "test","upper_bound": 111,"id": "1828287446","base": 11}],"using": "1828287446","resultCode": "0412000","resultDesc": "操作成功"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 using string True 正在套用的设置档id 1.2 fundamental_score array[object] True 设置档数据列表 1.2.1 id number False 设置档唯一标识 1.2.2 lower_bound number False 下限分数 1.2.3 upper_bound number False 上限分数 1.2.4 base number False 起始分数 1.2.5 name string False 设置档名称 1.3 resultCode string False 返回码 0412000 表示成功 其他表示失败 1.4 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:移动句子到指定分类 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"sentenceIds": "14161,14171","category_id": "894378237264662528"} 响应参数: {"resultCode": "0403000","resultDesc": "操作成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 page number True 偏移量 1.2 limit number True 每页数据量限制
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 sentenceIds string True 句子的唯一标识 1.2 category_id string True 分类的唯一标识
  • 报文样例 场景描述:删除句子 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"sentence_id": "14412"} 响应参数: {"resultCode": "0403000","resultDesc": "操作成功"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode string False 返回码 0403000 表示成功 其他表示失败 2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 sentence_id string True 句子的唯一标识
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 resultCode string False 返回码 0403000 表示成功 其他表示失败 2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 category_id string True 句子分类的唯一标识 1.2 sentence_name string True 句子名称 1.3 sentence_id string True 句子标识 1.4 tagDataList array[object] True 句子使用到的语义与关键词 1.4.1 tag_type string True 标签类型,取值范围: keyword:关键字 dialogue_act:语料 regular_exp:正则表达式 1.4.2 pos_sentences array[object] False 正向的语料,关键字和正则表达式 1.4.2.1 id string False 语料的唯一标识 1.4.2.2 name string False 语料内容 1.4.3 neg_sentences array[object] False 反向语料,与pos_sentences在同一个标签对象中不能同时存在 1.4.3.1 id string False 语料的唯一标识 1.4.3.2 name string False 语料内容
  • 报文样例 场景描述:更新句子 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "category_id": "1070149256381206528", "sentence_name": "句子名称766", "tagDataList": [ { "tag_type": "dialogue_act", "pos_sentences": [ { "name": "11111111111222222222" }, { "id": "10162", "name": "同义语料585111111111111111" } ], "neg_sentences": [ { "name": "1111111111111111" }, { "id": "10040", "name": "反义语料461111111111111" } ] }, { "tag_type": "keyword", "pos_sentences": [ { "name": "222222222222222222222222" }, { "id": "10094", "name": "关键字9891111111111111111" }, { "id": "10093", "name": "关键字11111111111111111111" } ] } ], "sentence_id": "10863", "deleteTagDataList": []} 响应参数: { "resultCode": "0403000", "id": "10863", "resultDesc": "操作成功"}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 id string False 句子分类的唯一标识 1.2 resultCode string False 返回码 0403000 表示成功 其他表示失败 1.3 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 category_id string False 句子分类的唯一标识 1.2 resultCode string False 返回码 0403000 表示成功 其他表示失败 1.3 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 name string True 句子分类名称
  • 报文样例 场景描述:创建句子分类 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"name": "cs"} 响应参数: {"category_id": "925086177642418176","resultCode": "0403000","resultDesc": "操作成功"}
  • 报文样例 场景描述:根据句子分类的唯一标识获取分类下句子列表 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"category_id": "1070149256381206528","page": 1,"limit": 10} 响应参数: { "data": [ { "category_id": "1070149256381206528", "sentence_id": "10849", "sentence_name": "句子名称87" }, { "category_id": "1070149256381206528", "sentence_id": "10856", "sentence_name": "句子名称96" }, { "category_id": "1070149256381206528", "sentence_id": "10863", "sentence_name": "句子名称403" }, { "category_id": "1070149256381206528", "sentence_id": "10870", "sentence_name": "句子名称78" }, { "category_id": "1070149256381206528", "sentence_id": "10877", "sentence_name": "句子名称25" }, { "category_id": "1070149256381206528", "sentence_id": "10884", "sentence_name": "句子名称39" }, { "category_id": "1070149256381206528", "sentence_id": "10891", "sentence_name": "句子名称85" } ], "resultCode": "0403000", "paging": { "total": 7 }, "resultDesc": "操作成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 category_id string True 句子分类的唯一标识 1.2 page number True 页码 1.3 limit number True 每页数量 取值范围:5, 10, 20, 50, 100
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 data array[object] False 返回结果 1.1.1 sentence_id string False 句子的唯一标识 1.1.2 sentence_name string False 句子名称 1.1.3 category_id string False 句子分类的唯一标识 1.2 paging object False 分页信息 1.2.1 total string False 查询结果总数 1.3 resultCode string False 返回码 0403000 表示成功 其他表示失败 1.4 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景1:查询句子列表 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "category_id": "1070149256381206528", "keyword": "句子", "page": 1, "limit": 10} 响应参数: { "paging": { "total": 4 }, "data": [ { "category_id": "1070149256381206528", "sentence_id": "10870", "sentence_name": "句子名称78", "tags": null }, { "category_id": "1070149256381206528", "sentence_id": "10877", "sentence_name": "句子名称25", "tags": null }, { "category_id": "1070149256381206528", "sentence_id": "10884", "sentence_name": "句子名称39", "tags": null }, { "category_id": "1070149256381206528", "sentence_id": "10891", "sentence_name": "句子名称85", "tags": null } ]} 场景2:通过句子id查询句子详情 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "sentence_id": "10891"} 响应参数: { "category_id": "1070149256381206528", "sentence_id": "10891", "tagDataList": [ { "tag_type": "dialogue_act", "pos_sentences": [ { "name": "同义语料18", "id": "10169" } ], "neg_sentences": [ { "name": "反义语料14", "id": "10047" } ] }, { "tag_type": "keyword", "pos_sentences": [ { "name": "正则表达式2221", "id": "10109" }, { "name": "关键字22223", "id": "10108" }, { "name": "关键字11164", "id": "10107" } ] } ], "sentence_name": "句子名称85", "resultCode": "0403000", "resultDesc": "操作成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 category_id string False 句子分类的唯一标识,传入句子分类标识只查询该分类下的句子 1.2 page number False 分页信息查询条件,查询目标页码 1.3 limit number False 分页信息查询条件,每页数量 取值范围:5, 10, 20, 50, 100 1.4 keyword string False 查询关键字 1.5 sentence_id string False 句子的唯一标识,当传入了句子标识,只查询返回该句子的详情
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 data array[object] False 返回的句子数据集合对象 1.1.1 category_id string False 句子分类的唯一标识 1.1.2 sentence_id string True 句子的唯一标识 1.1.3 sentence_name string False 句子名称 1.1.4 tags array[object] False 句子所使用的语义与关键词 1.1.4.1 tag_id string False 标签的唯一标识 1.1.4.2 tag_name string False 标签名称 1.1.4.3 tag_type string False 标签的类型:keyword-关键词,dialogue_act-语义,regular_exp-正则表达式 1.2 paging object False 分页信息对象 1.2.1 current number False 页码 1.2.2 limit number False 每页数量 1.2.3 total number False 查询结果总数 1.3 category_id string False 分类的唯一标识 1.4 sentence_id string False 句子的唯一标识 1.5 sentence_name string False 句子名称 1.6 tagDataList array[object] False 语义与关键字列表 1.6.1 tag_type string False 标签类型 1.6.2 pos_sentences array[object] False 正向语义,关键字和正则表达式 1.6.2.1 id string False 语料的唯一标识 1.6.2.2 name string False 语料内容 1.6.3 neg_sentences array[object] False 反向语义,与pos_sentences在同一个标签对象中不能同时存在 1.6.3.1 id string False 语料的唯一标识 1.6.3.2 name string False 语料内容 1.7 resultCode string False 返回码 0403000 表示成功 其他表示失败 1.8 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0403000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:删除句子分类 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: {"category_id": "923019012181331968"} 响应参数: {"resultCode": "0403000","resultDesc": "Opration Successful."}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 固定填 application/json; charset=UTF-8。 2 x-app-key string True appKey标识 3 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 4 x-UserId string True 操作员标识 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 category_id string True 需要删除的句子分类的唯一标识
共100000条