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.

CreationTimestamp

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

Type: Long

Required: No

Description

The description for the set of featured results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: ^\P{C}*$

Required: No

FeaturedDocuments

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.

Type: Array of FeaturedDocument objects

Required: No

FeaturedResultsSetId

The identifier of the set of featured results.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-zA-Z-0-9]*

Required: No

FeaturedResultsSetName

The name for the set of featured results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: [a-zA-Z0-9][ a-zA-Z0-9_-]*

Required: No

LastUpdatedTimestamp

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

Type: Long

Required: No

QueryTexts

The list of queries for featuring results.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 49 items.

Required: No

Status

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.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No

FeaturedResultsSet

Contents

See Also