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()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseRetrievalConfiguration.Builder>	serializableBuilderClass()
KnowledgeBaseRetrievalConfiguration.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final KnowledgeBaseVectorSearchConfiguration	vectorSearchConfiguration()	Contains details about how the results from the vector search should be returned.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseRetrievalConfiguration.Builder,KnowledgeBaseRetrievalConfiguration>

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.