EmbeddingItem Class

Package:
com.azure.ai.inference.models
Maven Artifact:
com.azure:azure-ai-inference:1.0.0-beta.5
  • java.lang.Object
    • com.azure.ai.inference.models.EmbeddingItem

Implements

JsonSerializable<EmbeddingItem>

public final class EmbeddingItem
implements JsonSerializable<EmbeddingItem>

Representation of a single embeddings relatedness comparison.

Method Summary

Modifier and Type Method and Description
static EmbeddingItem fromJson(JsonReader jsonReader)

Reads an instance of EmbeddingItem from the JsonReader.
BinaryData getEmbedding()

Get the embedding property: List of embedding values for the input prompt.
List<Float> getEmbeddingList()

Get the embedding property: List of embedding values for the input prompt.
int getIndex()

Get the index property: Index of the prompt to which the EmbeddingItem corresponds.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static EmbeddingItem fromJson(JsonReader jsonReader)

Reads an instance of EmbeddingItem from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of EmbeddingItem if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getEmbedding

public BinaryData getEmbedding()

Get the embedding property: List of embedding values for the input prompt. These represent a measurement of the vector-based relatedness of the provided input. Or a base64 encoded string of the embedding vector.

Returns:

the embedding value.

getEmbeddingList

public List<Float> getEmbeddingList()

Get the embedding property: List of embedding values for the input prompt. These represent a measurement of the vector-based relatedness of the provided input. Or a base64 encoded string of the embedding vector.

Returns:

the embeddings as a list of floats.

getIndex

public int getIndex()

Get the index property: Index of the prompt to which the EmbeddingItem corresponds.

Returns:

the index value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to