Class: Aws::Kendra::Types::QueryResult
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::QueryResult
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#facet_results ⇒ Array<Types::FacetResult>
Contains the facet results.
-
#query_id ⇒ String
The identifier for the search.
-
#result_items ⇒ Array<Types::QueryResultItem>
The results of the search.
-
#spell_corrected_queries ⇒ Array<Types::SpellCorrectedQuery>
A list of information related to suggested spell corrections for a query.
-
#total_number_of_results ⇒ Integer
The total number of items found by the search; however, you can only retrieve up to 100 items.
-
#warnings ⇒ Array<Types::Warning>
A list of warning codes and their messages on problems with your query.
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.
6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6835 class QueryResult < Struct.new( :query_id, :result_items, :facet_results, :total_number_of_results, :warnings, :spell_corrected_queries) SENSITIVE = [] include Aws::Structure end |
#query_id ⇒ String
The identifier for the search. You use QueryId
to identify the
search when using the feedback API.
6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6835 class QueryResult < Struct.new( :query_id, :result_items, :facet_results, :total_number_of_results, :warnings, :spell_corrected_queries) SENSITIVE = [] include Aws::Structure end |
#result_items ⇒ Array<Types::QueryResultItem>
The results of the search.
6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6835 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_queries ⇒ Array<Types::SpellCorrectedQuery>
A list of information related to suggested spell corrections for a query.
6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6835 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_results ⇒ Integer
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.
6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6835 class QueryResult < Struct.new( :query_id, :result_items, :facet_results, :total_number_of_results, :warnings, :spell_corrected_queries) SENSITIVE = [] include Aws::Structure end |
#warnings ⇒ Array<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.
6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6835 class QueryResult < Struct.new( :query_id, :result_items, :facet_results, :total_number_of_results, :warnings, :spell_corrected_queries) SENSITIVE = [] include Aws::Structure end |