MENU
      View training

        View training


        Article summary

        Available in Classic and VPC

        Get training information for a specific service among the created services.

        Request

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

        MethodURI
        GET/services/{serviceId}/trains/{trainType}/versions/{version}

        Request headers

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

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        serviceIdStringRequiredService ID
        trainTypeStringRequiredPost-training recommendation 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
        versionStringRequiredTraining version

        Request example

        The following is a sample request.

        curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/services/6wxgu******/trains/pop/versions/maqll******' \
        --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'
        Shell

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        serviceIdString-Service ID
        typeString-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
        hpConfigObject-Hyperparameter optimization (HPO) settings information
        hpConfig.is_enabledBoolean-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
        versionString-Training version
        descriptionString-Training description
        statusString-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
        createdDateString-Service creation date and time
        inferenceBoolean-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.

        {
            "serviceId": "6wxgu******",
            "type": "pop",
            "hpConfig": {
                "is_enabled": false
            },
            "version": "maqll******",
            "status": "learningFailed",
            "createdDate": "2024-07-30T11:25:36.558",
            "inference": true
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.