View training list

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Get the list of all training requests.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET	/services/{serviceId}/trains

Request headers

For headers common to all AiTEMS APIs, see Common AiTEMS headers.

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`offset`	Integer	Optional	Start location of query data Default: 0
`limit`	Integer	Optional	Maximum number of query data Default: 1000

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`serviceId`	String	Required	Service ID Check through Get service list

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`isRecent`	Boolean	Optional	Whether the item was recently requested for each type `true` \| `false` `true`: recently requested item `false`: not a recently requested item

Request example

The following is a sample request.

curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/services/6wxgu******/trains
?isRecent=true' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`trains`	Array	-	Training information
`offset`	Integer	-	Start location of query data
`limit`	Integer	-	Maximum number of query data

`trains`

The following describes trains.

Field	Type	Required	Description
`serviceId`	String	-	Service ID
`type`	String	-	Training request type `personalRecommend` \| `relatedItem` \| `pop` `personalRecommend`: personalized recommendations based on customer service users' past history `relatedItem`: personalized recommendations based on an item's association history `pop`: top item recommendations by rank
`hpConfig`	Object	-	Hyperparameter optimization (HPO) settings information
`hpConfig.is_enabled`	Boolean	-	HPO configuration status `true` \| `false` `true`: HPO configured, optimal training models can be implemented `false`: HPO not configured, trained by AiTEMS' own internal algorithms
`hpConfig.{option}`	String, Long, Boolean	-	Configured HPO value See HPO for value details
`version`	String	-	Training version
`description`	String	-	Training description
`status`	String	-	Training status `ready` \| `learning` \| `completed` \| `waiting` \| `requesting` \| `requestFailed` \| `refinedFailed` \| `stopping` \ `learningFailed` `ready`: ready (training available) `learning`: training in progress `completed`: training completed `waiting`: training execution pending `requesting`: requesting training `requestFailed`: training request failed `refinedFailed`: data refinement failed `stopping`: stopping `learningFailed`: training failed
`createdDate`	String	-	Service creation date and time
`nextUpdateDate`	String	-	Next scheduled update date and time for the service
`inference`	Boolean	-	Inference result status `true` \| `false` `true`: result found `false`: no result found

Response status codes

For response status codes common to all AiTEMS APIs, see Common AiTEMS API response status codes.

Response example

The following is a sample example.

{
    "trains": [
        {
            "serviceId": "6wxgu******",
            "type": "pop",
            "hpConfig": {
                "is_enabled": false
            },
            "version": "maqll******",
            "status": "stopping",
            "createdDate": "2024-07-30T11:25:36.558",
            "inference": false
        }
    ],
    "offset": 0,
    "limit": 1000
}

Was this article helpful?

What's Next

View training

Table of contents

Request
Response