Record Class SparseEmbeddingResults.Embedding

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

public static record SparseEmbeddingResults.Embedding(List<WeightedToken> tokens, boolean isTruncated) extends Record implements Writeable, org.elasticsearch.xcontent.ToXContentObject, EmbeddingResults.Embedding<SparseEmbeddingResults.Embedding>
  • Field Details

  • Constructor Details

    • Embedding

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

      public Embedding(List<WeightedToken> tokens, boolean isTruncated)
      Creates an instance of a Embedding record class.
      Parameters:
      tokens - the value for the tokens record component
      isTruncated - the value for the isTruncated record component
  • Method Details

    • create

      public static SparseEmbeddingResults.Embedding create(List<WeightedToken> weightedTokens, boolean isTruncated)
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • 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
    • asMap

      public Map<String,Object> asMap()
    • 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
    • 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<SparseEmbeddingResults.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<SparseEmbeddingResults.Embedding>
      Throws:
      IOException
    • 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. 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.
    • tokens

      public List<WeightedToken> tokens()
      Returns the value of the tokens record component.
      Returns:
      the value of the tokens record component
    • isTruncated

      public boolean isTruncated()
      Returns the value of the isTruncated record component.
      Returns:
      the value of the isTruncated record component