ExpandedResultItem
A single expanded result in a collapsed group of search results.
An expanded result item contains information about an expanded result document within a collapsed group of search results. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
Contents
- DocumentAttributes
-
An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.
Type: Array of DocumentAttribute objects
Required: No
- DocumentExcerpt
-
Provides text and information about where to highlight the text.
Type: TextWithHighlights object
Required: No
- DocumentId
-
The idenitifier of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- DocumentTitle
-
Provides text and information about where to highlight the text.
Type: TextWithHighlights object
Required: No
- DocumentURI
-
The URI of the original location of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(https?|ftp|file):\/\/([^\s]*)Required: No
- Id
-
The identifier for the expanded result.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 73.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
