Requesting service cycle learning
- Print
- PDF
Requesting service cycle learning
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.
Request service learning.
PUT https://aitems.apigw.ntruss.com/api/v1/services/{serviceId}/schedule?action=start
Requests
Request parameters
Parameters | Requirement status | Type | Restrictions | Description |
---|---|---|---|---|
serviceId | Yes | String | Service ID created | |
action | Yes | String | start, stop | Whether to start or stop cycle learning |
Request bodies
Parameters | Requirement status | Type | Restrictions | Description |
---|---|---|---|---|
trainTypes | Yes | Array | personalRecommend, pop | Learning request type |
description | No | String | Enter 0 to 100 characters | Learning description |
hpConfig.is_enabled | Yes | Boolean | HPO setting status | |
hpConfig.{option} | No | String, Int | Set HPO value |
HPO(Hyper parameter option)
Option name | Requirement status | Type | Learning type | Restrictions | Description |
---|---|---|---|---|---|
session_max_timestamp | No | Long | Personalized recommendation and related recommendations | - Default: 1800 - Min: 5 - Max: none | - Maximum idle time between actions to be regarded as the same sessions (seconds) - Recommend 1800 (30 minutes) or longer |
item_top_n | No | Long | Personalized recommendation and related recommendations | - Default: 20000 - Min: 1000 - Max: 500000 | - Maximum number of products to use for recommendation - Use in the order of popularity |
min_item_cut | No | Long | Personalized recommendation and related recommendations | - Default: 5 - Min: 1 - Max: none | Minimum number of conditions for showing product |
min_session_length | No | Long | Personalized recommendation and related recommendations | - Default: 2 - Min: 2 - Max: none | Minimum number of actions within a session |
max_user_recommend_top | No | Long | Personalized recommendation | - Default: 100 - Min: 1 - Max: 1000 | Maximum number of recommended products per user |
max_relate_recommend_top | No | Long | Related recommendations | - Default: 100 - Min: 1 - Max: 1000 | Maximum number of related recommended products per product |
remove_history_item | No | Boolean | Personalized recommendation and related recommendations | - Default: false | Removal status of a product that already has a history from personalized recommendation |
group_column | Yes | Array | Popular product | Cannot select USER_ID, ITEM_ID, TIMESTAMP | List of group columns extracted by popularity |
target_column | No | String | Popular product | Cannot select USER_ID, ITEM_ID, TIMESTAMP | Target columns to be extracted by popularity |
max_group_recommend_top | No | Long | Popular product | - Default - 100 - Min: 1 - Max: 1000 | Maximum number of popular products per group |
Responses
Field | Type | Description | Note |
---|---|---|---|
serviceId | String | Service ID | |
name | String | Service name | |
description | String | Service description | |
status | String | Service status | |
datasets[].datasetId | String | Dataset ID set to the service | |
datasets[].type | String | Dataset type set to the service | |
datasets[].name | String | Dataset name set to the service | |
datasets[].schemaName | String | Dataset schema name set to the service | |
datasets[].status | String | Dataset status set to the service | |
datasets[].createdDate | String | Dataset creation date set to the service | |
datasets[].updatedDate | String | Last update of dataset set to the service | |
hpConfig.is_enabled | Boolean | HPO setting status | |
hpConfig.{option} | String | Set HPO value | |
infers[].dataType | String | Learning result dataset type | |
infers[].trainVersion | String | Learning result version | |
infers[].status | String | Learning result status | |
infers[].rowCount | String | Number of learning results | |
createdDate | String | Service creation date | |
updatedDate | String | Last update | |
type | String | Service type | |
learningInterval | String | Update cycle | |
scheduledDate | String | Update base time |
Response status
HTTP Status | Desc |
---|---|
200 | OK (Successfully requested) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Examples
Request examples
PUT /api/v1/services/49qkb0fbnar/schedule?action=start
Host: aitems.apigw.ntruss.com
accept: application/json
x-ncp-iam-access-key: {Access key}
x-ncp-apigw-signature-v2: {API GW signature}
x-ncp-apigw-timestamp: {timestamp}
{
"trainTypes": [
"personalRecommend"
],
"description": "test",
"hpConfig": {
"is_enabled": false
}
}
Response examples
{
"serviceId": "49qkb0fbnar",
"name": "movie-service",
"description": "",
"status": "scheduled",
"datasets": [
{
"datasetId": "7qkv2ox8211",
"type": "interaction",
"name": "m-interaction",
"schemaName": "movie_interaction",
"status": "learnable",
"createdDate": "2021-09-15T18:19:22.709",
"updatedDate": "2021-11-22T17:03:35.844"
},
{
"datasetId": "qc80eu7udo9",
"type": "user",
"name": "m-user",
"schemaName": "movie_user",
"status": "learnable",
"createdDate": "2021-09-15T18:18:58.123",
"updatedDate": "2021-11-22T16:01:38.486"
},
{
"datasetId": "ap0l4f72e9f",
"type": "item",
"name": "m-item",
"schemaName": "movie_item",
"status": "learnable",
"createdDate": "2021-09-15T18:19:10.454",
"updatedDate": "2021-11-22T17:04:35.977"
}
],
"hpConfig": {
"is_enabled": false,
"group_column": [
"AGE"
]
},
"infers": [
{
"dataType": "personalRecommend",
"trainVersion": "owpayt7nw1n",
"status": "enable",
"rowCount": 1113,
"createdDate": "2021-11-24T15:24:06.62",
"updatedDate": "2021-11-24T15:24:18.162"
},
{
"dataType": "relatedItem",
"trainVersion": "owpayt7nw1n",
"status": "enable",
"rowCount": 2641,
"createdDate": "2021-11-24T15:24:06.686",
"updatedDate": "2021-11-24T15:24:20.902"
},
{
"dataType": "pop",
"trainVersion": "owpayt7nw1n",
"status": "enable",
"rowCount": 92,
"createdDate": "2021-11-24T15:17:29.353",
"updatedDate": "2021-11-24T15:17:39.565"
}
],
"createdDate": "2021-09-29T11:36:50.217",
"updatedDate": "2021-11-24T15:24:20.985"
"type": "interval",
"learningInterval": "hour6",
"scheduledDate": "2021-11-18T15:17:12.968"
}
Was this article helpful?