aws-sdk-kendra 1.71.0 → 1.72.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d35579c617bf49bba376c29ff34ed04b399117e07a6071f1043710ed65faca8a
-  data.tar.gz: 9b83c8d81f800bb0073882e559f9efe20becb43ce2119c5b45a9055d78d66996
+  metadata.gz: fb872c58d1bd0b4cf0e6c5836c80210af58cb1bd61d7a7dbcebacc55b5b0da7c
+  data.tar.gz: 2f15e99b78127ed82c993ed622a3f9da762914e609078ccf55111201a0af081d
 SHA512:
-  metadata.gz: 0d5cd57f9ce835bebd75a1abdbf8209c04686f1479559fc57b2b2d9f1b390da9781f372dedd5063582a820f734599e28a3c1ff35a2e71b133f0b7564e5fefd82
-  data.tar.gz: ebfd047866b107ead64f150f0f1601ebd0b3192e4346922206f55162c3db12e72ea6134041a4acc284bf32d88642632a4dfdec6c6b68d47c43706dfeed96720b
+  metadata.gz: 8c1a1ee464de81b4be7c7dd794d03b990c1f25db62a36e1593c2a3bd9d4a3e95eb664c4910282a458af28ce3d6d52a062e995f86b942cea4456e3fbdf74263d3
+  data.tar.gz: 5f8f0ed49b67d60dff2c0cd9e102f4f426c30764b9e697c6d946783e1855e0b4a3522e224b85ec07f51107c759960a3b2f0a67fb4cdad2e6bea812a8adb79f8b

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.72.0 (2023-09-12)
+------------------
+
+* Feature - Amazon Kendra now supports confidence score buckets for retrieved passage results using the Retrieve API.
+
 1.71.0 (2023-07-11)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.71.0
+1.72.0

data/lib/aws-sdk-kendra/client.rb

@@ -513,8 +513,14 @@ module Aws::Kendra
     #
     # The documents are deleted asynchronously. You can see the progress of
     # the deletion by using Amazon Web Services CloudWatch. Any error
-    # messages related to the processing of the batch are sent to you
-    # CloudWatch log.
+    # messages related to the processing of the batch are sent to your
+    # Amazon Web Services CloudWatch log. You can also use the
+    # `BatchGetDocumentStatus` API to monitor the progress of deleting your
+    # documents.
+    #
+    # Deleting documents from an index using `BatchDeleteDocument` could
+    # take up to an hour or more, depending on the number of documents you
+    # want to delete.
     #
     # @option params [required, String] :index_id
     #   The identifier of the index that contains the documents to delete.
@@ -683,7 +689,8 @@ module Aws::Kendra
     # The documents are indexed asynchronously. You can see the progress of
     # the batch using Amazon Web Services CloudWatch. Any error messages
     # related to processing the batch are sent to your Amazon Web Services
-    # CloudWatch log.
+    # CloudWatch log. You can also use the `BatchGetDocumentStatus` API to
+    # monitor the progress of indexing your documents.
     #
     # For an example of ingesting inline documents using Python and Java
     # SDKs, see [Adding files directly to an index][1].
@@ -2159,18 +2166,20 @@ module Aws::Kendra
     # returned from a call to `DescribeIndex`. The `Status` field is set to
     # `ACTIVE` when the index is ready to use.
     #
-    # Once the index is active you can index your documents using the
-    # `BatchPutDocument` API or using one of the supported data sources.
+    # Once the index is active, you can index your documents using the
+    # `BatchPutDocument` API or using one of the supported [data
+    # sources][1].
     #
     # For an example of creating an index and data source using the Python
-    # SDK, see [Getting started with Python SDK][1]. For an example of
+    # SDK, see [Getting started with Python SDK][2]. For an example of
     # creating an index and data source using the Java SDK, see [Getting
-    # started with Java SDK][2].
+    # started with Java SDK][3].
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html
-    # [2]: https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html
+    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-sources.html
+    # [2]: https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html
+    # [3]: https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html
     #
     # @option params [required, String] :name
     #   A name for the index.
@@ -2535,6 +2544,10 @@ module Aws::Kendra
     # `DescribeDataSource` API is set to `DELETING`. For more information,
     # see [Deleting Data Sources][1].
     #
