chore: deprecate Assistants API

stainless-app[bot] · stainless-app[bot] · commit 4ce753088e18 · 2025-05-29T15:58:00.000Z
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 109
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-fc64d7c2c8f51f750813375356c3f3fdfc7fc1b1b34f19c20a5410279d445d37.yml
 openapi_spec_hash: 618285fc70199ee32b9ebe4bf72f7e4c
-config_hash: 535b6e5f26a295d609b259c8cb8f656c
+config_hash: 3b590818075ca4b54949578b97494525
diff --git a/lib/openai/resources/beta/threads.rb b/lib/openai/resources/beta/threads.rb
@@ -3,13 +3,16 @@
 module OpenAI
   module Resources
     class Beta
+      # @deprecated The Assistants API is deprecated in favor of the Responses API
       class Threads
         # @return [OpenAI::Resources::Beta::Threads::Runs]
         attr_reader :runs
 
         # @return [OpenAI::Resources::Beta::Threads::Messages]
         attr_reader :messages
 
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # Some parameter documentations has been truncated, see
         # {OpenAI::Models::Beta::ThreadCreateParams} for more details.
         #
@@ -39,6 +42,8 @@ def create(params = {})
           )
         end
 
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # Retrieves a thread.
         #
         # @overload retrieve(thread_id, request_options: {})
@@ -59,6 +64,8 @@ def retrieve(thread_id, params = {})
           )
         end
 
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # Some parameter documentations has been truncated, see
         # {OpenAI::Models::Beta::ThreadUpdateParams} for more details.
         #
@@ -88,6 +95,8 @@ def update(thread_id, params = {})
           )
         end
 
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # Delete a thread.
         #
         # @overload delete(thread_id, request_options: {})
@@ -108,6 +117,8 @@ def delete(thread_id, params = {})
           )
         end
 
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # See {OpenAI::Resources::Beta::Threads#stream_raw} for streaming counterpart.
         #
         # Some parameter documentations has been truncated, see
@@ -166,11 +177,13 @@ def create_and_run(params)
             options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
           )
         end
-
+        
         def stream
           raise NotImplementedError.new("higher level helpers are coming soon!")
         end
-
+        
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
         # See {OpenAI::Resources::Beta::Threads#create_and_run} for non-streaming
         # counterpart.
         #
diff --git a/lib/openai/resources/beta/threads/messages.rb b/lib/openai/resources/beta/threads/messages.rb
@@ -4,7 +4,10 @@ module OpenAI
   module Resources
     class Beta
       class Threads
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
         class Messages
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::MessageCreateParams} for more details.
           #
@@ -38,6 +41,8 @@ def create(thread_id, params)
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::MessageRetrieveParams} for more details.
           #
@@ -68,6 +73,8 @@ def retrieve(message_id, params)
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::MessageUpdateParams} for more details.
           #
@@ -101,6 +108,8 @@ def update(message_id, params)
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::MessageListParams} for more details.
           #
@@ -137,6 +146,8 @@ def list(thread_id, params = {})
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Deletes a message.
           #
           # @overload delete(message_id, thread_id:, request_options: {})
diff --git a/lib/openai/resources/beta/threads/runs.rb b/lib/openai/resources/beta/threads/runs.rb
@@ -4,10 +4,13 @@ module OpenAI
   module Resources
     class Beta
       class Threads
+        # @deprecated The Assistants API is deprecated in favor of the Responses API
         class Runs
           # @return [OpenAI::Resources::Beta::Threads::Runs::Steps]
           attr_reader :steps
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # See {OpenAI::Resources::Beta::Threads::Runs#create_stream_raw} for streaming
           # counterpart.
           #
@@ -76,6 +79,8 @@ def create(thread_id, params)
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # See {OpenAI::Resources::Beta::Threads::Runs#create} for non-streaming
           # counterpart.
           #
@@ -147,6 +152,8 @@ def create_stream_raw(thread_id, params)
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::RunRetrieveParams} for more details.
           #
@@ -177,6 +184,8 @@ def retrieve(run_id, params)
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::RunUpdateParams} for more details.
           #
@@ -210,6 +219,8 @@ def update(run_id, params)
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Beta::Threads::RunListParams} for more details.
           #
@@ -244,6 +255,8 @@ def list(thread_id, params = {})
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # Cancels a run that is `in_progress`.
           #
           # @overload cancel(run_id, thread_id:, request_options: {})
@@ -271,6 +284,8 @@ def cancel(run_id, params)
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # See {OpenAI::Resources::Beta::Threads::Runs#submit_tool_outputs_stream_raw} for
           # streaming counterpart.
           #
@@ -314,6 +329,8 @@ def submit_tool_outputs(run_id, params)
             )
           end
 
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
           # See {OpenAI::Resources::Beta::Threads::Runs#submit_tool_outputs} for
           # non-streaming counterpart.
           #
