Help Center> RES> API Reference> APIs (Old Version)> Job-related APIs> Submitting Feature Engineering Jobs> Viewing Global Feature File Configurations
View PDF

Viewing Global Feature File Configurations

Function

This API is used to view the global feature file configurations.

URI

POST /v1/{project_id}/globalFeatures

Table 1 describes the URI parameters.
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter

Mandatory

Type

Description

global_features_information_path

Yes

String

OBS path for storing global feature files

Response

Table 3 describes the response parameters.

Table 3 Response parameters

Parameter

Type

Description

is_success

Boolean

Whether the request is successful

global_features

Object

Global feature. For details, see Table 4.

error_code

String

Error code that indicates a request has failed. This parameter is unavailable when a request is successful.

error_msg

String

Error message that indicates a request has failed. This parameter is unavailable when a request is successful.
Table 4 global_features parameters

Parameter

Type

Description

user_features

List

List of user features

item_features

List

List of item features
Table 5 user_features and item_features parameters

Parameter

Type

Description

feature_name

String

Feature name

feature_type

String

Feature type

feature_value_type

String

Feature value type

Example

  • Example request 
    {
  "global_features_information_path": "<OBS path for storing the global feature files>"
}
  • Example of a successful response 
    {
    "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"
            }
        ]
    }
}
  • Example of a failed response 
    { 
    "is_success": false, 
    "error_code": "res.1006", 
    "error_msg": "The content for the request is invalid." 
}

Status Code

For details about status codes, see Status Codes.