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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::RetrieveRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attribute_filter ⇒ Types::AttributeFilter

  Filters search results by document fields/attributes.

• #document_relevance_override_configurations ⇒ Array<Types::DocumentRelevanceConfiguration>

  Overrides relevance tuning configurations of fields/attributes set at the index level.

• #index_id ⇒ String

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

• #page_number ⇒ Integer

  Retrieved relevant passages are returned in pages the size of the ‘PageSize` parameter.

• #page_size ⇒ Integer

  Sets the number of retrieved relevant passages that are returned in each page of results.

• #query_text ⇒ String

  The input query text to retrieve relevant passages for the search.

• #requested_document_attributes ⇒ Array<String>

  A list of document fields/attributes to include in the response.

• #user_context ⇒ Types::UserContext

  The user context token or user and group information.

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.

Returns:

• (Types::AttributeFilter)

# File 'lib/aws-sdk-kendra/types.rb', line 8401

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:

• (Array<Types::DocumentRelevanceConfiguration>)

# File 'lib/aws-sdk-kendra/types.rb', line 8401

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)

# File 'lib/aws-sdk-kendra/types.rb', line 8401

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)

# File 'lib/aws-sdk-kendra/types.rb', line 8401

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)

# File 'lib/aws-sdk-kendra/types.rb', line 8401

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.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 8401

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>)

# File 'lib/aws-sdk-kendra/types.rb', line 8401

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:

• (Types::UserContext)

# File 'lib/aws-sdk-kendra/types.rb', line 8401

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