Package com.azure.ai.openai.models

Class EmbeddingItem

java.lang.Object

com.azure.ai.openai.models.EmbeddingItem

public final class EmbeddingItem
extends Object

Representation of a single embeddings relatedness comparison.

Method Summary

Modifier and Type	Method	Description
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.

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.