Package com.azure.ai.openai.models

Class EmbeddingItem

java.lang.Object

com.azure.ai.openai.models.EmbeddingItem

All Implemented Interfaces:

com.azure.json.JsonSerializable<EmbeddingItem>

public final class EmbeddingItem
extends Object
implements com.azure.json.JsonSerializable<EmbeddingItem>

Representation of a single embeddings relatedness comparison.

Method Summary

Modifier and Type	Method	Description
static EmbeddingItem	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of EmbeddingItem from the JsonReader.
List<Float>	getEmbedding()	Get the embedding property: List of embeddings value for the input prompt.
String	getEmbeddingAsString()	Get the embedding property: List of embeddings value in base64 format for the input prompt.
int	getPromptIndex()	Get the promptIndex property: Index of the prompt to which the EmbeddingItem corresponds.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getEmbedding

public List<Float> getEmbedding()

Get the embedding property: List of embeddings value for the input prompt. These represent a measurement of the vector-based relatedness of the provided input.

Returns:

the embedding value.

getEmbeddingAsString

public String getEmbeddingAsString()

Get the embedding property: List of embeddings value in base64 format for the input prompt.

Returns:

the embedding base64 encoded string.

getPromptIndex

public int getPromptIndex()

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

Returns:

the promptIndex value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<EmbeddingItem>

Throws:

IOException

fromJson

public static EmbeddingItem fromJson(com.azure.json.JsonReader jsonReader)
                              throws IOException

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:

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

IOException - If an error occurs while reading the EmbeddingItem.