aws-sdk-qconnect 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e305849a47af0149dd13ba1d4df018233269926e7d6dc867df794915e98a7f3
-  data.tar.gz: 1e61c5a73d8ca416d8658294307043991683dfabde081f96b1500133f415ab9c
+  metadata.gz: 540f1a83303847a0ae5825697b12ffe404daedd03752b8a09388125f1455d919
+  data.tar.gz: 72e594eaf6ec8b0c0653c2e790aaf7aa7d6fd38b8d9329375f5033181e92e905
 SHA512:
-  metadata.gz: 0bf72e71171c7cf7a42f6364606e6063430172fb57b0f61b194c99034ca7dc652d174e672ec00b9f2a2462f841473d0188000da3ae905a6139955d601b59d25b
-  data.tar.gz: 3aff985b14781e4720ee9dfcfd1c11cd184e4f4af09a3c1558c28d1dfe7cb3390b04bee439850a02b5874891611f72f549a1edb91fe9f45bf109240e99ffd1b7
+  metadata.gz: 647dad94adef4c4a076920ac32f306073c33dbbf01ed0fce7c929085212eca25511b3b7db4fa9fd9e2fbce065fb6e64a5892c1d8e1576a5ca2fb903cf678c764
+  data.tar.gz: dc01e0991c06ed500958817c3ae380a9cc072670c67f7725a8f7e74aba94073905ac07dafcf9df0cfc1d421aaa5c6f89cce9f817cc7abe9c41602cdc15fdaed7

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.2.0 (2024-01-05)
+------------------
+
+* Feature - Marked SearchQuickResponses API as readonly.
+
+1.1.0 (2023-12-01)
+------------------
+
+* Feature - This release adds the PutFeedback API and allows providing feedback against the specified assistant for the specified target.
+
 1.0.0 (2023-11-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.2.0

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

@@ -785,7 +785,7 @@ module Aws::QConnect
       req.send_request(options)
     end
 
-    # Creates a Amazon Q quick response.
+    # Creates an Amazon Q quick response.
     #
     # @option params [Array<String>] :channels
     #   The Amazon Connect channels this quick response applies to.
@@ -2038,6 +2038,59 @@ module Aws::QConnect
       req.send_request(options)
     end
 
+    # Provides feedback against the specified assistant for the specified
+    # target. This API only supports generative targets.
+    #
+    # @option params [required, String] :assistant_id
+    #   The identifier of the Amazon Q assistant.
+    #
+    # @option params [required, Types::ContentFeedbackData] :content_feedback
+    #   Information about the feedback provided.
+    #
+    # @option params [required, String] :target_id
+    #   The identifier of the feedback target.
+    #
+    # @option params [required, String] :target_type
+    #   The type of the feedback target.
+    #
+    # @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#content_feedback #content_feedback} => Types::ContentFeedbackData
+    #   * {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
+    #     content_feedback: { # required
+    #       generative_content_feedback_data: {
+    #         relevance: "HELPFUL", # required, accepts HELPFUL, NOT_HELPFUL
+    #       },
+    #     },
+    #     target_id: "Uuid", # required
+    #     target_type: "RECOMMENDATION", # required, accepts RECOMMENDATION, RESULT
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.assistant_arn #=> String
+    #   resp.assistant_id #=> String
+    #   resp.content_feedback.generative_content_feedback_data.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/qconnect-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].
     #
@@ -2251,7 +2304,7 @@ module Aws::QConnect
       req.send_request(options)
     end
 
-    # Searches existing Amazon Q quick responses in a Amazon Q knowledge
+    # Searches existing Amazon Q quick responses in an Amazon Q knowledge
     # base.
     #
     # @option params [Hash<String,String>] :attributes
@@ -2916,7 +2969,7 @@ module Aws::QConnect
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-qconnect'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.2.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -43,6 +43,7 @@ module Aws::QConnect
     ContactAttributes = Shapes::MapShape.new(name: 'ContactAttributes')
     ContentData = Shapes::StructureShape.new(name: 'ContentData')
     ContentDataDetails = Shapes::StructureShape.new(name: 'ContentDataDetails')
+    ContentFeedbackData = Shapes::UnionShape.new(name: 'ContentFeedbackData')
     ContentMetadata = Shapes::MapShape.new(name: 'ContentMetadata')
     ContentReference = Shapes::StructureShape.new(name: 'ContentReference')
     ContentStatus = Shapes::StringShape.new(name: 'ContentStatus')
@@ -87,6 +88,7 @@ module Aws::QConnect
     FilterField = Shapes::StringShape.new(name: 'FilterField')
     FilterList = Shapes::ListShape.new(name: 'FilterList')
     FilterOperator = Shapes::StringShape.new(name: 'FilterOperator')
+    GenerativeContentFeedbackData = Shapes::StructureShape.new(name: 'GenerativeContentFeedbackData')
     GenerativeDataDetails = Shapes::StructureShape.new(name: 'GenerativeDataDetails')
     GenerativeReference = Shapes::StructureShape.new(name: 'GenerativeReference')
     GenericArn = Shapes::StringShape.new(name: 'GenericArn')
@@ -156,6 +158,8 @@ module Aws::QConnect
     Order = Shapes::StringShape.new(name: 'Order')
     PreconditionFailedException = Shapes::StructureShape.new(name: 'PreconditionFailedException')
     Priority = Shapes::StringShape.new(name: 'Priority')
+    PutFeedbackRequest = Shapes::StructureShape.new(name: 'PutFeedbackRequest')
+    PutFeedbackResponse = Shapes::StructureShape.new(name: 'PutFeedbackResponse')
     QueryAssistantRequest = Shapes::StructureShape.new(name: 'QueryAssistantRequest')
     QueryAssistantResponse = Shapes::StructureShape.new(name: 'QueryAssistantResponse')
     QueryCondition = Shapes::UnionShape.new(name: 'QueryCondition')
@@ -203,6 +207,7 @@ module Aws::QConnect
     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')
@@ -241,6 +246,7 @@ module Aws::QConnect
     TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
     TagValue = Shapes::StringShape.new(name: 'TagValue')
     Tags = Shapes::MapShape.new(name: 'Tags')
+    TargetType = Shapes::StringShape.new(name: 'TargetType')
     TextData = Shapes::StructureShape.new(name: 'TextData')
     TimeToLive = Shapes::IntegerShape.new(name: 'TimeToLive')
     TooManyTagsException = Shapes::StructureShape.new(name: 'TooManyTagsException')
@@ -370,6 +376,12 @@ module Aws::QConnect
     ContentDataDetails.add_member(:text_data, Shapes::ShapeRef.new(shape: TextData, required: true, location_name: "textData"))
     ContentDataDetails.struct_class = Types::ContentDataDetails
 
+    ContentFeedbackData.add_member(:generative_content_feedback_data, Shapes::ShapeRef.new(shape: GenerativeContentFeedbackData, location_name: "generativeContentFeedbackData"))
+    ContentFeedbackData.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    ContentFeedbackData.add_member_subclass(:generative_content_feedback_data, Types::ContentFeedbackData::GenerativeContentFeedbackData)
+    ContentFeedbackData.add_member_subclass(:unknown, Types::ContentFeedbackData::Unknown)
+    ContentFeedbackData.struct_class = Types::ContentFeedbackData
+
     ContentMetadata.key = Shapes::ShapeRef.new(shape: NonEmptyString)
     ContentMetadata.value = Shapes::ShapeRef.new(shape: NonEmptyString)
 
@@ -546,6 +558,9 @@ module Aws::QConnect
 
     FilterList.member = Shapes::ShapeRef.new(shape: Filter)
 
+    GenerativeContentFeedbackData.add_member(:relevance, Shapes::ShapeRef.new(shape: Relevance, required: true, location_name: "relevance"))
+    GenerativeContentFeedbackData.struct_class = Types::GenerativeContentFeedbackData
+
     GenerativeDataDetails.add_member(:completion, Shapes::ShapeRef.new(shape: SensitiveString, required: true, location_name: "completion"))
     GenerativeDataDetails.add_member(:ranking_data, Shapes::ShapeRef.new(shape: RankingData, required: true, location_name: "rankingData"))
     GenerativeDataDetails.add_member(:references, Shapes::ShapeRef.new(shape: DataSummaryList, required: true, location_name: "references"))
@@ -772,6 +787,19 @@ module Aws::QConnect
     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(:content_feedback, Shapes::ShapeRef.new(shape: ContentFeedbackData, required: true, location_name: "contentFeedback"))
+    PutFeedbackRequest.add_member(:target_id, Shapes::ShapeRef.new(shape: Uuid, 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(:content_feedback, Shapes::ShapeRef.new(shape: ContentFeedbackData, required: true, location_name: "contentFeedback"))
+    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"))
@@ -1501,6 +1529,17 @@ module Aws::QConnect
         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-qconnect/endpoints.rb

@@ -418,6 +418,20 @@ module Aws::QConnect
       end
     end
 
+    class PutFeedback
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::QConnect::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class QueryAssistant
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-qconnect/plugins/endpoints.rb

@@ -115,6 +115,8 @@ module Aws::QConnect
             Aws::QConnect::Endpoints::ListTagsForResource.build(context)
           when :notify_recommendations_received
             Aws::QConnect::Endpoints::NotifyRecommendationsReceived.build(context)
+          when :put_feedback
+            Aws::QConnect::Endpoints::PutFeedback.build(context)
           when :query_assistant
             Aws::QConnect::Endpoints::QueryAssistant.build(context)
           when :remove_knowledge_base_template_uri

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

@@ -239,7 +239,7 @@ module Aws::QConnect
       include Aws::Structure
     end
 
-    # The capability configuration for a Amazon Q assistant.
+    # The capability configuration for an Amazon Q assistant.
     #
     # @!attribute [rw] type
     #   The type of Amazon Q assistant capability.
@@ -578,6 +578,29 @@ module Aws::QConnect
       include Aws::Structure
     end
 
+    # Information about the feedback.
+    #
+    # @note ContentFeedbackData is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @note ContentFeedbackData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ContentFeedbackData corresponding to the set member.
+    #
+    # @!attribute [rw] generative_content_feedback_data
+    #   Information about the feedback for a generative target type.
+    #   @return [Types::GenerativeContentFeedbackData]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ContentFeedbackData AWS API Documentation
+    #
+    class ContentFeedbackData < Struct.new(
+      :generative_content_feedback_data,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class GenerativeContentFeedbackData < ContentFeedbackData; end
+      class Unknown < ContentFeedbackData; end
+    end
+
     # Reference information about the content.
     #
     # @!attribute [rw] content_arn
@@ -1443,6 +1466,20 @@ module Aws::QConnect
       include Aws::Structure
     end
 
+    # The feedback information for a generative target type.
+    #
+    # @!attribute [rw] relevance
+    #   The relevance of the feedback.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GenerativeContentFeedbackData AWS API Documentation
+    #
+    class GenerativeContentFeedbackData < Struct.new(
+      :relevance)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Details about generative data.
     #
     # @!attribute [rw] completion
@@ -2518,6 +2555,65 @@ module Aws::QConnect
       include Aws::Structure
     end
 
+    # @!attribute [rw] assistant_id
+    #   The identifier of the Amazon Q assistant.
+    #   @return [String]
+    #
+    # @!attribute [rw] content_feedback
+    #   Information about the feedback provided.
+    #   @return [Types::ContentFeedbackData]
+    #
+    # @!attribute [rw] target_id
+    #   The identifier of the feedback target.
+    #   @return [String]
+    #
+    # @!attribute [rw] target_type
+    #   The type of the feedback target.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PutFeedbackRequest AWS API Documentation
+    #
+    class PutFeedbackRequest < Struct.new(
+      :assistant_id,
+      :content_feedback,
+      :target_id,
+      :target_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] assistant_arn
+    #   The Amazon Resource Name (ARN) of the Amazon Q assistant.
+    #   @return [String]
+    #
+    # @!attribute [rw] assistant_id
+    #   The identifier of the Amazon Q assistant.
+    #   @return [String]
+    #
+    # @!attribute [rw] content_feedback
+    #   Information about the feedback provided.
+    #   @return [Types::ContentFeedbackData]
+    #
+    # @!attribute [rw] target_id
+    #   The identifier of the feedback target.
+    #   @return [String]
+    #
+    # @!attribute [rw] target_type
+    #   The type of the feedback target.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PutFeedbackResponse AWS API Documentation
+    #
+    class PutFeedbackResponse < Struct.new(
+      :assistant_arn,
+      :assistant_id,
+      :content_feedback,
+      :target_id,
+      :target_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] assistant_id
     #   The identifier of the Amazon Q assistant. Can be either the ID or
     #   the ARN. URLs cannot contain the ARN.

data/lib/aws-sdk-qconnect.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-qconnect/customizations'
 # @!group service
 module Aws::QConnect
 
-  GEM_VERSION = '1.0.0'
+  GEM_VERSION = '1.2.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-qconnect
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core