All Implemented Interfaces:: com.openai.core.Params


public final class UsageCompletionsParams
 implements Params

Get completions usage details for the organization.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`UsageCompletionsParams.Builder`	A builder for UsageCompletionsParams.
`public final class`	`UsageCompletionsParams.BucketWidth`	Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.
`public final class`	`UsageCompletionsParams.GroupBy`

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`	`startTime()`	Start time (Unix seconds) of the query time range, inclusive.
`final Optional<List<String>>`	`apiKeyIds()`	Return only usage for these API keys.
`final Optional<Boolean>`	`batch()`	If `true`, return batch jobs only.
`final Optional<UsageCompletionsParams.BucketWidth>`	`bucketWidth()`	Width of each time bucket in response.
`final Optional<Long>`	`endTime()`	End time (Unix seconds) of the query time range, exclusive.
`final Optional<List<UsageCompletionsParams.GroupBy>>`	`groupBy()`	Group the usage data by the specified fields.
`final Optional<Long>`	`limit()`	Specifies the number of buckets to return.
`final Optional<List<String>>`	`models()`	Return only usage for these models.
`final Optional<String>`	`page()`	A cursor for use in pagination.
`final Optional<List<String>>`	`projectIds()`	Return only usage for these projects.
`final Optional<List<String>>`	`userIds()`	Return only usage for these users.
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final UsageCompletionsParams.Builder`	`toBuilder()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static UsageCompletionsParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of UsageCompletionsParams.

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

- Constructor Detail
- Method Detail
  - startTime
```
 final Long startTime()
```
    Start time (Unix seconds) of the query time range, inclusive.
  - apiKeyIds
```
 final Optional<List<String>> apiKeyIds()
```
    Return only usage for these API keys.
  - batch
```
 final Optional<Boolean> batch()
```
    If true, return batch jobs only. If false, return non-batch jobs only. By default, return both.
  - bucketWidth
```
 final Optional<UsageCompletionsParams.BucketWidth> bucketWidth()
```
    Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.
  - endTime
```
 final Optional<Long> endTime()
```
    End time (Unix seconds) of the query time range, exclusive.
  - groupBy
```
 final Optional<List<UsageCompletionsParams.GroupBy>> groupBy()
```
    Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, batch, service_tier or any combination of them.
  - limit
```
 final Optional<Long> limit()
```
    Specifies the number of buckets to return.
    bucket_width=1d: default: 7, max: 31
    bucket_width=1h: default: 24, max: 168
    bucket_width=1m: default: 60, max: 1440
  - models
```
 final Optional<List<String>> models()
```
    Return only usage for these models.
  - page
```
 final Optional<String> page()
```
    A cursor for use in pagination. Corresponding to the next_page field from the previous response.
  - projectIds
```
 final Optional<List<String>> projectIds()
```
    Return only usage for these projects.
  - userIds
```
 final Optional<List<String>> userIds()
```
    Return only usage for these users.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final UsageCompletionsParams.Builder toBuilder()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static UsageCompletionsParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of UsageCompletionsParams.
    The following fields are required:
    .startTime()

Class UsageCompletionsParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

startTime

apiKeyIds

batch

bucketWidth

endTime

groupBy

limit

models

page

projectIds

userIds

_additionalHeaders

_additionalQueryParams

toBuilder

_headers

_queryParams

equals

hashCode

toString

builder