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

Inherits:

Struct

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

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attribute_filter ⇒ Types::AttributeFilter

  Enables filtered searches based on document attributes.

• #document_relevance_override_configurations ⇒ Array<Types::DocumentRelevanceConfiguration>

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

• #facets ⇒ Array<Types::Facet>

  An array of documents attributes.

• #index_id ⇒ String

  The identifier of the index to 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.

• #query_text ⇒ String

  The input query text for the search.

• #requested_document_attributes ⇒ Array<String>

  An array of document attributes to include in the response.

• #sorting_configuration ⇒ Types::SortingConfiguration

  Provides information that determines how the results of the 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

Enables filtered searches based on document 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 filtering rules that a document must satisfy to be included in the query results.

Returns:

• (Types::AttributeFilter)

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

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,
  :user_context,
  :visitor_id,
  :spell_correction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#document_relevance_override_configurations ⇒ Array<Types::DocumentRelevanceConfiguration>

Overrides relevance tuning configurations of fields or 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 the fields you did not override, the importance is set to 1.

Returns:

• (Array<Types::DocumentRelevanceConfiguration>)

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

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,
  :user_context,
  :visitor_id,
  :spell_correction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#facets ⇒ Array<Types::Facet>

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.

Returns:

• (Array<Types::Facet>)

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

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,
  :user_context,
  :visitor_id,
  :spell_correction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index to search. The identifier is returned in the response from the CreateIndex API.

Returns:

• (String)

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

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,
  :user_context,
  :visitor_id,
  :spell_correction_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 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7589

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,
  :user_context,
  :visitor_id,
  :spell_correction_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 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7589

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,
  :user_context,
  :visitor_id,
  :spell_correction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#query_result_type_filter ⇒ String

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

Returns:

• (String)

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

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,
  :user_context,
  :visitor_id,
  :spell_correction_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.

Returns:

• (String)

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

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,
  :user_context,
  :visitor_id,
  :spell_correction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#requested_document_attributes ⇒ Array<String>

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.

Returns:

• (Array<String>)

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

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,
  :user_context,
  :visitor_id,
  :spell_correction_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 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7589

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,
  :user_context,
  :visitor_id,
  :spell_correction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#spell_correction_configuration ⇒ Types::SpellCorrectionConfiguration

Enables suggested spell corrections for queries.

Returns:

• (Types::SpellCorrectionConfiguration)

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

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,
  :user_context,
  :visitor_id,
  :spell_correction_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#user_context ⇒ Types::UserContext

The user context token or user and group information.

Returns:

• (Types::UserContext)

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

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,
  :user_context,
  :visitor_id,
  :spell_correction_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 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 7589

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,
  :user_context,
  :visitor_id,
  :spell_correction_configuration)
  SENSITIVE = []
  include Aws::Structure
end