Share via

EmbeddingItem Class

  • Reference
Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.12
  • java.lang.Object
    • com.azure.ai.openai.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.
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.
String getObject()

Get the object property: The object type which is always 'embedding'.
int getPromptIndex()

Get the promptIndex 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 List 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.

getObject

public String getObject()

Get the object property: The object type which is always 'embedding'.

Returns:

the object value.

getPromptIndex

public int getPromptIndex()

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

Returns:

the promptIndex value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to