Record Class TextEmbeddingByteResults.Embedding

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.core.inference.results.TextEmbeddingByteResults.Embedding
All Implemented Interfaces:
Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject, EmbeddingResults.Embedding<TextEmbeddingByteResults.Embedding>
Enclosing class:
TextEmbeddingByteResults

public static record TextEmbeddingByteResults.Embedding(byte[] values, int[] sumMergedValues, int numberOfMergedEmbeddings) extends Record implements Writeable, org.elasticsearch.xcontent.ToXContentObject, EmbeddingResults.Embedding<TextEmbeddingByteResults.Embedding>
  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY, EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
    Embedding(byte[] values)
     
    Embedding(byte[] values, int[] sumMergedValues, int numberOfMergedEmbeddings)
    Creates an instance of a Embedding record class.
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Indicates whether some other object is "equal to" this one.
    int
    Returns a hash code value for this object.
    Merges the existing embedding and provided embedding into a new embedding.
    int
    Returns the value of the numberOfMergedEmbeddings record component.
    of(List<Byte> embeddingValuesList)
     
    int[]
    Returns the value of the sumMergedValues record component.
    toBytesRef(org.elasticsearch.xcontent.XContent xContent)
    Serializes the embedding to bytes.
    Returns a string representation of this record class.
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    byte[]
    Returns the value of the values record component.
    void
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment
  • Field Details

  • Constructor Details

    • Embedding

      public Embedding(byte[] values)
    • Embedding

      public Embedding(StreamInput in) throws IOException
      Throws:
      IOException
    • Embedding

      public Embedding(byte[] values, int[] sumMergedValues, int numberOfMergedEmbeddings)
      Creates an instance of a Embedding record class.
      Parameters:
      values - the value for the values record component
      sumMergedValues - the value for the sumMergedValues record component
      numberOfMergedEmbeddings - the value for the numberOfMergedEmbeddings record component
  • Method Details

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • of

      public static TextEmbeddingByteResults.Embedding of(List<Byte> embeddingValuesList)
    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.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 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.
    • 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
    • merge

      Description copied from interface: EmbeddingResults.Embedding
      Merges the existing embedding and provided embedding into a new embedding.
      Specified by:
      merge in interface EmbeddingResults.Embedding<TextEmbeddingByteResults.Embedding>
    • toBytesRef

      public BytesReference toBytesRef(org.elasticsearch.xcontent.XContent xContent) throws IOException
      Description copied from interface: EmbeddingResults.Embedding
      Serializes the embedding to bytes.
      Specified by:
      toBytesRef in interface EmbeddingResults.Embedding<TextEmbeddingByteResults.Embedding>
      Throws:
      IOException
    • values

      public byte[] values()
      Returns the value of the values record component.
      Returns:
      the value of the values record component
    • sumMergedValues

      public int[] sumMergedValues()
      Returns the value of the sumMergedValues record component.
      Returns:
      the value of the sumMergedValues record component
    • numberOfMergedEmbeddings

      public int numberOfMergedEmbeddings()
      Returns the value of the numberOfMergedEmbeddings record component.
      Returns:
      the value of the numberOfMergedEmbeddings record component