Class DocumentBlock

java.lang.Object
software.amazon.awssdk.services.bedrockruntime.model.DocumentBlock
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DocumentBlock.Builder,DocumentBlock>
@Generated("software.amazon.awssdk:codegen") public final class DocumentBlock extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentBlock.Builder,DocumentBlock>

A document to include in a message.

See Also:

  • Method Details

    • format

      public final DocumentFormat format()

      The format of a document, or its extension.

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

      Returns:
      The format of a document, or its extension.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of a document, or its extension.

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

      Returns:
      The format of a document, or its extension.
      See Also:

    • name

      public final String name()

      A name for the document. The name can only contain the following characters:

      • Alphanumeric characters

      • Whitespace characters (no more than one in a row)

      • Hyphens

      • Parentheses

      • Square brackets

      This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

      Returns:
      A name for the document. The name can only contain the following characters:

      • Alphanumeric characters

      • Whitespace characters (no more than one in a row)

      • Hyphens

      • Parentheses

      • Square brackets

      This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

    • source

      public final DocumentSource source()

      Contains the content of the document.

      Returns:
      Contains the content of the document.

    • context

      public final String context()

      Contextual information about how the document should be processed or interpreted by the model when generating citations.

      Returns:
      Contextual information about how the document should be processed or interpreted by the model when generating citations.

    • citations

      public final CitationsConfig citations()

      Configuration settings that control how citations should be generated for this specific document.

      Returns:
      Configuration settings that control how citations should be generated for this specific document.

    • toBuilder

      public DocumentBlock.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DocumentBlock.Builder,DocumentBlock>
      Returns:
      a builder for type T

    • builder

      public static DocumentBlock.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DocumentBlock.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.