RetrieveResultItem
A single retrieved relevant passage result.
Contents
- Content
-
The contents of the relevant passage.
Type: String
Required: No
- DocumentAttributes
-
An array of document fields/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
- DocumentId
-
The identifier of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
- DocumentTitle
-
The title of the document.
Type: String
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 of the relevant passage result.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 73.
Required: No
- ScoreAttributes
-
The confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
Type: ScoreAttributes object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
