public static interface RetrieveResultItem.Builder extends SdkPojo, CopyableBuilder<RetrieveResultItem.Builder,RetrieveResultItem>
| Modifier and Type | Method and Description |
|---|---|
RetrieveResultItem.Builder |
content(String content)
The contents of the relevant passage.
|
RetrieveResultItem.Builder |
documentAttributes(Collection<DocumentAttribute> documentAttributes)
An array of document fields/attributes assigned to a document in the search results.
|
RetrieveResultItem.Builder |
documentAttributes(Consumer<DocumentAttribute.Builder>... documentAttributes)
An array of document fields/attributes assigned to a document in the search results.
|
RetrieveResultItem.Builder |
documentAttributes(DocumentAttribute... documentAttributes)
An array of document fields/attributes assigned to a document in the search results.
|
RetrieveResultItem.Builder |
documentId(String documentId)
The identifier of the document.
|
RetrieveResultItem.Builder |
documentTitle(String documentTitle)
The title of the document.
|
RetrieveResultItem.Builder |
documentURI(String documentURI)
The URI of the original location of the document.
|
RetrieveResultItem.Builder |
id(String id)
The identifier of the relevant passage result.
|
default RetrieveResultItem.Builder |
scoreAttributes(Consumer<ScoreAttributes.Builder> scoreAttributes)
The confidence score bucket for a retrieved passage result.
|
RetrieveResultItem.Builder |
scoreAttributes(ScoreAttributes scoreAttributes)
The confidence score bucket for a retrieved passage result.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildRetrieveResultItem.Builder id(String id)
The identifier of the relevant passage result.
id - The identifier of the relevant passage result.RetrieveResultItem.Builder documentId(String documentId)
The identifier of the document.
documentId - The identifier of the document.RetrieveResultItem.Builder documentTitle(String documentTitle)
The title of the document.
documentTitle - The title of the document.RetrieveResultItem.Builder content(String content)
The contents of the relevant passage.
content - The contents of the relevant passage.RetrieveResultItem.Builder documentURI(String documentURI)
The URI of the original location of the document.
documentURI - The URI of the original location of the document.RetrieveResultItem.Builder documentAttributes(Collection<DocumentAttribute> 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.
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.RetrieveResultItem.Builder documentAttributes(DocumentAttribute... 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.
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.RetrieveResultItem.Builder documentAttributes(Consumer<DocumentAttribute.Builder>... 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.
DocumentAttribute.Builder avoiding the need to create
one manually via DocumentAttribute.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately
and its result is passed to #documentAttributes(List.
documentAttributes - a consumer that will call methods on
DocumentAttribute.Builder#documentAttributes(java.util.Collection) RetrieveResultItem.Builder scoreAttributes(ScoreAttributes 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.
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.default RetrieveResultItem.Builder scoreAttributes(Consumer<ScoreAttributes.Builder> 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.
This is a convenience method that creates an instance of theScoreAttributes.Builder avoiding the
need to create one manually via ScoreAttributes.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to scoreAttributes(ScoreAttributes).
scoreAttributes - a consumer that will call methods on ScoreAttributes.BuilderscoreAttributes(ScoreAttributes)Copyright © 2023. All rights reserved.