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

Class VectorKnowledgeBaseConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.VectorKnowledgeBaseConfiguration

All Implemented Interfaces:

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

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

Contains details about the model used to create vector embeddings for the knowledge base.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VectorKnowledgeBaseConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static VectorKnowledgeBaseConfiguration.Builder	builder()
String	embeddingModelArn()	The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
EmbeddingModelConfiguration	embeddingModelConfiguration()	The embeddings model configuration details for the vector model used in Knowledge Base.
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 VectorKnowledgeBaseConfiguration.Builder>	serializableBuilderClass()
SupplementalDataStorageConfiguration	supplementalDataStorageConfiguration()	If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents.
VectorKnowledgeBaseConfiguration.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

embeddingModelArn

public final String embeddingModelArn()

The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

Returns:

The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

embeddingModelConfiguration

public final EmbeddingModelConfiguration embeddingModelConfiguration()

The embeddings model configuration details for the vector model used in Knowledge Base.

Returns:

The embeddings model configuration details for the vector model used in Knowledge Base.

supplementalDataStorageConfiguration

public final SupplementalDataStorageConfiguration supplementalDataStorageConfiguration()

If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate.

Returns:

If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate.

toBuilder

public VectorKnowledgeBaseConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VectorKnowledgeBaseConfiguration.Builder,VectorKnowledgeBaseConfiguration>

builder

public static VectorKnowledgeBaseConfiguration.Builder builder()

serializableBuilderClass

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