+    # Deleting an entire data source or re-syncing your index after deleting
+    # specific documents from a data source could take up to an hour or
+    # more, depending on the number of documents you want to delete.
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html
@@ -5417,9 +5430,9 @@ module Aws::Kendra
     # doesn't include question-answer or FAQ type responses from your
     # index. The passages are text excerpts that can be semantically
     # extracted from multiple documents and multiple parts of the same
-    # document. If in extreme cases your documents produce no relevant
-    # passages using the `Retrieve` API, you can alternatively use the
-    # `Query` API.
+    # document. If in extreme cases your documents produce zero passages
+    # using the `Retrieve` API, you can alternatively use the `Query` API
+    # and its types of responses.
     #
     # You can also do the following:
     #
@@ -5432,9 +5445,16 @@ module Aws::Kendra
     # You can also include certain fields in the response that might provide
     # useful additional information.
     #
+    # The `Retrieve` API shares the number of [query capacity units][2] that
+    # you set for your index. For more information on what's included in a
+    # single capacity unit and the default base capacity for an index, see
+    # [Adjusting capacity][3].
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html
+    # [2]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_CapacityUnitsConfiguration.html
+    # [3]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html
     #
     # @option params [required, String] :index_id
     #   The identifier of the index to retrieve relevant passages for the
@@ -5622,6 +5642,7 @@ module Aws::Kendra
     #   resp.result_items[0].document_attributes[0].value.string_list_value[0] #=> String
     #   resp.result_items[0].document_attributes[0].value.long_value #=> Integer
     #   resp.result_items[0].document_attributes[0].value.date_value #=> Time
+    #   resp.result_items[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "NOT_AVAILABLE"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Retrieve AWS API Documentation
     #
@@ -5636,6 +5657,10 @@ module Aws::Kendra
     # synchronization job is already in progress, Amazon Kendra returns a
     # `ResourceInUseException` exception.
     #
+    # Re-syncing your data source with your index after modifying, adding,
+    # or deleting documents from your data source respository could take up
+    # to an hour or more, depending on the number of documents to sync.
+    #
     # @option params [required, String] :id
     #   The identifier of the data source connector to synchronize.
     #
@@ -7178,7 +7203,7 @@ module Aws::Kendra
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kendra'
-      context[:gem_version] = '1.71.0'
+      context[:gem_version] = '1.72.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-kendra/client_api.rb

@@ -1993,6 +1993,7 @@ module Aws::Kendra
     RetrieveResultItem.add_member(:content, Shapes::ShapeRef.new(shape: Content, location_name: "Content"))
     RetrieveResultItem.add_member(:document_uri, Shapes::ShapeRef.new(shape: Url, location_name: "DocumentURI"))
     RetrieveResultItem.add_member(:document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "DocumentAttributes"))
+    RetrieveResultItem.add_member(:score_attributes, Shapes::ShapeRef.new(shape: ScoreAttributes, location_name: "ScoreAttributes"))
     RetrieveResultItem.struct_class = Types::RetrieveResultItem
 
     RetrieveResultItemList.member = Shapes::ShapeRef.new(shape: RetrieveResultItem)

data/lib/aws-sdk-kendra/types.rb

@@ -341,79 +341,122 @@ module Aws::Kendra
       include Aws::Structure
     end
 
-    # Provides filtering the query results based on document attributes or
-    # metadata fields.
+    # Filters the search results based on document attributes or fields.
     #
-    # When you use the `AndAllFilters` or `OrAllFilters`, filters you can
-    # use 2 layers under the first attribute filter. For example, you can
-    # use:
+    # You can filter results using attributes for your particular documents.
+    # The attributes must exist in your index. For example, if your
+    # documents include the custom attribute "Department", you can filter
+    # documents that belong to the "HR" department. You would use the
+    # `EqualsTo` operation to filter results or documents with
+    # "Department" equals to "HR".
     #
-    # `<AndAllFilters>`
+    # You can use `AndAllFilters` and `AndOrFilters` in combination with
+    # each other or with other operations such as `EqualsTo`. For example:
     #
-    # 1.  ` <OrAllFilters>`
+    # `AndAllFilters`
     #
-    # 2.  ` <EqualsTo>`
+    # * `EqualsTo`: "Department", "HR"
     #
-    # If you use more than 2 layers, you receive a `ValidationException`
-    # exception with the message "`AttributeFilter` cannot have a depth of
-    # more than 2."
+    # * `AndOrFilters`
     #
