Package com.azure.ai.openai.models

Class CompletionsUsageCompletionTokensDetails

java.lang.Object

com.azure.ai.openai.models.CompletionsUsageCompletionTokensDetails

All Implemented Interfaces:

com.azure.json.JsonSerializable<CompletionsUsageCompletionTokensDetails>

public final class CompletionsUsageCompletionTokensDetails
extends Object
implements com.azure.json.JsonSerializable<CompletionsUsageCompletionTokensDetails>

The CompletionsUsageCompletionTokensDetails model.

Method Summary

Modifier and Type	Method	Description
static CompletionsUsageCompletionTokensDetails	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of CompletionsUsageCompletionTokensDetails from the JsonReader.
Integer	getAcceptedPredictionTokens()	Get the acceptedPredictionTokens property: When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion.
Integer	getAudioTokens()	Get the audioTokens property: Audio input tokens generated by the model.
Integer	getReasoningTokens()	Get the reasoningTokens property: Tokens generated by the model for reasoning.
Integer	getRejectedPredictionTokens()	Get the rejectedPredictionTokens property: When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Method Details

getReasoningTokens

public Integer getReasoningTokens()

Get the reasoningTokens property: Tokens generated by the model for reasoning.

Returns:

the reasoningTokens value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<CompletionsUsageCompletionTokensDetails>

Throws:

IOException

fromJson

public static CompletionsUsageCompletionTokensDetails fromJson(com.azure.json.JsonReader jsonReader)
                                                        throws IOException

Reads an instance of CompletionsUsageCompletionTokensDetails from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CompletionsUsageCompletionTokensDetails if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException - If an error occurs while reading the CompletionsUsageCompletionTokensDetails.

getAcceptedPredictionTokens

public Integer getAcceptedPredictionTokens()

Get the acceptedPredictionTokens property: When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion.

Returns:

the acceptedPredictionTokens value.

getAudioTokens

public Integer getAudioTokens()

Get the audioTokens property: Audio input tokens generated by the model.

Returns:

the audioTokens value.

getRejectedPredictionTokens

public Integer getRejectedPredictionTokens()

Get the rejectedPredictionTokens property: When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits.

Returns:

the rejectedPredictionTokens value.