aws-sdk-connectwisdomservice 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d76798ee10a302f7353cccda0ce826b4e5de63b7b738be4ea1b6b72a90e58a0
-  data.tar.gz: b88942a0bfd5aa25a1411a951938614735bc8934e28821183ead9a9c89e14755
+  metadata.gz: 06dda9d1eaf52bb60f99fa3240b6fb51da383afdf684df37e8887b32982dd62c
+  data.tar.gz: 3814418e1b39057947e5ae7dd93b6768ccf12516cc78658a4c37c708fba5621b
 SHA512:
-  metadata.gz: 35587abdcf771ea8caf87d1f83923b44d17a0fb9d89bd5198d4a0563f03313c5af7f7c2752b89f515763db75abc6fd5205e8a3b1f91cdec812940712eb6d10a2
-  data.tar.gz: 85f32e1d97ff4342b0dc727c9ace992e52e4228614ba1dc1b191988ed7ae2b015ec3248e32f540615d83679248a75d11e0bbe2bd2c1e9398de3519dd36882fe4
+  metadata.gz: 25b42ec394c96683df1b8c3a9674512115e6aca39aac1ff15490bd05a2e6c9a8e8016e6ffd0c31e96ef63b7659168aea154fa2a8f4969f3d2fa9307f70852600
+  data.tar.gz: 3a0affa9889f1435171a5d3512570a4cdc41384a272fc2a6992032a1336df85fb0742b9f7d00854a2db79dfb0d60867e0fe5fb0e01a04b898c7fcfd9300025a3

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.8.0 (2022-08-15)
+------------------
+
+* Feature - This release introduces a new API PutFeedback that allows submitting feedback to Wisdom on content relevance.
+
 1.7.0 (2022-04-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.7.0
+1.8.0

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

@@ -1475,6 +1475,66 @@ module Aws::ConnectWisdomService
       req.send_request(options)
     end
 
+    # Submits feedback to Wisdom. The feedback is used to improve future
+    # recommendations from [GetRecommendations][1] or results from
+    # [QueryAssistant][2]. Feedback can be resubmitted up to 6 hours after
+    # submission.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html
+    # [2]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html
+    #
+    # @option params [required, String] :assistant_id
+    #   The identifier of the Wisdom assistant. Can be either the ID or the
+    #   ARN. URLs cannot contain the ARN.
+    #
+    # @option params [required, Types::FeedbackData] :feedback
+    #   The feedback.
+    #
+    # @option params [required, String] :target_id
+    #   The identifier of a recommendation. or The identifier of the result
+    #   data.
+    #
+    # @option params [required, String] :target_type
+    #   The type of the targetId for which The feedback. is targeted.
+    #
+    # @return [Types::PutFeedbackResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::PutFeedbackResponse#assistant_arn #assistant_arn} => String
+    #   * {Types::PutFeedbackResponse#assistant_id #assistant_id} => String
+    #   * {Types::PutFeedbackResponse#feedback #feedback} => Types::FeedbackData
+    #   * {Types::PutFeedbackResponse#target_id #target_id} => String
+    #   * {Types::PutFeedbackResponse#target_type #target_type} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_feedback({
+    #     assistant_id: "UuidOrArn", # required
+    #     feedback: { # required
+    #       relevance: "HELPFUL", # required, accepts HELPFUL, NOT_HELPFUL
+    #     },
+    #     target_id: "String", # required
+    #     target_type: "RECOMMENDATION", # required, accepts RECOMMENDATION, RESULT
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.assistant_arn #=> String
+    #   resp.assistant_id #=> String
+    #   resp.feedback.relevance #=> String, one of "HELPFUL", "NOT_HELPFUL"
+    #   resp.target_id #=> String
+    #   resp.target_type #=> String, one of "RECOMMENDATION", "RESULT"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/PutFeedback AWS API Documentation
+    #
+    # @overload put_feedback(params = {})
+    # @param [Hash] params ({})
+    def put_feedback(params = {}, options = {})
+      req = build_request(:put_feedback, params)
+      req.send_request(options)
+    end
+
     # Performs a manual search against the specified assistant. To retrieve
     # recommendations for an assistant, use [GetRecommendations][1].
     #
@@ -1949,7 +2009,7 @@ module Aws::ConnectWisdomService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-connectwisdomservice'
-      context[:gem_version] = '1.7.0'
+      context[:gem_version] = '1.8.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -59,6 +59,7 @@ module Aws::ConnectWisdomService
     Description = Shapes::StringShape.new(name: 'Description')
     Document = Shapes::StructureShape.new(name: 'Document')
     DocumentText = Shapes::StructureShape.new(name: 'DocumentText')
+    FeedbackData = Shapes::StructureShape.new(name: 'FeedbackData')
     Filter = Shapes::StructureShape.new(name: 'Filter')
     FilterField = Shapes::StringShape.new(name: 'FilterField')
     FilterList = Shapes::ListShape.new(name: 'FilterList')
@@ -109,6 +110,8 @@ module Aws::ConnectWisdomService
     NotifyRecommendationsReceivedResponse = Shapes::StructureShape.new(name: 'NotifyRecommendationsReceivedResponse')
     ObjectFieldsList = Shapes::ListShape.new(name: 'ObjectFieldsList')
     PreconditionFailedException = Shapes::StructureShape.new(name: 'PreconditionFailedException')
+    PutFeedbackRequest = Shapes::StructureShape.new(name: 'PutFeedbackRequest')
+    PutFeedbackResponse = Shapes::StructureShape.new(name: 'PutFeedbackResponse')
     QueryAssistantRequest = Shapes::StructureShape.new(name: 'QueryAssistantRequest')
     QueryAssistantResponse = Shapes::StructureShape.new(name: 'QueryAssistantResponse')
     QueryRecommendationTriggerData = Shapes::StructureShape.new(name: 'QueryRecommendationTriggerData')
@@ -123,6 +126,7 @@ module Aws::ConnectWisdomService
     RecommendationTriggerList = Shapes::ListShape.new(name: 'RecommendationTriggerList')
     RecommendationTriggerType = Shapes::StringShape.new(name: 'RecommendationTriggerType')
     RecommendationType = Shapes::StringShape.new(name: 'RecommendationType')
+    Relevance = Shapes::StringShape.new(name: 'Relevance')
     RelevanceLevel = Shapes::StringShape.new(name: 'RelevanceLevel')
     RelevanceScore = Shapes::FloatShape.new(name: 'RelevanceScore')
     RemoveKnowledgeBaseTemplateUriRequest = Shapes::StructureShape.new(name: 'RemoveKnowledgeBaseTemplateUriRequest')
@@ -152,6 +156,7 @@ module Aws::ConnectWisdomService
     TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
     TagValue = Shapes::StringShape.new(name: 'TagValue')
     Tags = Shapes::MapShape.new(name: 'Tags')
+    TargetType = Shapes::StringShape.new(name: 'TargetType')
     TooManyTagsException = Shapes::StructureShape.new(name: 'TooManyTagsException')
     UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
     UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
@@ -358,6 +363,9 @@ module Aws::ConnectWisdomService
     DocumentText.add_member(:text, Shapes::ShapeRef.new(shape: SensitiveString, location_name: "text"))
     DocumentText.struct_class = Types::DocumentText
 
+    FeedbackData.add_member(:relevance, Shapes::ShapeRef.new(shape: Relevance, required: true, location_name: "relevance"))
+    FeedbackData.struct_class = Types::FeedbackData
+
     Filter.add_member(:field, Shapes::ShapeRef.new(shape: FilterField, required: true, location_name: "field"))
     Filter.add_member(:operator, Shapes::ShapeRef.new(shape: FilterOperator, required: true, location_name: "operator"))
     Filter.add_member(:value, Shapes::ShapeRef.new(shape: NonEmptyString, required: true, location_name: "value"))
@@ -515,6 +523,19 @@ module Aws::ConnectWisdomService
     PreconditionFailedException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "message"))
     PreconditionFailedException.struct_class = Types::PreconditionFailedException
 
