kendra / Client / describe_featured_results_set

describe_featured_results_set

kendra.Client.describe_featured_results_set(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_featured_results_set(
    IndexId='string',
    FeaturedResultsSetId='string'
)

Parameters:

• IndexId (string) –

  [REQUIRED]

  The identifier of the index used for featuring results.

• FeaturedResultsSetId (string) –

  [REQUIRED]

  The identifier of the set of featured results that you want to get information on.

Return type:

dict

Returns:

Response Syntax

{
    'FeaturedResultsSetId': 'string',
    'FeaturedResultsSetName': 'string',
    'Description': 'string',
    'Status': 'ACTIVE'|'INACTIVE',
    'QueryTexts': [
        'string',
    ],
    'FeaturedDocumentsWithMetadata': [
        {
            'Id': 'string',
            'Title': 'string',
            'URI': 'string'
        },
    ],
    'FeaturedDocumentsMissing': [
        {
            'Id': 'string'
        },
    ],
    'LastUpdatedTimestamp': 123,
    'CreationTimestamp': 123
}

Response Structure

• (dict) –

  • FeaturedResultsSetId (string) –

    The identifier of the set of featured results.

  • FeaturedResultsSetName (string) –

    The name for the set of featured results.

  • Description (string) –

    The description for the set of featured results.

  • Status (string) –

    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.

  • QueryTexts (list) –

    The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

    • (string) –

  • FeaturedDocumentsWithMetadata (list) –

    The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

    • (dict) –

      A featured document with its metadata information. This document is displayed at the top of the search results page, placed above all other results for certain queries. If there’s an exact match of a query, then the document is featured in the search results.

      • Id (string) –

        The identifier of the featured document with its metadata. 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.

      • Title (string) –

        The main title of the featured document.

      • URI (string) –

        The source URI location of the featured document.

  • FeaturedDocumentsMissing (list) –

    The list of document IDs that don’t exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don’t exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

    • (dict) –

      A document ID doesn’t exist but you have specified as a featured document. Amazon Kendra cannot feature the document if it doesn’t exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

      • Id (string) –

        The identifier of the document that doesn’t exist but you have specified as a featured document.

  • LastUpdatedTimestamp (integer) –

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

  • CreationTimestamp (integer) –

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

Exceptions

• kendra.Client.exceptions.ResourceNotFoundException

• kendra.Client.exceptions.AccessDeniedException

• kendra.Client.exceptions.ValidationException

• kendra.Client.exceptions.ThrottlingException

• kendra.Client.exceptions.InternalServerException