Skip to content

Update Featured Results Set

kendra_update_featured_results_set R Documentation

Description

Updates a set of featured results. Features 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 of a query, then one or more specific documents are featured in the search results.

Usage

kendra_update_featured_results_set(IndexId, FeaturedResultsSetId,
  FeaturedResultsSetName, Description, Status, QueryTexts,
  FeaturedDocuments)

Arguments

IndexId

[required] The identifier of the index used for featuring results.

FeaturedResultsSetId

[required] The identifier of the set of featured results that you want to update.

FeaturedResultsSetName

A new name for the set of featured results.

Description

A new description for the set of featured results.

Status

You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. 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 featured documents, see FeaturedResultsSet.

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$update_featured_results_set(
  IndexId = "string",
  FeaturedResultsSetId = "string",
  FeaturedResultsSetName = "string",
  Description = "string",
  Status = "ACTIVE"|"INACTIVE",
  QueryTexts = list(
    "string"
  ),
  FeaturedDocuments = list(
    list(
      Id = "string"
    )
  )
)