Skip to content

Commit 88a4a35

Browse files
fix(api): docs updates
1 parent a2856b0 commit 88a4a35

File tree

7 files changed

+40
-32
lines changed

7 files changed

+40
-32
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

lib/openai/models/realtime/realtime_session_create_response.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -990,7 +990,7 @@ module McpToolApprovalSetting
990990
module Tracing
991991
extend OpenAI::Internal::Type::Union
992992

993-
# Default tracing mode for the session.
993+
# Enables tracing and sets default values for tracing configuration options. Always `auto`.
994994
variant const: :auto
995995

996996
# Granular configuration for tracing.

lib/openai/models/realtime/realtime_tracing_config.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ module Realtime
1212
module RealtimeTracingConfig
1313
extend OpenAI::Internal::Type::Union
1414

15-
# Default tracing mode for the session.
15+
# Enables tracing and sets default values for tracing configuration options. Always `auto`.
1616
variant const: :auto
1717

1818
# Granular configuration for tracing.

lib/openai/models/reasoning.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ class Reasoning < OpenAI::Internal::Type::BaseModel
3333
# debugging and understanding the model's reasoning process. One of `auto`,
3434
# `concise`, or `detailed`.
3535
#
36+
# `concise` is only supported for `computer-use-preview` models.
37+
#
3638
# @return [Symbol, OpenAI::Models::Reasoning::Summary, nil]
3739
optional :summary, enum: -> { OpenAI::Reasoning::Summary }, nil?: true
3840

@@ -75,6 +77,8 @@ module GenerateSummary
7577
# debugging and understanding the model's reasoning process. One of `auto`,
7678
# `concise`, or `detailed`.
7779
#
80+
# `concise` is only supported for `computer-use-preview` models.
81+
#
7882
# @see OpenAI::Models::Reasoning#summary
7983
module Summary
8084
extend OpenAI::Internal::Type::Enum

lib/openai/resources/files.rb

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,19 @@ class Files
1010
# up to 512 MB, and the size of all files uploaded by one organization can be up
1111
# to 1 TB.
1212
#
13-
# The Assistants API supports files up to 2 million tokens and of specific file
14-
# types. See the
15-
# [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for
16-
# details.
17-
#
18-
# The Fine-tuning API only supports `.jsonl` files. The input also has certain
19-
# required formats for fine-tuning
20-
# [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
21-
# [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
22-
# models.
23-
#
24-
# The Batch API only supports `.jsonl` files up to 200 MB in size. The input also
25-
# has a specific required
26-
# [format](https://platform.openai.com/docs/api-reference/batch/request-input).
13+
# - The Assistants API supports files up to 2 million tokens and of specific file
14+
# types. See the
15+
# [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools)
16+
# for details.
17+
# - The Fine-tuning API only supports `.jsonl` files. The input also has certain
18+
# required formats for fine-tuning
19+
# [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
20+
# or
21+
# [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
22+
# models.
23+
# - The Batch API only supports `.jsonl` files up to 200 MB in size. The input
24+
# also has a specific required
25+
# [format](https://platform.openai.com/docs/api-reference/batch/request-input).
2726
#
2827
# Please [contact us](https://help.openai.com/) if you need to increase these
2928
# storage limits.

rbi/openai/models/reasoning.rbi

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ module OpenAI
2828
# A summary of the reasoning performed by the model. This can be useful for
2929
# debugging and understanding the model's reasoning process. One of `auto`,
3030
# `concise`, or `detailed`.
31+
#
32+
# `concise` is only supported for `computer-use-preview` models.
3133
sig { returns(T.nilable(OpenAI::Reasoning::Summary::OrSymbol)) }
3234
attr_accessor :summary
3335

@@ -62,6 +64,8 @@ module OpenAI
6264
# A summary of the reasoning performed by the model. This can be useful for
6365
# debugging and understanding the model's reasoning process. One of `auto`,
6466
# `concise`, or `detailed`.
67+
#
68+
# `concise` is only supported for `computer-use-preview` models.
6569
summary: nil
6670
)
6771
end
@@ -109,6 +113,8 @@ module OpenAI
109113
# A summary of the reasoning performed by the model. This can be useful for
110114
# debugging and understanding the model's reasoning process. One of `auto`,
111115
# `concise`, or `detailed`.
116+
#
117+
# `concise` is only supported for `computer-use-preview` models.
112118
module Summary
113119
extend OpenAI::Internal::Type::Enum
114120

rbi/openai/resources/files.rbi

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,19 @@ module OpenAI
77
# up to 512 MB, and the size of all files uploaded by one organization can be up
88
# to 1 TB.
99
#
10-
# The Assistants API supports files up to 2 million tokens and of specific file
11-
# types. See the
12-
# [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for
13-
# details.
14-
#
15-
# The Fine-tuning API only supports `.jsonl` files. The input also has certain
16-
# required formats for fine-tuning
17-
# [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
18-
# [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
19-
# models.
20-
#
21-
# The Batch API only supports `.jsonl` files up to 200 MB in size. The input also
22-
# has a specific required
23-
# [format](https://platform.openai.com/docs/api-reference/batch/request-input).
10+
# - The Assistants API supports files up to 2 million tokens and of specific file
11+
# types. See the
12+
# [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools)
13+
# for details.
14+
# - The Fine-tuning API only supports `.jsonl` files. The input also has certain
15+
# required formats for fine-tuning
16+
# [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
17+
# or
18+
# [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
19+
# models.
20+
# - The Batch API only supports `.jsonl` files up to 200 MB in size. The input
21+
# also has a specific required
22+
# [format](https://platform.openai.com/docs/api-reference/batch/request-input).
2423
#
2524
# Please [contact us](https://help.openai.com/) if you need to increase these
2625
# storage limits.

0 commit comments

Comments
 (0)