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

Class BedrockEmbeddingModelConfiguration

    • 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

      • hasAudio

        public final boolean hasAudio()
        For responses, this returns true if the service returned a value for the Audio property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • audio

        public final List<AudioConfiguration> audio()

        Configuration settings for processing audio content in multimodal knowledge bases.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAudio() method.

        Returns:
        Configuration settings for processing audio content in multimodal knowledge bases.

      • hasVideo

        public final boolean hasVideo()
        For responses, this returns true if the service returned a value for the Video property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • video

        public final List<VideoConfiguration> video()

        Configuration settings for processing video content in multimodal knowledge bases.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVideo() method.

        Returns:
        Configuration settings for processing video content in multimodal knowledge bases.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)