Package dev.langchain4j.data.document

Interface Document

  • All Implemented Interfaces:
    
public interface Document

    Represents an unstructured piece of text that usually corresponds to a content of a single file. This text could originate from various sources such as a text file, PDF, DOCX, or a web page (HTML). Each document may have associated Metadata including its source, owner, creation date, etc.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Constructor Detail

    • Method Detail

      • text

         abstract String text()

        Returns the text of this document.

        Returns:

        the text.

      • metadata

         abstract Metadata metadata()

        Returns the metadata associated with this document.

        Returns:

        the metadata.

      • metadata

        @Deprecated(forRemoval = true) String metadata(String key)

        Looks up the metadata value for the given key.

        Parameters:
        key - the key to look up.
        Returns:

        the metadata value for the given key, or null if the key is not present.

      • from

         static Document from(String text)

        Creates a new Document from the given text.

        The created document will have empty metadata.

        Parameters:
        text - the text of the document.
        Returns:

        a new Document.

      • from

         static Document from(String text, Metadata metadata)

        Creates a new Document from the given text.

        Parameters:
        text - the text of the document.
        metadata - the metadata of the document.
        Returns:

        a new Document.

      • document

         static Document document(String text)

        Creates a new Document from the given text.

        The created document will have empty metadata.

        Parameters:
        text - the text of the document.
        Returns:

        a new Document.

      • document

         static Document document(String text, Metadata metadata)

        Creates a new Document from the given text.

        Parameters:
        text - the text of the document.
        metadata - the metadata of the document.
        Returns:

        a new Document.