Class: Aws::Kendra::Types::QueryResult

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#facet_resultsArray<Types::FacetResult>

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Returns:



10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10312

class QueryResult < Struct.new(
  :query_id,
  :result_items,
  :facet_results,
  :total_number_of_results,
  :warnings,
  :spell_corrected_queries)
  SENSITIVE = []
  include Aws::Structure
end

#query_idString

The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

Returns:

  • (String)


10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10312

class QueryResult < Struct.new(
  :query_id,
  :result_items,
  :facet_results,
  :total_number_of_results,
  :warnings,
  :spell_corrected_queries)
  SENSITIVE = []
  include Aws::Structure
end

#result_itemsArray<Types::QueryResultItem>

The results of the search.

Returns:



10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10312

class QueryResult < Struct.new(
  :query_id,
  :result_items,
  :facet_results,
  :total_number_of_results,
  :warnings,
  :spell_corrected_queries)
  SENSITIVE = []
  include Aws::Structure
end

#spell_corrected_queriesArray<Types::SpellCorrectedQuery>

A list of information related to suggested spell corrections for a query.

Returns:



10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10312

class QueryResult < Struct.new(
  :query_id,
  :result_items,
  :facet_results,
  :total_number_of_results,
  :warnings,
  :spell_corrected_queries)
  SENSITIVE = []
  include Aws::Structure
end

#total_number_of_resultsInteger

The total number of items found by the search; however, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

Returns:

  • (Integer)


10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10312

class QueryResult < Struct.new(
  :query_id,
  :result_items,
  :facet_results,
  :total_number_of_results,
  :warnings,
  :spell_corrected_queries)
  SENSITIVE = []
  include Aws::Structure
end

#warningsArray<Types::Warning>

A list of warning codes and their messages on problems with your query.

Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.

Returns:



10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 10312

class QueryResult < Struct.new(
  :query_id,
  :result_items,
  :facet_results,
  :total_number_of_results,
  :warnings,
  :spell_corrected_queries)
  SENSITIVE = []
  include Aws::Structure
end