@aws-sdk/client-personalize-runtime 3.564.0 → 3.567.0

package/dist-cjs/index.js

@@ -25,12 +25,15 @@ __export(src_exports, {
   GetActionRecommendationsRequestFilterSensitiveLog: () => GetActionRecommendationsRequestFilterSensitiveLog,
   GetPersonalizedRankingCommand: () => GetPersonalizedRankingCommand,
   GetPersonalizedRankingRequestFilterSensitiveLog: () => GetPersonalizedRankingRequestFilterSensitiveLog,
+  GetPersonalizedRankingResponseFilterSensitiveLog: () => GetPersonalizedRankingResponseFilterSensitiveLog,
   GetRecommendationsCommand: () => GetRecommendationsCommand,
   GetRecommendationsRequestFilterSensitiveLog: () => GetRecommendationsRequestFilterSensitiveLog,
+  GetRecommendationsResponseFilterSensitiveLog: () => GetRecommendationsResponseFilterSensitiveLog,
   InvalidInputException: () => InvalidInputException,
   PersonalizeRuntime: () => PersonalizeRuntime,
   PersonalizeRuntimeClient: () => PersonalizeRuntimeClient,
   PersonalizeRuntimeServiceException: () => PersonalizeRuntimeServiceException,
+  PredictedItemFilterSensitiveLog: () => PredictedItemFilterSensitiveLog,
   PromotionFilterSensitiveLog: () => PromotionFilterSensitiveLog,
   ResourceNotFoundException: () => ResourceNotFoundException,
   __Client: () => import_smithy_client.Client
@@ -250,6 +253,16 @@ var GetPersonalizedRankingRequestFilterSensitiveLog = /* @__PURE__ */ __name((ob
   ...obj.context && { context: import_smithy_client.SENSITIVE_STRING },
   ...obj.filterValues && { filterValues: import_smithy_client.SENSITIVE_STRING }
 }), "GetPersonalizedRankingRequestFilterSensitiveLog");
+var PredictedItemFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.metadata && { metadata: import_smithy_client.SENSITIVE_STRING }
+}), "PredictedItemFilterSensitiveLog");
+var GetPersonalizedRankingResponseFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.personalizedRanking && {
+    personalizedRanking: obj.personalizedRanking.map((item) => PredictedItemFilterSensitiveLog(item))
+  }
+}), "GetPersonalizedRankingResponseFilterSensitiveLog");
 var PromotionFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
   ...obj,
   ...obj.filterValues && { filterValues: import_smithy_client.SENSITIVE_STRING }
@@ -260,6 +273,10 @@ var GetRecommendationsRequestFilterSensitiveLog = /* @__PURE__ */ __name((obj) =
   ...obj.filterValues && { filterValues: import_smithy_client.SENSITIVE_STRING },
   ...obj.promotions && { promotions: obj.promotions.map((item) => PromotionFilterSensitiveLog(item)) }
 }), "GetRecommendationsRequestFilterSensitiveLog");
+var GetRecommendationsResponseFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.itemList && { itemList: obj.itemList.map((item) => PredictedItemFilterSensitiveLog(item)) }
+}), "GetRecommendationsResponseFilterSensitiveLog");
 
 // src/protocols/Aws_restJson1.ts
 var import_core2 = require("@aws-sdk/core");
@@ -446,6 +463,7 @@ var de_PredictedItem = /* @__PURE__ */ __name((output, context) => {
     itemId: import_smithy_client.expectString,
     metadata: import_smithy_client._json,
     promotionName: import_smithy_client.expectString,
+    reason: import_smithy_client._json,
     score: import_smithy_client.limitedParseDouble
   });
 }, "de_PredictedItem");
