Class CitationLocation

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

Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.

See Also:

  • Method Details

    • web

      public final WebLocation web()

      The web URL that was cited for this reference.

      Returns:
      The web URL that was cited for this reference.

    • documentChar

      public final DocumentCharLocation documentChar()

      The character-level location within the document where the cited content is found.

      Returns:
      The character-level location within the document where the cited content is found.

    • documentPage

      public final DocumentPageLocation documentPage()

      The page-level location within the document where the cited content is found.

      Returns:
      The page-level location within the document where the cited content is found.

    • documentChunk

      public final DocumentChunkLocation documentChunk()

      The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

      Returns:
      The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

    • searchResultLocation

      public final SearchResultLocation searchResultLocation()

      The search result location where the cited content is found, including the search result index and block positions within the content array.

      Returns:
      The search result location where the cited content is found, including the search result index and block positions within the content array.

    • toBuilder

      public CitationLocation.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<CitationLocation.Builder,CitationLocation>
      Returns:
      a builder for type T

    • builder

      public static CitationLocation.Builder builder()

    • serializableBuilderClass

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

    • fromWeb

      public static CitationLocation fromWeb(WebLocation web)
      Create an instance of this class with web() initialized to the given value.

      The web URL that was cited for this reference.

      Parameters:
      web - The web URL that was cited for this reference.

    • fromWeb

      public static CitationLocation fromWeb(Consumer<WebLocation.Builder> web)
      Create an instance of this class with web() initialized to the given value.

      The web URL that was cited for this reference.

      Parameters:
      web - The web URL that was cited for this reference.

    • fromDocumentChar

      public static CitationLocation fromDocumentChar(DocumentCharLocation documentChar)
      Create an instance of this class with documentChar() initialized to the given value.

      The character-level location within the document where the cited content is found.

      Parameters:
      documentChar - The character-level location within the document where the cited content is found.

    • fromDocumentChar

      public static CitationLocation fromDocumentChar(Consumer<DocumentCharLocation.Builder> documentChar)
      Create an instance of this class with documentChar() initialized to the given value.

      The character-level location within the document where the cited content is found.

      Parameters:
      documentChar - The character-level location within the document where the cited content is found.

    • fromDocumentPage

      public static CitationLocation fromDocumentPage(DocumentPageLocation documentPage)
      Create an instance of this class with documentPage() initialized to the given value.

      The page-level location within the document where the cited content is found.

      Parameters:
      documentPage - The page-level location within the document where the cited content is found.

    • fromDocumentPage

      public static CitationLocation fromDocumentPage(Consumer<DocumentPageLocation.Builder> documentPage)
      Create an instance of this class with documentPage() initialized to the given value.

      The page-level location within the document where the cited content is found.

      Parameters:
      documentPage - The page-level location within the document where the cited content is found.

    • fromDocumentChunk

      public static CitationLocation fromDocumentChunk(DocumentChunkLocation documentChunk)
      Create an instance of this class with documentChunk() initialized to the given value.

      The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

      Parameters:
      documentChunk - The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

    • fromDocumentChunk

      public static CitationLocation fromDocumentChunk(Consumer<DocumentChunkLocation.Builder> documentChunk)
      Create an instance of this class with documentChunk() initialized to the given value.

      The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

      Parameters:
      documentChunk - The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

    • fromSearchResultLocation

      public static CitationLocation fromSearchResultLocation(SearchResultLocation searchResultLocation)
      Create an instance of this class with searchResultLocation() initialized to the given value.

      The search result location where the cited content is found, including the search result index and block positions within the content array.

      Parameters:
      searchResultLocation - The search result location where the cited content is found, including the search result index and block positions within the content array.

    • fromSearchResultLocation

      public static CitationLocation fromSearchResultLocation(Consumer<SearchResultLocation.Builder> searchResultLocation)
      Create an instance of this class with searchResultLocation() initialized to the given value.

      The search result location where the cited content is found, including the search result index and block positions within the content array.

      Parameters:
      searchResultLocation - The search result location where the cited content is found, including the search result index and block positions within the content array.

    • type

      public CitationLocation.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be CitationLocation.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be CitationLocation.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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