diff --git a/lib/openai/resources/beta/threads/runs/steps.rb b/lib/openai/resources/beta/threads/runs/steps.rb
@@ -5,7 +5,10 @@ module Resources
     class Beta
       class Threads
         class Runs
+          # @deprecated The Assistants API is deprecated in favor of the Responses API
           class Steps
+            # @deprecated The Assistants API is deprecated in favor of the Responses API
+            #
             # Some parameter documentations has been truncated, see
             # {OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams} for more details.
             #
@@ -45,6 +48,8 @@ def retrieve(step_id, params)
               )
             end
 
+            # @deprecated The Assistants API is deprecated in favor of the Responses API
+            #
             # Some parameter documentations has been truncated, see
             # {OpenAI::Models::Beta::Threads::Runs::StepListParams} for more details.
             #

Original file line number	Diff line number	Diff line change
`@@ -3,13 +3,16 @@`
`3`	`3`	`module OpenAI`
`4`	`4`	`module Resources`
`5`	`5`	`class Beta`
	`6`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
`6`	`7`	`class Threads`
`7`	`8`	`# @return [OpenAI::Resources::Beta::Threads::Runs]`
`8`	`9`	`attr_reader :runs`
`9`	`10`
`10`	`11`	`# @return [OpenAI::Resources::Beta::Threads::Messages]`
`11`	`12`	`attr_reader :messages`
`12`	`13`
	`14`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`15`	`+ #`
`13`	`16`	`# Some parameter documentations has been truncated, see`
`14`	`17`	`# {OpenAI::Models::Beta::ThreadCreateParams} for more details.`
`15`	`18`	`#`
`@@ -39,6 +42,8 @@ def create(params = {})`
`39`	`42`	`)`
`40`	`43`	`end`
`41`	`44`
	`45`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`46`	`+ #`
`42`	`47`	`# Retrieves a thread.`
`43`	`48`	`#`
`44`	`49`	`# @overload retrieve(thread_id, request_options: {})`
`@@ -59,6 +64,8 @@ def retrieve(thread_id, params = {})`
`59`	`64`	`)`
`60`	`65`	`end`
`61`	`66`
	`67`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`68`	`+ #`
`62`	`69`	`# Some parameter documentations has been truncated, see`
`63`	`70`	`# {OpenAI::Models::Beta::ThreadUpdateParams} for more details.`
`64`	`71`	`#`
`@@ -88,6 +95,8 @@ def update(thread_id, params = {})`
`88`	`95`	`)`
`89`	`96`	`end`
`90`	`97`
	`98`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`99`	`+ #`
`91`	`100`	`# Delete a thread.`
`92`	`101`	`#`
`93`	`102`	`# @overload delete(thread_id, request_options: {})`
`@@ -108,6 +117,8 @@ def delete(thread_id, params = {})`
`108`	`117`	`)`
`109`	`118`	`end`
`110`	`119`
	`120`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`121`	`+ #`
`111`	`122`	`# See {OpenAI::Resources::Beta::Threads#stream_raw} for streaming counterpart.`
`112`	`123`	`#`
`113`	`124`	`# Some parameter documentations has been truncated, see`
`@@ -166,11 +177,13 @@ def create_and_run(params)`
`166`	`177`	`options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}`
`167`	`178`	`)`
`168`	`179`	`end`
`169`		`-`
	`180`	`+`
`170`	`181`	`def stream`
`171`	`182`	`raise NotImplementedError.new("higher level helpers are coming soon!")`
`172`	`183`	`end`
`173`		`-`
	`184`	`+`
	`185`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`186`	`+ #`
`174`	`187`	`# See {OpenAI::Resources::Beta::Threads#create_and_run} for non-streaming`
`175`	`188`	`# counterpart.`
`176`	`189`	`#`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,10 @@ module OpenAI`
`4`	`4`	`module Resources`
`5`	`5`	`class Beta`
`6`	`6`	`class Threads`
	`7`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
`7`	`8`	`class Messages`
	`9`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`10`	`+ #`
`8`	`11`	`# Some parameter documentations has been truncated, see`
`9`	`12`	`# {OpenAI::Models::Beta::Threads::MessageCreateParams} for more details.`
`10`	`13`	`#`
`@@ -38,6 +41,8 @@ def create(thread_id, params)`
`38`	`41`	`)`
`39`	`42`	`end`
`40`	`43`
	`44`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`45`	`+ #`
`41`	`46`	`# Some parameter documentations has been truncated, see`
`42`	`47`	`# {OpenAI::Models::Beta::Threads::MessageRetrieveParams} for more details.`
`43`	`48`	`#`
`@@ -68,6 +73,8 @@ def retrieve(message_id, params)`
`68`	`73`	`)`
`69`	`74`	`end`
`70`	`75`
	`76`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`77`	`+ #`
`71`	`78`	`# Some parameter documentations has been truncated, see`
`72`	`79`	`# {OpenAI::Models::Beta::Threads::MessageUpdateParams} for more details.`
`73`	`80`	`#`
`@@ -101,6 +108,8 @@ def update(message_id, params)`
`101`	`108`	`)`
`102`	`109`	`end`
`103`	`110`
	`111`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`112`	`+ #`
