aws-sdk-kendra 1.67.0 → 1.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 625ce42bb5968e9540506d1a52253eb532ec1fd7320bee731c1e5291287d11ba
-  data.tar.gz: 7d5d42a65506795b9dbd8da04fa50963769c8fcbb7593aaea700a1e52aa580ea
+  metadata.gz: 4372c3acacf5d72ee47336d56278f06798fb0b3a4b5381b748f6ba2cc4c4b399
+  data.tar.gz: e6853eea98a07d146ebf29af0bb646e07b04b72f58955af5f8acd46419ad746d
 SHA512:
-  metadata.gz: e9e0221747ddddf08c40d227b862e000e16bf72ef9b982350da16d71c5d725c9dd312da96452a06f38d0ca769db4432a41f8db48ce1b9c3aa2c3edcf29588535
-  data.tar.gz: f4dab3e7a39ca7cde611d3f807c5e274fb05d80944374d4229a160dffc561ce0b36f229574c6d9b8be6f4160b782c2f43ab8d61defcf18d83a24c0054fbeebda
+  metadata.gz: f89a7105f742a34a51e0df627c9e66411668dfd8cc43b10c635d4c85d1ab7f39ebd4c5768d8f9c3888c7b62b83cf3f3612376a753527da0555b8390f0e921d22
+  data.tar.gz: d707dd3b5aa4934e16ce8c9800239bc579bd10b5d5a6e69747a96b6f13fcc99d222435ba0644a5a3fb9aba04bc824085146cec3c116737260dcbc422617e7e87

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.69.0 (2023-06-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.68.0 (2023-06-22)
+------------------
+
+* Feature - Introducing Amazon Kendra Retrieve API that can be used to retrieve relevant passages or text excerpts given an input query.
+
 1.67.0 (2023-06-15)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.67.0
+1.69.0

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

@@ -1958,6 +1958,8 @@ module Aws::Kendra
     #   format, a CSV format that includes customs attributes in a header, and
     #   a JSON format that includes custom attributes.
     #
+    #   The default format is CSV.
+    #
     #   The format must match the format of the file stored in the S3 bucket
     #   identified in the `S3Path` parameter.
     #
@@ -5036,31 +5038,33 @@ module Aws::Kendra
       req.send_request(options)
     end
 
-    # Searches an active index. Use this API to search your documents using
-    # query. The `Query` API enables to do faceted search and to filter
-    # results based on document attributes.
+    # Searches an index given an input query.
     #
-    # It also enables you to provide user context that Amazon Kendra uses to
-    # enforce document access control in the search results.
+    # You can configure boosting or relevance tuning at the query level to
+    # override boosting at the index level, filter based on document
+    # fields/attributes and faceted search, and filter based on the user or
+    # their group access to documents. You can also include certain fields
+    # in the response that might provide useful additional information.
     #
-    # Amazon Kendra searches your index for text content and question and
-    # answer (FAQ) content. By default the response contains three types of
-    # results.
+    # A query response contains three types of results.
     #
-    # * Relevant passages
+    # * Relevant suggested answers. The answers can be either a text excerpt
+    #   or table excerpt. The answer can be highlighted in the excerpt.
     #
-    # * Matching FAQs
+    # * Matching FAQs or questions-answer from your FAQ file.
     #
-    # * Relevant documents
+    # * Relevant documents. This result type includes an excerpt of the
+    #   document with the document title. The searched terms can be
+    #   highlighted in the excerpt.
     #
     # You can specify that the query return only one type of result using
-    # the `QueryResultTypeFilter` parameter.
-    #
-    # Each query returns the 100 most relevant results.
+    # the `QueryResultTypeFilter` parameter. Each query returns the 100 most
+    # relevant results. If you filter result type to only question-answers,
+    # a maximum of four results are returned. If you filter result type to
+    # only answers, a maximum of three results are returned.
     #
     # @option params [required, String] :index_id
-    #   The identifier of the index to search. The identifier is returned in
-    #   the response from the `CreateIndex` API.
+    #   The identifier of the index for the search.
     #
     # @option params [String] :query_text
     #   The input query text for the search. Amazon Kendra truncates queries
@@ -5069,44 +5073,39 @@ module Aws::Kendra
     #   queries.
     #
     # @option params [Types::AttributeFilter] :attribute_filter
-    #   Enables filtered searches based on document attributes. You can only
+    #   Filters search results by document fields/attributes. You can only
     #   provide one attribute filter; however, the `AndAllFilters`,
     #   `NotFilter`, and `OrAllFilters` parameters contain a list of other
     #   filters.
     #
-    #   The `AttributeFilter` parameter enables you to create a set of
+    #   The `AttributeFilter` parameter means you can create a set of
     #   filtering rules that a document must satisfy to be included in the
     #   query results.
     #
     # @option params [Array<Types::Facet>] :facets
-    #   An array of documents attributes. Amazon Kendra returns a count for
-    #   each attribute key specified. This helps your users narrow their
-    #   search.
+    #   An array of documents fields/attributes for faceted search. Amazon
+    #   Kendra returns a count for each field key specified. This helps your
+    #   users narrow their search.
     #
     # @option params [Array<String>] :requested_document_attributes
-    #   An array of document attributes to include in the response. You can
-    #   limit the response to include certain document attributes. By default
+    #   An array of document fields/attributes to include in the response. You
+    #   can limit the response to include certain document fields. By default,
     #   all document attributes are included in the response.
     #
     # @option params [String] :query_result_type_filter
-    #   Sets the type of query. Only results for the specified query type are
-    #   returned.
+    #   Sets the type of query result or response. Only results for the
+    #   specified type are returned.
     #
     # @option params [Array<Types::DocumentRelevanceConfiguration>] :document_relevance_override_configurations
-    #   Overrides relevance tuning configurations of fields or attributes set
-    #   at the index level.
+    #   Overrides relevance tuning configurations of fields/attributes set at
+    #   the index level.
     #
     #   If you use this API to override the relevance tuning configured at the
     #   index level, but there is no relevance tuning configured at the index
     #   level, then Amazon Kendra does not apply any relevance tuning.
     #
-    #   If there is relevance tuning configured at the index level, but you do
-    #   not use this API to override any relevance tuning in the index, then
-    #   Amazon Kendra uses the relevance tuning that is configured at the
-    #   index level.
-    #
     #   If there is relevance tuning configured for fields at the index level,
-    #   but you use this API to override only some of these fields, then for
+    #   and you use this API to override only some of these fields, then for
     #   the fields you did not override, the importance is set to 1.
     #
     # @option params [Integer] :page_number
@@ -5394,6 +5393,230 @@ module Aws::Kendra
       req.send_request(options)
     end
 
+    # Retrieves relevant passages or text excerpts given an input query.
+    #
+    # This API is similar to the [Query][1] API. However, by default, the
+    # `Query` API only returns excerpt passages of up to 100 token words.
+    # With the `Retrieve` API, you can retrieve longer passages of up to 200
+    # token words and up to 100 semantically relevant passages. This
+    # 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.
+    #
+    # You can also do the following:
+    #
+    # * Override boosting at the index level
+    #
+    # * Filter based on document fields or attributes
+    #
+    # * Filter based on the user or their group access to documents
+    #
+    # You can also include certain fields in the response that might provide
+    # useful additional information.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html
+    #
+    # @option params [required, String] :index_id
+    #   The identifier of the index to retrieve relevant passages for the
+    #   search.
+    #
+    # @option params [required, String] :query_text
+    #   The input query text to retrieve relevant passages for the search.
+    #   Amazon Kendra truncates queries at 30 token words, which excludes
+    #   punctuation and stop words. Truncation still applies if you use
+    #   Boolean or more advanced, complex queries.
+    #
+    # @option params [Types::AttributeFilter] :attribute_filter
+    #   Filters search results by document fields/attributes. You can only
+    #   provide one attribute filter; however, the `AndAllFilters`,
+    #   `NotFilter`, and `OrAllFilters` parameters contain a list of other
+    #   filters.
+    #
+    #   The `AttributeFilter` parameter means you can create a set of
+    #   filtering rules that a document must satisfy to be included in the
+    #   query results.
+    #
+    # @option params [Array<String>] :requested_document_attributes
+    #   A list of document fields/attributes to include in the response. You
+    #   can limit the response to include certain document fields. By default,
+    #   all document fields are included in the response.
+    #
+    # @option params [Array<Types::DocumentRelevanceConfiguration>] :document_relevance_override_configurations
+    #   Overrides relevance tuning configurations of fields/attributes set at
+    #   the index level.
+    #
+    #   If you use this API to override the relevance tuning configured at the
+    #   index level, but there is no relevance tuning configured at the index
+    #   level, then Amazon Kendra does not apply any relevance tuning.
+    #
+    #   If there is relevance tuning configured for fields at the index level,
+    #   and you use this API to override only some of these fields, then for
+    #   the fields you did not override, the importance is set to 1.
+    #
+    # @option params [Integer] :page_number
+    #   Retrieved relevant passages are returned in pages the size of the
+    #   `PageSize` parameter. By default, Amazon Kendra returns the first page
+    #   of results. Use this parameter to get result pages after the first
+    #   one.
+    #
+    # @option params [Integer] :page_size
+    #   Sets the number of retrieved relevant passages that are returned in
+    #   each page of results. The default page size is 10. The maximum number
+    #   of results returned is 100. If you ask for more than 100 results, only
+    #   100 are returned.
+    #
+    # @option params [Types::UserContext] :user_context
+    #   The user context token or user and group information.
+    #
+    # @return [Types::RetrieveResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::RetrieveResult#query_id #query_id} => String
+    #   * {Types::RetrieveResult#result_items #result_items} => Array&lt;Types::RetrieveResultItem&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.retrieve({
+    #     index_id: "IndexId", # required
+    #     query_text: "QueryText", # required
+    #     attribute_filter: {
+    #       and_all_filters: [
+    #         {
+    #           # recursive AttributeFilter
+    #         },
+    #       ],
+    #       or_all_filters: [
+    #         {
+    #           # recursive AttributeFilter
+    #         },
+    #       ],
+    #       not_filter: {
+    #         # recursive AttributeFilter
+    #       },
+    #       equals_to: {
+    #         key: "DocumentAttributeKey", # required
+    #         value: { # required
+    #           string_value: "DocumentAttributeStringValue",
+    #           string_list_value: ["String"],
+    #           long_value: 1,
+    #           date_value: Time.now,
+    #         },
+    #       },
+    #       contains_all: {
+    #         key: "DocumentAttributeKey", # required
+    #         value: { # required
+    #           string_value: "DocumentAttributeStringValue",
+    #           string_list_value: ["String"],
+    #           long_value: 1,
+    #           date_value: Time.now,
+    #         },
+    #       },
+    #       contains_any: {
+    #         key: "DocumentAttributeKey", # required
+    #         value: { # required
+    #           string_value: "DocumentAttributeStringValue",
+    #           string_list_value: ["String"],
+    #           long_value: 1,
+    #           date_value: Time.now,
+    #         },
+    #       },
+    #       greater_than: {
+    #         key: "DocumentAttributeKey", # required
+    #         value: { # required
+    #           string_value: "DocumentAttributeStringValue",
+    #           string_list_value: ["String"],
+    #           long_value: 1,
+    #           date_value: Time.now,
+    #         },
+    #       },
+    #       greater_than_or_equals: {
+    #         key: "DocumentAttributeKey", # required
+    #         value: { # required
+    #           string_value: "DocumentAttributeStringValue",
+    #           string_list_value: ["String"],
+    #           long_value: 1,
+    #           date_value: Time.now,
+    #         },
+    #       },
+    #       less_than: {
+    #         key: "DocumentAttributeKey", # required
+    #         value: { # required
+    #           string_value: "DocumentAttributeStringValue",
+    #           string_list_value: ["String"],
+    #           long_value: 1,
+    #           date_value: Time.now,
+    #         },
+    #       },
+    #       less_than_or_equals: {
+    #         key: "DocumentAttributeKey", # required
+    #         value: { # required
+    #           string_value: "DocumentAttributeStringValue",
+    #           string_list_value: ["String"],
+    #           long_value: 1,
+    #           date_value: Time.now,
+    #         },
+    #       },
+    #     },
+    #     requested_document_attributes: ["DocumentAttributeKey"],
+    #     document_relevance_override_configurations: [
+    #       {
+    #         name: "DocumentMetadataConfigurationName", # required
+    #         relevance: { # required
+    #           freshness: false,
+    #           importance: 1,
+    #           duration: "Duration",
+    #           rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
+    #           value_importance_map: {
+    #             "ValueImportanceMapKey" => 1,
+    #           },
+    #         },
+    #       },
+    #     ],
+    #     page_number: 1,
+    #     page_size: 1,
+    #     user_context: {
+    #       token: "Token",
+    #       user_id: "PrincipalName",
+    #       groups: ["PrincipalName"],
+    #       data_source_groups: [
+    #         {
+    #           group_id: "PrincipalName", # required
+    #           data_source_id: "DataSourceId", # required
+    #         },
+    #       ],
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.query_id #=> String
+    #   resp.result_items #=> Array
+    #   resp.result_items[0].id #=> String
+    #   resp.result_items[0].document_id #=> String
+    #   resp.result_items[0].document_title #=> String
+    #   resp.result_items[0].content #=> String
+    #   resp.result_items[0].document_uri #=> String
+    #   resp.result_items[0].document_attributes #=> Array
+    #   resp.result_items[0].document_attributes[0].key #=> String
+    #   resp.result_items[0].document_attributes[0].value.string_value #=> String
+    #   resp.result_items[0].document_attributes[0].value.string_list_value #=> Array
+    #   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
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Retrieve AWS API Documentation
+    #
+    # @overload retrieve(params = {})
+    # @param [Hash] params ({})
+    def retrieve(params = {}, options = {})
+      req = build_request(:retrieve, params)
+      req.send_request(options)
+    end
+
     # Starts a synchronization job for a data source connector. If a
     # synchronization job is already in progress, Amazon Kendra returns a
     # `ResourceInUseException` exception.
@@ -6940,7 +7163,7 @@ module Aws::Kendra
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kendra'
-      context[:gem_version] = '1.67.0'
+      context[:gem_version] = '1.69.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -96,6 +96,7 @@ module Aws::Kendra
     ConfluenceSpaceToIndexFieldMapping = Shapes::StructureShape.new(name: 'ConfluenceSpaceToIndexFieldMapping')
     ConfluenceVersion = Shapes::StringShape.new(name: 'ConfluenceVersion')
     ConnectionConfiguration = Shapes::StructureShape.new(name: 'ConnectionConfiguration')
+    Content = Shapes::StringShape.new(name: 'Content')
     ContentSourceConfiguration = Shapes::StructureShape.new(name: 'ContentSourceConfiguration')
     ContentType = Shapes::StringShape.new(name: 'ContentType')
     Correction = Shapes::StructureShape.new(name: 'Correction')
@@ -208,6 +209,7 @@ module Aws::Kendra
     DocumentRelevanceOverrideConfigurationList = Shapes::ListShape.new(name: 'DocumentRelevanceOverrideConfigurationList')
     DocumentStatus = Shapes::StringShape.new(name: 'DocumentStatus')
     DocumentStatusList = Shapes::ListShape.new(name: 'DocumentStatusList')
+    DocumentTitle = Shapes::StringShape.new(name: 'DocumentTitle')
     DocumentsMetadataConfiguration = Shapes::StructureShape.new(name: 'DocumentsMetadataConfiguration')
     Domain = Shapes::StringShape.new(name: 'Domain')
     Duration = Shapes::StringShape.new(name: 'Duration')
@@ -438,6 +440,10 @@ module Aws::Kendra
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     ResourceUnavailableException = Shapes::StructureShape.new(name: 'ResourceUnavailableException')
     ResultId = Shapes::StringShape.new(name: 'ResultId')
+    RetrieveRequest = Shapes::StructureShape.new(name: 'RetrieveRequest')
+    RetrieveResult = Shapes::StructureShape.new(name: 'RetrieveResult')
+    RetrieveResultItem = Shapes::StructureShape.new(name: 'RetrieveResultItem')
+    RetrieveResultItemList = Shapes::ListShape.new(name: 'RetrieveResultItemList')
     RoleArn = Shapes::StringShape.new(name: 'RoleArn')
     S3BucketName = Shapes::StringShape.new(name: 'S3BucketName')
     S3DataSourceConfiguration = Shapes::StructureShape.new(name: 'S3DataSourceConfiguration')
@@ -1004,7 +1010,7 @@ module Aws::Kendra
     DataSourceConfiguration.add_member(:quip_configuration, Shapes::ShapeRef.new(shape: QuipConfiguration, location_name: "QuipConfiguration"))
     DataSourceConfiguration.add_member(:jira_configuration, Shapes::ShapeRef.new(shape: JiraConfiguration, location_name: "JiraConfiguration"))
     DataSourceConfiguration.add_member(:git_hub_configuration, Shapes::ShapeRef.new(shape: GitHubConfiguration, location_name: "GitHubConfiguration"))
-    DataSourceConfiguration.add_member(:alfresco_configuration, Shapes::ShapeRef.new(shape: AlfrescoConfiguration, location_name: "AlfrescoConfiguration"))
+    DataSourceConfiguration.add_member(:alfresco_configuration, Shapes::ShapeRef.new(shape: AlfrescoConfiguration, deprecated: true, location_name: "AlfrescoConfiguration", metadata: {"deprecatedMessage"=>"Deprecated AlfrescoConfiguration in favor of TemplateConfiguration"}))
     DataSourceConfiguration.add_member(:template_configuration, Shapes::ShapeRef.new(shape: TemplateConfiguration, location_name: "TemplateConfiguration"))
     DataSourceConfiguration.struct_class = Types::DataSourceConfiguration
 
@@ -1967,6 +1973,30 @@ module Aws::Kendra
     ResourceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     ResourceUnavailableException.struct_class = Types::ResourceUnavailableException
 
+    RetrieveRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
+    RetrieveRequest.add_member(:query_text, Shapes::ShapeRef.new(shape: QueryText, required: true, location_name: "QueryText"))
+    RetrieveRequest.add_member(:attribute_filter, Shapes::ShapeRef.new(shape: AttributeFilter, location_name: "AttributeFilter"))
+    RetrieveRequest.add_member(:requested_document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeKeyList, location_name: "RequestedDocumentAttributes"))
+    RetrieveRequest.add_member(:document_relevance_override_configurations, Shapes::ShapeRef.new(shape: DocumentRelevanceOverrideConfigurationList, location_name: "DocumentRelevanceOverrideConfigurations"))
+    RetrieveRequest.add_member(:page_number, Shapes::ShapeRef.new(shape: Integer, location_name: "PageNumber"))
+    RetrieveRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: Integer, location_name: "PageSize"))
+    RetrieveRequest.add_member(:user_context, Shapes::ShapeRef.new(shape: UserContext, location_name: "UserContext"))
+    RetrieveRequest.struct_class = Types::RetrieveRequest
+
+    RetrieveResult.add_member(:query_id, Shapes::ShapeRef.new(shape: QueryId, location_name: "QueryId"))
+    RetrieveResult.add_member(:result_items, Shapes::ShapeRef.new(shape: RetrieveResultItemList, location_name: "ResultItems"))
+    RetrieveResult.struct_class = Types::RetrieveResult
+
+    RetrieveResultItem.add_member(:id, Shapes::ShapeRef.new(shape: ResultId, location_name: "Id"))
+    RetrieveResultItem.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, location_name: "DocumentId"))
+    RetrieveResultItem.add_member(:document_title, Shapes::ShapeRef.new(shape: DocumentTitle, location_name: "DocumentTitle"))
+    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.struct_class = Types::RetrieveResultItem
+
+    RetrieveResultItemList.member = Shapes::ShapeRef.new(shape: RetrieveResultItem)
+
     S3DataSourceConfiguration.add_member(:bucket_name, Shapes::ShapeRef.new(shape: S3BucketName, required: true, location_name: "BucketName"))
     S3DataSourceConfiguration.add_member(:inclusion_prefixes, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPrefixes"))
     S3DataSourceConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
@@ -3207,6 +3237,21 @@ module Aws::Kendra
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
 
+      api.add_operation(:retrieve, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "Retrieve"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: RetrieveRequest)
+        o.output = Shapes::ShapeRef.new(shape: RetrieveResult)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:start_data_source_sync_job, Seahorse::Model::Operation.new.tap do |o|
         o.name = "StartDataSourceSyncJob"
         o.http_method = "POST"

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

@@ -740,6 +740,20 @@ module Aws::Kendra
       end
     end
 
+    class Retrieve
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::Kendra::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class StartDataSourceSyncJob
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-kendra/plugins/endpoints.rb

@@ -160,6 +160,8 @@ module Aws::Kendra
             Aws::Kendra::Endpoints::PutPrincipalMapping.build(context)
           when :query
             Aws::Kendra::Endpoints::Query.build(context)
+          when :retrieve
+            Aws::Kendra::Endpoints::Retrieve.build(context)
           when :start_data_source_sync_job
             Aws::Kendra::Endpoints::StartDataSourceSyncJob.build(context)
           when :stop_data_source_sync_job

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

@@ -119,15 +119,15 @@ module Aws::Kendra
     # Provides the configuration information to connect to Alfresco as your
     # data source.
     #
-    # <note markdown="1"> Alfresco data source connector is currently in preview mode. Basic
-    # authentication is currently supported. If you would like to use
-    # Alfresco connector in production, contact [Support][1].
+    # <note markdown="1"> Support for `AlfrescoConfiguration` ended May 2023. We recommend
+    # migrating to or using the Alfresco data source template schema /
+    # [TemplateConfiguration][1] API.
     #
     #  </note>
     #
     #
     #
-    # [1]: http://aws.amazon.com/contact-us/
+    # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
     #
     # @!attribute [rw] site_url
     #   The URL of the Alfresco site. For example, *https://hostname:8080*.
@@ -2066,6 +2066,8 @@ module Aws::Kendra
     #   format, a CSV format that includes customs attributes in a header,
     #   and a JSON format that includes custom attributes.
     #
+    #   The default format is CSV.
+    #
     #   The format must match the format of the file stored in the S3 bucket
     #   identified in the `S3Path` parameter.
     #
@@ -2634,6 +2636,14 @@ module Aws::Kendra
     # @!attribute [rw] alfresco_configuration
     #   Provides the configuration information to connect to Alfresco as
     #   your data source.
+    #
+    #   Support for `AlfrescoConfiguration` ended May 2023. We recommend
+    #   migrating to or using the Alfresco data source template schema /
+    #   [TemplateConfiguration][1] API.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
     #   @return [Types::AlfrescoConfiguration]
     #
     # @!attribute [rw] template_configuration
@@ -4246,6 +4256,10 @@ module Aws::Kendra
     #
     # @!attribute [rw] content_type
     #   The file type of the document in the `Blob` field.
+    #
+    #   If you want to index snippets or subsets of HTML documents instead
+    #   of the entirety of the HTML documents, you must add the `HTML` start
+    #   and closing tags (`<HTML>content</HTML>`) around the content.
     #   @return [String]
     #
     # @!attribute [rw] access_control_configuration_id
@@ -7487,8 +7501,7 @@ module Aws::Kendra
     end
 
     # @!attribute [rw] index_id
-    #   The identifier of the index to search. The identifier is returned in
-    #   the response from the `CreateIndex` API.
+    #   The identifier of the index for the search.
     #   @return [String]
     #
     # @!attribute [rw] query_text
@@ -7499,48 +7512,43 @@ module Aws::Kendra
     #   @return [String]
     #
     # @!attribute [rw] attribute_filter
-    #   Enables filtered searches based on document attributes. You can only
+    #   Filters search results by document fields/attributes. You can only
     #   provide one attribute filter; however, the `AndAllFilters`,
     #   `NotFilter`, and `OrAllFilters` parameters contain a list of other
     #   filters.
     #
-    #   The `AttributeFilter` parameter enables you to create a set of
+    #   The `AttributeFilter` parameter means you can create a set of
     #   filtering rules that a document must satisfy to be included in the
     #   query results.
     #   @return [Types::AttributeFilter]
     #
     # @!attribute [rw] facets
-    #   An array of documents attributes. Amazon Kendra returns a count for
-    #   each attribute key specified. This helps your users narrow their
-    #   search.
+    #   An array of documents fields/attributes for faceted search. Amazon
+    #   Kendra returns a count for each field key specified. This helps your
+    #   users narrow their search.
     #   @return [Array<Types::Facet>]
     #
     # @!attribute [rw] requested_document_attributes
-    #   An array of document attributes to include in the response. You can
-    #   limit the response to include certain document attributes. By
-    #   default all document attributes are included in the response.
+    #   An array of document fields/attributes to include in the response.
+    #   You can limit the response to include certain document fields. By
+    #   default, all document attributes are included in the response.
     #   @return [Array<String>]
     #
     # @!attribute [rw] query_result_type_filter
-    #   Sets the type of query. Only results for the specified query type
-    #   are returned.
+    #   Sets the type of query result or response. Only results for the
+    #   specified type are returned.
     #   @return [String]
     #
     # @!attribute [rw] document_relevance_override_configurations
-    #   Overrides relevance tuning configurations of fields or attributes
-    #   set at the index level.
+    #   Overrides relevance tuning configurations of fields/attributes set
+    #   at the index level.
     #
     #   If you use this API to override the relevance tuning configured at
     #   the index level, but there is no relevance tuning configured at the
     #   index level, then Amazon Kendra does not apply any relevance tuning.
     #
-    #   If there is relevance tuning configured at the index level, but you
-    #   do not use this API to override any relevance tuning in the index,
-    #   then Amazon Kendra uses the relevance tuning that is configured at
-    #   the index level.
-    #
     #   If there is relevance tuning configured for fields at the index
-    #   level, but you use this API to override only some of these fields,
+    #   level, and you use this API to override only some of these fields,
     #   then for the fields you did not override, the importance is set to
     #   1.
     #   @return [Array<Types::DocumentRelevanceConfiguration>]
@@ -7605,8 +7613,12 @@ module Aws::Kendra
     end
 
     # @!attribute [rw] query_id
-    #   The identifier for the search. You use `QueryId` to identify the
-    #   search when using the feedback API.
+    #   The identifier for the search. You also use `QueryId` to identify
+    #   the search when using the [SubmitFeedback][1] API.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html
     #   @return [String]
     #
     # @!attribute [rw] result_items
@@ -7615,12 +7627,12 @@ module Aws::Kendra
     #
     # @!attribute [rw] facet_results
     #   Contains the facet results. A `FacetResult` contains the counts for
-    #   each attribute key that was specified in the `Facets` input
+    #   each field/attribute key that was specified in the `Facets` input
     #   parameter.
     #   @return [Array<Types::FacetResult>]
     #
     # @!attribute [rw] total_number_of_results
-    #   The total number of items found by the search; however, you can only
+    #   The total number of items found by the search. However, you can only
     #   retrieve up to 100 items. For example, if the search found 192
     #   items, you can only retrieve the first 100 of the items.
     #   @return [Integer]
@@ -7688,7 +7700,8 @@ module Aws::Kendra
     #   @return [String]
     #
     # @!attribute [rw] additional_attributes
-    #   One or more additional attributes associated with the query result.
+    #   One or more additional fields/attributes associated with the query
+    #   result.
     #   @return [Array<Types::AdditionalResultAttribute>]
     #
     # @!attribute [rw] document_id
@@ -7710,27 +7723,27 @@ module Aws::Kendra
     #   @return [String]
     #
     # @!attribute [rw] document_attributes
-    #   An array of document attributes assigned to a document in the search
-    #   results. For example, the document author (`_author`) or the source
-    #   URI (`_source_uri`) of the document.
+    #   An array of document fields/attributes assigned to a document in the
+    #   search results. For example, the document author (`_author`) or the
+    #   source URI (`_source_uri`) of the document.
     #   @return [Array<Types::DocumentAttribute>]
     #
     # @!attribute [rw] score_attributes
-    #   Indicates the confidence that Amazon Kendra has that a result
-    #   matches the query that you provided. Each result is placed into a
-    #   bin that indicates the confidence, `VERY_HIGH`, `HIGH`, `MEDIUM` and
-    #   `LOW`. You can use the score to determine if a response meets the
+    #   Indicates the confidence level of Amazon Kendra providing a relevant
+    #   result for the query. Each result is placed into a bin that
+    #   indicates the confidence, `VERY_HIGH`, `HIGH`, `MEDIUM` and `LOW`.
+    #   You can use the score to determine if a response meets the
     #   confidence needed for your application.
     #
     #   The field is only set to `LOW` when the `Type` field is set to
-    #   `DOCUMENT` and Amazon Kendra is not confident that the result
-    #   matches the query.
+    #   `DOCUMENT` and Amazon Kendra is not confident that the result is
+    #   relevant to the query.
     #   @return [Types::ScoreAttributes]
     #
     # @!attribute [rw] feedback_token
     #   A token that identifies a particular result from a particular query.
     #   Use this token to provide click-through feedback for the result. For
-    #   more information, see [Submitting feedback ][1].
+    #   more information, see [Submitting feedback][1].
     #
     #
     #
@@ -8089,6 +8102,145 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # @!attribute [rw] index_id
+    #   The identifier of the index to retrieve relevant passages for the
+    #   search.
+    #   @return [String]
+    #
+    # @!attribute [rw] query_text
+    #   The input query text to retrieve relevant passages for the search.
+    #   Amazon Kendra truncates queries at 30 token words, which excludes
+    #   punctuation and stop words. Truncation still applies if you use
+    #   Boolean or more advanced, complex queries.
+    #   @return [String]
+    #
+    # @!attribute [rw] attribute_filter
+    #   Filters search results by document fields/attributes. You can only
+    #   provide one attribute filter; however, the `AndAllFilters`,
+    #   `NotFilter`, and `OrAllFilters` parameters contain a list of other
+    #   filters.
+    #
+    #   The `AttributeFilter` parameter means you can create a set of
+    #   filtering rules that a document must satisfy to be included in the
+    #   query results.
+    #   @return [Types::AttributeFilter]
+    #
+    # @!attribute [rw] requested_document_attributes
+    #   A list of document fields/attributes to include in the response. You
+    #   can limit the response to include certain document fields. By
+    #   default, all document fields are included in the response.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] document_relevance_override_configurations
+    #   Overrides relevance tuning configurations of fields/attributes set
+    #   at the index level.
+    #
+    #   If you use this API to override the relevance tuning configured at
+    #   the index level, but there is no relevance tuning configured at the
+    #   index level, then Amazon Kendra does not apply any relevance tuning.
+    #
+    #   If there is relevance tuning configured for fields at the index
+    #   level, and you use this API to override only some of these fields,
+    #   then for the fields you did not override, the importance is set to
+    #   1.
+    #   @return [Array<Types::DocumentRelevanceConfiguration>]
+    #
+    # @!attribute [rw] page_number
+    #   Retrieved relevant passages are returned in pages the size of the
+    #   `PageSize` parameter. By default, Amazon Kendra returns the first
+    #   page of results. Use this parameter to get result pages after the
+    #   first one.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] page_size
+    #   Sets the number of retrieved relevant passages that are returned in
+    #   each page of results. The default page size is 10. The maximum
+    #   number of results returned is 100. If you ask for more than 100
+    #   results, only 100 are returned.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] user_context
+    #   The user context token or user and group information.
+    #   @return [Types::UserContext]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/RetrieveRequest AWS API Documentation
+    #
+    class RetrieveRequest < Struct.new(
+      :index_id,
+      :query_text,
+      :attribute_filter,
+      :requested_document_attributes,
+      :document_relevance_override_configurations,
+      :page_number,
+      :page_size,
+      :user_context)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] query_id
+    #   The identifier of query used for the search. You also use `QueryId`
+    #   to identify the search when using the [Submitfeedback][1] API.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html
+    #   @return [String]
+    #
+    # @!attribute [rw] result_items
+    #   The results of the retrieved relevant passages for the search.
+    #   @return [Array<Types::RetrieveResultItem>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/RetrieveResult AWS API Documentation
+    #
+    class RetrieveResult < Struct.new(
+      :query_id,
+      :result_items)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A single retrieved relevant passage result.
+    #
+    # @!attribute [rw] id
+    #   The identifier of the relevant passage result.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_id
+    #   The identifier of the document.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_title
+    #   The title of the document.
+    #   @return [String]
+    #
+    # @!attribute [rw] content
+    #   The contents of the relevant passage.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_uri
+    #   The URI of the original location of the document.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_attributes
+    #   An array of document fields/attributes assigned to a document in the
+    #   search results. For example, the document author (`_author`) or the
+    #   source URI (`_source_uri`) of the document.
+    #   @return [Array<Types::DocumentAttribute>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/RetrieveResultItem AWS API Documentation
+    #
+    class RetrieveResultItem < Struct.new(
+      :id,
+      :document_id,
+      :document_title,
+      :content,
+      :document_uri,
+      :document_attributes)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides the configuration information to connect to an Amazon S3
     # bucket.
     #
@@ -8520,10 +8672,10 @@ module Aws::Kendra
     end
 
     # Provides a relative ranking that indicates how confident Amazon Kendra
-    # is that the response matches the query.
+    # is that the response is relevant to the query.
     #
     # @!attribute [rw] score_confidence
-    #   A relative ranking for how well the response matches the query.
+    #   A relative ranking for how relevant the response is to the query.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ScoreAttributes AWS API Documentation
@@ -8596,15 +8748,15 @@ module Aws::Kendra
     # @!attribute [rw] web_crawler_mode
     #   You can choose one of the following modes:
     #
-    #   * `HOST_ONLY` – crawl only the website host names. For example, if
-    #     the seed URL is "abc.example.com", then only URLs with host name
+    #   * `HOST_ONLY`—crawl only the website host names. For example, if the
+    #     seed URL is "abc.example.com", then only URLs with host name
     #     "abc.example.com" are crawled.
     #
-    #   * `SUBDOMAINS` – crawl the website host names with subdomains. For
+    #   * `SUBDOMAINS`—crawl the website host names with subdomains. For
     #     example, if the seed URL is "abc.example.com", then
     #     "a.abc.example.com" and "b.abc.example.com" are also crawled.
     #
-    #   * `EVERYTHING` – crawl the website host names with subdomains and
+    #   * `EVERYTHING`—crawl the website host names with subdomains and
     #     other domains that the web pages link to.
     #
     #   The default mode is set to `HOST_ONLY`.
