Package software.amazon.awssdk.services.bedrockruntime.model

Class Message

    • Method Detail

      • roleAsString

        public final String roleAsString()

        The role that the message plays in the message.

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

        Returns:
        The role that the message plays in the message.
        See Also:
        ConversationRole

      • hasContent

        public final boolean hasContent()
        For responses, this returns true if the service returned a value for the Content 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.

      • content

        public final List<ContentBlock> content()

        The message content. Note the following restrictions:

        • You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.

        • You can include up to five documents. Each document's size must be no more than 4.5 MB.

        • If you include a ContentBlock with a document field in the array, you must also include a ContentBlock with a text field.

        • You can only include images and documents if the role is user.

        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 hasContent() method.

        Returns:
        The message content. Note the following restrictions:

        • You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.

        • You can include up to five documents. Each document's size must be no more than 4.5 MB.

        • If you include a ContentBlock with a document field in the array, you must also include a ContentBlock with a text field.

        • You can only include images and documents if the role is user.

      • serializableBuilderClass

        public static Class<? extends Message.Builder> serializableBuilderClass()

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