Package com.azure.ai.openai.models

Class EmbeddingsUsage

java.lang.Object
com.azure.ai.openai.models.EmbeddingsUsage
All Implemented Interfaces:
com.azure.json.JsonSerializable<EmbeddingsUsage>
public final class EmbeddingsUsage extends Object implements com.azure.json.JsonSerializable<EmbeddingsUsage>
Measurement of the amount of tokens used in this request and response.

  • Method Details

    • 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 com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<EmbeddingsUsage>
      Throws:
      IOException

    • fromJson

      public static EmbeddingsUsage fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the EmbeddingsUsage.