aws-sdk-qconnect 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4e305849a47af0149dd13ba1d4df018233269926e7d6dc867df794915e98a7f3
4
- data.tar.gz: 1e61c5a73d8ca416d8658294307043991683dfabde081f96b1500133f415ab9c
3
+ metadata.gz: 6b46f2765d9b6572c7fedd62fd0c86ab974221d847ad828485c54af0cae2d48e
4
+ data.tar.gz: b2de7f9a70483d6dfb3018eed6c46977f04af2e9e4298fc59fde134491e12ffb
5
5
  SHA512:
6
- metadata.gz: 0bf72e71171c7cf7a42f6364606e6063430172fb57b0f61b194c99034ca7dc652d174e672ec00b9f2a2462f841473d0188000da3ae905a6139955d601b59d25b
7
- data.tar.gz: 3aff985b14781e4720ee9dfcfd1c11cd184e4f4af09a3c1558c28d1dfe7cb3390b04bee439850a02b5874891611f72f549a1edb91fe9f45bf109240e99ffd1b7
6
+ metadata.gz: bbe91c48220a6e9435e2b5f28842626fa9fee52b8668d39c8ad18486b902da20d339cb5b7c81e0586a6f92bdd6b8f495bb32fc3c8419d23350a35e51e9059e32
7
+ data.tar.gz: be3460479836b40e3334fb2c454ad815018695f5743dd2adf3b2e59d91894cbe0021deee2a8bef94a610da37121fc8944b92673d4e2097ab7e37f49892f357d7
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.1.0 (2023-12-01)
5
+ ------------------
6
+
7
+ * Feature - This release adds the PutFeedback API and allows providing feedback against the specified assistant for the specified target.
8
+
4
9
  1.0.0 (2023-11-28)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.0
1
+ 1.1.0
@@ -785,7 +785,7 @@ module Aws::QConnect
785
785
  req.send_request(options)
786
786
  end
787
787
 
788
- # Creates a Amazon Q quick response.
788
+ # Creates an Amazon Q quick response.
789
789
  #
790
790
  # @option params [Array<String>] :channels
791
791
  # The Amazon Connect channels this quick response applies to.
@@ -2038,6 +2038,59 @@ module Aws::QConnect
2038
2038
  req.send_request(options)
2039
2039
  end
2040
2040
 
2041
+ # Provides feedback against the specified assistant for the specified
2042
+ # target. This API only supports generative targets.
2043
+ #
2044
+ # @option params [required, String] :assistant_id
2045
+ # The identifier of the Amazon Q assistant.
2046
+ #
2047
+ # @option params [required, Types::ContentFeedbackData] :content_feedback
2048
+ # Information about the feedback provided.
2049
+ #
2050
+ # @option params [required, String] :target_id
2051
+ # The identifier of the feedback target.
2052
+ #
2053
+ # @option params [required, String] :target_type
2054
+ # The type of the feedback target.
2055
+ #
2056
+ # @return [Types::PutFeedbackResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2057
+ #
2058
+ # * {Types::PutFeedbackResponse#assistant_arn #assistant_arn} => String
2059
+ # * {Types::PutFeedbackResponse#assistant_id #assistant_id} => String
2060
+ # * {Types::PutFeedbackResponse#content_feedback #content_feedback} => Types::ContentFeedbackData
2061
+ # * {Types::PutFeedbackResponse#target_id #target_id} => String
2062
+ # * {Types::PutFeedbackResponse#target_type #target_type} => String
2063
+ #
2064
+ # @example Request syntax with placeholder values
2065
+ #
2066
+ # resp = client.put_feedback({
2067
+ # assistant_id: "UuidOrArn", # required
2068
+ # content_feedback: { # required
2069
+ # generative_content_feedback_data: {
2070
+ # relevance: "HELPFUL", # required, accepts HELPFUL, NOT_HELPFUL
2071
+ # },
2072
+ # },
2073
+ # target_id: "Uuid", # required
2074
+ # target_type: "RECOMMENDATION", # required, accepts RECOMMENDATION, RESULT
2075
+ # })
2076
+ #
2077
+ # @example Response structure
2078
+ #
2079
+ # resp.assistant_arn #=> String
2080
+ # resp.assistant_id #=> String
2081
+ # resp.content_feedback.generative_content_feedback_data.relevance #=> String, one of "HELPFUL", "NOT_HELPFUL"
2082
+ # resp.target_id #=> String
2083
+ # resp.target_type #=> String, one of "RECOMMENDATION", "RESULT"
2084
+ #
2085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PutFeedback AWS API Documentation
2086
+ #
2087
+ # @overload put_feedback(params = {})
2088
+ # @param [Hash] params ({})
2089
+ def put_feedback(params = {}, options = {})
2090
+ req = build_request(:put_feedback, params)
2091
+ req.send_request(options)
2092
+ end
2093
+
2041
2094
  # Performs a manual search against the specified assistant. To retrieve
