Skip to content

Commit 4ce7530

Browse files
chore: deprecate Assistants API
1 parent 0e24b3e commit 4ce7530

File tree

5 files changed

+49
-3
lines changed

5 files changed

+49
-3
lines changed

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 109
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-fc64d7c2c8f51f750813375356c3f3fdfc7fc1b1b34f19c20a5410279d445d37.yml
33
openapi_spec_hash: 618285fc70199ee32b9ebe4bf72f7e4c
4-
config_hash: 535b6e5f26a295d609b259c8cb8f656c
4+
config_hash: 3b590818075ca4b54949578b97494525

lib/openai/resources/beta/threads.rb

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@
33
module OpenAI
44
module Resources
55
class Beta
6+
# @deprecated The Assistants API is deprecated in favor of the Responses API
67
class Threads
78
# @return [OpenAI::Resources::Beta::Threads::Runs]
89
attr_reader :runs
910

1011
# @return [OpenAI::Resources::Beta::Threads::Messages]
1112
attr_reader :messages
1213

14+
# @deprecated The Assistants API is deprecated in favor of the Responses API
15+
#
1316
# Some parameter documentations has been truncated, see
1417
# {OpenAI::Models::Beta::ThreadCreateParams} for more details.
1518
#
@@ -39,6 +42,8 @@ def create(params = {})
3942
)
4043
end
4144

45+
# @deprecated The Assistants API is deprecated in favor of the Responses API
46+
#
4247
# Retrieves a thread.
4348
#
4449
# @overload retrieve(thread_id, request_options: {})
@@ -59,6 +64,8 @@ def retrieve(thread_id, params = {})
5964
)
6065
end
6166

67+
# @deprecated The Assistants API is deprecated in favor of the Responses API
68+
#
6269
# Some parameter documentations has been truncated, see
6370
# {OpenAI::Models::Beta::ThreadUpdateParams} for more details.
6471
#
@@ -88,6 +95,8 @@ def update(thread_id, params = {})
8895
)
8996
end
9097

98+
# @deprecated The Assistants API is deprecated in favor of the Responses API
99+
#
91100
# Delete a thread.
92101
#
93102
# @overload delete(thread_id, request_options: {})
@@ -108,6 +117,8 @@ def delete(thread_id, params = {})
108117
)
109118
end
110119

120+
# @deprecated The Assistants API is deprecated in favor of the Responses API
121+
#
111122
# See {OpenAI::Resources::Beta::Threads#stream_raw} for streaming counterpart.
112123
#
113124
# Some parameter documentations has been truncated, see
@@ -166,11 +177,13 @@ def create_and_run(params)
166177
options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
167178
)
168179
end
169-
180+
170181
def stream
171182
raise NotImplementedError.new("higher level helpers are coming soon!")
172183
end
173-
184+
185+
# @deprecated The Assistants API is deprecated in favor of the Responses API
186+
#
174187
# See {OpenAI::Resources::Beta::Threads#create_and_run} for non-streaming
175188
# counterpart.
176189
#

lib/openai/resources/beta/threads/messages.rb

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ module OpenAI
44
module Resources
55
class Beta
66
class Threads
7+
# @deprecated The Assistants API is deprecated in favor of the Responses API
78
class Messages
9+
# @deprecated The Assistants API is deprecated in favor of the Responses API
10+
#
811
# Some parameter documentations has been truncated, see
912
# {OpenAI::Models::Beta::Threads::MessageCreateParams} for more details.
1013
#
@@ -38,6 +41,8 @@ def create(thread_id, params)
3841
)
3942
end
4043

44+
# @deprecated The Assistants API is deprecated in favor of the Responses API
45+
#
4146
# Some parameter documentations has been truncated, see
4247
# {OpenAI::Models::Beta::Threads::MessageRetrieveParams} for more details.
4348
#
@@ -68,6 +73,8 @@ def retrieve(message_id, params)
6873
)
6974
end
7075

76+
# @deprecated The Assistants API is deprecated in favor of the Responses API
77+
#
7178
# Some parameter documentations has been truncated, see
7279
# {OpenAI::Models::Beta::Threads::MessageUpdateParams} for more details.
7380
#
@@ -101,6 +108,8 @@ def update(message_id, params)
101108
)
102109
end
103110

