Skip to content

Commit 663e896

Browse files
fix(api): docs updates
1 parent f05eec9 commit 663e896

File tree

4 files changed

+32
-30
lines changed

4 files changed

+32
-30
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 136
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-a4bb37d110a22c2888f53e21281434686a6fffa3e672a40f2503ad9bd2759063.yml
3-
openapi_spec_hash: 2d59eefb494dff4eea8c3d008c7e2070
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-a3c45d9bd3bb25bf4eaa49b7fb473a00038293dec659ffaa44f624ded884abf4.yml
3+
openapi_spec_hash: 9c20aaf786a0700dabd13d9865481c9e
44
config_hash: 50ee3382a63c021a9f821a935950e926

src/openai/resources/files.py

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -71,20 +71,19 @@ def create(
7171
up to 512 MB, and the size of all files uploaded by one organization can be up
7272
to 1 TB.
7373
74-
The Assistants API supports files up to 2 million tokens and of specific file
75-
types. See the
76-
[Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for
77-
details.
78-
79-
The Fine-tuning API only supports `.jsonl` files. The input also has certain
80-
required formats for fine-tuning
81-
[chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
82-
[completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
83-
models.
84-
85-
The Batch API only supports `.jsonl` files up to 200 MB in size. The input also
86-
has a specific required
87-
[format](https://platform.openai.com/docs/api-reference/batch/request-input).
74+
- The Assistants API supports files up to 2 million tokens and of specific file
75+
types. See the
76+
[Assistants Tools guide](https://platform.openai.com/docs/assistants/tools)
77+
for details.
78+
- The Fine-tuning API only supports `.jsonl` files. The input also has certain
79+
required formats for fine-tuning
80+
[chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
81+
or
82+
[completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
83+
models.
84+
- The Batch API only supports `.jsonl` files up to 200 MB in size. The input
85+
also has a specific required
86+
[format](https://platform.openai.com/docs/api-reference/batch/request-input).
8887
8988
Please [contact us](https://help.openai.com/) if you need to increase these
9089
storage limits.
@@ -388,20 +387,19 @@ async def create(
388387
up to 512 MB, and the size of all files uploaded by one organization can be up
389388
to 1 TB.
390389
391-
The Assistants API supports files up to 2 million tokens and of specific file
392-
types. See the
393-
[Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for
394-
details.
395-
396-
The Fine-tuning API only supports `.jsonl` files. The input also has certain
397-
required formats for fine-tuning
398-
[chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
399-
[completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
400-
models.
401-
402-
The Batch API only supports `.jsonl` files up to 200 MB in size. The input also
403-
has a specific required
404-
[format](https://platform.openai.com/docs/api-reference/batch/request-input).
390+
- The Assistants API supports files up to 2 million tokens and of specific file
391+
types. See the
392+
[Assistants Tools guide](https://platform.openai.com/docs/assistants/tools)
393+
for details.
394+
- The Fine-tuning API only supports `.jsonl` files. The input also has certain
395+
required formats for fine-tuning
396+
[chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
397+
or
398+
[completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
399+
models.
400+
- The Batch API only supports `.jsonl` files up to 200 MB in size. The input
401+
also has a specific required
402+
[format](https://platform.openai.com/docs/api-reference/batch/request-input).
405403
406404
Please [contact us](https://help.openai.com/) if you need to increase these
407405
storage limits.

src/openai/types/shared/reasoning.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,6 @@ class Reasoning(BaseModel):
3535
3636
This can be useful for debugging and understanding the model's reasoning
3737
process. One of `auto`, `concise`, or `detailed`.
38+
39+
`concise` is only supported for `computer-use-preview` models.
3840
"""

src/openai/types/shared_params/reasoning.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,6 @@ class Reasoning(TypedDict, total=False):
3636
3737
This can be useful for debugging and understanding the model's reasoning
3838
process. One of `auto`, `concise`, or `detailed`.
39+
40+
`concise` is only supported for `computer-use-preview` models.
3941
"""

0 commit comments

Comments
 (0)