aws-sdk-personalizeruntime 1.47.0 → 1.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edc5544c96f11eef7adc57370d0589cd7d9858579efb7e19035846caeef5d2b1
-  data.tar.gz: c5ed50f4fc32a503bc432157451bd28a8f5ee0c1165cfd161d5b5ac75b3c29bd
+  metadata.gz: 6e6097c3f5dfdcf1c95736e8e3482ed92302a9525d24a266e246568136473f0d
+  data.tar.gz: e313368d8f7b48c5368462d008987d42a4658f06e683725ee5857efd3ce4aee2
 SHA512:
-  metadata.gz: 4bc00d29bba054ffb9f96ee27c7e3fc539c6f2b5d87aa593f191b689b83b4db5f97fd0b3e5f17364606a4b6986734126e56a23c50f09288b16802820a51d87c5
-  data.tar.gz: 122a8ee5128f933075f5d9f1b6e67e0f8ff7c7b7261a5a09abeca28b48f6119def000476314a3d158e4ea21dbb9a16776ce33426ce64ef1ac95d3d9d1ea54466
+  metadata.gz: e49ec4ac3ee5f3d4b6d4aa08bf4d97c229b526524053a7d8de30906ef0e56ecc3fdbd001de7d393932590cd369bc2f051127944b42f55cad1673d8f7a73bb895
+  data.tar.gz: 36257dbd7c9112f49e6c59de004cadfee86e56ce5aad44a388f0746333e513325127c1fd65e1ca80445ad0ef5b844e2c195015d67771a67d8986cc6cfae08ef2

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.49.0 (2024-05-01)
+------------------
+
+* Feature - This release adds support for a Reason attribute for predicted items generated by User-Personalization-v2.
+
+1.48.0 (2024-04-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.47.0 (2024-01-26)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.47.0
+1.49.0

data/lib/aws-sdk-personalizeruntime/client.rb

@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
 require 'aws-sdk-core/plugins/response_paging.rb'
 require 'aws-sdk-core/plugins/stub_responses.rb'
 require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/invocation_id.rb'
 require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
@@ -72,6 +73,7 @@ module Aws::PersonalizeRuntime
     add_plugin(Aws::Plugins::ResponsePaging)
     add_plugin(Aws::Plugins::StubResponses)
     add_plugin(Aws::Plugins::IdempotencyToken)
+    add_plugin(Aws::Plugins::InvocationId)
     add_plugin(Aws::Plugins::JsonvalueConverter)
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
@@ -196,10 +198,17 @@ module Aws::PersonalizeRuntime
     #     When set to 'true' the request body will not be compressed
     #     for supported operations.
     #
-    #   @option options [String] :endpoint
-    #     The client endpoint is normally constructed from the `:region`
-    #     option. You should only configure an `:endpoint` when connecting
-    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
+    #   @option options [String, URI::HTTPS, URI::HTTP] :endpoint
+    #     Normally you should not configure the `:endpoint` option
+    #     directly. This is normally constructed from the `:region`
+    #     option. Configuring `:endpoint` is normally reserved for
+    #     connecting to test or custom endpoints. The endpoint should
+    #     be a URI formatted like:
+    #
+    #         'http://example.com'
+    #         'https://example.com'
+    #         'http://example.com:123'
+    #
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -337,50 +346,65 @@ module Aws::PersonalizeRuntime
     #   @option options [Aws::PersonalizeRuntime::EndpointProvider] :endpoint_provider
     #     The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::PersonalizeRuntime::EndpointParameters`
     #
-    #   @option options [URI::HTTP,String] :http_proxy A proxy to send
-    #     requests through.  Formatted like 'http://proxy.com:123'.
-    #
-    #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before raising a
-    #     `Timeout::Error`.
-    #
-    #   @option options [Float] :http_read_timeout (60) The default
-    #     number of seconds to wait for response data.  This value can
-    #     safely be set per-request on the session.
-    #
-    #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idle before it is
-    #     considered stale.  Stale connections are closed and removed
-    #     from the pool before making a request.
-    #
-    #   @option options [Float] :http_continue_timeout (1) The number of
-    #     seconds to wait for a 100-continue response before sending the
-    #     request body.  This option has no effect unless the request has
-    #     "Expect" header set to "100-continue".  Defaults to `nil` which
-    #     disables this behaviour.  This value can safely be set per
-    #     request on the session.
-    #
-    #   @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
-    #     in seconds.
+    #   @option options [Float] :http_continue_timeout (1)
+    #     The number of seconds to wait for a 100-continue response before sending the
+    #     request body.  This option has no effect unless the request has "Expect"
+    #     header set to "100-continue".  Defaults to `nil` which  disables this
+    #     behaviour.  This value can safely be set per request on the session.
+    #
+    #   @option options [Float] :http_idle_timeout (5)
+    #     The number of seconds a connection is allowed to sit idle before it
+    #     is considered stale.  Stale connections are closed and removed from the
+    #     pool before making a request.
+    #
+    #   @option options [Float] :http_open_timeout (15)
+    #     The default number of seconds to wait for response data.
+    #     This value can safely be set per-request on the session.
+    #
+    #   @option options [URI::HTTP,String] :http_proxy
+    #     A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
+    #
+    #   @option options [Float] :http_read_timeout (60)
+    #     The default number of seconds to wait for response data.
+    #     This value can safely be set per-request on the session.
+    #
+    #   @option options [Boolean] :http_wire_trace (false)
+    #     When `true`,  HTTP debug output will be sent to the `:logger`.
+    #
+    #   @option options [Proc] :on_chunk_received
+    #     When a Proc object is provided, it will be used as callback when each chunk
+    #     of the response body is received. It provides three arguments: the chunk,
+    #     the number of bytes received, and the total number of
+    #     bytes in the response (or nil if the server did not send a `content-length`).
+    #
+    #   @option options [Proc] :on_chunk_sent
+    #     When a Proc object is provided, it will be used as callback when each chunk
+    #     of the request body is sent. It provides three arguments: the chunk,
+    #     the number of bytes read from the body, and the total number of
+    #     bytes in the body.
+    #
+    #   @option options [Boolean] :raise_response_errors (true)
+    #     When `true`, response errors are raised.
+    #
+    #   @option options [String] :ssl_ca_bundle
+    #     Full path to the SSL certificate authority bundle file that should be used when
+    #     verifying peer certificates.  If you do not pass `:ssl_ca_bundle` or
+    #     `:ssl_ca_directory` the the system default will be used if available.
+    #
+    #   @option options [String] :ssl_ca_directory
+    #     Full path of the directory that contains the unbundled SSL certificate
+    #     authority files for verifying peer certificates.  If you do
+    #     not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
+    #     default will be used if available.
     #
-    #   @option options [Boolean] :http_wire_trace (false) When `true`,
-    #     HTTP debug output will be sent to the `:logger`.
+    #   @option options [String] :ssl_ca_store
+    #     Sets the X509::Store to verify peer certificate.
     #
-    #   @option options [Boolean] :ssl_verify_peer (true) When `true`,
-    #     SSL peer certificates are verified when establishing a
-    #     connection.
+    #   @option options [Float] :ssl_timeout
+    #     Sets the SSL timeout in seconds
     #
-    #   @option options [String] :ssl_ca_bundle Full path to the SSL
-    #     certificate authority bundle file that should be used when
-    #     verifying peer certificates.  If you do not pass
-    #     `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
-    #     will be used if available.
-    #
-    #   @option options [String] :ssl_ca_directory Full path of the
-    #     directory that contains the unbundled SSL certificate
-    #     authority files for verifying peer certificates.  If you do
-    #     not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
-    #     system default will be used if available.
+    #   @option options [Boolean] :ssl_verify_peer (true)
+    #     When `true`, SSL peer certificates are verified when establishing a connection.
     #
     def initialize(*args)
       super
@@ -578,6 +602,8 @@ module Aws::PersonalizeRuntime
     #   resp.personalized_ranking[0].promotion_name #=> String
     #   resp.personalized_ranking[0].metadata #=> Hash
     #   resp.personalized_ranking[0].metadata["ColumnName"] #=> String
+    #   resp.personalized_ranking[0].reason #=> Array
+    #   resp.personalized_ranking[0].reason[0] #=> String
     #   resp.recommendation_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRanking AWS API Documentation
@@ -737,6 +763,8 @@ module Aws::PersonalizeRuntime
     #   resp.item_list[0].promotion_name #=> String
     #   resp.item_list[0].metadata #=> Hash
     #   resp.item_list[0].metadata["ColumnName"] #=> String
+    #   resp.item_list[0].reason #=> Array
+    #   resp.item_list[0].reason[0] #=> String
     #   resp.recommendation_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendations AWS API Documentation
@@ -761,7 +789,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.47.0'
+      context[:gem_version] = '1.49.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-personalizeruntime/client_api.rb

@@ -46,6 +46,8 @@ module Aws::PersonalizeRuntime
     PredictedItem = Shapes::StructureShape.new(name: 'PredictedItem')
     Promotion = Shapes::StructureShape.new(name: 'Promotion')
     PromotionList = Shapes::ListShape.new(name: 'PromotionList')
+    Reason = Shapes::StringShape.new(name: 'Reason')
+    ReasonList = Shapes::ListShape.new(name: 'ReasonList')
     RecommendationID = Shapes::StringShape.new(name: 'RecommendationID')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     Score = Shapes::FloatShape.new(name: 'Score')
@@ -122,6 +124,7 @@ module Aws::PersonalizeRuntime
     PredictedItem.add_member(:score, Shapes::ShapeRef.new(shape: Score, location_name: "score"))
     PredictedItem.add_member(:promotion_name, Shapes::ShapeRef.new(shape: Name, location_name: "promotionName"))
     PredictedItem.add_member(:metadata, Shapes::ShapeRef.new(shape: Metadata, location_name: "metadata"))
+    PredictedItem.add_member(:reason, Shapes::ShapeRef.new(shape: ReasonList, location_name: "reason"))
     PredictedItem.struct_class = Types::PredictedItem
 
     Promotion.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
@@ -132,6 +135,8 @@ module Aws::PersonalizeRuntime
 
     PromotionList.member = Shapes::ShapeRef.new(shape: Promotion)
 
+    ReasonList.member = Shapes::ShapeRef.new(shape: Reason)
+
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
@@ -146,6 +151,7 @@ module Aws::PersonalizeRuntime
         "endpointPrefix" => "personalize-runtime",
         "jsonVersion" => "1.1",
         "protocol" => "rest-json",
+        "protocols" => ["rest-json"],
         "serviceFullName" => "Amazon Personalize Runtime",
         "serviceId" => "Personalize Runtime",
         "signatureVersion" => "v4",

data/lib/aws-sdk-personalizeruntime/types.rb

@@ -385,14 +385,41 @@ module Aws::PersonalizeRuntime
     #   Metadata about the item from your Items dataset.
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] reason
+    #   If you use User-Personalization-v2, a list of reasons for why the
+    #   item was included in recommendations. Possible reasons include the
+    #   following:
+    #
+    #   * Promoted item - Indicates the item was included as part of a
+    #     promotion that you applied in your recommendation request.
+    #
+    #   * 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 [Exploration][1].
+    #
+    #   * 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 `numResults` 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.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#about-exploration
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/PredictedItem AWS API Documentation
     #
     class PredictedItem < Struct.new(
       :item_id,
       :score,
       :promotion_name,
-      :metadata)
-      SENSITIVE = []
+      :metadata,
+      :reason)
+      SENSITIVE = [:metadata]
       include Aws::Structure
     end
 

data/lib/aws-sdk-personalizeruntime.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 # @!group service
 module Aws::PersonalizeRuntime
 
-  GEM_VERSION = '1.47.0'
+  GEM_VERSION = '1.49.0'
 
 end

data/sig/types.rbs

@@ -76,7 +76,8 @@ module Aws::PersonalizeRuntime
       attr_accessor score: ::Float
       attr_accessor promotion_name: ::String
       attr_accessor metadata: ::Hash[::String, ::String]
-      SENSITIVE: []
+      attr_accessor reason: ::Array[::String]
+      SENSITIVE: [:metadata]
     end
 
     class Promotion

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeruntime
 version: !ruby/object:Gem::Version
-  version: 1.47.0
+  version: 1.49.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.191.0
+        version: 3.193.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.191.0
+        version: 3.193.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement