Package software.amazon.awssdk.services.bedrock.model

Class KnowledgeBaseConfig

java.lang.Object

software.amazon.awssdk.services.bedrock.model.KnowledgeBaseConfig

All Implemented Interfaces:

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

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

The configuration details for retrieving information from a knowledge base and generating responses.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseConfig.Builder
static class	KnowledgeBaseConfig.Type

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static KnowledgeBaseConfig	fromRetrieveAndGenerateConfig(Consumer<RetrieveAndGenerateConfiguration.Builder> retrieveAndGenerateConfig)	Create an instance of this class with retrieveAndGenerateConfig() initialized to the given value.
static KnowledgeBaseConfig	fromRetrieveAndGenerateConfig(RetrieveAndGenerateConfiguration retrieveAndGenerateConfig)	Create an instance of this class with retrieveAndGenerateConfig() initialized to the given value.
static KnowledgeBaseConfig	fromRetrieveConfig(Consumer<RetrieveConfig.Builder> retrieveConfig)	Create an instance of this class with retrieveConfig() initialized to the given value.
static KnowledgeBaseConfig	fromRetrieveConfig(RetrieveConfig retrieveConfig)	Create an instance of this class with retrieveConfig() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RetrieveAndGenerateConfiguration	retrieveAndGenerateConfig()	Contains configuration details for retrieving information from a knowledge base and generating responses.
RetrieveConfig	retrieveConfig()	Contains configuration details for retrieving information from a knowledge base.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseConfig.Builder>	serializableBuilderClass()
KnowledgeBaseConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
KnowledgeBaseConfig.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

retrieveConfig

public final RetrieveConfig retrieveConfig()

Contains configuration details for retrieving information from a knowledge base.

Returns:

Contains configuration details for retrieving information from a knowledge base.

retrieveAndGenerateConfig

public final RetrieveAndGenerateConfiguration retrieveAndGenerateConfig()

Contains configuration details for retrieving information from a knowledge base and generating responses.

Returns:

Contains configuration details for retrieving information from a knowledge base and generating responses.

toBuilder

public KnowledgeBaseConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KnowledgeBaseConfig.Builder,KnowledgeBaseConfig>

builder

public static KnowledgeBaseConfig.Builder builder()

serializableBuilderClass

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

fromRetrieveConfig

public static KnowledgeBaseConfig fromRetrieveConfig(RetrieveConfig retrieveConfig)

Create an instance of this class with retrieveConfig() initialized to the given value.

Contains configuration details for retrieving information from a knowledge base.

Parameters:

retrieveConfig - Contains configuration details for retrieving information from a knowledge base.

fromRetrieveConfig

public static KnowledgeBaseConfig fromRetrieveConfig(Consumer<RetrieveConfig.Builder> retrieveConfig)

Create an instance of this class with retrieveConfig() initialized to the given value.

Contains configuration details for retrieving information from a knowledge base.

Parameters:

retrieveConfig - Contains configuration details for retrieving information from a knowledge base.

fromRetrieveAndGenerateConfig

public static KnowledgeBaseConfig fromRetrieveAndGenerateConfig(RetrieveAndGenerateConfiguration retrieveAndGenerateConfig)

Create an instance of this class with retrieveAndGenerateConfig() initialized to the given value.

Contains configuration details for retrieving information from a knowledge base and generating responses.

Parameters:

retrieveAndGenerateConfig - Contains configuration details for retrieving information from a knowledge base and generating responses.

fromRetrieveAndGenerateConfig

public static KnowledgeBaseConfig fromRetrieveAndGenerateConfig(Consumer<RetrieveAndGenerateConfiguration.Builder> retrieveAndGenerateConfig)

Create an instance of this class with retrieveAndGenerateConfig() initialized to the given value.

Contains configuration details for retrieving information from a knowledge base and generating responses.

Parameters:

retrieveAndGenerateConfig - Contains configuration details for retrieving information from a knowledge base and generating responses.

type

public KnowledgeBaseConfig.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be KnowledgeBaseConfig.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be KnowledgeBaseConfig.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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