Document

Information about a document from a search service such as OpenSearch (self managed). Amazon Kendra Intelligent Ranking uses this information to rank and score on.

Id

The identifier of the document from the search service.

Type: String

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

Required: Yes

OriginalScore

The original document score or rank from the search service. Amazon Kendra Intelligent Ranking gives the document a new score or rank based on its intelligent search algorithms.

Type: Float

Valid Range: Minimum value of -100000. Maximum value of 100000.

Required: Yes

Body

The body text of the search service's document.

Type: String

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

Pattern: ^\P{C}*$

Required: No

GroupId

The optional group identifier of the document from the search service. Documents with the same group identifier are grouped together and processed as one document within the service.

Type: String

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

Required: No

Title

The title of the search service's document.

Type: String

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

Required: No

TokenizedBody

The body text of the search service's document represented as a list of tokens or words. You must choose to provide Body or TokenizedBody. You cannot provide both.

Type: Array of strings

Array Members: Minimum number of 1 item.

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

Required: No

TokenizedTitle

The title of the search service's document represented as a list of tokens or words. You must choose to provide Title or TokenizedTitle. You cannot provide both.

Type: Array of strings

Array Members: Minimum number of 1 item.

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

Required: No

Document

Contents

See Also