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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#facet_results ⇒ Array<Types::FacetResult>

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

Returns:



3272
3273
3274
3275
3276
3277
3278
3279
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3272

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

#query_id ⇒ String

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

Returns:

  • (String) 


3272
3273
3274
3275
3276
3277
3278
3279
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3272

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

#result_items ⇒ Array<Types::QueryResultItem>

The results of the search.

Returns:



3272
3273
3274
3275
3276
3277
3278
3279
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3272

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

#total_number_of_results ⇒ Integer

The number of items returned by the search. Use this to determine when you have requested the last set of results.

Returns:

  • (Integer) 


3272
3273
3274
3275
3276
3277
3278
3279
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3272

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