2042
2095
  # recommendations for an assistant, use [GetRecommendations][1].
2043
2096
  #
@@ -2251,7 +2304,7 @@ module Aws::QConnect
2251
2304
  req.send_request(options)
2252
2305
  end
2253
2306
 
2254
- # Searches existing Amazon Q quick responses in a Amazon Q knowledge
2307
+ # Searches existing Amazon Q quick responses in an Amazon Q knowledge
2255
2308
  # base.
2256
2309
  #
2257
2310
  # @option params [Hash<String,String>] :attributes
@@ -2916,7 +2969,7 @@ module Aws::QConnect
2916
2969
  params: params,
2917
2970
  config: config)
2918
2971
  context[:gem_name] = 'aws-sdk-qconnect'
2919
- context[:gem_version] = '1.0.0'
2972
+ context[:gem_version] = '1.1.0'
2920
2973
  Seahorse::Client::Request.new(handlers, context)
2921
2974
  end
2922
2975
 
@@ -43,6 +43,7 @@ module Aws::QConnect
43
43
  ContactAttributes = Shapes::MapShape.new(name: 'ContactAttributes')
44
44
  ContentData = Shapes::StructureShape.new(name: 'ContentData')
45
45
  ContentDataDetails = Shapes::StructureShape.new(name: 'ContentDataDetails')
46
+ ContentFeedbackData = Shapes::UnionShape.new(name: 'ContentFeedbackData')
46
47
  ContentMetadata = Shapes::MapShape.new(name: 'ContentMetadata')
47
48
  ContentReference = Shapes::StructureShape.new(name: 'ContentReference')
48
49
  ContentStatus = Shapes::StringShape.new(name: 'ContentStatus')
@@ -87,6 +88,7 @@ module Aws::QConnect
87
88
  FilterField = Shapes::StringShape.new(name: 'FilterField')
88
89
  FilterList = Shapes::ListShape.new(name: 'FilterList')
89
90
  FilterOperator = Shapes::StringShape.new(name: 'FilterOperator')
91
+ GenerativeContentFeedbackData = Shapes::StructureShape.new(name: 'GenerativeContentFeedbackData')
90
92
  GenerativeDataDetails = Shapes::StructureShape.new(name: 'GenerativeDataDetails')
91
93
  GenerativeReference = Shapes::StructureShape.new(name: 'GenerativeReference')
92
94
  GenericArn = Shapes::StringShape.new(name: 'GenericArn')
@@ -156,6 +158,8 @@ module Aws::QConnect
156
158
  Order = Shapes::StringShape.new(name: 'Order')
157
159
  PreconditionFailedException = Shapes::StructureShape.new(name: 'PreconditionFailedException')
158
160
  Priority = Shapes::StringShape.new(name: 'Priority')
161
+ PutFeedbackRequest = Shapes::StructureShape.new(name: 'PutFeedbackRequest')
162
+ PutFeedbackResponse = Shapes::StructureShape.new(name: 'PutFeedbackResponse')
159
163
  QueryAssistantRequest = Shapes::StructureShape.new(name: 'QueryAssistantRequest')
160
164
  QueryAssistantResponse = Shapes::StructureShape.new(name: 'QueryAssistantResponse')
161
165
  QueryCondition = Shapes::UnionShape.new(name: 'QueryCondition')
@@ -203,6 +207,7 @@ module Aws::QConnect
203
207
  RecommendationTriggerList = Shapes::ListShape.new(name: 'RecommendationTriggerList')