@@ -8709,27 +8861,21 @@ module Aws::Kendra
     #   @return [Boolean]
     #
     # @!attribute [rw] include_attachment_file_patterns
-    #   A list of regular expression patterns to include certain attachments
-    #   of knowledge articles in your ServiceNow. Item that match the
-    #   patterns are included in the index. Items that don't match the
-    #   patterns are excluded from the index. If an item matches both an
-    #   inclusion and exclusion pattern, the exclusion pattern takes
-    #   precedence and the item isn't included in the index.
-    #
-    #   The regex is applied to the field specified in the
-    #   `PatternTargetField`.
+    #   A list of regular expression patterns applied to include knowledge
+    #   article attachments. Attachments that match the patterns are
+    #   included in the index. Items that don't match the patterns are
+    #   excluded from the index. If an item matches both an inclusion and
+    #   exclusion pattern, the exclusion pattern takes precedence and the
+    #   item isn't included in the index.
     #   @return [Array<String>]
     #
     # @!attribute [rw] exclude_attachment_file_patterns
-    #   A list of regular expression patterns to exclude certain attachments
-    #   of knowledge articles in your ServiceNow. Item that match the
-    #   patterns are excluded from the index. Items that don't match the
-    #   patterns are included in the index. If an item matches both an
-    #   inclusion and exclusion pattern, the exclusion pattern takes
-    #   precedence and the item isn't included in the index.
-    #
-    #   The regex is applied to the field specified in the
-    #   `PatternTargetField`.
+    #   A list of regular expression patterns applied to exclude certain
+    #   knowledge article attachments. Attachments that match the patterns
+    #   are excluded from the index. Items that don't match the patterns
+    #   are included in the index. If an item matches both an inclusion and
+    #   exclusion pattern, the exclusion pattern takes precedence and the
+    #   item isn't included in the index.
     #   @return [Array<String>]
     #
     # @!attribute [rw] document_data_field_name
@@ -10564,15 +10710,9 @@ module Aws::Kendra
     #   @return [Types::Urls]
     #
     # @!attribute [rw] crawl_depth
-    #   Specifies the number of levels in a website that you want to crawl.
-    #
-    #   The first level begins from the website seed or starting point URL.
-    #   For example, if a website has three levels—index level (the seed in
-    #   this example), sections level, and subsections level—and you are
-    #   only interested in crawling information up to the sections level
-    #   (levels 0-1), you can set your depth to 1.
-    #
-    #   The default crawl depth is set to 2.
+    #   The 'depth' or number of levels from the seed level to crawl. For
+    #   example, the seed URL page is depth 1 and any hyperlinks on this
+    #   page that are also crawled are depth 2.
     #   @return [Integer]
     #
     # @!attribute [rw] max_links_per_page

data/lib/aws-sdk-kendra.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kendra
 version: !ruby/object:Gem::Version
-  version: 1.67.0
+  version: 1.69.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.174.0
+        version: 3.176.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.174.0
+        version: 3.176.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement