aws-sdk-kendra 1.8.0 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-kendra.rb +3 -2
- data/lib/aws-sdk-kendra/client.rb +77 -16
- data/lib/aws-sdk-kendra/client_api.rb +25 -0
- data/lib/aws-sdk-kendra/types.rb +228 -23
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7b9c9e18500c2cbea326d60677c3102b7227620fc96f0057d724b670d2e9b42e
|
4
|
+
data.tar.gz: '08242ac7903468a85e7cf4a5a22ba00a4c8db4066aff18fc98b643161c111ee9'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: be25a71903a5a73560a6298f08c232a3e0ee5b4e31b18e40e4ae1c63df47d28c0e3b2b1dd114c6902456351036acaf3a66afb2fe6b1e1ddb252eb0c5f210e174
|
7
|
+
data.tar.gz: f775c2be8b9b66783bf63ffc624335c02137cd73e228b2c396678fe5fd1d437d043267806712ca6f9b336d3d270b17b4e4a14d59dfb5091bdce44eaec0bae6a2
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-kendra/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::Kendra
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.13.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::Kendra
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::Kendra
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -471,12 +486,10 @@ module Aws::Kendra
|
|
471
486
|
|
472
487
|
# Creates a data source that you use to with an Amazon Kendra index.
|
473
488
|
#
|
474
|
-
# You specify a name, connector type and description for
|
475
|
-
# source. You
|
476
|
-
#
|
477
|
-
#
|
478
|
-
# You also specify configuration information such as document metadata
|
479
|
-
# (author, source URI, and so on) and user context information.
|
489
|
+
# You specify a name, data source connector type and description for
|
490
|
+
# your data source. You also specify configuration information such as
|
491
|
+
# document metadata (author, source URI, and so on) and user context
|
492
|
+
# information.
|
480
493
|
#
|
481
494
|
# `CreateDataSource` is a synchronous operation. The operation returns
|
482
495
|
# 200 if the data source was successfully created. Otherwise, an
|
@@ -494,8 +507,8 @@ module Aws::Kendra
|
|
494
507
|
# The type of repository that contains the data source.
|
495
508
|
#
|
496
509
|
# @option params [required, Types::DataSourceConfiguration] :configuration
|
497
|
-
# The connector configuration information that is required
|
498
|
-
# repository.
|
510
|
+
# The data source connector configuration information that is required
|
511
|
+
# to access the repository.
|
499
512
|
#
|
500
513
|
# @option params [String] :description
|
501
514
|
# A description for the data source.
|
@@ -592,6 +605,9 @@ module Aws::Kendra
|
|
592
605
|
# acl_configuration: {
|
593
606
|
# allowed_groups_column_name: "ColumnName", # required
|
594
607
|
# },
|
608
|
+
# sql_configuration: {
|
609
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
610
|
+
# },
|
595
611
|
# },
|
596
612
|
# salesforce_configuration: {
|
597
613
|
# server_url: "Url", # required
|
@@ -771,6 +787,20 @@ module Aws::Kendra
|
|
771
787
|
# to identify and organize your resources and to control access to
|
772
788
|
# resources.
|
773
789
|
#
|
790
|
+
# @option params [String] :file_format
|
791
|
+
# The format of the input file. You can choose between a basic CSV
|
792
|
+
# format, a CSV format that includes customs attributes in a header, and
|
793
|
+
# a JSON format that includes custom attributes.
|
794
|
+
#
|
795
|
+
# The format must match the format of the file stored in the S3 bucket
|
796
|
+
# identified in the `S3Path` parameter.
|
797
|
+
#
|
798
|
+
# For more information, see [Adding questions and answers][1].
|
799
|
+
#
|
800
|
+
#
|
801
|
+
#
|
802
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
|
803
|
+
#
|
774
804
|
# @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
775
805
|
#
|
776
806
|
# * {Types::CreateFaqResponse#id #id} => String
|
@@ -792,6 +822,7 @@ module Aws::Kendra
|
|
792
822
|
# value: "TagValue", # required
|
793
823
|
# },
|
794
824
|
# ],
|
825
|
+
# file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
|
795
826
|
# })
|
796
827
|
#
|
797
828
|
# @example Response structure
|
@@ -825,6 +856,9 @@ module Aws::Kendra
|
|
825
856
|
# databases. Once you set the edition for an index, it can't be
|
826
857
|
# changed.
|
827
858
|
#
|
859
|
+
# The `Edition` parameter is optional. If you don't supply a value, the
|
860
|
+
# default is `ENTERPRISE_EDITION`.
|
861
|
+
#
|
828
862
|
# @option params [required, String] :role_arn
|
829
863
|
# An IAM role that gives Amazon Kendra permissions to access your Amazon
|
830
864
|
# CloudWatch logs and metrics. This is also the role used when you use
|
@@ -1055,6 +1089,7 @@ module Aws::Kendra
|
|
1055
1089
|
# resp.configuration.database_configuration.column_configuration.change_detecting_columns #=> Array
|
1056
1090
|
# resp.configuration.database_configuration.column_configuration.change_detecting_columns[0] #=> String
|
1057
1091
|
# resp.configuration.database_configuration.acl_configuration.allowed_groups_column_name #=> String
|
1092
|
+
# resp.configuration.database_configuration.sql_configuration.query_identifiers_enclosing_option #=> String, one of "DOUBLE_QUOTES", "NONE"
|
1058
1093
|
# resp.configuration.salesforce_configuration.server_url #=> String
|
1059
1094
|
# resp.configuration.salesforce_configuration.secret_arn #=> String
|
1060
1095
|
# resp.configuration.salesforce_configuration.standard_object_configurations #=> Array
|
@@ -1175,6 +1210,7 @@ module Aws::Kendra
|
|
1175
1210
|
# * {Types::DescribeFaqResponse#status #status} => String
|
1176
1211
|
# * {Types::DescribeFaqResponse#role_arn #role_arn} => String
|
1177
1212
|
# * {Types::DescribeFaqResponse#error_message #error_message} => String
|
1213
|
+
# * {Types::DescribeFaqResponse#file_format #file_format} => String
|
1178
1214
|
#
|
1179
1215
|
# @example Request syntax with placeholder values
|
1180
1216
|
#
|
@@ -1196,6 +1232,7 @@ module Aws::Kendra
|
|
1196
1232
|
# resp.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
|
1197
1233
|
# resp.role_arn #=> String
|
1198
1234
|
# resp.error_message #=> String
|
1235
|
+
# resp.file_format #=> String, one of "CSV", "CSV_WITH_HEADER", "JSON"
|
1199
1236
|
#
|
1200
1237
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq AWS API Documentation
|
1201
1238
|
#
|
@@ -1256,6 +1293,7 @@ module Aws::Kendra
|
|
1256
1293
|
# resp.document_metadata_configurations[0].search.facetable #=> Boolean
|
1257
1294
|
# resp.document_metadata_configurations[0].search.searchable #=> Boolean
|
1258
1295
|
# resp.document_metadata_configurations[0].search.displayable #=> Boolean
|
1296
|
+
# resp.document_metadata_configurations[0].search.sortable #=> Boolean
|
1259
1297
|
# resp.index_statistics.faq_statistics.indexed_question_answers_count #=> Integer
|
1260
1298
|
# resp.index_statistics.text_document_statistics.indexed_text_documents_count #=> Integer
|
1261
1299
|
# resp.index_statistics.text_document_statistics.indexed_text_bytes #=> Integer
|
@@ -1429,6 +1467,7 @@ module Aws::Kendra
|
|
1429
1467
|
# resp.faq_summary_items[0].status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
|
1430
1468
|
# resp.faq_summary_items[0].created_at #=> Time
|
1431
1469
|
# resp.faq_summary_items[0].updated_at #=> Time
|
1470
|
+
# resp.faq_summary_items[0].file_format #=> String, one of "CSV", "CSV_WITH_HEADER", "JSON"
|
1432
1471
|
#
|
1433
1472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs AWS API Documentation
|
1434
1473
|
#
|
@@ -1536,6 +1575,8 @@ module Aws::Kendra
|
|
1536
1575
|
# You can specify that the query return only one type of result using
|
1537
1576
|
# the `QueryResultTypeConfig` parameter.
|
1538
1577
|
#
|
1578
|
+
# Each query returns the 100 most relevant results.
|
1579
|
+
#
|
1539
1580
|
# @option params [required, String] :index_id
|
1540
1581
|
# The unique identifier of the index to search. The identifier is
|
1541
1582
|
# returned in the response from the operation.
|
@@ -1577,6 +1618,16 @@ module Aws::Kendra
|
|
1577
1618
|
# The default page size is 10. The maximum number of results returned is
|
1578
1619
|
# 100. If you ask for more than 100 results, only 100 are returned.
|
1579
1620
|
#
|
1621
|
+
# @option params [Types::SortingConfiguration] :sorting_configuration
|
1622
|
+
# Provides information that determines how the results of the query are
|
1623
|
+
# sorted. You can set the field that Amazon Kendra should sort the
|
1624
|
+
# results on, and specify whether the results should be sorted in
|
1625
|
+
# ascending or descending order. In the case of ties in sorting the
|
1626
|
+
# results, the results are sorted by relevance.
|
1627
|
+
#
|
1628
|
+
# If you don't provide sorting configuration, the results are sorted by
|
1629
|
+
# the relevance that Amazon Kendra determines for the result.
|
1630
|
+
#
|
1580
1631
|
# @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1581
1632
|
#
|
1582
1633
|
# * {Types::QueryResult#query_id #query_id} => String
|
@@ -1676,6 +1727,10 @@ module Aws::Kendra
|
|
1676
1727
|
# query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
|
1677
1728
|
# page_number: 1,
|
1678
1729
|
# page_size: 1,
|
1730
|
+
# sorting_configuration: {
|
1731
|
+
# document_attribute_key: "DocumentAttributeKey", # required
|
1732
|
+
# sort_order: "DESC", # required, accepts DESC, ASC
|
1733
|
+
# },
|
1679
1734
|
# })
|
1680
1735
|
#
|
1681
1736
|
# @example Response structure
|
@@ -1711,8 +1766,10 @@ module Aws::Kendra
|
|
1711
1766
|
# resp.result_items[0].document_attributes[0].value.string_list_value[0] #=> String
|
1712
1767
|
# resp.result_items[0].document_attributes[0].value.long_value #=> Integer
|
1713
1768
|
# resp.result_items[0].document_attributes[0].value.date_value #=> Time
|
1769
|
+
# resp.result_items[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW"
|
1714
1770
|
# resp.facet_results #=> Array
|
1715
1771
|
# resp.facet_results[0].document_attribute_key #=> String
|
1772
|
+
# resp.facet_results[0].document_attribute_value_type #=> String, one of "STRING_VALUE", "STRING_LIST_VALUE", "LONG_VALUE", "DATE_VALUE"
|
1716
1773
|
# resp.facet_results[0].document_attribute_value_count_pairs #=> Array
|
1717
1774
|
# resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.string_value #=> String
|
1718
1775
|
# resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.string_list_value #=> Array
|
@@ -2000,6 +2057,9 @@ module Aws::Kendra
|
|
2000
2057
|
# acl_configuration: {
|
2001
2058
|
# allowed_groups_column_name: "ColumnName", # required
|
2002
2059
|
# },
|
2060
|
+
# sql_configuration: {
|
2061
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
2062
|
+
# },
|
2003
2063
|
# },
|
2004
2064
|
# salesforce_configuration: {
|
2005
2065
|
# server_url: "Url", # required
|
@@ -2192,6 +2252,7 @@ module Aws::Kendra
|
|
2192
2252
|
# facetable: false,
|
2193
2253
|
# searchable: false,
|
2194
2254
|
# displayable: false,
|
2255
|
+
# sortable: false,
|
2195
2256
|
# },
|
2196
2257
|
# },
|
2197
2258
|
# ],
|
@@ -2223,7 +2284,7 @@ module Aws::Kendra
|
|
2223
2284
|
params: params,
|
2224
2285
|
config: config)
|
2225
2286
|
context[:gem_name] = 'aws-sdk-kendra'
|
2226
|
-
context[:gem_version] = '1.
|
2287
|
+
context[:gem_version] = '1.13.0'
|
2227
2288
|
Seahorse::Client::Request.new(handlers, context)
|
2228
2289
|
end
|
2229
2290
|
|
@@ -110,6 +110,7 @@ module Aws::Kendra
|
|
110
110
|
FacetList = Shapes::ListShape.new(name: 'FacetList')
|
111
111
|
FacetResult = Shapes::StructureShape.new(name: 'FacetResult')
|
112
112
|
FacetResultList = Shapes::ListShape.new(name: 'FacetResultList')
|
113
|
+
FaqFileFormat = Shapes::StringShape.new(name: 'FaqFileFormat')
|
113
114
|
FaqId = Shapes::StringShape.new(name: 'FaqId')
|
114
115
|
FaqName = Shapes::StringShape.new(name: 'FaqName')
|
115
116
|
FaqStatistics = Shapes::StructureShape.new(name: 'FaqStatistics')
|
@@ -161,6 +162,7 @@ module Aws::Kendra
|
|
161
162
|
PrincipalType = Shapes::StringShape.new(name: 'PrincipalType')
|
162
163
|
QueryCapacityUnit = Shapes::IntegerShape.new(name: 'QueryCapacityUnit')
|
163
164
|
QueryId = Shapes::StringShape.new(name: 'QueryId')
|
165
|
+
QueryIdentifiersEnclosingOption = Shapes::StringShape.new(name: 'QueryIdentifiersEnclosingOption')
|
164
166
|
QueryRequest = Shapes::StructureShape.new(name: 'QueryRequest')
|
165
167
|
QueryResult = Shapes::StructureShape.new(name: 'QueryResult')
|
166
168
|
QueryResultItem = Shapes::StructureShape.new(name: 'QueryResultItem')
|
@@ -198,6 +200,8 @@ module Aws::Kendra
|
|
198
200
|
SalesforceStandardObjectConfigurationList = Shapes::ListShape.new(name: 'SalesforceStandardObjectConfigurationList')
|
199
201
|
SalesforceStandardObjectName = Shapes::StringShape.new(name: 'SalesforceStandardObjectName')
|
200
202
|
ScanSchedule = Shapes::StringShape.new(name: 'ScanSchedule')
|
203
|
+
ScoreAttributes = Shapes::StructureShape.new(name: 'ScoreAttributes')
|
204
|
+
ScoreConfidence = Shapes::StringShape.new(name: 'ScoreConfidence')
|
201
205
|
Search = Shapes::StructureShape.new(name: 'Search')
|
202
206
|
SecretArn = Shapes::StringShape.new(name: 'SecretArn')
|
203
207
|
SecurityGroupIdList = Shapes::ListShape.new(name: 'SecurityGroupIdList')
|
@@ -211,6 +215,9 @@ module Aws::Kendra
|
|
211
215
|
SharePointConfiguration = Shapes::StructureShape.new(name: 'SharePointConfiguration')
|
212
216
|
SharePointUrlList = Shapes::ListShape.new(name: 'SharePointUrlList')
|
213
217
|
SharePointVersion = Shapes::StringShape.new(name: 'SharePointVersion')
|
218
|
+
SortOrder = Shapes::StringShape.new(name: 'SortOrder')
|
219
|
+
SortingConfiguration = Shapes::StructureShape.new(name: 'SortingConfiguration')
|
220
|
+
SqlConfiguration = Shapes::StructureShape.new(name: 'SqlConfiguration')
|
214
221
|
StartDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StartDataSourceSyncJobRequest')
|
215
222
|
StartDataSourceSyncJobResponse = Shapes::StructureShape.new(name: 'StartDataSourceSyncJobResponse')
|
216
223
|
StopDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StopDataSourceSyncJobRequest')
|
@@ -355,6 +362,7 @@ module Aws::Kendra
|
|
355
362
|
CreateFaqRequest.add_member(:s3_path, Shapes::ShapeRef.new(shape: S3Path, required: true, location_name: "S3Path"))
|
356
363
|
CreateFaqRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
|
357
364
|
CreateFaqRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
365
|
+
CreateFaqRequest.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
358
366
|
CreateFaqRequest.struct_class = Types::CreateFaqRequest
|
359
367
|
|
360
368
|
CreateFaqResponse.add_member(:id, Shapes::ShapeRef.new(shape: FaqId, location_name: "Id"))
|
@@ -431,6 +439,7 @@ module Aws::Kendra
|
|
431
439
|
DatabaseConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
|
432
440
|
DatabaseConfiguration.add_member(:column_configuration, Shapes::ShapeRef.new(shape: ColumnConfiguration, required: true, location_name: "ColumnConfiguration"))
|
433
441
|
DatabaseConfiguration.add_member(:acl_configuration, Shapes::ShapeRef.new(shape: AclConfiguration, location_name: "AclConfiguration"))
|
442
|
+
DatabaseConfiguration.add_member(:sql_configuration, Shapes::ShapeRef.new(shape: SqlConfiguration, location_name: "SqlConfiguration"))
|
434
443
|
DatabaseConfiguration.struct_class = Types::DatabaseConfiguration
|
435
444
|
|
436
445
|
DeleteDataSourceRequest.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
|
@@ -476,6 +485,7 @@ module Aws::Kendra
|
|
476
485
|
DescribeFaqResponse.add_member(:status, Shapes::ShapeRef.new(shape: FaqStatus, location_name: "Status"))
|
477
486
|
DescribeFaqResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
478
487
|
DescribeFaqResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
488
|
+
DescribeFaqResponse.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
479
489
|
DescribeFaqResponse.struct_class = Types::DescribeFaqResponse
|
480
490
|
|
481
491
|
DescribeIndexRequest.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "Id"))
|
@@ -548,6 +558,7 @@ module Aws::Kendra
|
|
548
558
|
FacetList.member = Shapes::ShapeRef.new(shape: Facet)
|
549
559
|
|
550
560
|
FacetResult.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, location_name: "DocumentAttributeKey"))
|
561
|
+
FacetResult.add_member(:document_attribute_value_type, Shapes::ShapeRef.new(shape: DocumentAttributeValueType, location_name: "DocumentAttributeValueType"))
|
551
562
|
FacetResult.add_member(:document_attribute_value_count_pairs, Shapes::ShapeRef.new(shape: DocumentAttributeValueCountPairList, location_name: "DocumentAttributeValueCountPairs"))
|
552
563
|
FacetResult.struct_class = Types::FacetResult
|
553
564
|
|
@@ -561,6 +572,7 @@ module Aws::Kendra
|
|
561
572
|
FaqSummary.add_member(:status, Shapes::ShapeRef.new(shape: FaqStatus, location_name: "Status"))
|
562
573
|
FaqSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
563
574
|
FaqSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
575
|
+
FaqSummary.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
564
576
|
FaqSummary.struct_class = Types::FaqSummary
|
565
577
|
|
566
578
|
FaqSummaryItems.member = Shapes::ShapeRef.new(shape: FaqSummary)
|
@@ -662,6 +674,7 @@ module Aws::Kendra
|
|
662
674
|
QueryRequest.add_member(:query_result_type_filter, Shapes::ShapeRef.new(shape: QueryResultType, location_name: "QueryResultTypeFilter"))
|
663
675
|
QueryRequest.add_member(:page_number, Shapes::ShapeRef.new(shape: Integer, location_name: "PageNumber"))
|
664
676
|
QueryRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: Integer, location_name: "PageSize"))
|
677
|
+
QueryRequest.add_member(:sorting_configuration, Shapes::ShapeRef.new(shape: SortingConfiguration, location_name: "SortingConfiguration"))
|
665
678
|
QueryRequest.struct_class = Types::QueryRequest
|
666
679
|
|
667
680
|
QueryResult.add_member(:query_id, Shapes::ShapeRef.new(shape: QueryId, location_name: "QueryId"))
|
@@ -678,6 +691,7 @@ module Aws::Kendra
|
|
678
691
|
QueryResultItem.add_member(:document_excerpt, Shapes::ShapeRef.new(shape: TextWithHighlights, location_name: "DocumentExcerpt"))
|
679
692
|
QueryResultItem.add_member(:document_uri, Shapes::ShapeRef.new(shape: Url, location_name: "DocumentURI"))
|
680
693
|
QueryResultItem.add_member(:document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "DocumentAttributes"))
|
694
|
+
QueryResultItem.add_member(:score_attributes, Shapes::ShapeRef.new(shape: ScoreAttributes, location_name: "ScoreAttributes"))
|
681
695
|
QueryResultItem.struct_class = Types::QueryResultItem
|
682
696
|
|
683
697
|
QueryResultItemList.member = Shapes::ShapeRef.new(shape: QueryResultItem)
|
@@ -769,9 +783,13 @@ module Aws::Kendra
|
|
769
783
|
|
770
784
|
SalesforceStandardObjectConfigurationList.member = Shapes::ShapeRef.new(shape: SalesforceStandardObjectConfiguration)
|
771
785
|
|
786
|
+
ScoreAttributes.add_member(:score_confidence, Shapes::ShapeRef.new(shape: ScoreConfidence, location_name: "ScoreConfidence"))
|
787
|
+
ScoreAttributes.struct_class = Types::ScoreAttributes
|
788
|
+
|
772
789
|
Search.add_member(:facetable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Facetable"))
|
773
790
|
Search.add_member(:searchable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Searchable"))
|
774
791
|
Search.add_member(:displayable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Displayable"))
|
792
|
+
Search.add_member(:sortable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Sortable"))
|
775
793
|
Search.struct_class = Types::Search
|
776
794
|
|
777
795
|
SecurityGroupIdList.member = Shapes::ShapeRef.new(shape: VpcSecurityGroupId)
|
@@ -819,6 +837,13 @@ module Aws::Kendra
|
|
819
837
|
|
820
838
|
SharePointUrlList.member = Shapes::ShapeRef.new(shape: Url)
|
821
839
|
|
840
|
+
SortingConfiguration.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, required: true, location_name: "DocumentAttributeKey"))
|
841
|
+
SortingConfiguration.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "SortOrder"))
|
842
|
+
SortingConfiguration.struct_class = Types::SortingConfiguration
|
843
|
+
|
844
|
+
SqlConfiguration.add_member(:query_identifiers_enclosing_option, Shapes::ShapeRef.new(shape: QueryIdentifiersEnclosingOption, location_name: "QueryIdentifiersEnclosingOption"))
|
845
|
+
SqlConfiguration.struct_class = Types::SqlConfiguration
|
846
|
+
|
822
847
|
StartDataSourceSyncJobRequest.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
|
823
848
|
StartDataSourceSyncJobRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
824
849
|
StartDataSourceSyncJobRequest.struct_class = Types::StartDataSourceSyncJobRequest
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -439,13 +439,13 @@ module Aws::Kendra
|
|
439
439
|
#
|
440
440
|
# @!attribute [rw] contains_all
|
441
441
|
# Returns true when a document contains all of the specified document
|
442
|
-
# attributes. This filter is only
|
442
|
+
# attributes. This filter is only applicable to `StringListValue`
|
443
443
|
# metadata.
|
444
444
|
# @return [Types::DocumentAttribute]
|
445
445
|
#
|
446
446
|
# @!attribute [rw] contains_any
|
447
447
|
# Returns true when a document contains any of the specified document
|
448
|
-
# attributes.This filter is only
|
448
|
+
# attributes. This filter is only applicable to `StringListValue`
|
449
449
|
# metadata.
|
450
450
|
# @return [Types::DocumentAttribute]
|
451
451
|
#
|
@@ -942,6 +942,9 @@ module Aws::Kendra
|
|
942
942
|
# acl_configuration: {
|
943
943
|
# allowed_groups_column_name: "ColumnName", # required
|
944
944
|
# },
|
945
|
+
# sql_configuration: {
|
946
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
947
|
+
# },
|
945
948
|
# },
|
946
949
|
# salesforce_configuration: {
|
947
950
|
# server_url: "Url", # required
|
@@ -1094,8 +1097,8 @@ module Aws::Kendra
|
|
1094
1097
|
# @return [String]
|
1095
1098
|
#
|
1096
1099
|
# @!attribute [rw] configuration
|
1097
|
-
# The connector configuration information that is required
|
1098
|
-
# the repository.
|
1100
|
+
# The data source connector configuration information that is required
|
1101
|
+
# to access the repository.
|
1099
1102
|
# @return [Types::DataSourceConfiguration]
|
1100
1103
|
#
|
1101
1104
|
# @!attribute [rw] description
|
@@ -1170,6 +1173,7 @@ module Aws::Kendra
|
|
1170
1173
|
# value: "TagValue", # required
|
1171
1174
|
# },
|
1172
1175
|
# ],
|
1176
|
+
# file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
|
1173
1177
|
# }
|
1174
1178
|
#
|
1175
1179
|
# @!attribute [rw] index_id
|
@@ -1204,6 +1208,21 @@ module Aws::Kendra
|
|
1204
1208
|
# to resources.
|
1205
1209
|
# @return [Array<Types::Tag>]
|
1206
1210
|
#
|
1211
|
+
# @!attribute [rw] file_format
|
1212
|
+
# The format of the input file. You can choose between a basic CSV
|
1213
|
+
# format, a CSV format that includes customs attributes in a header,
|
1214
|
+
# and a JSON format that includes custom attributes.
|
1215
|
+
#
|
1216
|
+
# The format must match the format of the file stored in the S3 bucket
|
1217
|
+
# identified in the `S3Path` parameter.
|
1218
|
+
#
|
1219
|
+
# For more information, see [Adding questions and answers][1].
|
1220
|
+
#
|
1221
|
+
#
|
1222
|
+
#
|
1223
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
|
1224
|
+
# @return [String]
|
1225
|
+
#
|
1207
1226
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqRequest AWS API Documentation
|
1208
1227
|
#
|
1209
1228
|
class CreateFaqRequest < Struct.new(
|
@@ -1212,7 +1231,8 @@ module Aws::Kendra
|
|
1212
1231
|
:description,
|
1213
1232
|
:s3_path,
|
1214
1233
|
:role_arn,
|
1215
|
-
:tags
|
1234
|
+
:tags,
|
1235
|
+
:file_format)
|
1216
1236
|
SENSITIVE = []
|
1217
1237
|
include Aws::Structure
|
1218
1238
|
end
|
@@ -1259,6 +1279,9 @@ module Aws::Kendra
|
|
1259
1279
|
# or proof of concept. Use `ENTERPRISE_EDITION` for your production
|
1260
1280
|
# databases. Once you set the edition for an index, it can't be
|
1261
1281
|
# changed.
|
1282
|
+
#
|
1283
|
+
# The `Edition` parameter is optional. If you don't supply a value,
|
1284
|
+
# the default is `ENTERPRISE_EDITION`.
|
1262
1285
|
# @return [String]
|
1263
1286
|
#
|
1264
1287
|
# @!attribute [rw] role_arn
|
@@ -1387,6 +1410,9 @@ module Aws::Kendra
|
|
1387
1410
|
# acl_configuration: {
|
1388
1411
|
# allowed_groups_column_name: "ColumnName", # required
|
1389
1412
|
# },
|
1413
|
+
# sql_configuration: {
|
1414
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
1415
|
+
# },
|
1390
1416
|
# },
|
1391
1417
|
# salesforce_configuration: {
|
1392
1418
|
# server_url: "Url", # required
|
@@ -1515,17 +1541,18 @@ module Aws::Kendra
|
|
1515
1541
|
# }
|
1516
1542
|
#
|
1517
1543
|
# @!attribute [rw] s3_configuration
|
1518
|
-
# Provides information to create a connector for a
|
1519
|
-
# in an Amazon S3 bucket.
|
1544
|
+
# Provides information to create a data source connector for a
|
1545
|
+
# document repository in an Amazon S3 bucket.
|
1520
1546
|
# @return [Types::S3DataSourceConfiguration]
|
1521
1547
|
#
|
1522
1548
|
# @!attribute [rw] share_point_configuration
|
1523
|
-
# Provides information necessary to create a connector for
|
1524
|
-
# SharePoint site.
|
1549
|
+
# Provides information necessary to create a data source connector for
|
1550
|
+
# a Microsoft SharePoint site.
|
1525
1551
|
# @return [Types::SharePointConfiguration]
|
1526
1552
|
#
|
1527
1553
|
# @!attribute [rw] database_configuration
|
1528
|
-
# Provides information necessary to create a connector for
|
1554
|
+
# Provides information necessary to create a data source connector for
|
1555
|
+
# a database.
|
1529
1556
|
# @return [Types::DatabaseConfiguration]
|
1530
1557
|
#
|
1531
1558
|
# @!attribute [rw] salesforce_configuration
|
@@ -1638,7 +1665,7 @@ module Aws::Kendra
|
|
1638
1665
|
# @!attribute [rw] metrics
|
1639
1666
|
# Maps a batch delete document request to a specific data source sync
|
1640
1667
|
# job. This is optional and should only be supplied when documents are
|
1641
|
-
# deleted by a connector.
|
1668
|
+
# deleted by a data source connector.
|
1642
1669
|
# @return [Types::DataSourceSyncJobMetrics]
|
1643
1670
|
#
|
1644
1671
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJob AWS API Documentation
|
@@ -1685,7 +1712,7 @@ module Aws::Kendra
|
|
1685
1712
|
|
1686
1713
|
# Maps a batch delete document request to a specific data source sync
|
1687
1714
|
# job. This is optional and should only be supplied when documents are
|
1688
|
-
# deleted by a connector.
|
1715
|
+
# deleted by a data source connector.
|
1689
1716
|
#
|
1690
1717
|
# @!attribute [rw] documents_added
|
1691
1718
|
# The number of documents added from the data source up to now in the
|
@@ -1824,6 +1851,9 @@ module Aws::Kendra
|
|
1824
1851
|
# acl_configuration: {
|
1825
1852
|
# allowed_groups_column_name: "ColumnName", # required
|
1826
1853
|
# },
|
1854
|
+
# sql_configuration: {
|
1855
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
1856
|
+
# },
|
1827
1857
|
# }
|
1828
1858
|
#
|
1829
1859
|
# @!attribute [rw] database_engine_type
|
@@ -1848,6 +1878,11 @@ module Aws::Kendra
|
|
1848
1878
|
# user context filtering.
|
1849
1879
|
# @return [Types::AclConfiguration]
|
1850
1880
|
#
|
1881
|
+
# @!attribute [rw] sql_configuration
|
1882
|
+
# Provides information about how Amazon Kendra uses quote marks around
|
1883
|
+
# SQL identifiers when querying a database data source.
|
1884
|
+
# @return [Types::SqlConfiguration]
|
1885
|
+
#
|
1851
1886
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DatabaseConfiguration AWS API Documentation
|
1852
1887
|
#
|
1853
1888
|
class DatabaseConfiguration < Struct.new(
|
@@ -1855,7 +1890,8 @@ module Aws::Kendra
|
|
1855
1890
|
:connection_configuration,
|
1856
1891
|
:vpc_configuration,
|
1857
1892
|
:column_configuration,
|
1858
|
-
:acl_configuration
|
1893
|
+
:acl_configuration,
|
1894
|
+
:sql_configuration)
|
1859
1895
|
SENSITIVE = []
|
1860
1896
|
include Aws::Structure
|
1861
1897
|
end
|
@@ -2097,6 +2133,10 @@ module Aws::Kendra
|
|
2097
2133
|
# the reason why the FAQ failed.
|
2098
2134
|
# @return [String]
|
2099
2135
|
#
|
2136
|
+
# @!attribute [rw] file_format
|
2137
|
+
# The file format used by the input files for the FAQ.
|
2138
|
+
# @return [String]
|
2139
|
+
#
|
2100
2140
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqResponse AWS API Documentation
|
2101
2141
|
#
|
2102
2142
|
class DescribeFaqResponse < Struct.new(
|
@@ -2109,7 +2149,8 @@ module Aws::Kendra
|
|
2109
2149
|
:s3_path,
|
2110
2150
|
:status,
|
2111
2151
|
:role_arn,
|
2112
|
-
:error_message
|
2152
|
+
:error_message,
|
2153
|
+
:file_format)
|
2113
2154
|
SENSITIVE = []
|
2114
2155
|
include Aws::Structure
|
2115
2156
|
end
|
@@ -2360,7 +2401,7 @@ module Aws::Kendra
|
|
2360
2401
|
# @return [Integer]
|
2361
2402
|
#
|
2362
2403
|
# @!attribute [rw] date_value
|
2363
|
-
# A date
|
2404
|
+
# A date expressed as an ISO 8601 string.
|
2364
2405
|
# @return [Time]
|
2365
2406
|
#
|
2366
2407
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
|
@@ -2416,6 +2457,7 @@ module Aws::Kendra
|
|
2416
2457
|
# facetable: false,
|
2417
2458
|
# searchable: false,
|
2418
2459
|
# displayable: false,
|
2460
|
+
# sortable: false,
|
2419
2461
|
# },
|
2420
2462
|
# }
|
2421
2463
|
#
|
@@ -2501,6 +2543,11 @@ module Aws::Kendra
|
|
2501
2543
|
# `DocumentAttributeKey` provided in the query.
|
2502
2544
|
# @return [String]
|
2503
2545
|
#
|
2546
|
+
# @!attribute [rw] document_attribute_value_type
|
2547
|
+
# The data type of the facet value. This is the same as the type
|
2548
|
+
# defined for the index field when it was created.
|
2549
|
+
# @return [String]
|
2550
|
+
#
|
2504
2551
|
# @!attribute [rw] document_attribute_value_count_pairs
|
2505
2552
|
# An array of key/value pairs, where the key is the value of the
|
2506
2553
|
# attribute and the count is the number of documents that share the
|
@@ -2511,6 +2558,7 @@ module Aws::Kendra
|
|
2511
2558
|
#
|
2512
2559
|
class FacetResult < Struct.new(
|
2513
2560
|
:document_attribute_key,
|
2561
|
+
:document_attribute_value_type,
|
2514
2562
|
:document_attribute_value_count_pairs)
|
2515
2563
|
SENSITIVE = []
|
2516
2564
|
include Aws::Structure
|
@@ -2557,6 +2605,10 @@ module Aws::Kendra
|
|
2557
2605
|
# The UNIX datetime that the FAQ was last updated.
|
2558
2606
|
# @return [Time]
|
2559
2607
|
#
|
2608
|
+
# @!attribute [rw] file_format
|
2609
|
+
# The file type used to create the FAQ.
|
2610
|
+
# @return [String]
|
2611
|
+
#
|
2560
2612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FaqSummary AWS API Documentation
|
2561
2613
|
#
|
2562
2614
|
class FaqSummary < Struct.new(
|
@@ -2564,7 +2616,8 @@ module Aws::Kendra
|
|
2564
2616
|
:name,
|
2565
2617
|
:status,
|
2566
2618
|
:created_at,
|
2567
|
-
:updated_at
|
2619
|
+
:updated_at,
|
2620
|
+
:file_format)
|
2568
2621
|
SENSITIVE = []
|
2569
2622
|
include Aws::Structure
|
2570
2623
|
end
|
@@ -3180,6 +3233,10 @@ module Aws::Kendra
|
|
3180
3233
|
# query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
|
3181
3234
|
# page_number: 1,
|
3182
3235
|
# page_size: 1,
|
3236
|
+
# sorting_configuration: {
|
3237
|
+
# document_attribute_key: "DocumentAttributeKey", # required
|
3238
|
+
# sort_order: "DESC", # required, accepts DESC, ASC
|
3239
|
+
# },
|
3183
3240
|
# }
|
3184
3241
|
#
|
3185
3242
|
# @!attribute [rw] index_id
|
@@ -3232,6 +3289,17 @@ module Aws::Kendra
|
|
3232
3289
|
# returned.
|
3233
3290
|
# @return [Integer]
|
3234
3291
|
#
|
3292
|
+
# @!attribute [rw] sorting_configuration
|
3293
|
+
# Provides information that determines how the results of the query
|
3294
|
+
# are sorted. You can set the field that Amazon Kendra should sort the
|
3295
|
+
# results on, and specify whether the results should be sorted in
|
3296
|
+
# ascending or descending order. In the case of ties in sorting the
|
3297
|
+
# results, the results are sorted by relevance.
|
3298
|
+
#
|
3299
|
+
# If you don't provide sorting configuration, the results are sorted
|
3300
|
+
# by the relevance that Amazon Kendra determines for the result.
|
3301
|
+
# @return [Types::SortingConfiguration]
|
3302
|
+
#
|
3235
3303
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
|
3236
3304
|
#
|
3237
3305
|
class QueryRequest < Struct.new(
|
@@ -3242,7 +3310,8 @@ module Aws::Kendra
|
|
3242
3310
|
:requested_document_attributes,
|
3243
3311
|
:query_result_type_filter,
|
3244
3312
|
:page_number,
|
3245
|
-
:page_size
|
3313
|
+
:page_size,
|
3314
|
+
:sorting_configuration)
|
3246
3315
|
SENSITIVE = []
|
3247
3316
|
include Aws::Structure
|
3248
3317
|
end
|
@@ -3263,8 +3332,9 @@ module Aws::Kendra
|
|
3263
3332
|
# @return [Array<Types::FacetResult>]
|
3264
3333
|
#
|
3265
3334
|
# @!attribute [rw] total_number_of_results
|
3266
|
-
# The number of items
|
3267
|
-
#
|
3335
|
+
# The total number of items found by the search; however, you can only
|
3336
|
+
# retrieve up to 100 items. For example, if the search found 192
|
3337
|
+
# items, you can only retrieve the first 100 of the items.
|
3268
3338
|
# @return [Integer]
|
3269
3339
|
#
|
3270
3340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
|
@@ -3294,7 +3364,7 @@ module Aws::Kendra
|
|
3294
3364
|
# @return [String]
|
3295
3365
|
#
|
3296
3366
|
# @!attribute [rw] additional_attributes
|
3297
|
-
# One or more additional
|
3367
|
+
# One or more additional attributes associated with the query result.
|
3298
3368
|
# @return [Array<Types::AdditionalResultAttribute>]
|
3299
3369
|
#
|
3300
3370
|
# @!attribute [rw] document_id
|
@@ -3321,6 +3391,18 @@ module Aws::Kendra
|
|
3321
3391
|
# source URI (SourceUri) of the document.
|
3322
3392
|
# @return [Array<Types::DocumentAttribute>]
|
3323
3393
|
#
|
3394
|
+
# @!attribute [rw] score_attributes
|
3395
|
+
# Indicates the confidence that Amazon Kendra has that a result
|
3396
|
+
# matches the query that you provided. Each result is placed into a
|
3397
|
+
# bin that indicates the confidence, `VERY_HIGH`, `HIGH`, `MEDIUM` and
|
3398
|
+
# `LOW`. You can use the score to determine if a response meets the
|
3399
|
+
# confidence needed for your application.
|
3400
|
+
#
|
3401
|
+
# The field is only set to `LOW` when the `Type` field is set to
|
3402
|
+
# `DOCUMENT` and Amazon Kendra is not confident that the result
|
3403
|
+
# matches the query.
|
3404
|
+
# @return [Types::ScoreAttributes]
|
3405
|
+
#
|
3324
3406
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation
|
3325
3407
|
#
|
3326
3408
|
class QueryResultItem < Struct.new(
|
@@ -3331,7 +3413,8 @@ module Aws::Kendra
|
|
3331
3413
|
:document_title,
|
3332
3414
|
:document_excerpt,
|
3333
3415
|
:document_uri,
|
3334
|
-
:document_attributes
|
3416
|
+
:document_attributes,
|
3417
|
+
:score_attributes)
|
3335
3418
|
SENSITIVE = []
|
3336
3419
|
include Aws::Structure
|
3337
3420
|
end
|
@@ -4046,6 +4129,21 @@ module Aws::Kendra
|
|
4046
4129
|
include Aws::Structure
|
4047
4130
|
end
|
4048
4131
|
|
4132
|
+
# Provides a relative ranking that indicates how confident Amazon Kendra
|
4133
|
+
# is that the response matches the query.
|
4134
|
+
#
|
4135
|
+
# @!attribute [rw] score_confidence
|
4136
|
+
# A relative ranking for how well the response matches the query.
|
4137
|
+
# @return [String]
|
4138
|
+
#
|
4139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ScoreAttributes AWS API Documentation
|
4140
|
+
#
|
4141
|
+
class ScoreAttributes < Struct.new(
|
4142
|
+
:score_confidence)
|
4143
|
+
SENSITIVE = []
|
4144
|
+
include Aws::Structure
|
4145
|
+
end
|
4146
|
+
|
4049
4147
|
# Provides information about how a custom index field is used during a
|
4050
4148
|
# search.
|
4051
4149
|
#
|
@@ -4056,6 +4154,7 @@ module Aws::Kendra
|
|
4056
4154
|
# facetable: false,
|
4057
4155
|
# searchable: false,
|
4058
4156
|
# displayable: false,
|
4157
|
+
# sortable: false,
|
4059
4158
|
# }
|
4060
4159
|
#
|
4061
4160
|
# @!attribute [rw] facetable
|
@@ -4077,12 +4176,20 @@ module Aws::Kendra
|
|
4077
4176
|
# default is `true`.
|
4078
4177
|
# @return [Boolean]
|
4079
4178
|
#
|
4179
|
+
# @!attribute [rw] sortable
|
4180
|
+
# Determines whether the field can be used to sort the results of a
|
4181
|
+
# query. If you specify sorting on a field that does not have
|
4182
|
+
# `Sortable` set to `true`, Amazon Kendra returns an exception. The
|
4183
|
+
# default is `false`.
|
4184
|
+
# @return [Boolean]
|
4185
|
+
#
|
4080
4186
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Search AWS API Documentation
|
4081
4187
|
#
|
4082
4188
|
class Search < Struct.new(
|
4083
4189
|
:facetable,
|
4084
4190
|
:searchable,
|
4085
|
-
:displayable
|
4191
|
+
:displayable,
|
4192
|
+
:sortable)
|
4086
4193
|
SENSITIVE = []
|
4087
4194
|
include Aws::Structure
|
4088
4195
|
end
|
@@ -4407,7 +4514,7 @@ module Aws::Kendra
|
|
4407
4514
|
# @return [Array<String>]
|
4408
4515
|
#
|
4409
4516
|
# @!attribute [rw] exclusion_patterns
|
4410
|
-
# A list of
|
4517
|
+
# A list of regular expression patterns. Documents that match the
|
4411
4518
|
# patterns are excluded from the index. Documents that don't match
|
4412
4519
|
# the patterns are included in the index. If a document matches both
|
4413
4520
|
# an exclusion pattern and an inclusion pattern, the document is not
|
@@ -4454,6 +4561,100 @@ module Aws::Kendra
|
|
4454
4561
|
include Aws::Structure
|
4455
4562
|
end
|
4456
4563
|
|
4564
|
+
# Specifies the document attribute to use to sort the response to a
|
4565
|
+
# Amazon Kendra query. You can specify a single attribute for sorting.
|
4566
|
+
# The attribute must have the `Sortable` flag set to `true`, otherwise
|
4567
|
+
# Amazon Kendra returns an exception.
|
4568
|
+
#
|
4569
|
+
# You can sort attributes of the following types.
|
4570
|
+
#
|
4571
|
+
# * Date value
|
4572
|
+
#
|
4573
|
+
# * Long value
|
4574
|
+
#
|
4575
|
+
# * String value
|
4576
|
+
#
|
4577
|
+
# You can't sort attributes of the following type.
|
4578
|
+
#
|
4579
|
+
# * String list value
|
4580
|
+
#
|
4581
|
+
# ^
|
4582
|
+
#
|
4583
|
+
# @note When making an API call, you may pass SortingConfiguration
|
4584
|
+
# data as a hash:
|
4585
|
+
#
|
4586
|
+
# {
|
4587
|
+
# document_attribute_key: "DocumentAttributeKey", # required
|
4588
|
+
# sort_order: "DESC", # required, accepts DESC, ASC
|
4589
|
+
# }
|
4590
|
+
#
|
4591
|
+
# @!attribute [rw] document_attribute_key
|
4592
|
+
# The name of the document attribute used to sort the response. You
|
4593
|
+
# can use any field that has the `Sortable` flag set to true.
|
4594
|
+
#
|
4595
|
+
# You can also sort by any of the following built-in attributes:
|
4596
|
+
#
|
4597
|
+
# * \_category
|
4598
|
+
#
|
4599
|
+
# * \_created\_at
|
4600
|
+
#
|
4601
|
+
# * \_last\_updated\_at
|
4602
|
+
#
|
4603
|
+
# * \_version
|
4604
|
+
#
|
4605
|
+
# * \_view\_count
|
4606
|
+
# @return [String]
|
4607
|
+
#
|
4608
|
+
# @!attribute [rw] sort_order
|
4609
|
+
# The order that the results should be returned in. In case of ties,
|
4610
|
+
# the relevance assigned to the result by Amazon Kendra is used as the
|
4611
|
+
# tie-breaker.
|
4612
|
+
# @return [String]
|
4613
|
+
#
|
4614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SortingConfiguration AWS API Documentation
|
4615
|
+
#
|
4616
|
+
class SortingConfiguration < Struct.new(
|
4617
|
+
:document_attribute_key,
|
4618
|
+
:sort_order)
|
4619
|
+
SENSITIVE = []
|
4620
|
+
include Aws::Structure
|
4621
|
+
end
|
4622
|
+
|
4623
|
+
# Provides information that configures Amazon Kendra to use a SQL
|
4624
|
+
# database.
|
4625
|
+
#
|
4626
|
+
# @note When making an API call, you may pass SqlConfiguration
|
4627
|
+
# data as a hash:
|
4628
|
+
#
|
4629
|
+
# {
|
4630
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
4631
|
+
# }
|
4632
|
+
#
|
4633
|
+
# @!attribute [rw] query_identifiers_enclosing_option
|
4634
|
+
# Determines whether Amazon Kendra encloses SQL identifiers for tables
|
4635
|
+
# and column names in double quotes (") when making a database query.
|
4636
|
+
#
|
4637
|
+
# By default, Amazon Kendra passes SQL identifiers the way that they
|
4638
|
+
# are entered into the data source configuration. It does not change
|
4639
|
+
# the case of identifiers or enclose them in quotes.
|
4640
|
+
#
|
4641
|
+
# PostgreSQL internally converts uppercase characters to lower case
|
4642
|
+
# characters in identifiers unless they are quoted. Choosing this
|
4643
|
+
# option encloses identifiers in quotes so that PostgreSQL does not
|
4644
|
+
# convert the character's case.
|
4645
|
+
#
|
4646
|
+
# For MySQL databases, you must enable the `ansi_quotes` option when
|
4647
|
+
# you set this field to `DOUBLE_QUOTES`.
|
4648
|
+
# @return [String]
|
4649
|
+
#
|
4650
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SqlConfiguration AWS API Documentation
|
4651
|
+
#
|
4652
|
+
class SqlConfiguration < Struct.new(
|
4653
|
+
:query_identifiers_enclosing_option)
|
4654
|
+
SENSITIVE = []
|
4655
|
+
include Aws::Structure
|
4656
|
+
end
|
4657
|
+
|
4457
4658
|
# @note When making an API call, you may pass StartDataSourceSyncJobRequest
|
4458
4659
|
# data as a hash:
|
4459
4660
|
#
|
@@ -4811,6 +5012,9 @@ module Aws::Kendra
|
|
4811
5012
|
# acl_configuration: {
|
4812
5013
|
# allowed_groups_column_name: "ColumnName", # required
|
4813
5014
|
# },
|
5015
|
+
# sql_configuration: {
|
5016
|
+
# query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
|
5017
|
+
# },
|
4814
5018
|
# },
|
4815
5019
|
# salesforce_configuration: {
|
4816
5020
|
# server_url: "Url", # required
|
@@ -5012,6 +5216,7 @@ module Aws::Kendra
|
|
5012
5216
|
# facetable: false,
|
5013
5217
|
# searchable: false,
|
5014
5218
|
# displayable: false,
|
5219
|
+
# sortable: false,
|
5015
5220
|
# },
|
5016
5221
|
# },
|
5017
5222
|
# ],
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kendra
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.13.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-09-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|