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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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 field/attribute key that was specified in the `Facets` input parameter.

Returns:



8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
# File 'lib/aws-sdk-kendra/types.rb', line 8027

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

The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there’s an exact match of a query, then certain documents are featured in the search results.

Returns:



8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
# File 'lib/aws-sdk-kendra/types.rb', line 8027

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

#query_idString

The identifier for the search. You also use ‘QueryId` to identify the search when using the [SubmitFeedback] API.

[1]: docs.aws.amazon.com/kendra/latest/APIReference/API_SubmitFeedback.html

Returns:

  • (String)


8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
# File 'lib/aws-sdk-kendra/types.rb', line 8027

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

#result_itemsArray<Types::QueryResultItem>

The results of the search.

Returns:



8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
# File 'lib/aws-sdk-kendra/types.rb', line 8027

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

#spell_corrected_queriesArray<Types::SpellCorrectedQuery>

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

Returns:



8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
# File 'lib/aws-sdk-kendra/types.rb', line 8027

class QueryResult < Struct.new(
  :query_id,
  :result_items,
  :facet_results,
  :total_number_of_results,
  :warnings,
  :spell_corrected_queries,
  :featured_results_items)
  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)


8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
# File 'lib/aws-sdk-kendra/types.rb', line 8027

class QueryResult < Struct.new(
  :query_id,
  :result_items,
  :facet_results,
  :total_number_of_results,
  :warnings,
  :spell_corrected_queries,
  :featured_results_items)
  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].

[1]: docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax

Returns:



8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
# File 'lib/aws-sdk-kendra/types.rb', line 8027

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