Skip to content

Create Featured Results Set

kendra_create_featured_results_set R Documentation

Creates a set of featured results to display at the top of the search results page

Description

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.

You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.

Usage

kendra_create_featured_results_set(IndexId, FeaturedResultsSetName,
  Description, ClientToken, Status, QueryTexts, FeaturedDocuments, Tags)

Arguments

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 create_featured_results_set API with the same client token will create only one featured results set.

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 update_featured_results_set 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.

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:_ . : / = + - @.

Value

A list with the following syntax: 

list(
  FeaturedResultsSet = list(
    FeaturedResultsSetId = "string",
    FeaturedResultsSetName = "string",
    Description = "string",
    Status = "ACTIVE"|"INACTIVE",
    QueryTexts = list(
      "string"
    ),
    FeaturedDocuments = list(
      list(
        Id = "string"
      )
    ),
    LastUpdatedTimestamp = 123,
    CreationTimestamp = 123
  )
)

Request syntax

svc$create_featured_results_set(
  IndexId = "string",
  FeaturedResultsSetName = "string",
  Description = "string",
  ClientToken = "string",
  Status = "ACTIVE"|"INACTIVE",
  QueryTexts = list(
    "string"
  ),
  FeaturedDocuments = list(
    list(
      Id = "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)