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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::QueryResult

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #facet_results ⇒ Array<Types::FacetResult>

  Contains the facet results.

• #featured_results_items ⇒ Array<Types::FeaturedResultsItem>

  The list of featured result items.

• #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.

• #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 field/attribute key that was specified in the `Facets` input parameter.

Returns:

• (Array<Types::FacetResult>)

# 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

#featured_results_items ⇒ Array<Types::FeaturedResultsItem>

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:

• (Array<Types::FeaturedResultsItem>)

# 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_id ⇒ String

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)

# 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_items ⇒ Array<Types::QueryResultItem>

The results of the search.

Returns:

• (Array<Types::QueryResultItem>)

# 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_queries ⇒ Array<Types::SpellCorrectedQuery>

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

Returns:

• (Array<Types::SpellCorrectedQuery>)

# 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_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.

Returns:

• (Integer)

# 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

#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].

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

Returns:

• (Array<Types::Warning>)

# 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