Class: Aws::Kendra::Types::FeaturedResultsSet

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

Overview

A set of featured results that are displayed at the top of your search results. Featured results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timestamp ⇒ Integer

The Unix timestamp when the set of featured results was created.

Returns:

  • (Integer) 


5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5570

class FeaturedResultsSet < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the set of featured results.

Returns:

  • (String) 


5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5570

class FeaturedResultsSet < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#featured_documents ⇒ Array<Types::FeaturedDocument>

The list of document IDs for the documents you want to feature at the top of the search results page. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

You can add up to four featured documents. You can request to increase this limit by contacting Support.

Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

Returns:



5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5570

class FeaturedResultsSet < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#featured_results_set_id ⇒ String

The identifier of the set of featured results.

Returns:

  • (String) 


5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5570

class FeaturedResultsSet < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#featured_results_set_name ⇒ String

The name for the set of featured results.

Returns:

  • (String) 


5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5570

class FeaturedResultsSet < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timestamp ⇒ Integer

The Unix timestamp when the set of featured results was last updated.

Returns:

  • (Integer) 


5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5570

class FeaturedResultsSet < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#query_texts ⇒ Array<String>

The list of queries for featuring results.

Specific queries are mapped to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the results. The exact match applies to the full query. For example, if you only specify 'Kendra', queries such as 'How does kendra semantically rank results?' will not render the featured results. Featured results are designed for specific queries, rather than queries that are too broad in scope.

Returns:

  • (Array<String>) 


5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5570

class FeaturedResultsSet < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

Returns:

  • (String) 


5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5570

class FeaturedResultsSet < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end