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

Class KnowledgeBaseConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.KnowledgeBaseConfiguration

All Implemented Interfaces:

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

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

Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	knowledgeBaseId()	The unique identifier for a knowledge base attached to the agent.
KnowledgeBaseRetrievalConfiguration	retrievalConfiguration()	The configurations to apply to the knowledge base during query.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseConfiguration.Builder>	serializableBuilderClass()
KnowledgeBaseConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

knowledgeBaseId

public final String knowledgeBaseId()

The unique identifier for a knowledge base attached to the agent.

Returns:

The unique identifier for a knowledge base attached to the agent.

retrievalConfiguration

public final KnowledgeBaseRetrievalConfiguration retrievalConfiguration()

The configurations to apply to the knowledge base during query. For more information, see Query configurations.

Returns:

The configurations to apply to the knowledge base during query. For more information, see Query configurations.

toBuilder

public KnowledgeBaseConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseConfiguration.Builder,KnowledgeBaseConfiguration>

builder

public static KnowledgeBaseConfiguration.Builder builder()

serializableBuilderClass

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