FeaturedResultsSet
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.
Types
Properties
The Unix timestamp when the set of featured results was created.
The description for the set of featured results.
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.
The identifier of the set of featured results.
The name for the set of featured results.
The Unix timestamp when the set of featured results was last updated.
The list of queries for featuring results.
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
.