Skip to content

Commit 1726e6b

Browse files
stainless-app[bot]RobertCraigie
stainless-app[bot]
authored and
RobertCraigie
committed
chore: deprecate Assistants API
1 parent 1f59811 commit 1726e6b

File tree

5 files changed

+31
-129
lines changed

5 files changed

+31
-129
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 & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,14 @@ import { buildHeaders } from '../../../internal/headers';
99
import { RequestOptions } from '../../../internal/request-options';
1010
import { path } from '../../../internal/utils/path';
1111

12+
/**
13+
* @deprecated The Assistants API is deprecated in favor of the Responses API
14+
*/
1215
export class Messages extends APIResource {
1316
/**
1417
* Create a message.
1518
*
16-
* @example
17-
* ```ts
18-
* const message = await client.beta.threads.messages.create(
19-
* 'thread_id',
20-
* { content: 'string', role: 'user' },
21-
* );
22-
* ```
19+
* @deprecated The Assistants API is deprecated in favor of the Responses API
2320
*/
2421
create(threadID: string, body: MessageCreateParams, options?: RequestOptions): APIPromise<Message> {
2522
return this._client.post(path`/threads/${threadID}/messages`, {
@@ -32,13 +29,7 @@ export class Messages extends APIResource {
3229
/**
3330
* Retrieve a message.
3431
*
35-
* @example
36-
* ```ts
37-
* const message = await client.beta.threads.messages.retrieve(
38-
* 'message_id',
39-
* { thread_id: 'thread_id' },
40-
* );
41-
* ```
32+
* @deprecated The Assistants API is deprecated in favor of the Responses API
4233
*/
4334
retrieve(messageID: string, params: MessageRetrieveParams, options?: RequestOptions): APIPromise<Message> {
4435
const { thread_id } = params;
@@ -51,13 +42,7 @@ export class Messages extends APIResource {
5142
/**
5243
* Modifies a message.
5344
*
54-
* @example
55-
* ```ts
56-
* const message = await client.beta.threads.messages.update(
57-
* 'message_id',
58-
* { thread_id: 'thread_id' },
59-
* );
60-
* ```
45+
* @deprecated The Assistants API is deprecated in favor of the Responses API
6146
*/
6247
update(messageID: string, params: MessageUpdateParams, options?: RequestOptions): APIPromise<Message> {
6348
const { thread_id, ...body } = params;
@@ -71,15 +56,7 @@ export class Messages extends APIResource {
7156
/**
7257
* Returns a list of messages for a given thread.
7358
*
74-
* @example
75-
* ```ts
76-
* // Automatically fetches more pages as needed.
77-
* for await (const message of client.beta.threads.messages.list(
78-
* 'thread_id',
79-
* )) {
80-
* // ...
81-
* }
82-
* ```
59+
* @deprecated The Assistants API is deprecated in favor of the Responses API
8360
*/
8461
list(
8562
threadID: string,
@@ -96,13 +73,7 @@ export class Messages extends APIResource {
9673
/**
9774
* Deletes a message.
9875
*
99-
* @example
100-
* ```ts
101-
* const messageDeleted =
102-
* await client.beta.threads.messages.delete('message_id', {
103-
* thread_id: 'thread_id',
104-
* });
105-
* ```
76+
* @deprecated The Assistants API is deprecated in favor of the Responses API
10677
*/
10778
delete(
10879
messageID: string,

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

Lines changed: 9 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,16 @@ import { sleep } from '../../../../internal/utils/sleep';
4141
import { RunSubmitToolOutputsParamsStream } from '../../../../lib/AssistantStream';
4242
import { path } from '../../../../internal/utils/path';
4343

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

4750
/**
4851
* Create a run.
4952
*
50-
* @example
51-
* ```ts
52-
* const run = await client.beta.threads.runs.create(
53-
* 'thread_id',
54-
* { assistant_id: 'assistant_id' },
55-
* );
56-
* ```
53+
* @deprecated The Assistants API is deprecated in favor of the Responses API
5754
*/
5855
create(threadID: string, params: RunCreateParamsNonStreaming, options?: RequestOptions): APIPromise<Run>;
5956
create(
@@ -84,13 +81,7 @@ export class Runs extends APIResource {
8481
/**
8582
* Retrieves a run.
8683
*
87-
* @example
88-
* ```ts
89-
* const run = await client.beta.threads.runs.retrieve(
90-
* 'run_id',
91-
* { thread_id: 'thread_id' },
92-
* );
93-
* ```
84+
* @deprecated The Assistants API is deprecated in favor of the Responses API
9485
*/
9586
retrieve(runID: string, params: RunRetrieveParams, options?: RequestOptions): APIPromise<Run> {
9687
const { thread_id } = params;
@@ -103,13 +94,7 @@ export class Runs extends APIResource {
10394
/**
10495
* Modifies a run.
10596
*
106-
* @example
107-
* ```ts
108-
* const run = await client.beta.threads.runs.update(
109-
* 'run_id',
110-
* { thread_id: 'thread_id' },
111-
* );
112-
* ```
97+
* @deprecated The Assistants API is deprecated in favor of the Responses API
11398
*/
11499
update(runID: string, params: RunUpdateParams, options?: RequestOptions): APIPromise<Run> {
115100
const { thread_id, ...body } = params;
@@ -123,15 +108,7 @@ export class Runs extends APIResource {
123108
/**
124109
* Returns a list of runs belonging to a thread.
125110
*
126-
* @example
127-
* ```ts
128-
* // Automatically fetches more pages as needed.
129-
* for await (const run of client.beta.threads.runs.list(
130-
* 'thread_id',
131-
* )) {
132-
* // ...
133-
* }
134-
* ```
111+
* @deprecated The Assistants API is deprecated in favor of the Responses API
135112
*/
136113
list(
137114
threadID: string,
@@ -148,13 +125,7 @@ export class Runs extends APIResource {
148125
/**
149126
* Cancels a run that is `in_progress`.
150127
*
151-
* @example
152-
* ```ts
153-
* const run = await client.beta.threads.runs.cancel(
154-
* 'run_id',
155-
* { thread_id: 'thread_id' },
156-
* );
157-
* ```
128+
* @deprecated The Assistants API is deprecated in favor of the Responses API
158129
*/
159130
cancel(runID: string, params: RunCancelParams, options?: RequestOptions): APIPromise<Run> {
160131
const { thread_id } = params;
@@ -260,14 +231,7 @@ export class Runs extends APIResource {
260231
* tool calls once they're all completed. All outputs must be submitted in a single
261232
* request.
262233
*
263-
* @example
264-
* ```ts
265-
* const run =
266-
* await client.beta.threads.runs.submitToolOutputs(
267-
* 'run_id',
268-
* { thread_id: 'thread_id', tool_outputs: [{}] },
269-
* );
270-
* ```
234+
* @deprecated The Assistants API is deprecated in favor of the Responses API
271235
*/
272236
submitToolOutputs(
273237
runID: string,

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

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,14 @@ import { buildHeaders } from '../../../../internal/headers';
99
import { RequestOptions } from '../../../../internal/request-options';
1010
import { path } from '../../../../internal/utils/path';
1111

12+
/**
13+
* @deprecated The Assistants API is deprecated in favor of the Responses API
14+
*/
1215
export class Steps extends APIResource {
1316
/**
1417
* Retrieves a run step.
1518
*
16-
* @example
17-
* ```ts
18-
* const runStep =
19-
* await client.beta.threads.runs.steps.retrieve('step_id', {
20-
* thread_id: 'thread_id',
21-
* run_id: 'run_id',
22-
* });
23-
* ```
19+
* @deprecated The Assistants API is deprecated in favor of the Responses API
2420
*/
2521
retrieve(stepID: string, params: StepRetrieveParams, options?: RequestOptions): APIPromise<RunStep> {
2622
const { thread_id, run_id, ...query } = params;
@@ -34,16 +30,7 @@ export class Steps extends APIResource {
3430
/**
3531
* Returns a list of run steps belonging to a run.
3632
*
37-
* @example
38-
* ```ts
39-
* // Automatically fetches more pages as needed.
40-
* for await (const runStep of client.beta.threads.runs.steps.list(
41-
* 'run_id',
42-
* { thread_id: 'thread_id' },
43-
* )) {
44-
* // ...
45-
* }
46-
* ```
33+
* @deprecated The Assistants API is deprecated in favor of the Responses API
4734
*/
4835
list(runID: string, params: StepListParams, options?: RequestOptions): PagePromise<RunStepsPage, RunStep> {
4936
const { thread_id, ...query } = params;

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

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,17 @@ import { RequestOptions } from '../../../internal/request-options';
7272
import { AssistantStream, ThreadCreateAndRunParamsBaseStream } from '../../../lib/AssistantStream';
7373
import { path } from '../../../internal/utils/path';
7474

75+
/**
76+
* @deprecated The Assistants API is deprecated in favor of the Responses API
77+
*/
7578
export class Threads extends APIResource {
7679
runs: RunsAPI.Runs = new RunsAPI.Runs(this._client);
7780
messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
7881

7982
/**
8083
* Create a thread.
8184
*
82-
* @example
83-
* ```ts
84-
* const thread = await client.beta.threads.create();
85-
* ```
85+
* @deprecated The Assistants API is deprecated in favor of the Responses API
8686
*/
8787
create(body: ThreadCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise<Thread> {
8888
return this._client.post('/threads', {
@@ -95,12 +95,7 @@ export class Threads extends APIResource {
9595
/**
9696
* Retrieves a thread.
9797
*
98-
* @example
99-
* ```ts
100-
* const thread = await client.beta.threads.retrieve(
101-
* 'thread_id',
102-
* );
103-
* ```
98+
* @deprecated The Assistants API is deprecated in favor of the Responses API
10499
*/
105100
retrieve(threadID: string, options?: RequestOptions): APIPromise<Thread> {
106101
return this._client.get(path`/threads/${threadID}`, {
@@ -112,12 +107,7 @@ export class Threads extends APIResource {
112107
/**
113108
* Modifies a thread.
114109
*
115-
* @example
116-
* ```ts
117-
* const thread = await client.beta.threads.update(
118-
* 'thread_id',
119-
* );
120-
* ```
110+
* @deprecated The Assistants API is deprecated in favor of the Responses API
121111
*/
122112
update(threadID: string, body: ThreadUpdateParams, options?: RequestOptions): APIPromise<Thread> {
123113
return this._client.post(path`/threads/${threadID}`, {
@@ -130,12 +120,7 @@ export class Threads extends APIResource {
130120
/**
131121
* Delete a thread.
132122
*
133-
* @example
134-
* ```ts
135-
* const threadDeleted = await client.beta.threads.delete(
136-
* 'thread_id',
137-
* );
138-
* ```
123+
* @deprecated The Assistants API is deprecated in favor of the Responses API
139124
*/
140125
delete(threadID: string, options?: RequestOptions): APIPromise<ThreadDeleted> {
141126
return this._client.delete(path`/threads/${threadID}`, {
@@ -147,12 +132,7 @@ export class Threads extends APIResource {
147132
/**
148133
* Create a thread and run it in one request.
149134
*
150-
* @example
151-
* ```ts
152-
* const run = await client.beta.threads.createAndRun({
153-
* assistant_id: 'assistant_id',
154-
* });
155-
* ```
135+
* @deprecated The Assistants API is deprecated in favor of the Responses API
156136
*/
157137
createAndRun(body: ThreadCreateAndRunParamsNonStreaming, options?: RequestOptions): APIPromise<RunsAPI.Run>;
158138
createAndRun(

0 commit comments

Comments
 (0)