release: 4.62.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.61.1"
+  ".": "4.62.0"
 }

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 4.62.0 (2024-09-17)
+
+Full Changelog: [v4.61.1...v4.62.0](https://github.com/openai/openai-node/compare/v4.61.1...v4.62.0)
+
+### Features
+
+* **client:** add ._request_id property to object responses ([#1078](https://github.com/openai/openai-node/issues/1078)) ([d5c2131](https://github.com/openai/openai-node/commit/d5c21314449091dd1c668c7358b25e041466f588))
+
+
+### Chores
+
+* **internal:** add ecosystem test for qs reproduction ([0199dd8](https://github.com/openai/openai-node/commit/0199dd85981497fac2b60f786acc00ea30683897))
+* **internal:** add query string encoder ([#1079](https://github.com/openai/openai-node/issues/1079)) ([f870682](https://github.com/openai/openai-node/commit/f870682d5c490182547c428b0b5c75da0e34d15a))
+* **internal:** fix some types ([#1082](https://github.com/openai/openai-node/issues/1082)) ([1ec41a7](https://github.com/openai/openai-node/commit/1ec41a7d768502a31abb33bf86b0539e5b4b6541))
+* **tests:** add query string tests to ecosystem tests ([36be724](https://github.com/openai/openai-node/commit/36be724384401bb697d8b07b0a1965be721cfa51))
+
 ## 4.61.1 (2024-09-16)
 
 Full Changelog: [v4.61.0...v4.61.1](https://github.com/openai/openai-node/compare/v4.61.0...v4.61.1)

README.md

@@ -19,7 +19,7 @@ You can import in Deno via:
 <!-- x-release-please-start-version -->
 
 ```ts
-import OpenAI from 'https://deno.land/x/openai@v4.61.1/mod.ts';
+import OpenAI from 'https://deno.land/x/openai@v4.62.0/mod.ts';
 ```
 
 <!-- x-release-please-end -->

ecosystem-tests/cli.ts

@@ -34,6 +34,14 @@ const projectRunners = {
     await installPackage();
     await run('node', ['test.js']);
   },
+  'nodenext-tsup': async () => {
+    await installPackage();
+    await run('npm', ['run', 'build']);
+
+    if (state.live) {
+      await run('npm', ['run', 'main']);
+    }
+  },
   'ts-browser-webpack': async () => {
     await installPackage();
 

ecosystem-tests/node-js/test.js

@@ -1,8 +1,35 @@
-const openaiKey = "a valid OpenAI key"
 const OpenAI = require('openai');
 
-console.log(OpenAI)
+const openai = new OpenAI();
 
-const openai = new OpenAI({
-	apiKey: openaiKey,
-});
+function assertEqual(actual, expected) {
+  if (actual === expected) {
+    return;
+  }
+
+  console.error('expected', expected);
+  console.error('actual  ', actual);
+  throw new Error('expected values to be equal');
+}
+
+async function main() {
+  const completion = await openai.chat.completions.create({
+    model: 'gpt-4',
+    messages: [{ role: 'user', content: 'Say this is a test' }],
+  });
+  if (!completion.choices[0].message.content) {
+    console.dir(completion, { depth: 4 });
+    throw new Error('no response content!');
+  }
+
+  assertEqual(
+    decodeURIComponent(openai.stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+    'foo[nested][a]=true&foo[nested][b]=foo',
+  );
+  assertEqual(
+    decodeURIComponent(openai.stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+    'foo[nested][a][]=hello&foo[nested][a][]=world',
+  );
+}
+
+main();

ecosystem-tests/node-ts-cjs-auto/tests/test.ts

@@ -257,3 +257,12 @@ describe('toFile', () => {
     expect(result.filename).toEqual('finetune.jsonl');
   });
 });
+
+test('query strings', () => {
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+  ).toEqual('foo[nested][a]=true&foo[nested][b]=foo');
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+  ).toEqual('foo[nested][a][]=hello&foo[nested][a][]=world');
+});

ecosystem-tests/node-ts-cjs-web/tests/test-jsdom.ts

@@ -164,3 +164,12 @@ describe.skip('toFile', () => {
     expect(result.filename).toEqual('finetune.jsonl');
   });
 });
+
+test('query strings', () => {
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+  ).toEqual('foo[nested][a]=true&foo[nested][b]=foo');
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+  ).toEqual('foo[nested][a][]=hello&foo[nested][a][]=world');
+});

ecosystem-tests/node-ts-cjs-web/tests/test-node.ts

@@ -151,3 +151,12 @@ describe('toFile', () => {
     expect(result.filename).toEqual('finetune.jsonl');
   });
 });
+
+test('query strings', () => {
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+  ).toEqual('foo[nested][a]=true&foo[nested][b]=foo');
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+  ).toEqual('foo[nested][a][]=hello&foo[nested][a][]=world');
+});

ecosystem-tests/node-ts-cjs/tests/test-jsdom.ts

@@ -144,3 +144,12 @@ describe.skip('toFile', () => {
     expect(result.filename).toEqual('finetune.jsonl');
   });
 });
+
+test('query strings', () => {
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+  ).toEqual('foo[nested][a]=true&foo[nested][b]=foo');
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+  ).toEqual('foo[nested][a][]=hello&foo[nested][a][]=world');
+});