204
208
  RecommendationTriggerType = Shapes::StringShape.new(name: 'RecommendationTriggerType')
205
209
  RecommendationType = Shapes::StringShape.new(name: 'RecommendationType')
210
+ Relevance = Shapes::StringShape.new(name: 'Relevance')
206
211
  RelevanceLevel = Shapes::StringShape.new(name: 'RelevanceLevel')
207
212
  RelevanceScore = Shapes::FloatShape.new(name: 'RelevanceScore')
208
213
  RemoveKnowledgeBaseTemplateUriRequest = Shapes::StructureShape.new(name: 'RemoveKnowledgeBaseTemplateUriRequest')
@@ -241,6 +246,7 @@ module Aws::QConnect
241
246
  TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
242
247
  TagValue = Shapes::StringShape.new(name: 'TagValue')
243
248
  Tags = Shapes::MapShape.new(name: 'Tags')
249
+ TargetType = Shapes::StringShape.new(name: 'TargetType')
244
250
  TextData = Shapes::StructureShape.new(name: 'TextData')
245
251
  TimeToLive = Shapes::IntegerShape.new(name: 'TimeToLive')
246
252
  TooManyTagsException = Shapes::StructureShape.new(name: 'TooManyTagsException')
@@ -370,6 +376,12 @@ module Aws::QConnect
370
376
  ContentDataDetails.add_member(:text_data, Shapes::ShapeRef.new(shape: TextData, required: true, location_name: "textData"))
371
377
  ContentDataDetails.struct_class = Types::ContentDataDetails
372
378
 
379
+ ContentFeedbackData.add_member(:generative_content_feedback_data, Shapes::ShapeRef.new(shape: GenerativeContentFeedbackData, location_name: "generativeContentFeedbackData"))
380
+ ContentFeedbackData.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
381
+ ContentFeedbackData.add_member_subclass(:generative_content_feedback_data, Types::ContentFeedbackData::GenerativeContentFeedbackData)
382
+ ContentFeedbackData.add_member_subclass(:unknown, Types::ContentFeedbackData::Unknown)
383
+ ContentFeedbackData.struct_class = Types::ContentFeedbackData
384
+
373
385
  ContentMetadata.key = Shapes::ShapeRef.new(shape: NonEmptyString)
374
386
  ContentMetadata.value = Shapes::ShapeRef.new(shape: NonEmptyString)
375
387
 
@@ -546,6 +558,9 @@ module Aws::QConnect
546
558
 
547
559
  FilterList.member = Shapes::ShapeRef.new(shape: Filter)
548
560
 
561
+ GenerativeContentFeedbackData.add_member(:relevance, Shapes::ShapeRef.new(shape: Relevance, required: true, location_name: "relevance"))
562
+ GenerativeContentFeedbackData.struct_class = Types::GenerativeContentFeedbackData
563
+
549
564
  GenerativeDataDetails.add_member(:completion, Shapes::ShapeRef.new(shape: SensitiveString, required: true, location_name: "completion"))
550
565
  GenerativeDataDetails.add_member(:ranking_data, Shapes::ShapeRef.new(shape: RankingData, required: true, location_name: "rankingData"))
551
566
  GenerativeDataDetails.add_member(:references, Shapes::ShapeRef.new(shape: DataSummaryList, required: true, location_name: "references"))
@@ -772,6 +787,19 @@ module Aws::QConnect
772
787
  PreconditionFailedException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "message"))
773
788
  PreconditionFailedException.struct_class = Types::PreconditionFailedException
774
789
 
