Skip to content

Commit b24eab6

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore: deprecate Assistants API
1 parent 76b3100 commit b24eab6

File tree

5 files changed

+31
-132
lines changed

5 files changed

+31
-132
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: 111
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

‎src/resources/beta/threads/messages.ts‎

Lines changed: 8 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,14 @@ import * as Shared from '../../shared';
77
import * as AssistantsAPI from '../assistants';
88
import { CursorPage, type CursorPageParams } from '../../../pagination';
99

10+
/**
11+
* @deprecated The Assistants API is deprecated in favor of the Responses API
12+
*/
1013
export class Messages extends APIResource {
1114
/**
1215
* Create a message.
1316
*
14-
* @example
15-
* ```ts
16-
* const message = await client.beta.threads.messages.create(
17-
* 'thread_id',
18-
* { content: 'string', role: 'user' },
19-
* );
20-
* ```
17+
* @deprecated The Assistants API is deprecated in favor of the Responses API
2118
*/
2219
create(
2320
threadId: string,
@@ -34,13 +31,7 @@ export class Messages extends APIResource {
3431
/**
3532
* Retrieve a message.
3633
*
37-
* @example
38-
* ```ts
39-
* const message = await client.beta.threads.messages.retrieve(
40-
* 'thread_id',
41-
* 'message_id',
42-
* );
43-
* ```
34+
* @deprecated The Assistants API is deprecated in favor of the Responses API
4435
*/
4536
retrieve(threadId: string, messageId: string, options?: Core.RequestOptions): Core.APIPromise<Message> {
4637
return this._client.get(`/threads/${threadId}/messages/${messageId}`, {
@@ -52,13 +43,7 @@ export class Messages extends APIResource {
5243
/**
5344
* Modifies a message.
5445
*
55-
* @example
56-
* ```ts
57-
* const message = await client.beta.threads.messages.update(
58-
* 'thread_id',
59-
* 'message_id',
60-
* );
61-
* ```
46+
* @deprecated The Assistants API is deprecated in favor of the Responses API
6247
*/
6348
update(
6449
threadId: string,
@@ -76,15 +61,7 @@ export class Messages extends APIResource {
7661
/**
7762
* Returns a list of messages for a given thread.
7863
*
79-
* @example
80-
* ```ts
81-
* // Automatically fetches more pages as needed.
82-
* for await (const message of client.beta.threads.messages.list(
83-
* 'thread_id',
84-
* )) {
85-
* // ...
86-
* }
87-
* ```
64+
* @deprecated The Assistants API is deprecated in favor of the Responses API
8865
*/
8966
list(
9067
threadId: string,
@@ -110,14 +87,7 @@ export class Messages extends APIResource {
11087
/**
11188
* Deletes a message.
11289
*
113-
* @example
114-
* ```ts
115-
* const messageDeleted =
116-
* await client.beta.threads.messages.del(
117-
* 'thread_id',
118-
* 'message_id',
119-
* );
120-
* ```
90+
* @deprecated The Assistants API is deprecated in favor of the Responses API
12191
*/
12292
del(threadId: string, messageId: string, options?: Core.RequestOptions): Core.APIPromise<MessageDeleted> {
12393
return this._client.delete(`/threads/${threadId}/messages/${messageId}`, {

‎src/resources/beta/threads/runs/runs.ts‎

Lines changed: 9 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,16 @@ import {
4040
import { CursorPage, type CursorPageParams } from '../../../../pagination';
4141
import { Stream } from '../../../../streaming';
4242

43+
/**
44+
* @deprecated The Assistants API is deprecated in favor of the Responses API
45+
*/
4346
export class Runs extends APIResource {
4447
steps: StepsAPI.Steps = new StepsAPI.Steps(this._client);
4548

4649
/**
4750
* Create a run.
4851
*
49-
* @example
50-
* ```ts
51-
* const run = await client.beta.threads.runs.create(
52-
* 'thread_id',
53-
* { assistant_id: 'assistant_id' },
54-
* );
55-
* ```
52+
* @deprecated The Assistants API is deprecated in favor of the Responses API
5653
*/
5754
create(
5855
threadId: string,
@@ -87,13 +84,7 @@ export class Runs extends APIResource {
8784
/**
8885
* Retrieves a run.
8986
*
90-
* @example
91-
* ```ts
92-
* const run = await client.beta.threads.runs.retrieve(
93-
* 'thread_id',
94-
* 'run_id',
95-
* );
96-
* ```
87+
* @deprecated The Assistants API is deprecated in favor of the Responses API
9788
*/
9889
retrieve(threadId: string, runId: string, options?: Core.RequestOptions): Core.APIPromise<Run> {
9990
return this._client.get(`/threads/${threadId}/runs/${runId}`, {
@@ -105,13 +96,7 @@ export class Runs extends APIResource {
10596
/**
10697
* Modifies a run.
10798
*
108-
* @example
109-
* ```ts
110-
* const run = await client.beta.threads.runs.update(
111-
* 'thread_id',
112-
* 'run_id',
113-
* );
114-
* ```
99+
* @deprecated The Assistants API is deprecated in favor of the Responses API
115100
*/
116101
update(
117102
threadId: string,
@@ -129,15 +114,7 @@ export class Runs extends APIResource {
129114
/**
130115
* Returns a list of runs belonging to a thread.
131116
*
132-
* @example
133-
* ```ts
134-
* // Automatically fetches more pages as needed.
135-
* for await (const run of client.beta.threads.runs.list(
136-
* 'thread_id',
137-
* )) {
138-
* // ...
139-
* }
140-
* ```
117+
* @deprecated The Assistants API is deprecated in favor of the Responses API
141118
*/
142119
list(
143120
threadId: string,
@@ -163,13 +140,7 @@ export class Runs extends APIResource {
163140
/**
164141
* Cancels a run that is `in_progress`.
165142
*
166-
* @example
167-
* ```ts
168-
* const run = await client.beta.threads.runs.cancel(
169-
* 'thread_id',
170-
* 'run_id',
171-
* );
172-
* ```
143+
* @deprecated The Assistants API is deprecated in favor of the Responses API
173144
*/
174145
cancel(threadId: string, runId: string, options?: Core.RequestOptions): Core.APIPromise<Run> {
175146
return this._client.post(`/threads/${threadId}/runs/${runId}/cancel`, {
@@ -272,15 +243,7 @@ export class Runs extends APIResource {
272243
* tool calls once they're all completed. All outputs must be submitted in a single
273244
* request.
274245
*
275-
* @example
276-
* ```ts
277-
* const run =
278-
* await client.beta.threads.runs.submitToolOutputs(
279-
* 'thread_id',
280-
* 'run_id',
281-
* { tool_outputs: [{}] },
282-
* );
283-
* ```
246+
* @deprecated The Assistants API is deprecated in favor of the Responses API
284247
*/
285248
submitToolOutputs(
286249
threadId: string,

‎src/resources/beta/threads/runs/steps.ts‎

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,14 @@ import * as StepsAPI from './steps';
77
import * as Shared from '../../../shared';
88
import { CursorPage, type CursorPageParams } from '../../../../pagination';
99

10+
/**
11+
* @deprecated The Assistants API is deprecated in favor of the Responses API
12+
*/
1013
export class Steps extends APIResource {
1114
/**
1215
* Retrieves a run step.
1316
*
14-
* @example
15-
* ```ts
16-
* const runStep =
17-
* await client.beta.threads.runs.steps.retrieve(
18-
* 'thread_id',
19-
* 'run_id',
20-
* 'step_id',
21-
* );
22-
* ```
17+
* @deprecated The Assistants API is deprecated in favor of the Responses API
2318
*/
2419
retrieve(
2520
threadId: string,
@@ -54,16 +49,7 @@ export class Steps extends APIResource {
5449
/**
5550
* Returns a list of run steps belonging to a run.
5651
*
57-
* @example
58-
* ```ts
59-
* // Automatically fetches more pages as needed.
60-
* for await (const runStep of client.beta.threads.runs.steps.list(
61-
* 'thread_id',
62-
* 'run_id',
63-
* )) {
64-
* // ...
65-
* }
66-
* ```
52+
* @deprecated The Assistants API is deprecated in favor of the Responses API
6753
*/
6854
list(
6955
threadId: string,

‎src/resources/beta/threads/threads.ts‎

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,17 @@ import {
6767
} from './runs/runs';
6868
import { Stream } from '../../../streaming';
6969

70+
/**
71+
* @deprecated The Assistants API is deprecated in favor of the Responses API
72+
*/
7073
export class Threads extends APIResource {
7174
runs: RunsAPI.Runs = new RunsAPI.Runs(this._client);
7275
messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
7376

7477
/**
7578
* Create a thread.
7679
*
77-
* @example
78-
* ```ts
79-
* const thread = await client.beta.threads.create();
80-
* ```
80+
* @deprecated The Assistants API is deprecated in favor of the Responses API
8181
*/
8282
create(body?: ThreadCreateParams, options?: Core.RequestOptions): Core.APIPromise<Thread>;
8383
create(options?: Core.RequestOptions): Core.APIPromise<Thread>;
@@ -98,12 +98,7 @@ export class Threads extends APIResource {
9898
/**
9999
* Retrieves a thread.
100100
*
101-
* @example
102-
* ```ts
103-
* const thread = await client.beta.threads.retrieve(
104-
* 'thread_id',
105-
* );
106-
* ```
101+
* @deprecated The Assistants API is deprecated in favor of the Responses API
107102
*/
108103
retrieve(threadId: string, options?: Core.RequestOptions): Core.APIPromise<Thread> {
109104
return this._client.get(`/threads/${threadId}`, {
@@ -115,12 +110,7 @@ export class Threads extends APIResource {
115110
/**
116111
* Modifies a thread.
117112
*
118-
* @example
119-
* ```ts
120-
* const thread = await client.beta.threads.update(
121-
* 'thread_id',
122-
* );
123-
* ```
113+
* @deprecated The Assistants API is deprecated in favor of the Responses API
124114
*/
125115
update(threadId: string, body: ThreadUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Thread> {
126116
return this._client.post(`/threads/${threadId}`, {
@@ -133,12 +123,7 @@ export class Threads extends APIResource {
133123
/**
134124
* Delete a thread.
135125
*
136-
* @example
137-
* ```ts
138-
* const threadDeleted = await client.beta.threads.del(
139-
* 'thread_id',
140-
* );
141-
* ```
126+
* @deprecated The Assistants API is deprecated in favor of the Responses API
142127
*/
143128
del(threadId: string, options?: Core.RequestOptions): Core.APIPromise<ThreadDeleted> {
144129
return this._client.delete(`/threads/${threadId}`, {
@@ -150,12 +135,7 @@ export class Threads extends APIResource {
150135
/**
151136
* Create a thread and run it in one request.
152137
*
153-
* @example
154-
* ```ts
155-
* const run = await client.beta.threads.createAndRun({
156-
* assistant_id: 'assistant_id',
157-
* });
158-
* ```
138+
* @deprecated The Assistants API is deprecated in favor of the Responses API
159139
*/
160140
createAndRun(
161141
body: ThreadCreateAndRunParamsNonStreaming,

0 commit comments

Comments
 (0)