ecosystem-tests/node-ts-cjs/tests/test-node.ts

@@ -192,3 +192,12 @@ describe('toFile', () => {
     expect(result.filename).toEqual('finetune.jsonl');
   });
 });
+
+test('query strings', () => {
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+  ).toEqual('foo[nested][a]=true&foo[nested][b]=foo');
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+  ).toEqual('foo[nested][a][]=hello&foo[nested][a][]=world');
+});

ecosystem-tests/node-ts-esm-auto/tests/test.ts

@@ -194,3 +194,12 @@ describe('toFile', () => {
     expect(result.filename).toEqual('finetune.jsonl');
   });
 });
+
+test('query strings', () => {
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+  ).toEqual('foo[nested][a]=true&foo[nested][b]=foo');
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+  ).toEqual('foo[nested][a][]=hello&foo[nested][a][]=world');
+});

ecosystem-tests/node-ts-esm-web/tests/test.ts

@@ -152,3 +152,12 @@ describe('toFile', () => {
     expect(result.filename).toEqual('finetune.jsonl');
   });
 });
+
+test('query strings', () => {
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+  ).toEqual('foo[nested][a]=true&foo[nested][b]=foo');
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+  ).toEqual('foo[nested][a][]=hello&foo[nested][a][]=world');
+});

ecosystem-tests/node-ts-esm/tests/test-esnext.ts

@@ -64,3 +64,12 @@ it(`raw response`, async function () {
   const json: ChatCompletion = JSON.parse(chunks.join(''));
   expect(json.choices[0]?.message.content || '').toBeSimilarTo('This is a test', 10);
 });
+
+test('query strings', () => {
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+  ).toEqual('foo[nested][a]=true&foo[nested][b]=foo');
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+  ).toEqual('foo[nested][a][]=hello&foo[nested][a][]=world');
+});

ecosystem-tests/node-ts-esm/tests/test.ts

@@ -173,3 +173,12 @@ describe('toFile', () => {
     expect(result.filename).toEqual('finetune.jsonl');
   });
 });
+
+test('query strings', () => {
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+  ).toEqual('foo[nested][a]=true&foo[nested][b]=foo');
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+  ).toEqual('foo[nested][a][]=hello&foo[nested][a][]=world');
+});

ecosystem-tests/node-ts4.5-jest27/tests/test.ts

@@ -192,3 +192,12 @@ describe('toFile', () => {
     expect(result.filename).toEqual('finetune.jsonl');
   });
 });
+
+test('query strings', () => {
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+  ).toEqual('foo[nested][a]=true&foo[nested][b]=foo');
+  expect(
+    decodeURIComponent((client as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+  ).toEqual('foo[nested][a][]=hello&foo[nested][a][]=world');
+});

ecosystem-tests/nodenext-tsup/index.ts

@@ -0,0 +1,41 @@
+import { OpenAI } from 'openai';
+
+const openai = new OpenAI();
+
+function assertEqual(actual: any, expected: any) {
+  if (actual === expected) {
+    return;
+  }
+
+  console.error('expected', expected);
+  console.error('actual  ', actual);
+  throw new Error('expected values to be equal');
+}
+
+async function main() {
+  const completion = await openai.chat.completions.create({
+    model: 'gpt-4o-mini',
+    messages: [
+      {
+        role: 'user',
+        content: 'What is the capital of the United States?',
+      },
+    ],
+  });
+  // smoke test for responses
+  if (!completion.choices[0]?.message.content) {
+    console.dir(completion, { depth: 4 });
+    throw new Error('no response content!');
+  }
+
+  assertEqual(
+    decodeURIComponent((openai as any).stringifyQuery({ foo: { nested: { a: true, b: 'foo' } } })),
+    'foo[nested][a]=true&foo[nested][b]=foo',
+  );
+  assertEqual(
+    decodeURIComponent((openai as any).stringifyQuery({ foo: { nested: { a: ['hello', 'world'] } } })),
+    'foo[nested][a][]=hello&foo[nested][a][]=world',
+  );
+}
+
+main();