华为云用户手册

响应示例 { "result": [ { "RegisterMatrix": [ [ 1, 0, 0 ], [ 0, 1, 0 ], [ 0, 0, 1 ] ] }, { "Box": { "Y": 0, "Width": 100, "Angle": 0, "X": 0, "Height": 100 }, "Score": 0.9, "label": "person" } ] }

功能介绍 找出图像中所有感兴趣的目标，确定它们的位置和类别。物体检测-N模型特点是参数量适中，适合在资源有限的环境中使用，提供较快的检测速度和合理的精度。 服务调用方式： 支持图片推理和视频推理。 图片、视频推理支持在线和边缘部署。 视频推理调用方式，需在创建部署任务时设置环境变量，添加rtsp视频流地址： 添加环境变量，名称 “ADDRS”。环境变量的值为视频流地址，格式示例：rtsp://{边缘节点地址:端口}/{rtsp视频流地址} 模型推理结果需在容器日志中查询，远程登录到部署服务器后，执行docker ps命令获取容器列表及其信息。 记录部署任务名称，进入ModelArts服务的模型部署导航栏中按照模型的部署形式，进入在线服务、边缘服务页签按照任务名称找到对应的任务ID。按创建部署任务时生成的任务ID在容器信息中查找，找到与名称对应的CONTAINER ID。 执行docker logs -f {CONTAINER ID}命令查看容器日志。在容器日志中可查看推理执行过程，搜索“result”可获取推理结果。

URI 图片接口：POST /v1/{project_id}/infer-api/proxy/service/{deployment_id}/ 视频接口：POST /v1/{project_id}/infer-api/proxy/service/{deployment_id}/v1/video/set_data/ 获取URI方式请参见请求URI。 表1 推理接口路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参见获取项目ID。 deployment_id 是 String 模型的部署ID，获取方法请参见获取模型部署ID。

向量&重排专业大模型 模型介绍 Pangu-EmbeddingRank模型，用于大模型RAG场景。在ModelArts Studio大模型开发平台部署Pangu-EmbeddingRank模型，会生成Embedding模型服务、Rerank模型服务两个服务。这两个服务均可以在Agent开发平台中创建知识库中被使用。 推理特性 推理精度 FP16 起推规格（推理单元） 1 QPS 6 Embedding模型服务 Rerank模型服务 父主题： 模型推理接口

URI POST /v1/{project_id}/infer-api/proxy/service/{deployment_id}/perm-feat-importance 获取URI方式请参见请求URI。 表1 推理接口路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参见获取项目ID。 deployment_id 是 String 模型的部署ID，获取方法请参见获取模型部署ID。

请求示例 { "data": [ { "feature_1": xx, "feature_2": xx, ... "feature_n": xx, "target": 0, }, ... { "feature_1": xx, "feature_2": xx, ... "feature_n": xx, "target": 1 } ], "fi_args":{ "num_shuffle_sets": 1, "sample_num": 1000 } } 此处data列表的长度至少为1000，建议通过以下代码根据csv文件生成请求体（DATA_NUM为从csv文件中采样数据的数量）： import random import json import pandas as pd ENCODING_TYPE = "utf-8" DATA_NUM = 1200 data_path = "path/to/xxx.csv" df = pd.read_csv(data_path, encoding=ENCODING_TYPE) data_list = df.to_dict("records") data_list = random.sample(data_list, DATA_NUM) request_data = { "data": data_list, "fi_args": { "num_shuffle_sets": 1, "sample_num": 1000, } } request_str = json.dumps(request_data) print(request_str)

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result Object 预测结果信息。 pred_proba Array 预测结果对应的置信度，每条结果为一个Dict，Dict的键值对分别表示预测结果、置信度。 说明：请求字段predict_proba配置为true时，响应body才返回pred_proba子项，否则无该子项。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息

请求示例 { "data": [ { "feature_1": xx, "feature_2": xx, ... "feature_n": xx }, ... { "feature_1": xx, "feature_2": xx, ... "feature_n": xx } ]， "predict_proba": true }

响应示例 { "result": [ "0", "1", ... "0" ], "pred_proba": [ { “0”: 0.791, “1”: 0.209 }, { “0”: 0.103, “1”: 0.897 }, ... { “0”: 0.665, “1”: 0.335 }, ] }

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 data 是 Array 参数解释： 待进行预测的数据，data为一个数组，数组中包含多个对象，每个对象是一组完整的特征数据。 约束限制： 待预测特征名需要与训练数据中的特征名保持一致。例如，训练数据中特征列按照feature_1、feature_2……进行命名，在调用推理接口时，特征名也需要保持相同。同时推理接口中特征数量需要与训练数据中的特征数保持一致。一组特征数据填写完成后再填写剩余待预测数据，格式详见请求示例。 取值范围： 输入数据中的一组数据。 默认取值： 预测大模型在训练完成后，可以在训练日志页面，“模型训练”日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 predict_proba 否 boolean 参数解释： 是否输出置信度 约束限制： 无 取值范围： true或false 默认取值： 非必填项，默认false。

