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 +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra.rb +1 -1
- data/lib/aws-sdk-kendra/client.rb +548 -2
- data/lib/aws-sdk-kendra/client_api.rb +273 -1
- data/lib/aws-sdk-kendra/types.rb +816 -9
- metadata +3 -4
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -500,7 +500,7 @@ module Aws::Kendra
|
|
500
500
|
# document_id_list: ["DocumentId"], # required
|
501
501
|
# data_source_sync_job_metric_target: {
|
502
502
|
# data_source_id: "DataSourceId", # required
|
503
|
-
# data_source_sync_job_id: "DataSourceSyncJobId",
|
503
|
+
# data_source_sync_job_id: "DataSourceSyncJobId",
|
504
504
|
# },
|
505
505
|
# }
|
506
506
|
#
|
@@ -624,6 +624,13 @@ module Aws::Kendra
|
|
624
624
|
# @!attribute [rw] documents
|
625
625
|
# One or more documents to add to the index.
|
626
626
|
#
|
627
|
+
# Documents can include custom attributes. For example,
|
628
|
+
# 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes
|
629
|
+
# that provide information on the synchronization of documents running
|
630
|
+
# on a data source. Note, 'DataSourceSyncJobId' could be an optional
|
631
|
+
# custom attribute as Amazon Kendra will use the ID of a running sync
|
632
|
+
# job.
|
633
|
+
#
|
627
634
|
# Documents have the following file size limits.
|
628
635
|
#
|
629
636
|
# * 5 MB total size for inline documents
|
@@ -728,6 +735,26 @@ module Aws::Kendra
|
|
728
735
|
include Aws::Structure
|
729
736
|
end
|
730
737
|
|
738
|
+
# @note When making an API call, you may pass ClearQuerySuggestionsRequest
|
739
|
+
# data as a hash:
|
740
|
+
#
|
741
|
+
# {
|
742
|
+
# index_id: "IndexId", # required
|
743
|
+
# }
|
744
|
+
#
|
745
|
+
# @!attribute [rw] index_id
|
746
|
+
# The identifier of the index you want to clear query suggestions
|
747
|
+
# from.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestionsRequest AWS API Documentation
|
751
|
+
#
|
752
|
+
class ClearQuerySuggestionsRequest < Struct.new(
|
753
|
+
:index_id)
|
754
|
+
SENSITIVE = []
|
755
|
+
include Aws::Structure
|
756
|
+
end
|
757
|
+
|
731
758
|
# Gathers information about when a particular result was clicked by a
|
732
759
|
# user. Your application uses the `SubmitFeedback` operation to provide
|
733
760
|
# click information.
|
@@ -1991,6 +2018,110 @@ module Aws::Kendra
|
|
1991
2018
|
include Aws::Structure
|
1992
2019
|
end
|
1993
2020
|
|
2021
|
+
# @note When making an API call, you may pass CreateQuerySuggestionsBlockListRequest
|
2022
|
+
# data as a hash:
|
2023
|
+
#
|
2024
|
+
# {
|
2025
|
+
# index_id: "IndexId", # required
|
2026
|
+
# name: "QuerySuggestionsBlockListName", # required
|
2027
|
+
# description: "Description",
|
2028
|
+
# source_s3_path: { # required
|
2029
|
+
# bucket: "S3BucketName", # required
|
2030
|
+
# key: "S3ObjectKey", # required
|
2031
|
+
# },
|
2032
|
+
# client_token: "ClientTokenName",
|
2033
|
+
# role_arn: "RoleArn", # required
|
2034
|
+
# tags: [
|
2035
|
+
# {
|
2036
|
+
# key: "TagKey", # required
|
2037
|
+
# value: "TagValue", # required
|
2038
|
+
# },
|
2039
|
+
# ],
|
2040
|
+
# }
|
2041
|
+
#
|
2042
|
+
# @!attribute [rw] index_id
|
2043
|
+
# The identifier of the index you want to create a query suggestions
|
2044
|
+
# block list for.
|
2045
|
+
# @return [String]
|
2046
|
+
#
|
2047
|
+
# @!attribute [rw] name
|
2048
|
+
# A user friendly name for the block list.
|
2049
|
+
#
|
2050
|
+
# For example, the block list named 'offensive-words' includes all
|
2051
|
+
# offensive words that could appear in user queries and need to be
|
2052
|
+
# blocked from suggestions.
|
2053
|
+
# @return [String]
|
2054
|
+
#
|
2055
|
+
# @!attribute [rw] description
|
2056
|
+
# A user-friendly description for the block list.
|
2057
|
+
#
|
2058
|
+
# For example, the description "List of all offensive words that can
|
2059
|
+
# appear in user queries and need to be blocked from suggestions."
|
2060
|
+
# @return [String]
|
2061
|
+
#
|
2062
|
+
# @!attribute [rw] source_s3_path
|
2063
|
+
# The S3 path to your block list text file in your S3 bucket.
|
2064
|
+
#
|
2065
|
+
# Each block word or phrase should be on a separate line in a text
|
2066
|
+
# file.
|
2067
|
+
#
|
2068
|
+
# For information on the current quota limits for block lists, see
|
2069
|
+
# [Quotas for Amazon Kendra][1].
|
2070
|
+
#
|
2071
|
+
#
|
2072
|
+
#
|
2073
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
2074
|
+
# @return [Types::S3Path]
|
2075
|
+
#
|
2076
|
+
# @!attribute [rw] client_token
|
2077
|
+
# A token that you provide to identify the request to create a query
|
2078
|
+
# suggestions block list.
|
2079
|
+
#
|
2080
|
+
# **A suitable default value is auto-generated.** You should normally
|
2081
|
+
# not need to pass this option.
|
2082
|
+
# @return [String]
|
2083
|
+
#
|
2084
|
+
# @!attribute [rw] role_arn
|
2085
|
+
# The IAM (Identity and Access Management) role used by Amazon Kendra
|
2086
|
+
# to access the block list text file in your S3 bucket.
|
2087
|
+
#
|
2088
|
+
# You need permissions to the role ARN (Amazon Resource Name). The
|
2089
|
+
# role needs S3 read permissions to your file in S3 and needs to give
|
2090
|
+
# STS (Security Token Service) assume role permissions to Amazon
|
2091
|
+
# Kendra.
|
2092
|
+
# @return [String]
|
2093
|
+
#
|
2094
|
+
# @!attribute [rw] tags
|
2095
|
+
# A tag that you can assign to a block list that categorizes the block
|
2096
|
+
# list.
|
2097
|
+
# @return [Array<Types::Tag>]
|
2098
|
+
#
|
2099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListRequest AWS API Documentation
|
2100
|
+
#
|
2101
|
+
class CreateQuerySuggestionsBlockListRequest < Struct.new(
|
2102
|
+
:index_id,
|
2103
|
+
:name,
|
2104
|
+
:description,
|
2105
|
+
:source_s3_path,
|
2106
|
+
:client_token,
|
2107
|
+
:role_arn,
|
2108
|
+
:tags)
|
2109
|
+
SENSITIVE = []
|
2110
|
+
include Aws::Structure
|
2111
|
+
end
|
2112
|
+
|
2113
|
+
# @!attribute [rw] id
|
2114
|
+
# The unique identifier of the created block list.
|
2115
|
+
# @return [String]
|
2116
|
+
#
|
2117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListResponse AWS API Documentation
|
2118
|
+
#
|
2119
|
+
class CreateQuerySuggestionsBlockListResponse < Struct.new(
|
2120
|
+
:id)
|
2121
|
+
SENSITIVE = []
|
2122
|
+
include Aws::Structure
|
2123
|
+
end
|
2124
|
+
|
1994
2125
|
# @note When making an API call, you may pass CreateThesaurusRequest
|
1995
2126
|
# data as a hash:
|
1996
2127
|
#
|
@@ -2506,7 +2637,7 @@ module Aws::Kendra
|
|
2506
2637
|
#
|
2507
2638
|
# {
|
2508
2639
|
# data_source_id: "DataSourceId", # required
|
2509
|
-
# data_source_sync_job_id: "DataSourceSyncJobId",
|
2640
|
+
# data_source_sync_job_id: "DataSourceSyncJobId",
|
2510
2641
|
# }
|
2511
2642
|
#
|
2512
2643
|
# @!attribute [rw] data_source_id
|
@@ -2515,6 +2646,15 @@ module Aws::Kendra
|
|
2515
2646
|
#
|
2516
2647
|
# @!attribute [rw] data_source_sync_job_id
|
2517
2648
|
# The ID of the sync job that is running on the data source.
|
2649
|
+
#
|
2650
|
+
# If the ID of a sync job is not provided and there is a sync job
|
2651
|
+
# running, then the ID of this sync job is used and metrics are
|
2652
|
+
# generated for this sync job.
|
2653
|
+
#
|
2654
|
+
# If the ID of a sync job is not provided and there is no sync job
|
2655
|
+
# running, then no metrics are generated and documents are
|
2656
|
+
# indexed/deleted at the index level without sync job metrics
|
2657
|
+
# included.
|
2518
2658
|
# @return [String]
|
2519
2659
|
#
|
2520
2660
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetricTarget AWS API Documentation
|
@@ -2781,6 +2921,31 @@ module Aws::Kendra
|
|
2781
2921
|
include Aws::Structure
|
2782
2922
|
end
|
2783
2923
|
|
2924
|
+
# @note When making an API call, you may pass DeleteQuerySuggestionsBlockListRequest
|
2925
|
+
# data as a hash:
|
2926
|
+
#
|
2927
|
+
# {
|
2928
|
+
# index_id: "IndexId", # required
|
2929
|
+
# id: "QuerySuggestionsBlockListId", # required
|
2930
|
+
# }
|
2931
|
+
#
|
2932
|
+
# @!attribute [rw] index_id
|
2933
|
+
# The identifier of the you want to delete a block list from.
|
2934
|
+
# @return [String]
|
2935
|
+
#
|
2936
|
+
# @!attribute [rw] id
|
2937
|
+
# The unique identifier of the block list that needs to be deleted.
|
2938
|
+
# @return [String]
|
2939
|
+
#
|
2940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockListRequest AWS API Documentation
|
2941
|
+
#
|
2942
|
+
class DeleteQuerySuggestionsBlockListRequest < Struct.new(
|
2943
|
+
:index_id,
|
2944
|
+
:id)
|
2945
|
+
SENSITIVE = []
|
2946
|
+
include Aws::Structure
|
2947
|
+
end
|
2948
|
+
|
2784
2949
|
# @note When making an API call, you may pass DeleteThesaurusRequest
|
2785
2950
|
# data as a hash:
|
2786
2951
|
#
|
@@ -3109,6 +3274,218 @@ module Aws::Kendra
|
|
3109
3274
|
include Aws::Structure
|
3110
3275
|
end
|
3111
3276
|
|
3277
|
+
# @note When making an API call, you may pass DescribeQuerySuggestionsBlockListRequest
|
3278
|
+
# data as a hash:
|
3279
|
+
#
|
3280
|
+
# {
|
3281
|
+
# index_id: "IndexId", # required
|
3282
|
+
# id: "QuerySuggestionsBlockListId", # required
|
3283
|
+
# }
|
3284
|
+
#
|
3285
|
+
# @!attribute [rw] index_id
|
3286
|
+
# The identifier of the index for the block list.
|
3287
|
+
# @return [String]
|
3288
|
+
#
|
3289
|
+
# @!attribute [rw] id
|
3290
|
+
# The unique identifier of the block list.
|
3291
|
+
# @return [String]
|
3292
|
+
#
|
3293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListRequest AWS API Documentation
|
3294
|
+
#
|
3295
|
+
class DescribeQuerySuggestionsBlockListRequest < Struct.new(
|
3296
|
+
:index_id,
|
3297
|
+
:id)
|
3298
|
+
SENSITIVE = []
|
3299
|
+
include Aws::Structure
|
3300
|
+
end
|
3301
|
+
|
3302
|
+
# @!attribute [rw] index_id
|
3303
|
+
# Shows the identifier of the index for the block list.
|
3304
|
+
# @return [String]
|
3305
|
+
#
|
3306
|
+
# @!attribute [rw] id
|
3307
|
+
# Shows the unique identifier of the block list.
|
3308
|
+
# @return [String]
|
3309
|
+
#
|
3310
|
+
# @!attribute [rw] name
|
3311
|
+
# Shows the name of the block list.
|
3312
|
+
# @return [String]
|
3313
|
+
#
|
3314
|
+
# @!attribute [rw] description
|
3315
|
+
# Shows the description for the block list.
|
3316
|
+
# @return [String]
|
3317
|
+
#
|
3318
|
+
# @!attribute [rw] status
|
3319
|
+
# Shows whether the current status of the block list is `ACTIVE` or
|
3320
|
+
# `INACTIVE`.
|
3321
|
+
# @return [String]
|
3322
|
+
#
|
3323
|
+
# @!attribute [rw] error_message
|
3324
|
+
# Shows the error message with details when there are issues in
|
3325
|
+
# processing the block list.
|
3326
|
+
# @return [String]
|
3327
|
+
#
|
3328
|
+
# @!attribute [rw] created_at
|
3329
|
+
# Shows the date-time a block list for query suggestions was last
|
3330
|
+
# created.
|
3331
|
+
# @return [Time]
|
3332
|
+
#
|
3333
|
+
# @!attribute [rw] updated_at
|
3334
|
+
# Shows the date-time a block list for query suggestions was last
|
3335
|
+
# updated.
|
3336
|
+
# @return [Time]
|
3337
|
+
#
|
3338
|
+
# @!attribute [rw] source_s3_path
|
3339
|
+
# Shows the current S3 path to your block list text file in your S3
|
3340
|
+
# bucket.
|
3341
|
+
#
|
3342
|
+
# Each block word or phrase should be on a separate line in a text
|
3343
|
+
# file.
|
3344
|
+
#
|
3345
|
+
# For information on the current quota limits for block lists, see
|
3346
|
+
# [Quotas for Amazon Kendra][1].
|
3347
|
+
#
|
3348
|
+
#
|
3349
|
+
#
|
3350
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
3351
|
+
# @return [Types::S3Path]
|
3352
|
+
#
|
3353
|
+
# @!attribute [rw] item_count
|
3354
|
+
# Shows the current number of valid, non-empty words or phrases in the
|
3355
|
+
# block list text file.
|
3356
|
+
# @return [Integer]
|
3357
|
+
#
|
3358
|
+
# @!attribute [rw] file_size_bytes
|
3359
|
+
# Shows the current size of the block list text file in S3.
|
3360
|
+
# @return [Integer]
|
3361
|
+
#
|
3362
|
+
# @!attribute [rw] role_arn
|
3363
|
+
# Shows the current IAM (Identity and Access Management) role used by
|
3364
|
+
# Amazon Kendra to access the block list text file in S3.
|
3365
|
+
#
|
3366
|
+
# The role needs S3 read permissions to your file in S3 and needs to
|
3367
|
+
# give STS (Security Token Service) assume role permissions to Amazon
|
3368
|
+
# Kendra.
|
3369
|
+
# @return [String]
|
3370
|
+
#
|
3371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListResponse AWS API Documentation
|
3372
|
+
#
|
3373
|
+
class DescribeQuerySuggestionsBlockListResponse < Struct.new(
|
3374
|
+
:index_id,
|
3375
|
+
:id,
|
3376
|
+
:name,
|
3377
|
+
:description,
|
3378
|
+
:status,
|
3379
|
+
:error_message,
|
3380
|
+
:created_at,
|
3381
|
+
:updated_at,
|
3382
|
+
:source_s3_path,
|
3383
|
+
:item_count,
|
3384
|
+
:file_size_bytes,
|
3385
|
+
:role_arn)
|
3386
|
+
SENSITIVE = []
|
3387
|
+
include Aws::Structure
|
3388
|
+
end
|
3389
|
+
|
3390
|
+
# @note When making an API call, you may pass DescribeQuerySuggestionsConfigRequest
|
3391
|
+
# data as a hash:
|
3392
|
+
#
|
3393
|
+
# {
|
3394
|
+
# index_id: "IndexId", # required
|
3395
|
+
# }
|
3396
|
+
#
|
3397
|
+
# @!attribute [rw] index_id
|
3398
|
+
# The identifier of the index you want to describe query suggestions
|
3399
|
+
# settings for.
|
3400
|
+
# @return [String]
|
3401
|
+
#
|
3402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigRequest AWS API Documentation
|
3403
|
+
#
|
3404
|
+
class DescribeQuerySuggestionsConfigRequest < Struct.new(
|
3405
|
+
:index_id)
|
3406
|
+
SENSITIVE = []
|
3407
|
+
include Aws::Structure
|
3408
|
+
end
|
3409
|
+
|
3410
|
+
# @!attribute [rw] mode
|
3411
|
+
# Shows whether query suggestions are currently in `ENABLED` mode or
|
3412
|
+
# `LEARN_ONLY` mode.
|
3413
|
+
#
|
3414
|
+
# By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
|
3415
|
+
# turns off query suggestions for your users. You can change the mode
|
3416
|
+
# using the [UpdateQuerySuggestionsConfig][1] operation.
|
3417
|
+
#
|
3418
|
+
#
|
3419
|
+
#
|
3420
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
|
3421
|
+
# @return [String]
|
3422
|
+
#
|
3423
|
+
# @!attribute [rw] status
|
3424
|
+
# Shows whether the status of query suggestions settings is currently
|
3425
|
+
# Active or Updating.
|
3426
|
+
#
|
3427
|
+
# Active means the current settings apply and Updating means your
|
3428
|
+
# changed settings are in the process of applying.
|
3429
|
+
# @return [String]
|
3430
|
+
#
|
3431
|
+
# @!attribute [rw] query_log_look_back_window_in_days
|
3432
|
+
# Shows how recent your queries are in your query log time window (in
|
3433
|
+
# days).
|
3434
|
+
# @return [Integer]
|
3435
|
+
#
|
3436
|
+
# @!attribute [rw] include_queries_without_user_information
|
3437
|
+
# Shows whether Amazon Kendra uses all queries or only uses queries
|
3438
|
+
# that include user information to generate query suggestions.
|
3439
|
+
# @return [Boolean]
|
3440
|
+
#
|
3441
|
+
# @!attribute [rw] minimum_number_of_querying_users
|
3442
|
+
# Shows the minimum number of unique users who must search a query in
|
3443
|
+
# order for the query to be eligible to suggest to your users.
|
3444
|
+
# @return [Integer]
|
3445
|
+
#
|
3446
|
+
# @!attribute [rw] minimum_query_count
|
3447
|
+
# Shows the minimum number of times a query must be searched in order
|
3448
|
+
# for the query to be eligible to suggest to your users.
|
3449
|
+
# @return [Integer]
|
3450
|
+
#
|
3451
|
+
# @!attribute [rw] last_suggestions_build_time
|
3452
|
+
# Shows the date-time query suggestions for an index was last updated.
|
3453
|
+
# @return [Time]
|
3454
|
+
#
|
3455
|
+
# @!attribute [rw] last_clear_time
|
3456
|
+
# Shows the date-time query suggestions for an index was last cleared.
|
3457
|
+
#
|
3458
|
+
# After you clear suggestions, Amazon Kendra learns new suggestions
|
3459
|
+
# based on new queries added to the query log from the time you
|
3460
|
+
# cleared suggestions. Amazon Kendra only considers re-occurences of a
|
3461
|
+
# query from the time you cleared suggestions.
|
3462
|
+
# @return [Time]
|
3463
|
+
#
|
3464
|
+
# @!attribute [rw] total_suggestions_count
|
3465
|
+
# Shows the current total count of query suggestions for an index.
|
3466
|
+
#
|
3467
|
+
# This count can change when you update your query suggestions
|
3468
|
+
# settings, if you filter out certain queries from suggestions using a
|
3469
|
+
# block list, and as the query log accumulates more queries for Amazon
|
3470
|
+
# Kendra to learn from.
|
3471
|
+
# @return [Integer]
|
3472
|
+
#
|
3473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigResponse AWS API Documentation
|
3474
|
+
#
|
3475
|
+
class DescribeQuerySuggestionsConfigResponse < Struct.new(
|
3476
|
+
:mode,
|
3477
|
+
:status,
|
3478
|
+
:query_log_look_back_window_in_days,
|
3479
|
+
:include_queries_without_user_information,
|
3480
|
+
:minimum_number_of_querying_users,
|
3481
|
+
:minimum_query_count,
|
3482
|
+
:last_suggestions_build_time,
|
3483
|
+
:last_clear_time,
|
3484
|
+
:total_suggestions_count)
|
3485
|
+
SENSITIVE = []
|
3486
|
+
include Aws::Structure
|
3487
|
+
end
|
3488
|
+
|
3112
3489
|
# @note When making an API call, you may pass DescribeThesaurusRequest
|
3113
3490
|
# data as a hash:
|
3114
3491
|
#
|
@@ -3621,6 +3998,63 @@ module Aws::Kendra
|
|
3621
3998
|
include Aws::Structure
|
3622
3999
|
end
|
3623
4000
|
|
4001
|
+
# @note When making an API call, you may pass GetQuerySuggestionsRequest
|
4002
|
+
# data as a hash:
|
4003
|
+
#
|
4004
|
+
# {
|
4005
|
+
# index_id: "IndexId", # required
|
4006
|
+
# query_text: "SuggestionQueryText", # required
|
4007
|
+
# max_suggestions_count: 1,
|
4008
|
+
# }
|
4009
|
+
#
|
4010
|
+
# @!attribute [rw] index_id
|
4011
|
+
# The identifier of the index you want to get query suggestions from.
|
4012
|
+
# @return [String]
|
4013
|
+
#
|
4014
|
+
# @!attribute [rw] query_text
|
4015
|
+
# The text of a user's query to generate query suggestions.
|
4016
|
+
#
|
4017
|
+
# A query is suggested if the query prefix matches what a user starts
|
4018
|
+
# to type as their query.
|
4019
|
+
#
|
4020
|
+
# Amazon Kendra does not show any suggestions if a user types fewer
|
4021
|
+
# than two characters or more than 60 characters. A query must also
|
4022
|
+
# have at least one search result and contain at least one word of
|
4023
|
+
# more than four characters.
|
4024
|
+
# @return [String]
|
4025
|
+
#
|
4026
|
+
# @!attribute [rw] max_suggestions_count
|
4027
|
+
# The maximum number of query suggestions you want to show to your
|
4028
|
+
# users.
|
4029
|
+
# @return [Integer]
|
4030
|
+
#
|
4031
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsRequest AWS API Documentation
|
4032
|
+
#
|
4033
|
+
class GetQuerySuggestionsRequest < Struct.new(
|
4034
|
+
:index_id,
|
4035
|
+
:query_text,
|
4036
|
+
:max_suggestions_count)
|
4037
|
+
SENSITIVE = []
|
4038
|
+
include Aws::Structure
|
4039
|
+
end
|
4040
|
+
|
4041
|
+
# @!attribute [rw] query_suggestions_id
|
4042
|
+
# The unique identifier for a list of query suggestions for an index.
|
4043
|
+
# @return [String]
|
4044
|
+
#
|
4045
|
+
# @!attribute [rw] suggestions
|
4046
|
+
# A list of query suggestions for an index.
|
4047
|
+
# @return [Array<Types::Suggestion>]
|
4048
|
+
#
|
4049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsResponse AWS API Documentation
|
4050
|
+
#
|
4051
|
+
class GetQuerySuggestionsResponse < Struct.new(
|
4052
|
+
:query_suggestions_id,
|
4053
|
+
:suggestions)
|
4054
|
+
SENSITIVE = []
|
4055
|
+
include Aws::Structure
|
4056
|
+
end
|
4057
|
+
|
3624
4058
|
# Provides configuration information for data sources that connect to
|
3625
4059
|
# Google Drive.
|
3626
4060
|
#
|
@@ -4145,6 +4579,78 @@ module Aws::Kendra
|
|
4145
4579
|
include Aws::Structure
|
4146
4580
|
end
|
4147
4581
|
|
4582
|
+
# @note When making an API call, you may pass ListQuerySuggestionsBlockListsRequest
|
4583
|
+
# data as a hash:
|
4584
|
+
#
|
4585
|
+
# {
|
4586
|
+
# index_id: "IndexId", # required
|
4587
|
+
# next_token: "NextToken",
|
4588
|
+
# max_results: 1,
|
4589
|
+
# }
|
4590
|
+
#
|
4591
|
+
# @!attribute [rw] index_id
|
4592
|
+
# The identifier of the index for a list of all block lists that exist
|
4593
|
+
# for that index.
|
4594
|
+
#
|
4595
|
+
# For information on the current quota limits for block lists, see
|
4596
|
+
# [Quotas for Amazon Kendra][1].
|
4597
|
+
#
|
4598
|
+
#
|
4599
|
+
#
|
4600
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
4601
|
+
# @return [String]
|
4602
|
+
#
|
4603
|
+
# @!attribute [rw] next_token
|
4604
|
+
# If the previous response was incomplete (because there is more data
|
4605
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
4606
|
+
# response. You can use this pagination token to retrieve the next set
|
4607
|
+
# of block lists (`BlockListSummaryItems`).
|
4608
|
+
# @return [String]
|
4609
|
+
#
|
4610
|
+
# @!attribute [rw] max_results
|
4611
|
+
# The maximum number of block lists to return.
|
4612
|
+
# @return [Integer]
|
4613
|
+
#
|
4614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsRequest AWS API Documentation
|
4615
|
+
#
|
4616
|
+
class ListQuerySuggestionsBlockListsRequest < Struct.new(
|
4617
|
+
:index_id,
|
4618
|
+
:next_token,
|
4619
|
+
:max_results)
|
4620
|
+
SENSITIVE = []
|
4621
|
+
include Aws::Structure
|
4622
|
+
end
|
4623
|
+
|
4624
|
+
# @!attribute [rw] block_list_summary_items
|
4625
|
+
# Summary items for a block list.
|
4626
|
+
#
|
4627
|
+
# This includes summary items on the block list ID, block list name,
|
4628
|
+
# when the block list was created, when the block list was last
|
4629
|
+
# updated, and the count of block words/phrases in the block list.
|
4630
|
+
#
|
4631
|
+
# For information on the current quota limits for block lists, see
|
4632
|
+
# [Quotas for Amazon Kendra][1].
|
4633
|
+
#
|
4634
|
+
#
|
4635
|
+
#
|
4636
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
4637
|
+
# @return [Array<Types::QuerySuggestionsBlockListSummary>]
|
4638
|
+
#
|
4639
|
+
# @!attribute [rw] next_token
|
4640
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
4641
|
+
# you can use in the subsequent request to retrieve the next set of
|
4642
|
+
# block lists.
|
4643
|
+
# @return [String]
|
4644
|
+
#
|
4645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsResponse AWS API Documentation
|
4646
|
+
#
|
4647
|
+
class ListQuerySuggestionsBlockListsResponse < Struct.new(
|
4648
|
+
:block_list_summary_items,
|
4649
|
+
:next_token)
|
4650
|
+
SENSITIVE = []
|
4651
|
+
include Aws::Structure
|
4652
|
+
end
|
4653
|
+
|
4148
4654
|
# @note When making an API call, you may pass ListTagsForResourceRequest
|
4149
4655
|
# data as a hash:
|
4150
4656
|
#
|
@@ -4726,6 +5232,57 @@ module Aws::Kendra
|
|
4726
5232
|
include Aws::Structure
|
4727
5233
|
end
|
4728
5234
|
|
5235
|
+
# Summary information on a query suggestions block list.
|
5236
|
+
#
|
5237
|
+
# This includes information on the block list ID, block list name, when
|
5238
|
+
# the block list was created, when the block list was last updated, and
|
5239
|
+
# the count of block words/phrases in the block list.
|
5240
|
+
#
|
5241
|
+
# For information on the current quota limits for block lists, see
|
5242
|
+
# [Quotas for Amazon Kendra][1].
|
5243
|
+
#
|
5244
|
+
#
|
5245
|
+
#
|
5246
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
5247
|
+
#
|
5248
|
+
# @!attribute [rw] id
|
5249
|
+
# The identifier of a block list.
|
5250
|
+
# @return [String]
|
5251
|
+
#
|
5252
|
+
# @!attribute [rw] name
|
5253
|
+
# The name of the block list.
|
5254
|
+
# @return [String]
|
5255
|
+
#
|
5256
|
+
# @!attribute [rw] status
|
5257
|
+
# The status of the block list.
|
5258
|
+
# @return [String]
|
5259
|
+
#
|
5260
|
+
# @!attribute [rw] created_at
|
5261
|
+
# The date-time summary information for a query suggestions block list
|
5262
|
+
# was last created.
|
5263
|
+
# @return [Time]
|
5264
|
+
#
|
5265
|
+
# @!attribute [rw] updated_at
|
5266
|
+
# The date-time the block list was last updated.
|
5267
|
+
# @return [Time]
|
5268
|
+
#
|
5269
|
+
# @!attribute [rw] item_count
|
5270
|
+
# The number of items in the block list file.
|
5271
|
+
# @return [Integer]
|
5272
|
+
#
|
5273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QuerySuggestionsBlockListSummary AWS API Documentation
|
5274
|
+
#
|
5275
|
+
class QuerySuggestionsBlockListSummary < Struct.new(
|
5276
|
+
:id,
|
5277
|
+
:name,
|
5278
|
+
:status,
|
5279
|
+
:created_at,
|
5280
|
+
:updated_at,
|
5281
|
+
:item_count)
|
5282
|
+
SENSITIVE = []
|
5283
|
+
include Aws::Structure
|
5284
|
+
end
|
5285
|
+
|
4729
5286
|
# Provides information for manually tuning the relevance of a field in a
|
4730
5287
|
# search. When a query includes terms that match the field, the results
|
4731
5288
|
# are given a boost in the response based on these tuning parameters.
|
@@ -4916,12 +5473,21 @@ module Aws::Kendra
|
|
4916
5473
|
# document that matches an inclusion pattern also matches an exclusion
|
4917
5474
|
# pattern, the document is not indexed.
|
4918
5475
|
#
|
4919
|
-
#
|
4920
|
-
#
|
5476
|
+
# Some [examples][1] are:
|
5477
|
+
#
|
5478
|
+
# * **.txt* will include all text files in a directory (files with
|
5479
|
+
# the extension .txt).
|
4921
5480
|
#
|
5481
|
+
# * ***/*.txt* will include all text files in a directory and its
|
5482
|
+
# subdirectories.
|
4922
5483
|
#
|
5484
|
+
# * **tax** will include all files in a directory that contain
|
5485
|
+
# 'tax' in the file name, such as 'tax', 'taxes',
|
5486
|
+
# 'income\_tax'.
|
4923
5487
|
#
|
4924
|
-
#
|
5488
|
+
#
|
5489
|
+
#
|
5490
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
|
4925
5491
|
# @return [Array<String>]
|
4926
5492
|
#
|
4927
5493
|
# @!attribute [rw] exclusion_patterns
|
@@ -4929,12 +5495,21 @@ module Aws::Kendra
|
|
4929
5495
|
# a document that matches an inclusion prefix or inclusion pattern
|
4930
5496
|
# also matches an exclusion pattern, the document is not indexed.
|
4931
5497
|
#
|
4932
|
-
#
|
4933
|
-
#
|
5498
|
+
# Some [examples][1] are:
|
5499
|
+
#
|
5500
|
+
# * **.png , *.jpg* will exclude all PNG and JPEG image files in a
|
5501
|
+
# directory (files with the extensions .png and .jpg).
|
5502
|
+
#
|
5503
|
+
# * **internal** will exclude all files in a directory that contain
|
5504
|
+
# 'internal' in the file name, such as 'internal',
|
5505
|
+
# 'internal\_only', 'company\_internal'.
|
4934
5506
|
#
|
5507
|
+
# * ***/*internal** will exclude all internal-related files in a
|
5508
|
+
# directory and its subdirectories.
|
4935
5509
|
#
|
4936
5510
|
#
|
4937
|
-
#
|
5511
|
+
#
|
5512
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
|
4938
5513
|
# @return [Array<String>]
|
4939
5514
|
#
|
4940
5515
|
# @!attribute [rw] documents_metadata_configuration
|
@@ -5021,7 +5596,7 @@ module Aws::Kendra
|
|
5021
5596
|
# @!attribute [rw] document_title_field_name
|
5022
5597
|
# The name of the column in the Salesforce FeedItem table that
|
5023
5598
|
# contains the title of the document. This is typically the `Title`
|
5024
|
-
#
|
5599
|
+
# column.
|
5025
5600
|
# @return [String]
|
5026
5601
|
#
|
5027
5602
|
# @!attribute [rw] field_mappings
|
@@ -6151,6 +6726,86 @@ module Aws::Kendra
|
|
6151
6726
|
include Aws::Structure
|
6152
6727
|
end
|
6153
6728
|
|
6729
|
+
# A single query suggestion.
|
6730
|
+
#
|
6731
|
+
# @!attribute [rw] id
|
6732
|
+
# The unique UUID (universally unique identifier) of a single query
|
6733
|
+
# suggestion.
|
6734
|
+
# @return [String]
|
6735
|
+
#
|
6736
|
+
# @!attribute [rw] value
|
6737
|
+
# The value for the unique UUID (universally unique identifier) of a
|
6738
|
+
# single query suggestion.
|
6739
|
+
#
|
6740
|
+
# The value is the text string of a suggestion.
|
6741
|
+
# @return [Types::SuggestionValue]
|
6742
|
+
#
|
6743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Suggestion AWS API Documentation
|
6744
|
+
#
|
6745
|
+
class Suggestion < Struct.new(
|
6746
|
+
:id,
|
6747
|
+
:value)
|
6748
|
+
SENSITIVE = []
|
6749
|
+
include Aws::Structure
|
6750
|
+
end
|
6751
|
+
|
6752
|
+
# The text highlights for a single query suggestion.
|
6753
|
+
#
|
6754
|
+
# @!attribute [rw] begin_offset
|
6755
|
+
# The zero-based location in the response string where the highlight
|
6756
|
+
# starts.
|
6757
|
+
# @return [Integer]
|
6758
|
+
#
|
6759
|
+
# @!attribute [rw] end_offset
|
6760
|
+
# The zero-based location in the response string where the highlight
|
6761
|
+
# ends.
|
6762
|
+
# @return [Integer]
|
6763
|
+
#
|
6764
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionHighlight AWS API Documentation
|
6765
|
+
#
|
6766
|
+
class SuggestionHighlight < Struct.new(
|
6767
|
+
:begin_offset,
|
6768
|
+
:end_offset)
|
6769
|
+
SENSITIVE = []
|
6770
|
+
include Aws::Structure
|
6771
|
+
end
|
6772
|
+
|
6773
|
+
# Provides text and information about where to highlight the query
|
6774
|
+
# suggestion text.
|
6775
|
+
#
|
6776
|
+
# @!attribute [rw] text
|
6777
|
+
# The query suggestion text to display to the user.
|
6778
|
+
# @return [String]
|
6779
|
+
#
|
6780
|
+
# @!attribute [rw] highlights
|
6781
|
+
# The beginning and end of the query suggestion text that should be
|
6782
|
+
# highlighted.
|
6783
|
+
# @return [Array<Types::SuggestionHighlight>]
|
6784
|
+
#
|
6785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionTextWithHighlights AWS API Documentation
|
6786
|
+
#
|
6787
|
+
class SuggestionTextWithHighlights < Struct.new(
|
6788
|
+
:text,
|
6789
|
+
:highlights)
|
6790
|
+
SENSITIVE = []
|
6791
|
+
include Aws::Structure
|
6792
|
+
end
|
6793
|
+
|
6794
|
+
# The `SuggestionTextWithHighlights` structure information.
|
6795
|
+
#
|
6796
|
+
# @!attribute [rw] text
|
6797
|
+
# The `SuggestionTextWithHighlights` structure that contains the query
|
6798
|
+
# suggestion text and highlights.
|
6799
|
+
# @return [Types::SuggestionTextWithHighlights]
|
6800
|
+
#
|
6801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionValue AWS API Documentation
|
6802
|
+
#
|
6803
|
+
class SuggestionValue < Struct.new(
|
6804
|
+
:text)
|
6805
|
+
SENSITIVE = []
|
6806
|
+
include Aws::Structure
|
6807
|
+
end
|
6808
|
+
|
6154
6809
|
# A list of key/value pairs that identify an index, FAQ, or data source.
|
6155
6810
|
# Tag keys and values can consist of Unicode letters, digits, white
|
6156
6811
|
# space, and any of the following symbols: \_ . : / = + - @.
|
@@ -6787,6 +7442,158 @@ module Aws::Kendra
|
|
6787
7442
|
include Aws::Structure
|
6788
7443
|
end
|
6789
7444
|
|
7445
|
+
# @note When making an API call, you may pass UpdateQuerySuggestionsBlockListRequest
|
7446
|
+
# data as a hash:
|
7447
|
+
#
|
7448
|
+
# {
|
7449
|
+
# index_id: "IndexId", # required
|
7450
|
+
# id: "QuerySuggestionsBlockListId", # required
|
7451
|
+
# name: "QuerySuggestionsBlockListName",
|
7452
|
+
# description: "Description",
|
7453
|
+
# source_s3_path: {
|
7454
|
+
# bucket: "S3BucketName", # required
|
7455
|
+
# key: "S3ObjectKey", # required
|
7456
|
+
# },
|
7457
|
+
# role_arn: "RoleArn",
|
7458
|
+
# }
|
7459
|
+
#
|
7460
|
+
# @!attribute [rw] index_id
|
7461
|
+
# The identifier of the index for a block list.
|
7462
|
+
# @return [String]
|
7463
|
+
#
|
7464
|
+
# @!attribute [rw] id
|
7465
|
+
# The unique identifier of a block list.
|
7466
|
+
# @return [String]
|
7467
|
+
#
|
7468
|
+
# @!attribute [rw] name
|
7469
|
+
# The name of a block list.
|
7470
|
+
# @return [String]
|
7471
|
+
#
|
7472
|
+
# @!attribute [rw] description
|
7473
|
+
# The description for a block list.
|
7474
|
+
# @return [String]
|
7475
|
+
#
|
7476
|
+
# @!attribute [rw] source_s3_path
|
7477
|
+
# The S3 path where your block list text file sits in S3.
|
7478
|
+
#
|
7479
|
+
# If you update your block list and provide the same path to the block
|
7480
|
+
# list text file in S3, then Amazon Kendra reloads the file to refresh
|
7481
|
+
# the block list. Amazon Kendra does not automatically refresh your
|
7482
|
+
# block list. You need to call the `UpdateQuerySuggestionsBlockList`
|
7483
|
+
# API to refresh you block list.
|
7484
|
+
#
|
7485
|
+
# If you update your block list, then Amazon Kendra asynchronously
|
7486
|
+
# refreshes all query suggestions with the latest content in the S3
|
7487
|
+
# file. This means changes might not take effect immediately.
|
7488
|
+
# @return [Types::S3Path]
|
7489
|
+
#
|
7490
|
+
# @!attribute [rw] role_arn
|
7491
|
+
# The IAM (Identity and Access Management) role used to access the
|
7492
|
+
# block list text file in S3.
|
7493
|
+
# @return [String]
|
7494
|
+
#
|
7495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockListRequest AWS API Documentation
|
7496
|
+
#
|
7497
|
+
class UpdateQuerySuggestionsBlockListRequest < Struct.new(
|
7498
|
+
:index_id,
|
7499
|
+
:id,
|
7500
|
+
:name,
|
7501
|
+
:description,
|
7502
|
+
:source_s3_path,
|
7503
|
+
:role_arn)
|
7504
|
+
SENSITIVE = []
|
7505
|
+
include Aws::Structure
|
7506
|
+
end
|
7507
|
+
|
7508
|
+
# @note When making an API call, you may pass UpdateQuerySuggestionsConfigRequest
|
7509
|
+
# data as a hash:
|
7510
|
+
#
|
7511
|
+
# {
|
7512
|
+
# index_id: "IndexId", # required
|
7513
|
+
# mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
|
7514
|
+
# query_log_look_back_window_in_days: 1,
|
7515
|
+
# include_queries_without_user_information: false,
|
7516
|
+
# minimum_number_of_querying_users: 1,
|
7517
|
+
# minimum_query_count: 1,
|
7518
|
+
# }
|
7519
|
+
#
|
7520
|
+
# @!attribute [rw] index_id
|
7521
|
+
# The identifier of the index you want to update query suggestions
|
7522
|
+
# settings for.
|
7523
|
+
# @return [String]
|
7524
|
+
#
|
7525
|
+
# @!attribute [rw] mode
|
7526
|
+
# Set the mode to `ENABLED` or `LEARN_ONLY`.
|
7527
|
+
#
|
7528
|
+
# By default, Amazon Kendra enables query suggestions. `LEARN_ONLY`
|
7529
|
+
# mode allows you to turn off query suggestions. You can to update
|
7530
|
+
# this at any time.
|
7531
|
+
#
|
7532
|
+
# In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
|
7533
|
+
# queries to keep suggestions up to date for when you are ready to
|
7534
|
+
# switch to ENABLED mode again.
|
7535
|
+
# @return [String]
|
7536
|
+
#
|
7537
|
+
# @!attribute [rw] query_log_look_back_window_in_days
|
7538
|
+
# How recent your queries are in your query log time window.
|
7539
|
+
#
|
7540
|
+
# The time window is the number of days from current day to past days.
|
7541
|
+
#
|
7542
|
+
# By default, Amazon Kendra sets this to 180.
|
7543
|
+
# @return [Integer]
|
7544
|
+
#
|
7545
|
+
# @!attribute [rw] include_queries_without_user_information
|
7546
|
+
# `TRUE` to include queries without user information (i.e. all
|
7547
|
+
# queries, irrespective of the user), otherwise `FALSE` to only
|
7548
|
+
# include queries with user information.
|
7549
|
+
#
|
7550
|
+
# If you pass user information to Amazon Kendra along with the
|
7551
|
+
# queries, you can set this flag to `FALSE` and instruct Amazon Kendra
|
7552
|
+
# to only consider queries with user information.
|
7553
|
+
#
|
7554
|
+
# If you set to `FALSE`, Amazon Kendra only considers queries searched
|
7555
|
+
# at least `MinimumQueryCount` times across
|
7556
|
+
# `MinimumNumberOfQueryingUsers` unique users for suggestions.
|
7557
|
+
#
|
7558
|
+
# If you set to `TRUE`, Amazon Kendra ignores all user information and
|
7559
|
+
# learns from all queries.
|
7560
|
+
# @return [Boolean]
|
7561
|
+
#
|
7562
|
+
# @!attribute [rw] minimum_number_of_querying_users
|
7563
|
+
# The minimum number of unique users who must search a query in order
|
7564
|
+
# for the query to be eligible to suggest to your users.
|
7565
|
+
#
|
7566
|
+
# Increasing this number might decrease the number of suggestions.
|
7567
|
+
# However, this ensures a query is searched by many users and is truly
|
7568
|
+
# popular to suggest to users.
|
7569
|
+
#
|
7570
|
+
# How you tune this setting depends on your specific needs.
|
7571
|
+
# @return [Integer]
|
7572
|
+
#
|
7573
|
+
# @!attribute [rw] minimum_query_count
|
7574
|
+
# The the minimum number of times a query must be searched in order to
|
7575
|
+
# be eligible to suggest to your users.
|
7576
|
+
#
|
7577
|
+
# Decreasing this number increases the number of suggestions. However,
|
7578
|
+
# this affects the quality of suggestions as it sets a low bar for a
|
7579
|
+
# query to be considered popular to suggest to users.
|
7580
|
+
#
|
7581
|
+
# How you tune this setting depends on your specific needs.
|
7582
|
+
# @return [Integer]
|
7583
|
+
#
|
7584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfigRequest AWS API Documentation
|
7585
|
+
#
|
7586
|
+
class UpdateQuerySuggestionsConfigRequest < Struct.new(
|
7587
|
+
:index_id,
|
7588
|
+
:mode,
|
7589
|
+
:query_log_look_back_window_in_days,
|
7590
|
+
:include_queries_without_user_information,
|
7591
|
+
:minimum_number_of_querying_users,
|
7592
|
+
:minimum_query_count)
|
7593
|
+
SENSITIVE = []
|
7594
|
+
include Aws::Structure
|
7595
|
+
end
|
7596
|
+
|
6790
7597
|
# @note When making an API call, you may pass UpdateThesaurusRequest
|
6791
7598
|
# data as a hash:
|
6792
7599
|
#
|