aws-sdk-kendra 1.24.0 → 1.29.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +25 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra.rb +1 -1
- data/lib/aws-sdk-kendra/client.rb +732 -8
- data/lib/aws-sdk-kendra/client_api.rb +387 -1
- data/lib/aws-sdk-kendra/types.rb +1609 -35
- metadata +3 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c889eb178ba263dd3756480d36ad4d306d3955f0b13020a0aee248544186098b
|
4
|
+
data.tar.gz: cf3504f318fbf4b6b517c2ba8d938ba1705ec551d4825717482b8a154dcef3e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b1c09536c3b61f6f2e46d8dda754a43bb6ad5e1c981b76edc902cdba4ea97fc0d79b4f0df25eca1675ab10f858a342a5b524394b7204d5d0d47e74fb9b599650
|
7
|
+
data.tar.gz: 19610c0498b6eb771d4ddd9357a938056f1ac68720a540bfb9c3421017aaaae0629813cf5e8f4faf9a80c67de30fbdef912b09e752b89f2c4bc65b45f83e4e35
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,31 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.29.0 (2021-06-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon Kendra Enterprise Edition now offered in smaller more granular units to enable customers with smaller workloads. Virtual Storage Capacity units now offer scaling in increments of 100,000 documents (up to 30GB) per unit and Virtual Query Units offer scaling increments of 8,000 queries per day.
|
8
|
+
|
9
|
+
1.28.0 (2021-06-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Amazon Kendra now supports SharePoint 2013 and SharePoint 2016 when using a SharePoint data source.
|
13
|
+
|
14
|
+
1.27.0 (2021-06-17)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Amazon Kendra now supports the indexing of web documents for search through the web crawler.
|
18
|
+
|
19
|
+
1.26.0 (2021-06-09)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - AWS Kendra now supports checking document status.
|
23
|
+
|
24
|
+
1.25.0 (2021-05-27)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Amazon Kendra now suggests popular queries in order to help guide query typing and help overall accuracy.
|
28
|
+
|
4
29
|
1.24.0 (2021-04-21)
|
5
30
|
------------------
|
6
31
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.29.0
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -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",
|
367
|
+
# data_source_sync_job_id: "DataSourceSyncJobId",
|
368
368
|
# },
|
369
369
|
# })
|
370
370
|
#
|
@@ -384,6 +384,85 @@ module Aws::Kendra
|
|
384
384
|
req.send_request(options)
|
385
385
|
end
|
386
386
|
|
387
|
+
# Returns the indexing status for one or more documents submitted with
|
388
|
+
# the [ BatchPutDocument][1] operation.
|
389
|
+
#
|
390
|
+
# When you use the `BatchPutDocument` operation, documents are indexed
|
391
|
+
# asynchronously. You can use the `BatchGetDocumentStatus` operation to
|
392
|
+
# get the current status of a list of documents so that you can
|
393
|
+
# determine if they have been successfully indexed.
|
394
|
+
#
|
395
|
+
# You can also use the `BatchGetDocumentStatus` operation to check the
|
396
|
+
# status of the [ BatchDeleteDocument][2] operation. When a document is
|
397
|
+
# deleted from the index, Amazon Kendra returns `NOT_FOUND` as the
|
398
|
+
# status.
|
399
|
+
#
|
400
|
+
#
|
401
|
+
#
|
402
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html
|
403
|
+
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html
|
404
|
+
#
|
405
|
+
# @option params [required, String] :index_id
|
406
|
+
# The identifier of the index to add documents to. The index ID is
|
407
|
+
# returned by the [ CreateIndex ][1] operation.
|
408
|
+
#
|
409
|
+
#
|
410
|
+
#
|
411
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html
|
412
|
+
#
|
413
|
+
# @option params [required, Array<Types::DocumentInfo>] :document_info_list
|
414
|
+
# A list of `DocumentInfo` objects that identify the documents for which
|
415
|
+
# to get the status. You identify the documents by their document ID and
|
416
|
+
# optional attributes.
|
417
|
+
#
|
418
|
+
# @return [Types::BatchGetDocumentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
419
|
+
#
|
420
|
+
# * {Types::BatchGetDocumentStatusResponse#errors #errors} => Array<Types::BatchGetDocumentStatusResponseError>
|
421
|
+
# * {Types::BatchGetDocumentStatusResponse#document_status_list #document_status_list} => Array<Types::Status>
|
422
|
+
#
|
423
|
+
# @example Request syntax with placeholder values
|
424
|
+
#
|
425
|
+
# resp = client.batch_get_document_status({
|
426
|
+
# index_id: "IndexId", # required
|
427
|
+
# document_info_list: [ # required
|
428
|
+
# {
|
429
|
+
# document_id: "DocumentId", # required
|
430
|
+
# attributes: [
|
431
|
+
# {
|
432
|
+
# key: "DocumentAttributeKey", # required
|
433
|
+
# value: { # required
|
434
|
+
# string_value: "DocumentAttributeStringValue",
|
435
|
+
# string_list_value: ["String"],
|
436
|
+
# long_value: 1,
|
437
|
+
# date_value: Time.now,
|
438
|
+
# },
|
439
|
+
# },
|
440
|
+
# ],
|
441
|
+
# },
|
442
|
+
# ],
|
443
|
+
# })
|
444
|
+
#
|
445
|
+
# @example Response structure
|
446
|
+
#
|
447
|
+
# resp.errors #=> Array
|
448
|
+
# resp.errors[0].document_id #=> String
|
449
|
+
# resp.errors[0].error_code #=> String, one of "InternalError", "InvalidRequest"
|
450
|
+
# resp.errors[0].error_message #=> String
|
451
|
+
# resp.document_status_list #=> Array
|
452
|
+
# resp.document_status_list[0].document_id #=> String
|
453
|
+
# resp.document_status_list[0].document_status #=> String, one of "NOT_FOUND", "PROCESSING", "INDEXED", "UPDATED", "FAILED", "UPDATE_FAILED"
|
454
|
+
# resp.document_status_list[0].failure_code #=> String
|
455
|
+
# resp.document_status_list[0].failure_reason #=> String
|
456
|
+
#
|
457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatus AWS API Documentation
|
458
|
+
#
|
459
|
+
# @overload batch_get_document_status(params = {})
|
460
|
+
# @param [Hash] params ({})
|
461
|
+
def batch_get_document_status(params = {}, options = {})
|
462
|
+
req = build_request(:batch_get_document_status, params)
|
463
|
+
req.send_request(options)
|
464
|
+
end
|
465
|
+
|
387
466
|
# Adds one or more documents to an index.
|
388
467
|
#
|
389
468
|
# The `BatchPutDocument` operation enables you to ingest inline
|
@@ -412,6 +491,12 @@ module Aws::Kendra
|
|
412
491
|
# @option params [required, Array<Types::Document>] :documents
|
413
492
|
# One or more documents to add to the index.
|
414
493
|
#
|
494
|
+
# Documents can include custom attributes. For example, 'DataSourceId'
|
495
|
+
# and 'DataSourceSyncJobId' are custom attributes that provide
|
496
|
+
# information on the synchronization of documents running on a data
|
497
|
+
# source. Note, 'DataSourceSyncJobId' could be an optional custom
|
498
|
+
# attribute as Amazon Kendra will use the ID of a running sync job.
|
499
|
+
#
|
415
500
|
# Documents have the following file size limits.
|
416
501
|
#
|
417
502
|
# * 5 MB total size for inline documents
|
@@ -484,6 +569,34 @@ module Aws::Kendra
|
|
484
569
|
req.send_request(options)
|
485
570
|
end
|
486
571
|
|
572
|
+
# Clears existing query suggestions from an index.
|
573
|
+
#
|
574
|
+
# This deletes existing suggestions only, not the queries in the query
|
575
|
+
# log. After you clear suggestions, Amazon Kendra learns new suggestions
|
576
|
+
# based on new queries added to the query log from the time you cleared
|
577
|
+
# suggestions. If you do not see any new suggestions, then please allow
|
578
|
+
# Amazon Kendra to collect enough queries to learn new suggestions.
|
579
|
+
#
|
580
|
+
# @option params [required, String] :index_id
|
581
|
+
# The identifier of the index you want to clear query suggestions from.
|
582
|
+
#
|
583
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
584
|
+
#
|
585
|
+
# @example Request syntax with placeholder values
|
586
|
+
#
|
587
|
+
# resp = client.clear_query_suggestions({
|
588
|
+
# index_id: "IndexId", # required
|
589
|
+
# })
|
590
|
+
#
|
591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestions AWS API Documentation
|
592
|
+
#
|
593
|
+
# @overload clear_query_suggestions(params = {})
|
594
|
+
# @param [Hash] params ({})
|
595
|
+
def clear_query_suggestions(params = {}, options = {})
|
596
|
+
req = build_request(:clear_query_suggestions, params)
|
597
|
+
req.send_request(options)
|
598
|
+
end
|
599
|
+
|
487
600
|
# Creates a data source that you use to with an Amazon Kendra index.
|
488
601
|
#
|
489
602
|
# You specify a name, data source connector type and description for
|
@@ -566,7 +679,7 @@ module Aws::Kendra
|
|
566
679
|
# resp = client.create_data_source({
|
567
680
|
# name: "DataSourceName", # required
|
568
681
|
# index_id: "IndexId", # required
|
569
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE
|
682
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER
|
570
683
|
# configuration: {
|
571
684
|
# s3_configuration: {
|
572
685
|
# bucket_name: "S3BucketName", # required
|
@@ -581,7 +694,7 @@ module Aws::Kendra
|
|
581
694
|
# },
|
582
695
|
# },
|
583
696
|
# share_point_configuration: {
|
584
|
-
# share_point_version: "
|
697
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
585
698
|
# urls: ["Url"], # required
|
586
699
|
# secret_arn: "SecretArn", # required
|
587
700
|
# crawl_attachments: false,
|
@@ -601,6 +714,10 @@ module Aws::Kendra
|
|
601
714
|
# ],
|
602
715
|
# document_title_field_name: "DataSourceFieldName",
|
603
716
|
# disable_local_groups: false,
|
717
|
+
# ssl_certificate_s3_path: {
|
718
|
+
# bucket: "S3BucketName", # required
|
719
|
+
# key: "S3ObjectKey", # required
|
720
|
+
# },
|
604
721
|
# },
|
605
722
|
# database_configuration: {
|
606
723
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -829,6 +946,37 @@ module Aws::Kendra
|
|
829
946
|
# exclude_user_accounts: ["UserAccount"],
|
830
947
|
# exclude_shared_drives: ["SharedDriveId"],
|
831
948
|
# },
|
949
|
+
# web_crawler_configuration: {
|
950
|
+
# urls: { # required
|
951
|
+
# seed_url_configuration: {
|
952
|
+
# seed_urls: ["SeedUrl"], # required
|
953
|
+
# web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
|
954
|
+
# },
|
955
|
+
# site_maps_configuration: {
|
956
|
+
# site_maps: ["SiteMap"], # required
|
957
|
+
# },
|
958
|
+
# },
|
959
|
+
# crawl_depth: 1,
|
960
|
+
# max_links_per_page: 1,
|
961
|
+
# max_content_size_per_page_in_mega_bytes: 1.0,
|
962
|
+
# max_urls_per_minute_crawl_rate: 1,
|
963
|
+
# url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
964
|
+
# url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
965
|
+
# proxy_configuration: {
|
966
|
+
# host: "Host", # required
|
967
|
+
# port: 1, # required
|
968
|
+
# credentials: "SecretArn",
|
969
|
+
# },
|
970
|
+
# authentication_configuration: {
|
971
|
+
# basic_authentication: [
|
972
|
+
# {
|
973
|
+
# host: "Host", # required
|
974
|
+
# port: 1, # required
|
975
|
+
# credentials: "SecretArn", # required
|
976
|
+
# },
|
977
|
+
# ],
|
978
|
+
# },
|
979
|
+
# },
|
832
980
|
# },
|
833
981
|
# description: "Description",
|
834
982
|
# schedule: "ScanSchedule",
|
@@ -966,6 +1114,13 @@ module Aws::Kendra
|
|
966
1114
|
# The `Edition` parameter is optional. If you don't supply a value, the
|
967
1115
|
# default is `ENTERPRISE_EDITION`.
|
968
1116
|
#
|
1117
|
+
# For more information on quota limits for enterprise and developer
|
1118
|
+
# editions, see [Quotas][1].
|
1119
|
+
#
|
1120
|
+
#
|
1121
|
+
#
|
1122
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
1123
|
+
#
|
969
1124
|
# @option params [required, String] :role_arn
|
970
1125
|
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
971
1126
|
# Kendra permissions to access your Amazon CloudWatch logs and metrics.
|
@@ -1065,6 +1220,107 @@ module Aws::Kendra
|
|
1065
1220
|
req.send_request(options)
|
1066
1221
|
end
|
1067
1222
|
|
1223
|
+
# Creates a block list to exlcude certain queries from suggestions.
|
1224
|
+
#
|
1225
|
+
# Any query that contains words or phrases specified in the block list
|
1226
|
+
# is blocked or filtered out from being shown as a suggestion.
|
1227
|
+
#
|
1228
|
+
# You need to provide the file location of your block list text file in
|
1229
|
+
# your S3 bucket. In your text file, enter each block word or phrase on
|
1230
|
+
# a separate line.
|
1231
|
+
#
|
1232
|
+
# For information on the current quota limits for block lists, see
|
1233
|
+
# [Quotas for Amazon Kendra][1].
|
1234
|
+
#
|
1235
|
+
#
|
1236
|
+
#
|
1237
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
1238
|
+
#
|
1239
|
+
# @option params [required, String] :index_id
|
1240
|
+
# The identifier of the index you want to create a query suggestions
|
1241
|
+
# block list for.
|
1242
|
+
#
|
1243
|
+
# @option params [required, String] :name
|
1244
|
+
# A user friendly name for the block list.
|
1245
|
+
#
|
1246
|
+
# For example, the block list named 'offensive-words' includes all
|
1247
|
+
# offensive words that could appear in user queries and need to be
|
1248
|
+
# blocked from suggestions.
|
1249
|
+
#
|
1250
|
+
# @option params [String] :description
|
1251
|
+
# A user-friendly description for the block list.
|
1252
|
+
#
|
1253
|
+
# For example, the description "List of all offensive words that can
|
1254
|
+
# appear in user queries and need to be blocked from suggestions."
|
1255
|
+
#
|
1256
|
+
# @option params [required, Types::S3Path] :source_s3_path
|
1257
|
+
# The S3 path to your block list text file in your S3 bucket.
|
1258
|
+
#
|
1259
|
+
# Each block word or phrase should be on a separate line in a text file.
|
1260
|
+
#
|
1261
|
+
# For information on the current quota limits for block lists, see
|
1262
|
+
# [Quotas for Amazon Kendra][1].
|
1263
|
+
#
|
1264
|
+
#
|
1265
|
+
#
|
1266
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
1267
|
+
#
|
1268
|
+
# @option params [String] :client_token
|
1269
|
+
# A token that you provide to identify the request to create a query
|
1270
|
+
# suggestions block list.
|
1271
|
+
#
|
1272
|
+
# **A suitable default value is auto-generated.** You should normally
|
1273
|
+
# not need to pass this option.**
|
1274
|
+
#
|
1275
|
+
# @option params [required, String] :role_arn
|
1276
|
+
# The IAM (Identity and Access Management) role used by Amazon Kendra to
|
1277
|
+
# access the block list text file in your S3 bucket.
|
1278
|
+
#
|
1279
|
+
# You need permissions to the role ARN (Amazon Resource Name). The role
|
1280
|
+
# needs S3 read permissions to your file in S3 and needs to give STS
|
1281
|
+
# (Security Token Service) assume role permissions to Amazon Kendra.
|
1282
|
+
#
|
1283
|
+
# @option params [Array<Types::Tag>] :tags
|
1284
|
+
# A tag that you can assign to a block list that categorizes the block
|
1285
|
+
# list.
|
1286
|
+
#
|
1287
|
+
# @return [Types::CreateQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1288
|
+
#
|
1289
|
+
# * {Types::CreateQuerySuggestionsBlockListResponse#id #id} => String
|
1290
|
+
#
|
1291
|
+
# @example Request syntax with placeholder values
|
1292
|
+
#
|
1293
|
+
# resp = client.create_query_suggestions_block_list({
|
1294
|
+
# index_id: "IndexId", # required
|
1295
|
+
# name: "QuerySuggestionsBlockListName", # required
|
1296
|
+
# description: "Description",
|
1297
|
+
# source_s3_path: { # required
|
1298
|
+
# bucket: "S3BucketName", # required
|
1299
|
+
# key: "S3ObjectKey", # required
|
1300
|
+
# },
|
1301
|
+
# client_token: "ClientTokenName",
|
1302
|
+
# role_arn: "RoleArn", # required
|
1303
|
+
# tags: [
|
1304
|
+
# {
|
1305
|
+
# key: "TagKey", # required
|
1306
|
+
# value: "TagValue", # required
|
1307
|
+
# },
|
1308
|
+
# ],
|
1309
|
+
# })
|
1310
|
+
#
|
1311
|
+
# @example Response structure
|
1312
|
+
#
|
1313
|
+
# resp.id #=> String
|
1314
|
+
#
|
1315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockList AWS API Documentation
|
1316
|
+
#
|
1317
|
+
# @overload create_query_suggestions_block_list(params = {})
|
1318
|
+
# @param [Hash] params ({})
|
1319
|
+
def create_query_suggestions_block_list(params = {}, options = {})
|
1320
|
+
req = build_request(:create_query_suggestions_block_list, params)
|
1321
|
+
req.send_request(options)
|
1322
|
+
end
|
1323
|
+
|
1068
1324
|
# Creates a thesaurus for an index. The thesaurus contains a list of
|
1069
1325
|
# synonyms in Solr format.
|
1070
1326
|
#
|
@@ -1220,6 +1476,36 @@ module Aws::Kendra
|
|
1220
1476
|
req.send_request(options)
|
1221
1477
|
end
|
1222
1478
|
|
1479
|
+
# Deletes a block list used for query suggestions for an index.
|
1480
|
+
#
|
1481
|
+
# A deleted block list might not take effect right away. Amazon Kendra
|
1482
|
+
# needs to refresh the entire suggestions list to add back the queries
|
1483
|
+
# that were previously blocked.
|
1484
|
+
#
|
1485
|
+
# @option params [required, String] :index_id
|
1486
|
+
# The identifier of the you want to delete a block list from.
|
1487
|
+
#
|
1488
|
+
# @option params [required, String] :id
|
1489
|
+
# The unique identifier of the block list that needs to be deleted.
|
1490
|
+
#
|
1491
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1492
|
+
#
|
1493
|
+
# @example Request syntax with placeholder values
|
1494
|
+
#
|
1495
|
+
# resp = client.delete_query_suggestions_block_list({
|
1496
|
+
# index_id: "IndexId", # required
|
1497
|
+
# id: "QuerySuggestionsBlockListId", # required
|
1498
|
+
# })
|
1499
|
+
#
|
1500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockList AWS API Documentation
|
1501
|
+
#
|
1502
|
+
# @overload delete_query_suggestions_block_list(params = {})
|
1503
|
+
# @param [Hash] params ({})
|
1504
|
+
def delete_query_suggestions_block_list(params = {}, options = {})
|
1505
|
+
req = build_request(:delete_query_suggestions_block_list, params)
|
1506
|
+
req.send_request(options)
|
1507
|
+
end
|
1508
|
+
|
1223
1509
|
# Deletes an existing Amazon Kendra thesaurus.
|
1224
1510
|
#
|
1225
1511
|
# @option params [required, String] :id
|
@@ -1281,7 +1567,7 @@ module Aws::Kendra
|
|
1281
1567
|
# resp.id #=> String
|
1282
1568
|
# resp.index_id #=> String
|
1283
1569
|
# resp.name #=> String
|
1284
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
|
1570
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER"
|
1285
1571
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
1286
1572
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
1287
1573
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -1291,7 +1577,7 @@ module Aws::Kendra
|
|
1291
1577
|
# resp.configuration.s3_configuration.exclusion_patterns[0] #=> String
|
1292
1578
|
# resp.configuration.s3_configuration.documents_metadata_configuration.s3_prefix #=> String
|
1293
1579
|
# resp.configuration.s3_configuration.access_control_list_configuration.key_path #=> String
|
1294
|
-
# resp.configuration.share_point_configuration.share_point_version #=> String, one of "SHAREPOINT_ONLINE"
|
1580
|
+
# resp.configuration.share_point_configuration.share_point_version #=> String, one of "SHAREPOINT_2013", "SHAREPOINT_2016", "SHAREPOINT_ONLINE"
|
1295
1581
|
# resp.configuration.share_point_configuration.urls #=> Array
|
1296
1582
|
# resp.configuration.share_point_configuration.urls[0] #=> String
|
1297
1583
|
# resp.configuration.share_point_configuration.secret_arn #=> String
|
@@ -1311,6 +1597,8 @@ module Aws::Kendra
|
|
1311
1597
|
# resp.configuration.share_point_configuration.field_mappings[0].index_field_name #=> String
|
1312
1598
|
# resp.configuration.share_point_configuration.document_title_field_name #=> String
|
1313
1599
|
# resp.configuration.share_point_configuration.disable_local_groups #=> Boolean
|
1600
|
+
# resp.configuration.share_point_configuration.ssl_certificate_s3_path.bucket #=> String
|
1601
|
+
# resp.configuration.share_point_configuration.ssl_certificate_s3_path.key #=> String
|
1314
1602
|
# resp.configuration.database_configuration.database_engine_type #=> String, one of "RDS_AURORA_MYSQL", "RDS_AURORA_POSTGRESQL", "RDS_MYSQL", "RDS_POSTGRESQL"
|
1315
1603
|
# resp.configuration.database_configuration.connection_configuration.database_host #=> String
|
1316
1604
|
# resp.configuration.database_configuration.connection_configuration.database_port #=> Integer
|
@@ -1467,6 +1755,26 @@ module Aws::Kendra
|
|
1467
1755
|
# resp.configuration.google_drive_configuration.exclude_user_accounts[0] #=> String
|
1468
1756
|
# resp.configuration.google_drive_configuration.exclude_shared_drives #=> Array
|
1469
1757
|
# resp.configuration.google_drive_configuration.exclude_shared_drives[0] #=> String
|
1758
|
+
# resp.configuration.web_crawler_configuration.urls.seed_url_configuration.seed_urls #=> Array
|
1759
|
+
# resp.configuration.web_crawler_configuration.urls.seed_url_configuration.seed_urls[0] #=> String
|
1760
|
+
# resp.configuration.web_crawler_configuration.urls.seed_url_configuration.web_crawler_mode #=> String, one of "HOST_ONLY", "SUBDOMAINS", "EVERYTHING"
|
1761
|
+
# resp.configuration.web_crawler_configuration.urls.site_maps_configuration.site_maps #=> Array
|
1762
|
+
# resp.configuration.web_crawler_configuration.urls.site_maps_configuration.site_maps[0] #=> String
|
1763
|
+
# resp.configuration.web_crawler_configuration.crawl_depth #=> Integer
|
1764
|
+
# resp.configuration.web_crawler_configuration.max_links_per_page #=> Integer
|
1765
|
+
# resp.configuration.web_crawler_configuration.max_content_size_per_page_in_mega_bytes #=> Float
|
1766
|
+
# resp.configuration.web_crawler_configuration.max_urls_per_minute_crawl_rate #=> Integer
|
1767
|
+
# resp.configuration.web_crawler_configuration.url_inclusion_patterns #=> Array
|
1768
|
+
# resp.configuration.web_crawler_configuration.url_inclusion_patterns[0] #=> String
|
1769
|
+
# resp.configuration.web_crawler_configuration.url_exclusion_patterns #=> Array
|
1770
|
+
# resp.configuration.web_crawler_configuration.url_exclusion_patterns[0] #=> String
|
1771
|
+
# resp.configuration.web_crawler_configuration.proxy_configuration.host #=> String
|
1772
|
+
# resp.configuration.web_crawler_configuration.proxy_configuration.port #=> Integer
|
1773
|
+
# resp.configuration.web_crawler_configuration.proxy_configuration.credentials #=> String
|
1774
|
+
# resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication #=> Array
|
1775
|
+
# resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].host #=> String
|
1776
|
+
# resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].port #=> Integer
|
1777
|
+
# resp.configuration.web_crawler_configuration.authentication_configuration.basic_authentication[0].credentials #=> String
|
1470
1778
|
# resp.created_at #=> Time
|
1471
1779
|
# resp.updated_at #=> Time
|
1472
1780
|
# resp.description #=> String
|
@@ -1617,6 +1925,112 @@ module Aws::Kendra
|
|
1617
1925
|
req.send_request(options)
|
1618
1926
|
end
|
1619
1927
|
|
1928
|
+
# Describes a block list used for query suggestions for an index.
|
1929
|
+
#
|
1930
|
+
# This is used to check the current settings that are applied to a block
|
1931
|
+
# list.
|
1932
|
+
#
|
1933
|
+
# @option params [required, String] :index_id
|
1934
|
+
# The identifier of the index for the block list.
|
1935
|
+
#
|
1936
|
+
# @option params [required, String] :id
|
1937
|
+
# The unique identifier of the block list.
|
1938
|
+
#
|
1939
|
+
# @return [Types::DescribeQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1940
|
+
#
|
1941
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#index_id #index_id} => String
|
1942
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#id #id} => String
|
1943
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#name #name} => String
|
1944
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#description #description} => String
|
1945
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#status #status} => String
|
1946
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#error_message #error_message} => String
|
1947
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#created_at #created_at} => Time
|
1948
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#updated_at #updated_at} => Time
|
1949
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#source_s3_path #source_s3_path} => Types::S3Path
|
1950
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#item_count #item_count} => Integer
|
1951
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#file_size_bytes #file_size_bytes} => Integer
|
1952
|
+
# * {Types::DescribeQuerySuggestionsBlockListResponse#role_arn #role_arn} => String
|
1953
|
+
#
|
1954
|
+
# @example Request syntax with placeholder values
|
1955
|
+
#
|
1956
|
+
# resp = client.describe_query_suggestions_block_list({
|
1957
|
+
# index_id: "IndexId", # required
|
1958
|
+
# id: "QuerySuggestionsBlockListId", # required
|
1959
|
+
# })
|
1960
|
+
#
|
1961
|
+
# @example Response structure
|
1962
|
+
#
|
1963
|
+
# resp.index_id #=> String
|
1964
|
+
# resp.id #=> String
|
1965
|
+
# resp.name #=> String
|
1966
|
+
# resp.description #=> String
|
1967
|
+
# resp.status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
|
1968
|
+
# resp.error_message #=> String
|
1969
|
+
# resp.created_at #=> Time
|
1970
|
+
# resp.updated_at #=> Time
|
1971
|
+
# resp.source_s3_path.bucket #=> String
|
1972
|
+
# resp.source_s3_path.key #=> String
|
1973
|
+
# resp.item_count #=> Integer
|
1974
|
+
# resp.file_size_bytes #=> Integer
|
1975
|
+
# resp.role_arn #=> String
|
1976
|
+
#
|
1977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockList AWS API Documentation
|
1978
|
+
#
|
1979
|
+
# @overload describe_query_suggestions_block_list(params = {})
|
1980
|
+
# @param [Hash] params ({})
|
1981
|
+
def describe_query_suggestions_block_list(params = {}, options = {})
|
1982
|
+
req = build_request(:describe_query_suggestions_block_list, params)
|
1983
|
+
req.send_request(options)
|
1984
|
+
end
|
1985
|
+
|
1986
|
+
# Describes the settings of query suggestions for an index.
|
1987
|
+
#
|
1988
|
+
# This is used to check the current settings applied to query
|
1989
|
+
# suggestions.
|
1990
|
+
#
|
1991
|
+
# @option params [required, String] :index_id
|
1992
|
+
# The identifier of the index you want to describe query suggestions
|
1993
|
+
# settings for.
|
1994
|
+
#
|
1995
|
+
# @return [Types::DescribeQuerySuggestionsConfigResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1996
|
+
#
|
1997
|
+
# * {Types::DescribeQuerySuggestionsConfigResponse#mode #mode} => String
|
1998
|
+
# * {Types::DescribeQuerySuggestionsConfigResponse#status #status} => String
|
1999
|
+
# * {Types::DescribeQuerySuggestionsConfigResponse#query_log_look_back_window_in_days #query_log_look_back_window_in_days} => Integer
|
2000
|
+
# * {Types::DescribeQuerySuggestionsConfigResponse#include_queries_without_user_information #include_queries_without_user_information} => Boolean
|
2001
|
+
# * {Types::DescribeQuerySuggestionsConfigResponse#minimum_number_of_querying_users #minimum_number_of_querying_users} => Integer
|
2002
|
+
# * {Types::DescribeQuerySuggestionsConfigResponse#minimum_query_count #minimum_query_count} => Integer
|
2003
|
+
# * {Types::DescribeQuerySuggestionsConfigResponse#last_suggestions_build_time #last_suggestions_build_time} => Time
|
2004
|
+
# * {Types::DescribeQuerySuggestionsConfigResponse#last_clear_time #last_clear_time} => Time
|
2005
|
+
# * {Types::DescribeQuerySuggestionsConfigResponse#total_suggestions_count #total_suggestions_count} => Integer
|
2006
|
+
#
|
2007
|
+
# @example Request syntax with placeholder values
|
2008
|
+
#
|
2009
|
+
# resp = client.describe_query_suggestions_config({
|
2010
|
+
# index_id: "IndexId", # required
|
2011
|
+
# })
|
2012
|
+
#
|
2013
|
+
# @example Response structure
|
2014
|
+
#
|
2015
|
+
# resp.mode #=> String, one of "ENABLED", "LEARN_ONLY"
|
2016
|
+
# resp.status #=> String, one of "ACTIVE", "UPDATING"
|
2017
|
+
# resp.query_log_look_back_window_in_days #=> Integer
|
2018
|
+
# resp.include_queries_without_user_information #=> Boolean
|
2019
|
+
# resp.minimum_number_of_querying_users #=> Integer
|
2020
|
+
# resp.minimum_query_count #=> Integer
|
2021
|
+
# resp.last_suggestions_build_time #=> Time
|
2022
|
+
# resp.last_clear_time #=> Time
|
2023
|
+
# resp.total_suggestions_count #=> Integer
|
2024
|
+
#
|
2025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig AWS API Documentation
|
2026
|
+
#
|
2027
|
+
# @overload describe_query_suggestions_config(params = {})
|
2028
|
+
# @param [Hash] params ({})
|
2029
|
+
def describe_query_suggestions_config(params = {}, options = {})
|
2030
|
+
req = build_request(:describe_query_suggestions_config, params)
|
2031
|
+
req.send_request(options)
|
2032
|
+
end
|
2033
|
+
|
1620
2034
|
# Describes an existing Amazon Kendra thesaurus.
|
1621
2035
|
#
|
1622
2036
|
# @option params [required, String] :id
|
@@ -1674,6 +2088,58 @@ module Aws::Kendra
|
|
1674
2088
|
req.send_request(options)
|
1675
2089
|
end
|
1676
2090
|
|
2091
|
+
# Fetches the queries that are suggested to your users.
|
2092
|
+
#
|
2093
|
+
# @option params [required, String] :index_id
|
2094
|
+
# The identifier of the index you want to get query suggestions from.
|
2095
|
+
#
|
2096
|
+
# @option params [required, String] :query_text
|
2097
|
+
# The text of a user's query to generate query suggestions.
|
2098
|
+
#
|
2099
|
+
# A query is suggested if the query prefix matches what a user starts to
|
2100
|
+
# type as their query.
|
2101
|
+
#
|
2102
|
+
# Amazon Kendra does not show any suggestions if a user types fewer than
|
2103
|
+
# two characters or more than 60 characters. A query must also have at
|
2104
|
+
# least one search result and contain at least one word of more than
|
2105
|
+
# four characters.
|
2106
|
+
#
|
2107
|
+
# @option params [Integer] :max_suggestions_count
|
2108
|
+
# The maximum number of query suggestions you want to show to your
|
2109
|
+
# users.
|
2110
|
+
#
|
2111
|
+
# @return [Types::GetQuerySuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2112
|
+
#
|
2113
|
+
# * {Types::GetQuerySuggestionsResponse#query_suggestions_id #query_suggestions_id} => String
|
2114
|
+
# * {Types::GetQuerySuggestionsResponse#suggestions #suggestions} => Array<Types::Suggestion>
|
2115
|
+
#
|
2116
|
+
# @example Request syntax with placeholder values
|
2117
|
+
#
|
2118
|
+
# resp = client.get_query_suggestions({
|
2119
|
+
# index_id: "IndexId", # required
|
2120
|
+
# query_text: "SuggestionQueryText", # required
|
2121
|
+
# max_suggestions_count: 1,
|
2122
|
+
# })
|
2123
|
+
#
|
2124
|
+
# @example Response structure
|
2125
|
+
#
|
2126
|
+
# resp.query_suggestions_id #=> String
|
2127
|
+
# resp.suggestions #=> Array
|
2128
|
+
# resp.suggestions[0].id #=> String
|
2129
|
+
# resp.suggestions[0].value.text.text #=> String
|
2130
|
+
# resp.suggestions[0].value.text.highlights #=> Array
|
2131
|
+
# resp.suggestions[0].value.text.highlights[0].begin_offset #=> Integer
|
2132
|
+
# resp.suggestions[0].value.text.highlights[0].end_offset #=> Integer
|
2133
|
+
#
|
2134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions AWS API Documentation
|
2135
|
+
#
|
2136
|
+
# @overload get_query_suggestions(params = {})
|
2137
|
+
# @param [Hash] params ({})
|
2138
|
+
def get_query_suggestions(params = {}, options = {})
|
2139
|
+
req = build_request(:get_query_suggestions, params)
|
2140
|
+
req.send_request(options)
|
2141
|
+
end
|
2142
|
+
|
1677
2143
|
# Gets statistics about synchronizing Amazon Kendra with a data source.
|
1678
2144
|
#
|
1679
2145
|
# @option params [required, String] :id
|
@@ -1780,7 +2246,7 @@ module Aws::Kendra
|
|
1780
2246
|
# resp.summary_items #=> Array
|
1781
2247
|
# resp.summary_items[0].name #=> String
|
1782
2248
|
# resp.summary_items[0].id #=> String
|
1783
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
|
2249
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER"
|
1784
2250
|
# resp.summary_items[0].created_at #=> Time
|
1785
2251
|
# resp.summary_items[0].updated_at #=> Time
|
1786
2252
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -1887,6 +2353,68 @@ module Aws::Kendra
|
|
1887
2353
|
req.send_request(options)
|
1888
2354
|
end
|
1889
2355
|
|
2356
|
+
# Lists the block lists used for query suggestions for an index.
|
2357
|
+
#
|
2358
|
+
# For information on the current quota limits for block lists, see
|
2359
|
+
# [Quotas for Amazon Kendra][1].
|
2360
|
+
#
|
2361
|
+
#
|
2362
|
+
#
|
2363
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
2364
|
+
#
|
2365
|
+
# @option params [required, String] :index_id
|
2366
|
+
# The identifier of the index for a list of all block lists that exist
|
2367
|
+
# for that index.
|
2368
|
+
#
|
2369
|
+
# For information on the current quota limits for block lists, see
|
2370
|
+
# [Quotas for Amazon Kendra][1].
|
2371
|
+
#
|
2372
|
+
#
|
2373
|
+
#
|
2374
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
2375
|
+
#
|
2376
|
+
# @option params [String] :next_token
|
2377
|
+
# If the previous response was incomplete (because there is more data to
|
2378
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
2379
|
+
# You can use this pagination token to retrieve the next set of block
|
2380
|
+
# lists (`BlockListSummaryItems`).
|
2381
|
+
#
|
2382
|
+
# @option params [Integer] :max_results
|
2383
|
+
# The maximum number of block lists to return.
|
2384
|
+
#
|
2385
|
+
# @return [Types::ListQuerySuggestionsBlockListsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2386
|
+
#
|
2387
|
+
# * {Types::ListQuerySuggestionsBlockListsResponse#block_list_summary_items #block_list_summary_items} => Array<Types::QuerySuggestionsBlockListSummary>
|
2388
|
+
# * {Types::ListQuerySuggestionsBlockListsResponse#next_token #next_token} => String
|
2389
|
+
#
|
2390
|
+
# @example Request syntax with placeholder values
|
2391
|
+
#
|
2392
|
+
# resp = client.list_query_suggestions_block_lists({
|
2393
|
+
# index_id: "IndexId", # required
|
2394
|
+
# next_token: "NextToken",
|
2395
|
+
# max_results: 1,
|
2396
|
+
# })
|
2397
|
+
#
|
2398
|
+
# @example Response structure
|
2399
|
+
#
|
2400
|
+
# resp.block_list_summary_items #=> Array
|
2401
|
+
# resp.block_list_summary_items[0].id #=> String
|
2402
|
+
# resp.block_list_summary_items[0].name #=> String
|
2403
|
+
# resp.block_list_summary_items[0].status #=> String, one of "ACTIVE", "CREATING", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
|
2404
|
+
# resp.block_list_summary_items[0].created_at #=> Time
|
2405
|
+
# resp.block_list_summary_items[0].updated_at #=> Time
|
2406
|
+
# resp.block_list_summary_items[0].item_count #=> Integer
|
2407
|
+
# resp.next_token #=> String
|
2408
|
+
#
|
2409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockLists AWS API Documentation
|
2410
|
+
#
|
2411
|
+
# @overload list_query_suggestions_block_lists(params = {})
|
2412
|
+
# @param [Hash] params ({})
|
2413
|
+
def list_query_suggestions_block_lists(params = {}, options = {})
|
2414
|
+
req = build_request(:list_query_suggestions_block_lists, params)
|
2415
|
+
req.send_request(options)
|
2416
|
+
end
|
2417
|
+
|
1890
2418
|
# Gets a list of tags associated with a specified resource. Indexes,
|
1891
2419
|
# FAQs, and data sources can have tags associated with them.
|
1892
2420
|
#
|
@@ -2468,7 +2996,7 @@ module Aws::Kendra
|
|
2468
2996
|
# },
|
2469
2997
|
# },
|
2470
2998
|
# share_point_configuration: {
|
2471
|
-
# share_point_version: "
|
2999
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
2472
3000
|
# urls: ["Url"], # required
|
2473
3001
|
# secret_arn: "SecretArn", # required
|
2474
3002
|
# crawl_attachments: false,
|
@@ -2488,6 +3016,10 @@ module Aws::Kendra
|
|
2488
3016
|
# ],
|
2489
3017
|
# document_title_field_name: "DataSourceFieldName",
|
2490
3018
|
# disable_local_groups: false,
|
3019
|
+
# ssl_certificate_s3_path: {
|
3020
|
+
# bucket: "S3BucketName", # required
|
3021
|
+
# key: "S3ObjectKey", # required
|
3022
|
+
# },
|
2491
3023
|
# },
|
2492
3024
|
# database_configuration: {
|
2493
3025
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -2716,6 +3248,37 @@ module Aws::Kendra
|
|
2716
3248
|
# exclude_user_accounts: ["UserAccount"],
|
2717
3249
|
# exclude_shared_drives: ["SharedDriveId"],
|
2718
3250
|
# },
|
3251
|
+
# web_crawler_configuration: {
|
3252
|
+
# urls: { # required
|
3253
|
+
# seed_url_configuration: {
|
3254
|
+
# seed_urls: ["SeedUrl"], # required
|
3255
|
+
# web_crawler_mode: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS, EVERYTHING
|
3256
|
+
# },
|
3257
|
+
# site_maps_configuration: {
|
3258
|
+
# site_maps: ["SiteMap"], # required
|
3259
|
+
# },
|
3260
|
+
# },
|
3261
|
+
# crawl_depth: 1,
|
3262
|
+
# max_links_per_page: 1,
|
3263
|
+
# max_content_size_per_page_in_mega_bytes: 1.0,
|
3264
|
+
# max_urls_per_minute_crawl_rate: 1,
|
3265
|
+
# url_inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3266
|
+
# url_exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3267
|
+
# proxy_configuration: {
|
3268
|
+
# host: "Host", # required
|
3269
|
+
# port: 1, # required
|
3270
|
+
# credentials: "SecretArn",
|
3271
|
+
# },
|
3272
|
+
# authentication_configuration: {
|
3273
|
+
# basic_authentication: [
|
3274
|
+
# {
|
3275
|
+
# host: "Host", # required
|
3276
|
+
# port: 1, # required
|
3277
|
+
# credentials: "SecretArn", # required
|
3278
|
+
# },
|
3279
|
+
# ],
|
3280
|
+
# },
|
3281
|
+
# },
|
2719
3282
|
# },
|
2720
3283
|
# description: "Description",
|
2721
3284
|
# schedule: "ScanSchedule",
|
@@ -2826,6 +3389,167 @@ module Aws::Kendra
|
|
2826
3389
|
req.send_request(options)
|
2827
3390
|
end
|
2828
3391
|
|
3392
|
+
# Updates a block list used for query suggestions for an index.
|
3393
|
+
#
|
3394
|
+
# Updates to a block list might not take effect right away. Amazon
|
3395
|
+
# Kendra needs to refresh the entire suggestions list to apply any
|
3396
|
+
# updates to the block list. Other changes not related to the block list
|
3397
|
+
# apply immediately.
|
3398
|
+
#
|
3399
|
+
# If a block list is updating, then you need to wait for the first
|
3400
|
+
# update to finish before submitting another update.
|
3401
|
+
#
|
3402
|
+
# Amazon Kendra supports partial updates, so you only need to provide
|
3403
|
+
# the fields you want to update.
|
3404
|
+
#
|
3405
|
+
# @option params [required, String] :index_id
|
3406
|
+
# The identifier of the index for a block list.
|
3407
|
+
#
|
3408
|
+
# @option params [required, String] :id
|
3409
|
+
# The unique identifier of a block list.
|
3410
|
+
#
|
3411
|
+
# @option params [String] :name
|
3412
|
+
# The name of a block list.
|
3413
|
+
#
|
3414
|
+
# @option params [String] :description
|
3415
|
+
# The description for a block list.
|
3416
|
+
#
|
3417
|
+
# @option params [Types::S3Path] :source_s3_path
|
3418
|
+
# The S3 path where your block list text file sits in S3.
|
3419
|
+
#
|
3420
|
+
# If you update your block list and provide the same path to the block
|
3421
|
+
# list text file in S3, then Amazon Kendra reloads the file to refresh
|
3422
|
+
# the block list. Amazon Kendra does not automatically refresh your
|
3423
|
+
# block list. You need to call the `UpdateQuerySuggestionsBlockList` API
|
3424
|
+
# to refresh you block list.
|
3425
|
+
#
|
3426
|
+
# If you update your block list, then Amazon Kendra asynchronously
|
3427
|
+
# refreshes all query suggestions with the latest content in the S3
|
3428
|
+
# file. This means changes might not take effect immediately.
|
3429
|
+
#
|
3430
|
+
# @option params [String] :role_arn
|
3431
|
+
# The IAM (Identity and Access Management) role used to access the block
|
3432
|
+
# list text file in S3.
|
3433
|
+
#
|
3434
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3435
|
+
#
|
3436
|
+
# @example Request syntax with placeholder values
|
3437
|
+
#
|
3438
|
+
# resp = client.update_query_suggestions_block_list({
|
3439
|
+
# index_id: "IndexId", # required
|
3440
|
+
# id: "QuerySuggestionsBlockListId", # required
|
3441
|
+
# name: "QuerySuggestionsBlockListName",
|
3442
|
+
# description: "Description",
|
3443
|
+
# source_s3_path: {
|
3444
|
+
# bucket: "S3BucketName", # required
|
3445
|
+
# key: "S3ObjectKey", # required
|
3446
|
+
# },
|
3447
|
+
# role_arn: "RoleArn",
|
3448
|
+
# })
|
3449
|
+
#
|
3450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockList AWS API Documentation
|
3451
|
+
#
|
3452
|
+
# @overload update_query_suggestions_block_list(params = {})
|
3453
|
+
# @param [Hash] params ({})
|
3454
|
+
def update_query_suggestions_block_list(params = {}, options = {})
|
3455
|
+
req = build_request(:update_query_suggestions_block_list, params)
|
3456
|
+
req.send_request(options)
|
3457
|
+
end
|
3458
|
+
|
3459
|
+
# Updates the settings of query suggestions for an index.
|
3460
|
+
#
|
3461
|
+
# Amazon Kendra supports partial updates, so you only need to provide
|
3462
|
+
# the fields you want to update.
|
3463
|
+
#
|
3464
|
+
# If an update is currently processing (i.e. 'happening'), you need to
|
3465
|
+
# wait for the update to finish before making another update.
|
3466
|
+
#
|
3467
|
+
# Updates to query suggestions settings might not take effect right
|
3468
|
+
# away. The time for your updated settings to take effect depends on the
|
3469
|
+
# updates made and the number of search queries in your index.
|
3470
|
+
#
|
3471
|
+
# You can still enable/disable query suggestions at any time.
|
3472
|
+
#
|
3473
|
+
# @option params [required, String] :index_id
|
3474
|
+
# The identifier of the index you want to update query suggestions
|
3475
|
+
# settings for.
|
3476
|
+
#
|
3477
|
+
# @option params [String] :mode
|
3478
|
+
# Set the mode to `ENABLED` or `LEARN_ONLY`.
|
3479
|
+
#
|
3480
|
+
# By default, Amazon Kendra enables query suggestions. `LEARN_ONLY` mode
|
3481
|
+
# allows you to turn off query suggestions. You can to update this at
|
3482
|
+
# any time.
|
3483
|
+
#
|
3484
|
+
# In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
|
3485
|
+
# queries to keep suggestions up to date for when you are ready to
|
3486
|
+
# switch to ENABLED mode again.
|
3487
|
+
#
|
3488
|
+
# @option params [Integer] :query_log_look_back_window_in_days
|
3489
|
+
# How recent your queries are in your query log time window.
|
3490
|
+
#
|
3491
|
+
# The time window is the number of days from current day to past days.
|
3492
|
+
#
|
3493
|
+
# By default, Amazon Kendra sets this to 180.
|
3494
|
+
#
|
3495
|
+
# @option params [Boolean] :include_queries_without_user_information
|
3496
|
+
# `TRUE` to include queries without user information (i.e. all queries,
|
3497
|
+
# irrespective of the user), otherwise `FALSE` to only include queries
|
3498
|
+
# with user information.
|
3499
|
+
#
|
3500
|
+
# If you pass user information to Amazon Kendra along with the queries,
|
3501
|
+
# you can set this flag to `FALSE` and instruct Amazon Kendra to only
|
3502
|
+
# consider queries with user information.
|
3503
|
+
#
|
3504
|
+
# If you set to `FALSE`, Amazon Kendra only considers queries searched
|
3505
|
+
# at least `MinimumQueryCount` times across
|
3506
|
+
# `MinimumNumberOfQueryingUsers` unique users for suggestions.
|
3507
|
+
#
|
3508
|
+
# If you set to `TRUE`, Amazon Kendra ignores all user information and
|
3509
|
+
# learns from all queries.
|
3510
|
+
#
|
3511
|
+
# @option params [Integer] :minimum_number_of_querying_users
|
3512
|
+
# The minimum number of unique users who must search a query in order
|
3513
|
+
# for the query to be eligible to suggest to your users.
|
3514
|
+
#
|
3515
|
+
# Increasing this number might decrease the number of suggestions.
|
3516
|
+
# However, this ensures a query is searched by many users and is truly
|
3517
|
+
# popular to suggest to users.
|
3518
|
+
#
|
3519
|
+
# How you tune this setting depends on your specific needs.
|
3520
|
+
#
|
3521
|
+
# @option params [Integer] :minimum_query_count
|
3522
|
+
# The the minimum number of times a query must be searched in order to
|
3523
|
+
# be eligible to suggest to your users.
|
3524
|
+
#
|
3525
|
+
# Decreasing this number increases the number of suggestions. However,
|
3526
|
+
# this affects the quality of suggestions as it sets a low bar for a
|
3527
|
+
# query to be considered popular to suggest to users.
|
3528
|
+
#
|
3529
|
+
# How you tune this setting depends on your specific needs.
|
3530
|
+
#
|
3531
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3532
|
+
#
|
3533
|
+
# @example Request syntax with placeholder values
|
3534
|
+
#
|
3535
|
+
# resp = client.update_query_suggestions_config({
|
3536
|
+
# index_id: "IndexId", # required
|
3537
|
+
# mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
|
3538
|
+
# query_log_look_back_window_in_days: 1,
|
3539
|
+
# include_queries_without_user_information: false,
|
3540
|
+
# minimum_number_of_querying_users: 1,
|
3541
|
+
# minimum_query_count: 1,
|
3542
|
+
# })
|
3543
|
+
#
|
3544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig AWS API Documentation
|
3545
|
+
#
|
3546
|
+
# @overload update_query_suggestions_config(params = {})
|
3547
|
+
# @param [Hash] params ({})
|
3548
|
+
def update_query_suggestions_config(params = {}, options = {})
|
3549
|
+
req = build_request(:update_query_suggestions_config, params)
|
3550
|
+
req.send_request(options)
|
3551
|
+
end
|
3552
|
+
|
2829
3553
|
# Updates a thesaurus file associated with an index.
|
2830
3554
|
#
|
2831
3555
|
# @option params [required, String] :id
|
@@ -2884,7 +3608,7 @@ module Aws::Kendra
|
|
2884
3608
|
params: params,
|
2885
3609
|
config: config)
|
2886
3610
|
context[:gem_name] = 'aws-sdk-kendra'
|
2887
|
-
context[:gem_version] = '1.
|
3611
|
+
context[:gem_version] = '1.29.0'
|
2888
3612
|
Seahorse::Client::Request.new(handlers, context)
|
2889
3613
|
end
|
2890
3614
|
|