Class: Aws::Kendra::Types::FeaturedResultsSet
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::FeaturedResultsSet
- 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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#creation_timestamp ⇒ Integer
The Unix timestamp when the set of featured results was created.
-
#description ⇒ String
The description for the set of featured results.
-
#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.
-
#featured_results_set_id ⇒ String
The identifier of the set of featured results.
-
#featured_results_set_name ⇒ String
The name for the set of featured results.
-
#last_updated_timestamp ⇒ Integer
The Unix timestamp when the set of featured results was last updated.
-
#query_texts ⇒ Array<String>
The list of queries for featuring results.
-
#status ⇒ String
The current status of the set of featured results.
Instance Attribute Details
#creation_timestamp ⇒ Integer
The Unix timestamp when the set of featured results was created.
5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5537 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.
5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5537 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.
5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5537 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.
5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5537 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.
5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5537 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.
5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5537 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.
5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5537 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
.
5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5537 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 |