Class: Aws::Kendra::Types::QueryRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::QueryRequest

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.

• #collapse_configuration ⇒ Types::CollapseConfiguration

  Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.

• #document_relevance_override_configurations ⇒ Array<Types::DocumentRelevanceConfiguration>

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

• #facets ⇒ Array<Types::Facet>

  An array of documents fields/attributes for faceted search.

• #index_id ⇒ String

  The identifier of the index for the search.

• #page_number ⇒ Integer

  Query results are returned in pages the size of the ‘PageSize` parameter.

• #page_size ⇒ Integer

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

• #query_result_type_filter ⇒ String

  Sets the type of query result or response.

• #query_text ⇒ String

  The input query text for the search.

• #requested_document_attributes ⇒ Array<String>

  An array of document fields/attributes to include in the response.

• #sorting_configuration ⇒ Types::SortingConfiguration

  Provides information that determines how the results of the query are sorted.

• #sorting_configurations ⇒ Array<Types::SortingConfiguration>

  Provides configuration information to determine how the results of a query are sorted.

• #spell_correction_configuration ⇒ Types::SpellCorrectionConfiguration

  Enables suggested spell corrections for queries.

• #user_context ⇒ Types::UserContext

  The user context token or user and group information.

• #visitor_id ⇒ String

  Provides an identifier for a specific user.

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:

• (Types::AttributeFilter)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#collapse_configuration ⇒ Types::CollapseConfiguration

Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.

Returns:

• (Types::CollapseConfiguration)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  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 8003

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#facets ⇒ Array<Types::Facet>

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.

Returns:

• (Array<Types::Facet>)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index for the search.

Returns:

• (String)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#page_number ⇒ Integer

Query results 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 8003

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#page_size ⇒ Integer

Sets the number of results 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 8003

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#query_result_type_filter ⇒ String

Sets the type of query result or response. Only results for the specified type are returned.

Returns:

• (String)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#query_text ⇒ String

The input query text 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)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#requested_document_attributes ⇒ Array<String>

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.

Returns:

• (Array<String>)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sorting_configuration ⇒ Types::SortingConfiguration

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don’t provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Returns:

• (Types::SortingConfiguration)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sorting_configurations ⇒ Array<Types::SortingConfiguration>

Provides configuration information to determine how the results of a query are sorted.

You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.

If you don’t provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.

Returns:

• (Array<Types::SortingConfiguration>)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#spell_correction_configuration ⇒ Types::SpellCorrectionConfiguration

Enables suggested spell corrections for queries.

Returns:

• (Types::SpellCorrectionConfiguration)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  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 8003

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#visitor_id ⇒ String

Provides an identifier for a specific user. The ‘VisitorId` should be a unique identifier, such as a GUID. Don’t use personally identifiable information, such as the user’s email address, as the ‘VisitorId`.

Returns:

• (String)

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

class QueryRequest < Struct.new(
  :index_id,
  :query_text,
  :attribute_filter,
  :facets,
  :requested_document_attributes,
  :query_result_type_filter,
  :document_relevance_override_configurations,
  :page_number,
  :page_size,
  :sorting_configuration,
  :sorting_configurations,
  :user_context,
  :visitor_id,
  :spell_correction_configuration,
  :collapse_configuration)
  SENSITIVE = []
  include Aws::Structure
end