@aws-sdk/client-personalize-runtime 3.379.1 → 3.385.0

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

@@ -5,32 +5,38 @@ import { PersonalizeRuntimeServiceException as __BaseException } from "./Persona
  */
 export interface GetPersonalizedRankingRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the campaign to use for generating the personalized
      *       ranking.</p>
      */
     campaignArn: string | undefined;
     /**
+     * @public
      * <p>A list of items (by <code>itemId</code>) to rank. If an item was not included in the training dataset,
      *       the item is appended to the end of the reranked list. The maximum is 500.</p>
      */
     inputList: string[] | undefined;
     /**
+     * @public
      * <p>The user for which you want the campaign to provide a personalized ranking.</p>
      */
     userId: string | undefined;
     /**
+     * @public
      * <p>The contextual metadata to use when getting recommendations. Contextual metadata includes
      *       any interaction information that might be relevant when getting a user's recommendations, such
      *       as the user's current location or device type.</p>
      */
     context?: Record<string, string>;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user.
      *       For more information, see
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
      */
     filterArn?: string;
     /**
+     * @public
      * <p>The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)
      *       as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
      *     </p>
@@ -52,15 +58,18 @@ export interface GetPersonalizedRankingRequest {
  */
 export interface PredictedItem {
     /**
+     * @public
      * <p>The recommended item ID.</p>
      */
     itemId?: string;
     /**
+     * @public
      * <p>A numeric representation of the model's certainty that the item will be the next user
      *       selection. For more information on scoring logic, see <a>how-scores-work</a>.</p>
      */
     score?: number;
     /**
+     * @public
      * <p>The name of the promotion that included the predicted item.</p>
      */
     promotionName?: string;
@@ -70,10 +79,12 @@ export interface PredictedItem {
  */
 export interface GetPersonalizedRankingResponse {
     /**
+     * @public
      * <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
      */
     personalizedRanking?: PredictedItem[];
     /**
+     * @public
      * <p>The ID of the recommendation.</p>
      */
     recommendationId?: string;
@@ -108,19 +119,23 @@ export declare class ResourceNotFoundException extends __BaseException {
  */
 export interface Promotion {
     /**
+     * @public
      * <p>The name of the promotion.</p>
      */
     name?: string;
     /**
+     * @public
      * <p>The percentage of recommended items to apply the promotion to.</p>
      */
     percentPromotedItems?: number;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters">Promotion filters</a>.</p>
      */
     filterArn?: string;
     /**
+     * @public
      * <p>The values to use when promoting items.
      *       For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
      *     </p>
@@ -139,36 +154,43 @@ export interface Promotion {
  */
 export interface GetRecommendationsRequest {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.</p>
      */
     campaignArn?: string;
     /**
+     * @public
      * <p>The item ID to provide recommendations for.</p>
      *          <p>Required for <code>RELATED_ITEMS</code> recipe type.</p>
      */
     itemId?: string;
     /**
+     * @public
      * <p>The user ID to provide recommendations for.</p>
      *          <p>Required for <code>USER_PERSONALIZATION</code> recipe type.</p>
      */
     userId?: string;
     /**
+     * @public
      * <p>The number of results to return. The default is 25. The maximum is 500.</p>
      */
     numResults?: number;
     /**
+     * @public
      * <p>The contextual metadata to use when getting recommendations. Contextual metadata includes
      *       any interaction information that might be relevant when getting a user's recommendations, such
      *       as the user's current location or device type.</p>
      */
     context?: Record<string, string>;
     /**
+     * @public
      * <p>The ARN of the filter to apply to the returned recommendations. For more information, see
      *       <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
      *          <p>When using this parameter, be sure the filter resource is <code>ACTIVE</code>.</p>
      */
     filterArn?: string;
     /**
+     * @public
      * <p>The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)
      *       as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
      *     </p>
@@ -182,11 +204,13 @@ export interface GetRecommendationsRequest {
      */
     filterValues?: Record<string, string>;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you
      *     created a Domain dataset group with a recommender for a domain use case.</p>
      */
     recommenderArn?: string;
     /**
+     * @public
      * <p>The promotions to apply to the recommendation request.
      *       A promotion defines additional business rules that apply to a configurable subset of recommended items.</p>
      */
@@ -197,11 +221,13 @@ export interface GetRecommendationsRequest {
  */
 export interface GetRecommendationsResponse {
     /**
+     * @public
      * <p>A list of recommendations sorted in descending order by prediction score. There can be a
      *       maximum of 500 items in the list.</p>
      */
     itemList?: PredictedItem[];
     /**
+     * @public
      * <p>The ID of the recommendation.</p>
      */
     recommendationId?: string;

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.379.1",
+  "version": "3.385.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.385.0",
+    "@aws-sdk/credential-provider-node": "3.385.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",