Class: Aws::Kendra::Types::GetQuerySuggestionsRequest

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_suggestions_config ⇒ Types::AttributeSuggestionsGetConfig

Configuration information for the document fields/attributes that you want to base query suggestions on.

Returns:



5643
5644
5645
5646
5647
5648
5649
5650
5651
 
# File 'lib/aws-sdk-kendra/types.rb', line 5643

class GetQuerySuggestionsRequest < Struct.new(
  :index_id,
  :query_text,
  :max_suggestions_count,
  :suggestion_types,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index you want to get query suggestions from.

Returns:

  • (String) 


5643
5644
5645
5646
5647
5648
5649
5650
5651
 
# File 'lib/aws-sdk-kendra/types.rb', line 5643

class GetQuerySuggestionsRequest < Struct.new(
  :index_id,
  :query_text,
  :max_suggestions_count,
  :suggestion_types,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end

#max_suggestions_count ⇒ Integer

The maximum number of query suggestions you want to show to your users.

Returns:

  • (Integer) 


5643
5644
5645
5646
5647
5648
5649
5650
5651
 
# File 'lib/aws-sdk-kendra/types.rb', line 5643

class GetQuerySuggestionsRequest < Struct.new(
  :index_id,
  :query_text,
  :max_suggestions_count,
  :suggestion_types,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end

#query_text ⇒ String

The text of a user’s query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Returns:

  • (String) 


5643
5644
5645
5646
5647
5648
5649
5650
5651
 
# File 'lib/aws-sdk-kendra/types.rb', line 5643

class GetQuerySuggestionsRequest < Struct.new(
  :index_id,
  :query_text,
  :max_suggestions_count,
  :suggestion_types,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end

#suggestion_types ⇒ Array<String>

The suggestions type to base query suggestions on. The suggestion types are query history or document fields/attributes. You can set one type or the other.

If you set query history as your suggestions type, Amazon Kendra suggests queries relevant to your users based on popular queries in the query history.

If you set document fields/attributes as your suggestions type, Amazon Kendra suggests queries relevant to your users based on the contents of document fields.

Returns:

  • (Array<String>) 


5643
5644
5645
5646
5647
5648
5649
5650
5651
 
# File 'lib/aws-sdk-kendra/types.rb', line 5643

class GetQuerySuggestionsRequest < Struct.new(
  :index_id,
  :query_text,
  :max_suggestions_count,
  :suggestion_types,
  :attribute_suggestions_config)
  SENSITIVE = []
  include Aws::Structure
end