Package ai.docling.serve.api.chunk.response

Class Chunk.Builder

java.lang.Object
ai.docling.serve.api.chunk.response.Chunk.Builder
Enclosing class:
Chunk
public static class Chunk.Builder extends Object
Builder for creating Chunk instances. Generated by Lombok's @Builder annotation.

Builder methods:

  • filename(String) - Set the filename of the source document
  • chunkIndex(int) - Set the zero-based chunk index
  • text(String) - Set the formatted chunk text
  • rawText(String) - Set the raw chunk text
  • numTokens(Integer) - Set the number of tokens
  • heading(String) - Add a single heading (use with @Singular)
  • headings(List<String>) - Set the list of headings
  • caption(String) - Add a single caption (use with @Singular)
  • captions(List<String>) - Set the list of captions
  • docItem(String) - Add a single doc item reference (use with @Singular)
  • docItems(List<String>) - Set the list of doc items
  • pageNumber(Integer) - Add a single page number (use with @Singular)
  • pageNumbers(List<Integer>) - Set the list of page numbers
  • metadata(String, Object) - Add a single metadata entry (use with @Singular)
  • metadata(Map<String, Object>) - Set the metadata map

  • Method Details

    • filename

      public @NonNull Chunk.Builder filename(String filename)
      Filename of the source document.
      Parameters:
      filename - the filename of the source document
      Returns:
      this.

    • chunkIndex

      public @NonNull Chunk.Builder chunkIndex(int chunkIndex)
      Index of this chunk within the document.
      Parameters:
      chunkIndex - the zero-based chunk index
      Returns:
      this.

    • text

      public @NonNull Chunk.Builder text(String text)
      The chunk text with structural context (headers, formatting).
      Parameters:
      text - the formatted chunk text
      Returns:
      this.

    • rawText

      public @NonNull Chunk.Builder rawText(@Nullable String rawText)
      Raw chunk text without additional formatting or context.
      Parameters:
      rawText - the raw chunk text, or null if not included
      Returns:
      this.

    • numTokens

      public @NonNull Chunk.Builder numTokens(Integer numTokens)
      Number of tokens in the text, if the chunker is aware of tokens.
      Parameters:
      numTokens - the number of tokens, or null if not calculated
      Returns:
      this.

    • heading

      public @NonNull Chunk.Builder heading(String heading)

    • headings

      public @NonNull Chunk.Builder headings(@NonNull Collection<? extends String> headings)

    • clearHeadings

      public @NonNull Chunk.Builder clearHeadings()

    • caption

      public @NonNull Chunk.Builder caption(String caption)

    • captions

      public @NonNull Chunk.Builder captions(@NonNull Collection<? extends String> captions)

    • clearCaptions

      public @NonNull Chunk.Builder clearCaptions()

    • docItem

      public @NonNull Chunk.Builder docItem(String docItem)

    • docItems

      public @NonNull Chunk.Builder docItems(@NonNull Collection<? extends String> docItems)

    • clearDocItems

      public @NonNull Chunk.Builder clearDocItems()

    • pageNumber

      public @NonNull Chunk.Builder pageNumber(Integer pageNumber)

    • pageNumbers

      public @NonNull Chunk.Builder pageNumbers(@NonNull Collection<? extends Integer> pageNumbers)

    • clearPageNumbers

      public @NonNull Chunk.Builder clearPageNumbers()

    • metadata

      public @NonNull Chunk.Builder metadata(String metadataKey, Object metadataValue)

    • metadata

      public @NonNull Chunk.Builder metadata(@NonNull Map<? extends String,? extends Object> metadata)

    • clearMetadata

      public @NonNull Chunk.Builder clearMetadata()

    • build

      public @NonNull Chunk build()

    • toString

      public @NonNull String toString()
      Overrides:
      toString in class Object