Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface KnowledgeBaseQuery.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseQuery

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

Method Summary

Modifier and Type	Method	Description
default KnowledgeBaseQuery.Builder	image(Consumer<InputImage.Builder> image)	An image to include in the knowledge base query for multimodal retrieval.
KnowledgeBaseQuery.Builder	image(InputImage image)	An image to include in the knowledge base query for multimodal retrieval.
KnowledgeBaseQuery.Builder	text(String text)	The text of the query made to the knowledge base.
KnowledgeBaseQuery.Builder	type(String type)	The type of query being performed.
KnowledgeBaseQuery.Builder	type(KnowledgeBaseQueryType type)	The type of query being performed.

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 Detail

image

KnowledgeBaseQuery.Builder image(InputImage image)

An image to include in the knowledge base query for multimodal retrieval.

Parameters:

image - An image to include in the knowledge base query for multimodal retrieval.

Returns:

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

image

default KnowledgeBaseQuery.Builder image(Consumer<InputImage.Builder> image)

An image to include in the knowledge base query for multimodal retrieval.

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

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

Parameters:

image - a consumer that will call methods on InputImage.Builder

Returns:

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

See Also:

image(InputImage)

text

KnowledgeBaseQuery.Builder text(String text)

The text of the query made to the knowledge base.

Parameters:

text - The text of the query made to the knowledge base.

Returns:

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

type

KnowledgeBaseQuery.Builder type(String type)

The type of query being performed.

Parameters:

type - The type of query being performed.

Returns:

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

See Also:

KnowledgeBaseQueryType, KnowledgeBaseQueryType

type

KnowledgeBaseQuery.Builder type(KnowledgeBaseQueryType type)

The type of query being performed.

Parameters:

type - The type of query being performed.

Returns:

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

See Also:

KnowledgeBaseQueryType, KnowledgeBaseQueryType