Module org.elasticsearch.xcore

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

Record Class EmbeddingFloatResults.Embedding

java.lang.Object

java.lang.Record

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

All Implemented Interfaces:

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

Enclosing class:

EmbeddingFloatResults

public static record EmbeddingFloatResults.Embedding(float[] values, int numberOfMergedEmbeddings)
extends Record
implements Writeable, ToXContentObject, EmbeddingResults.Embedding<EmbeddingFloatResults.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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Embedding(float[] values)
Embedding(float[] values, int numberOfMergedEmbeddings)	Creates an instance of a Embedding record class.
Embedding(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	hashCode()	Returns a hash code value for this object.
EmbeddingFloatResults.Embedding	merge(EmbeddingFloatResults.Embedding embedding)	Merges the existing embedding and provided embedding into a new embedding.
int	numberOfMergedEmbeddings()	Returns the value of the numberOfMergedEmbeddings record component.
static EmbeddingFloatResults.Embedding	of(List<Float> embeddingValuesList)
static EmbeddingFloatResults.Embedding	of(MlDenseEmbeddingResults embeddingResult)
BytesReference	toBytesRef(XContent xContent)	Serializes the embedding to bytes.
String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
float[]	values()	Returns the value of the values record component.
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

Constructor Details

Embedding

public Embedding(float[] values)

Embedding

public Embedding(StreamInput in)
          throws IOException

Throws:

IOException

Embedding

public Embedding(float[] values,
 int numberOfMergedEmbeddings)

Creates an instance of a Embedding record class.

Parameters:

values - the value for the values record component

numberOfMergedEmbeddings - the value for the numberOfMergedEmbeddings record component

Method Details

of

public static EmbeddingFloatResults.Embedding of(MlDenseEmbeddingResults embeddingResult)

of

public static EmbeddingFloatResults.Embedding of(List<Float> embeddingValuesList)

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

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

public EmbeddingFloatResults.Embedding merge(EmbeddingFloatResults.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<EmbeddingFloatResults.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<EmbeddingFloatResults.Embedding>

Throws:

IOException

values

public float[] values()

Returns the value of the values record component.

Returns:

the value of the values record component

numberOfMergedEmbeddings

public int numberOfMergedEmbeddings()

Returns the value of the numberOfMergedEmbeddings record component.

Returns:

the value of the numberOfMergedEmbeddings record component