View source: R/kendra_operations.R
kendra_create_featured_results_set | R Documentation |
Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries 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 search results.
See https://www.paws-r-sdk.com/docs/kendra_create_featured_results_set/ for full documentation.
kendra_create_featured_results_set(
IndexId,
FeaturedResultsSetName,
Description = NULL,
ClientToken = NULL,
Status = NULL,
QueryTexts = NULL,
FeaturedDocuments = NULL,
Tags = NULL
)
IndexId |
[required] The identifier of the index that you want to use for featuring results. |
FeaturedResultsSetName |
[required] A name for the set of featured results. |
Description |
A description for the set of featured results. |
ClientToken |
A token that you provide to identify the request to create a set of
featured results. Multiple calls to the
|
Status |
The current status of the set of featured results. When the value is
|
QueryTexts |
A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet. |
FeaturedDocuments |
A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet. |
Tags |
A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @. |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.