Skip to content

Commit 849c8df

Browse files
docs(api): add batch size limit to file_batches parameter descriptions
1 parent 5e5bc78 commit 849c8df

3 files changed

Lines changed: 14 additions & 8 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 148
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-0d1a3d48d59d864f24002e6e58a4cf38cb80ba1f4b234f6f766789e2866820c8.yml
3-
openapi_spec_hash: 65fce2adfac759c10dc8bd51e09fa3db
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-46434d15307c0a84fad213c705ba29ab7342f27aa377e302d506a51cb784613b.yml
3+
openapi_spec_hash: 4a64f88af6142d69d6e01dc9207f232a
44
config_hash: 948733484caf41e71093c6582dbc319c

src/openai/resources/vector_stores/file_batches.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,14 @@ def create(
7979
file_ids: A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
8080
the vector store should use. Useful for tools like `file_search` that can access
8181
files. If `attributes` or `chunking_strategy` are provided, they will be applied
82-
to all files in the batch. Mutually exclusive with `files`.
82+
to all files in the batch. The maximum batch size is 2000 files. Mutually
83+
exclusive with `files`.
8384
8485
files: A list of objects that each include a `file_id` plus optional `attributes` or
8586
`chunking_strategy`. Use this when you need to override metadata for specific
8687
files. The global `attributes` or `chunking_strategy` will be ignored and must
87-
be specified for each file. Mutually exclusive with `file_ids`.
88+
be specified for each file. The maximum batch size is 2000 files. Mutually
89+
exclusive with `file_ids`.
8890
8991
extra_headers: Send extra headers
9092
@@ -438,12 +440,14 @@ async def create(
438440
file_ids: A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
439441
the vector store should use. Useful for tools like `file_search` that can access
440442
files. If `attributes` or `chunking_strategy` are provided, they will be applied
441-
to all files in the batch. Mutually exclusive with `files`.
443+
to all files in the batch. The maximum batch size is 2000 files. Mutually
444+
exclusive with `files`.
442445
443446
files: A list of objects that each include a `file_id` plus optional `attributes` or
444447
`chunking_strategy`. Use this when you need to override metadata for specific
445448
files. The global `attributes` or `chunking_strategy` will be ignored and must
446-
be specified for each file. Mutually exclusive with `file_ids`.
449+
be specified for each file. The maximum batch size is 2000 files. Mutually
450+
exclusive with `file_ids`.
447451
448452
extra_headers: Send extra headers
449453

src/openai/types/vector_stores/file_batch_create_params.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,17 @@ class FileBatchCreateParams(TypedDict, total=False):
3333
A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
3434
the vector store should use. Useful for tools like `file_search` that can access
3535
files. If `attributes` or `chunking_strategy` are provided, they will be applied
36-
to all files in the batch. Mutually exclusive with `files`.
36+
to all files in the batch. The maximum batch size is 2000 files. Mutually
37+
exclusive with `files`.
3738
"""
3839

3940
files: Iterable[File]
4041
"""
4142
A list of objects that each include a `file_id` plus optional `attributes` or
4243
`chunking_strategy`. Use this when you need to override metadata for specific
4344
files. The global `attributes` or `chunking_strategy` will be ignored and must
44-
be specified for each file. Mutually exclusive with `file_ids`.
45+
be specified for each file. The maximum batch size is 2000 files. Mutually
46+
exclusive with `file_ids`.
4547
"""
4648

4749

0 commit comments

Comments
 (0)