华为云用户手册

  • 增量更新图谱 登录KG服务管理控制台,默认进入“我的图谱”页面。 在“我的图谱”页面,单击图谱卡片。 进入图谱详情页面。 单击右上角的“增量更新”。 进入“增量更新”页面,通过配置数据源、配置信息抽取、配置知识映射、配置知识融合、配置图谱质检等流水线步骤,构建增量图谱。 在“增量更新”页面,依次完成数据源配置、信息抽取、知识映射、知识融合、图谱质检的配置,详细的操作指引请见表1。 “增量更新”页面入口与“创建 知识图谱 ”页面入口不同,但是增量更新中的配置操作均与创建知识图谱操作相同。 增量更新不支持更新本体,仅支持预览本体。 图1 增量更新 表1 增量更新图谱操作 操作顺序 操作名称 操作指引 1 增加基础数据 配置数据源 2 更新信息抽取 配置信息抽取 3 更新知识映射 配置知识映射 4 更新知识融合 配置知识融合 5 更新图谱质检 配置图谱质检 配置完后,单击右上角的“生成图谱”。 跳至“我的图谱”页面,等待“运行状态”变为“可用”,即图谱构建完成。您可以单击已构建的图谱卡片,进入图谱详情页面查看图谱详情。
  • 进入全量更新页面 登录KG服务管理控制台,默认进入“我的图谱”页面。 在“我的图谱”页面,单击图谱卡片。 进入图谱详情页面。 单击右上角的“全量更新”,根据自身业务选择更新方式,可选“普通配置构建”“智能一键构建”和“图谱导入”。 普通配置构建:通过配置数据源、配置图谱本体、配置信息抽取、配置知识映射、知识融合、图谱质检等流水线步骤,构建新的知识图谱。 智能一键构建:只需提供新的源数据,无需创建本体等其他配置,快速构建新的知识图谱。 图谱导入:对于导出的图谱版本,通过图谱导入可以快速恢复图谱版本。
  • 进入图谱预览页面 登录KG服务管理控制台,默认进入“我的图谱”页面。 在“我的图谱”页面,单击已创建图谱的名称,进入图谱详情页面。 图1 图谱详情 单击“预览图谱”,选择匹配方式: 图2 选择匹配方式 选择“完全匹配”,输入“实体名称”,按回车进入图谱预览页面,预览该实体的知识图谱。 选择“模糊匹配”,输入实体名称部分字段,按回车进入图谱预览页面,预览实体名称含该字段的所有实体的知识图谱。 举例:某电影相关图谱,输入某一具体的电影名称,按回车进入图谱预览页面,预览该电影的知识图谱。 预览知识图谱时,在右侧工具栏中,可以执行以下操作: 单击,可以查看历史操作。 单击,可以放大图谱画面。 单击,可以缩小图谱画面。 单击,可以恢复图谱画面至原始比例。 单击,可以查看图例。 单击,可以查看与该实体有关系的局部图谱数据。 单击,可以查看力引导布局的图谱。 单击,可以查看圆形布局的图谱。 单击,可以查看网格布局的图谱。 单击,可以查看分层布局的图谱。 单击,可以查看自动分群布局的图谱。 单击,可以下载当前图谱画面。
  • 预览图谱 在图谱预览页面,您可以查看到所搜索的实体信息。 图3 预览图谱 功能区 “预览图谱”页面右侧有功能区可进行如下操作。 :查看历史操作记录。 :放大查看图谱实体。 :缩小查看图谱实体。 :适配比例查看图谱。 :查看局部图谱的实体信息。 :以不同布局方式查看图谱和实体。 :保存图谱或实体图片至本地。如果下载的界面字体太小,请滚动鼠标调整字体大小。 新建 “预览图谱”页面左上角可在当前图谱基础上,新建实体或实体间的关系,详情请见新建实体/关系。 运行记录和查询结果 “预览图谱”页面下方“运行记录”页签可查看在预览图谱页面的查询记录,“查询结果”页签可查看在预览图谱页面查询实体的JSON格式信息。 Gremlin “预览图谱”页面下方用Gremlin语句查询实体,例如希望随机查看10个实体,则输入命令g.V().limit(10) ,随机查看10条关系,则输入命令g.E().limit(10)。 使用Gremlin语句查询当前暂不支持TinkerPop3.4中原生支持的模糊搜索功能,例如startingWith、endingWith、containing等查询。
  • 知识融合 知识融合是指融合来自多个数据来源的关于同一个实体或概念的描述信息,对来自不同数据源的知识在统一规范下进行异构数据整合、消歧。 如图1所示的两条数据,这两条数据中的“元鲜”实际上是同一个人,因此需要对这两条数据进行融合。 图1 知识融合示例 知识融合过程请见图2,融合过程说明请见表1。 图2 知识融合 表1 知识融合说明 融合过程 过程说明 初步筛选 知识融合需要初步筛选与融合标识符相似的实体数据。 判断属性相似度 初步筛选与融合标识符相似的数据后,需要配置相似属性和相似度函数,并判断数据之间的属性相似度。 融合知识 对属性相似度均达到阈值条件的数据进行融合。 综上所述,在创建图谱的过程中,需要配置知识融合的融合标识符、待融合的实体、相似度函数和相似度阈值等参数,KG服务会根据所配置的参数进行知识融合。配置知识融合的详细步骤请见配置知识融合。
  • 操作步骤 在普通配置构建图谱页面,单击“图谱本体”。 页面下方弹出图谱本体配置对话框,单击右侧按钮可以放大对话框。 选择左侧“我的库”页签,在“图谱本体组件”中拖拽合适的本体到虚线框中,单击“保存”,完成本体选择。 “我的库”页签下的“图谱本体组件”呈现的是“我的图谱资产库”中“本体管理”页面创建或OBS导入的所有本体。 “公有库”页签下的“图谱本体组件”呈现的是KG服务预置的本体,如果有满足您需求的本体,您也可以直接拖拽使用。 可单击页面右下角的“编辑”,进入本体修改页面,修改后的本体将保存至“我的库”。 图1 图谱本体 图谱本体配置完成后,鼠标悬浮在图谱本体方框区域,显示清空图标,单击后可一键清空图谱本体配置。
  • 操作步骤 在普通配置构建图谱页面,单击“数据源”,页面下方弹出数据源配置对话框,单击右侧按钮可以放大对话框。 图2 配置数据源 在数据源配置对话框,填写相关信息。 “选择数据格式”:构建图谱的数据源格式,包括“ CS V”、“XLSX”、“JSON”、“短文本”,详情请见数据格式要求。 “选择数据源文件”:单击,弹出“选择数据源文件”对话框,选择数据源存放在OBS的路径: “OBS桶”:选择数据源文件存放的OBS桶。确保OBS桶与KG服务在同一区域,桶的存储类别为“标准存储”。 “存储路径”:选择数据源文件存放在OBS桶的文件路径。 “为OBS桶授权”:如果OBS桶未授权,请勾选“确认授权”。 选择完成后,单击“确定”。 “实体类型字段”:当数据格式选择“JSON”时,在“实体类型字段”文本框中填写基础数据中描述实体类型的函数字段。 例如以一个有关于电影的图谱数据为例,选择数据格式和数据源文件后,下方可预览基础数据。 图3 数据源配置 填写完信息后,单击“保存”。 如果您待创建的图谱只需要一个数据源,那么您已完成数据源的配置。 如果您待创建的图谱需要输入多个数据源,请进入下一步。 单击“数据源”下方的“添加数据源”,添加新的数据源,按步骤1~3,配置新的数据源。
  • 功能区操作 创建本体界面右上角的功能区,可基于当前本体进行一系列操作。 图10 功能区 表2 功能区操作 图标 说明 保存当前界面的概念节点和关系曲线。 清空界面,即清空当前界面的概念节点和关系曲线。 导出当前界面的概念节点和关系曲线至OBS。导出前需要提前创建好OBS桶,详情请见OBS添加桶。 单击图标,在导出本体的对话框中填写“导出文件名”,选择“OBS桶”和“存储路径”,然后单击“确定”。 导出文件名 填写导出本体的文件名。 OBS桶 选择存放本体文件的OBS桶。需保证您的OBS桶与KG服务在同一区域,桶的存储类别为“标准存储”。 存储路径 选择存放本体文件的OBS路径。 从OBS导入本体。导入前将待导入的本体文件(json格式)上传至OBS中,详情请参见OBS添加桶和OBS上传文件或文件夹。 说明: 此处导入的本体会覆盖当前正在编辑的本体。 单击图标,在导入本体的对话框中选择“OBS桶”和“存储路径”,然后单击“确定”。 OBS桶 选择提前准备的本体文件存放的OBS桶。需保证您的OBS桶与KG服务在同一区域,桶的存储类别为“标准存储”。 存储路径 选择提前准备的本体文件存放在OBS桶中的路径。 单击图标可查看创建本体所有操作的快捷键。 单击图标放大本体。 单击图标缩小本体。 单击图标使本体以适配大小显示。 单击图标撤销上一个操作。 单击图标恢复上一个已撤销的操作。
  • 编辑概念 右键单击概念图标,选择“编辑”。 或双击概念图标。 左侧弹出概念编辑框。 在概念编辑框中,按表1编辑“概念名称”、“Icon”和“属性”。 图2 编辑概念 表1 编辑概念 参数 说明 概念名称 概念名称只能由大小写字母、数字、中文、下划线组成,长度为1-63位。 Icon 单击选择概念图标的颜色和样式,单击右侧的“更多”,可选择更多图标样式。 属性 编辑当前概念的属性。所有概念都默认有一个属性为“name”,且默认属性类型为“single_string”。 添加属性 单击“添加属性”可添加属性文本框,在文本框中填写属性的“名称”,选择“单值/多值”、“类型”、“操作”。 “名称”:属性名称只能由大小写字母、数字、中文、下划线组成,长度为1-63位。 “单值/多值”:选择当前属性是单值还是多值。 “类型”:选择属性的类型,“单值”可选类型有“single_string”、“single_int”、“single_double”、“single_bool”,“多值”可选类型有“set_string”、“set_int”、“set_double”。 填写完概念的属性后,单击“操作”列的,保存信息。 编辑属性 单击已有属性“操作”列的,可对属性的“名称”重新编辑,也可重新选择“单值/多值”、“类型”。 修改完属性后,单击“操作”列的,保存信息。 复制属性 单击已有属性“操作”列的,复制当前属性。 删除属性 单击已有属性“操作”列的,删除当前属性。 填完信息后,单击“保存”。
  • 基本概念 实体 实体是有可区别性且独立存在的某种事物。例如某一具体的电影(或人物或关系),如电影“霸王别姬”,可称作实体。 概念 概念指是抽象的、普遍的想法,是充当指明实体、事件或关系的范畴或类的实体。例如本体如图1所示,“film”、“people”可称作概念。 概念间关系 概念间关系是概念之间的相关联系。例如本体如图1所示,“film”、“people”两者之间的关系“actor”、“director”均可称作概念间关系。关系名称不能重复。 本体 本体是某个领域中抽象概念的集合,能够描述某个范围内一切事物的共有特征以及事物间的关系。例如图1可称作一个本体。 图1 本体
  • 功能介绍 针对云服务没有构建知识图谱的现状,华为云为各类企业提供 知识图谱服务 ,使用户通过配置化形式自动完成知识图谱的构建流程。知识图谱服务提供图谱创建、本体管理、图谱管理等功能,覆盖创建本体、配置数据源、选择本体、信息抽取、知识映射、知识融合、图谱质检等业务,具体功能如图1和表1所示。 图1 知识图谱流水线平台功能 表1 知识图谱功能说明 功能 说明 本体管理 支持创建本体。 支持查看、编辑本体信息。 支持导出本体。 模型管理 支持自定义信息抽取模型,利用模型进行信息抽取。 支持创建、发布信息抽取模型版本。 知识图谱管理 支持创建知识图谱流水线任务,生成知识图谱。 支持编辑知识图谱流水线任务信息,包括数据源选择、图谱本体配置、信息抽取配置、知识映射信息配置、知识融合信息配置、图谱质检配置。 支持增量数据,更新图谱。 支持图谱预览、图谱版本管理。
  • 构建图谱流程 KG服务为用户提供了两种方式构建图谱,不同的方式所需要的功能不同。基于不同的图谱构建方式,梳理了使用KG服务的主要流程。 图2 构建图谱流程 表2 构建图谱流程说明 主任务 说明 详细指导 购买知识图谱&选择图谱规格 在创建知识图谱之前,需要购买图谱并选择图谱规格。 购买知识图谱 智能一键构建图谱 只需提供源数据,无需其他配置,即可快速构建图谱。 智能一键构建图谱 普通配置构建图谱 通过配置数据源、配置图谱本体、配置信息抽取、配置知识映射、配置知识融合、配置图谱质检,构建适用于自身业务的知识图谱。 普通配置构建图谱
  • 请求示例 使用图片的url POST https://{endpoint}/v3/{project_id}/moderation/image/batch { "event_type" : "comment", "categories" : [ "string" ], "image_text_config" : { "black_glossary_names" : [ "string" ], "white_glossary_names" : [ "string" ] }, "urls" : [ { "url" : "http://xxxxxx.com/qweqeqeqz.jpg", "data_id" : "1234" } ], "language" : "zh" } 使用bizType POST https://{endpoint}/v3/{project_id}/moderation/image/batch { "urls" : [ { "url" : "http://xxxxxx.com/qweqeqeqz.jpg", "data_id" : "1234" } ], "language" : "zh", "biz_type" : "test_type" }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 request_id String 本次请求的唯一标识,用于问题排查,建议保存。 results Array of ImageDetectionResult objects 调用结果。 表7 ImageDetectionResult 参数 参数类型 描述 suggestion String 审核结果是否通过。 block:包含敏感信息,不通过。 pass:不包含敏感信息,通过 。 review:需要人工复检。 category String 检测结果的一级标签。支持category列表如下: terrorism: 暴恐。 porn: 色情。 image_text: 图文审核。 details Array of ImageDetectionResultDetail objects 检测详情。 ocr_text String 图文审核检测出的文本,只有在category参数配置image_text且检测出文本时展示该字段。 data_id String 图片唯一标识。同一次请求中不可重复,由大小写英文字母、数字、下划线(_)、中划线(-)组成,不超过30个字符。 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 表8 ImageDetectionResultDetail 参数 参数类型 描述 suggestion String 审核结果是否通过。 block:包含敏感信息,不通过。 review:需要人工复检。 category String 检测结果的一级标签。支持category列表如下: terrorism: 暴恐。 porn: 色情。 image_text: 图文审核。 confidence Float 置信度,可选值在0-1之间,值越大,可信度越高。 face_location FaceLocationDetail object 人物位置信息,该数组有四个值,分别代表左上角的坐标和右下角的坐标。例如[207,522,340,567],207代表的是左上角的横坐标,522代表左上角的纵坐标,340代表的是右下角的横坐标,567代表的是右下角的纵坐标。 qr_location QRLocationDetail object 图片中二维码指向的链接,当请求参数categories中包含image_text时存在。 qr_content String 图片中二维码指向的链接,当请求参数categories中包含image_text时存在。 segments Array of OCRTextDetail objects image_text场景下命中的文本片段。 label String 识别的详细标签。 表9 FaceLocationDetail 参数 参数类型 描述 top_left_x Integer 检测出人脸的左上角横坐标。 top_left_y Integer 检测出人脸的左上角纵坐标。 bottom_right_x Integer 检测出人脸的右下角横坐标。 bottom_right_y Integer 检测出人脸的右下角纵坐标。 表10 QRLocationDetail 参数 参数类型 描述 top_left_x Integer 检测出的二维码左上角横坐标。 top_left_y Integer 检测出的二维码左上角纵坐标。 bottom_right_x Integer 检测出的二维码右下角横坐标。 bottom_right_y Integer 检测出的二维码右下角纵坐标。 表11 OCRTextDetail 参数 参数类型 描述 segment String 命中的风险片段。 glossary_name String 命中的自定义词库名称。命中自定义词库时,才会返回当前字段。 状态码: 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口,响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 event_type 否 String 事件类型。可选值如下: head_image:头像。 album:相册。 dynamic:动态。 article:帖子。 comment:评论。 room_cover:房间封面。 group_message:群聊图片。 message:私聊图片。 product:商品图片。 说明: 如果请求参数中包含biz_type则优先使用biz_type,event_type和categories参数将不生效,审核策略由biz_type的设置决定。 如果未传biz_type则event_type和categories为必传参数。 categories 否 Array of strings 检测场景。可添加的检测场景如下: terrorism:暴恐元素的检测。 porn:涉黄元素的检测。 image_text:广告图文的检测。 可通过配置上述场景,来完对应场景元素的检测。每个检测场景的检测次数会分类统计。 说明: 如果请求参数中包含biz_type则优先使用biz_type,event_type和categories参数将不生效,审核策略由biz_type的设置决定。 如果未传biz_type则event_type和categories为必传参数。 image_text_config 否 image_text_config object 图文审核黑白词库配置。 urls 是 Array of urls objects 图片url列表。最大支持12张图片。 language 否 String 指定图片中文字语种类型。 zh: 中文(默认值为zh,中国站仅支持zh)。 en: 英文 。 biz_type 否 String 用户在控制台界面创建的自定义审核策略名称。 如果请求参数中包含biz_type则优先使用biz_type,event_type和categories参数将不生效,审核策略由biz_type的设置决定。 如果未传biz_type则event_type和categories为必传参数。 表4 image_text_config 参数 是否必选 参数类型 描述 black_glossary_names 否 Array of strings 检测时使用的自定义黑名单词库列表。 white_glossary_names 否 Array of strings 检测时使用的自定义白名单词库列表。 表5 urls 参数 是否必选 参数类型 描述 url 是 String 图片url,目前支持:公网HTTP/HTTPS URL。 data_id 是 String 图片唯一标识。同一次请求中不可重复,由大小写英文字母、数字、下划线(_)、中划线(-)组成,不超过30个字符。
  • 响应示例 状态码: 200 成功响应示例 { "job_id" : "xxxxxx", "status" : "succeeded", "result" : { "suggestion" : "block", "details" : [ { "start_position" : 1, "end_position" : 10, "suggestion" : "block", "index" : 12, "label" : "porn", "type" : "text", "text" : "xxxxxxxxx", "segments" : [ { "segment" : "xxx" }, { "segment" : "xxx" }, { "segment" : "xxx" } ] } ] }, "request_params" : { "data" : { "url" : "https://xxxxx", "format" : "pdf" }, "event_type" : "default", "image_categories" : [ "politics", "porn", "image_text", "terrorism" ], "text_categories" : [ "default" ], "callback" : "http://xxx" } } 状态码: 400 失败响应示例 { "error_code" : "AIS.0030", "error_msg" : "Job not found" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 job_id String 作业id。 status String 作业状态,可取值有: running:正在运行 succeeded:运行成功 failed:运行失败 result result object 作业审核结果,当作业状态为succeeded时存在。 request_params request_params object 作业创建参数。 create_time String 作业创建时间。 update_time String 作业更新时间。 request_id String 本次请求的唯一标识,用于问题排查,建议保存。 表4 result 参数 参数类型 描述 suggestion String 文档审核结果是否通过。 block:包含敏感信息,不通过 review:需要人工复检 pass:不包含敏感信息,通过 details Array of details objects 审核详情。 表5 details 参数 参数类型 描述 suggestion String 当前内容片段的处置建议: block:包含敏感信息,不通过 review:需要人工复检 type String 当前内容片段的类型,可取值有: text:文本 image:图像 video:视频 label String 当前内容片段的风险类型,可取值为: terrorism:暴恐 porn:色情 sexy:性感 abuse:辱骂 ad:广告 qr_code:二维码 watermark:水印 meaningless:无意义 ban:违禁 bad_scene:不良场景 moan:娇喘 index Integer 当前处理的片段索引。 text String 当前内容片段中的文本内容,仅当type为text时存在。 start_position Integer 当前文本内容片段在输入中的起始位置,仅当type为text时存在。 end_position Integer 当前文本内容片段在输入中的结束位置,仅当type为text时存在。 image_url String 网页图片url,仅当type为image且文档格式为webpage时存在。 segments Array of segments objects 命中的风险片段信息列表,仅在有命中敏感词时才返回。 video_image_details Array of DocumentVideoImageDetail objects 网页视频中截帧部分审核详情。 audio_details Array of DocumentAudioDetail objects 网页视频中音频部分审核详情。 表6 segments 参数 参数类型 描述 segment String 命中的敏感词。 表7 DocumentVideoImageDetail 参数 参数类型 描述 time Float 截帧在视频文件中的时间,单位为秒。 suggestion String 截帧审核结果是否通过。 block:包含敏感信息,不通过 review:需要人工复检 ocr_text String 截帧检测出的文本。 label String 识别的详细标签。 segments Array of segments objects 命中的文本风险片段列表。 表8 segments 参数 参数类型 描述 segment String 命中的风险片段。 表9 DocumentAudioDetail 参数 参数类型 描述 start_time Float 音频片段开始时间。 end_time Float 音频片段结束时间。 suggestion String 音频片段审核处理建议。 block:包含敏感信息,不通过 review:需要人工复检 audio_text String 音频片段文本内容。 label String 音频片段标签。 segments Array of segments objects 命中的风险片段信息列表。 表10 segments 参数 参数类型 描述 segment String 命中的风险片段。 表11 request_params 参数 参数类型 描述 data data object 创建作业时传的data参数。 event_type String 创建作业时传的event_type参数。 image_categories Array of strings 创建作业时传的image_categories参数。 text_categories Array of strings 创建作业时传的text_categories参数。 video_image_categories Array of strings 创建作业时传的video_image_categories参数。 audio_categories Array of strings 创建作业时传的audio_categories参数。 callback String 创建作业时传的callback参数。 表12 data 参数 参数类型 描述 url String 创建作业时传的url参数。目前支持:公网HTTP/HTTPS URL。 format String 创建作业时传的format参数。 frame_interval Integer 创建作业时传的frame_interval参数。 状态码: 400 表13 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 请求示例 创建文档 内容审核 作业。 POST https://{endpoint}/v3/{project_id}/moderation/document/jobs { "data" : { "url" : "xxx", "format" : "pdf" }, "event_type" : "default", "image_categories" : [ "politics", "porn", "image_text", "terrorism" ], "text_categories" : [ "default" ], "callback" : "http://xxx" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 data 是 data object 文档数据输入。 event_type 是 String 事件类型,可选值如下: default:默认事件 liberal_arts_education:文科教育 sciences_education:理科教育 news:新闻 forums:论坛 novels:小说 image_categories 否 Array of strings 文档中图片需要检测的风险类型,不传或为空时表示不审核图片内容, 可取值如下: porn:涉黄检测 terrorism: 暴恐检测 bad_scene: 不良场景检测 image_text: 图文检测 text_categories 否 Array of strings 文档中文本需要检测的风险类型,不传或为空时表示不审核文本内容, 可取值为default,表示检测暴恐、违禁、色情、辱骂、广告等违规内容。 video_image_categories 否 Array of strings 网页视频中图片需要检测的风险类型,不传或为空时表示不审核网页视频内容, 可取值如下: porn:涉黄检测 terrorism: 暴恐检测 bad_scene: 不良场景检测 image_text: 图文检测 audio_categories 否 Array of strings 网页视频中音频需要检测的风险类型,不传或为空时表示不审核网页视频中音频的内容, 可取值如下: porn:涉黄检测 ad:广告检测 abuse:辱骂检测 moan:娇喘检测 callback 否 String 该字段非空时,检测结果会回调通知您的URL。该字段为空时,您需要定时轮询获取检测结果。 说明: 您的callback接口需要支持POST方法; 回调数据格式,请参考查询文档内容审核作业的响应示例; 您的服务端callback接口收到内容安全发送的结果后,如果在响应超时时间3秒内返回的HTTP状态码为200,则表示接收成功。其他HTTP状态码或响应时间大于3秒后返回状态码均视为接收失败,接收失败时,内容安全将重复发送多次检测结果。 seed 否 String 用于回调通知时校验请求是由华为云内容安全服务发起,您可以自定义。值为随机字符串,由英文字母、数字、下划线组成,不超过64个字符。 说明: 当seed非空时,headers中将包含X-Auth-Signature字段,字段的值使用HmacSHA256算法生成,待加密字符串由create_time、job_id、request_id、seed按照顺序拼接而成,密钥为seed。 表4 data 参数 是否必选 参数类型 描述 url 是 String 文档url。目前支持:公网HTTP/HTTPS URL。 format 是 String 文档格式。可选值: docx/pdf/doc/xls/xlsx/ppt/pptx/pps/ppsx/ xltx/xltm/xlsb/xlsm/txt/csv/epub/webpage,如果format与文档实际格式不一致,则返回结果会报参数错误。 frame_interval 否 Integer 当需要审核网页视频时,视频截帧频率间隔,单位为秒,取值范围为1~60s,如果不传递默认5s截帧一次。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 request_id String 本次请求的唯一标识,用于问题排查,建议保存。 job_id String 作业唯一标识。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 响应示例 状态码: 200 成功响应示例 { "job_id" : "01661356800_7c0fe871f80543358917e4faebca4a48", "request_id" : "07490f57ac5e034c077ab25b5f9e1da5" } 状态码: 400 失败响应示例 { "error_code" : "AIS.0401", "error_msg" : "The input parameter event_type is incorrect." }
  • 请求示例 创建视频流内容审核作业。 POST https://{endpoint}/v3/{project_id}/moderation/video-stream/jobs { "data" : { "url" : "xxx", "frame_interval" : 3 }, "event_type" : "default", "image_categories" : [ "politics", "porn", "image_text", "terrorism" ], "audio_categories" : [ "porn", "ad", "politics", "moan", "abuse" ], "callback" : "xxx" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 request_id String 本次请求的唯一标识,用于问题排查,建议保存。 job_id String 作业唯一标识。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 响应示例 状态码: 200 成功响应示例 { "job_id" : "01661356800_7c0fe871f80543358917e4faebca4a48", "request_id" : "07490f57ac5e034c077ab25b5f9e1da5" } 状态码: 400 失败响应示例 { "error_code" : "AIS.0401", "error_msg" : "The input parameter event_type is incorrect." }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 data 是 data object 视频流数据输入。 event_type 是 String 事件类型,可选值为default,default表示默认事件。 image_categories 是 Array of strings 视频流中画面需要检测的风险类型,列表不能为空。 可选择的风险类型如下: porn:鉴黄内容的检测 terrorism:暴恐内容的检测 image_text:图文违规内容的检测(检测图片中出现的广告、色情、暴恐的文字违规内容以及二维码内容) audio_categories 否 Array of strings 视频流中音频需要检测的风险类型,不传或为空时表示不审核音频维度。 可选择的风险类型如下: porn:涉黄检测 abuse: 辱骂检测 ad: 广告检测 moan: 娇喘检测 callback 是 String 该字段非空时,检测结果会回调通知您的URL。视频流未结束时,检测片段违规时回调客户端,视频流结束时,检测片段违规或正常都将回调客户端。 说明: 您的callback接口需要支持POST方法; 回调数据格式,请参考查询视频内容审核作业的响应示例; 您的服务端callback接口收到内容安全发送的结果后,如果在响应超时时间3秒内返回的HTTP状态码为200,则表示接收成功。其他HTTP状态码或响应时间大于3秒后返回状态码均视为接收失败,接收失败时,内容安全将重复发送多次检测结果。 seed 否 String 用于回调通知时校验请求是由华为云内容安全服务发起,您可以自定义。值为随机字符串,由英文字母、数字、下划线组成,不超过64个字符。 说明: 当seed非空时,headers中将包含X-Auth-Signature字段,字段的值使用HmacSHA256算法生成,待加密字符串由create_time、job_id、request_id、seed按照顺序拼接而成,密钥为seed。 表4 data 参数 是否必选 参数类型 描述 url 是 String 视频流url,支持rtmp、rtmps、hls、http、https等主流协议。 frame_interval 否 Integer 截帧频率间隔,单位为秒,取值范围为1~60s;如果不传递默认5s截帧一次。
  • 请求示例 创建音频流内容审核作业请求体 POST https://{endpoint}/v3/{project_id}/moderation/audio-stream/jobs { "data" : { "url" : "https://xxxxx" }, "event_type" : "default", "categories" : [ "porn", "ad" ], "callback" : "http://xxxx" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 request_id String 本次请求的唯一标识,用于问题排查,建议保存。 job_id String 作业唯一标识。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 响应示例 状态码: 200 成功响应示例 { "job_id" : "01661356800_7c0fe871f80543358917e4faebca4a48", "request_id" : "07490f57ac5e034c077ab25b5f9e1da5" } 状态码: 400 失败响应示例 { "error_code" : "AIS.0401", "error_msg" : "The input parameter event_type is incorrect." }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 data 是 data object 音频流数据输入。 event_type 是 String 事件类型,可选值如下: default:默认事件 audiobook:有声书 education:教育音频 game:游戏语音房 live:秀场直播 ecommerce:电商直播 voiceroom:交友语音房 private:私密语音聊天 categories 是 Array of strings 需要检测的风险类型,列表不能为空。可选择的风险类型如下: porn:涉黄检测 abuse: 辱骂检测 ad: 广告检测 moan: 娇喘检测 callback 是 String 该字段非空时,检测结果会回调通知您的URL。音频流未结束时,检测片段违规时回调客户端,音频流结束时,检测片段违规或正常都将回调客户端。 说明: 您的callback接口需要支持POST方法; 回调数据格式,请参考查询音频内容审核作业的响应示例; 您的服务端callback接口收到内容安全发送的结果后,如果在响应超时时间3秒内返回的HTTP状态码为200,则表示接收成功。其他HTTP状态码或响应时间大于3秒后返回状态码均视为接收失败,接收失败时,内容安全将重复发送多次检测结果。 seed 否 String 用于回调通知时校验请求是由华为云内容安全服务发起,您可以自定义。值为随机字符串,由英文字母、数字、下划线组成,不超过64个字符。 说明: 当seed非空时,headers中将包含X-Auth-Signature字段,字段的值使用HmacSHA256算法生成,待加密字符串由create_time、job_id、request_id、seed按照顺序拼接而成,密钥为seed。 表4 data 参数 是否必选 参数类型 描述 url 是 String 音频流url地址,支持rtmp、rtmps、hls、http、https等主流协议。 language 否 String 支持检测的音频流语言。可选值为zh:中文。 不传该参数表示默认为zh。 return_all_results 否 Boolean 返回音频片段结果的策略。可选值如下: false:返回风险等级为非pass的音频片段结果。 true:返回所有风险等级的音频片段结果 说明: 1. 默认值为false。 2. 每隔10秒返回一次最近10秒音频流的审核结果。
  • 响应示例 状态码: 200 成功响应示例 { "request_id" : "53f9719c3730d1169e47403d5c8a9473", "result" : { "category" : "porn", "details" : [ { "category" : "porn", "confidence" : 0.9934315, "label" : "sexy_female", "suggestion" : "review" }, { "category" : "porn", "confidence" : 0.99798274, "label" : "intimacy", "suggestion" : "review" } ], "suggestion" : "review" } } 状态码: 400 失败响应示例 { "error_code" : "AIS.0402", "error_msg" : "The image format is not supported." }
共100000条