790
+ PutFeedbackRequest.add_member(:assistant_id, Shapes::ShapeRef.new(shape: UuidOrArn, required: true, location: "uri", location_name: "assistantId"))
791
+ PutFeedbackRequest.add_member(:content_feedback, Shapes::ShapeRef.new(shape: ContentFeedbackData, required: true, location_name: "contentFeedback"))
792
+ PutFeedbackRequest.add_member(:target_id, Shapes::ShapeRef.new(shape: Uuid, required: true, location_name: "targetId"))
793
+ PutFeedbackRequest.add_member(:target_type, Shapes::ShapeRef.new(shape: TargetType, required: true, location_name: "targetType"))
794
+ PutFeedbackRequest.struct_class = Types::PutFeedbackRequest
795
+
796
+ PutFeedbackResponse.add_member(:assistant_arn, Shapes::ShapeRef.new(shape: UuidOrArn, required: true, location_name: "assistantArn"))
797
+ PutFeedbackResponse.add_member(:assistant_id, Shapes::ShapeRef.new(shape: Uuid, required: true, location_name: "assistantId"))
798
+ PutFeedbackResponse.add_member(:content_feedback, Shapes::ShapeRef.new(shape: ContentFeedbackData, required: true, location_name: "contentFeedback"))
799
+ PutFeedbackResponse.add_member(:target_id, Shapes::ShapeRef.new(shape: Uuid, required: true, location_name: "targetId"))
800
+ PutFeedbackResponse.add_member(:target_type, Shapes::ShapeRef.new(shape: TargetType, required: true, location_name: "targetType"))
801
+ PutFeedbackResponse.struct_class = Types::PutFeedbackResponse
802
+
775
803
  QueryAssistantRequest.add_member(:assistant_id, Shapes::ShapeRef.new(shape: UuidOrArn, required: true, location: "uri", location_name: "assistantId"))
776
804
  QueryAssistantRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
777
805
  QueryAssistantRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
@@ -1501,6 +1529,17 @@ module Aws::QConnect
1501
1529
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1502
1530
  end)
1503
1531
 
