aws-sdk-kendra 1.20.0 → 1.25.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +138 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-kendra.rb +2 -2
- data/lib/aws-sdk-kendra/client.rb +601 -16
- data/lib/aws-sdk-kendra/client_api.rb +287 -2
- data/lib/aws-sdk-kendra/errors.rb +1 -1
- data/lib/aws-sdk-kendra/resource.rb +1 -1
- data/lib/aws-sdk-kendra/types.rb +991 -50
- metadata +11 -9
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -61,7 +61,7 @@ module Aws::Kendra
|
|
61
61
|
# A list of groups, separated by semi-colons, that filters a query
|
62
62
|
# response based on user context. The document is only returned to
|
63
63
|
# users that are in one of the groups specified in the `UserContext`
|
64
|
-
# field of the Query operation.
|
64
|
+
# field of the `Query` operation.
|
65
65
|
# @return [String]
|
66
66
|
#
|
67
67
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation
|
@@ -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
|
#
|
@@ -541,7 +541,7 @@ module Aws::Kendra
|
|
541
541
|
end
|
542
542
|
|
543
543
|
# Provides information about documents that could not be removed from an
|
544
|
-
# index by the BatchDeleteDocument operation.
|
544
|
+
# index by the `BatchDeleteDocument` operation.
|
545
545
|
#
|
546
546
|
# @!attribute [rw] id
|
547
547
|
# The identifier of the document that couldn't be removed from the
|
@@ -608,7 +608,7 @@ module Aws::Kendra
|
|
608
608
|
#
|
609
609
|
# @!attribute [rw] index_id
|
610
610
|
# The identifier of the index to add the documents to. You need to
|
611
|
-
# create the index first using the CreateIndex operation.
|
611
|
+
# create the index first using the `CreateIndex` operation.
|
612
612
|
# @return [String]
|
613
613
|
#
|
614
614
|
# @!attribute [rw] role_arn
|
@@ -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,8 +735,28 @@ 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
|
-
# user. Your application uses the SubmitFeedback operation to provide
|
759
|
+
# user. Your application uses the `SubmitFeedback` operation to provide
|
733
760
|
# click information.
|
734
761
|
#
|
735
762
|
# @note When making an API call, you may pass ClickFeedback
|
@@ -792,7 +819,7 @@ module Aws::Kendra
|
|
792
819
|
# @!attribute [rw] field_mappings
|
793
820
|
# An array of objects that map database column names to the
|
794
821
|
# corresponding fields in an index. You must first create the fields
|
795
|
-
# in the index using the UpdateIndex operation.
|
822
|
+
# in the index using the `UpdateIndex` operation.
|
796
823
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
797
824
|
#
|
798
825
|
# @!attribute [rw] change_detecting_columns
|
@@ -868,7 +895,8 @@ module Aws::Kendra
|
|
868
895
|
# Defines the mapping between a field in the Confluence data source to a
|
869
896
|
# Amazon Kendra index field.
|
870
897
|
#
|
871
|
-
# You must first create the index field using the
|
898
|
+
# You must first create the index field using the `UpdateIndex`
|
899
|
+
# operation.
|
872
900
|
#
|
873
901
|
# @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
|
874
902
|
# data as a hash:
|
@@ -882,7 +910,8 @@ module Aws::Kendra
|
|
882
910
|
# @!attribute [rw] data_source_field_name
|
883
911
|
# The name of the field in the data source.
|
884
912
|
#
|
885
|
-
# You must first create the index field using the
|
913
|
+
# You must first create the index field using the `UpdateIndex`
|
914
|
+
# operation.
|
886
915
|
# @return [String]
|
887
916
|
#
|
888
917
|
# @!attribute [rw] date_field_format
|
@@ -909,7 +938,8 @@ module Aws::Kendra
|
|
909
938
|
|
910
939
|
# Specifies the blog settings for the Confluence data source. Blogs are
|
911
940
|
# always indexed unless filtered from the index by the
|
912
|
-
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
941
|
+
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
942
|
+
# `ConfluenceConfiguration` type.
|
913
943
|
#
|
914
944
|
# @note When making an API call, you may pass ConfluenceBlogConfiguration
|
915
945
|
# data as a hash:
|
@@ -945,7 +975,8 @@ module Aws::Kendra
|
|
945
975
|
# Defines the mapping between a blog field in the Confluence data source
|
946
976
|
# to a Amazon Kendra index field.
|
947
977
|
#
|
948
|
-
# You must first create the index field using the
|
978
|
+
# You must first create the index field using the `UpdateIndex`
|
979
|
+
# operation.
|
949
980
|
#
|
950
981
|
# @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
|
951
982
|
# data as a hash:
|
@@ -1158,7 +1189,8 @@ module Aws::Kendra
|
|
1158
1189
|
# Defines the mapping between a field in the Confluence data source to a
|
1159
1190
|
# Amazon Kendra index field.
|
1160
1191
|
#
|
1161
|
-
# You must first create the index field using the
|
1192
|
+
# You must first create the index field using the `UpdateIndex`
|
1193
|
+
# operation.
|
1162
1194
|
#
|
1163
1195
|
# @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
|
1164
1196
|
# data as a hash:
|
@@ -1271,7 +1303,8 @@ module Aws::Kendra
|
|
1271
1303
|
# Defines the mapping between a field in the Confluence data source to a
|
1272
1304
|
# Amazon Kendra index field.
|
1273
1305
|
#
|
1274
|
-
# You must first create the index field using the
|
1306
|
+
# You must first create the index field using the `UpdateIndex`
|
1307
|
+
# operation.
|
1275
1308
|
#
|
1276
1309
|
# @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
|
1277
1310
|
# data as a hash:
|
@@ -1547,6 +1580,7 @@ module Aws::Kendra
|
|
1547
1580
|
# index_field_name: "IndexFieldName", # required
|
1548
1581
|
# },
|
1549
1582
|
# ],
|
1583
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
1550
1584
|
# },
|
1551
1585
|
# service_catalog_configuration: {
|
1552
1586
|
# crawl_attachments: false,
|
@@ -1562,6 +1596,7 @@ module Aws::Kendra
|
|
1562
1596
|
# },
|
1563
1597
|
# ],
|
1564
1598
|
# },
|
1599
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
1565
1600
|
# },
|
1566
1601
|
# confluence_configuration: {
|
1567
1602
|
# server_url: "Url", # required
|
@@ -1983,6 +2018,110 @@ module Aws::Kendra
|
|
1983
2018
|
include Aws::Structure
|
1984
2019
|
end
|
1985
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
|
+
|
1986
2125
|
# @note When making an API call, you may pass CreateThesaurusRequest
|
1987
2126
|
# data as a hash:
|
1988
2127
|
#
|
@@ -2249,6 +2388,7 @@ module Aws::Kendra
|
|
2249
2388
|
# index_field_name: "IndexFieldName", # required
|
2250
2389
|
# },
|
2251
2390
|
# ],
|
2391
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
2252
2392
|
# },
|
2253
2393
|
# service_catalog_configuration: {
|
2254
2394
|
# crawl_attachments: false,
|
@@ -2264,6 +2404,7 @@ module Aws::Kendra
|
|
2264
2404
|
# },
|
2265
2405
|
# ],
|
2266
2406
|
# },
|
2407
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
2267
2408
|
# },
|
2268
2409
|
# confluence_configuration: {
|
2269
2410
|
# server_url: "Url", # required
|
@@ -2390,7 +2531,7 @@ module Aws::Kendra
|
|
2390
2531
|
end
|
2391
2532
|
|
2392
2533
|
# Summary information for a Amazon Kendra data source. Returned in a
|
2393
|
-
# call to .
|
2534
|
+
# call to the `DescribeDataSource` operation.
|
2394
2535
|
#
|
2395
2536
|
# @!attribute [rw] name
|
2396
2537
|
# The name of the data source.
|
@@ -2413,7 +2554,7 @@ module Aws::Kendra
|
|
2413
2554
|
# @return [Time]
|
2414
2555
|
#
|
2415
2556
|
# @!attribute [rw] status
|
2416
|
-
# The status of the data source. When the status is `
|
2557
|
+
# The status of the data source. When the status is `ACTIVE` the data
|
2417
2558
|
# source is ready to use.
|
2418
2559
|
# @return [String]
|
2419
2560
|
#
|
@@ -2496,7 +2637,7 @@ module Aws::Kendra
|
|
2496
2637
|
#
|
2497
2638
|
# {
|
2498
2639
|
# data_source_id: "DataSourceId", # required
|
2499
|
-
# data_source_sync_job_id: "DataSourceSyncJobId",
|
2640
|
+
# data_source_sync_job_id: "DataSourceSyncJobId",
|
2500
2641
|
# }
|
2501
2642
|
#
|
2502
2643
|
# @!attribute [rw] data_source_id
|
@@ -2505,6 +2646,15 @@ module Aws::Kendra
|
|
2505
2646
|
#
|
2506
2647
|
# @!attribute [rw] data_source_sync_job_id
|
2507
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.
|
2508
2658
|
# @return [String]
|
2509
2659
|
#
|
2510
2660
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetricTarget AWS API Documentation
|
@@ -2558,7 +2708,7 @@ module Aws::Kendra
|
|
2558
2708
|
end
|
2559
2709
|
|
2560
2710
|
# Maps a column or attribute in the data source to an index field. You
|
2561
|
-
# must first create the fields in the index using the UpdateIndex
|
2711
|
+
# must first create the fields in the index using the `UpdateIndex`
|
2562
2712
|
# operation.
|
2563
2713
|
#
|
2564
2714
|
# @note When making an API call, you may pass DataSourceToIndexFieldMapping
|
@@ -2771,6 +2921,31 @@ module Aws::Kendra
|
|
2771
2921
|
include Aws::Structure
|
2772
2922
|
end
|
2773
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
|
+
|
2774
2949
|
# @note When making an API call, you may pass DeleteThesaurusRequest
|
2775
2950
|
# data as a hash:
|
2776
2951
|
#
|
@@ -3062,7 +3237,7 @@ module Aws::Kendra
|
|
3062
3237
|
# @return [String]
|
3063
3238
|
#
|
3064
3239
|
# @!attribute [rw] capacity_units
|
3065
|
-
# For
|
3240
|
+
# For Enterprise edition indexes, you can choose to use additional
|
3066
3241
|
# capacity to meet the needs of your application. This contains the
|
3067
3242
|
# capacity units used for the index. A 0 for the query capacity or the
|
3068
3243
|
# storage capacity indicates that the index is using the default
|
@@ -3099,6 +3274,218 @@ module Aws::Kendra
|
|
3099
3274
|
include Aws::Structure
|
3100
3275
|
end
|
3101
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
|
+
|
3102
3489
|
# @note When making an API call, you may pass DescribeThesaurusRequest
|
3103
3490
|
# data as a hash:
|
3104
3491
|
#
|
@@ -3439,19 +3826,58 @@ module Aws::Kendra
|
|
3439
3826
|
include Aws::Structure
|
3440
3827
|
end
|
3441
3828
|
|
3442
|
-
#
|
3443
|
-
# access control information, source URI, document author, and custom
|
3444
|
-
# attributes. Each metadata file contains metadata about a single
|
3445
|
-
# document.
|
3829
|
+
# Overrides the document relevance properties of a custom index field.
|
3446
3830
|
#
|
3447
|
-
# @note When making an API call, you may pass
|
3831
|
+
# @note When making an API call, you may pass DocumentRelevanceConfiguration
|
3448
3832
|
# data as a hash:
|
3449
3833
|
#
|
3450
3834
|
# {
|
3451
|
-
#
|
3835
|
+
# name: "DocumentMetadataConfigurationName", # required
|
3836
|
+
# relevance: { # required
|
3837
|
+
# freshness: false,
|
3838
|
+
# importance: 1,
|
3839
|
+
# duration: "Duration",
|
3840
|
+
# rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
3841
|
+
# value_importance_map: {
|
3842
|
+
# "ValueImportanceMapKey" => 1,
|
3843
|
+
# },
|
3844
|
+
# },
|
3452
3845
|
# }
|
3453
3846
|
#
|
3454
|
-
# @!attribute [rw]
|
3847
|
+
# @!attribute [rw] name
|
3848
|
+
# The name of the tuning configuration to override document relevance
|
3849
|
+
# at the index level.
|
3850
|
+
# @return [String]
|
3851
|
+
#
|
3852
|
+
# @!attribute [rw] relevance
|
3853
|
+
# Provides information for manually tuning the relevance of a field in
|
3854
|
+
# a search. When a query includes terms that match the field, the
|
3855
|
+
# results are given a boost in the response based on these tuning
|
3856
|
+
# parameters.
|
3857
|
+
# @return [Types::Relevance]
|
3858
|
+
#
|
3859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentRelevanceConfiguration AWS API Documentation
|
3860
|
+
#
|
3861
|
+
class DocumentRelevanceConfiguration < Struct.new(
|
3862
|
+
:name,
|
3863
|
+
:relevance)
|
3864
|
+
SENSITIVE = []
|
3865
|
+
include Aws::Structure
|
3866
|
+
end
|
3867
|
+
|
3868
|
+
# Document metadata files that contain information such as the document
|
3869
|
+
# access control information, source URI, document author, and custom
|
3870
|
+
# attributes. Each metadata file contains metadata about a single
|
3871
|
+
# document.
|
3872
|
+
#
|
3873
|
+
# @note When making an API call, you may pass DocumentsMetadataConfiguration
|
3874
|
+
# data as a hash:
|
3875
|
+
#
|
3876
|
+
# {
|
3877
|
+
# s3_prefix: "S3ObjectKey",
|
3878
|
+
# }
|
3879
|
+
#
|
3880
|
+
# @!attribute [rw] s3_prefix
|
3455
3881
|
# A prefix used to filter metadata configuration files in the AWS S3
|
3456
3882
|
# bucket. The S3 bucket might contain multiple metadata files. Use
|
3457
3883
|
# `S3Prefix` to include only the desired metadata files.
|
@@ -3572,6 +3998,63 @@ module Aws::Kendra
|
|
3572
3998
|
include Aws::Structure
|
3573
3999
|
end
|
3574
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
|
+
|
3575
4058
|
# Provides configuration information for data sources that connect to
|
3576
4059
|
# Google Drive.
|
3577
4060
|
#
|
@@ -3629,7 +4112,7 @@ module Aws::Kendra
|
|
3629
4112
|
#
|
3630
4113
|
# If you are using the console, you can define index fields when
|
3631
4114
|
# creating the mapping. If you are using the API, you must first
|
3632
|
-
# create the field using the UpdateIndex operation.
|
4115
|
+
# create the field using the `UpdateIndex` operation.
|
3633
4116
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
3634
4117
|
#
|
3635
4118
|
# @!attribute [rw] exclude_mime_types
|
@@ -4096,6 +4579,78 @@ module Aws::Kendra
|
|
4096
4579
|
include Aws::Structure
|
4097
4580
|
end
|
4098
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
|
+
|
4099
4654
|
# @note When making an API call, you may pass ListTagsForResourceRequest
|
4100
4655
|
# data as a hash:
|
4101
4656
|
#
|
@@ -4427,6 +4982,20 @@ module Aws::Kendra
|
|
4427
4982
|
# ],
|
4428
4983
|
# requested_document_attributes: ["DocumentAttributeKey"],
|
4429
4984
|
# query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
|
4985
|
+
# document_relevance_override_configurations: [
|
4986
|
+
# {
|
4987
|
+
# name: "DocumentMetadataConfigurationName", # required
|
4988
|
+
# relevance: { # required
|
4989
|
+
# freshness: false,
|
4990
|
+
# importance: 1,
|
4991
|
+
# duration: "Duration",
|
4992
|
+
# rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
4993
|
+
# value_importance_map: {
|
4994
|
+
# "ValueImportanceMapKey" => 1,
|
4995
|
+
# },
|
4996
|
+
# },
|
4997
|
+
# },
|
4998
|
+
# ],
|
4430
4999
|
# page_number: 1,
|
4431
5000
|
# page_size: 1,
|
4432
5001
|
# sorting_configuration: {
|
@@ -4441,7 +5010,7 @@ module Aws::Kendra
|
|
4441
5010
|
#
|
4442
5011
|
# @!attribute [rw] index_id
|
4443
5012
|
# The unique identifier of the index to search. The identifier is
|
4444
|
-
# returned in the response from the operation.
|
5013
|
+
# returned in the response from the `CreateIndex` operation.
|
4445
5014
|
# @return [String]
|
4446
5015
|
#
|
4447
5016
|
# @!attribute [rw] query_text
|
@@ -4476,6 +5045,25 @@ module Aws::Kendra
|
|
4476
5045
|
# are returned.
|
4477
5046
|
# @return [String]
|
4478
5047
|
#
|
5048
|
+
# @!attribute [rw] document_relevance_override_configurations
|
5049
|
+
# Overrides relevance tuning configurations of fields or attributes
|
5050
|
+
# set at the index level.
|
5051
|
+
#
|
5052
|
+
# If you use this API to override the relevance tuning configured at
|
5053
|
+
# the index level, but there is no relevance tuning configured at the
|
5054
|
+
# index level, then Amazon Kendra does not apply any relevance tuning.
|
5055
|
+
#
|
5056
|
+
# If there is relevance tuning configured at the index level, but you
|
5057
|
+
# do not use this API to override any relevance tuning in the index,
|
5058
|
+
# then Amazon Kendra uses the relevance tuning that is configured at
|
5059
|
+
# the index level.
|
5060
|
+
#
|
5061
|
+
# If there is relevance tuning configured for fields at the index
|
5062
|
+
# level, but you use this API to override only some of these fields,
|
5063
|
+
# then for the fields you did not override, the importance is set to
|
5064
|
+
# 1.
|
5065
|
+
# @return [Array<Types::DocumentRelevanceConfiguration>]
|
5066
|
+
#
|
4479
5067
|
# @!attribute [rw] page_number
|
4480
5068
|
# Query results are returned in pages the size of the `PageSize`
|
4481
5069
|
# parameter. By default, Amazon Kendra returns the first page of
|
@@ -4520,6 +5108,7 @@ module Aws::Kendra
|
|
4520
5108
|
:facets,
|
4521
5109
|
:requested_document_attributes,
|
4522
5110
|
:query_result_type_filter,
|
5111
|
+
:document_relevance_override_configurations,
|
4523
5112
|
:page_number,
|
4524
5113
|
:page_size,
|
4525
5114
|
:sorting_configuration,
|
@@ -4643,6 +5232,57 @@ module Aws::Kendra
|
|
4643
5232
|
include Aws::Structure
|
4644
5233
|
end
|
4645
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
|
+
|
4646
5286
|
# Provides information for manually tuning the relevance of a field in a
|
4647
5287
|
# search. When a query includes terms that match the field, the results
|
4648
5288
|
# are given a boost in the response based on these tuning parameters.
|
@@ -4727,7 +5367,7 @@ module Aws::Kendra
|
|
4727
5367
|
end
|
4728
5368
|
|
4729
5369
|
# Provides feedback on how relevant a document is to a search. Your
|
4730
|
-
# application uses the SubmitFeedback operation to provide relevance
|
5370
|
+
# application uses the `SubmitFeedback` operation to provide relevance
|
4731
5371
|
# information.
|
4732
5372
|
#
|
4733
5373
|
# @note When making an API call, you may pass RelevanceFeedback
|
@@ -4833,12 +5473,21 @@ module Aws::Kendra
|
|
4833
5473
|
# document that matches an inclusion pattern also matches an exclusion
|
4834
5474
|
# pattern, the document is not indexed.
|
4835
5475
|
#
|
4836
|
-
#
|
4837
|
-
# (programming)][1] in *Wikipedia*.
|
5476
|
+
# Some [examples][1] are:
|
4838
5477
|
#
|
5478
|
+
# * **.txt* will include all text files in a directory (files with
|
5479
|
+
# the extension .txt).
|
4839
5480
|
#
|
5481
|
+
# * ***/*.txt* will include all text files in a directory and its
|
5482
|
+
# subdirectories.
|
4840
5483
|
#
|
4841
|
-
#
|
5484
|
+
# * **tax** will include all files in a directory that contain
|
5485
|
+
# 'tax' in the file name, such as 'tax', 'taxes',
|
5486
|
+
# 'income\_tax'.
|
5487
|
+
#
|
5488
|
+
#
|
5489
|
+
#
|
5490
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
|
4842
5491
|
# @return [Array<String>]
|
4843
5492
|
#
|
4844
5493
|
# @!attribute [rw] exclusion_patterns
|
@@ -4846,12 +5495,21 @@ module Aws::Kendra
|
|
4846
5495
|
# a document that matches an inclusion prefix or inclusion pattern
|
4847
5496
|
# also matches an exclusion pattern, the document is not indexed.
|
4848
5497
|
#
|
4849
|
-
#
|
4850
|
-
#
|
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'.
|
4851
5506
|
#
|
5507
|
+
# * ***/*internal** will exclude all internal-related files in a
|
5508
|
+
# directory and its subdirectories.
|
4852
5509
|
#
|
4853
5510
|
#
|
4854
|
-
#
|
5511
|
+
#
|
5512
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
|
4855
5513
|
# @return [Array<String>]
|
4856
5514
|
#
|
4857
5515
|
# @!attribute [rw] documents_metadata_configuration
|
@@ -4938,7 +5596,7 @@ module Aws::Kendra
|
|
4938
5596
|
# @!attribute [rw] document_title_field_name
|
4939
5597
|
# The name of the column in the Salesforce FeedItem table that
|
4940
5598
|
# contains the title of the document. This is typically the `Title`
|
4941
|
-
#
|
5599
|
+
# column.
|
4942
5600
|
# @return [String]
|
4943
5601
|
#
|
4944
5602
|
# @!attribute [rw] field_mappings
|
@@ -5078,7 +5736,7 @@ module Aws::Kendra
|
|
5078
5736
|
# @return [Array<Types::SalesforceStandardObjectConfiguration>]
|
5079
5737
|
#
|
5080
5738
|
# @!attribute [rw] knowledge_article_configuration
|
5081
|
-
# Specifies configuration information for the
|
5739
|
+
# Specifies configuration information for the knowledge article types
|
5082
5740
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
5083
5741
|
# articles and the standard fields of knowledge articles, or the
|
5084
5742
|
# custom fields of custom knowledge articles, but not both.
|
@@ -5183,7 +5841,7 @@ module Aws::Kendra
|
|
5183
5841
|
include Aws::Structure
|
5184
5842
|
end
|
5185
5843
|
|
5186
|
-
# Specifies configuration information for the
|
5844
|
+
# Specifies configuration information for the knowledge article types
|
5187
5845
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
5188
5846
|
# articles and the standard fields of knowledge articles, or the custom
|
5189
5847
|
# fields of custom knowledge articles, but not both
|
@@ -5323,7 +5981,7 @@ module Aws::Kendra
|
|
5323
5981
|
include Aws::Structure
|
5324
5982
|
end
|
5325
5983
|
|
5326
|
-
# Specifies
|
5984
|
+
# Specifies configuration information for indexing a single standard
|
5327
5985
|
# object.
|
5328
5986
|
#
|
5329
5987
|
# @note When making an API call, you may pass SalesforceStandardObjectConfiguration
|
@@ -5353,7 +6011,7 @@ module Aws::Kendra
|
|
5353
6011
|
#
|
5354
6012
|
# @!attribute [rw] document_title_field_name
|
5355
6013
|
# The name of the field in the standard object table that contains the
|
5356
|
-
# document
|
6014
|
+
# document title.
|
5357
6015
|
# @return [String]
|
5358
6016
|
#
|
5359
6017
|
# @!attribute [rw] field_mappings
|
@@ -5485,6 +6143,7 @@ module Aws::Kendra
|
|
5485
6143
|
# index_field_name: "IndexFieldName", # required
|
5486
6144
|
# },
|
5487
6145
|
# ],
|
6146
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
5488
6147
|
# },
|
5489
6148
|
# service_catalog_configuration: {
|
5490
6149
|
# crawl_attachments: false,
|
@@ -5500,6 +6159,7 @@ module Aws::Kendra
|
|
5500
6159
|
# },
|
5501
6160
|
# ],
|
5502
6161
|
# },
|
6162
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
5503
6163
|
# }
|
5504
6164
|
#
|
5505
6165
|
# @!attribute [rw] host_url
|
@@ -5529,6 +6189,25 @@ module Aws::Kendra
|
|
5529
6189
|
# the ServiceNow site.
|
5530
6190
|
# @return [Types::ServiceNowServiceCatalogConfiguration]
|
5531
6191
|
#
|
6192
|
+
# @!attribute [rw] authentication_type
|
6193
|
+
# Determines the type of authentication used to connect to the
|
6194
|
+
# ServiceNow instance. If you choose `HTTP_BASIC`, Amazon Kendra is
|
6195
|
+
# authenticated using the user name and password provided in the AWS
|
6196
|
+
# Secrets Manager secret in the `SecretArn` field. When you choose
|
6197
|
+
# `OAUTH2`, Amazon Kendra is authenticated using the OAuth token and
|
6198
|
+
# secret provided in the Secrets Manager secret, and the user name and
|
6199
|
+
# password are used to determine which information Amazon Kendra has
|
6200
|
+
# access to.
|
6201
|
+
#
|
6202
|
+
# When you use `OAUTH2` authentication, you must generate a token and
|
6203
|
+
# a client secret using the ServiceNow console. For more information,
|
6204
|
+
# see [Using a ServiceNow data source][1].
|
6205
|
+
#
|
6206
|
+
#
|
6207
|
+
#
|
6208
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html
|
6209
|
+
# @return [String]
|
6210
|
+
#
|
5532
6211
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowConfiguration AWS API Documentation
|
5533
6212
|
#
|
5534
6213
|
class ServiceNowConfiguration < Struct.new(
|
@@ -5536,7 +6215,8 @@ module Aws::Kendra
|
|
5536
6215
|
:secret_arn,
|
5537
6216
|
:service_now_build_version,
|
5538
6217
|
:knowledge_article_configuration,
|
5539
|
-
:service_catalog_configuration
|
6218
|
+
:service_catalog_configuration,
|
6219
|
+
:authentication_type)
|
5540
6220
|
SENSITIVE = []
|
5541
6221
|
include Aws::Structure
|
5542
6222
|
end
|
@@ -5560,6 +6240,7 @@ module Aws::Kendra
|
|
5560
6240
|
# index_field_name: "IndexFieldName", # required
|
5561
6241
|
# },
|
5562
6242
|
# ],
|
6243
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
5563
6244
|
# }
|
5564
6245
|
#
|
5565
6246
|
# @!attribute [rw] crawl_attachments
|
@@ -5594,6 +6275,20 @@ module Aws::Kendra
|
|
5594
6275
|
# You must create the index field before you map the field.
|
5595
6276
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
5596
6277
|
#
|
6278
|
+
# @!attribute [rw] filter_query
|
6279
|
+
# A query that selects the knowledge articles to index. The query can
|
6280
|
+
# return articles from multiple knowledge bases, and the knowledge
|
6281
|
+
# bases can be public or private.
|
6282
|
+
#
|
6283
|
+
# The query string must be one generated by the ServiceNow console.
|
6284
|
+
# For more information, see [Specifying documents to index with a
|
6285
|
+
# query][1].
|
6286
|
+
#
|
6287
|
+
#
|
6288
|
+
#
|
6289
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html
|
6290
|
+
# @return [String]
|
6291
|
+
#
|
5597
6292
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration AWS API Documentation
|
5598
6293
|
#
|
5599
6294
|
class ServiceNowKnowledgeArticleConfiguration < Struct.new(
|
@@ -5602,7 +6297,8 @@ module Aws::Kendra
|
|
5602
6297
|
:exclude_attachment_file_patterns,
|
5603
6298
|
:document_data_field_name,
|
5604
6299
|
:document_title_field_name,
|
5605
|
-
:field_mappings
|
6300
|
+
:field_mappings,
|
6301
|
+
:filter_query)
|
5606
6302
|
SENSITIVE = []
|
5607
6303
|
include Aws::Structure
|
5608
6304
|
end
|
@@ -5634,13 +6330,23 @@ module Aws::Kendra
|
|
5634
6330
|
# @return [Boolean]
|
5635
6331
|
#
|
5636
6332
|
# @!attribute [rw] include_attachment_file_patterns
|
5637
|
-
#
|
5638
|
-
# index.
|
6333
|
+
# A list of regular expression patterns. Documents that match the
|
6334
|
+
# patterns are included in the index. Documents that don't match the
|
6335
|
+
# patterns are excluded from the index. If a document matches both an
|
6336
|
+
# exclusion pattern and an inclusion pattern, the document is not
|
6337
|
+
# included in the index.
|
6338
|
+
#
|
6339
|
+
# The regex is applied to the file name of the attachment.
|
5639
6340
|
# @return [Array<String>]
|
5640
6341
|
#
|
5641
6342
|
# @!attribute [rw] exclude_attachment_file_patterns
|
5642
|
-
#
|
5643
|
-
# index.
|
6343
|
+
# A list of regular expression patterns. Documents that match the
|
6344
|
+
# patterns are excluded from the index. Documents that don't match
|
6345
|
+
# the patterns are included in the index. If a document matches both
|
6346
|
+
# an exclusion pattern and an inclusion pattern, the document is not
|
6347
|
+
# included in the index.
|
6348
|
+
#
|
6349
|
+
# The regex is applied to the file name of the attachment.
|
5644
6350
|
# @return [Array<String>]
|
5645
6351
|
#
|
5646
6352
|
# @!attribute [rw] document_data_field_name
|
@@ -5775,9 +6481,9 @@ module Aws::Kendra
|
|
5775
6481
|
# @!attribute [rw] field_mappings
|
5776
6482
|
# A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
|
5777
6483
|
# SharePoint attributes to custom fields in the Amazon Kendra index.
|
5778
|
-
# You must first create the index fields using the
|
5779
|
-
# you map SharePoint attributes. For more
|
5780
|
-
# Data Source Fields][1].
|
6484
|
+
# You must first create the index fields using the `UpdateIndex`
|
6485
|
+
# operation before you map SharePoint attributes. For more
|
6486
|
+
# information, see [Mapping Data Source Fields][1].
|
5781
6487
|
#
|
5782
6488
|
#
|
5783
6489
|
#
|
@@ -5995,7 +6701,8 @@ module Aws::Kendra
|
|
5995
6701
|
#
|
5996
6702
|
# @!attribute [rw] query_id
|
5997
6703
|
# The identifier of the specific query for which you are submitting
|
5998
|
-
# feedback. The query ID is returned in the response to the
|
6704
|
+
# feedback. The query ID is returned in the response to the `Query`
|
6705
|
+
# operation.
|
5999
6706
|
# @return [String]
|
6000
6707
|
#
|
6001
6708
|
# @!attribute [rw] click_feedback_items
|
@@ -6019,6 +6726,86 @@ module Aws::Kendra
|
|
6019
6726
|
include Aws::Structure
|
6020
6727
|
end
|
6021
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
|
+
|
6022
6809
|
# A list of key/value pairs that identify an index, FAQ, or data source.
|
6023
6810
|
# Tag keys and values can consist of Unicode letters, digits, white
|
6024
6811
|
# space, and any of the following symbols: \_ . : / = + - @.
|
@@ -6412,6 +7199,7 @@ module Aws::Kendra
|
|
6412
7199
|
# index_field_name: "IndexFieldName", # required
|
6413
7200
|
# },
|
6414
7201
|
# ],
|
7202
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
6415
7203
|
# },
|
6416
7204
|
# service_catalog_configuration: {
|
6417
7205
|
# crawl_attachments: false,
|
@@ -6427,6 +7215,7 @@ module Aws::Kendra
|
|
6427
7215
|
# },
|
6428
7216
|
# ],
|
6429
7217
|
# },
|
7218
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
6430
7219
|
# },
|
6431
7220
|
# confluence_configuration: {
|
6432
7221
|
# server_url: "Url", # required
|
@@ -6621,7 +7410,7 @@ module Aws::Kendra
|
|
6621
7410
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
6622
7411
|
#
|
6623
7412
|
# @!attribute [rw] capacity_units
|
6624
|
-
# Sets the number of
|
7413
|
+
# Sets the number of additional storage and query capacity units that
|
6625
7414
|
# should be used by the index. You can change the capacity of the
|
6626
7415
|
# index up to 5 times per day.
|
6627
7416
|
#
|
@@ -6653,6 +7442,158 @@ module Aws::Kendra
|
|
6653
7442
|
include Aws::Structure
|
6654
7443
|
end
|
6655
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
|
+
|
6656
7597
|
# @note When making an API call, you may pass UpdateThesaurusRequest
|
6657
7598
|
# data as a hash:
|
6658
7599
|
#
|