Package dev.langchain4j.data.document

Record Class DefaultDocument

java.lang.Object
java.lang.Record
dev.langchain4j.data.document.DefaultDocument
All Implemented Interfaces:
Document
public record DefaultDocument(String text, Metadata metadata) extends Record implements Document
A default implementation of a Document.

  • Constructor Details

    • DefaultDocument

      public DefaultDocument(String text, Metadata metadata)
      Creates an instance of a DefaultDocument record class.
      Parameters:
      text - the value for the text record component
      metadata - the value for the metadata record component

    • DefaultDocument

      public DefaultDocument(String text)

  • Method Details

    • metadata

      public String metadata(String key)
      Description copied from interface: Document
      Looks up the metadata value for the given key.
      Specified by:
      metadata in interface Document
      Parameters:
      key - the key to look up.
      Returns:
      the metadata value for the given key, or null if the key is not present.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • text

      public String text()
      Returns the value of the text record component.
      Specified by:
      text in interface Document
      Returns:
      the value of the text record component

    • metadata

      public Metadata metadata()
      Returns the value of the metadata record component.
      Specified by:
      metadata in interface Document
      Returns:
      the value of the metadata record component