All Implemented Interfaces:


public final class CompletionUsage

Usage statistics for the completion request.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`CompletionUsage.Builder`	A builder for CompletionUsage.
`public final class`	`CompletionUsage.CompletionTokensDetails`	Breakdown of tokens used in a completion.
`public final class`	`CompletionUsage.PromptTokensDetails`	Breakdown of tokens used in the prompt.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Long`	`completionTokens()`	Number of tokens in the generated completion.
`final Long`	`promptTokens()`	Number of tokens in the prompt.
`final Long`	`totalTokens()`	Total number of tokens used in the request (prompt + completion).
`final Optional<CompletionUsage.CompletionTokensDetails>`	`completionTokensDetails()`	Breakdown of tokens used in a completion.
`final Optional<CompletionUsage.PromptTokensDetails>`	`promptTokensDetails()`	Breakdown of tokens used in the prompt.
`final JsonField<Long>`	`_completionTokens()`	Returns the raw JSON value of completionTokens.
`final JsonField<Long>`	`_promptTokens()`	Returns the raw JSON value of promptTokens.
`final JsonField<Long>`	`_totalTokens()`	Returns the raw JSON value of totalTokens.
`final JsonField<CompletionUsage.CompletionTokensDetails>`	`_completionTokensDetails()`	Returns the raw JSON value of completionTokensDetails.
`final JsonField<CompletionUsage.PromptTokensDetails>`	`_promptTokensDetails()`	Returns the raw JSON value of promptTokensDetails.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final CompletionUsage.Builder`	`toBuilder()`
`final CompletionUsage`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static CompletionUsage.Builder`	`builder()`	Returns a mutable builder for constructing an instance of CompletionUsage.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - completionTokens
```
 final Long completionTokens()
```
    Number of tokens in the generated completion.
  - promptTokens
```
 final Long promptTokens()
```
    Number of tokens in the prompt.
  - totalTokens
```
 final Long totalTokens()
```
    Total number of tokens used in the request (prompt + completion).
  - completionTokensDetails
```
 final Optional<CompletionUsage.CompletionTokensDetails> completionTokensDetails()
```
    Breakdown of tokens used in a completion.
  - promptTokensDetails
```
 final Optional<CompletionUsage.PromptTokensDetails> promptTokensDetails()
```
    Breakdown of tokens used in the prompt.
  - _completionTokens
```
 final JsonField<Long> _completionTokens()
```
    Returns the raw JSON value of completionTokens.
    Unlike completionTokens, this method doesn't throw if the JSON field has an unexpected type.
  - _promptTokens
```
 final JsonField<Long> _promptTokens()
```
    Returns the raw JSON value of promptTokens.
    Unlike promptTokens, this method doesn't throw if the JSON field has an unexpected type.
  - _totalTokens
```
 final JsonField<Long> _totalTokens()
```
    Returns the raw JSON value of totalTokens.
    Unlike totalTokens, this method doesn't throw if the JSON field has an unexpected type.
  - _completionTokensDetails
```
 final JsonField<CompletionUsage.CompletionTokensDetails> _completionTokensDetails()
```
    Returns the raw JSON value of completionTokensDetails.
    Unlike completionTokensDetails, this method doesn't throw if the JSON field has an unexpected type.
  - _promptTokensDetails
```
 final JsonField<CompletionUsage.PromptTokensDetails> _promptTokensDetails()
```
    Returns the raw JSON value of promptTokensDetails.
    Unlike promptTokensDetails, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final CompletionUsage.Builder toBuilder()
```
  - validate
```
 final CompletionUsage validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static CompletionUsage.Builder builder()
```
    Returns a mutable builder for constructing an instance of CompletionUsage.
    The following fields are required:
    .completionTokens() .promptTokens() .totalTokens()

Class CompletionUsage

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

completionTokens

promptTokens

totalTokens

completionTokensDetails

promptTokensDetails

_completionTokens

_promptTokens

_totalTokens

_completionTokensDetails

_promptTokensDetails

_additionalProperties

toBuilder

validate

isValid

equals

hashCode

toString

builder