`104`	`113`	`# Some parameter documentations has been truncated, see`
`105`	`114`	`# {OpenAI::Models::Beta::Threads::MessageListParams} for more details.`
`106`	`115`	`#`
`@@ -137,6 +146,8 @@ def list(thread_id, params = {})`
`137`	`146`	`)`
`138`	`147`	`end`
`139`	`148`
	`149`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`150`	`+ #`
`140`	`151`	`# Deletes a message.`
`141`	`152`	`#`
`142`	`153`	`# @overload delete(message_id, thread_id:, request_options: {})`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,13 @@ module OpenAI`
`4`	`4`	`module Resources`
`5`	`5`	`class Beta`
`6`	`6`	`class Threads`
	`7`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
`7`	`8`	`class Runs`
`8`	`9`	`# @return [OpenAI::Resources::Beta::Threads::Runs::Steps]`
`9`	`10`	`attr_reader :steps`
`10`	`11`
	`12`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`13`	`+ #`
`11`	`14`	`# See {OpenAI::Resources::Beta::Threads::Runs#create_stream_raw} for streaming`
`12`	`15`	`# counterpart.`
`13`	`16`	`#`
`@@ -76,6 +79,8 @@ def create(thread_id, params)`
`76`	`79`	`)`
`77`	`80`	`end`
`78`	`81`
	`82`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`83`	`+ #`
`79`	`84`	`# See {OpenAI::Resources::Beta::Threads::Runs#create} for non-streaming`
`80`	`85`	`# counterpart.`
`81`	`86`	`#`
`@@ -147,6 +152,8 @@ def create_stream_raw(thread_id, params)`
`147`	`152`	`)`
`148`	`153`	`end`
`149`	`154`
	`155`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`156`	`+ #`
`150`	`157`	`# Some parameter documentations has been truncated, see`
`151`	`158`	`# {OpenAI::Models::Beta::Threads::RunRetrieveParams} for more details.`
`152`	`159`	`#`
`@@ -177,6 +184,8 @@ def retrieve(run_id, params)`
`177`	`184`	`)`
`178`	`185`	`end`
`179`	`186`
	`187`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`188`	`+ #`
`180`	`189`	`# Some parameter documentations has been truncated, see`
`181`	`190`	`# {OpenAI::Models::Beta::Threads::RunUpdateParams} for more details.`
`182`	`191`	`#`
`@@ -210,6 +219,8 @@ def update(run_id, params)`
`210`	`219`	`)`
`211`	`220`	`end`
`212`	`221`
	`222`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`223`	`+ #`
`213`	`224`	`# Some parameter documentations has been truncated, see`
`214`	`225`	`# {OpenAI::Models::Beta::Threads::RunListParams} for more details.`
`215`	`226`	`#`
`@@ -244,6 +255,8 @@ def list(thread_id, params = {})`
`244`	`255`	`)`
`245`	`256`	`end`
`246`	`257`
	`258`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`259`	`+ #`
`247`	`260`	# Cancels a run that is `in_progress`.
`248`	`261`	`#`
`249`	`262`	`# @overload cancel(run_id, thread_id:, request_options: {})`
`@@ -271,6 +284,8 @@ def cancel(run_id, params)`
`271`	`284`	`)`
`272`	`285`	`end`
`273`	`286`
	`287`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`288`	`+ #`
`274`	`289`	`# See {OpenAI::Resources::Beta::Threads::Runs#submit_tool_outputs_stream_raw} for`
`275`	`290`	`# streaming counterpart.`
`276`	`291`	`#`
`@@ -314,6 +329,8 @@ def submit_tool_outputs(run_id, params)`
`314`	`329`	`)`
`315`	`330`	`end`
`316`	`331`
	`332`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`333`	`+ #`
`317`	`334`	`# See {OpenAI::Resources::Beta::Threads::Runs#submit_tool_outputs} for`
`318`	`335`	`# non-streaming counterpart.`
`319`	`336`	`#`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,10 @@ module Resources`
`5`	`5`	`class Beta`
`6`	`6`	`class Threads`
`7`	`7`	`class Runs`
	`8`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
`8`	`9`	`class Steps`
	`10`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`11`	`+ #`
`9`	`12`	`# Some parameter documentations has been truncated, see`
`10`	`13`	`# {OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams} for more details.`
`11`	`14`	`#`
`@@ -45,6 +48,8 @@ def retrieve(step_id, params)`
`45`	`48`	`)`
`46`	`49`	`end`
`47`	`50`
	`51`	`+ # @deprecated The Assistants API is deprecated in favor of the Responses API`
	`52`	`+ #`
`48`	`53`	`# Some parameter documentations has been truncated, see`
`49`	`54`	`# {OpenAI::Models::Beta::Threads::Runs::StepListParams} for more details.`
`50`	`55`	`#`