Skip to content

Commit be1ca6b

Browse files
feat(api): add support for storing chat completions (#1327)
1 parent 6e9444c commit be1ca6b

File tree

14 files changed

+534
-128
lines changed

14 files changed

+534
-128
lines changed

.stats.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
configured_endpoints: 69
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-dfb00c627f58e5180af7a9b29ed2f2aa0764a3b9daa6a32a1cc45bc8e48dfe15.yml
1+
configured_endpoints: 74
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-4aa6ee65ba9efc789e05e6a5ef0883b2cadf06def8efd863dbf75e9e233067e1.yml

api.md

+42-30
Original file line numberDiff line numberDiff line change
@@ -32,39 +32,51 @@ Types:
3232

3333
Types:
3434

35-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletion</a></code>
36-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionAssistantMessageParam</a></code>
37-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionAudio</a></code>
38-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionAudioParam</a></code>
39-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionChunk</a></code>
40-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionContentPart</a></code>
41-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionContentPartImage</a></code>
42-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionContentPartInputAudio</a></code>
43-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionContentPartRefusal</a></code>
44-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionContentPartText</a></code>
45-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionDeveloperMessageParam</a></code>
46-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionFunctionCallOption</a></code>
47-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionFunctionMessageParam</a></code>
48-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionMessage</a></code>
49-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionMessageParam</a></code>
50-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionMessageToolCall</a></code>
51-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionModality</a></code>
52-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionNamedToolChoice</a></code>
53-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionPredictionContent</a></code>
54-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionReasoningEffort</a></code>
55-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionRole</a></code>
56-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionStreamOptions</a></code>
57-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionSystemMessageParam</a></code>
58-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionTokenLogprob</a></code>
59-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionTool</a></code>
60-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionToolChoiceOption</a></code>
61-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionToolMessageParam</a></code>
62-
- <code><a href="./src/resources/chat/completions.ts">ChatCompletionUserMessageParam</a></code>
63-
- <code><a href="./src/resources/chat/completions.ts">CreateChatCompletionRequestMessage</a></code>
35+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletion</a></code>
36+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionAssistantMessageParam</a></code>
37+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionAudio</a></code>
38+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionAudioParam</a></code>
39+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionChunk</a></code>
40+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionContentPart</a></code>
41+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionContentPartImage</a></code>
42+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionContentPartInputAudio</a></code>
43+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionContentPartRefusal</a></code>
44+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionContentPartText</a></code>
45+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionDeleted</a></code>
46+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionDeveloperMessageParam</a></code>
47+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionFunctionCallOption</a></code>
48+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionFunctionMessageParam</a></code>
49+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionMessage</a></code>
50+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionMessageParam</a></code>
51+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionMessageToolCall</a></code>
52+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionModality</a></code>
53+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionNamedToolChoice</a></code>
54+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionPredictionContent</a></code>
55+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionReasoningEffort</a></code>
56+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionRole</a></code>
57+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionStoreMessage</a></code>
58+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionStreamOptions</a></code>
59+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionSystemMessageParam</a></code>
60+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionTokenLogprob</a></code>
61+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionTool</a></code>
62+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionToolChoiceOption</a></code>
63+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionToolMessageParam</a></code>
64+
- <code><a href="./src/resources/chat/completions/completions.ts">ChatCompletionUserMessageParam</a></code>
65+
- <code><a href="./src/resources/chat/completions/completions.ts">CreateChatCompletionRequestMessage</a></code>
6466

6567
Methods:
6668

67-
- <code title="post /chat/completions">client.chat.completions.<a href="./src/resources/chat/completions.ts">create</a>({ ...params }) -> ChatCompletion</code>
69+
- <code title="post /chat/completions">client.chat.completions.<a href="./src/resources/chat/completions/completions.ts">create</a>({ ...params }) -> ChatCompletion</code>
70+
- <code title="get /chat/completions/{completion_id}">client.chat.completions.<a href="./src/resources/chat/completions/completions.ts">retrieve</a>(completionId) -> ChatCompletion</code>
71+
- <code title="post /chat/completions/{completion_id}">client.chat.completions.<a href="./src/resources/chat/completions/completions.ts">update</a>(completionId, { ...params }) -> ChatCompletion</code>
72+
- <code title="get /chat/completions">client.chat.completions.<a href="./src/resources/chat/completions/completions.ts">list</a>({ ...params }) -> ChatCompletionsPage</code>
73+
- <code title="delete /chat/completions/{completion_id}">client.chat.completions.<a href="./src/resources/chat/completions/completions.ts">del</a>(completionId) -> ChatCompletionDeleted</code>
74+
75+
### Messages
76+
77+
Methods:
78+
79+
- <code title="get /chat/completions/{completion_id}/messages">client.chat.completions.messages.<a href="./src/resources/chat/completions/messages.ts">list</a>(completionId, { ...params }) -> ChatCompletionStoreMessagesPage</code>
6880

6981
# Embeddings
7082

src/index.ts

+19-8
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@ import {
6666
import { Audio, AudioModel, AudioResponseFormat } from './resources/audio/audio';
6767
import { Beta } from './resources/beta/beta';
6868
import { Chat, ChatModel } from './resources/chat/chat';
69+
import { FineTuning } from './resources/fine-tuning/fine-tuning';
70+
import {
71+
Upload,
72+
UploadCompleteParams,
73+
UploadCreateParams,
74+
Uploads as UploadsAPIUploads,
75+
} from './resources/uploads/uploads';
6976
import {
7077
ChatCompletion,
7178
ChatCompletionAssistantMessageParam,
@@ -80,9 +87,11 @@ import {
8087
ChatCompletionCreateParams,
8188
ChatCompletionCreateParamsNonStreaming,
8289
ChatCompletionCreateParamsStreaming,
90+
ChatCompletionDeleted,
8391
ChatCompletionDeveloperMessageParam,
8492
ChatCompletionFunctionCallOption,
8593
ChatCompletionFunctionMessageParam,
94+
ChatCompletionListParams,
8695
ChatCompletionMessage,
8796
ChatCompletionMessageParam,
8897
ChatCompletionMessageToolCall,
@@ -91,21 +100,17 @@ import {
91100
ChatCompletionPredictionContent,
92101
ChatCompletionReasoningEffort,
93102
ChatCompletionRole,
103+
ChatCompletionStoreMessage,
94104
ChatCompletionStreamOptions,
95105
ChatCompletionSystemMessageParam,
96106
ChatCompletionTokenLogprob,
97107
ChatCompletionTool,
98108
ChatCompletionToolChoiceOption,
99109
ChatCompletionToolMessageParam,
110+
ChatCompletionUpdateParams,
100111
ChatCompletionUserMessageParam,
101-
} from './resources/chat/completions';
102-
import { FineTuning } from './resources/fine-tuning/fine-tuning';
103-
import {
104-
Upload,
105-
UploadCompleteParams,
106-
UploadCreateParams,
107-
Uploads as UploadsAPIUploads,
108-
} from './resources/uploads/uploads';
112+
ChatCompletionsPage,
113+
} from './resources/chat/completions/completions';
109114

110115
export interface ClientOptions {
111116
/**
@@ -310,6 +315,7 @@ export class OpenAI extends Core.APIClient {
310315

311316
OpenAI.Completions = Completions;
312317
OpenAI.Chat = Chat;
318+
OpenAI.ChatCompletionsPage = ChatCompletionsPage;
313319
OpenAI.Embeddings = Embeddings;
314320
OpenAI.Files = Files;
315321
OpenAI.FileObjectsPage = FileObjectsPage;
@@ -355,6 +361,7 @@ export declare namespace OpenAI {
355361
type ChatCompletionContentPartInputAudio as ChatCompletionContentPartInputAudio,
356362
type ChatCompletionContentPartRefusal as ChatCompletionContentPartRefusal,
357363
type ChatCompletionContentPartText as ChatCompletionContentPartText,
364+
type ChatCompletionDeleted as ChatCompletionDeleted,
358365
type ChatCompletionDeveloperMessageParam as ChatCompletionDeveloperMessageParam,
359366
type ChatCompletionFunctionCallOption as ChatCompletionFunctionCallOption,
360367
type ChatCompletionFunctionMessageParam as ChatCompletionFunctionMessageParam,
@@ -366,16 +373,20 @@ export declare namespace OpenAI {
366373
type ChatCompletionPredictionContent as ChatCompletionPredictionContent,
367374
type ChatCompletionReasoningEffort as ChatCompletionReasoningEffort,
368375
type ChatCompletionRole as ChatCompletionRole,
376+
type ChatCompletionStoreMessage as ChatCompletionStoreMessage,
369377
type ChatCompletionStreamOptions as ChatCompletionStreamOptions,
370378
type ChatCompletionSystemMessageParam as ChatCompletionSystemMessageParam,
371379
type ChatCompletionTokenLogprob as ChatCompletionTokenLogprob,
372380
type ChatCompletionTool as ChatCompletionTool,
373381
type ChatCompletionToolChoiceOption as ChatCompletionToolChoiceOption,
374382
type ChatCompletionToolMessageParam as ChatCompletionToolMessageParam,
375383
type ChatCompletionUserMessageParam as ChatCompletionUserMessageParam,
384+
ChatCompletionsPage as ChatCompletionsPage,
376385
type ChatCompletionCreateParams as ChatCompletionCreateParams,
377386
type ChatCompletionCreateParamsNonStreaming as ChatCompletionCreateParamsNonStreaming,
378387
type ChatCompletionCreateParamsStreaming as ChatCompletionCreateParamsStreaming,
388+
type ChatCompletionUpdateParams as ChatCompletionUpdateParams,
389+
type ChatCompletionListParams as ChatCompletionListParams,
379390
};
380391

381392
export {

src/lib/ChatCompletionStream.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import {
1313
type ChatCompletionCreateParamsStreaming,
1414
type ChatCompletionCreateParamsBase,
1515
type ChatCompletionRole,
16-
} from '../resources/chat/completions';
16+
} from '../resources/chat/completions/completions';
1717
import {
1818
AbstractChatCompletionRunner,
1919
type AbstractChatCompletionRunnerEvents,

src/resources/chat/chat.ts

+17-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
import { APIResource } from '../../resource';
4-
import * as CompletionsAPI from './completions';
4+
import * as CompletionsAPI from './completions/completions';
55
import {
66
ChatCompletion,
77
ChatCompletionAssistantMessageParam,
@@ -16,9 +16,11 @@ import {
1616
ChatCompletionCreateParams,
1717
ChatCompletionCreateParamsNonStreaming,
1818
ChatCompletionCreateParamsStreaming,
19+
ChatCompletionDeleted,
1920
ChatCompletionDeveloperMessageParam,
2021
ChatCompletionFunctionCallOption,
2122
ChatCompletionFunctionMessageParam,
23+
ChatCompletionListParams,
2224
ChatCompletionMessage,
2325
ChatCompletionMessageParam,
2426
ChatCompletionMessageToolCall,
@@ -27,19 +29,24 @@ import {
2729
ChatCompletionPredictionContent,
2830
ChatCompletionReasoningEffort,
2931
ChatCompletionRole,
32+
ChatCompletionStoreMessage,
3033
ChatCompletionStreamOptions,
3134
ChatCompletionSystemMessageParam,
3235
ChatCompletionTokenLogprob,
3336
ChatCompletionTool,
3437
ChatCompletionToolChoiceOption,
3538
ChatCompletionToolMessageParam,
39+
ChatCompletionUpdateParams,
3640
ChatCompletionUserMessageParam,
41+
ChatCompletionsPage,
3742
CompletionCreateParams,
3843
CompletionCreateParamsNonStreaming,
3944
CompletionCreateParamsStreaming,
45+
CompletionListParams,
46+
CompletionUpdateParams,
4047
Completions,
4148
CreateChatCompletionRequestMessage,
42-
} from './completions';
49+
} from './completions/completions';
4350

4451
export class Chat extends APIResource {
4552
completions: CompletionsAPI.Completions = new CompletionsAPI.Completions(this._client);
@@ -87,6 +94,7 @@ export type ChatModel =
8794
| 'gpt-3.5-turbo-16k-0613';
8895

8996
Chat.Completions = Completions;
97+
Chat.ChatCompletionsPage = ChatCompletionsPage;
9098

9199
export declare namespace Chat {
92100
export { type ChatModel as ChatModel };
@@ -103,6 +111,7 @@ export declare namespace Chat {
103111
type ChatCompletionContentPartInputAudio as ChatCompletionContentPartInputAudio,
104112
type ChatCompletionContentPartRefusal as ChatCompletionContentPartRefusal,
105113
type ChatCompletionContentPartText as ChatCompletionContentPartText,
114+
type ChatCompletionDeleted as ChatCompletionDeleted,
106115
type ChatCompletionDeveloperMessageParam as ChatCompletionDeveloperMessageParam,
107116
type ChatCompletionFunctionCallOption as ChatCompletionFunctionCallOption,
108117
type ChatCompletionFunctionMessageParam as ChatCompletionFunctionMessageParam,
@@ -114,6 +123,7 @@ export declare namespace Chat {
114123
type ChatCompletionPredictionContent as ChatCompletionPredictionContent,
115124
type ChatCompletionReasoningEffort as ChatCompletionReasoningEffort,
116125
type ChatCompletionRole as ChatCompletionRole,
126+
type ChatCompletionStoreMessage as ChatCompletionStoreMessage,
117127
type ChatCompletionStreamOptions as ChatCompletionStreamOptions,
118128
type ChatCompletionSystemMessageParam as ChatCompletionSystemMessageParam,
119129
type ChatCompletionTokenLogprob as ChatCompletionTokenLogprob,
@@ -122,11 +132,16 @@ export declare namespace Chat {
122132
type ChatCompletionToolMessageParam as ChatCompletionToolMessageParam,
123133
type ChatCompletionUserMessageParam as ChatCompletionUserMessageParam,
124134
type CreateChatCompletionRequestMessage as CreateChatCompletionRequestMessage,
135+
ChatCompletionsPage as ChatCompletionsPage,
125136
type ChatCompletionCreateParams as ChatCompletionCreateParams,
126137
type CompletionCreateParams as CompletionCreateParams,
127138
type ChatCompletionCreateParamsNonStreaming as ChatCompletionCreateParamsNonStreaming,
128139
type CompletionCreateParamsNonStreaming as CompletionCreateParamsNonStreaming,
129140
type ChatCompletionCreateParamsStreaming as ChatCompletionCreateParamsStreaming,
130141
type CompletionCreateParamsStreaming as CompletionCreateParamsStreaming,
142+
type ChatCompletionUpdateParams as ChatCompletionUpdateParams,
143+
type CompletionUpdateParams as CompletionUpdateParams,
144+
type ChatCompletionListParams as ChatCompletionListParams,
145+
type CompletionListParams as CompletionListParams,
131146
};
132147
}

0 commit comments

Comments
 (0)