aws-sdk-kendra 1.20.0 → 1.25.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: 79f5cd534e7f42898247529121cbbf6405d2fbeed157733c2bd46bebaa47037e
4
- data.tar.gz: 7844dc337245b7eb71dcdccb10651a6ed66af0276a8006240a22e27190402980
3
+ metadata.gz: c24dd5b0c9a0dfa5191e12c22817095559fe1a55fe11686928bf467a6381fbb6
4
+ data.tar.gz: 508006e9c8c7e694b2df5ce300bcd1aae37007991db321cea131a6c3fffcb2de
5
5
  SHA512:
6
- metadata.gz: 2acf956bf5d708e4e1f681057049fa0b74a67de236fb08a25e858c4456f66125efb086cb9bcb669aedcd36e42b812f6a154a66abbe2a0acf80b8b9b83bcfef00
7
- data.tar.gz: 90146acdc630dee44a92654af8d2068f2ea12e7ea15102666989e9895f7b059a49ff15cf7dea2f1fd0840703f24c3c85692c592ce4a80d569c86f91c330cef0e
6
+ metadata.gz: 2e608a2fc83b64fe26924fe29e0a9d8b96ee651ff9d8d5ed98e9e0151e980f669b819e7ebb3b09aa142f679ca541014c58342e7ede4fe90a8c37f4107c2304a6
7
+ data.tar.gz: 532b41df9199cd337fec526cff3bde4a8b6aca52bd9962ed4218d3532415779b8f356ae6b487240eaaae83eddbe16c75641cffb9648d7a38a2af109a3f19992e
data/CHANGELOG.md ADDED
@@ -0,0 +1,138 @@
1
+ Unreleased Changes
2
+ ------------------
3
+
4
+ 1.25.0 (2021-05-27)
5
+ ------------------
6
+
7
+ * Feature - Amazon Kendra now suggests popular queries in order to help guide query typing and help overall accuracy.
8
+
9
+ 1.24.0 (2021-04-21)
10
+ ------------------
11
+
12
+ * Feature - Amazon Kendra now enables users to override index-level boosting configurations for each query.
13
+
14
+ 1.23.0 (2021-04-01)
15
+ ------------------
16
+
17
+ * Feature - AWS Kendra's ServiceNow data source now supports OAuth 2.0 authentication and knowledge article filtering via a ServiceNow query.
18
+
19
+ 1.22.0 (2021-03-10)
20
+ ------------------
21
+
22
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
23
+
24
+ 1.21.0 (2021-02-02)
25
+ ------------------
26
+
27
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
28
+
29
+ 1.20.0 (2020-12-10)
30
+ ------------------
31
+
32
+ * Feature - Amazon Kendra now supports adding synonyms to an index through the new Thesaurus resource.
33
+
34
+ 1.19.0 (2020-12-08)
35
+ ------------------
36
+
37
+ * Feature - 1. Amazon Kendra connector for Google Drive repositories 2. Amazon Kendra's relevance ranking models are regularly tuned for each customer by capturing end-user search patterns and feedback.
38
+
39
+ 1.18.0 (2020-11-05)
40
+ ------------------
41
+
42
+ * Feature - Amazon Kendra now supports providing user context in your query requests, Tokens can be JSON or JWT format. This release also introduces support for Confluence cloud datasources.
43
+
44
+ 1.17.0 (2020-10-26)
45
+ ------------------
46
+
47
+ * Feature - Amazon Kendra now supports indexing data from Confluence Server.
48
+
49
+ 1.16.0 (2020-10-21)
50
+ ------------------
51
+
52
+ * Feature - This release adds custom data sources: a new data source type that gives you full control of the documents added, modified or deleted during a data source sync while providing run history metrics.
53
+
54
+ 1.15.0 (2020-10-21)
55
+ ------------------
56
+
57
+ * Feature - This release adds custom data sources: a new data source type that gives you full control of the documents added, modified or deleted during a data source sync while providing run history metrics.
58
+
59
+ 1.14.0 (2020-09-30)
60
+ ------------------
61
+
62
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
63
+
64
+ 1.13.0 (2020-09-17)
65
+ ------------------
66
+
67
+ * Feature - Amazon Kendra now supports additional file formats and metadata for FAQs.
68
+
69
+ 1.12.0 (2020-09-15)
70
+ ------------------
71
+
72
+ * Feature - Amazon Kendra now returns confidence scores for 'document' query responses.
73
+
74
+ 1.11.0 (2020-09-03)
75
+ ------------------
76
+
77
+ * Feature - Amazon Kendra now returns confidence scores for both 'answer' and 'question and answer' query responses.
78
+
79
+ 1.10.0 (2020-08-25)
80
+ ------------------
81
+
82
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
83
+
84
+ 1.9.0 (2020-07-24)
85
+ ------------------
86
+
87
+ * Feature - Amazon Kendra now supports sorting query results based on document attributes. Amazon Kendra also introduced an option to enclose table and column names with double quotes for database data sources.
88
+
89
+ 1.8.0 (2020-06-23)
90
+ ------------------
91
+
92
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
93
+
94
+ 1.7.1 (2020-06-11)
95
+ ------------------
96
+
97
+ * Issue - Republish previous version with correct dependency on `aws-sdk-core`.
98
+
99
+ 1.7.0 (2020-06-10)
100
+ ------------------
101
+
102
+ * Issue - This version has been yanked. (#2327).
103
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
104
+
105
+ 1.6.0 (2020-05-28)
106
+ ------------------
107
+
108
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
109
+
110
+ 1.5.0 (2020-05-11)
111
+ ------------------
112
+
113
+ * Feature - Amazon Kendra is now generally available. As part of general availability, we are launching * Developer edition * Ability to scale your Amazon Kendra index with capacity units * Support for new connectors * Support for new tagging API's * Support for Deleting data source * Metrics for data source sync operations * Metrics for query & storage utilization
114
+
115
+ 1.4.0 (2020-05-07)
116
+ ------------------
117
+
118
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
119
+
120
+ 1.3.0 (2020-03-27)
121
+ ------------------
122
+
123
+ * Feature - The Amazon Kendra Microsoft SharePoint data source now supports include and exclude regular expressions and change log features. Include and exclude regular expressions enable you to provide a list of regular expressions to match the display URL of SharePoint documents to either include or exclude documents respectively. When you enable the changelog feature it enables Amazon Kendra to use the SharePoint change log to determine which documents to update in the index.
124
+
125
+ 1.2.0 (2020-03-09)
126
+ ------------------
127
+
128
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
129
+
130
+ 1.1.0 (2019-12-10)
131
+ ------------------
132
+
133
+ * Feature - 1. Adding DocumentTitleFieldName as an optional configuration for SharePoint. 2. updating s3 object pattern to support all s3 keys.
134
+
135
+ 1.0.0 (2019-12-03)
136
+ ------------------
137
+
138
+ * Feature - Initial release of `aws-sdk-kendra`.
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.25.0
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
48
48
  # @!group service
49
49
  module Aws::Kendra
50
50
 
51
- GEM_VERSION = '1.20.0'
51
+ GEM_VERSION = '1.25.0'
52
52
 
53
53
  end
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -338,10 +338,10 @@ module Aws::Kendra
338
338
  # @!group API Operations
339
339
 
340
340
  # Removes one or more documents from an index. The documents must have
341
- # been added with the BatchPutDocument operation.
341
+ # been added with the `BatchPutDocument` operation.
342
342
  #
343
343
  # The documents are deleted asynchronously. You can see the progress of
344
- # the deletion by using AWS CloudWatch. Any error messages releated to
344
+ # the deletion by using AWS CloudWatch. Any error messages related to
345
345
  # the processing of the batch are sent to you CloudWatch log.
346
346
  #
347
347
  # @option params [required, String] :index_id
@@ -364,7 +364,7 @@ module Aws::Kendra
364
364
  # document_id_list: ["DocumentId"], # required
365
365
  # data_source_sync_job_metric_target: {
366
366
  # data_source_id: "DataSourceId", # required
367
- # data_source_sync_job_id: "DataSourceSyncJobId", # required
367
+ # data_source_sync_job_id: "DataSourceSyncJobId",
368
368
  # },
369
369
  # })
370
370
  #
@@ -398,7 +398,7 @@ module Aws::Kendra
398
398
  #
399
399
  # @option params [required, String] :index_id
400
400
  # The identifier of the index to add the documents to. You need to
401
- # create the index first using the CreateIndex operation.
401
+ # create the index first using the `CreateIndex` operation.
402
402
  #
403
403
  # @option params [String] :role_arn
404
404
  # The Amazon Resource Name (ARN) of a role that is allowed to run the
@@ -412,6 +412,12 @@ module Aws::Kendra
412
412
  # @option params [required, Array<Types::Document>] :documents
413
413
  # One or more documents to add to the index.
414
414
  #
415
+ # Documents can include custom attributes. For example, 'DataSourceId'
416
+ # and 'DataSourceSyncJobId' are custom attributes that provide
417
+ # information on the synchronization of documents running on a data
418
+ # source. Note, 'DataSourceSyncJobId' could be an optional custom
419
+ # attribute as Amazon Kendra will use the ID of a running sync job.
420
+ #
415
421
  # Documents have the following file size limits.
416
422
  #
417
423
  # * 5 MB total size for inline documents
@@ -484,6 +490,34 @@ module Aws::Kendra
484
490
  req.send_request(options)
485
491
  end
486
492
 
493
+ # Clears existing query suggestions from an index.
494
+ #
495
+ # This deletes existing suggestions only, not the queries in the query
496
+ # log. After you clear suggestions, Amazon Kendra learns new suggestions
497
+ # based on new queries added to the query log from the time you cleared
498
+ # suggestions. If you do not see any new suggestions, then please allow
499
+ # Amazon Kendra to collect enough queries to learn new suggestions.
500
+ #
501
+ # @option params [required, String] :index_id
502
+ # The identifier of the index you want to clear query suggestions from.
503
+ #
504
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
505
+ #
506
+ # @example Request syntax with placeholder values
507
+ #
508
+ # resp = client.clear_query_suggestions({
509
+ # index_id: "IndexId", # required
510
+ # })
511
+ #
512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestions AWS API Documentation
513
+ #
514
+ # @overload clear_query_suggestions(params = {})
515
+ # @param [Hash] params ({})
516
+ def clear_query_suggestions(params = {}, options = {})
517
+ req = build_request(:clear_query_suggestions, params)
518
+ req.send_request(options)
519
+ end
520
+
487
521
  # Creates a data source that you use to with an Amazon Kendra index.
488
522
  #
489
523
  # You specify a name, data source connector type and description for
@@ -744,6 +778,7 @@ module Aws::Kendra
744
778
  # index_field_name: "IndexFieldName", # required
745
779
  # },
746
780
  # ],
781
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
747
782
  # },
748
783
  # service_catalog_configuration: {
749
784
  # crawl_attachments: false,
@@ -759,6 +794,7 @@ module Aws::Kendra
759
794
  # },
760
795
  # ],
761
796
  # },
797
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
762
798
  # },
763
799
  # confluence_configuration: {
764
800
  # server_url: "Url", # required
@@ -944,11 +980,12 @@ module Aws::Kendra
944
980
 
945
981
  # Creates a new Amazon Kendra index. Index creation is an asynchronous
946
982
  # operation. To determine if index creation has completed, check the
947
- # `Status` field returned from a call to . The `Status` field is set to
948
- # `ACTIVE` when the index is ready to use.
983
+ # `Status` field returned from a call to `DescribeIndex`. The `Status`
984
+ # field is set to `ACTIVE` when the index is ready to use.
949
985
  #
950
986
  # Once the index is active you can index your documents using the
951
- # operation or using one of the supported data sources.
987
+ # `BatchPutDocument` operation or using one of the supported data
988
+ # sources.
952
989
  #
953
990
  # @option params [required, String] :name
954
991
  # The name for the new index.
@@ -1062,6 +1099,107 @@ module Aws::Kendra
1062
1099
  req.send_request(options)
1063
1100
  end
1064
1101
 
1102
+ # Creates a block list to exlcude certain queries from suggestions.
1103
+ #
1104
+ # Any query that contains words or phrases specified in the block list
1105
+ # is blocked or filtered out from being shown as a suggestion.
1106
+ #
1107
+ # You need to provide the file location of your block list text file in
1108
+ # your S3 bucket. In your text file, enter each block word or phrase on
1109
+ # a separate line.
1110
+ #
1111
+ # For information on the current quota limits for block lists, see
1112
+ # [Quotas for Amazon Kendra][1].
1113
+ #
1114
+ #
1115
+ #
1116
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1117
+ #
1118
+ # @option params [required, String] :index_id
1119
+ # The identifier of the index you want to create a query suggestions
1120
+ # block list for.
1121
+ #
1122
+ # @option params [required, String] :name
1123
+ # A user friendly name for the block list.
1124
+ #
1125
+ # For example, the block list named 'offensive-words' includes all
1126
+ # offensive words that could appear in user queries and need to be
1127
+ # blocked from suggestions.
1128
+ #
1129
+ # @option params [String] :description
1130
+ # A user-friendly description for the block list.
1131
+ #
1132
+ # For example, the description "List of all offensive words that can
1133
+ # appear in user queries and need to be blocked from suggestions."
1134
+ #
1135
+ # @option params [required, Types::S3Path] :source_s3_path
1136
+ # The S3 path to your block list text file in your S3 bucket.
1137
+ #
1138
+ # Each block word or phrase should be on a separate line in a text file.
1139
+ #
1140
+ # For information on the current quota limits for block lists, see
1141
+ # [Quotas for Amazon Kendra][1].
1142
+ #
1143
+ #
1144
+ #
1145
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1146
+ #
1147
+ # @option params [String] :client_token
1148
+ # A token that you provide to identify the request to create a query
1149
+ # suggestions block list.
1150
+ #
1151
+ # **A suitable default value is auto-generated.** You should normally
1152
+ # not need to pass this option.**
1153
+ #
1154
+ # @option params [required, String] :role_arn
1155
+ # The IAM (Identity and Access Management) role used by Amazon Kendra to
1156
+ # access the block list text file in your S3 bucket.
1157
+ #
1158
+ # You need permissions to the role ARN (Amazon Resource Name). The role
1159
+ # needs S3 read permissions to your file in S3 and needs to give STS
1160
+ # (Security Token Service) assume role permissions to Amazon Kendra.
1161
+ #
1162
+ # @option params [Array<Types::Tag>] :tags
1163
+ # A tag that you can assign to a block list that categorizes the block
1164
+ # list.
1165
+ #
1166
+ # @return [Types::CreateQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1167
+ #
1168
+ # * {Types::CreateQuerySuggestionsBlockListResponse#id #id} => String
1169
+ #
1170
+ # @example Request syntax with placeholder values
1171
+ #
1172
+ # resp = client.create_query_suggestions_block_list({
1173
+ # index_id: "IndexId", # required
1174
+ # name: "QuerySuggestionsBlockListName", # required
1175
+ # description: "Description",
1176
+ # source_s3_path: { # required
1177
+ # bucket: "S3BucketName", # required
1178
+ # key: "S3ObjectKey", # required
1179
+ # },
1180
+ # client_token: "ClientTokenName",
1181
+ # role_arn: "RoleArn", # required
1182
+ # tags: [
1183
+ # {
1184
+ # key: "TagKey", # required
1185
+ # value: "TagValue", # required
1186
+ # },
1187
+ # ],
1188
+ # })
1189
+ #
1190
+ # @example Response structure
1191
+ #
1192
+ # resp.id #=> String
1193
+ #
1194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList AWS API Documentation
1195
+ #
1196
+ # @overload create_query_suggestions_block_list(params = {})
1197
+ # @param [Hash] params ({})
1198
+ def create_query_suggestions_block_list(params = {}, options = {})
1199
+ req = build_request(:create_query_suggestions_block_list, params)
1200
+ req.send_request(options)
1201
+ end
1202
+
1065
1203
  # Creates a thesaurus for an index. The thesaurus contains a list of
1066
1204
  # synonyms in Solr format.
1067
1205
  #
@@ -1134,9 +1272,9 @@ module Aws::Kendra
1134
1272
 
1135
1273
  # Deletes an Amazon Kendra data source. An exception is not thrown if
1136
1274
  # the data source is already being deleted. While the data source is
1137
- # being deleted, the `Status` field returned by a call to the operation
1138
- # is set to `DELETING`. For more information, see [Deleting Data
1139
- # Sources][1].
1275
+ # being deleted, the `Status` field returned by a call to the
1276
+ # `DescribeDataSource` operation is set to `DELETING`. For more
1277
+ # information, see [Deleting Data Sources][1].
1140
1278
  #
1141
1279
  #
1142
1280
  #
@@ -1194,7 +1332,7 @@ module Aws::Kendra
1194
1332
 
1195
1333
  # Deletes an existing Amazon Kendra index. An exception is not thrown if
1196
1334
  # the index is already being deleted. While the index is being deleted,
1197
- # the `Status` field returned by a call to the DescribeIndex operation
1335
+ # the `Status` field returned by a call to the `DescribeIndex` operation
1198
1336
  # is set to `DELETING`.
1199
1337
  #
1200
1338
  # @option params [required, String] :id
@@ -1217,6 +1355,36 @@ module Aws::Kendra
1217
1355
  req.send_request(options)
1218
1356
  end
1219
1357
 
1358
+ # Deletes a block list used for query suggestions for an index.
1359
+ #
1360
+ # A deleted block list might not take effect right away. Amazon Kendra
1361
+ # needs to refresh the entire suggestions list to add back the queries
1362
+ # that were previously blocked.
1363
+ #
1364
+ # @option params [required, String] :index_id
1365
+ # The identifier of the you want to delete a block list from.
1366
+ #
1367
+ # @option params [required, String] :id
1368
+ # The unique identifier of the block list that needs to be deleted.
1369
+ #
1370
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1371
+ #
1372
+ # @example Request syntax with placeholder values
1373
+ #
1374
+ # resp = client.delete_query_suggestions_block_list({
1375
+ # index_id: "IndexId", # required
1376
+ # id: "QuerySuggestionsBlockListId", # required
1377
+ # })
1378
+ #
1379
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList AWS API Documentation
1380
+ #
1381
+ # @overload delete_query_suggestions_block_list(params = {})
1382
+ # @param [Hash] params ({})
1383
+ def delete_query_suggestions_block_list(params = {}, options = {})
1384
+ req = build_request(:delete_query_suggestions_block_list, params)
1385
+ req.send_request(options)
1386
+ end
1387
+
1220
1388
  # Deletes an existing Amazon Kendra thesaurus.
1221
1389
  #
1222
1390
  # @option params [required, String] :id
@@ -1402,6 +1570,7 @@ module Aws::Kendra
1402
1570
  # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].data_source_field_name #=> String
1403
1571
  # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].date_field_format #=> String
1404
1572
  # resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].index_field_name #=> String
1573
+ # resp.configuration.service_now_configuration.knowledge_article_configuration.filter_query #=> String
1405
1574
  # resp.configuration.service_now_configuration.service_catalog_configuration.crawl_attachments #=> Boolean
1406
1575
  # resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns #=> Array
1407
1576
  # resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[0] #=> String
@@ -1413,6 +1582,7 @@ module Aws::Kendra
1413
1582
  # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
1414
1583
  # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
1415
1584
  # resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
1585
+ # resp.configuration.service_now_configuration.authentication_type #=> String, one of "HTTP_BASIC", "OAUTH2"
1416
1586
  # resp.configuration.confluence_configuration.server_url #=> String
1417
1587
  # resp.configuration.confluence_configuration.secret_arn #=> String
1418
1588
  # resp.configuration.confluence_configuration.version #=> String, one of "CLOUD", "SERVER"
@@ -1612,6 +1782,112 @@ module Aws::Kendra
1612
1782
  req.send_request(options)
1613
1783
  end
1614
1784
 
1785
+ # Describes a block list used for query suggestions for an index.
1786
+ #
1787
+ # This is used to check the current settings that are applied to a block
1788
+ # list.
1789
+ #
1790
+ # @option params [required, String] :index_id
1791
+ # The identifier of the index for the block list.
1792
+ #
1793
+ # @option params [required, String] :id
1794
+ # The unique identifier of the block list.
1795
+ #
1796
+ # @return [Types::DescribeQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1797
+ #
1798
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#index_id #index_id} => String
1799
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#id #id} => String
1800
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#name #name} => String
1801
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#description #description} => String
1802
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#status #status} => String
1803
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#error_message #error_message} => String
1804
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#created_at #created_at} => Time
1805
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#updated_at #updated_at} => Time
1806
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#source_s3_path #source_s3_path} => Types::S3Path
1807
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#item_count #item_count} => Integer
1808
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#file_size_bytes #file_size_bytes} => Integer
1809
+ # * {Types::DescribeQuerySuggestionsBlockListResponse#role_arn #role_arn} => String
1810
+ #
1811
+ # @example Request syntax with placeholder values
1812
+ #
1813
+ # resp = client.describe_query_suggestions_block_list({
1814
+ # index_id: "IndexId", # required
1815
+ # id: "QuerySuggestionsBlockListId", # required
1816
+ # })
1817
+ #
1818
+ # @example Response structure
1819
+ #
1820
+ # resp.index_id #=> String
1821
+ # resp.id #=> String
1822
+ # resp.name #=> String
1823
+ # resp.description #=> String
1824
+ # resp.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
1825
+ # resp.error_message #=> String
1826
+ # resp.created_at #=> Time
1827
+ # resp.updated_at #=> Time
1828
+ # resp.source_s3_path.bucket #=> String
1829
+ # resp.source_s3_path.key #=> String
1830
+ # resp.item_count #=> Integer
1831
+ # resp.file_size_bytes #=> Integer
1832
+ # resp.role_arn #=> String
1833
+ #
1834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList AWS API Documentation
1835
+ #
1836
+ # @overload describe_query_suggestions_block_list(params = {})
1837
+ # @param [Hash] params ({})
1838
+ def describe_query_suggestions_block_list(params = {}, options = {})
1839
+ req = build_request(:describe_query_suggestions_block_list, params)
1840
+ req.send_request(options)
1841
+ end
1842
+
1843
+ # Describes the settings of query suggestions for an index.
1844
+ #
1845
+ # This is used to check the current settings applied to query
1846
+ # suggestions.
1847
+ #
1848
+ # @option params [required, String] :index_id
1849
+ # The identifier of the index you want to describe query suggestions
1850
+ # settings for.
1851
+ #
1852
+ # @return [Types::DescribeQuerySuggestionsConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1853
+ #
1854
+ # * {Types::DescribeQuerySuggestionsConfigResponse#mode #mode} => String
1855
+ # * {Types::DescribeQuerySuggestionsConfigResponse#status #status} => String
1856
+ # * {Types::DescribeQuerySuggestionsConfigResponse#query_log_look_back_window_in_days #query_log_look_back_window_in_days} => Integer
1857
+ # * {Types::DescribeQuerySuggestionsConfigResponse#include_queries_without_user_information #include_queries_without_user_information} => Boolean
1858
+ # * {Types::DescribeQuerySuggestionsConfigResponse#minimum_number_of_querying_users #minimum_number_of_querying_users} => Integer
1859
+ # * {Types::DescribeQuerySuggestionsConfigResponse#minimum_query_count #minimum_query_count} => Integer
1860
+ # * {Types::DescribeQuerySuggestionsConfigResponse#last_suggestions_build_time #last_suggestions_build_time} => Time
1861
+ # * {Types::DescribeQuerySuggestionsConfigResponse#last_clear_time #last_clear_time} => Time
1862
+ # * {Types::DescribeQuerySuggestionsConfigResponse#total_suggestions_count #total_suggestions_count} => Integer
1863
+ #
1864
+ # @example Request syntax with placeholder values
1865
+ #
1866
+ # resp = client.describe_query_suggestions_config({
1867
+ # index_id: "IndexId", # required
1868
+ # })
1869
+ #
1870
+ # @example Response structure
1871
+ #
1872
+ # resp.mode #=> String, one of "ENABLED", "LEARN_ONLY"
1873
+ # resp.status #=> String, one of "ACTIVE", "UPDATING"
1874
+ # resp.query_log_look_back_window_in_days #=> Integer
1875
+ # resp.include_queries_without_user_information #=> Boolean
1876
+ # resp.minimum_number_of_querying_users #=> Integer
1877
+ # resp.minimum_query_count #=> Integer
1878
+ # resp.last_suggestions_build_time #=> Time
1879
+ # resp.last_clear_time #=> Time
1880
+ # resp.total_suggestions_count #=> Integer
1881
+ #
1882
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig AWS API Documentation
1883
+ #
1884
+ # @overload describe_query_suggestions_config(params = {})
1885
+ # @param [Hash] params ({})
1886
+ def describe_query_suggestions_config(params = {}, options = {})
1887
+ req = build_request(:describe_query_suggestions_config, params)
1888
+ req.send_request(options)
1889
+ end
1890
+
1615
1891
  # Describes an existing Amazon Kendra thesaurus.
1616
1892
  #
1617
1893
  # @option params [required, String] :id
@@ -1669,6 +1945,58 @@ module Aws::Kendra
1669
1945
  req.send_request(options)
1670
1946
  end
1671
1947
 
1948
+ # Fetches the queries that are suggested to your users.
1949
+ #
1950
+ # @option params [required, String] :index_id
1951
+ # The identifier of the index you want to get query suggestions from.
1952
+ #
1953
+ # @option params [required, String] :query_text
1954
+ # The text of a user's query to generate query suggestions.
1955
+ #
1956
+ # A query is suggested if the query prefix matches what a user starts to
1957
+ # type as their query.
1958
+ #
1959
+ # Amazon Kendra does not show any suggestions if a user types fewer than
1960
+ # two characters or more than 60 characters. A query must also have at
1961
+ # least one search result and contain at least one word of more than
1962
+ # four characters.
1963
+ #
1964
+ # @option params [Integer] :max_suggestions_count
1965
+ # The maximum number of query suggestions you want to show to your
1966
+ # users.
1967
+ #
1968
+ # @return [Types::GetQuerySuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1969
+ #
1970
+ # * {Types::GetQuerySuggestionsResponse#query_suggestions_id #query_suggestions_id} => String
1971
+ # * {Types::GetQuerySuggestionsResponse#suggestions #suggestions} => Array&lt;Types::Suggestion&gt;
1972
+ #
1973
+ # @example Request syntax with placeholder values
1974
+ #
1975
+ # resp = client.get_query_suggestions({
1976
+ # index_id: "IndexId", # required
1977
+ # query_text: "SuggestionQueryText", # required
1978
+ # max_suggestions_count: 1,
1979
+ # })
1980
+ #
1981
+ # @example Response structure
1982
+ #
1983
+ # resp.query_suggestions_id #=> String
1984
+ # resp.suggestions #=> Array
1985
+ # resp.suggestions[0].id #=> String
1986
+ # resp.suggestions[0].value.text.text #=> String
1987
+ # resp.suggestions[0].value.text.highlights #=> Array
1988
+ # resp.suggestions[0].value.text.highlights[0].begin_offset #=> Integer
1989
+ # resp.suggestions[0].value.text.highlights[0].end_offset #=> Integer
1990
+ #
1991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions AWS API Documentation
1992
+ #
1993
+ # @overload get_query_suggestions(params = {})
1994
+ # @param [Hash] params ({})
1995
+ def get_query_suggestions(params = {}, options = {})
1996
+ req = build_request(:get_query_suggestions, params)
1997
+ req.send_request(options)
1998
+ end
1999
+
1672
2000
  # Gets statistics about synchronizing Amazon Kendra with a data source.
1673
2001
  #
1674
2002
  # @option params [required, String] :id
@@ -1882,6 +2210,68 @@ module Aws::Kendra
1882
2210
  req.send_request(options)
1883
2211
  end
1884
2212
 
2213
+ # Lists the block lists used for query suggestions for an index.
2214
+ #
2215
+ # For information on the current quota limits for block lists, see
2216
+ # [Quotas for Amazon Kendra][1].
2217
+ #
2218
+ #
2219
+ #
2220
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2221
+ #
2222
+ # @option params [required, String] :index_id
2223
+ # The identifier of the index for a list of all block lists that exist
2224
+ # for that index.
2225
+ #
2226
+ # For information on the current quota limits for block lists, see
2227
+ # [Quotas for Amazon Kendra][1].
2228
+ #
2229
+ #
2230
+ #
2231
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2232
+ #
2233
+ # @option params [String] :next_token
2234
+ # If the previous response was incomplete (because there is more data to
2235
+ # retrieve), Amazon Kendra returns a pagination token in the response.
2236
+ # You can use this pagination token to retrieve the next set of block
2237
+ # lists (`BlockListSummaryItems`).
2238
+ #
2239
+ # @option params [Integer] :max_results
2240
+ # The maximum number of block lists to return.
2241
+ #
2242
+ # @return [Types::ListQuerySuggestionsBlockListsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2243
+ #
2244
+ # * {Types::ListQuerySuggestionsBlockListsResponse#block_list_summary_items #block_list_summary_items} => Array&lt;Types::QuerySuggestionsBlockListSummary&gt;
2245
+ # * {Types::ListQuerySuggestionsBlockListsResponse#next_token #next_token} => String
2246
+ #
2247
+ # @example Request syntax with placeholder values
2248
+ #
2249
+ # resp = client.list_query_suggestions_block_lists({
2250
+ # index_id: "IndexId", # required
2251
+ # next_token: "NextToken",
2252
+ # max_results: 1,
2253
+ # })
2254
+ #
2255
+ # @example Response structure
2256
+ #
2257
+ # resp.block_list_summary_items #=> Array
2258
+ # resp.block_list_summary_items[0].id #=> String
2259
+ # resp.block_list_summary_items[0].name #=> String
2260
+ # resp.block_list_summary_items[0].status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
2261
+ # resp.block_list_summary_items[0].created_at #=> Time
2262
+ # resp.block_list_summary_items[0].updated_at #=> Time
2263
+ # resp.block_list_summary_items[0].item_count #=> Integer
2264
+ # resp.next_token #=> String
2265
+ #
2266
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists AWS API Documentation
2267
+ #
2268
+ # @overload list_query_suggestions_block_lists(params = {})
2269
+ # @param [Hash] params ({})
2270
+ def list_query_suggestions_block_lists(params = {}, options = {})
2271
+ req = build_request(:list_query_suggestions_block_lists, params)
2272
+ req.send_request(options)
2273
+ end
2274
+
1885
2275
  # Gets a list of tags associated with a specified resource. Indexes,
1886
2276
  # FAQs, and data sources can have tags associated with them.
1887
2277
  #
@@ -1984,7 +2374,7 @@ module Aws::Kendra
1984
2374
  #
1985
2375
  # @option params [required, String] :index_id
1986
2376
  # The unique identifier of the index to search. The identifier is
1987
- # returned in the response from the operation.
2377
+ # returned in the response from the `CreateIndex` operation.
1988
2378
  #
1989
2379
  # @option params [required, String] :query_text
1990
2380
  # The text to search for.
@@ -2013,6 +2403,23 @@ module Aws::Kendra
2013
2403
  # Sets the type of query. Only results for the specified query type are
2014
2404
  # returned.
2015
2405
  #
2406
+ # @option params [Array<Types::DocumentRelevanceConfiguration>] :document_relevance_override_configurations
2407
+ # Overrides relevance tuning configurations of fields or attributes set
2408
+ # at the index level.
2409
+ #
2410
+ # If you use this API to override the relevance tuning configured at the
2411
+ # index level, but there is no relevance tuning configured at the index
2412
+ # level, then Amazon Kendra does not apply any relevance tuning.
2413
+ #
2414
+ # If there is relevance tuning configured at the index level, but you do
2415
+ # not use this API to override any relevance tuning in the index, then
2416
+ # Amazon Kendra uses the relevance tuning that is configured at the
2417
+ # index level.
2418
+ #
2419
+ # If there is relevance tuning configured for fields at the index level,
2420
+ # but you use this API to override only some of these fields, then for
2421
+ # the fields you did not override, the importance is set to 1.
2422
+ #
2016
2423
  # @option params [Integer] :page_number
2017
2424
  # Query results are returned in pages the size of the `PageSize`
2018
2425
  # parameter. By default, Amazon Kendra returns the first page of
@@ -2139,6 +2546,20 @@ module Aws::Kendra
2139
2546
  # ],
2140
2547
  # requested_document_attributes: ["DocumentAttributeKey"],
2141
2548
  # query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
2549
+ # document_relevance_override_configurations: [
2550
+ # {
2551
+ # name: "DocumentMetadataConfigurationName", # required
2552
+ # relevance: { # required
2553
+ # freshness: false,
2554
+ # importance: 1,
2555
+ # duration: "Duration",
2556
+ # rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
2557
+ # value_importance_map: {
2558
+ # "ValueImportanceMapKey" => 1,
2559
+ # },
2560
+ # },
2561
+ # },
2562
+ # ],
2142
2563
  # page_number: 1,
2143
2564
  # page_size: 1,
2144
2565
  # sorting_configuration: {
@@ -2280,7 +2701,8 @@ module Aws::Kendra
2280
2701
  #
2281
2702
  # @option params [required, String] :query_id
2282
2703
  # The identifier of the specific query for which you are submitting
2283
- # feedback. The query ID is returned in the response to the operation.
2704
+ # feedback. The query ID is returned in the response to the `Query`
2705
+ # operation.
2284
2706
  #
2285
2707
  # @option params [Array<Types::ClickFeedback>] :click_feedback_items
2286
2708
  # Tells Amazon Kendra that a particular search result link was chosen by
@@ -2594,6 +3016,7 @@ module Aws::Kendra
2594
3016
  # index_field_name: "IndexFieldName", # required
2595
3017
  # },
2596
3018
  # ],
3019
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
2597
3020
  # },
2598
3021
  # service_catalog_configuration: {
2599
3022
  # crawl_attachments: false,
@@ -2609,6 +3032,7 @@ module Aws::Kendra
2609
3032
  # },
2610
3033
  # ],
2611
3034
  # },
3035
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
2612
3036
  # },
2613
3037
  # confluence_configuration: {
2614
3038
  # server_url: "Url", # required
@@ -2711,7 +3135,7 @@ module Aws::Kendra
2711
3135
  # The document metadata to update.
2712
3136
  #
2713
3137
  # @option params [Types::CapacityUnitsConfiguration] :capacity_units
2714
- # Sets the number of addtional storage and query capacity units that
3138
+ # Sets the number of additional storage and query capacity units that
2715
3139
  # should be used by the index. You can change the capacity of the index
2716
3140
  # up to 5 times per day.
2717
3141
  #
@@ -2787,6 +3211,167 @@ module Aws::Kendra
2787
3211
  req.send_request(options)
2788
3212
  end
2789
3213
 
3214
+ # Updates a block list used for query suggestions for an index.
3215
+ #
3216
+ # Updates to a block list might not take effect right away. Amazon
3217
+ # Kendra needs to refresh the entire suggestions list to apply any
3218
+ # updates to the block list. Other changes not related to the block list
3219
+ # apply immediately.
3220
+ #
3221
+ # If a block list is updating, then you need to wait for the first
3222
+ # update to finish before submitting another update.
3223
+ #
3224
+ # Amazon Kendra supports partial updates, so you only need to provide
3225
+ # the fields you want to update.
3226
+ #
3227
+ # @option params [required, String] :index_id
3228
+ # The identifier of the index for a block list.
3229
+ #
3230
+ # @option params [required, String] :id
3231
+ # The unique identifier of a block list.
3232
+ #
3233
+ # @option params [String] :name
3234
+ # The name of a block list.
3235
+ #
3236
+ # @option params [String] :description
3237
+ # The description for a block list.
3238
+ #
3239
+ # @option params [Types::S3Path] :source_s3_path
3240
+ # The S3 path where your block list text file sits in S3.
3241
+ #
3242
+ # If you update your block list and provide the same path to the block
3243
+ # list text file in S3, then Amazon Kendra reloads the file to refresh
3244
+ # the block list. Amazon Kendra does not automatically refresh your
3245
+ # block list. You need to call the `UpdateQuerySuggestionsBlockList` API
3246
+ # to refresh you block list.
3247
+ #
3248
+ # If you update your block list, then Amazon Kendra asynchronously
3249
+ # refreshes all query suggestions with the latest content in the S3
3250
+ # file. This means changes might not take effect immediately.
3251
+ #
3252
+ # @option params [String] :role_arn
3253
+ # The IAM (Identity and Access Management) role used to access the block
3254
+ # list text file in S3.
3255
+ #
3256
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3257
+ #
3258
+ # @example Request syntax with placeholder values
3259
+ #
3260
+ # resp = client.update_query_suggestions_block_list({
3261
+ # index_id: "IndexId", # required
3262
+ # id: "QuerySuggestionsBlockListId", # required
3263
+ # name: "QuerySuggestionsBlockListName",
3264
+ # description: "Description",
3265
+ # source_s3_path: {
3266
+ # bucket: "S3BucketName", # required
3267
+ # key: "S3ObjectKey", # required
3268
+ # },
3269
+ # role_arn: "RoleArn",
3270
+ # })
3271
+ #
3272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList AWS API Documentation
3273
+ #
3274
+ # @overload update_query_suggestions_block_list(params = {})
3275
+ # @param [Hash] params ({})
3276
+ def update_query_suggestions_block_list(params = {}, options = {})
3277
+ req = build_request(:update_query_suggestions_block_list, params)
3278
+ req.send_request(options)
3279
+ end
3280
+
3281
+ # Updates the settings of query suggestions for an index.
3282
+ #
3283
+ # Amazon Kendra supports partial updates, so you only need to provide
3284
+ # the fields you want to update.
3285
+ #
3286
+ # If an update is currently processing (i.e. 'happening'), you need to
3287
+ # wait for the update to finish before making another update.
3288
+ #
3289
+ # Updates to query suggestions settings might not take effect right
3290
+ # away. The time for your updated settings to take effect depends on the
3291
+ # updates made and the number of search queries in your index.
3292
+ #
3293
+ # You can still enable/disable query suggestions at any time.
3294
+ #
3295
+ # @option params [required, String] :index_id
3296
+ # The identifier of the index you want to update query suggestions
3297
+ # settings for.
3298
+ #
3299
+ # @option params [String] :mode
3300
+ # Set the mode to `ENABLED` or `LEARN_ONLY`.
3301
+ #
3302
+ # By default, Amazon Kendra enables query suggestions. `LEARN_ONLY` mode
3303
+ # allows you to turn off query suggestions. You can to update this at
3304
+ # any time.
3305
+ #
3306
+ # In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
3307
+ # queries to keep suggestions up to date for when you are ready to
3308
+ # switch to ENABLED mode again.
3309
+ #
3310
+ # @option params [Integer] :query_log_look_back_window_in_days
3311
+ # How recent your queries are in your query log time window.
3312
+ #
3313
+ # The time window is the number of days from current day to past days.
3314
+ #
3315
+ # By default, Amazon Kendra sets this to 180.
3316
+ #
3317
+ # @option params [Boolean] :include_queries_without_user_information
3318
+ # `TRUE` to include queries without user information (i.e. all queries,
3319
+ # irrespective of the user), otherwise `FALSE` to only include queries
3320
+ # with user information.
3321
+ #
3322
+ # If you pass user information to Amazon Kendra along with the queries,
3323
+ # you can set this flag to `FALSE` and instruct Amazon Kendra to only
3324
+ # consider queries with user information.
3325
+ #
3326
+ # If you set to `FALSE`, Amazon Kendra only considers queries searched
3327
+ # at least `MinimumQueryCount` times across
3328
+ # `MinimumNumberOfQueryingUsers` unique users for suggestions.
3329
+ #
3330
+ # If you set to `TRUE`, Amazon Kendra ignores all user information and
3331
+ # learns from all queries.
3332
+ #
3333
+ # @option params [Integer] :minimum_number_of_querying_users
3334
+ # The minimum number of unique users who must search a query in order
3335
+ # for the query to be eligible to suggest to your users.
3336
+ #
3337
+ # Increasing this number might decrease the number of suggestions.
3338
+ # However, this ensures a query is searched by many users and is truly
3339
+ # popular to suggest to users.
3340
+ #
3341
+ # How you tune this setting depends on your specific needs.
3342
+ #
3343
+ # @option params [Integer] :minimum_query_count
3344
+ # The the minimum number of times a query must be searched in order to
3345
+ # be eligible to suggest to your users.
3346
+ #
3347
+ # Decreasing this number increases the number of suggestions. However,
3348
+ # this affects the quality of suggestions as it sets a low bar for a
3349
+ # query to be considered popular to suggest to users.
3350
+ #
3351
+ # How you tune this setting depends on your specific needs.
3352
+ #
3353
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3354
+ #
3355
+ # @example Request syntax with placeholder values
3356
+ #
3357
+ # resp = client.update_query_suggestions_config({
3358
+ # index_id: "IndexId", # required
3359
+ # mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
3360
+ # query_log_look_back_window_in_days: 1,
3361
+ # include_queries_without_user_information: false,
3362
+ # minimum_number_of_querying_users: 1,
3363
+ # minimum_query_count: 1,
3364
+ # })
3365
+ #
3366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig AWS API Documentation
3367
+ #
3368
+ # @overload update_query_suggestions_config(params = {})
3369
+ # @param [Hash] params ({})
3370
+ def update_query_suggestions_config(params = {}, options = {})
3371
+ req = build_request(:update_query_suggestions_config, params)
3372
+ req.send_request(options)
3373
+ end
3374
+
2790
3375
  # Updates a thesaurus file associated with an index.
2791
3376
  #
2792
3377
  # @option params [required, String] :id
@@ -2845,7 +3430,7 @@ module Aws::Kendra
2845
3430
  params: params,
2846
3431
  config: config)
2847
3432
  context[:gem_name] = 'aws-sdk-kendra'
2848
- context[:gem_version] = '1.20.0'
3433
+ context[:gem_version] = '1.25.0'
2849
3434
  Seahorse::Client::Request.new(handlers, context)
2850
3435
  end
2851
3436