com.azure.ai.openai.models.CompletionsUsage.yml

### YamlMime:JavaType
uid: "com.azure.ai.openai.models.CompletionsUsage"
fullName: "com.azure.ai.openai.models.CompletionsUsage"
name: "CompletionsUsage"
nameWithType: "CompletionsUsage"
summary: "Representation of the token counts processed for a completions request."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **CompletionsUsage**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.openai.models.CompletionsUsage?alt=com.azure.ai.openai.models.CompletionsUsage&text=CompletionsUsage\" data-throw-if-not-resolved=\"False\" />&gt;"
methods:
- uid: "com.azure.ai.openai.models.CompletionsUsage.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.ai.openai.models.CompletionsUsage.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "CompletionsUsage.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Completions<wbr>Usage from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static CompletionsUsage fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of CompletionsUsage from the JsonReader."
  returns:
    description: "An instance of CompletionsUsage if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.ai.openai.models.CompletionsUsage?alt=com.azure.ai.openai.models.CompletionsUsage&text=CompletionsUsage\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.openai.models.CompletionsUsage.getCompletionTokens()"
  fullName: "com.azure.ai.openai.models.CompletionsUsage.getCompletionTokens()"
  name: "getCompletionTokens()"
  nameWithType: "CompletionsUsage.getCompletionTokens()"
  summary: "Get the completion<wbr>Tokens property: The number of tokens generated across all completions emissions."
  syntax: "public int getCompletionTokens()"
  desc: "Get the completionTokens property: The number of tokens generated across all completions emissions."
  returns:
    description: "the completionTokens value."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.openai.models.CompletionsUsage.getPromptTokens()"
  fullName: "com.azure.ai.openai.models.CompletionsUsage.getPromptTokens()"
  name: "getPromptTokens()"
  nameWithType: "CompletionsUsage.getPromptTokens()"
  summary: "Get the prompt<wbr>Tokens property: The number of tokens in the provided prompts for the completions request."
  syntax: "public int getPromptTokens()"
  desc: "Get the promptTokens property: The number of tokens in the provided prompts for the completions request."
  returns:
    description: "the promptTokens value."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.openai.models.CompletionsUsage.getTotalTokens()"
  fullName: "com.azure.ai.openai.models.CompletionsUsage.getTotalTokens()"
  name: "getTotalTokens()"
  nameWithType: "CompletionsUsage.getTotalTokens()"
  summary: "Get the total<wbr>Tokens property: The total number of tokens processed for the completions request and response."
  syntax: "public int getTotalTokens()"
  desc: "Get the totalTokens property: The total number of tokens processed for the completions request and response."
  returns:
    description: "the totalTokens value."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.openai.models.CompletionsUsage.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.ai.openai.models.CompletionsUsage.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "CompletionsUsage.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Representation of the token counts processed for a completions request. Counts consider all tokens across prompts, choices, choice alternates, best\\_of generations, and other consumers."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.openai.models.CompletionsUsage?alt=com.azure.ai.openai.models.CompletionsUsage&text=CompletionsUsage\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.ai.openai.models"
artifact: com.azure:azure-ai-openai:1.0.0-beta.10