aws-sdk-kendra 1.10.0 → 1.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-kendra.rb +2 -1
- data/lib/aws-sdk-kendra/client.rb +80 -19
- data/lib/aws-sdk-kendra/client_api.rb +16 -2
- data/lib/aws-sdk-kendra/types.rb +168 -30
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c77b5b18cc4e0ecb4bcc79d4ea634e97ab6ab111fbe61b0d4e9fc1e7a0c4eb4e
|
4
|
+
data.tar.gz: cd63a111a6d43ce21f5529422159df0105676114a7c74fac2589486caf988a1f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6b4292ac03075fe1c885c6887daa5340c5d4b448c3fea5a30cd50b0fef4f1a3a457d8f5223b187a7eb0303de713c43e8f8ce7dc8e3a6fc3365622fabf30e0843
|
7
|
+
data.tar.gz: 4a0571ccd44824781a50c68bbd7962caa7261f57a77b191297ba13dbff2d353a93c672237c45db93728ffe8bed6c073fa4fdb81189a889954510c43ee383a76d
|
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
|
|
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
|
|
47
48
|
# @!group service
|
48
49
|
module Aws::Kendra
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.15.0'
|
51
52
|
|
52
53
|
end
|
@@ -486,12 +486,10 @@ module Aws::Kendra
|
|
486
486
|
|
487
487
|
# Creates a data source that you use to with an Amazon Kendra index.
|
488
488
|
#
|
489
|
-
# You specify a name, connector type and description for
|
490
|
-
# source. You
|
491
|
-
#
|
492
|
-
#
|
493
|
-
# You also specify configuration information such as document metadata
|
494
|
-
# (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.
|
495
493
|
#
|
496
494
|
# `CreateDataSource` is a synchronous operation. The operation returns
|
497
495
|
# 200 if the data source was successfully created. Otherwise, an
|
@@ -508,10 +506,16 @@ module Aws::Kendra
|
|
508
506
|
# @option params [required, String] :type
|
509
507
|
# The type of repository that contains the data source.
|
510
508
|
#
|
511
|
-
# @option params [
|
509
|
+
# @option params [Types::DataSourceConfiguration] :configuration
|
512
510
|
# The connector configuration information that is required to access the
|
513
511
|
# repository.
|
514
512
|
#
|
513
|
+
# You can't specify the `Configuration` parameter when the `Type`
|
514
|
+
# parameter is set to `CUSTOM`. If you do, you receive a
|
515
|
+
# `ValidationException` exception.
|
516
|
+
#
|
517
|
+
# The `Configuration` parameter is required for all other data sources.
|
518
|
+
#
|
515
519
|
# @option params [String] :description
|
516
520
|
# A description for the data source.
|
517
521
|
#
|
@@ -521,11 +525,21 @@ module Aws::Kendra
|
|
521
525
|
# Kendra will not periodically update the index. You can call the
|
522
526
|
# `StartDataSourceSyncJob` operation to update the index.
|
523
527
|
#
|
524
|
-
#
|
528
|
+
# You can't specify the `Schedule` parameter when the `Type` parameter
|
529
|
+
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
530
|
+
# exception.
|
531
|
+
#
|
532
|
+
# @option params [String] :role_arn
|
525
533
|
# The Amazon Resource Name (ARN) of a role with permission to access the
|
526
534
|
# data source. For more information, see [IAM Roles for Amazon
|
527
535
|
# Kendra][1].
|
528
536
|
#
|
537
|
+
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
538
|
+
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
539
|
+
# exception.
|
540
|
+
#
|
541
|
+
# The `RoleArn` parameter is required for all other data sources.
|
542
|
+
#
|
529
543
|
#
|
530
544
|
#
|
531
545
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
@@ -535,6 +549,14 @@ module Aws::Kendra
|
|
535
549
|
# the tags to identify and organize your resources and to control access
|
536
550
|
# to resources.
|
537
551
|
#
|
552
|
+
# @option params [String] :client_token
|
553
|
+
# A token that you provide to identify the request to create a data
|
554
|
+
# source. Multiple calls to the `CreateDataSource` operation with the
|
555
|
+
# same client token will create only one data source.
|
556
|
+
#
|
557
|
+
# **A suitable default value is auto-generated.** You should normally
|
558
|
+
# not need to pass this option.**
|
559
|
+
#
|
538
560
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
539
561
|
#
|
540
562
|
# * {Types::CreateDataSourceResponse#id #id} => String
|
@@ -544,11 +566,12 @@ module Aws::Kendra
|
|
544
566
|
# resp = client.create_data_source({
|
545
567
|
# name: "DataSourceName", # required
|
546
568
|
# index_id: "IndexId", # required
|
547
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW
|
548
|
-
# configuration: {
|
569
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM
|
570
|
+
# configuration: {
|
549
571
|
# s3_configuration: {
|
550
572
|
# bucket_name: "S3BucketName", # required
|
551
573
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
574
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
552
575
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
553
576
|
# documents_metadata_configuration: {
|
554
577
|
# s3_prefix: "S3ObjectKey",
|
@@ -738,13 +761,14 @@ module Aws::Kendra
|
|
738
761
|
# },
|
739
762
|
# description: "Description",
|
740
763
|
# schedule: "ScanSchedule",
|
741
|
-
# role_arn: "RoleArn",
|
764
|
+
# role_arn: "RoleArn",
|
742
765
|
# tags: [
|
743
766
|
# {
|
744
767
|
# key: "TagKey", # required
|
745
768
|
# value: "TagValue", # required
|
746
769
|
# },
|
747
770
|
# ],
|
771
|
+
# client_token: "ClientTokenName",
|
748
772
|
# })
|
749
773
|
#
|
750
774
|
# @example Response structure
|
@@ -789,6 +813,28 @@ module Aws::Kendra
|
|
789
813
|
# to identify and organize your resources and to control access to
|
790
814
|
# resources.
|
791
815
|
#
|
816
|
+
# @option params [String] :file_format
|
817
|
+
# The format of the input file. You can choose between a basic CSV
|
818
|
+
# format, a CSV format that includes customs attributes in a header, and
|
819
|
+
# a JSON format that includes custom attributes.
|
820
|
+
#
|
821
|
+
# The format must match the format of the file stored in the S3 bucket
|
822
|
+
# identified in the `S3Path` parameter.
|
823
|
+
#
|
824
|
+
# For more information, see [Adding questions and answers][1].
|
825
|
+
#
|
826
|
+
#
|
827
|
+
#
|
828
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
|
829
|
+
#
|
830
|
+
# @option params [String] :client_token
|
831
|
+
# A token that you provide to identify the request to create a FAQ.
|
832
|
+
# Multiple calls to the `CreateFaqRequest` operation with the same
|
833
|
+
# client token will create only one FAQ.
|
834
|
+
#
|
835
|
+
# **A suitable default value is auto-generated.** You should normally
|
836
|
+
# not need to pass this option.**
|
837
|
+
#
|
792
838
|
# @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
793
839
|
#
|
794
840
|
# * {Types::CreateFaqResponse#id #id} => String
|
@@ -810,6 +856,8 @@ module Aws::Kendra
|
|
810
856
|
# value: "TagValue", # required
|
811
857
|
# },
|
812
858
|
# ],
|
859
|
+
# file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
|
860
|
+
# client_token: "ClientTokenName",
|
813
861
|
# })
|
814
862
|
#
|
815
863
|
# @example Response structure
|
@@ -843,11 +891,14 @@ module Aws::Kendra
|
|
843
891
|
# databases. Once you set the edition for an index, it can't be
|
844
892
|
# changed.
|
845
893
|
#
|
894
|
+
# The `Edition` parameter is optional. If you don't supply a value, the
|
895
|
+
# default is `ENTERPRISE_EDITION`.
|
896
|
+
#
|
846
897
|
# @option params [required, String] :role_arn
|
847
|
-
# An
|
848
|
-
#
|
849
|
-
#
|
850
|
-
# bucket.
|
898
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
899
|
+
# Kendra permissions to access your Amazon CloudWatch logs and metrics.
|
900
|
+
# This is also the role used when you use the `BatchPutDocument`
|
901
|
+
# operation to index documents from an Amazon S3 bucket.
|
851
902
|
#
|
852
903
|
# @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
|
853
904
|
# The identifier of the AWS KMS customer managed key (CMK) to use to
|
@@ -860,7 +911,7 @@ module Aws::Kendra
|
|
860
911
|
# @option params [String] :client_token
|
861
912
|
# A token that you provide to identify the request to create an index.
|
862
913
|
# Multiple calls to the `CreateIndex` operation with the same client
|
863
|
-
# token will create only one index
|
914
|
+
# token will create only one index.
|
864
915
|
#
|
865
916
|
# **A suitable default value is auto-generated.** You should normally
|
866
917
|
# not need to pass this option.**
|
@@ -1026,10 +1077,12 @@ module Aws::Kendra
|
|
1026
1077
|
# resp.id #=> String
|
1027
1078
|
# resp.index_id #=> String
|
1028
1079
|
# resp.name #=> String
|
1029
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1080
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM"
|
1030
1081
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
1031
1082
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
1032
1083
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
1084
|
+
# resp.configuration.s3_configuration.inclusion_patterns #=> Array
|
1085
|
+
# resp.configuration.s3_configuration.inclusion_patterns[0] #=> String
|
1033
1086
|
# resp.configuration.s3_configuration.exclusion_patterns #=> Array
|
1034
1087
|
# resp.configuration.s3_configuration.exclusion_patterns[0] #=> String
|
1035
1088
|
# resp.configuration.s3_configuration.documents_metadata_configuration.s3_prefix #=> String
|
@@ -1194,6 +1247,7 @@ module Aws::Kendra
|
|
1194
1247
|
# * {Types::DescribeFaqResponse#status #status} => String
|
1195
1248
|
# * {Types::DescribeFaqResponse#role_arn #role_arn} => String
|
1196
1249
|
# * {Types::DescribeFaqResponse#error_message #error_message} => String
|
1250
|
+
# * {Types::DescribeFaqResponse#file_format #file_format} => String
|
1197
1251
|
#
|
1198
1252
|
# @example Request syntax with placeholder values
|
1199
1253
|
#
|
@@ -1215,6 +1269,7 @@ module Aws::Kendra
|
|
1215
1269
|
# resp.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
|
1216
1270
|
# resp.role_arn #=> String
|
1217
1271
|
# resp.error_message #=> String
|
1272
|
+
# resp.file_format #=> String, one of "CSV", "CSV_WITH_HEADER", "JSON"
|
1218
1273
|
#
|
1219
1274
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq AWS API Documentation
|
1220
1275
|
#
|
@@ -1398,7 +1453,7 @@ module Aws::Kendra
|
|
1398
1453
|
# resp.summary_items #=> Array
|
1399
1454
|
# resp.summary_items[0].name #=> String
|
1400
1455
|
# resp.summary_items[0].id #=> String
|
1401
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1456
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM"
|
1402
1457
|
# resp.summary_items[0].created_at #=> Time
|
1403
1458
|
# resp.summary_items[0].updated_at #=> Time
|
1404
1459
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -1449,6 +1504,7 @@ module Aws::Kendra
|
|
1449
1504
|
# resp.faq_summary_items[0].status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
|
1450
1505
|
# resp.faq_summary_items[0].created_at #=> Time
|
1451
1506
|
# resp.faq_summary_items[0].updated_at #=> Time
|
1507
|
+
# resp.faq_summary_items[0].file_format #=> String, one of "CSV", "CSV_WITH_HEADER", "JSON"
|
1452
1508
|
#
|
1453
1509
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs AWS API Documentation
|
1454
1510
|
#
|
@@ -1556,6 +1612,8 @@ module Aws::Kendra
|
|
1556
1612
|
# You can specify that the query return only one type of result using
|
1557
1613
|
# the `QueryResultTypeConfig` parameter.
|
1558
1614
|
#
|
1615
|
+
# Each query returns the 100 most relevant results.
|
1616
|
+
#
|
1559
1617
|
# @option params [required, String] :index_id
|
1560
1618
|
# The unique identifier of the index to search. The identifier is
|
1561
1619
|
# returned in the response from the operation.
|
@@ -1745,8 +1803,10 @@ module Aws::Kendra
|
|
1745
1803
|
# resp.result_items[0].document_attributes[0].value.string_list_value[0] #=> String
|
1746
1804
|
# resp.result_items[0].document_attributes[0].value.long_value #=> Integer
|
1747
1805
|
# resp.result_items[0].document_attributes[0].value.date_value #=> Time
|
1806
|
+
# resp.result_items[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW"
|
1748
1807
|
# resp.facet_results #=> Array
|
1749
1808
|
# resp.facet_results[0].document_attribute_key #=> String
|
1809
|
+
# resp.facet_results[0].document_attribute_value_type #=> String, one of "STRING_VALUE", "STRING_LIST_VALUE", "LONG_VALUE", "DATE_VALUE"
|
1750
1810
|
# resp.facet_results[0].document_attribute_value_count_pairs #=> Array
|
1751
1811
|
# resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.string_value #=> String
|
1752
1812
|
# resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.string_list_value #=> Array
|
@@ -1976,6 +2036,7 @@ module Aws::Kendra
|
|
1976
2036
|
# s3_configuration: {
|
1977
2037
|
# bucket_name: "S3BucketName", # required
|
1978
2038
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
2039
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1979
2040
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1980
2041
|
# documents_metadata_configuration: {
|
1981
2042
|
# s3_prefix: "S3ObjectKey",
|
@@ -2261,7 +2322,7 @@ module Aws::Kendra
|
|
2261
2322
|
params: params,
|
2262
2323
|
config: config)
|
2263
2324
|
context[:gem_name] = 'aws-sdk-kendra'
|
2264
|
-
context[:gem_version] = '1.
|
2325
|
+
context[:gem_version] = '1.15.0'
|
2265
2326
|
Seahorse::Client::Request.new(handlers, context)
|
2266
2327
|
end
|
2267
2328
|
|
@@ -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')
|
@@ -199,6 +200,8 @@ module Aws::Kendra
|
|
199
200
|
SalesforceStandardObjectConfigurationList = Shapes::ListShape.new(name: 'SalesforceStandardObjectConfigurationList')
|
200
201
|
SalesforceStandardObjectName = Shapes::StringShape.new(name: 'SalesforceStandardObjectName')
|
201
202
|
ScanSchedule = Shapes::StringShape.new(name: 'ScanSchedule')
|
203
|
+
ScoreAttributes = Shapes::StructureShape.new(name: 'ScoreAttributes')
|
204
|
+
ScoreConfidence = Shapes::StringShape.new(name: 'ScoreConfidence')
|
202
205
|
Search = Shapes::StructureShape.new(name: 'Search')
|
203
206
|
SecretArn = Shapes::StringShape.new(name: 'SecretArn')
|
204
207
|
SecurityGroupIdList = Shapes::ListShape.new(name: 'SecurityGroupIdList')
|
@@ -343,11 +346,12 @@ module Aws::Kendra
|
|
343
346
|
CreateDataSourceRequest.add_member(:name, Shapes::ShapeRef.new(shape: DataSourceName, required: true, location_name: "Name"))
|
344
347
|
CreateDataSourceRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
345
348
|
CreateDataSourceRequest.add_member(:type, Shapes::ShapeRef.new(shape: DataSourceType, required: true, location_name: "Type"))
|
346
|
-
CreateDataSourceRequest.add_member(:configuration, Shapes::ShapeRef.new(shape: DataSourceConfiguration,
|
349
|
+
CreateDataSourceRequest.add_member(:configuration, Shapes::ShapeRef.new(shape: DataSourceConfiguration, location_name: "Configuration"))
|
347
350
|
CreateDataSourceRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
348
351
|
CreateDataSourceRequest.add_member(:schedule, Shapes::ShapeRef.new(shape: ScanSchedule, location_name: "Schedule"))
|
349
|
-
CreateDataSourceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn,
|
352
|
+
CreateDataSourceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
350
353
|
CreateDataSourceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
354
|
+
CreateDataSourceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenName, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
351
355
|
CreateDataSourceRequest.struct_class = Types::CreateDataSourceRequest
|
352
356
|
|
353
357
|
CreateDataSourceResponse.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
|
@@ -359,6 +363,8 @@ module Aws::Kendra
|
|
359
363
|
CreateFaqRequest.add_member(:s3_path, Shapes::ShapeRef.new(shape: S3Path, required: true, location_name: "S3Path"))
|
360
364
|
CreateFaqRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
|
361
365
|
CreateFaqRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
366
|
+
CreateFaqRequest.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
367
|
+
CreateFaqRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenName, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
362
368
|
CreateFaqRequest.struct_class = Types::CreateFaqRequest
|
363
369
|
|
364
370
|
CreateFaqResponse.add_member(:id, Shapes::ShapeRef.new(shape: FaqId, location_name: "Id"))
|
@@ -481,6 +487,7 @@ module Aws::Kendra
|
|
481
487
|
DescribeFaqResponse.add_member(:status, Shapes::ShapeRef.new(shape: FaqStatus, location_name: "Status"))
|
482
488
|
DescribeFaqResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
483
489
|
DescribeFaqResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
490
|
+
DescribeFaqResponse.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
484
491
|
DescribeFaqResponse.struct_class = Types::DescribeFaqResponse
|
485
492
|
|
486
493
|
DescribeIndexRequest.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "Id"))
|
@@ -553,6 +560,7 @@ module Aws::Kendra
|
|
553
560
|
FacetList.member = Shapes::ShapeRef.new(shape: Facet)
|
554
561
|
|
555
562
|
FacetResult.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, location_name: "DocumentAttributeKey"))
|
563
|
+
FacetResult.add_member(:document_attribute_value_type, Shapes::ShapeRef.new(shape: DocumentAttributeValueType, location_name: "DocumentAttributeValueType"))
|
556
564
|
FacetResult.add_member(:document_attribute_value_count_pairs, Shapes::ShapeRef.new(shape: DocumentAttributeValueCountPairList, location_name: "DocumentAttributeValueCountPairs"))
|
557
565
|
FacetResult.struct_class = Types::FacetResult
|
558
566
|
|
@@ -566,6 +574,7 @@ module Aws::Kendra
|
|
566
574
|
FaqSummary.add_member(:status, Shapes::ShapeRef.new(shape: FaqStatus, location_name: "Status"))
|
567
575
|
FaqSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
568
576
|
FaqSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
577
|
+
FaqSummary.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
569
578
|
FaqSummary.struct_class = Types::FaqSummary
|
570
579
|
|
571
580
|
FaqSummaryItems.member = Shapes::ShapeRef.new(shape: FaqSummary)
|
@@ -684,6 +693,7 @@ module Aws::Kendra
|
|
684
693
|
QueryResultItem.add_member(:document_excerpt, Shapes::ShapeRef.new(shape: TextWithHighlights, location_name: "DocumentExcerpt"))
|
685
694
|
QueryResultItem.add_member(:document_uri, Shapes::ShapeRef.new(shape: Url, location_name: "DocumentURI"))
|
686
695
|
QueryResultItem.add_member(:document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "DocumentAttributes"))
|
696
|
+
QueryResultItem.add_member(:score_attributes, Shapes::ShapeRef.new(shape: ScoreAttributes, location_name: "ScoreAttributes"))
|
687
697
|
QueryResultItem.struct_class = Types::QueryResultItem
|
688
698
|
|
689
699
|
QueryResultItemList.member = Shapes::ShapeRef.new(shape: QueryResultItem)
|
@@ -715,6 +725,7 @@ module Aws::Kendra
|
|
715
725
|
|
716
726
|
S3DataSourceConfiguration.add_member(:bucket_name, Shapes::ShapeRef.new(shape: S3BucketName, required: true, location_name: "BucketName"))
|
717
727
|
S3DataSourceConfiguration.add_member(:inclusion_prefixes, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPrefixes"))
|
728
|
+
S3DataSourceConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
|
718
729
|
S3DataSourceConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
|
719
730
|
S3DataSourceConfiguration.add_member(:documents_metadata_configuration, Shapes::ShapeRef.new(shape: DocumentsMetadataConfiguration, location_name: "DocumentsMetadataConfiguration"))
|
720
731
|
S3DataSourceConfiguration.add_member(:access_control_list_configuration, Shapes::ShapeRef.new(shape: AccessControlListConfiguration, location_name: "AccessControlListConfiguration"))
|
@@ -775,6 +786,9 @@ module Aws::Kendra
|
|
775
786
|
|
776
787
|
SalesforceStandardObjectConfigurationList.member = Shapes::ShapeRef.new(shape: SalesforceStandardObjectConfiguration)
|
777
788
|
|
789
|
+
ScoreAttributes.add_member(:score_confidence, Shapes::ShapeRef.new(shape: ScoreConfidence, location_name: "ScoreConfidence"))
|
790
|
+
ScoreAttributes.struct_class = Types::ScoreAttributes
|
791
|
+
|
778
792
|
Search.add_member(:facetable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Facetable"))
|
779
793
|
Search.add_member(:searchable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Searchable"))
|
780
794
|
Search.add_member(:displayable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Displayable"))
|
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
|
#
|
@@ -879,11 +879,12 @@ module Aws::Kendra
|
|
879
879
|
# {
|
880
880
|
# name: "DataSourceName", # required
|
881
881
|
# index_id: "IndexId", # required
|
882
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW
|
883
|
-
# configuration: {
|
882
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM
|
883
|
+
# configuration: {
|
884
884
|
# s3_configuration: {
|
885
885
|
# bucket_name: "S3BucketName", # required
|
886
886
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
887
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
887
888
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
888
889
|
# documents_metadata_configuration: {
|
889
890
|
# s3_prefix: "S3ObjectKey",
|
@@ -1073,13 +1074,14 @@ module Aws::Kendra
|
|
1073
1074
|
# },
|
1074
1075
|
# description: "Description",
|
1075
1076
|
# schedule: "ScanSchedule",
|
1076
|
-
# role_arn: "RoleArn",
|
1077
|
+
# role_arn: "RoleArn",
|
1077
1078
|
# tags: [
|
1078
1079
|
# {
|
1079
1080
|
# key: "TagKey", # required
|
1080
1081
|
# value: "TagValue", # required
|
1081
1082
|
# },
|
1082
1083
|
# ],
|
1084
|
+
# client_token: "ClientTokenName",
|
1083
1085
|
# }
|
1084
1086
|
#
|
1085
1087
|
# @!attribute [rw] name
|
@@ -1099,6 +1101,13 @@ module Aws::Kendra
|
|
1099
1101
|
# @!attribute [rw] configuration
|
1100
1102
|
# The connector configuration information that is required to access
|
1101
1103
|
# the repository.
|
1104
|
+
#
|
1105
|
+
# You can't specify the `Configuration` parameter when the `Type`
|
1106
|
+
# parameter is set to `CUSTOM`. If you do, you receive a
|
1107
|
+
# `ValidationException` exception.
|
1108
|
+
#
|
1109
|
+
# The `Configuration` parameter is required for all other data
|
1110
|
+
# sources.
|
1102
1111
|
# @return [Types::DataSourceConfiguration]
|
1103
1112
|
#
|
1104
1113
|
# @!attribute [rw] description
|
@@ -1110,6 +1119,10 @@ module Aws::Kendra
|
|
1110
1119
|
# your repository and update the index. If you don't set a schedule
|
1111
1120
|
# Amazon Kendra will not periodically update the index. You can call
|
1112
1121
|
# the `StartDataSourceSyncJob` operation to update the index.
|
1122
|
+
#
|
1123
|
+
# You can't specify the `Schedule` parameter when the `Type`
|
1124
|
+
# parameter is set to `CUSTOM`. If you do, you receive a
|
1125
|
+
# `ValidationException` exception.
|
1113
1126
|
# @return [String]
|
1114
1127
|
#
|
1115
1128
|
# @!attribute [rw] role_arn
|
@@ -1117,6 +1130,12 @@ module Aws::Kendra
|
|
1117
1130
|
# the data source. For more information, see [IAM Roles for Amazon
|
1118
1131
|
# Kendra][1].
|
1119
1132
|
#
|
1133
|
+
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
1134
|
+
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
1135
|
+
# exception.
|
1136
|
+
#
|
1137
|
+
# The `RoleArn` parameter is required for all other data sources.
|
1138
|
+
#
|
1120
1139
|
#
|
1121
1140
|
#
|
1122
1141
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
@@ -1128,6 +1147,15 @@ module Aws::Kendra
|
|
1128
1147
|
# access to resources.
|
1129
1148
|
# @return [Array<Types::Tag>]
|
1130
1149
|
#
|
1150
|
+
# @!attribute [rw] client_token
|
1151
|
+
# A token that you provide to identify the request to create a data
|
1152
|
+
# source. Multiple calls to the `CreateDataSource` operation with the
|
1153
|
+
# same client token will create only one data source.
|
1154
|
+
#
|
1155
|
+
# **A suitable default value is auto-generated.** You should normally
|
1156
|
+
# not need to pass this option.
|
1157
|
+
# @return [String]
|
1158
|
+
#
|
1131
1159
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceRequest AWS API Documentation
|
1132
1160
|
#
|
1133
1161
|
class CreateDataSourceRequest < Struct.new(
|
@@ -1138,7 +1166,8 @@ module Aws::Kendra
|
|
1138
1166
|
:description,
|
1139
1167
|
:schedule,
|
1140
1168
|
:role_arn,
|
1141
|
-
:tags
|
1169
|
+
:tags,
|
1170
|
+
:client_token)
|
1142
1171
|
SENSITIVE = []
|
1143
1172
|
include Aws::Structure
|
1144
1173
|
end
|
@@ -1173,6 +1202,8 @@ module Aws::Kendra
|
|
1173
1202
|
# value: "TagValue", # required
|
1174
1203
|
# },
|
1175
1204
|
# ],
|
1205
|
+
# file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
|
1206
|
+
# client_token: "ClientTokenName",
|
1176
1207
|
# }
|
1177
1208
|
#
|
1178
1209
|
# @!attribute [rw] index_id
|
@@ -1207,6 +1238,30 @@ module Aws::Kendra
|
|
1207
1238
|
# to resources.
|
1208
1239
|
# @return [Array<Types::Tag>]
|
1209
1240
|
#
|
1241
|
+
# @!attribute [rw] file_format
|
1242
|
+
# The format of the input file. You can choose between a basic CSV
|
1243
|
+
# format, a CSV format that includes customs attributes in a header,
|
1244
|
+
# and a JSON format that includes custom attributes.
|
1245
|
+
#
|
1246
|
+
# The format must match the format of the file stored in the S3 bucket
|
1247
|
+
# identified in the `S3Path` parameter.
|
1248
|
+
#
|
1249
|
+
# For more information, see [Adding questions and answers][1].
|
1250
|
+
#
|
1251
|
+
#
|
1252
|
+
#
|
1253
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
|
1254
|
+
# @return [String]
|
1255
|
+
#
|
1256
|
+
# @!attribute [rw] client_token
|
1257
|
+
# A token that you provide to identify the request to create a FAQ.
|
1258
|
+
# Multiple calls to the `CreateFaqRequest` operation with the same
|
1259
|
+
# client token will create only one FAQ.
|
1260
|
+
#
|
1261
|
+
# **A suitable default value is auto-generated.** You should normally
|
1262
|
+
# not need to pass this option.
|
1263
|
+
# @return [String]
|
1264
|
+
#
|
1210
1265
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqRequest AWS API Documentation
|
1211
1266
|
#
|
1212
1267
|
class CreateFaqRequest < Struct.new(
|
@@ -1215,7 +1270,9 @@ module Aws::Kendra
|
|
1215
1270
|
:description,
|
1216
1271
|
:s3_path,
|
1217
1272
|
:role_arn,
|
1218
|
-
:tags
|
1273
|
+
:tags,
|
1274
|
+
:file_format,
|
1275
|
+
:client_token)
|
1219
1276
|
SENSITIVE = []
|
1220
1277
|
include Aws::Structure
|
1221
1278
|
end
|
@@ -1262,13 +1319,17 @@ module Aws::Kendra
|
|
1262
1319
|
# or proof of concept. Use `ENTERPRISE_EDITION` for your production
|
1263
1320
|
# databases. Once you set the edition for an index, it can't be
|
1264
1321
|
# changed.
|
1322
|
+
#
|
1323
|
+
# The `Edition` parameter is optional. If you don't supply a value,
|
1324
|
+
# the default is `ENTERPRISE_EDITION`.
|
1265
1325
|
# @return [String]
|
1266
1326
|
#
|
1267
1327
|
# @!attribute [rw] role_arn
|
1268
|
-
# An IAM role that gives Amazon
|
1269
|
-
#
|
1270
|
-
#
|
1271
|
-
# Amazon S3
|
1328
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
1329
|
+
# Kendra permissions to access your Amazon CloudWatch logs and
|
1330
|
+
# metrics. This is also the role used when you use the
|
1331
|
+
# `BatchPutDocument` operation to index documents from an Amazon S3
|
1332
|
+
# bucket.
|
1272
1333
|
# @return [String]
|
1273
1334
|
#
|
1274
1335
|
# @!attribute [rw] server_side_encryption_configuration
|
@@ -1284,7 +1345,7 @@ module Aws::Kendra
|
|
1284
1345
|
# @!attribute [rw] client_token
|
1285
1346
|
# A token that you provide to identify the request to create an index.
|
1286
1347
|
# Multiple calls to the `CreateIndex` operation with the same client
|
1287
|
-
# token will create only one index
|
1348
|
+
# token will create only one index.
|
1288
1349
|
#
|
1289
1350
|
# **A suitable default value is auto-generated.** You should normally
|
1290
1351
|
# not need to pass this option.
|
@@ -1332,6 +1393,7 @@ module Aws::Kendra
|
|
1332
1393
|
# s3_configuration: {
|
1333
1394
|
# bucket_name: "S3BucketName", # required
|
1334
1395
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
1396
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1335
1397
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1336
1398
|
# documents_metadata_configuration: {
|
1337
1399
|
# s3_prefix: "S3ObjectKey",
|
@@ -1521,17 +1583,18 @@ module Aws::Kendra
|
|
1521
1583
|
# }
|
1522
1584
|
#
|
1523
1585
|
# @!attribute [rw] s3_configuration
|
1524
|
-
# Provides information to create a connector for a
|
1525
|
-
# in an Amazon S3 bucket.
|
1586
|
+
# Provides information to create a data source connector for a
|
1587
|
+
# document repository in an Amazon S3 bucket.
|
1526
1588
|
# @return [Types::S3DataSourceConfiguration]
|
1527
1589
|
#
|
1528
1590
|
# @!attribute [rw] share_point_configuration
|
1529
|
-
# Provides information necessary to create a connector for
|
1530
|
-
# SharePoint site.
|
1591
|
+
# Provides information necessary to create a data source connector for
|
1592
|
+
# a Microsoft SharePoint site.
|
1531
1593
|
# @return [Types::SharePointConfiguration]
|
1532
1594
|
#
|
1533
1595
|
# @!attribute [rw] database_configuration
|
1534
|
-
# Provides information necessary to create a connector for
|
1596
|
+
# Provides information necessary to create a data source connector for
|
1597
|
+
# a database.
|
1535
1598
|
# @return [Types::DatabaseConfiguration]
|
1536
1599
|
#
|
1537
1600
|
# @!attribute [rw] salesforce_configuration
|
@@ -1644,7 +1707,7 @@ module Aws::Kendra
|
|
1644
1707
|
# @!attribute [rw] metrics
|
1645
1708
|
# Maps a batch delete document request to a specific data source sync
|
1646
1709
|
# job. This is optional and should only be supplied when documents are
|
1647
|
-
# deleted by a connector.
|
1710
|
+
# deleted by a data source connector.
|
1648
1711
|
# @return [Types::DataSourceSyncJobMetrics]
|
1649
1712
|
#
|
1650
1713
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJob AWS API Documentation
|
@@ -1691,7 +1754,7 @@ module Aws::Kendra
|
|
1691
1754
|
|
1692
1755
|
# Maps a batch delete document request to a specific data source sync
|
1693
1756
|
# job. This is optional and should only be supplied when documents are
|
1694
|
-
# deleted by a connector.
|
1757
|
+
# deleted by a data source connector.
|
1695
1758
|
#
|
1696
1759
|
# @!attribute [rw] documents_added
|
1697
1760
|
# The number of documents added from the data source up to now in the
|
@@ -2112,6 +2175,10 @@ module Aws::Kendra
|
|
2112
2175
|
# the reason why the FAQ failed.
|
2113
2176
|
# @return [String]
|
2114
2177
|
#
|
2178
|
+
# @!attribute [rw] file_format
|
2179
|
+
# The file format used by the input files for the FAQ.
|
2180
|
+
# @return [String]
|
2181
|
+
#
|
2115
2182
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqResponse AWS API Documentation
|
2116
2183
|
#
|
2117
2184
|
class DescribeFaqResponse < Struct.new(
|
@@ -2124,7 +2191,8 @@ module Aws::Kendra
|
|
2124
2191
|
:s3_path,
|
2125
2192
|
:status,
|
2126
2193
|
:role_arn,
|
2127
|
-
:error_message
|
2194
|
+
:error_message,
|
2195
|
+
:file_format)
|
2128
2196
|
SENSITIVE = []
|
2129
2197
|
include Aws::Structure
|
2130
2198
|
end
|
@@ -2517,6 +2585,11 @@ module Aws::Kendra
|
|
2517
2585
|
# `DocumentAttributeKey` provided in the query.
|
2518
2586
|
# @return [String]
|
2519
2587
|
#
|
2588
|
+
# @!attribute [rw] document_attribute_value_type
|
2589
|
+
# The data type of the facet value. This is the same as the type
|
2590
|
+
# defined for the index field when it was created.
|
2591
|
+
# @return [String]
|
2592
|
+
#
|
2520
2593
|
# @!attribute [rw] document_attribute_value_count_pairs
|
2521
2594
|
# An array of key/value pairs, where the key is the value of the
|
2522
2595
|
# attribute and the count is the number of documents that share the
|
@@ -2527,6 +2600,7 @@ module Aws::Kendra
|
|
2527
2600
|
#
|
2528
2601
|
class FacetResult < Struct.new(
|
2529
2602
|
:document_attribute_key,
|
2603
|
+
:document_attribute_value_type,
|
2530
2604
|
:document_attribute_value_count_pairs)
|
2531
2605
|
SENSITIVE = []
|
2532
2606
|
include Aws::Structure
|
@@ -2573,6 +2647,10 @@ module Aws::Kendra
|
|
2573
2647
|
# The UNIX datetime that the FAQ was last updated.
|
2574
2648
|
# @return [Time]
|
2575
2649
|
#
|
2650
|
+
# @!attribute [rw] file_format
|
2651
|
+
# The file type used to create the FAQ.
|
2652
|
+
# @return [String]
|
2653
|
+
#
|
2576
2654
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FaqSummary AWS API Documentation
|
2577
2655
|
#
|
2578
2656
|
class FaqSummary < Struct.new(
|
@@ -2580,7 +2658,8 @@ module Aws::Kendra
|
|
2580
2658
|
:name,
|
2581
2659
|
:status,
|
2582
2660
|
:created_at,
|
2583
|
-
:updated_at
|
2661
|
+
:updated_at,
|
2662
|
+
:file_format)
|
2584
2663
|
SENSITIVE = []
|
2585
2664
|
include Aws::Structure
|
2586
2665
|
end
|
@@ -3295,8 +3374,9 @@ module Aws::Kendra
|
|
3295
3374
|
# @return [Array<Types::FacetResult>]
|
3296
3375
|
#
|
3297
3376
|
# @!attribute [rw] total_number_of_results
|
3298
|
-
# The number of items
|
3299
|
-
#
|
3377
|
+
# The total number of items found by the search; however, you can only
|
3378
|
+
# retrieve up to 100 items. For example, if the search found 192
|
3379
|
+
# items, you can only retrieve the first 100 of the items.
|
3300
3380
|
# @return [Integer]
|
3301
3381
|
#
|
3302
3382
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
|
@@ -3326,7 +3406,7 @@ module Aws::Kendra
|
|
3326
3406
|
# @return [String]
|
3327
3407
|
#
|
3328
3408
|
# @!attribute [rw] additional_attributes
|
3329
|
-
# One or more additional
|
3409
|
+
# One or more additional attributes associated with the query result.
|
3330
3410
|
# @return [Array<Types::AdditionalResultAttribute>]
|
3331
3411
|
#
|
3332
3412
|
# @!attribute [rw] document_id
|
@@ -3353,6 +3433,18 @@ module Aws::Kendra
|
|
3353
3433
|
# source URI (SourceUri) of the document.
|
3354
3434
|
# @return [Array<Types::DocumentAttribute>]
|
3355
3435
|
#
|
3436
|
+
# @!attribute [rw] score_attributes
|
3437
|
+
# Indicates the confidence that Amazon Kendra has that a result
|
3438
|
+
# matches the query that you provided. Each result is placed into a
|
3439
|
+
# bin that indicates the confidence, `VERY_HIGH`, `HIGH`, `MEDIUM` and
|
3440
|
+
# `LOW`. You can use the score to determine if a response meets the
|
3441
|
+
# confidence needed for your application.
|
3442
|
+
#
|
3443
|
+
# The field is only set to `LOW` when the `Type` field is set to
|
3444
|
+
# `DOCUMENT` and Amazon Kendra is not confident that the result
|
3445
|
+
# matches the query.
|
3446
|
+
# @return [Types::ScoreAttributes]
|
3447
|
+
#
|
3356
3448
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation
|
3357
3449
|
#
|
3358
3450
|
class QueryResultItem < Struct.new(
|
@@ -3363,7 +3455,8 @@ module Aws::Kendra
|
|
3363
3455
|
:document_title,
|
3364
3456
|
:document_excerpt,
|
3365
3457
|
:document_uri,
|
3366
|
-
:document_attributes
|
3458
|
+
:document_attributes,
|
3459
|
+
:score_attributes)
|
3367
3460
|
SENSITIVE = []
|
3368
3461
|
include Aws::Structure
|
3369
3462
|
end
|
@@ -3534,6 +3627,7 @@ module Aws::Kendra
|
|
3534
3627
|
# {
|
3535
3628
|
# bucket_name: "S3BucketName", # required
|
3536
3629
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
3630
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3537
3631
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3538
3632
|
# documents_metadata_configuration: {
|
3539
3633
|
# s3_prefix: "S3ObjectKey",
|
@@ -3552,10 +3646,23 @@ module Aws::Kendra
|
|
3552
3646
|
# the index.
|
3553
3647
|
# @return [Array<String>]
|
3554
3648
|
#
|
3649
|
+
# @!attribute [rw] inclusion_patterns
|
3650
|
+
# A list of glob patterns for documents that should be indexed. If a
|
3651
|
+
# document that matches an inclusion pattern also matches an exclusion
|
3652
|
+
# pattern, the document is not indexed.
|
3653
|
+
#
|
3654
|
+
# For more information about glob patterns, see [glob
|
3655
|
+
# (programming)][1] in *Wikipedia*.
|
3656
|
+
#
|
3657
|
+
#
|
3658
|
+
#
|
3659
|
+
# [1]: https://en.wikipedia.org/wiki/Glob_(programming)
|
3660
|
+
# @return [Array<String>]
|
3661
|
+
#
|
3555
3662
|
# @!attribute [rw] exclusion_patterns
|
3556
3663
|
# A list of glob patterns for documents that should not be indexed. If
|
3557
|
-
# a document that matches an inclusion prefix
|
3558
|
-
# exclusion pattern, the document is not indexed.
|
3664
|
+
# a document that matches an inclusion prefix or inclusion pattern
|
3665
|
+
# also matches an exclusion pattern, the document is not indexed.
|
3559
3666
|
#
|
3560
3667
|
# For more information about glob patterns, see [glob
|
3561
3668
|
# (programming)][1] in *Wikipedia*.
|
@@ -3582,6 +3689,7 @@ module Aws::Kendra
|
|
3582
3689
|
class S3DataSourceConfiguration < Struct.new(
|
3583
3690
|
:bucket_name,
|
3584
3691
|
:inclusion_prefixes,
|
3692
|
+
:inclusion_patterns,
|
3585
3693
|
:exclusion_patterns,
|
3586
3694
|
:documents_metadata_configuration,
|
3587
3695
|
:access_control_list_configuration)
|
@@ -4078,6 +4186,21 @@ module Aws::Kendra
|
|
4078
4186
|
include Aws::Structure
|
4079
4187
|
end
|
4080
4188
|
|
4189
|
+
# Provides a relative ranking that indicates how confident Amazon Kendra
|
4190
|
+
# is that the response matches the query.
|
4191
|
+
#
|
4192
|
+
# @!attribute [rw] score_confidence
|
4193
|
+
# A relative ranking for how well the response matches the query.
|
4194
|
+
# @return [String]
|
4195
|
+
#
|
4196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ScoreAttributes AWS API Documentation
|
4197
|
+
#
|
4198
|
+
class ScoreAttributes < Struct.new(
|
4199
|
+
:score_confidence)
|
4200
|
+
SENSITIVE = []
|
4201
|
+
include Aws::Structure
|
4202
|
+
end
|
4203
|
+
|
4081
4204
|
# Provides information about how a custom index field is used during a
|
4082
4205
|
# search.
|
4083
4206
|
#
|
@@ -4500,6 +4623,20 @@ module Aws::Kendra
|
|
4500
4623
|
# The attribute must have the `Sortable` flag set to `true`, otherwise
|
4501
4624
|
# Amazon Kendra returns an exception.
|
4502
4625
|
#
|
4626
|
+
# You can sort attributes of the following types.
|
4627
|
+
#
|
4628
|
+
# * Date value
|
4629
|
+
#
|
4630
|
+
# * Long value
|
4631
|
+
#
|
4632
|
+
# * String value
|
4633
|
+
#
|
4634
|
+
# You can't sort attributes of the following type.
|
4635
|
+
#
|
4636
|
+
# * String list value
|
4637
|
+
#
|
4638
|
+
# ^
|
4639
|
+
#
|
4503
4640
|
# @note When making an API call, you may pass SortingConfiguration
|
4504
4641
|
# data as a hash:
|
4505
4642
|
#
|
@@ -4551,8 +4688,8 @@ module Aws::Kendra
|
|
4551
4688
|
# }
|
4552
4689
|
#
|
4553
4690
|
# @!attribute [rw] query_identifiers_enclosing_option
|
4554
|
-
# Determines whether Amazon Kendra encloses SQL identifiers
|
4555
|
-
# quotes (") when making a database query.
|
4691
|
+
# Determines whether Amazon Kendra encloses SQL identifiers for tables
|
4692
|
+
# and column names in double quotes (") when making a database query.
|
4556
4693
|
#
|
4557
4694
|
# By default, Amazon Kendra passes SQL identifiers the way that they
|
4558
4695
|
# are entered into the data source configuration. It does not change
|
@@ -4564,7 +4701,7 @@ module Aws::Kendra
|
|
4564
4701
|
# convert the character's case.
|
4565
4702
|
#
|
4566
4703
|
# For MySQL databases, you must enable the `ansi_quotes` option when
|
4567
|
-
# you
|
4704
|
+
# you set this field to `DOUBLE_QUOTES`.
|
4568
4705
|
# @return [String]
|
4569
4706
|
#
|
4570
4707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SqlConfiguration AWS API Documentation
|
@@ -4874,6 +5011,7 @@ module Aws::Kendra
|
|
4874
5011
|
# s3_configuration: {
|
4875
5012
|
# bucket_name: "S3BucketName", # required
|
4876
5013
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
5014
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4877
5015
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4878
5016
|
# documents_metadata_configuration: {
|
4879
5017
|
# s3_prefix: "S3ObjectKey",
|
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.15.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-10-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.109.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.109.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|