Class CitationDocument.Builder

java.lang.Object
org.springframework.ai.anthropic.api.CitationDocument.Builder
Enclosing class:
CitationDocument
public static class CitationDocument.Builder extends Object
Builder class for CitationDocument.
Since:
1.1.0
Author:
Soby Chacko

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • plainText

      public CitationDocument.Builder plainText(String text)
      Create a plain text document.
      Parameters:
      text - The document text content
      Returns:
      Builder for method chaining

    • pdf

      public CitationDocument.Builder pdf(byte[] pdfBytes)
      Create a PDF document from byte array.
      Parameters:
      pdfBytes - The PDF file content as bytes
      Returns:
      Builder for method chaining

    • pdfFile

      public CitationDocument.Builder pdfFile(String filePath) throws IOException
      Create a PDF document from file path.
      Parameters:
      filePath - Path to the PDF file
      Returns:
      Builder for method chaining
      Throws:
      IOException - if file cannot be read

    • customContent

      public CitationDocument.Builder customContent(List<AnthropicApi.ContentBlock> contentBlocks)
      Create a custom content document with user-defined blocks.
      Parameters:
      contentBlocks - List of content blocks for fine-grained citation control
      Returns:
      Builder for method chaining

    • customContent

      public CitationDocument.Builder customContent(String... textBlocks)
      Create a custom content document from text blocks.
      Parameters:
      textBlocks - Variable number of text strings to create content blocks
      Returns:
      Builder for method chaining

    • title

      public CitationDocument.Builder title(String title)
      Set the document title (optional, not included in citations).
      Parameters:
      title - Document title for reference
      Returns:
      Builder for method chaining

    • context

      public CitationDocument.Builder context(String context)
      Set the document context (optional, not included in citations).
      Parameters:
      context - Additional context or metadata about the document
      Returns:
      Builder for method chaining

    • citationsEnabled

      public CitationDocument.Builder citationsEnabled(boolean enabled)
      Enable or disable citations for this document.
      Parameters:
      enabled - Whether citations should be enabled
      Returns:
      Builder for method chaining

    • build

      public CitationDocument build()
      Build the CitationDocument.
      Returns:
      Configured CitationDocument