software.amazon.awssdk.services.kendraranking.model

Interface Document.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Document.Builder,Document>, SdkBuilder<Document.Builder,Document>, SdkPojo

Enclosing class:

Document

public static interface Document.Builder
extends SdkPojo, CopyableBuilder<Document.Builder,Document>

Method Summary

Modifier and Type	Method and Description
Document.Builder	body(String body) The body text of the search service's document.
Document.Builder	groupId(String groupId) The optional group identifier of the document from the search service.
Document.Builder	id(String id) The identifier of the document from the search service.
Document.Builder	originalScore(Float originalScore) The original document score or rank from the search service.
Document.Builder	title(String title) The title of the search service's document.
Document.Builder	tokenizedBody(Collection<String> tokenizedBody) The body text of the search service's document represented as a list of tokens or words.
Document.Builder	tokenizedBody(String... tokenizedBody) The body text of the search service's document represented as a list of tokens or words.
Document.Builder	tokenizedTitle(Collection<String> tokenizedTitle) The title of the search service's document represented as a list of tokens or words.
Document.Builder	tokenizedTitle(String... tokenizedTitle) The title of the search service's document represented as a list of tokens or words.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

id

Document.Builder id(String id)

The identifier of the document from the search service.

Parameters:

id - The identifier of the document from the search service.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupId

Document.Builder groupId(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

title

Document.Builder title(String title)

The title of the search service's document.

Parameters:

title - The title of the search service's document.

Returns:

Returns a reference to this object so that method calls can be chained together.

body

Document.Builder body(String body)

The body text of the search service's document.

Parameters:

body - The body text of the search service's document.

Returns:

Returns a reference to this object so that method calls can be chained together.

tokenizedTitle

Document.Builder tokenizedTitle(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tokenizedTitle

Document.Builder tokenizedTitle(String... 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tokenizedBody

Document.Builder tokenizedBody(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tokenizedBody

Document.Builder tokenizedBody(String... 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

originalScore

Document.Builder originalScore(Float 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.