华为云用户手册

  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 image1_face CompareFace object 第1幅图像中检测到的人脸,DetectFace结构见DetectFace。 调用失败时无此字段。 image2_face CompareFace object 第2幅图像中检测到的人脸,DetectFace结构见DetectFace。 调用失败时无此字段。 similarity Double 人脸相似度,1表示最大,0表示最小,值越大表示越相似。一般情况下超过0.93即可认为是同一个人。如果图片质量较低,也会影响相似度。 调用失败时无此字段。 表5 CompareFace 参数 参数类型 描述 bounding_box BoundingBox object 人脸在图像中的位置。 表6 BoundingBox 参数 参数类型 描述 width Integer 人脸图像所在矩形框的宽度。 top_left_y Integer 矩形框左上角纵坐标。 top_left_x Integer 矩形框左上角横坐标。 height Integer 人脸图像所在矩形框的高度。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账,当前仅支持按需计费模式。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用FRS服务,账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID,正常使用FRS服务,账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID(包含特殊字符等),正常使用FRS服务,账单的企业项目会被分类到"default"中。 表3 请求Body参数 参数名 参数类型 是否必选 说明 image1_url String 与image1_file、image1_base64三选一 图片的URL路径,目前仅支持华为云上OBS的URL,使用时只需保证FRS有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。 OBS URL格式如下,可在OBS控制台获取。 https://BucketName.obs.xxxx.com/ObjectName image1_file File 与image1_url、image1_base64三选一 本地图片文件,要求: 图片不能超过8MB,建议小于1MB。 上传文件时,请求格式为multipart。 image1_base64 String 与image1_file、image1_url三选一 图像数据,Base64编码,要求: Base64编码后大小不超过8MB,建议小于1MB。 图片为JPG/JPEG/BMP/PNG格式。 image2_url String 与image2_file、image2_base64三选一 图片的URL路径,目前仅支持华为云上OBS的URL,且 人脸识别服务 有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。 image2_file File 与image2_url、image2_base64三选一 本地图片文件,要求: 图片不能超过8MB,建议小于1MB。 上传文件时,请求格式为multipart。 image2_base64 String 与image2_file、image2_url三选一 图像数据,Base64编码,要求: Base64编码后大小不超过8MB,建议小于1MB。 图片为JPG/JPEG/BMP/PNG格式。
  • 功能介绍 人脸比对是将两个人脸进行比对,来判断是否为同一个人,返回比对置信度。如果传入的图片中包含多个人脸,选取最大的人脸进行比对。 前提条件: 请确保您已开通 人脸识别 服务,具体操作方法请参见申请服务。 约束限制: 人脸比对输入的两张图片总大小。 只支持识别JPG、PNG、JPEG、BMP格式的图片。 application/json请求的body中,请使用标准Json格式。 Base64编码中请勿使用回车换行。 系统不保存用户图片。 图片大小小于8MB,由于过大图片会导致时延较长,并且图片信息量不大,建议小于1MB。 图片分辨率小于4096*4096,图片中人脸像素大于80*80,建议120*120以上。 为保证识别效果,人脸图片建议要求如下: 光照大于200lux、无反光强光阴影现象。 人脸无遮挡、整体清晰无拖尾抖动等运动模糊。 侧脸不超过30°、俯仰角小于15°、偏转角小于15°、图片中人脸保持竖置正脸。 具体的约束限制信息请参见约束与限制章节。 建议: 由于过大图片对识别算法精度无明显提升,同时会导致时延较长,建议传入图片小于1MB,一般500KB左右足够。 OBS上存储的图片也建议小于1MB。 图片中人脸像素建议120*120以上。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 faces Array of SearchFace objects 查找的人脸集合,详见SearchFace。 调用失败时无此字段。 表5 SearchFace 参数 参数类型 描述 bounding_box BoundingBox object 人脸在图像中的位置。 similarity Double 人脸搜索时用于被检索的相似度。 external_fields Object 用户添加的额外自定义字段。 external_image_id String 人脸所在的外部图片ID。 face_id String 人脸ID,由系统内部生成的唯一ID。 表6 BoundingBox 参数 参数类型 描述 width Integer 矩形框宽度。 top_left_y Integer 矩形框左上角纵坐标。 top_left_x Integer 矩形框左上角横坐标。 height Integer 矩形框高度。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账,当前仅支持按需计费模式。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用FRS服务,账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID,正常使用FRS服务,账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID(包含特殊字符等),正常使用FRS服务,账单的企业项目会被分类到"default"中。 表3 请求Body参数 参数名 参数类型 是否必选 说明 image_url String 与image_file、image_base64、face_id四选一 图片的URL路径,目前仅支持华为云上OBS的URL,使用时只需保证FRS有权限读取该OBS桶的数据。开通读取权限的操作请参见服务授权。 image_file File 与image_url、image_base64、face_id四选一 本地图片文件,图片不能超过8MB,建议小于1MB。上传文件时,请求格式为multipart。 image_base64 String 与image_file、image_url、face_id四选一 图像数据,Base64编码,要求: Base64编码后大小不超过8MB,建议小于1MB。 图片为JPG/JPEG/BMP/PNG格式。 face_id String 与image_file、image_base64、image_url四选一 导入人脸时,系统返回的人脸编号,即人脸ID。 top_n Integer 否 返回查询到的最相似的N张人脸,N默认为10,取值范围[0,1000]。 N张人脸按照置信度降序排序,置信度越大越靠前。 threshold Double 否 人脸相似度阈值,低于这个阈值则不返回,取值范围[0,1],一般情况下建议取值0.93,默认为0。 sort JsonArray 否 支持字段排序,参考sort语法。 filter String 否 过滤条件,参考filter语法。 return_fields JsonArray 否 指定返回的自定义字段。
  • 功能介绍 人脸搜索是指在已有的人脸库中,查询与目标人脸相似的一张或者多张人脸,并返回相应的置信度。如果图片中包含多个人脸,选取图片中检测到的最大尺寸人脸作为检索的输入。 支持传入图片或者faceID进行人脸搜索。 前提条件: 请确保您已开通人脸识别服务,具体操作方法请参见申请服务。 约束限制: 只支持识别JPG、PNG、JPEG、BMP格式的图片。 application/json请求的body中,请使用标准Json格式。 Base64编码中请勿使用回车换行。 系统不保存用户图片。 图片大小小于8MB,由于过大图片会导致时延较长,并且图片信息量不大,建议小于1MB。 图片分辨率小于4096*4096,图片中人脸像素大于80*80,建议120*120以上。 为保证识别效果,人脸图片建议要求如下: 光照大于200lux、无反光强光阴影现象。 人脸无遮挡、整体清晰无拖尾抖动等运动模糊。 侧脸不超过30°、俯仰角小于15°、偏转角小于15°、图片中人脸保持竖置正脸。 其他的约束限制信息请参见约束与限制章节。 建议: 由于过大图片对识别算法精度无明显提升,同时会导致时延较长,建议传入图片小于1MB,一般500KB左右足够。 OBS上存储的图片也建议小于1MB。 图片中人脸像素建议120*120以上。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账,当前仅支持按需计费模式。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用FRS服务,账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID,正常使用FRS服务,账单的企业项目会显示对应不存在的企业项目ID。 携带正确的ID,正常使用FRS服务,账单的企业项目会被分类到企业ID对应的企业项目中。 表3 请求Body参数 参数名 参数类型 是否必选 说明 face_id String 是 人脸ID,由系统内部生成的唯一ID。 external_image_id String 否 用户指定的图片外部ID,与当前图像绑定。用户不设置该参数时,系统会自动生成一个。该ID长度范围为[1,36],可以包含字母、数字、中划线或者下划线,不包含其他的特殊字符。 这里是待修改的参数,external_image_id和external_fields至少选一个。 external_fields Object 否 自定义字段的key值长度范围为[1,36],string类型的value长度范围为[1,256],具体参见自定义字段。 这里是待修改的参数,external_image_id和external_fields至少选一个。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 face_number Integer 更新的人脸数量。 调用失败时无此字段。 face_set_id String 人脸库ID。 调用失败时无此字段。 face_set_name String 人脸库名称。 调用失败时无此字段。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 face_number Integer 删除的人脸数量。 调用失败时无此字段。 face_set_id String 人脸库ID。 调用失败时无此字段。 face_set_name String 人脸库名称。 调用失败时无此字段。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账,当前仅支持按需计费模式。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用FRS服务,账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID,正常使用FRS服务,账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID(包含特殊字符等),正常使用FRS服务,账单的企业项目会被分类到"default"中。 表3 请求Body参数 参数名 参数类型 是否必选 说明 filter String 是 过滤条件,具体参见filter语法。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账,当前仅支持按需计费模式。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用FRS服务,账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID,正常使用FRS服务,账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID(包含特殊字符等),正常使用FRS服务,账单的企业项目会被分类到"default"中。
  • 获取AK/SK 登录人脸识别管理控制台。 单击页面右上角的用户名,并选择“我的凭证”。 进入“我的凭证”页面。 单击“访问秘钥”页签下的“新增访问密钥”。 弹出“新增访问密钥”对话框。 输入“登录密码”,如果绑定了手机或者邮箱,还需要获取验证码并进行验证。 验证成功后,弹出访问密钥下载对话框。 单击“确定”,并根据提示下载保存访问密钥。 如果已生成过AK/SK,找到原来已下载的AK/SK文件,文件名一般为:credentials.csv。 父主题: 获取项目ID/账号名/AK/SK
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 face_set_info FaceSetInfo object 人脸库信息集合,详见FaceSetInfo。 调用失败时无此字段。 表4 FaceSetInfo 参数 参数类型 描述 face_number Integer 人脸库当中的人脸数量。 external_fields Object 用户的自定义字段。 face_set_id String 人脸库ID,随机生成的包含八个字符的字符串。 face_set_name String 人脸库名称。 create_date String 创建时间。 face_set_capacity Integer 人脸库最大的容量。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账,当前仅支持按需计费模式。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用FRS服务,账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID,正常使用FRS服务,账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID(包含特殊字符等),正常使用FRS服务,账单的企业项目会被分类到"default"中。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 face_set_id String 人脸库ID,随机生成的包含八个字符的字符串。 调用失败时无此字段。 face_set_name String 人脸库名称。 调用失败时无此字段。 faces Array of FaceSetFace objects 人脸库当中的人脸结构,详见FaceSetFace。 调用失败时无此字段。 表5 FaceSetFace 参数 参数类型 描述 bounding_box BoundingBox object 人脸在图像中的位置。 BoundingBox结构见BoundingBox。 external_fields Object 用户添加的额外字段。 external_image_id String 人脸所在的外部图片ID。 face_id String 人脸ID,由系统内部生成的唯一ID。 表6 BoundingBox 参数 参数类型 描述 width Integer 矩形框宽度。 top_left_y Integer 矩形框左上角纵坐标。 top_left_x Integer 矩形框左上角横坐标。 height Integer 矩形框高度。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • URI GET /v2/{project_id}/face-sets/{face_set_name}/faces?offset=xxx&limit=xxx 或者 GET /v2/{project_id}/face-sets/{face_set_name}/faces?face_id={face_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参见获取项目ID/账号名/AK/SK。 face_set_name String 是 人脸库名称。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否,与face_id二选一 Integer 查询的起始位置,取值范围为非负整数,默认为0。 limit 否,与face_id二选一 Integer 单次查询总量,默认为5。offset+limit值不能超过10000。 face_id 否,与offset二选一 String 人脸ID。 offset+limit值不能超过10000。人脸识别系统非存储系统,暂时不支持数据遍历操作,用户可以自行保存face_id,根据face_id查询导入的人脸信息。
  • 功能介绍 静默活体检测是基于人脸图片中可能存在的畸变、摩尔纹、反光、倒影、边框等信息,判断图片中的人脸是否来自于真人活体,进行实人检测,有效抵御纸质翻拍照、电子翻拍照以及视频翻拍等各种攻击方式。静默活体检测支持单张图片,也支持多人脸图片,当图片中有多个人脸时,会检测其中最大的人脸是否为活体。新老用户均可用该接口。 前提条件: 请确保您已开通人脸识别服务,具体操作方法请参见申请服务。 约束限制: 只支持识别JPG、PNG、JPEG、BMP格式的图片。 application/json请求的body中,请使用标准Json格式。 Base64编码中请勿使用回车换行。 系统不保存用户图片。 图片大小小于2MB,由于过大图片会导致时延较长,并且图片信息量不大,建议小于1MB。 图片分辨率小于4096*4096,图片中人脸像素大于40*40,建议120*120以上。 为保证识别效果,人脸图片建议要求如下: 光照大于200lux、无反光强光阴影现象。 人脸无遮挡、整体清晰无拖尾抖动等运动模糊。 侧脸不超过30°、俯仰角小于15°、偏转角小于15°、图片中人脸保持竖置正脸。 其他的约束限制信息请参见1.4 约束限制章节。 建议: 由于过大图片对识别算法精度无明显提升,同时会导致时延较长,建议传入图片小于1MB,一般500KB左右足够。 OBS上存储的图片也建议小于1MB。 图片中人脸像素建议120*120以上。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账,当前仅支持按需计费模式。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用FRS服务,账单归到企业ID对应的企业项目中。 携带错误的ID,正常使用FRS服务,账单的企业项目会被分类为“未归集”。 不携带ID,正常使用FRS服务,账单的企业项目会被分类为“default”。 表3 请求Body参数 参数名 是否必选 参数类型 说明 image_url 与image_file、image_base64三选一 String 图片的URL路径,目前仅支持华为云上OBS的URL,使用时只需保证FRS有权限读取该OBS桶的数据。开通读取权限的操作请参见申请服务。 image_file 与image_url、image_base64三选一 File 本地图片文件,要求: 图片不能超过8MB。 上传文件时,请求格式为multipart。 image_base64 与image_file、image_url三选一 String 图像数据,Base64编码,要求: Base64编码后大小不超过8MB。 图片为JPG/JPEG/BMP/PNG格式。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见认证鉴权。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。FRS支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账,当前仅支持按需计费模式。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用FRS服务,账单的企业项目会被分类到企业ID对应的企业项目中。 携带格式正确但不存在的ID,正常使用FRS服务,账单的企业项目会显示对应不存在的企业项目ID。 不携带ID或格式错误ID(包含特殊字符等),正常使用FRS服务,账单的企业项目会被分类到"default"中。
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 face_sets_info Array of FaceSetInfo objects 人脸库信息集合,详见FaceSetInfo。 调用失败时无此字段。 表4 FaceSetInfo 参数 参数类型 描述 face_number Integer 人脸库中已有的人脸特征的数量。 external_fields Object 用户的自定义字段。 face_set_id String 人脸库ID,随机生成的包含八个字符的字符串。 face_set_name String 人脸库名称。 create_date String 创建时间。 face_set_capacity Integer 人脸库最大的容量。创建人脸库时,请求参数如果不设置face_set_capacity参数,默认每个人脸库最大容量为10万个人脸特征。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参考错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 人脸检测API的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://face.cn-north-4.myhuaweicloud.com/v2/{project_id}/face-detect
  • Token认证 需要使用同一个Token鉴权时,可以缓存起来,避免频繁调用。 关于Token有效期的详细说明请参见获取 IAM 用户Token(使用密码)。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 username、domainname、project name可登录控制台“我的凭证”页面获取。password为用户密码。 获取Token 时,如果出现账密报错“The username or password is wrong.”,请参见如何处理账密报错。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokensContent-Type: application/jsonRequest Body:{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "project name" } } } } 如下图所示,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。获取Token之后,您就可以使用Token认证调用FRS服务API。 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。 图1 获取用户Token响应消息头
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。 X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token请参考认证鉴权。 添加消息头后的请求如下所示。 POST https://face.cn-north-4.myhuaweicloud.com/v2/{project_id}/face-detectContent-Type: application/jsonx-auth-token: MIIaBgYJKoZIhvcNAQcC…
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 例如,对于人脸检测接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。 POST https://face.cn-north-4.myhuaweicloud.com/v2/{project_id}/face-detectRequest Header:Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDT...Request Body:{ "image_base64": "/9j/4AAQSkZJRgABAgEASABIAAD...", "attributes": "2,12,13"} 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。 AK/SK获取方式请参考获取AK/SK。
  • 其他操作 删除 在问题类别区域,选中待删除的问题类别名称,单击删除问题类别。 在“删除问题类别”弹窗中单击“确定”。 图2 删除问题类别 编辑 在问题类别区域,选中待编辑的问题类别名称,单击编辑问题类别。 在“编辑问题类别”弹窗中单击“确定”。 图3 编辑类别 刷新 在问题类别区域,单击刷新问题类别列表。 查找 在问题类别区域,在查找框中输入问题类别名称,单击查找。 图4 查找问题类别 添加子级类别 鼠标悬浮在某一类别时,单击类别名称右侧的可新建子级类别。
  • 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 表1 请求URI 参数 说明 URI-scheme 传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器 域名 或IP,不同服务在不同区域时,对应Endpoint不同,可以从终端节点中获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取。 例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 例如调用人脸检测接口,API的resource-path为“/v2/{project_id}/face-detect”。 query-string 查询参数,可选,查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如,您需要在“华北-北京四”区域调用人脸检测API,URI如下所示。其中face.cn-north-4.myhuaweicloud.com表示“华北-北京四”区域的Endpoint,{project_id}表示与区域对应的项目id,可在“我的凭证”页面获取。 https://face.cn-north-4.myhuaweicloud.com/v2/{project_id}/face-detect 图1 URI示意图 为查看方便,服务每个具体API的URI,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 问答统计 问答统计提供了 问答机器人 问答相关的一些数据信息,您可以通过不同的时间维度来查看统计数据。 “问答统计”只统计最近三个月的数据。 如图1所示,问答统计按如下几个维度进行统计展示。 问答占比统计 问答类型分为“对话技能”、“直接命中问题”、“推荐问题”、“无效问题”、“闲聊”、“兜底”,此处展示了每一类问答的回答次数,并通过饼图的样式展示。 对话技能:机器人对话体验过程中,调用技能进行对话的次数。 直接命中问题:用户提的问题,机器人匹配到知识库中的问题,直接返回答案。 推荐问题:用户提的问题,机器人匹配到知识库中的多个问题,返回推荐的所有相似问题。 无效问题:用户提的问题,机器人匹配到知识库中的无效问题。 闲聊:用户提的问题,机器人匹配到知识库中的闲聊问题,返回闲聊的答案。 兜底:当机器人无法理解用户的问题时,机器人会按照设置的识别失败回复进行回复响应。 问答次数趋势统计 根据指定的时间,使用折线图展示问答次数的趋势。 问答占比趋势统计 根据指定的时间,使用折线图展示问答占比的趋势。 图1 问答统计
  • 访问统计 访问统计提供了用户访问和使用问答机器人的一些统计信息。 如图2所示,访问统计按如下几个维度进行统计展示。 访问数:指定时间段内用户和 智能问答机器人 问答会话的个数,每唤起一次机器人即为一个访问数。 独立用户数:指定时间段内不同用户访问智能问答服务的用户个数。 平均对话轮数:指定时间段内每个用户平均与问答机器人对话的轮数,其计算公式为:用户与问答机器人进行问答的总次数/指定时间段内用户访问智能问答机器人的总次数。 平均访问时长:指定时间段内每个用户平均访问的时长,单位为秒,其计算公式为:访问问答机器人的总时间/指定时间段内访问智能问答机器人的用户数。 访问数趋势统计:以折线图的形式展示了指定时间段内,总访问数和独立用户数的数据趋势。 平均对话轮数趋势统计:以折线图的形式展示了指定时间段内平均对话轮数。 平均访问时长趋势统计:以折线图的形式展示了指定时间段内平均访问时长。 图2 访问统计
  • 新建对话回复节点 在机器人与用户的对话流程中,完成处理节点后,您需要配置回复节点,用来表示机器人回复用户的内容。您可以插入变量或者槽位,编辑回复术语。对话流程的终结节点,必须以回复节点结束。 在左上角节点列表中,拖拽“对话回复”节点到中间空白区域,同时界面右侧展开“对话回复”页签。 图1 对话回复 设置节点名称、回复信息、变量、槽位等信息。 对话回复的内容可以插入变量、插入槽位,并填充变量和槽位之间的文本使其构成一个完整的语句。例如:[S:check_weather-城市][S:check_weather-时间]的天气是[V:weather],表示机器人回复的术语可以是“北京2020.07.07的天气是多云”。 表1 参数说明 参数名称 参数说明 取值范围 插入变量 选择变量,并关联对应的变量信息。 只支持由大小写字母、数字、汉字以及部分符号(“_”、“-”、“#”)组成,输入长度为1~63字符。 插入槽位 选择意图,并关联对应的槽位信息。 意图下的所有槽位。 父主题: 配置对话流程(可选)
共100000条