Class: Aws::Kendra::Types::RetrieveRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_filter ⇒ Types::AttributeFilter

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.

<note markdown=“1”> For Amazon Kendra Gen AI Enterprise Edition indices use ‘AttributeFilter` to enable document filtering for end users using `_email_id` or include public documents (`_email_id=null`).

</note>

Returns:



8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
 
# File 'lib/aws-sdk-kendra/types.rb', line 8596

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

#document_relevance_override_configurations ⇒ Array<Types::DocumentRelevanceConfiguration>

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.

Returns:



8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
 
# File 'lib/aws-sdk-kendra/types.rb', line 8596

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

#index_id ⇒ String

The identifier of the index to retrieve relevant passages for the search.

Returns:

  • (String) 


8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
 
# File 'lib/aws-sdk-kendra/types.rb', line 8596

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

#page_number ⇒ Integer

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.

Returns:

  • (Integer) 


8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
 
# File 'lib/aws-sdk-kendra/types.rb', line 8596

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

#page_size ⇒ Integer

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.

Returns:

  • (Integer) 


8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
 
# File 'lib/aws-sdk-kendra/types.rb', line 8596

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

#query_text ⇒ String

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. For example, ‘Timeoff AND October AND Category:HR` is counted as 3 tokens: `timeoff`, `october`, `hr`. For more information, see [Searching with advanced query syntax] in the Amazon Kendra Developer Guide.

[1]: docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax

Returns:

  • (String) 


8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
 
# File 'lib/aws-sdk-kendra/types.rb', line 8596

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

#requested_document_attributes ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
 
# File 'lib/aws-sdk-kendra/types.rb', line 8596

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

#user_context ⇒ Types::UserContext

The user context token or user and group information.

Returns:



8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
 
# File 'lib/aws-sdk-kendra/types.rb', line 8596

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