@@ -481,7 +499,7 @@ var _GetPersonalizedRankingCommand = class _GetPersonalizedRankingCommand extend
     (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
     (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
   ];
-}).s("AmazonPersonalizeRuntime", "GetPersonalizedRanking", {}).n("PersonalizeRuntimeClient", "GetPersonalizedRankingCommand").f(GetPersonalizedRankingRequestFilterSensitiveLog, void 0).ser(se_GetPersonalizedRankingCommand).de(de_GetPersonalizedRankingCommand).build() {
+}).s("AmazonPersonalizeRuntime", "GetPersonalizedRanking", {}).n("PersonalizeRuntimeClient", "GetPersonalizedRankingCommand").f(GetPersonalizedRankingRequestFilterSensitiveLog, GetPersonalizedRankingResponseFilterSensitiveLog).ser(se_GetPersonalizedRankingCommand).de(de_GetPersonalizedRankingCommand).build() {
 };
 __name(_GetPersonalizedRankingCommand, "GetPersonalizedRankingCommand");
 var GetPersonalizedRankingCommand = _GetPersonalizedRankingCommand;
@@ -498,7 +516,7 @@ var _GetRecommendationsCommand = class _GetRecommendationsCommand extends import
     (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
     (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
   ];
-}).s("AmazonPersonalizeRuntime", "GetRecommendations", {}).n("PersonalizeRuntimeClient", "GetRecommendationsCommand").f(GetRecommendationsRequestFilterSensitiveLog, void 0).ser(se_GetRecommendationsCommand).de(de_GetRecommendationsCommand).build() {
+}).s("AmazonPersonalizeRuntime", "GetRecommendations", {}).n("PersonalizeRuntimeClient", "GetRecommendationsCommand").f(GetRecommendationsRequestFilterSensitiveLog, GetRecommendationsResponseFilterSensitiveLog).ser(se_GetRecommendationsCommand).de(de_GetRecommendationsCommand).build() {
 };
 __name(_GetRecommendationsCommand, "GetRecommendationsCommand");
 var GetRecommendationsCommand = _GetRecommendationsCommand;
@@ -529,7 +547,10 @@ var PersonalizeRuntime = _PersonalizeRuntime;
   ResourceNotFoundException,
   GetActionRecommendationsRequestFilterSensitiveLog,
   GetPersonalizedRankingRequestFilterSensitiveLog,
+  PredictedItemFilterSensitiveLog,
+  GetPersonalizedRankingResponseFilterSensitiveLog,
   PromotionFilterSensitiveLog,
-  GetRecommendationsRequestFilterSensitiveLog
+  GetRecommendationsRequestFilterSensitiveLog,
+  GetRecommendationsResponseFilterSensitiveLog
 });
 

package/dist-es/commands/GetPersonalizedRankingCommand.js

@@ -2,7 +2,7 @@ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { GetPersonalizedRankingRequestFilterSensitiveLog, } from "../models/models_0";
+import { GetPersonalizedRankingRequestFilterSensitiveLog, GetPersonalizedRankingResponseFilterSensitiveLog, } from "../models/models_0";
 import { de_GetPersonalizedRankingCommand, se_GetPersonalizedRankingCommand } from "../protocols/Aws_restJson1";
 export { $Command };
 export class GetPersonalizedRankingCommand extends $Command
@@ -18,7 +18,7 @@ export class GetPersonalizedRankingCommand extends $Command
 })
     .s("AmazonPersonalizeRuntime", "GetPersonalizedRanking", {})
     .n("PersonalizeRuntimeClient", "GetPersonalizedRankingCommand")
-    .f(GetPersonalizedRankingRequestFilterSensitiveLog, void 0)
+    .f(GetPersonalizedRankingRequestFilterSensitiveLog, GetPersonalizedRankingResponseFilterSensitiveLog)
     .ser(se_GetPersonalizedRankingCommand)
     .de(de_GetPersonalizedRankingCommand)
     .build() {

package/dist-es/commands/GetRecommendationsCommand.js

@@ -2,7 +2,7 @@ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { GetRecommendationsRequestFilterSensitiveLog, } from "../models/models_0";
+import { GetRecommendationsRequestFilterSensitiveLog, GetRecommendationsResponseFilterSensitiveLog, } from "../models/models_0";
 import { de_GetRecommendationsCommand, se_GetRecommendationsCommand } from "../protocols/Aws_restJson1";
 export { $Command };
 export class GetRecommendationsCommand extends $Command
@@ -18,7 +18,7 @@ export class GetRecommendationsCommand extends $Command
 })
     .s("AmazonPersonalizeRuntime", "GetRecommendations", {})
     .n("PersonalizeRuntimeClient", "GetRecommendationsCommand")
-    .f(GetRecommendationsRequestFilterSensitiveLog, void 0)
+    .f(GetRecommendationsRequestFilterSensitiveLog, GetRecommendationsResponseFilterSensitiveLog)
     .ser(se_GetRecommendationsCommand)
     .de(de_GetRecommendationsCommand)
     .build() {

package/dist-es/models/models_0.js

@@ -33,6 +33,16 @@ export const GetPersonalizedRankingRequestFilterSensitiveLog = (obj) => ({
     ...(obj.context && { context: SENSITIVE_STRING }),
     ...(obj.filterValues && { filterValues: SENSITIVE_STRING }),
 });
+export const PredictedItemFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.metadata && { metadata: SENSITIVE_STRING }),
+});
+export const GetPersonalizedRankingResponseFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.personalizedRanking && {
+        personalizedRanking: obj.personalizedRanking.map((item) => PredictedItemFilterSensitiveLog(item)),
+    }),
+});
 export const PromotionFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.filterValues && { filterValues: SENSITIVE_STRING }),
@@ -43,3 +53,7 @@ export const GetRecommendationsRequestFilterSensitiveLog = (obj) => ({
     ...(obj.filterValues && { filterValues: SENSITIVE_STRING }),
     ...(obj.promotions && { promotions: obj.promotions.map((item) => PromotionFilterSensitiveLog(item)) }),
 });
+export const GetRecommendationsResponseFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.itemList && { itemList: obj.itemList.map((item) => PredictedItemFilterSensitiveLog(item)) }),
+});

package/dist-es/protocols/Aws_restJson1.js

@@ -182,6 +182,7 @@ const de_PredictedItem = (output, context) => {
         itemId: __expectString,
         metadata: _json,
         promotionName: __expectString,
+        reason: _json,
         score: __limitedParseDouble,
     });
 };

package/dist-types/commands/GetPersonalizedRankingCommand.d.ts

