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

Class KnowledgeBaseQuery

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.KnowledgeBaseQuery

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KnowledgeBaseQuery.Builder,KnowledgeBaseQuery>

@Generated("software.amazon.awssdk:codegen")
public final class KnowledgeBaseQuery
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KnowledgeBaseQuery.Builder,KnowledgeBaseQuery>

Contains the query made to the knowledge base.

This data type is used in the following API operations:

• Retrieve request – in the retrievalQuery field

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseQuery.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseQuery.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputImage	image()	An image to include in the knowledge base query for multimodal retrieval.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseQuery.Builder>	serializableBuilderClass()
String	text()	The text of the query made to the knowledge base.
KnowledgeBaseQuery.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
KnowledgeBaseQueryType	type()	The type of query being performed.
String	typeAsString()	The type of query being performed.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

image

public final InputImage image()

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

Returns:

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

text

public final String text()

The text of the query made to the knowledge base.

Returns:

The text of the query made to the knowledge base.

type

public final KnowledgeBaseQueryType type()

The type of query being performed.

If the service returns an enum value that is not available in the current SDK version, type will return KnowledgeBaseQueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of query being performed.

See Also:

KnowledgeBaseQueryType

typeAsString

public final String typeAsString()

The type of query being performed.

If the service returns an enum value that is not available in the current SDK version, type will return KnowledgeBaseQueryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of query being performed.

See Also:

KnowledgeBaseQueryType

toBuilder

public KnowledgeBaseQuery.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseQuery.Builder,KnowledgeBaseQuery>

builder

public static KnowledgeBaseQuery.Builder builder()

serializableBuilderClass

public static Class<? extends KnowledgeBaseQuery.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo