Package com.google.genkit.ai

Class Document

java.lang.Object
com.google.genkit.ai.Document
public class Document extends Object
Document represents a document for use with embedders and retrievers.

  • Constructor Details

    • Document

      public Document()
      Default constructor.

    • Document

      public Document(String text)
      Creates a Document with text content.
      Parameters:
      text - the text content

    • Document

      public Document(List<Part> content)
      Creates a Document with parts.
      Parameters:
      content - the content parts

  • Method Details

    • fromText

      public static Document fromText(String text)
      Creates a text Document.
      Parameters:
      text - the text content
      Returns:
      a Document with text content

    • fromText

      public static Document fromText(String text, Map<String,Object> metadata)
      Creates a Document with text and metadata.
      Parameters:
      text - the text content
      metadata - the metadata
      Returns:
      a Document with text content and metadata

    • text

      public String text()
      Gets the text content of this Document.
      Returns:
      the concatenated text content

    • getContent

      public List<Part> getContent()

    • setContent

      public void setContent(List<Part> content)

    • getMetadata

      public Map<String,Object> getMetadata()

    • setMetadata

      public void setMetadata(Map<String,Object> metadata)

    • withMetadata

      public Document withMetadata(String key, Object value)
      Adds metadata to this Document.
      Parameters:
      key - the metadata key
      value - the metadata value
      Returns:
      this Document for chaining