@@ -68,6 +68,9 @@ declare const GetPersonalizedRankingCommand_base: {
  * //       metadata: { // Metadata
  * //         "<keys>": "STRING_VALUE",
  * //       },
+ * //       reason: [ // ReasonList
+ * //         "STRING_VALUE",
+ * //       ],
  * //     },
  * //   ],
  * //   recommendationId: "STRING_VALUE",

package/dist-types/commands/GetRecommendationsCommand.d.ts

@@ -90,6 +90,9 @@ declare const GetRecommendationsCommand_base: {
  * //       metadata: { // Metadata
  * //         "<keys>": "STRING_VALUE",
  * //       },
+ * //       reason: [ // ReasonList
+ * //         "STRING_VALUE",
+ * //       ],
  * //     },
  * //   ],
  * //   recommendationId: "STRING_VALUE",

package/dist-types/models/models_0.d.ts

@@ -190,6 +190,31 @@ export interface PredictedItem {
      * @public
      */
     metadata?: Record<string, string>;
+    /**
+     * <p>If you use User-Personalization-v2, a list of reasons for why the item was included in recommendations. Possible reasons include the following:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Promoted item - Indicates the item was included as part of a promotion that you applied in your recommendation request.</p>
+     *             </li>
+     *             <li>
+     *                <p>Exploration - Indicates the item was included with exploration.
+     *           With exploration, recommendations include items with less interactions data or relevance for the user.
+     *           For more information about exploration, see
+     *           <a href="https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#about-exploration">Exploration</a>.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *           Popular item - Indicates the item was included as a placeholder popular item.
+     *           If you use a filter, depending on how many recommendations the filter removes,
+     *            Amazon Personalize might add placeholder items to meet the <code>numResults</code> for your
+     *           recommendation request. These items are popular items, based on interactions data, that satisfy your filter criteria.
+     *           They don't have a relevance score for the user.
+     *         </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    reason?: string[];
 }
 /**
  * @public
@@ -345,6 +370,14 @@ export declare const GetActionRecommendationsRequestFilterSensitiveLog: (obj: Ge
  * @internal
  */
 export declare const GetPersonalizedRankingRequestFilterSensitiveLog: (obj: GetPersonalizedRankingRequest) => any;
+/**
+ * @internal
+ */
+export declare const PredictedItemFilterSensitiveLog: (obj: PredictedItem) => any;
+/**
+ * @internal
+ */
+export declare const GetPersonalizedRankingResponseFilterSensitiveLog: (obj: GetPersonalizedRankingResponse) => any;
 /**
  * @internal
  */
@@ -353,3 +386,7 @@ export declare const PromotionFilterSensitiveLog: (obj: Promotion) => any;
  * @internal
  */
 export declare const GetRecommendationsRequestFilterSensitiveLog: (obj: GetRecommendationsRequest) => any;
+/**
+ * @internal
+ */
+export declare const GetRecommendationsResponseFilterSensitiveLog: (obj: GetRecommendationsResponse) => any;

package/dist-types/ts3.4/models/models_0.d.ts

@@ -43,6 +43,7 @@ export interface PredictedItem {
   score?: number;
   promotionName?: string;
   metadata?: Record<string, string>;
+  reason?: string[];
 }
 export interface GetPersonalizedRankingResponse {
   personalizedRanking?: PredictedItem[];
@@ -76,7 +77,16 @@ export declare const GetActionRecommendationsRequestFilterSensitiveLog: (
 export declare const GetPersonalizedRankingRequestFilterSensitiveLog: (
   obj: GetPersonalizedRankingRequest
 ) => any;
+export declare const PredictedItemFilterSensitiveLog: (
+  obj: PredictedItem
+) => any;
+export declare const GetPersonalizedRankingResponseFilterSensitiveLog: (
+  obj: GetPersonalizedRankingResponse
+) => any;
 export declare const PromotionFilterSensitiveLog: (obj: Promotion) => any;
 export declare const GetRecommendationsRequestFilterSensitiveLog: (
   obj: GetRecommendationsRequest
 ) => any;
+export declare const GetRecommendationsResponseFilterSensitiveLog: (
+  obj: GetRecommendationsResponse
+) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-personalize-runtime",
   "description": "AWS SDK for JavaScript Personalize Runtime Client for Node.js, Browser and React Native",
-  "version": "3.564.0",
+  "version": "3.567.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-personalize-runtime",
@@ -20,17 +20,17 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/core": "3.556.0",
-    "@aws-sdk/credential-provider-node": "3.564.0",
-    "@aws-sdk/middleware-host-header": "3.535.0",
-    "@aws-sdk/middleware-logger": "3.535.0",
-    "@aws-sdk/middleware-recursion-detection": "3.535.0",
-    "@aws-sdk/middleware-user-agent": "3.540.0",
-    "@aws-sdk/region-config-resolver": "3.535.0",
-    "@aws-sdk/types": "3.535.0",
-    "@aws-sdk/util-endpoints": "3.540.0",
-    "@aws-sdk/util-user-agent-browser": "3.535.0",
-    "@aws-sdk/util-user-agent-node": "3.535.0",
+    "@aws-sdk/core": "3.567.0",
+    "@aws-sdk/credential-provider-node": "3.567.0",
+    "@aws-sdk/middleware-host-header": "3.567.0",
+    "@aws-sdk/middleware-logger": "3.567.0",
+    "@aws-sdk/middleware-recursion-detection": "3.567.0",
+    "@aws-sdk/middleware-user-agent": "3.567.0",
+    "@aws-sdk/region-config-resolver": "3.567.0",
+    "@aws-sdk/types": "3.567.0",
+    "@aws-sdk/util-endpoints": "3.567.0",
+    "@aws-sdk/util-user-agent-browser": "3.567.0",
+    "@aws-sdk/util-user-agent-node": "3.567.0",
     "@smithy/config-resolver": "^2.2.0",
     "@smithy/core": "^1.4.2",
     "@smithy/fetch-http-handler": "^2.5.0",
@@ -59,8 +59,7 @@
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@smithy/service-client-documentation-generator": "^2.2.0",
-    "@tsconfig/node14": "1.0.3",
+    "@tsconfig/node16": "16.1.3",
     "@types/node": "^14.14.31",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
@@ -68,7 +67,7 @@
     "typescript": "~4.9.5"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=16.0.0"
   },
   "typesVersions": {
     "<4.0": {