Module org.elasticsearch.xcore
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>
-
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(List<WeightedToken> tokens, boolean isTruncated) Creates an instance of aEmbeddingrecord class.Embedding(StreamInput in) -
Method Summary
Modifier and TypeMethodDescriptionasMap()create(List<WeightedToken> weightedTokens, boolean isTruncated) final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.booleanReturns the value of theisTruncatedrecord component.merge(SparseEmbeddingResults.Embedding embedding) Merges the existing embedding and provided embedding into a new embedding.toBytesRef(org.elasticsearch.xcontent.XContent xContent) Serializes the embedding to bytes.tokens()Returns the value of thetokensrecord component.toString()Returns a string representation of this record class.org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) 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:
-
IS_TRUNCATED
- See Also:
-
-
Constructor Details
-
Embedding
- Throws:
IOException
-
Embedding
Creates an instance of aEmbeddingrecord class.- Parameters:
tokens- the value for thetokensrecord componentisTruncated- the value for theisTruncatedrecord component
-
-
Method Details
-
create
public static SparseEmbeddingResults.Embedding create(List<WeightedToken> weightedTokens, boolean isTruncated) -
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
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
-
asMap
-
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. -
merge
Description copied from interface:EmbeddingResults.EmbeddingMerges the existing embedding and provided embedding into a new embedding.- Specified by:
mergein interfaceEmbeddingResults.Embedding<SparseEmbeddingResults.Embedding>
-
toBytesRef
Description copied from interface:EmbeddingResults.EmbeddingSerializes the embedding to bytes.- Specified by:
toBytesRefin interfaceEmbeddingResults.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. -
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 '=='. -
tokens
Returns the value of thetokensrecord component.- Returns:
- the value of the
tokensrecord component
-
isTruncated
public boolean isTruncated()Returns the value of theisTruncatedrecord component.- Returns:
- the value of the
isTruncatedrecord component
-