根据上传文件创建人工标签--增长分析 DataFinder-火山引擎

文档中心

立即注册

导航

增长分析 DataFinder

根据上传文件创建人工标签

最近更新时间：2024.06.30 18:36:02首次发布时间：2024.06.30 18:36:02

请求说明

Path：/finder/openApi/v2/atlas/labelMeta/manualLabel
Method: POST
Content-type: application/json

请求参数

Header:

参数	类型	是否必选	示例值	描述
X-Tenant	Int	是	1	项目id

Body:

参数	类型	是否必选	示例值	描述
name	String	是	manual22	标签名称
labelEntityType	String	是	baseid	标签实体类型
appId	Int	是	1	项目id
descr	String	否	无	标签描述
dataTypeName	String	是	string	标签数据类型
conf	Json	否	见下文请求示例	标签配置，如果需要上传文件可以配置其中的manualProperty，dataModelId为上传文件API返回id
labelRangeRules	Json	是	见下文请求示例	人工标签枚举值规则文本&多值文本类型规则： `"labelRangeRules": { "value": { "enumValue": ["男", "女"] } }` 数值类型规则： `"labelRangeRules": { "value": { "minValue": 1, "maxValue": 5 } }`

Body样例:

{
    "name": "manual22",
    "labelEntityType": "baseid",
    "conf": {
        "manualProperty": {
            "dataModelId": 374
        }
    },
    "appId": 1,
    "descr": "",
    "dataTypeName": "string",
    "labelRangeRules": {
        "value": {
            "enumValue": ["男", "女"]
        }
    }
}

返回参数

Response:

{
  "JSONIFY_PRETTYPRINT_REGULAR": false, 
  "code": 0, 
  "data": {
    "labelId": 42
  }, 
  "msg": "成功"
}

字段含义说明

Field	Type	Description
code	int	状态码
message	string	返回message
labelId	int	创建成功的标签id

请求示例

bc 为创建的 RangersClient, 其初始化请参考使用说明，各语言的 SDK 都提供了类似的接口
调用(Python)：

body = {
    "name": "manual22",
    "labelEntityType": "baseid",
    "conf": {
        "manualProperty": {
            "dataModelId": 373
        }
    },
    "appId": 1,
    "descr": "",
    "dataTypeName": "string",
    "labelRangeRules": {
        "value": {
            "enumValue": ["男", "女"]
        }
    }
}
res = bc.request(method='POST', service_url='/finder/openApi/v2/atlas/labelMeta/manualLabel', headers={'x-Tenant': "1", "Content-Type": "application/json"}, body=body)
print(res.content)
print(json.loads(res.content))

返回示例

返回结果：

{
    "JSONIFY_PRETTYPRINT_REGULAR":false,
    "code":0,
    "data":{
        "labelId":3
    },
    "msg":"成功"
}