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

Class KnowledgeBaseRetrievalConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.KnowledgeBaseRetrievalConfiguration

All Implemented Interfaces:

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

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

Contains configurations for knowledge base query. For more information, see Query configurations.

This data type is used in the following API operations:

• Retrieve request – in the retrievalConfiguration field

• RetrieveAndGenerate request – in the retrievalConfiguration field

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseRetrievalConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseRetrievalConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseRetrievalConfiguration.Builder>	serializableBuilderClass()
KnowledgeBaseRetrievalConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
KnowledgeBaseVectorSearchConfiguration	vectorSearchConfiguration()	Contains details about how the results from the vector search should be returned.

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

vectorSearchConfiguration

public final KnowledgeBaseVectorSearchConfiguration vectorSearchConfiguration()

Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

Returns:

Contains details about how the results from the vector search should be returned. For more information, see Query configurations.

toBuilder

public KnowledgeBaseRetrievalConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseRetrievalConfiguration.Builder,KnowledgeBaseRetrievalConfiguration>

builder

public static KnowledgeBaseRetrievalConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends KnowledgeBaseRetrievalConfiguration.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