更新リストの照会

Classic/VPC環境で利用できます。

サービスの更新情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/services/{serviceId}/updates

リクエストヘッダ

AiTEMS APIで共通して使用されるヘッダの詳細は、AiTEMSの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`serviceId`	String	Required	サービス ID サービスリストの照会を通じて確認

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`type`	String	Required	学習リクエストタイプ `personalRecommend` \| `relatedItem` \| `pop` `personalRecommend`: 顧客サービス利用者の過去の履歴に基づいて個別に推薦 `relatedItem`: アイテムの関連履歴に基づいて個別に推薦 `pop`: ランキング別人気アイテムを推薦
`trainVersion`	String	Required	学習のバージョン学習リストの照会を通じて確認

リクエスト例

リクエストのサンプルコードは次の通りです。

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'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`updates[].updateVersion`	String	-	更新バージョン
`updates[].status`	String	-	更新状態
`updates[].type`	String	-	学習リクエストタイプ `personalRecommend` \| `relatedItem` \| `pop` `personalRecommend`: 顧客サービス利用者の過去の履歴に基づいて個別に推薦 `relatedItem`: アイテムの関連履歴に基づいて個別に推薦 `pop`: ランキング別人気アイテムを推薦
`updates[].createdDate`	String	-	更新のリクエスト日時
`updates[].finishedDate`	String	-	更新完了日時
`updates[].updateResult`	Object	-	更新結果
`updates[].updateResult.inputUsersCnt`	Integer	-	更新をリクエストした User数
`updates[].updateResult.inputItemsCnt`	Integer	-	更新をリクエストした Item数
`updates[].updateResult.inputRowsCnt`	Integer	-	更新をリクエストした Interaction(ログ)数
`updates[].updateResult.updatedItemsCnt`	Integer	-	更新された Item数
`updates[].updateResult.updatedUsersCnt`	Integer	-	更新された User数

レスポンスステータスコード

AiTEMS APIで共通して使用されるレスポンスステータスコードの詳細は、AiTEMS APIの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "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
      }
    }
  ]
}