Skip to content

Commit c649360

Browse files
stainless-app[bot]stainless-app[bot]
committed
fix(api): docs updates
1 parent 2101ebe commit c649360

File tree

7 files changed

+60
-47
lines changed

7 files changed

+60
-47
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: 135
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

‎openai-java-core/src/main/kotlin/com/openai/models/Reasoning.kt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ private constructor(
7272
* A summary of the reasoning performed by the model. This can be useful for debugging and
7373
* understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`.
7474
*
75+
* `concise` is only supported for `computer-use-preview` models.
76+
*
7577
* @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
7678
* server responded with an unexpected value).
7779
*/
@@ -187,6 +189,8 @@ private constructor(
187189
/**
188190
* A summary of the reasoning performed by the model. This can be useful for debugging and
189191
* understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`.
192+
*
193+
* `concise` is only supported for `computer-use-preview` models.
190194
*/
191195
fun summary(summary: Summary?) = summary(JsonField.ofNullable(summary))
192196

@@ -406,6 +410,8 @@ private constructor(
406410
/**
407411
* A summary of the reasoning performed by the model. This can be useful for debugging and
408412
* understanding the model's reasoning process. One of `auto`, `concise`, or `detailed`.
413+
*
414+
* `concise` is only supported for `computer-use-preview` models.
409415
*/
410416
class Summary @JsonCreator private constructor(private val value: JsonField<String>) : Enum {
411417

‎openai-java-core/src/main/kotlin/com/openai/models/files/FileCreateParams.kt‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,14 @@ import kotlin.io.path.name
2525
/**
2626
* Upload a file that can be used across various endpoints. Individual files can be up to 512 MB,
2727
* and the size of all files uploaded by one organization can be up to 1 TB.
28-
*
29-
* The Assistants API supports files up to 2 million tokens and of specific file types. See the
30-
* [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for details.
31-
*
32-
* The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats for
33-
* fine-tuning [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
34-
* [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
35-
* models.
36-
*
37-
* The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a specific
38-
* required [format](https://platform.openai.com/docs/api-reference/batch/request-input).
28+
* - The Assistants API supports files up to 2 million tokens and of specific file types. See the
29+
* [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for details.
30+
* - The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats
31+
* for fine-tuning [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
32+
* or [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
33+
* models.
34+
* - The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a specific
35+
* required [format](https://platform.openai.com/docs/api-reference/batch/request-input).
3936
*
4037
* Please [contact us](https://help.openai.com/) if you need to increase these storage limits.
4138
*/

‎openai-java-core/src/main/kotlin/com/openai/models/realtime/RealtimeTracingConfig.kt‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ private constructor(
4242
private val _json: JsonValue? = null,
4343
) {
4444

45-
/** Default tracing mode for the session. */
45+
/** Enables tracing and sets default values for tracing configuration options. Always `auto`. */
4646
fun auto(): Optional<JsonValue> = Optional.ofNullable(auto)
4747

4848
/** Granular configuration for tracing. */
@@ -53,7 +53,7 @@ private constructor(
5353

5454
fun isTracingConfiguration(): Boolean = tracingConfiguration != null
5555

56-
/** Default tracing mode for the session. */
56+
/** Enables tracing and sets default values for tracing configuration options. Always `auto`. */
5757
fun asAuto(): JsonValue = auto.getOrThrow("auto")
5858

5959
/** Granular configuration for tracing. */
@@ -144,7 +144,9 @@ private constructor(
144144

145145
companion object {
146146

147-
/** Default tracing mode for the session. */
147+
/**
148+
* Enables tracing and sets default values for tracing configuration options. Always `auto`.
149+
*/
148150
@JvmStatic fun ofAuto() = RealtimeTracingConfig(auto = JsonValue.from("auto"))
149151

150152
/** Granular configuration for tracing. */
@@ -159,7 +161,9 @@ private constructor(
159161
*/
160162
interface Visitor<out T> {
161163

162-
/** Default tracing mode for the session. */
164+
/**
165+
* Enables tracing and sets default values for tracing configuration options. Always `auto`.
166+
*/
163167
fun visitAuto(auto: JsonValue): T
164168

165169
/** Granular configuration for tracing. */

‎openai-java-core/src/main/kotlin/com/openai/models/realtime/clientsecrets/RealtimeSessionCreateResponse.kt‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6657,7 +6657,9 @@ private constructor(
66576657
private val _json: JsonValue? = null,
66586658
) {
66596659

6660-
/** Default tracing mode for the session. */
6660+
/**
6661+
* Enables tracing and sets default values for tracing configuration options. Always `auto`.
6662+
*/
66616663
fun auto(): Optional<JsonValue> = Optional.ofNullable(auto)
66626664

66636665
/** Granular configuration for tracing. */
@@ -6667,7 +6669,9 @@ private constructor(
66676669

66686670
fun isConfiguration(): Boolean = configuration != null
66696671

6670-
/** Default tracing mode for the session. */
6672+
/**
6673+
* Enables tracing and sets default values for tracing configuration options. Always `auto`.
6674+
*/
66716675
fun asAuto(): JsonValue = auto.getOrThrow("auto")
66726676

66736677
/** Granular configuration for tracing. */
@@ -6755,7 +6759,10 @@ private constructor(
67556759

67566760
companion object {
67576761

6758-
/** Default tracing mode for the session. */
6762+
/**
6763+
* Enables tracing and sets default values for tracing configuration options. Always
6764+
* `auto`.
6765+
*/
67596766
@JvmStatic fun ofAuto() = Tracing(auto = JsonValue.from("auto"))
67606767

67616768
/** Granular configuration for tracing. */
@@ -6769,7 +6776,10 @@ private constructor(
67696776
*/
67706777
interface Visitor<out T> {
67716778

6772-
/** Default tracing mode for the session. */
6779+
/**
6780+
* Enables tracing and sets default values for tracing configuration options. Always
6781+
* `auto`.
6782+
*/
67736783
fun visitAuto(auto: JsonValue): T
67746784

67756785
/** Granular configuration for tracing. */

‎openai-java-core/src/main/kotlin/com/openai/services/async/FileServiceAsync.kt‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,17 @@ interface FileServiceAsync {
3434
/**
3535
* Upload a file that can be used across various endpoints. Individual files can be up to 512
3636
* MB, and the size of all files uploaded by one organization can be up to 1 TB.
37-
*
38-
* The Assistants API supports files up to 2 million tokens and of specific file types. See the
39-
* [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for details.
40-
*
41-
* The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats
42-
* for fine-tuning [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
43-
* or
44-
* [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
45-
* models.
46-
*
47-
* The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a
48-
* specific required
49-
* [format](https://platform.openai.com/docs/api-reference/batch/request-input).
37+
* - The Assistants API supports files up to 2 million tokens and of specific file types. See
38+
* the [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for
39+
* details.
40+
* - The Fine-tuning API only supports `.jsonl` files. The input also has certain required
41+
* formats for fine-tuning
42+
* [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
43+
* [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
44+
* models.
45+
* - The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a
46+
* specific required
47+
* [format](https://platform.openai.com/docs/api-reference/batch/request-input).
5048
*
5149
* Please [contact us](https://help.openai.com/) if you need to increase these storage limits.
5250
*/

‎openai-java-core/src/main/kotlin/com/openai/services/blocking/FileService.kt‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,17 @@ interface FileService {
3434
/**
3535
* Upload a file that can be used across various endpoints. Individual files can be up to 512
3636
* MB, and the size of all files uploaded by one organization can be up to 1 TB.
37-
*
38-
* The Assistants API supports files up to 2 million tokens and of specific file types. See the
39-
* [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for details.
40-
*
41-
* The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats
42-
* for fine-tuning [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
43-
* or
44-
* [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
45-
* models.
46-
*
47-
* The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a
48-
* specific required
49-
* [format](https://platform.openai.com/docs/api-reference/batch/request-input).
37+
* - The Assistants API supports files up to 2 million tokens and of specific file types. See
38+
* the [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for
39+
* details.
40+
* - The Fine-tuning API only supports `.jsonl` files. The input also has certain required
41+
* formats for fine-tuning
42+
* [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
43+
* [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
44+
* models.
45+
* - The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a
46+
* specific required
47+
* [format](https://platform.openai.com/docs/api-reference/batch/request-input).
5048
*
5149
* Please [contact us](https://help.openai.com/) if you need to increase these storage limits.
5250
*/

0 commit comments

Comments
 (0)