Package software.amazon.awssdk.services.bedrockagent.model

Class KnowledgeBaseConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.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>

Contains details about the vector embeddings configuration of the knowledge base.

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()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final KendraKnowledgeBaseConfiguration	kendraKnowledgeBaseConfiguration()	Settings for an Amazon Kendra knowledge base.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseConfiguration.Builder>	serializableBuilderClass()
final SqlKnowledgeBaseConfiguration	sqlKnowledgeBaseConfiguration()	Specifies configurations for a knowledge base connected to an SQL database.
KnowledgeBaseConfiguration.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final KnowledgeBaseType	type()	The type of data that the data source is converted into for the knowledge base.
final String	typeAsString()	The type of data that the data source is converted into for the knowledge base.
final VectorKnowledgeBaseConfiguration	vectorKnowledgeBaseConfiguration()	Contains details about the model that's used to convert the data source into vector embeddings.

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 Details

type

public final KnowledgeBaseType type()

The type of data that the data source is converted into for the knowledge base.

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

Returns:

The type of data that the data source is converted into for the knowledge base.

See Also:

• KnowledgeBaseType

typeAsString

public final String typeAsString()

The type of data that the data source is converted into for the knowledge base.

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

Returns:

The type of data that the data source is converted into for the knowledge base.

See Also:

• KnowledgeBaseType

vectorKnowledgeBaseConfiguration

public final VectorKnowledgeBaseConfiguration vectorKnowledgeBaseConfiguration()

Contains details about the model that's used to convert the data source into vector embeddings.

Returns:

Contains details about the model that's used to convert the data source into vector embeddings.

kendraKnowledgeBaseConfiguration

public final KendraKnowledgeBaseConfiguration kendraKnowledgeBaseConfiguration()

Settings for an Amazon Kendra knowledge base.

Returns:

Settings for an Amazon Kendra knowledge base.

sqlKnowledgeBaseConfiguration

public final SqlKnowledgeBaseConfiguration sqlKnowledgeBaseConfiguration()

Specifies configurations for a knowledge base connected to an SQL database.

Returns:

Specifies configurations for a knowledge base connected to an SQL database.

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