+    PutFeedbackRequest.add_member(:assistant_id, Shapes::ShapeRef.new(shape: UuidOrArn, required: true, location: "uri", location_name: "assistantId"))
+    PutFeedbackRequest.add_member(:feedback, Shapes::ShapeRef.new(shape: FeedbackData, required: true, location_name: "feedback"))
+    PutFeedbackRequest.add_member(:target_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "targetId"))
+    PutFeedbackRequest.add_member(:target_type, Shapes::ShapeRef.new(shape: TargetType, required: true, location_name: "targetType"))
+    PutFeedbackRequest.struct_class = Types::PutFeedbackRequest
+
+    PutFeedbackResponse.add_member(:assistant_arn, Shapes::ShapeRef.new(shape: UuidOrArn, required: true, location_name: "assistantArn"))
+    PutFeedbackResponse.add_member(:assistant_id, Shapes::ShapeRef.new(shape: Uuid, required: true, location_name: "assistantId"))
+    PutFeedbackResponse.add_member(:feedback, Shapes::ShapeRef.new(shape: FeedbackData, required: true, location_name: "feedback"))
+    PutFeedbackResponse.add_member(:target_id, Shapes::ShapeRef.new(shape: Uuid, required: true, location_name: "targetId"))
+    PutFeedbackResponse.add_member(:target_type, Shapes::ShapeRef.new(shape: TargetType, required: true, location_name: "targetType"))
+    PutFeedbackResponse.struct_class = Types::PutFeedbackResponse
+
     QueryAssistantRequest.add_member(:assistant_id, Shapes::ShapeRef.new(shape: UuidOrArn, required: true, location: "uri", location_name: "assistantId"))
     QueryAssistantRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
     QueryAssistantRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
