Module org.elasticsearch.xcore
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.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionEmbedding(byte[] values) Embedding(byte[] values, int[] sumMergedValues, int numberOfMergedEmbeddings) Creates an instance of aEmbeddingrecord class.Embedding(StreamInput in) -
Method Summary
Modifier and TypeMethodDescriptionbooleanIndicates whether some other object is "equal to" this one.inthashCode()Returns a hash code value for this object.merge(TextEmbeddingByteResults.Embedding embedding) Merges the existing embedding and provided embedding into a new embedding.intReturns the value of thenumberOfMergedEmbeddingsrecord component.int[]Returns the value of thesumMergedValuesrecord component.toBytesRef(org.elasticsearch.xcontent.XContent xContent) Serializes the embedding to bytes.toString()Returns a string representation of this record class.org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) byte[]values()Returns the value of thevaluesrecord component.voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
EMBEDDING
- See Also:
-
-
Constructor Details
-
Embedding
public Embedding(byte[] values) -
Embedding
- Throws:
IOException
-
Embedding
public Embedding(byte[] values, int[] sumMergedValues, int numberOfMergedEmbeddings) Creates an instance of aEmbeddingrecord class.- Parameters:
values- the value for thevaluesrecord componentsumMergedValues- the value for thesumMergedValuesrecord componentnumberOfMergedEmbeddings- the value for thenumberOfMergedEmbeddingsrecord component
-
-
Method Details
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
of
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
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. -
equals
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 withObjects::equals(Object,Object); primitive components are compared with '=='. -
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. -
merge
Description copied from interface:EmbeddingResults.EmbeddingMerges the existing embedding and provided embedding into a new embedding.- Specified by:
mergein interfaceEmbeddingResults.Embedding<TextEmbeddingByteResults.Embedding>
-
toBytesRef
Description copied from interface:EmbeddingResults.EmbeddingSerializes the embedding to bytes.- Specified by:
toBytesRefin interfaceEmbeddingResults.Embedding<TextEmbeddingByteResults.Embedding>- Throws:
IOException
-
values
public byte[] values()Returns the value of thevaluesrecord component.- Returns:
- the value of the
valuesrecord component
-
sumMergedValues
public int[] sumMergedValues()Returns the value of thesumMergedValuesrecord component.- Returns:
- the value of the
sumMergedValuesrecord component
-
numberOfMergedEmbeddings
public int numberOfMergedEmbeddings()Returns the value of thenumberOfMergedEmbeddingsrecord component.- Returns:
- the value of the
numberOfMergedEmbeddingsrecord component
-