Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.results

Record Class SparseEmbeddingResults.Embedding

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.core.inference.results.SparseEmbeddingResults.Embedding

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject, EmbeddingResults.Embedding<SparseEmbeddingResults.Embedding>

Enclosing class:

SparseEmbeddingResults

public static record SparseEmbeddingResults.Embedding(List<WeightedToken> tokens, boolean isTruncated)
extends Record
implements Writeable, ToXContentObject, EmbeddingResults.Embedding<SparseEmbeddingResults.Embedding>

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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	IS_TRUNCATED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Embedding(List<WeightedToken> tokens, boolean isTruncated)	Creates an instance of a Embedding record class.
Embedding(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()
static SparseEmbeddingResults.Embedding	create(List<WeightedToken> weightedTokens, boolean isTruncated)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	isTruncated()	Returns the value of the isTruncated record component.
SparseEmbeddingResults.Embedding	merge(SparseEmbeddingResults.Embedding embedding)	Merges the existing embedding and provided embedding into a new embedding.
BytesReference	toBytesRef(XContent xContent)	Serializes the embedding to bytes.
List<WeightedToken>	tokens()	Returns the value of the tokens record component.
String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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

IS_TRUNCATED

public static final String IS_TRUNCATED

See Also:

• Constant Field Values

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 XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface 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

public SparseEmbeddingResults.Embedding merge(SparseEmbeddingResults.Embedding embedding)

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(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