EmbeddingsUsage 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.EmbeddingsUsage

Implements

JsonSerializable<EmbeddingsUsage>

public final class EmbeddingsUsage
implements JsonSerializable<EmbeddingsUsage>

Measurement of the amount of tokens used in this request and response.

Method Summary

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

Reads an instance of EmbeddingsUsage from the JsonReader.
int getPromptTokens()

Get the promptTokens property: Number of tokens sent in the original request.
int getTotalTokens()

Get the totalTokens property: Total number of tokens transacted in this request/response.
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 EmbeddingsUsage fromJson(JsonReader jsonReader)

Reads an instance of EmbeddingsUsage from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of EmbeddingsUsage 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.

getPromptTokens

public int getPromptTokens()

Get the promptTokens property: Number of tokens sent in the original request.

Returns:

the promptTokens value.

getTotalTokens

public int getTotalTokens()

Get the totalTokens property: Total number of tokens transacted in this request/response.

Returns:

the totalTokens value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to