-    # If you use more than 10 attribute filters in a given list for
-    # `AndAllFilters` or `OrAllFilters`, you receive a `ValidationException`
-    # with the message "`AttributeFilter` cannot have a length of more than
-    # 10".
+    #   * `ContainsAny`: "Project Name", \["new hires", "new hiring"\]
+    #
+    #   ^
+    #
+    # This example filters results or documents that belong to the HR
+    # department *and* belong to projects that contain "new hires" *or*
+    # "new hiring" in the project name (must use `ContainAny` with
+    # `StringListValue`). This example is filtering with a depth of 2.
+    #
+    # You cannot filter more than a depth of 2, otherwise you receive a
+    # `ValidationException` exception with the message "AttributeFilter
+    # cannot have a depth of more than 2." Also, if you use more than 10
+    # attribute filters in a given list for `AndAllFilters` or
+    # `OrAllFilters`, you receive a `ValidationException` with the message
+    # "AttributeFilter cannot have a length of more than 10".
+    #
+    # For examples of using `AttributeFilter`, see [Using document
+    # attributes to filter search results][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering
     #
     # @!attribute [rw] and_all_filters
-    #   Performs a logical `AND` operation on all supplied filters.
+    #   Performs a logical `AND` operation on all filters that you specify.
     #   @return [Array<Types::AttributeFilter>]
     #
     # @!attribute [rw] or_all_filters
-    #   Performs a logical `OR` operation on all supplied filters.
+    #   Performs a logical `OR` operation on all filters that you specify.
     #   @return [Array<Types::AttributeFilter>]
     #
     # @!attribute [rw] not_filter
-    #   Performs a logical `NOT` operation on all supplied filters.
+    #   Performs a logical `NOT` operation on all filters that you specify.
     #   @return [Types::AttributeFilter]
     #
     # @!attribute [rw] equals_to
-    #   Performs an equals operation on two document attributes or metadata
-    #   fields.
+    #   Performs an equals operation on document attributes/fields and their
+    #   values.
     #   @return [Types::DocumentAttribute]
     #
     # @!attribute [rw] contains_all
     #   Returns true when a document contains all of the specified document
-    #   attributes or metadata fields. This filter is only applicable to
-    #   `StringListValue` metadata.
+    #   attributes/fields. This filter is only applicable to
+    #   [StringListValue][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
     #   @return [Types::DocumentAttribute]
     #
     # @!attribute [rw] contains_any
     #   Returns true when a document contains any of the specified document
-    #   attributes or metadata fields. This filter is only applicable to
-    #   `StringListValue` metadata.
+    #   attributes/fields. This filter is only applicable to
+    #   [StringListValue][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
     #   @return [Types::DocumentAttribute]
     #
     # @!attribute [rw] greater_than
-    #   Performs a greater than operation on two document attributes or
-    #   metadata fields. Use with a document attribute of type `Date` or
+    #   Performs a greater than operation on document attributes/fields and
+    #   their values. Use with the [document attribute type][1] `Date` or
     #   `Long`.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
     #   @return [Types::DocumentAttribute]
     #
     # @!attribute [rw] greater_than_or_equals
-    #   Performs a greater or equals than operation on two document
-    #   attributes or metadata fields. Use with a document attribute of type
-    #   `Date` or `Long`.
+    #   Performs a greater or equals than operation on document
+    #   attributes/fields and their values. Use with the [document attribute
+    #   type][1] `Date` or `Long`.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
     #   @return [Types::DocumentAttribute]
     #
     # @!attribute [rw] less_than
-    #   Performs a less than operation on two document attributes or
-    #   metadata fields. Use with a document attribute of type `Date` or
+    #   Performs a less than operation on document attributes/fields and
+    #   their values. Use with the [document attribute type][1] `Date` or
     #   `Long`.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
     #   @return [Types::DocumentAttribute]
     #
     # @!attribute [rw] less_than_or_equals
-    #   Performs a less than or equals operation on two document attributes
-    #   or metadata fields. Use with a document attribute of type `Date` or
-    #   `Long`.
+    #   Performs a less than or equals operation on document
+    #   attributes/fields and their values. Use with the [document attribute
+    #   type][1] `Date` or `Long`.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html
     #   @return [Types::DocumentAttribute]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeFilter AWS API Documentation
@@ -877,7 +920,7 @@ module Aws::Kendra
     #   If there was an error adding a document to an index the error is
     #   reported in your Amazon Web Services CloudWatch log. For more
     #   information, see [Monitoring Amazon Kendra with Amazon CloudWatch
