Get update list
    • PDF

    Get update list

    • PDF

    Article summary

    Available in Classic and VPC

    Get the service update information.

    Request

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

    MethodURI
    GET/services/{serviceId}/updates

    Request headers

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

    Request path parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    serviceIdStringRequiredService ID

    Request query parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    typeStringRequiredTraining 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
    trainVersionStringRequiredTraining version

    Request example

    The following is a sample request.

    curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/services/49qkb******/updates
    ?type=personalRecommend
    &trainVersion=9fn93******' \
    --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.

    FieldTypeRequiredDescription
    updates[].updateVersionString-Update version
    updates[].statusString-Update status
    updates[].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
    updates[].createdDateString-Update request date and time
    updates[].finishedDateString-Update completion date and time
    updates[].updateResultObject-Update result
    updates[].updateResult.inputUsersCntInteger-Number of users requested for update
    updates[].updateResult.inputItemsCntInteger-Number of items requested for update
    updates[].updateResult.inputRowsCntInteger-Number of interactions (logs) requested for update
    updates[].updateResult.updatedItemsCntInteger-Number of items updated
    updates[].updateResult.updatedUsersCntInteger-Number of users updated

    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.

    {
      "updates": [
        {
          "updateVersion": "sl3ao******",
          "status": "completed",
          "type": "personalRecommend",
          "createdDate": "2024-08-16T15:37:34.720Z",
          "finishedDate": "2024-08-16T15:37:34.720Z",
          "updateResult": {
            "inputUsersCnt": 2,
            "inputItemsCnt": 0,
            "inputRowsCnt": 2,
            "updatedItemsCnt": 0,
            "updatedUsersCnt": 2
          }
        }
      ]
    }
    

    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.