@@ -964,6 +985,17 @@ module Aws::ConnectWisdomService
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
 
+      api.add_operation(:put_feedback, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "PutFeedback"
+        o.http_method = "PUT"
+        o.http_request_uri = "/assistants/{assistantId}/feedback"
+        o.input = Shapes::ShapeRef.new(shape: PutFeedbackRequest)
+        o.output = Shapes::ShapeRef.new(shape: PutFeedbackResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:query_assistant, Seahorse::Model::Operation.new.tap do |o|
         o.name = "QueryAssistant"
         o.http_method = "POST"

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

@@ -1044,6 +1044,27 @@ module Aws::ConnectWisdomService
       include Aws::Structure
     end
 
+    # The feedback to submit to Wisdom.
+    #
+    # @note When making an API call, you may pass FeedbackData
+    #   data as a hash:
+    #
+    #       {
+    #         relevance: "HELPFUL", # required, accepts HELPFUL, NOT_HELPFUL
+    #       }
+    #
+    # @!attribute [rw] relevance
+    #   The relevance of the target this feedback is for.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/FeedbackData AWS API Documentation
+    #
+    class FeedbackData < Struct.new(
+      :relevance)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A search filter.
     #
     # @note When making an API call, you may pass Filter
@@ -1833,6 +1854,80 @@ module Aws::ConnectWisdomService
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass PutFeedbackRequest
+    #   data as a hash:
+    #
+    #       {
+    #         assistant_id: "UuidOrArn", # required
+    #         feedback: { # required
+    #           relevance: "HELPFUL", # required, accepts HELPFUL, NOT_HELPFUL
+    #         },
+    #         target_id: "String", # required
+    #         target_type: "RECOMMENDATION", # required, accepts RECOMMENDATION, RESULT
+    #       }
+    #
+    # @!attribute [rw] assistant_id
+    #   The identifier of the Wisdom assistant. Can be either the ID or the
+    #   ARN. URLs cannot contain the ARN.
+    #   @return [String]
+    #
+    # @!attribute [rw] feedback
+    #   The feedback.
+    #   @return [Types::FeedbackData]
+    #
+    # @!attribute [rw] target_id
+    #   The identifier of a recommendation. or The identifier of the result
+    #   data.
+    #   @return [String]
+    #
+    # @!attribute [rw] target_type
+    #   The type of the targetId for which The feedback. is targeted.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/PutFeedbackRequest AWS API Documentation
+    #
+    class PutFeedbackRequest < Struct.new(
+      :assistant_id,
+      :feedback,
+      :target_id,
+      :target_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] assistant_arn
+    #   The Amazon Resource Name (ARN) of the Wisdom assistant.
+    #   @return [String]
+    #
+    # @!attribute [rw] assistant_id
+    #   The identifier of the Wisdom assistant.
+    #   @return [String]
+    #
+    # @!attribute [rw] feedback
+    #   The feedback.
+    #   @return [Types::FeedbackData]
+    #
+    # @!attribute [rw] target_id
+    #   The identifier of a recommendation. or The identifier of the result
+    #   data.
+    #   @return [String]
+    #
+    # @!attribute [rw] target_type
+    #   The type of the targetId for which The feedback. is targeted.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/PutFeedbackResponse AWS API Documentation
+    #
+    class PutFeedbackResponse < Struct.new(
+      :assistant_arn,
+      :assistant_id,
+      :feedback,
+      :target_id,
+      :target_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass QueryAssistantRequest
     #   data as a hash:
     #

data/lib/aws-sdk-connectwisdomservice.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-connectwisdomservice/customizations'
 # @!group service
 module Aws::ConnectWisdomService
 
-  GEM_VERSION = '1.7.0'
+  GEM_VERSION = '1.8.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-connectwisdomservice
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core