Skip to content

Commit 6d5b877

Browse files
committed
add usage bytes docs
1 parent 03e28b3 commit 6d5b877

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

openapi.yaml

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6067,7 +6067,10 @@ paths:
60676067
"id": "file-abc123",
60686068
"object": "vector_store.file",
60696069
"created_at": 1699061776,
6070-
"vector_store_id
6070+
"usage_bytes": 1234,
6071+
"vector_store_id": "vs_abcd",
6072+
"status": "completed",
6073+
"last_error": null
60716074
}
60726075
60736076
/vector_stores/{vector_store_id}/files/{file_id}:
@@ -6137,7 +6140,9 @@ paths:
61376140
"id": "file-abc123",
61386141
"object": "vector_store.file",
61396142
"created_at": 1699061776,
6140-
"vector_store_id": "vs_abc123"
6143+
"vector_store_id": "vs_abcd",
6144+
"status": "completed",
6145+
"last_error": null
61416146
}
61426147
delete:
61436148
operationId: deleteVectorStoreFile
@@ -6356,7 +6361,15 @@ paths:
63566361
"id": "vsfb_abc123",
63576362
"object": "vector_store.file_batch",
63586363
"created_at": 1699061776,
6359-
"vector_store_id": "vs_abc123"
6364+
"vector_store_id": "vs_abc123",
6365+
"status": "in_progress",
6366+
"file_counts": {
6367+
"in_progress": 1,
6368+
"completed": 1,
6369+
"failed": 0,
6370+
"cancelled": 0,
6371+
"total": 0,
6372+
}
63606373
}
63616374
63626375
/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel:
@@ -6572,7 +6585,7 @@ paths:
65726585
65736586
See [upload file](/docs/api-reference/files/create) for how to upload a file.
65746587
6575-
Your input file must be formatted as a JSONL file, and must be uploaded with the purpose `batch`.
6588+
Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/requestInput), and must be uploaded with the purpose `batch`.
65766589
endpoint:
65776590
type: string
65786591
enum: ["/v1/chat/completions"]
@@ -11840,8 +11853,8 @@ components:
1184011853
name:
1184111854
description: The name of the vector store.
1184211855
type: string
11843-
bytes:
11844-
description: The byte size of the vector store.
11856+
usage_bytes:
11857+
description: The total number of bytes used by the files in the vector store.
1184511858
type: integer
1184611859
file_counts:
1184711860
type: object
@@ -11889,6 +11902,7 @@ components:
1188911902
required:
1189011903
- id
1189111904
- object
11905+
- usage_bytes
1189211906
- created_at
1189311907
- status
1189411908
- last_active_at
@@ -11904,6 +11918,7 @@ components:
1190411918
"id": "vs_123",
1190511919
"object": "vector_store",
1190611920
"created_at": 1698107661,
11921+
"usage_bytes": 123456,
1190711922
"last_active_at": 1698107661,
1190811923
"name": "my_vector_store",
1190911924
"bytes": 123456,
@@ -12009,6 +12024,9 @@ components:
1200912024
description: The object type, which is always `vector_store.file`.
1201012025
type: string
1201112026
enum: ["vector_store.file"]
12027+
usage_bytes:
12028+
description: The total vector store usage in bytes. Note that this may be different from the original file size.
12029+
type: integer
1201212030
created_at:
1201312031
description: The Unix timestamp (in seconds) for when the vector store file was created.
1201412032
type: integer
@@ -12043,6 +12061,7 @@ components:
1204312061
required:
1204412062
- id
1204512063
- object
12064+
- usage_bytes
1204612065
- created_at
1204712066
- vector_store_id
1204812067
- status
@@ -12054,6 +12073,7 @@ components:
1205412073
{
1205512074
"id": "file-abc123",
1205612075
"object": "vector_store.file",
12076+
"usage_bytes": 1234,
1205712077
"created_at": 1698107661,
1205812078
"vector_store_id": "vs_abc123",
1205912079
"status": "completed",
@@ -12895,7 +12915,7 @@ x-oaiMeta:
1289512915
- id: batch
1289612916
title: Batch
1289712917
description: |
12898-
Create large batches of API requests to run asynchronously.
12918+
Create large batches of API requests for asynchronous processing. The Batch API returns completions within 24 hours for a 50% discount.
1289912919
navigationGroup: endpoints
1290012920
sections:
1290112921
- type: endpoint

0 commit comments

Comments
 (0)