Module org.elasticsearch.server
Package org.elasticsearch.search.vectors

Record Class VectorData

java.lang.Object
java.lang.Record
org.elasticsearch.search.vectors.VectorData
All Implemented Interfaces:
Writeable, ToXContent, ToXContentFragment
public record VectorData(float[] floatVector, byte[] byteVector, String stringVector) extends Record implements Writeable, ToXContentFragment

  • Constructor Details

    • VectorData

      public VectorData(float[] floatVector)

    • VectorData

      public VectorData(byte[] byteVector)

    • VectorData

      public VectorData(String stringVector)

    • VectorData

      public VectorData(StreamInput in) throws IOException
      Throws:
      IOException

    • VectorData

      public VectorData(float[] floatVector, byte[] byteVector, String stringVector)
      Creates an instance of a VectorData record class.
      Parameters:
      floatVector - the value for the floatVector record component
      byteVector - the value for the byteVector record component
      stringVector - the value for the stringVector record component

  • Method Details

    • isFloat

      public boolean isFloat()

    • isStringVector

      public boolean isStringVector()

    • stringVector

      public String stringVector()
      Returns the value of the stringVector record component.
      Returns:
      the value of the stringVector record component

    • size

      public int size()

    • asByteVector

      public byte[] asByteVector()

    • asFloatVector

      public float[] asFloatVector()

    • addToBuffer

      public void addToBuffer(DenseVectorFieldMapper.Element element, ByteBuffer byteBuffer)

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • toXContent

      public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      IOException

    • toString

      public 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

    • equals

      public boolean equals(Object obj)
      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:
      obj - the object with which to compare
      Returns:
      true if this object is the same as the obj argument; false otherwise.

    • hashCode

      public 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

    • parseXContent

      public static VectorData parseXContent(XContentParser parser) throws IOException
      Throws:
      IOException

    • fromFloats

      public static VectorData fromFloats(float[] vec)

    • fromBytes

      public static VectorData fromBytes(byte[] vec)

    • fromStringVector

      public static VectorData fromStringVector(String encoded)

    • decodeQueryVector

      public static VectorData decodeQueryVector(String encoded, DenseVectorFieldMapper.ElementType elementType, int dims)
      Decodes an encoded string (hex or base64) to VectorData based on the element type and dimensions. Base64 encoding is supported for all element types with proper byte interpretation. Hex encoding produces byte vectors and is supported for BYTE and BIT element types, and for FLOAT/BFLOAT16 when the decoded byte length matches the expected dimensions.
      Parameters:
      encoded - the encoded vector string
      elementType - the element type (BYTE, FLOAT, BFLOAT16, BIT)
      dims - the expected dimensions
      Returns:
      the decoded VectorData
      Throws:
      IllegalArgumentException - if the string cannot be decoded or doesn't match expected dimensions

    • floatVector

      public float[] floatVector()
      Returns the value of the floatVector record component.
      Returns:
      the value of the floatVector record component

    • byteVector

      public byte[] byteVector()
      Returns the value of the byteVector record component.
      Returns:
      the value of the byteVector record component