-    #   Logs][1]
+    #   logs][1].
     #
     #
     #
@@ -2879,19 +2922,35 @@ module Aws::Kendra
       include Aws::Structure
     end
 
-    # Maps a column or attribute in the data source to an index field. You
-    # must first create the fields in the index using the `UpdateIndex` API.
+    # Maps attributes or field names of the documents synced from the data
+    # source to Amazon Kendra index field names. You can set up field
+    # mappings for each data source when calling [CreateDataSource][1] or
+    # [UpdateDataSource][2] API. To create custom fields, use the
+    # `UpdateIndex` API to first create an index field and then map to the
+    # data source field. For more information, see [Mapping data source
+    # fields][3].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html
+    # [2]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html
+    # [3]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
     #
     # @!attribute [rw] data_source_field_name
-    #   The name of the column or attribute in the data source.
+    #   The name of the field in the data source. You must first create the
+    #   index field using the `UpdateIndex` API.
     #   @return [String]
     #
     # @!attribute [rw] date_field_format
-    #   The type of data stored in the column or attribute.
+    #   The format for date fields in the data source. If the field
+    #   specified in `DataSourceFieldName` is a date field, you must specify
+    #   the date format. If the field is not a date field, an exception is
+    #   thrown.
     #   @return [String]
     #
     # @!attribute [rw] index_field_name
-    #   The name of the field in the index.
+    #   The name of the index field to map to the data source field. The
+    #   index field type must match the data source field type.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceToIndexFieldMapping AWS API Documentation
@@ -2927,7 +2986,12 @@ module Aws::Kendra
       include Aws::Structure
     end
 
-    # Provides the configuration information to connect to a index.
+    # Provides the configuration information to an [Amazon Kendra supported
+    # database][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html
     #
     # @!attribute [rw] database_engine_type
     #   The type of database engine that runs the database.
@@ -4453,22 +4517,22 @@ module Aws::Kendra
       include Aws::Structure
     end
 
-    # Provides the count of documents that match a particular attribute when
-    # doing a faceted search.
+    # Provides the count of documents that match a particular document
+    # attribute or field when doing a faceted search.
     #
     # @!attribute [rw] document_attribute_value
-    #   The value of the attribute. For example, "HR".
+    #   The value of the attribute/field. For example, "HR".
     #   @return [Types::DocumentAttributeValue]
     #
     # @!attribute [rw] count
-    #   The number of documents in the response that have the attribute
-    #   value for the key.
+    #   The number of documents in the response that have the
+    #   attribute/field value for the key.
     #   @return [Integer]
     #
     # @!attribute [rw] facet_results
-    #   Contains the results of a document attribute that is a nested facet.
-    #   A `FacetResult` contains the counts for each facet nested within a
-    #   facet.
+    #   Contains the results of a document attribute/field that is a nested
+    #   facet. A `FacetResult` contains the counts for each facet nested
+    #   within a facet.
     #
     #   For example, the document attribute or facet "Department" includes
     #   a value called "Engineering". In addition, the document attribute
@@ -4809,7 +4873,7 @@ module Aws::Kendra
       include Aws::Structure
     end
 
-    # Information about a document attribute. You can use document
+    # Information about a document attribute or field. You can use document
     # attributes as facets.
     #
     # For example, the document attribute or facet "Department" includes
@@ -8228,6 +8292,13 @@ module Aws::Kendra
     #   source URI (`_source_uri`) of the document.
     #   @return [Array<Types::DocumentAttribute>]
     #
+    # @!attribute [rw] score_attributes
+    #   The confidence score bucket for a retrieved passage result. The
+    #   confidence bucket provides a relative ranking that indicates how
+    #   confident Amazon Kendra is that the response is relevant to the
+    #   query.
+    #   @return [Types::ScoreAttributes]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/RetrieveResultItem AWS API Documentation
     #
     class RetrieveResultItem < Struct.new(
@@ -8236,7 +8307,8 @@ module Aws::Kendra
       :document_title,
       :content,
       :document_uri,
-      :document_attributes)
+      :document_attributes,
+      :score_attributes)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-kendra.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-kendra/customizations'
 # @!group service
 module Aws::Kendra
 
-  GEM_VERSION = '1.71.0'
+  GEM_VERSION = '1.72.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kendra
 version: !ruby/object:Gem::Version
-  version: 1.71.0
+  version: 1.72.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core