Describe Featured Results Set

kendra_describe_featured_results_set

R Documentation

Gets information about a set of featured results¶

Description¶

Gets information about a set of featured results. Features 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.

Usage¶

kendra_describe_featured_results_set(IndexId, FeaturedResultsSetId)

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 get information on.

Value¶

A list with the following syntax:

list(
  FeaturedResultsSetId = "string",
  FeaturedResultsSetName = "string",
  Description = "string",
  Status = "ACTIVE"|"INACTIVE",
  QueryTexts = list(
    "string"
  ),
  FeaturedDocumentsWithMetadata = list(
    list(
      Id = "string",
      Title = "string",
      URI = "string"
    )
  ),
  FeaturedDocumentsMissing = list(
    list(
      Id = "string"
    )
  ),
  LastUpdatedTimestamp = 123,
  CreationTimestamp = 123
)

Request syntax¶

svc$describe_featured_results_set(
  IndexId = "string",
  FeaturedResultsSetId = "string"
)