请求示例 { "context_len": 256, "data": [ { "context": { "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328，...] } }, { "context": { "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328，...] } } ] }

响应示例 { "data": [ { "prediction":{ "label": 0 } } ], "time_cost": { "infer_cost_time": "82.609 ms", "postprocess_cost_time": "0.29 ms", "preprocess_cost_time": "0.1332 ms", "service_cost_total_time": "84.965 ms" } }

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 data 是 Array 参数解释： 时序数据请求的批处理队列。 约束限制： 盘古时序预测分类任务的输入数据内容，用字典承载。输入数据字典中，键对应特征列名，值为序列数据具体内容。 取值范围： 输入数据中的一行数据。 默认取值： 预测大模型在训练完成后，可以在训练日志页面，“模型训练”日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 context_len 否 int 参数解释： 时序任务的数据窗口大小，该参数主要服务于支持多尺度窗口的模型的推理。 约束限制： 填写时需要保证输入序列长度大于等于该值。 取值范围： min:32 max:512 -1为当前服务模型的默认大小。 默认取值： 128

请求示例 { "data": [ { "feature_1": xx, "feature_2": xx, ... "feature_n": xx }, ... { "feature_1": xx, "feature_2": xx, ... "feature_n": xx } ]， "predict_proba": true }

响应示例 { "result": [ "0", "1", ... "0" ], "pred_proba": [ { “0”: 0.791, “1”: 0.209 }, { “0”: 0.103, “1”: 0.897 }, ... { “0”: 0.665, “1”: 0.335 }, ] }

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 data 是 Array 参数解释： 待进行预测的数据，从输入的特征数据中检测是否存在异常值。 约束限制： data为一个数组，数组中包含多个对象，每个对象是一组完整的特征数据。 待预测特征名需要与训练数据中的特征名保持一致。例如，训练数据中特征列按照feature_1、feature_2……进行命名，在调用推理接口时，特征名也需要保持相同。同时推理接口中特征数量需要与训练数据中的特征数保持一致。一组特征数据填写完成后再填写剩余待预测数据，格式详见请求示例。 取值范围： 输入数据中的一组数据。 默认取值： 预测大模型在训练完成后，可以在训练日志页面，“模型训练”日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 predict_proba 否 boolean 参数解释： 是否输出置信度 约束限制： 无 取值范围： true或false 默认取值： 非必填项，默认false。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result Object 预测结果信息。 pred_proba Array 预测结果对应的置信度，每条结果为一个Dict，Dict的键值对分别表示预测结果、置信度。 说明：请求字段predict_proba配置为true时，响应body才返回pred_proba子项，否则无该子项 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

请求示例 POST 'http://10.155.96.123:9099/pangu/search/v1/rerank' \ --header 'Content-Type: application/json' \ --data '{ "query": "南京", "rerank_order": [ "title", "content" ], "docs": [ { "id": "a01", "title": "南京", "content": "简介：南京一般指南京市。 南京市，简称“宁”，古称金陵、建康，江苏省省会、副省级市、特大城市、南京都市圈核心城市，国务院批复确定的中国东部地区重要的中心城市、全国重要的科研教育基地和综合交通枢纽。" }, { "id": "a02", "title": "南京", "content": "南京市人民政府关于市政府领导同志工作分工的通知 · 南京市人民政府2021年政府信息公开工作年度报告 " }, { "id": "a03", "title": "南京", "content": "唐代以成都为南京不到三年时间。 [1] 宋大中祥符七年（1014年），建应天府（今商丘）为南京。 [2-5] 辽代，以北京为南京。金代，以开封为南京。明永乐十九年（1421年），明成祖迁都，京师应天府（今南京）改称为南京，作为留都。" }, { "id": "a04", "title": "南京", "content": "《南京市推进城市运行“一网统管”暂行办法》(下简称《办法》)3月1日将开始施行。" }, { "id": "a05", "title": "南京", "content": "一年下来,南京的大部分地方基本都去过了,因为朋友要来国庆玩嘛,问我哪里有什么好玩的地方,所以就决定写这篇日志了。 " }, { "id": "a06", "title": "南京", "content": "南京市人防指挥信息保障中心民防大厦消防设备采购中标结果公告 电台升级设备采购项目中标结果公告 南京人防短波电台升级改造设备采购项目招标公告 姚坊门水土保持验收中标候..." }, { "id": "a07", "title": "南京", "content": "1993年11月，京南乡、长发乡分别改为镇。2005年7月，长发镇并入京南镇。行政区划 1984年，辖京南、旺安、古榄、思蓬、儒垌、城垌、太平、大岸、纯冲、古参共10个村。2011年末，京南镇辖京南、长发2个社区，京南、旺安、古榄、..." }, { "id": "a08", "title": "南京", "content": "身为首都的北京，是全国四大直辖市中唯一没有“副省级新区”的城市，而天津、重庆以及更早的上海，从制造业为核心的经济新区中获得的“速度效益”，则让北京对“京南新区”充满期许。" }, { "id": "a09", "title": "南京", "content": "落实科技成果转化财税奖补政策，对输出技术合同、吸纳技术合同（技术开发、技术转让）进行补助；推进“京津研发，沧州转化”，深化与京津合作，进一步吸引京津成果落地转化。..." } ], "top_n": 10 }'

