Create custom attributes
- Print
- PDF
Create custom attributes
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Create a profile of custom attributes.
When you request to create a profile, the creation process will proceed according to the following sequence.
| Order | Creation status | Description |
|---|---|---|
| Step 1 | registered: registered | Status where the creation job is registered in the NCLUE system
|
| Step 2 | pending: pending | Status where the creation job is queued in the system |
| Step 3 | in_progress: creating | Status where the creation job is running on the server |
| Step 4 |
| Status where the creation job has been completed
|
Note
The duration of each job when creating a profile depends on the amount of data and service's available resources. To check the progress of the creation, call the Get custom attributes API and check the status field in the response body.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| POST | /profile/custom-attributes |
Request headers
For information about the headers common to all NCLUE APIs, see NCLUE request headers.
Request body
You can include the following data in the body of your request:
| Field | Type | Required | Description |
|---|---|---|---|
name | String | Required | Profile name
|
feature_id | String | Required | Feature ID to apply for profiling
|
keyword_set | String | Required | List of attribute keywords to check the similarity to the target user
|
result_bucket | String | Required | Name of the Object Storage bucket where the profiling result will be stored |
result_file_path | String | Required | File path in result_bucket to store the profiling results
|
Request example
The request example is as follows:
curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/profile/custom-attributes' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' \
--data '{
"name": "YOUR_PROFILE_NAME",
"feature_id": "1be871f6-****-****-****-827671fa8fdb",
"keyword_set": "Running\nrun\nmarathon\njogging\nrunning shoes\nrunning socks\nrunning app",
"result_bucket": "YOUR_BUCKET_NAME",
"result_file_path": "path/filename"
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
| Field | Type | Required | Description |
|---|---|---|---|
profile_id | String | - | Profile ID |
profile_name | String | - | Profile name |
feature_id | String | - | Feature ID to profile |
feature_name | String | - | Feature name to profile |
keyword_set | String | - | Attribute keyword list
|
created_at | String | - | Profile creation request date and time (ISO 8601 format) |
result_bucket | String | - | Name of the Object Storage bucket where the profiling result will be stored |
result_file_path | String | - | File path in result_bucket where the profiling result will be stored |
Response status codes
For response status codes common to NCLUE, see NCLUE response status codes.
Response example
The response example is as follows:
{
"profile_id": "a7f4f996-****-****-****-b0531230e17e",
"profile_name": "YOUR_PROFILE_NAME",
"feature_id": "1be871f6-****-****-****-827671fa8fdb",
"feature_name": "YOUR_FEATURE_NAME",
"keyword_set": "Running, run, marathon, jogging, running shoes, running socks, running app",
"created_at": "2024-11-26T17:25:42+09:00",
"result_bucket": "YOUR_BUCKET_NAME",
"result_file_path": "path/filename"
}
Was this article helpful?