aws-sdk-kendra 1.24.0 → 1.25.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f3cba49ab0bd0ebf0402ed5cfa575f7974f0cc2237808f474615a3d2bbc09ce6
4
- data.tar.gz: 8cab555f2b156c2997cc48c51d7a85f76ed74b255ec013d5fdf01860ba4e31da
3
+ metadata.gz: c24dd5b0c9a0dfa5191e12c22817095559fe1a55fe11686928bf467a6381fbb6
4
+ data.tar.gz: 508006e9c8c7e694b2df5ce300bcd1aae37007991db321cea131a6c3fffcb2de
5
5
  SHA512:
6
- metadata.gz: 4476c80222605da34edc81d2cfc7efe2209a574c067bace3c9bf23a872c37bc100fa34d2e75934db17c6c3ca532a659cf5be21d1ba85e610768c05266aafaaad
7
- data.tar.gz: 59a7170b16fea52f95bc57e0f9be6ebdb411f9d05ed444f7811ed9ddf41f5ac6d7d375c3cc0e7649c0d7d145839349a184169549494ea0fe7f0ece5db2affb38
6
+ metadata.gz: 2e608a2fc83b64fe26924fe29e0a9d8b96ee651ff9d8d5ed98e9e0151e980f669b819e7ebb3b09aa142f679ca541014c58342e7ede4fe90a8c37f4107c2304a6
7
+ data.tar.gz: 532b41df9199cd337fec526cff3bde4a8b6aca52bd9962ed4218d3532415779b8f356ae6b487240eaaae83eddbe16c75641cffb9648d7a38a2af109a3f19992e
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
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
+
4
9
  1.24.0 (2021-04-21)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.24.0
1
+ 1.25.0
@@ -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.24.0'
51
+ GEM_VERSION = '1.25.0'
52
52
 
53
53
  end
@@ -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
  #
@@ -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
@@ -1065,6 +1099,107 @@ module Aws::Kendra
1065
1099
  req.send_request(options)
1066
1100
  end
1067
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
+
1068
1203
  # Creates a thesaurus for an index. The thesaurus contains a list of
1069
1204
  # synonyms in Solr format.
1070
1205
  #
@@ -1220,6 +1355,36 @@ module Aws::Kendra
1220
1355
  req.send_request(options)
1221
1356
  end
1222
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
+
1223
1388
  # Deletes an existing Amazon Kendra thesaurus.
1224
1389
  #
1225
1390
  # @option params [required, String] :id
@@ -1617,6 +1782,112 @@ module Aws::Kendra
1617
1782
  req.send_request(options)
1618
1783
  end
1619
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
+
1620
1891
  # Describes an existing Amazon Kendra thesaurus.
1621
1892
  #
1622
1893
  # @option params [required, String] :id
@@ -1674,6 +1945,58 @@ module Aws::Kendra
1674
1945
  req.send_request(options)
1675
1946
  end
1676
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
+
1677
2000
  # Gets statistics about synchronizing Amazon Kendra with a data source.
1678
2001
  #
1679
2002
  # @option params [required, String] :id
@@ -1887,6 +2210,68 @@ module Aws::Kendra
1887
2210
  req.send_request(options)
1888
2211
  end
1889
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
+
1890
2275
  # Gets a list of tags associated with a specified resource. Indexes,
1891
2276
  # FAQs, and data sources can have tags associated with them.
1892
2277
  #
@@ -2826,6 +3211,167 @@ module Aws::Kendra
2826
3211
  req.send_request(options)
2827
3212
  end
2828
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
+
2829
3375
  # Updates a thesaurus file associated with an index.
2830
3376
  #
2831
3377
  # @option params [required, String] :id
@@ -2884,7 +3430,7 @@ module Aws::Kendra
2884
3430
  params: params,
2885
3431
  config: config)
2886
3432
  context[:gem_name] = 'aws-sdk-kendra'
2887
- context[:gem_version] = '1.24.0'
3433
+ context[:gem_version] = '1.25.0'
2888
3434
  Seahorse::Client::Request.new(handlers, context)
2889
3435
  end
2890
3436