更新时间:2023-05-24 GMT+08:00
分享

查询全局特征配置

功能介绍

该接口用于查询全局特征配置。

URI

POST /v1/{project_id}/globalFeatures

参数说明请参见表1-URI参数说明
表1 URI参数说明

名称

是否必选

类型

说明

project_id

String

项目编号,用于资源隔离。获取方法请参见获取项目ID

请求消息

请求参数如表2所示。

表2 请求参数说明

参数名称

是否必选

参数类型

说明

global_features_information_path

String

全局特征文件OBS路径。

响应消息

响应参数请参见表3

表3 响应参数说明

参数名称

参数类型

说明

is_success

Boolean

请求是否成功。

global_features

Object

全局特征表4

error_code

String

请求失败时的错误码,请求成功时无此字段。

error_msg

String

请求失败时的错误信息,请求成功时无此字段。

表4 global_features参数说明

参数名称

参数类型

说明

user_features

List

用户特征列表。

item_features

List

物品特征列表。

表5 user_features 和 item_features参数说明

参数名称

参数类型

说明

feature_name

String

特征名称。

feature_type

String

特征类型。

feature_value_type

String

特征值类型。

示例

  • 请求示例
    {
      "global_features_information_path": "<全局特征文件OBS路径>"
    }
  • 成功响应示例
    {
        "is_success": true,
        "global_features": {
            "user_features": [
                {
                    "feature_name": "provinceId",
                    "feature_type": "BASIC_INFO",
                    "feature_value_type": "string"
                },
                {
                    "feature_name": "salary",
                    "feature_type": "BASIC_INFO",
                    "feature_value_type": "numerical"
                },
                {
                    "feature_name": "hobbies",
                    "feature_type": "BASIC_INFO",
                    "feature_value_type": "strArray"
                },
                {
                    "feature_name": "user_tags",
                    "feature_type": "TAGS",
                    "feature_value_type": "map"
                },
                {
                    "feature_name": "payment_type",
                    "feature_type": "CONTEXT",
                    "feature_value_type": "string"
                }
            ],
            "item_features": [
                {
                    "feature_name": "product_name",
                    "feature_type": "BASIC_INFO",
                    "feature_value_type": "string"
                },
                {
                    "feature_name": "order_price",
                    "feature_type": "BASIC_INFO",
                    "feature_value_type": "numerical"
                },
                {
                    "feature_name": "categories",
                    "feature_type": "BASIC_INFO",
                    "feature_value_type": "strArray"
                },
                {
                    "feature_name": "item_tags",
                    "feature_type": "TAGS",
                    "feature_value_type": "map"
                }
            ]
        }
    }
  • 失败响应示例
    { 
        "is_success": false, 
        "error_code": "res.1006", 
        "error_msg": "The content for the request is invalid." 
    }

状态码

状态码请参见状态码

相关文档