1532
+ api.add_operation(:put_feedback, Seahorse::Model::Operation.new.tap do |o|
1533
+ o.name = "PutFeedback"
1534
+ o.http_method = "PUT"
1535
+ o.http_request_uri = "/assistants/{assistantId}/feedback"
1536
+ o.input = Shapes::ShapeRef.new(shape: PutFeedbackRequest)
1537
+ o.output = Shapes::ShapeRef.new(shape: PutFeedbackResponse)
1538
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
1539
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1540
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1541
+ end)
1542
+
1504
1543
  api.add_operation(:query_assistant, Seahorse::Model::Operation.new.tap do |o|
1505
1544
  o.name = "QueryAssistant"
1506
1545
  o.http_method = "POST"
@@ -418,6 +418,20 @@ module Aws::QConnect
418
418
  end
419
419
  end
420
420
 
421
+ class PutFeedback
422
+ def self.build(context)
423
+ unless context.config.regional_endpoint
424
+ endpoint = context.config.endpoint.to_s
425
+ end
426
+ Aws::QConnect::EndpointParameters.new(
427
+ region: context.config.region,
428
+ use_dual_stack: context.config.use_dualstack_endpoint,
429
+ use_fips: context.config.use_fips_endpoint,
430
+ endpoint: endpoint,
431
+ )
432
+ end
433
+ end
434
+
421
435
  class QueryAssistant
422
436
  def self.build(context)
423
437
  unless context.config.regional_endpoint
@@ -115,6 +115,8 @@ module Aws::QConnect
115
115
  Aws::QConnect::Endpoints::ListTagsForResource.build(context)
116
116
  when :notify_recommendations_received
117
117
  Aws::QConnect::Endpoints::NotifyRecommendationsReceived.build(context)
118
+ when :put_feedback
119
+ Aws::QConnect::Endpoints::PutFeedback.build(context)
118
120
  when :query_assistant
119
121
  Aws::QConnect::Endpoints::QueryAssistant.build(context)
120
122
  when :remove_knowledge_base_template_uri
@@ -239,7 +239,7 @@ module Aws::QConnect
239
239
  include Aws::Structure
240
240
  end
241
241
 
242
- # The capability configuration for a Amazon Q assistant.
242
+ # The capability configuration for an Amazon Q assistant.
243
243
  #
244
244
  # @!attribute [rw] type
245
245
  # The type of Amazon Q assistant capability.
@@ -578,6 +578,29 @@ module Aws::QConnect
578
578
  include Aws::Structure
579
579
  end
580
580
 
581
+ # Information about the feedback.
582
+ #
583
+ # @note ContentFeedbackData is a union - when making an API calls you must set exactly one of the members.
584
+ #
585
+ # @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.
586
+ #
587
+ # @!attribute [rw] generative_content_feedback_data
588
+ # Information about the feedback for a generative target type.
589
+ # @return [Types::GenerativeContentFeedbackData]
590
+ #
591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ContentFeedbackData AWS API Documentation
592
+ #
593
+ class ContentFeedbackData < Struct.new(
594
+ :generative_content_feedback_data,
595
+ :unknown)
596
+ SENSITIVE = []
597
+ include Aws::Structure
598
+ include Aws::Structure::Union
599
+
600
+ class GenerativeContentFeedbackData < ContentFeedbackData; end
601
+ class Unknown < ContentFeedbackData; end
602
+ end
603
+
581
604
  # Reference information about the content.
582
605
  #
583
606
  # @!attribute [rw] content_arn
@@ -1443,6 +1466,20 @@ module Aws::QConnect
1443
1466
  include Aws::Structure
1444
1467
  end
1445
1468
 
1469
+ # The feedback information for a generative target type.
1470
+ #
1471
+ # @!attribute [rw] relevance
1472
+ # The relevance of the feedback.
1473
+ # @return [String]
1474
+ #
1475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GenerativeContentFeedbackData AWS API Documentation
1476
+ #
1477
+ class GenerativeContentFeedbackData < Struct.new(
1478
+ :relevance)
1479
+ SENSITIVE = []
1480
+ include Aws::Structure
1481
+ end
1482
+
1446
1483
  # Details about generative data.
1447
1484
  #
1448
1485
  # @!attribute [rw] completion
@@ -2518,6 +2555,65 @@ module Aws::QConnect
2518
2555
  include Aws::Structure
2519
2556
  end
2520
2557
 
2558
+ # @!attribute [rw] assistant_id
2559
+ # The identifier of the Amazon Q assistant.
2560
+ # @return [String]
2561
+ #
2562
+ # @!attribute [rw] content_feedback
2563
+ # Information about the feedback provided.
2564
+ # @return [Types::ContentFeedbackData]
2565
+ #
2566
+ # @!attribute [rw] target_id
2567
+ # The identifier of the feedback target.
2568
+ # @return [String]
2569
+ #
2570
+ # @!attribute [rw] target_type
2571
+ # The type of the feedback target.
2572
+ # @return [String]
2573
+ #
2574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PutFeedbackRequest AWS API Documentation
2575
+ #
2576
+ class PutFeedbackRequest < Struct.new(
2577
+ :assistant_id,
2578
+ :content_feedback,
2579
+ :target_id,
2580
+ :target_type)
2581
+ SENSITIVE = []
2582
+ include Aws::Structure
2583
+ end
2584
+
2585
+ # @!attribute [rw] assistant_arn
2586
+ # The Amazon Resource Name (ARN) of the Amazon Q assistant.
2587
+ # @return [String]
2588
+ #
2589
+ # @!attribute [rw] assistant_id
2590
+ # The identifier of the Amazon Q assistant.
2591
+ # @return [String]
2592
+ #
2593
+ # @!attribute [rw] content_feedback
2594
+ # Information about the feedback provided.
2595
+ # @return [Types::ContentFeedbackData]
2596
+ #
2597
+ # @!attribute [rw] target_id
2598
+ # The identifier of the feedback target.
2599
+ # @return [String]
2600
+ #
2601
+ # @!attribute [rw] target_type
2602
+ # The type of the feedback target.
2603
+ # @return [String]
2604
+ #
2605
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PutFeedbackResponse AWS API Documentation
2606
+ #
2607
+ class PutFeedbackResponse < Struct.new(
2608
+ :assistant_arn,
2609
+ :assistant_id,
2610
+ :content_feedback,
2611
+ :target_id,
2612
+ :target_type)
2613
+ SENSITIVE = []
2614
+ include Aws::Structure
2615
+ end
2616
+
2521
2617
  # @!attribute [rw] assistant_id
2522
2618
  # The identifier of the Amazon Q assistant. Can be either the ID or
2523
2619
  # the ARN. URLs cannot contain the ARN.
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-qconnect/customizations'
52
52
  # @!group service
53
53
  module Aws::QConnect
54
54
 
55
- GEM_VERSION = '1.0.0'
55
+ GEM_VERSION = '1.1.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-qconnect
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-28 00:00:00.000000000 Z
11
+ date: 2023-12-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core