响应示例 {"rank_result": [{"score": 0.9975486397743225, "id": "a01"}, {"score": 0.7712018489837646, "id": "a03"}, {"score": 0.37750864028930664, "id": "a06"}, {"score": 0.22653242945671082, "id": "a09"}, {"score": 0.11012815684080124, "id": "a02"}, {"score": 0.08153211325407028, "id": "a05"}, {"score": 0.028581004589796066, "id": "a04"}, {"score": 0.01370169036090374, "id": "a07"}, {"score": 0.010038669221103191, "id": "a08"}], "ret": 0, "cost": 0.5570168495178223}

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 rank_result List[OBJECT] rerank的结果。 ret String 错误码。 cost Float 模型推理耗时。 表6 rank_result 字段 参数 参数类型 描述 id String rerank的文本id。 score Float rerank的排序分值。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 ret String 错误码。 msg String 错误信息。 rank_result List[List[Float]] embedding的结果，当错误时，是为空。 cost Float 处理时间。

请求参数 使用Token认证方式的请求Header参数见表1。 表1 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见3.1.6.1-表 请求Header参数（API Key认证）。 表2 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表3 请求Body参数 参数 是否必选 参数类型 描述 rerank_order 是 String 参数解释： docs 中多字段的拼接顺序， 配合doc字段，记录doc信息中的字段的优先级，影响rank的输入。 约束限制： 和docs中文本取值的具体字段名称有关。 取值范围： - 默认取值： - docs 是 List[Object] 参数解释： 要排序的文本，支持多字段输入；具体list中的结构见表4描述。 约束限制： 文本字符长度为1~200。 取值范围： - 默认取值： - query 是 String 参数解释： query信息。 约束限制： 查询字符长度为1~64。 取值范围： - 默认取值： - top_n 否 int 参数解释： 返回top_n的结果。 约束限制： - 取值范围： 0~200 默认取值：10 表4 docs 的字段 参数 是否必选 参数类型 描述 id 是 String 参数解释： 描述文本信息的唯一标识。 约束限制： id长度为1~20。 取值范围： - 默认取值： - title 否 String 参数解释： 描述文本标题。 约束限制： title和content不能同时为空。 字符串长度为1~10240。 取值范围： - 默认取值： - content 否 String 参数解释： 描述文本的内容。 约束限制： title和content不能同时为空。 字符串长度为1~10240。 取值范围： - 默认取值： -

请求示例 单图请求示例 { "images": "/9j/4Vr2RXhpZgAASUkqAAgAAA.....", } 批量请求示例（单次请求批次上限为24张图） { "images": ["/9j/4Vr2RXhpZgAASUkqAAgAAA.....", "/9j/4RIrRXhpZgAATU......"] } 带高级参数的单标签分类请求示例 { "images": ["/9j/4Vr2RXhpZgAASUkqAAgAAA.....", "/9j/4RIrRXhpZgAATU......"], "top": 3 } 带高级参数的多标签分类请求示例 { "images": ["/9j/4Vr2RXhpZgAASUkqAAgAAA.....", "/9j/4RIrRXhpZgAATU......"], "threshold": { "bird": 0.33, "blackbird": 0.44 } }

响应示例 响应返回一个字典，键为本次请求的输入图像的编号，对输入的图像按顺序从0开始编号；值为一个列表，列表里为该图像的预测结果，每张图像可能存在多个预测结果（例如多标签分类模式）。 { "0": [ { "label": "bird", "score": "0.95511043" }, { "label": "blackbird", "score": "0.75241840" }, ], "1": [ { "label": "bird", "score": "0.36211243" } ], "dataset_id": "1341002014632579072" }

