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

Class BedrockEmbeddingModelConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.BedrockEmbeddingModelConfiguration

All Implemented Interfaces:

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

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

The vector configuration details for the Bedrock embeddings model.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BedrockEmbeddingModelConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static BedrockEmbeddingModelConfiguration.Builder	builder()
Integer	dimensions()	The dimensions details for the vector configuration used on the Bedrock embeddings model.
EmbeddingDataType	embeddingDataType()	The data type for the vectors when using a model to convert text into vector embeddings.
String	embeddingDataTypeAsString()	The data type for the vectors when using a model to convert text into vector embeddings.
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 BedrockEmbeddingModelConfiguration.Builder>	serializableBuilderClass()
BedrockEmbeddingModelConfiguration.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

dimensions

public final Integer dimensions()

The dimensions details for the vector configuration used on the Bedrock embeddings model.

Returns:

The dimensions details for the vector configuration used on the Bedrock embeddings model.

embeddingDataType

public final EmbeddingDataType embeddingDataType()

The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See Supported embeddings models for information on the available models and their vector data types.

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

Returns:

The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See Supported embeddings models for information on the available models and their vector data types.

See Also:

EmbeddingDataType

embeddingDataTypeAsString

public final String embeddingDataTypeAsString()

The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See Supported embeddings models for information on the available models and their vector data types.

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

Returns:

The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See Supported embeddings models for information on the available models and their vector data types.

See Also:

EmbeddingDataType

toBuilder

public BedrockEmbeddingModelConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BedrockEmbeddingModelConfiguration.Builder,BedrockEmbeddingModelConfiguration>

builder

public static BedrockEmbeddingModelConfiguration.Builder builder()

serializableBuilderClass

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