Skip to content

Commit 399a81d

Browse files
jzhou-openaijzhou-openai
authored
Merge pull request #375 from openai/dev/jzhou/doc-minor-update-usage-api
Minor update for Usage API
2 parents ab22d64 + 152a060 commit 399a81d

File tree

1 file changed

+41
-7
lines changed

1 file changed

+41
-7
lines changed

‎openapi.yaml‎

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5601,7 +5601,7 @@ paths:
56015601
"end_time": 1730505600,
56025602
"results": [
56035603
{
5604-
"object": "orgainzation.usage.audio_speeches.result",
5604+
"object": "organization.usage.audio_speeches.result",
56055605
"characters": 45,
56065606
"num_model_requests": 1,
56075607
"project_id": null,
@@ -12901,10 +12901,12 @@ components:
1290112901
description: Lowercase ISO-4217 currency e.g. "usd"
1290212902
line_item:
1290312903
type: string
12904+
nullable: true
1290412905
description: When `group_by=line_item`, this field provides the line item of the
1290512906
grouped costs result.
1290612907
project_id:
1290712908
type: string
12909+
nullable: true
1290812910
description: When `group_by=project_id`, this field provides the project ID of
1290912911
the grouped costs result.
1291012912
required:
@@ -23206,18 +23208,22 @@ components:
2320623208
description: The count of requests made to the model.
2320723209
project_id:
2320823210
type: string
23211+
nullable: true
2320923212
description: When `group_by=project_id`, this field provides the project ID of
2321023213
the grouped usage result.
2321123214
user_id:
2321223215
type: string
23216+
nullable: true
2321323217
description: When `group_by=user_id`, this field provides the user ID of the
2321423218
grouped usage result.
2321523219
api_key_id:
2321623220
type: string
23221+
nullable: true
2321723222
description: When `group_by=api_key_id`, this field provides the API key ID of
2321823223
the grouped usage result.
2321923224
model:
2322023225
type: string
23226+
nullable: true
2322123227
description: When `group_by=model`, this field provides the model name of the
2322223228
grouped usage result.
2322323229
required:
@@ -23253,18 +23259,22 @@ components:
2325323259
description: The count of requests made to the model.
2325423260
project_id:
2325523261
type: string
23262+
nullable: true
2325623263
description: When `group_by=project_id`, this field provides the project ID of
2325723264
the grouped usage result.
2325823265
user_id:
2325923266
type: string
23267+
nullable: true
2326023268
description: When `group_by=user_id`, this field provides the user ID of the
2326123269
grouped usage result.
2326223270
api_key_id:
2326323271
type: string
23272+
nullable: true
2326423273
description: When `group_by=api_key_id`, this field provides the API key ID of
2326523274
the grouped usage result.
2326623275
model:
2326723276
type: string
23277+
nullable: true
2326823278
description: When `group_by=model`, this field provides the model name of the
2326923279
grouped usage result.
2327023280
required:
@@ -23297,6 +23307,7 @@ components:
2329723307
description: The number of code interpreter sessions.
2329823308
project_id:
2329923309
type: string
23310+
nullable: true
2330023311
description: When `group_by=project_id`, this field provides the project ID of
2330123312
the grouped usage result.
2330223313
required:
@@ -23320,35 +23331,43 @@ components:
2332023331
- organization.usage.completions.result
2332123332
input_tokens:
2332223333
type: integer
23323-
description: The number of input tokens used.
23334+
description: The aggregated number of input tokens used. For customers subscribe
23335+
to scale tier, this includes scale tier tokens.
2332423336
input_cached_tokens:
2332523337
type: integer
23326-
description: The number of input tokens that has been cached from previous
23327-
requests.
23338+
description: The aggregated number of input tokens that has been cached from
23339+
previous requests. For customers subscribe to scale tier, this
23340+
includes scale tier tokens.
2332823341
output_tokens:
2332923342
type: integer
23330-
description: The number of output tokens used.
23343+
description: The aggregated number of output tokens used. For customers
23344+
subscribe to scale tier, this includes scale tier tokens.
2333123345
num_model_requests:
2333223346
type: integer
2333323347
description: The count of requests made to the model.
2333423348
project_id:
2333523349
type: string
23350+
nullable: true
2333623351
description: When `group_by=project_id`, this field provides the project ID of
2333723352
the grouped usage result.
2333823353
user_id:
2333923354
type: string
23355+
nullable: true
2334023356
description: When `group_by=user_id`, this field provides the user ID of the
2334123357
grouped usage result.
2334223358
api_key_id:
2334323359
type: string
23360+
nullable: true
2334423361
description: When `group_by=api_key_id`, this field provides the API key ID of
2334523362
the grouped usage result.
2334623363
model:
2334723364
type: string
23365+
nullable: true
2334823366
description: When `group_by=model`, this field provides the model name of the
2334923367
grouped usage result.
2335023368
batch:
2335123369
type: boolean
23370+
nullable: true
2335223371
description: When `group_by=batch`, this field tells whether the grouped usage
2335323372
result is batch or not.
2335423373
required:
@@ -23381,24 +23400,28 @@ components:
2338123400
- organization.usage.embeddings.result
2338223401
input_tokens:
2338323402
type: integer
23384-
description: The number of input tokens used.
23403+
description: The aggregated number of input tokens used.
2338523404
num_model_requests:
2338623405
type: integer
2338723406
description: The count of requests made to the model.
2338823407
project_id:
2338923408
type: string
23409+
nullable: true
2339023410
description: When `group_by=project_id`, this field provides the project ID of
2339123411
the grouped usage result.
2339223412
user_id:
2339323413
type: string
23414+
nullable: true
2339423415
description: When `group_by=user_id`, this field provides the user ID of the
2339523416
grouped usage result.
2339623417
api_key_id:
2339723418
type: string
23419+
nullable: true
2339823420
description: When `group_by=api_key_id`, this field provides the API key ID of
2339923421
the grouped usage result.
2340023422
model:
2340123423
type: string
23424+
nullable: true
2340223425
description: When `group_by=model`, this field provides the model name of the
2340323426
grouped usage result.
2340423427
required:
@@ -23433,27 +23456,33 @@ components:
2343323456
description: The count of requests made to the model.
2343423457
source:
2343523458
type: string
23459+
nullable: true
2343623460
description: When `group_by=source`, this field provides the source of the
2343723461
grouped usage result, possible values are `image.generation`,
2343823462
`image.edit`, `image.variation`.
2343923463
size:
2344023464
type: string
23465+
nullable: true
2344123466
description: When `group_by=size`, this field provides the image size of the
2344223467
grouped usage result.
2344323468
project_id:
2344423469
type: string
23470+
nullable: true
2344523471
description: When `group_by=project_id`, this field provides the project ID of
2344623472
the grouped usage result.
2344723473
user_id:
2344823474
type: string
23475+
nullable: true
2344923476
description: When `group_by=user_id`, this field provides the user ID of the
2345023477
grouped usage result.
2345123478
api_key_id:
2345223479
type: string
23480+
nullable: true
2345323481
description: When `group_by=api_key_id`, this field provides the API key ID of
2345423482
the grouped usage result.
2345523483
model:
2345623484
type: string
23485+
nullable: true
2345723486
description: When `group_by=model`, this field provides the model name of the
2345823487
grouped usage result.
2345923488
required:
@@ -23484,24 +23513,28 @@ components:
2348423513
- organization.usage.moderations.result
2348523514
input_tokens:
2348623515
type: integer
23487-
description: The number of input tokens used.
23516+
description: The aggregated number of input tokens used.
2348823517
num_model_requests:
2348923518
type: integer
2349023519
description: The count of requests made to the model.
2349123520
project_id:
2349223521
type: string
23522+
nullable: true
2349323523
description: When `group_by=project_id`, this field provides the project ID of
2349423524
the grouped usage result.
2349523525
user_id:
2349623526
type: string
23527+
nullable: true
2349723528
description: When `group_by=user_id`, this field provides the user ID of the
2349823529
grouped usage result.
2349923530
api_key_id:
2350023531
type: string
23532+
nullable: true
2350123533
description: When `group_by=api_key_id`, this field provides the API key ID of
2350223534
the grouped usage result.
2350323535
model:
2350423536
type: string
23537+
nullable: true
2350523538
description: When `group_by=model`, this field provides the model name of the
2350623539
grouped usage result.
2350723540
required:
@@ -23582,6 +23615,7 @@ components:
2358223615
description: The vector stores usage in bytes.
2358323616
project_id:
2358423617
type: string
23618+
nullable: true
2358523619
description: When `group_by=project_id`, this field provides the project ID of
2358623620
the grouped usage result.
2358723621
required:

0 commit comments

Comments
 (0)