111+
# @deprecated The Assistants API is deprecated in favor of the Responses API
112+
#
104113
# Some parameter documentations has been truncated, see
105114
# {OpenAI::Models::Beta::Threads::MessageListParams} for more details.
106115
#
@@ -137,6 +146,8 @@ def list(thread_id, params = {})
137146
)
138147
end
139148

149+
# @deprecated The Assistants API is deprecated in favor of the Responses API
150+
#
140151
# Deletes a message.
141152
#
142153
# @overload delete(message_id, thread_id:, request_options: {})

lib/openai/resources/beta/threads/runs.rb

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@ module OpenAI
44
module Resources
55
class Beta
66
class Threads
7+
# @deprecated The Assistants API is deprecated in favor of the Responses API
78
class Runs
89
# @return [OpenAI::Resources::Beta::Threads::Runs::Steps]
910
attr_reader :steps
1011

12+
# @deprecated The Assistants API is deprecated in favor of the Responses API
13+
#
1114
# See {OpenAI::Resources::Beta::Threads::Runs#create_stream_raw} for streaming
1215
# counterpart.
1316
#
@@ -76,6 +79,8 @@ def create(thread_id, params)
7679
)
7780
end
7881

82+
# @deprecated The Assistants API is deprecated in favor of the Responses API
83+
#
7984
# See {OpenAI::Resources::Beta::Threads::Runs#create} for non-streaming
8085
# counterpart.
8186
#
@@ -147,6 +152,8 @@ def create_stream_raw(thread_id, params)
147152
)
148153
end
149154

155+
# @deprecated The Assistants API is deprecated in favor of the Responses API
156+
#
150157
# Some parameter documentations has been truncated, see
151158
# {OpenAI::Models::Beta::Threads::RunRetrieveParams} for more details.
152159
#
@@ -177,6 +184,8 @@ def retrieve(run_id, params)
177184
)
178185
end
179186

187+
# @deprecated The Assistants API is deprecated in favor of the Responses API
188+
#
180189
# Some parameter documentations has been truncated, see
181190
# {OpenAI::Models::Beta::Threads::RunUpdateParams} for more details.
182191
#
@@ -210,6 +219,8 @@ def update(run_id, params)
210219
)
211220
end
212221

222+
# @deprecated The Assistants API is deprecated in favor of the Responses API
223+
#
213224
# Some parameter documentations has been truncated, see
214225
# {OpenAI::Models::Beta::Threads::RunListParams} for more details.
215226
#
@@ -244,6 +255,8 @@ def list(thread_id, params = {})
244255
)
245256
end
246257

258+
# @deprecated The Assistants API is deprecated in favor of the Responses API
259+
#
247260
# Cancels a run that is `in_progress`.
248261
#
249262
# @overload cancel(run_id, thread_id:, request_options: {})
@@ -271,6 +284,8 @@ def cancel(run_id, params)
271284
)
272285
end
273286

287+
# @deprecated The Assistants API is deprecated in favor of the Responses API
288+
#
274289
# See {OpenAI::Resources::Beta::Threads::Runs#submit_tool_outputs_stream_raw} for
275290
# streaming counterpart.
276291
#
@@ -314,6 +329,8 @@ def submit_tool_outputs(run_id, params)
314329
)
315330
end
316331

332+
# @deprecated The Assistants API is deprecated in favor of the Responses API
333+
#
317334
# See {OpenAI::Resources::Beta::Threads::Runs#submit_tool_outputs} for
318335
# non-streaming counterpart.
319336
#

lib/openai/resources/beta/threads/runs/steps.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ module Resources
55
class Beta
66
class Threads
77
class Runs
8+
# @deprecated The Assistants API is deprecated in favor of the Responses API
89
class Steps
10+
# @deprecated The Assistants API is deprecated in favor of the Responses API
11+
#
912
# Some parameter documentations has been truncated, see
1013
# {OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams} for more details.
1114
#
@@ -45,6 +48,8 @@ def retrieve(step_id, params)
4548
)
4649
end
4750

51+
# @deprecated The Assistants API is deprecated in favor of the Responses API
52+
#
4853
# Some parameter documentations has been truncated, see
4954
# {OpenAI::Models::Beta::Threads::Runs::StepListParams} for more details.
5055
#

0 commit comments

Comments
 (0)