功能介绍 根据在图像信息中所反映的不同特征，对图像进行定量分析，把图像划归为若干个类别中的某一种。适用于动植物分类、车辆类型分类、车牌分类、废钢定级、零部件分类等任务。 服务调用方式： 支持图片推理和视频推理。 图片、视频推理支持在线和边缘部署。 视频推理调用方式，需在创建部署任务时设置环境变量，添加rtsp视频流地址： 添加环境变量，名称 “ADDRS”。环境变量的值为视频流地址，格式示例：rtsp://{边缘节点地址:端口}/{rtsp视频流地址} 模型推理结果需在容器日志中查询，远程登录到部署服务器后，执行docker ps命令获取容器列表及其信息。 记录部署任务名称，进入ModelArts服务的模型部署导航栏中按照模型的部署形式，进入在线服务、边缘服务页签按照任务名称找到对应的任务ID。按创建部署任务时生成的任务ID在容器信息中查找，找到与名称对应的CONTAINER ID。 执行docker logs -f {CONTAINER ID}命令查看容器日志。在容器日志中可查看推理执行过程，搜索“result”可获取推理结果。

请求参数 使用Token认证方式的请求Header参数见表1。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表2。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 images 是 String/List[String] 参数解释：被检测图片的base64编码。 约束限制：单张图片请求时，参数类型为String，为图片的base64编码；批量请求时，参数类型为List[String]，以列表形式存放各图片的base64编码，单次请求不超过24张。 取值范围：建议整个请求体大小不超过4M，建议使用JPG、PNG、JPEG、BMP格式的图片。 默认取值：默认只支持RGB三通道图片数据，其他通道的数据暂不支持。 mode 否 String 参数解释：取值为"single"或者"multiple"，分别表示单标签分类和多标签分类模式，二者取一。 约束限制： 取值范围：取值为"single"或者"multiple"。 默认取值：默认设置为训练得到的模型对应的模式 threshold 否 dict 参数解释：多标签分类时，各标签对应的预测得分阈值，预测得分小于阈值的预测结果将会被过滤。 约束限制：仅在多标签分类模式下有效。 取值范围： 默认取值： top 否 int 参数解释：单标签分类时，用于规定输出top N的预测得分对应的预测结果。 约束限制：仅在单标签分类模式下有效。 取值范围： 默认取值：

响应参数 状态码： 200 响应成功返回的结构体是一个Dict，由本次请求的多张输入图像的预测结果组成，图像与图像之间通过编号（键）区分。 表5 单/多标签分类响应成功Body参数 参数 参数类型 描述 键 String 输入图像的顺序编号，从"0"开始，最大不超过"23"。 值 List[Dict] 当前编号的图像对应的预测结果。 dataset_id String 训练数据集ID。 其中，每张图像的预测结果参数类型为List[Dict]，表示预测得到的一个或多个类别，每个Dict的参数内容请参考表6。 表6 单张图像的单个类别预测结果参数 参数 参数类型 描述 label String 预测的类别，与训练数据中定义的类别相同。 score String 预测的置信度结果，输出每个标签对应的预测得分，得分区间为0至1。 状态码： 400 表7 响应失败Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

响应示例 { "lineages": [ { "id": null, "from_id": null, "from_name": null, "from_catalog": null, "from_type": "OBS", "to_id": "1352299121133883392", "to_name": null, "to_catalog": "ORIGINAL", "to_type": "DATASET", "process_id": null, "process_name": null, "process_type": null, "train_job_name": null, "model_type": null, "train_type": null, "create_time": null, "from_path": "bucket/folder", "from_path_existed": null }, { "id": "1352299380551585793", "from_id": "1352299121133883392", "from_name": "时序-回归-test", "from_catalog": "ORIGINAL", "from_type": "DATASET", "to_id": "1352299379473649664", "to_name": "pub_时序回归", "to_catalog": "PUBLISH", "to_type": "DATASET", "process_id": "lt_97a2aa4cca744775aa5c7cfe3cb36121", "process_name": "pub_时序回归", "process_type": "PUBLISH", "train_job_name": null, "model_type": null, "train_type": null, "create_time": null, "from_path": null, "from_path_existed": null } ] }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表2 请求Query参数 参数 是否必选 参数类型 描述 limit 是 integer 参数解释： 接口返回的血缘数量上限 约束限制： 无 取值范围： [1, 1000] 默认取值： 100 from_path 是 string 参数解释： 来源obs路径 约束限制： 最终租户桶下的OBS全路径 取值范围： 无 默认取值： 无

请求示例 GET https://{endpotint}/v1/{project_id}/workspaces/{workspace_id}/data-management/lineages?limit=100&from_path=bucket/folder1/folder2 Requet Header: Content_Type: application/json X-Auth-Token: MIIVV... Request Params: limit: 1000 from_path: bucket/folder1/folder2

响应示例 { "result": [ { "Box": { "Angle": 0, "Height": 60, "Width": 106, "X": 852, "Y": 182 }, "Score": 0.88427734375, "label": "car" }, { "Box": { "Angle": 0, "Height": 114, "Width": 55, "X": 800, "Y": 170 }, "Score": 0.70556640625, "label": "person" } ] }