software.amazon.awssdk.services.kendra.model

Interface QueryResultItem.Builder

All Superinterfaces:

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

Enclosing class:

QueryResultItem

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

Method Summary

Modifier and Type	Method and Description
QueryResultItem.Builder	additionalAttributes(AdditionalResultAttribute... additionalAttributes) One or more additional attributes associated with the query result.
QueryResultItem.Builder	additionalAttributes(Collection<AdditionalResultAttribute> additionalAttributes) One or more additional attributes associated with the query result.
QueryResultItem.Builder	additionalAttributes(Consumer<AdditionalResultAttribute.Builder>... additionalAttributes) One or more additional attributes associated with the query result.
QueryResultItem.Builder	documentAttributes(Collection<DocumentAttribute> documentAttributes) An array of document attributes for the document that the query result maps to.
QueryResultItem.Builder	documentAttributes(Consumer<DocumentAttribute.Builder>... documentAttributes) An array of document attributes for the document that the query result maps to.
QueryResultItem.Builder	documentAttributes(DocumentAttribute... documentAttributes) An array of document attributes for the document that the query result maps to.
default QueryResultItem.Builder	documentExcerpt(Consumer<TextWithHighlights.Builder> documentExcerpt) An extract of the text in the document.
QueryResultItem.Builder	documentExcerpt(TextWithHighlights documentExcerpt) An extract of the text in the document.
QueryResultItem.Builder	documentId(String documentId) The unique identifier for the document.
default QueryResultItem.Builder	documentTitle(Consumer<TextWithHighlights.Builder> documentTitle) The title of the document.
QueryResultItem.Builder	documentTitle(TextWithHighlights documentTitle) The title of the document.
QueryResultItem.Builder	documentURI(String documentURI) The URI of the original location of the document.
QueryResultItem.Builder	id(String id) The unique identifier for the query result.
default QueryResultItem.Builder	scoreAttributes(Consumer<ScoreAttributes.Builder> scoreAttributes) Indicates the confidence that Amazon Kendra has that a result matches the query that you provided.
QueryResultItem.Builder	scoreAttributes(ScoreAttributes scoreAttributes) Indicates the confidence that Amazon Kendra has that a result matches the query that you provided.
QueryResultItem.Builder	type(QueryResultType type) The type of document.
QueryResultItem.Builder	type(String type) The type of document.

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

QueryResultItem.Builder id(String id)

The unique identifier for the query result.

Parameters:

id - The unique identifier for the query result.

Returns:

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

type

QueryResultItem.Builder type(String type)

The type of document.

Parameters:

type - The type of document.

Returns:

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

See Also:

QueryResultType, QueryResultType

type

QueryResultItem.Builder type(QueryResultType type)

The type of document.

Parameters:

type - The type of document.

Returns:

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

See Also:

QueryResultType, QueryResultType

additionalAttributes

QueryResultItem.Builder additionalAttributes(Collection<AdditionalResultAttribute> additionalAttributes)

One or more additional attributes associated with the query result.

Parameters:

additionalAttributes - One or more additional attributes associated with the query result.

Returns:

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

additionalAttributes

QueryResultItem.Builder additionalAttributes(AdditionalResultAttribute... additionalAttributes)

One or more additional attributes associated with the query result.

Parameters:

additionalAttributes - One or more additional attributes associated with the query result.

Returns:

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

additionalAttributes

QueryResultItem.Builder additionalAttributes(Consumer<AdditionalResultAttribute.Builder>... additionalAttributes)

One or more additional attributes associated with the query result.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #additionalAttributes(List).

Parameters:

additionalAttributes - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#additionalAttributes(List)

documentId

QueryResultItem.Builder documentId(String documentId)

The unique identifier for the document.

Parameters:

documentId - The unique identifier for the document.

Returns:

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

documentTitle

QueryResultItem.Builder documentTitle(TextWithHighlights documentTitle)

The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

Parameters:

documentTitle - The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

Returns:

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

documentTitle

default QueryResultItem.Builder documentTitle(Consumer<TextWithHighlights.Builder> documentTitle)

The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

This is a convenience that creates an instance of the TextWithHighlights.Builder avoiding the need to create one manually via TextWithHighlights.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentTitle(TextWithHighlights).

Parameters:

documentTitle - a consumer that will call methods on TextWithHighlights.Builder

Returns:

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

See Also:

documentTitle(TextWithHighlights)

documentExcerpt

QueryResultItem.Builder documentExcerpt(TextWithHighlights documentExcerpt)

An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

Parameters:

documentExcerpt - An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

Returns:

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

documentExcerpt

default QueryResultItem.Builder documentExcerpt(Consumer<TextWithHighlights.Builder> documentExcerpt)

An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

This is a convenience that creates an instance of the TextWithHighlights.Builder avoiding the need to create one manually via TextWithHighlights.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentExcerpt(TextWithHighlights).

Parameters:

documentExcerpt - a consumer that will call methods on TextWithHighlights.Builder

Returns:

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

See Also:

documentExcerpt(TextWithHighlights)

documentURI

QueryResultItem.Builder documentURI(String documentURI)

The URI of the original location of the document.

Parameters:

documentURI - The URI of the original location of the document.

Returns:

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

documentAttributes

QueryResultItem.Builder documentAttributes(Collection<DocumentAttribute> documentAttributes)

An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

Parameters:

documentAttributes - An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

Returns:

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

documentAttributes

QueryResultItem.Builder documentAttributes(DocumentAttribute... documentAttributes)

An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

Parameters:

documentAttributes - An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

Returns:

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

documentAttributes

QueryResultItem.Builder documentAttributes(Consumer<DocumentAttribute.Builder>... documentAttributes)

An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #documentAttributes(List).

Parameters:

documentAttributes - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#documentAttributes(List)

scoreAttributes

QueryResultItem.Builder scoreAttributes(ScoreAttributes scoreAttributes)

Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

Parameters:

scoreAttributes - Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

Returns:

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

scoreAttributes

default QueryResultItem.Builder scoreAttributes(Consumer<ScoreAttributes.Builder> scoreAttributes)

Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.

This is a convenience that creates an instance of the ScoreAttributes.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).

Parameters:

scoreAttributes - a consumer that will call methods on ScoreAttributes.Builder

Returns:

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

See Also:

scoreAttributes(ScoreAttributes)