Interface RetrievalConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

RetrievalConfiguration

@Mutable
@NotThreadSafe
public static interface RetrievalConfiguration.Builder
extends SdkPojo, CopyableBuilder<RetrievalConfiguration.Builder,RetrievalConfiguration>

Method Summary

Modifier and Type	Method	Description
default RetrievalConfiguration.Builder	filter(Consumer<RetrievalFilterConfiguration.Builder> filter)	The filter configuration for content retrieval.
RetrievalConfiguration.Builder	filter(RetrievalFilterConfiguration filter)	The filter configuration for content retrieval.
default RetrievalConfiguration.Builder	knowledgeSource(Consumer<KnowledgeSource.Builder> knowledgeSource)	The knowledge source configuration for content retrieval.
RetrievalConfiguration.Builder	knowledgeSource(KnowledgeSource knowledgeSource)	The knowledge source configuration for content retrieval.
RetrievalConfiguration.Builder	numberOfResults(Integer numberOfResults)	The number of results to retrieve.
RetrievalConfiguration.Builder	overrideKnowledgeBaseSearchType(String overrideKnowledgeBaseSearchType)	Override setting for the knowledge base search type during retrieval.
RetrievalConfiguration.Builder	overrideKnowledgeBaseSearchType(KnowledgeBaseSearchType overrideKnowledgeBaseSearchType)	Override setting for the knowledge base search type during retrieval.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

knowledgeSource

RetrievalConfiguration.Builder knowledgeSource(KnowledgeSource knowledgeSource)

The knowledge source configuration for content retrieval.

Parameters:

knowledgeSource - The knowledge source configuration for content retrieval.

Returns:

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

knowledgeSource

default RetrievalConfiguration.Builder knowledgeSource(Consumer<KnowledgeSource.Builder> knowledgeSource)

The knowledge source configuration for content retrieval.

This is a convenience method that creates an instance of the KnowledgeSource.Builder avoiding the need to create one manually via KnowledgeSource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to knowledgeSource(KnowledgeSource).

Parameters:

knowledgeSource - a consumer that will call methods on KnowledgeSource.Builder

Returns:

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

See Also:

• knowledgeSource(KnowledgeSource)

filter

RetrievalConfiguration.Builder filter(RetrievalFilterConfiguration filter)

The filter configuration for content retrieval.

Parameters:

filter - The filter configuration for content retrieval.

Returns:

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

filter

default RetrievalConfiguration.Builder filter(Consumer<RetrievalFilterConfiguration.Builder> filter)

The filter configuration for content retrieval.

This is a convenience method that creates an instance of the RetrievalFilterConfiguration.Builder avoiding the need to create one manually via RetrievalFilterConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(RetrievalFilterConfiguration).

Parameters:

filter - a consumer that will call methods on RetrievalFilterConfiguration.Builder

Returns:

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

See Also:

• filter(RetrievalFilterConfiguration)

numberOfResults

RetrievalConfiguration.Builder numberOfResults(Integer numberOfResults)

The number of results to retrieve.

Parameters:

numberOfResults - The number of results to retrieve.

Returns:

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

overrideKnowledgeBaseSearchType

RetrievalConfiguration.Builder overrideKnowledgeBaseSearchType(String overrideKnowledgeBaseSearchType)

Override setting for the knowledge base search type during retrieval.

Parameters:

overrideKnowledgeBaseSearchType - Override setting for the knowledge base search type during retrieval.

Returns:

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

See Also:

• KnowledgeBaseSearchType
• KnowledgeBaseSearchType

overrideKnowledgeBaseSearchType

RetrievalConfiguration.Builder overrideKnowledgeBaseSearchType(KnowledgeBaseSearchType overrideKnowledgeBaseSearchType)

Override setting for the knowledge base search type during retrieval.

Parameters:

overrideKnowledgeBaseSearchType - Override setting for the knowledge base search type during retrieval.

Returns:

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

See Also:

• KnowledgeBaseSearchType
• KnowledgeBaseSearchType