FeaturedDocumentWithMetadata - Amazon Kendra API Reference

FeaturedDocumentWithMetadata

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.

Contents

Id

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Title

The main title of the featured document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

URI

The source URI location of the featured document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^(https?|ftp|file):\/\/([^\s]*)

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: