feat(client): promote beta completions methods to GA

RobertCraigie · RobertCraigie · commit 4c622f9f5552 · 2025-05-29T17:25:23.000+01:00
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -315,7 +315,7 @@ The `openai/shims` imports have been removed. Your global types must now be [cor
 Previously, the following code would just output a warning to the console, now it will throw an error.
 
 ```ts
-const completion = await client.beta.chat.completions.parse({
+const completion = await client.chat.completions.parse({
   // ...
   response_format: zodResponseFormat(
     z.object({
@@ -329,7 +329,7 @@ const completion = await client.beta.chat.completions.parse({
 You must mark optional properties with `.nullable()` as purely optional fields are not supported by the [API](https://platform.openai.com/docs/guides/structured-outputs?api-mode=responses#all-fields-must-be-required).
 
 ```ts
-const completion = await client.beta.chat.completions.parse({
+const completion = await client.chat.completions.parse({
   // ...
   response_format: zodResponseFormat(
     z.object({
@@ -377,18 +377,44 @@ export type FineTuningJobsPage = CursorPage<FineTuningJob>;
 
 If you were importing these classes at runtime, you'll need to switch to importing the base class or only import them at the type-level.
 
+### Beta chat namespace removed
+
+The `beta.chat` namespace has been removed. All chat completion methods that were previously in beta have been moved to the main `chat.completions` namespace:
+
+```ts
+// Before
+client.beta.chat.completions.parse()
+client.beta.chat.completions.stream()
+client.beta.chat.completions.runTools()
+
+// After
+client.chat.completions.parse()
+client.chat.completions.stream()
+client.chat.completions.runTools()
+```
+
+Additionally, related types have been moved:
+
+```ts
+// Before
+import { ParsedChatCompletion, ParsedChoice, ParsedFunction } from 'openai/resources/beta/chat/completions';
+
+// After
+import { ParsedChatCompletion, ParsedChoice, ParsedFunction } from 'openai/resources/chat/completions';
+```
+
 ### Removed deprecated `.runFunctions` methods
 
-The deprecated `client.beta.chat.completions.runFunctions()` method and all of it's surrounding types have been removed, instead you should use
-`client.beta.chat.completions.runTools()`.
+The deprecated `client.chat.completions.runFunctions()` method and all of it's surrounding types have been removed, instead you should use
+`client.chat.completions.runTools()`.
 
 ### `.runTools()` event / method names
 
 To better align with the tool-based API, several event names in the ChatCompletionRunner have been renamed:
 
 ```ts
 // Before
-openai.beta.chat.completions
+openai.chat.completions
   .runTools({
     // ..
   })
@@ -398,7 +424,7 @@ openai.beta.chat.completions
   .on('finalFunctionCallResult', (result) => console.log('finalFunctionCallResult', result));
 
 // After
-openai.beta.chat.completions
+openai.chat.completions
   .runTools({
     // ..
   })
diff --git a/ecosystem-tests/node-ts-cjs-auto/tests/test.ts b/ecosystem-tests/node-ts-cjs-auto/tests/test.ts
@@ -76,7 +76,7 @@ it(`ChatCompletionStream works`, async function () {
   let finalMessage: OpenAI.Chat.ChatCompletionMessageParam | undefined;
   let finalChatCompletion: OpenAI.Chat.ChatCompletion | undefined;
 
-  const stream = client.beta.chat.completions
+  const stream = client.chat.completions
     .stream({
       model: 'gpt-4',
       messages: [{ role: 'user', content: 'Say this is a test' }],
@@ -120,7 +120,7 @@ it(`aborting ChatCompletionStream works`, async function () {
   let emittedError: any;
   let caughtError: any;
   const controller = new AbortController();
-  const stream = client.beta.chat.completions
+  const stream = client.chat.completions
     .stream(
       {
         model: 'gpt-4',
diff --git a/examples/logprobs.ts b/examples/logprobs.ts
@@ -6,7 +6,7 @@ import OpenAI from 'openai';
 const openai = new OpenAI();
 
 async function main() {
-  const stream = await openai.beta.chat.completions
+  const stream = await openai.chat.completions
     .stream({
       model: 'gpt-4',
       messages: [{ role: 'user', content: 'Say this is a test' }],
diff --git a/examples/parsing-run-tools.ts b/examples/parsing-run-tools.ts
@@ -28,7 +28,7 @@ const Condition = z.object({
 const openai = new OpenAI();
 
 async function main() {
-  const runner = openai.beta.chat.completions
+  const runner = openai.chat.completions
     .runTools({
       model: 'gpt-4o-2024-08-06',
       messages: [{ role: 'user', content: `What are the last 10 orders?` }],
diff --git a/examples/parsing-stream.ts b/examples/parsing-stream.ts
@@ -15,7 +15,7 @@ const MathResponse = z.object({
 async function main() {
   const client = new OpenAI();
 
-  const stream = client.beta.chat.completions
+  const stream = client.chat.completions
     .stream({
       model: 'gpt-4o-2024-08-06',
       messages: [
diff --git a/examples/parsing-tools-stream.ts b/examples/parsing-tools-stream.ts
@@ -12,7 +12,7 @@ async function main() {
   const client = new OpenAI();
   const refusal = process.argv.includes('refusal');
 
-  const stream = client.beta.chat.completions
+  const stream = client.chat.completions
     .stream({
       model: 'gpt-4o-2024-08-06',
       messages: [
diff --git a/examples/parsing-tools.ts b/examples/parsing-tools.ts
@@ -38,7 +38,7 @@ const Query = z.object({
 async function main() {
   const client = new OpenAI();
 
-  const completion = await client.beta.chat.completions.parse({
+  const completion = await client.chat.completions.parse({
     model: 'gpt-4o-2024-08-06',
     messages: [
       {
diff --git a/examples/parsing.ts b/examples/parsing.ts
@@ -15,7 +15,7 @@ const MathResponse = z.object({
 async function main() {
   const client = new OpenAI();
 
-  const completion = await client.beta.chat.completions.parse({
+  const completion = await client.chat.completions.parse({
     model: 'gpt-4o-2024-08-06',
     messages: [
       { role: 'system', content: 'You are a helpful math tutor.' },
diff --git a/examples/stream-to-client-express.ts b/examples/stream-to-client-express.ts
@@ -30,7 +30,7 @@ app.post('/', async (req: Request, res: Response) => {
   try {
     console.log('Received request:', req.body);
 
-    const stream = openai.beta.chat.completions.stream({
+    const stream = openai.chat.completions.stream({
       model: 'gpt-3.5-turbo',
       stream: true,
       messages: [{ role: 'user', content: req.body }],
diff --git a/examples/stream-to-client-next.ts b/examples/stream-to-client-next.ts
@@ -25,7 +25,7 @@ export const runtime = 'edge';
 export default async function handler(req: NextApiRequest, res: NextApiResponse) {
   const openai = new OpenAI();
 
-  const stream = openai.beta.chat.completions.stream({
+  const stream = openai.chat.completions.stream({
     model: 'gpt-3.5-turbo',
     stream: true,
     // @ts-ignore
diff --git a/examples/stream.ts b/examples/stream.ts
@@ -5,7 +5,7 @@ import OpenAI from 'openai';
 const openai = new OpenAI();
 
 async function main() {
-  const runner = openai.beta.chat.completions
+  const runner = openai.chat.completions
     .stream({
       model: 'gpt-3.5-turbo',
       messages: [{ role: 'user', content: 'Say this is a test' }],
diff --git a/examples/tool-call-helpers-zod.ts b/examples/tool-call-helpers-zod.ts
@@ -34,7 +34,7 @@ async function getBook({ id }: GetParams) {
 }
 
 async function main() {
-  const runner = openai.beta.chat.completions
+  const runner = openai.chat.completions
     .runTools({
       model: 'gpt-4-1106-preview',
       stream: true,
diff --git a/examples/tool-call-helpers.ts b/examples/tool-call-helpers.ts
@@ -63,7 +63,7 @@ const tools: RunnableToolFunction<any>[] = [
 ];
 
 async function main() {
-  const runner = await openai.beta.chat.completions
+  const runner = await openai.chat.completions
     .runTools({
       model: 'gpt-4-1106-preview',
       stream: true,
diff --git a/examples/ui-generation.ts b/examples/ui-generation.ts
@@ -31,7 +31,7 @@ const UISchema: z.ZodType<UI> = z.lazy(() =>
 );
 
 async function main() {
-  const completion = await openai.beta.chat.completions.parse({
+  const completion = await openai.chat.completions.parse({
     model: 'gpt-4o-2024-08-06',
     messages: [
       {
diff --git a/helpers.md b/helpers.md
@@ -2,7 +2,7 @@
 
 The OpenAI API supports extracting JSON from the model with the `response_format` request param, for more details on the API, see [this guide](https://platform.openai.com/docs/guides/structured-outputs).
 
-The SDK provides a `client.beta.chat.completions.parse()` method which is a wrapper over the `client.chat.completions.create()` that
+The SDK provides a `client.chat.completions.parse()` method which is a wrapper over the `client.chat.completions.create()` that
 provides richer integrations with TS specific types & returns a `ParsedChatCompletion` object, which is an extension of the standard `ChatCompletion` type.
 
 ## Auto-parsing response content with Zod schemas
@@ -27,7 +27,7 @@ const MathResponse = z.object({
 
 const client = new OpenAI();
 
-const completion = await client.beta.chat.completions.parse({
+const completion = await client.chat.completions.parse({
   model: 'gpt-4o-2024-08-06',
   messages: [
     { role: 'system', content: 'You are a helpful math tutor.' },
@@ -93,7 +93,7 @@ const Query = z.object({
 });
 
 const client = new OpenAI();
-const completion = await client.beta.chat.completions.parse({
+const completion = await client.chat.completions.parse({
   model: 'gpt-4o-2024-08-06',
   messages: [
     {
@@ -122,7 +122,7 @@ main();
 
 ### Differences from `.create()`
 
-The `beta.chat.completions.parse()` method imposes some additional restrictions on it's usage that `chat.completions.create()` does not.
+The `chat.completions.parse()` method imposes some additional restrictions on it's usage that `chat.completions.create()` does not.
 
 - If the completion completes with `finish_reason` set to `length` or `content_filter`, the `LengthFinishReasonError` / `ContentFilterFinishReasonError` errors will be raised.
 - Only strict function tools can be passed, e.g. `{type: 'function', function: {..., strict: true}}`
@@ -304,7 +304,7 @@ See an example of streaming helpers in action in [`examples/stream.ts`](examples
 
 ### Automated function calls
 
-We provide the `openai.beta.chat.completions.runTools({…})`
+We provide the `openai.chat.completions.runTools({…})`
 convenience helper for using function tool calls with the `/chat/completions` endpoint
 which automatically call the JavaScript functions you provide
 and sends their results back to the `/chat/completions` endpoint,
@@ -323,7 +323,7 @@ import OpenAI from 'openai';
 const client = new OpenAI();
 
 async function main() {
-  const runner = client.beta.chat.completions
+  const runner = client.chat.completions
     .runTools({
       model: 'gpt-4o',
       messages: [{ role: 'user', content: 'How is the weather this week?' }],
diff --git a/src/helpers/zod.ts b/src/helpers/zod.ts
@@ -32,7 +32,7 @@ function zodToJsonSchema(schema: ZodType, options: { name: string }): Record<str
  * the given Zod object.
  *
  * ```ts
- * const completion = await client.beta.chat.completions.parse({
+ * const completion = await client.chat.completions.parse({
  *    model: 'gpt-4o-2024-08-06',
  *    messages: [
  *      { role: 'system', content: 'You are a helpful math tutor.' },
diff --git a/src/lib/AbstractChatCompletionRunner.ts b/src/lib/AbstractChatCompletionRunner.ts
@@ -18,7 +18,7 @@ import type { ChatCompletionToolRunnerParams } from './ChatCompletionRunner';
 import type { ChatCompletionStreamingToolRunnerParams } from './ChatCompletionStreamingRunner';
 import { isAssistantMessage, isToolMessage } from './chatCompletionUtils';
 import { BaseEvents, EventStream } from './EventStream';
-import type { ParsedChatCompletion } from '../resources/beta/chat/completions';
+import type { ParsedChatCompletion } from '../resources/chat/completions';
 import type OpenAI from '../index';
 import { isAutoParsableTool, parseChatCompletion } from '../lib/parser';
 import type { RequestOptions } from '../internal/request-options';
diff --git a/src/lib/ChatCompletionStream.ts b/src/lib/ChatCompletionStream.ts
@@ -20,7 +20,7 @@ import {
 import { type ReadableStream } from '../internal/shim-types';
 import { Stream } from '../streaming';
 import OpenAI from '../index';
-import { ParsedChatCompletion } from '../resources/beta/chat/completions';
+import { ParsedChatCompletion } from '../resources/chat/completions';
 import {
   AutoParseableResponseFormat,
   hasAutoParseableInput,
diff --git a/src/lib/parser.ts b/src/lib/parser.ts
@@ -11,7 +11,7 @@ import {
   ParsedChatCompletion,
   ParsedChoice,
   ParsedFunctionToolCall,
-} from '../resources/beta/chat/completions';
+} from '../resources/chat/completions';
 import { ResponseFormatJSONSchema } from '../resources/shared';
 import { ContentFilterFinishReasonError, LengthFinishReasonError, OpenAIError } from '../error';
 import { type ResponseFormatTextJSONSchemaConfig } from '../resources/responses/responses';
diff --git a/src/resources/beta/beta.ts b/src/resources/beta/beta.ts
@@ -2,7 +2,6 @@
 
 import { APIResource } from '../../core/resource';
 import * as AssistantsAPI from './assistants';
-import * as ChatAPI from './chat/chat';
 import {
   Assistant,
   AssistantCreateParams,
@@ -91,11 +90,9 @@ import {
   ThreadUpdateParams,
   Threads,
 } from './threads/threads';
-import { Chat } from './chat/chat';
 
 export class Beta extends APIResource {
   realtime: RealtimeAPI.Realtime = new RealtimeAPI.Realtime(this._client);
-  chat: ChatAPI.Chat = new ChatAPI.Chat(this._client);
   assistants: AssistantsAPI.Assistants = new AssistantsAPI.Assistants(this._client);
   threads: ThreadsAPI.Threads = new ThreadsAPI.Threads(this._client);
 }
@@ -158,8 +155,6 @@ export declare namespace Beta {
     type TranscriptionSessionUpdatedEvent as TranscriptionSessionUpdatedEvent,
   };
 
-  export { Chat as Chat };
-
   export {
     Assistants as Assistants,
     type Assistant as Assistant,
diff --git a/src/resources/beta/chat/chat.ts b/src/resources/beta/chat/chat.ts
diff --git a/src/resources/beta/chat/completions.ts b/src/resources/beta/chat/completions.ts
diff --git a/src/resources/beta/chat/index.ts b/src/resources/beta/chat/index.ts
diff --git a/src/resources/beta/index.ts b/src/resources/beta/index.ts
diff --git a/src/resources/chat/completions/completions.ts b/src/resources/chat/completions/completions.ts
diff --git a/src/resources/chat/completions/index.ts b/src/resources/chat/completions/index.ts
diff --git a/tests/lib/ChatCompletionRunFunctions.test.ts b/tests/lib/ChatCompletionRunFunctions.test.ts
diff --git a/tests/lib/ChatCompletionStream.test.ts b/tests/lib/ChatCompletionStream.test.ts
diff --git a/tests/lib/parser.test.ts b/tests/lib/parser.test.ts

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ const Query = z.object({`
`38`	`38`	`async function main() {`
`39`	`39`	`const client = new OpenAI();`
`40`	`40`
`41`		`- const completion = await client.beta.chat.completions.parse({`
	`41`	`+ const completion = await client.chat.completions.parse({`
`42`	`42`	`model: 'gpt-4o-2024-08-06',`
`43`	`43`	`messages: [`
`44`	`44`	`{`