release: 4.47.3

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.47.2"
+  ".": "4.47.3"
 }

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 4.47.3 (2024-05-31)
+
+Full Changelog: [v4.47.2...v4.47.3](https://github.com/openai/openai-node/compare/v4.47.2...v4.47.3)
+
+### Bug Fixes
+
+* allow git imports for pnpm ([#873](https://github.com/openai/openai-node/issues/873)) ([9da9809](https://github.com/openai/openai-node/commit/9da98090e80cbe988a3d695e4c9b57439080ec3e))
+
+
+### Documentation
+
+* **azure:** update example and readme to use Entra ID ([#857](https://github.com/openai/openai-node/issues/857)) ([722eff1](https://github.com/openai/openai-node/commit/722eff1a7aeaa2ce3c40301709db61258c9afa16))
+
 ## 4.47.2 (2024-05-28)
 
 Full Changelog: [v4.47.1...v4.47.2](https://github.com/openai/openai-node/compare/v4.47.1...v4.47.2)

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/[email protected].2/mod.ts';
+import OpenAI from 'https://deno.land/x/[email protected].3/mod.ts';
 ```
 
 <!-- x-release-please-end -->
@@ -367,11 +367,18 @@ To use this library with [Azure OpenAI](https://learn.microsoft.com/en-us/azure/
 class instead of the `OpenAI` class.
 
 > [!IMPORTANT]
-> The Azure API shape differs from the core API shape which means that the static types for responses / params
+> The Azure API shape slightly differs from the core API shape which means that the static types for responses / params
 > won't always be correct.
 
 ```ts
-const openai = new AzureOpenAI();
+import { AzureOpenAI } from 'openai';
+import { getBearerTokenProvider, DefaultAzureCredential } from '@azure/identity';
+
+const credential = new DefaultAzureCredential();
+const scope = 'https://cognitiveservices.azure.com/.default';
+const azureADTokenProvider = getBearerTokenProvider(credential, scope);
+
+const openai = new AzureOpenAI({ azureADTokenProvider });
 
 const result = await openai.chat.completions.create({
   model: 'gpt-4-1106-preview',

examples/azure.ts

@@ -1,14 +1,19 @@
 #!/usr/bin/env -S npm run tsn -T
 
 import { AzureOpenAI } from 'openai';
+import { getBearerTokenProvider, DefaultAzureCredential } from '@azure/identity';
 
 // Corresponds to your Model deployment within your OpenAI resource, e.g. gpt-4-1106-preview
 // Navigate to the Azure OpenAI Studio to deploy a model.
 const deployment = 'gpt-4-1106-preview';
 
-// Make sure to set both AZURE_OPENAI_ENDPOINT with the endpoint of your Azure resource and AZURE_OPENAI_API_KEY with the API key.
-// You can find both information in the Azure Portal.
-const openai = new AzureOpenAI();
+const credential = new DefaultAzureCredential();
+const scope = 'https://cognitiveservices.azure.com/.default';
+const azureADTokenProvider = getBearerTokenProvider(credential, scope);
+
+// Make sure to set AZURE_OPENAI_ENDPOINT with the endpoint of your Azure resource.
+// You can find it in the Azure Portal.
+const openai = new AzureOpenAI({ azureADTokenProvider });
 
 async function main() {
   console.log('Non-streaming:');

examples/package.json

@@ -9,7 +9,8 @@
     "express": "^4.18.2",
     "next": "^14.1.1",
     "openai": "file:..",
-    "zod-to-json-schema": "^3.21.4"
+    "zod-to-json-schema": "^3.21.4",
+    "@azure/identity": "^4.2.0"
   },
   "devDependencies": {
     "@types/body-parser": "^1.19.3",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.47.2",
+  "version": "4.47.3",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",
@@ -16,7 +16,6 @@
   "scripts": {
     "test": "./scripts/test",
     "build": "./scripts/build",
-    "prepack": "echo 'to pack, run yarn build && (cd dist; yarn pack)' && exit 1",
     "prepublishOnly": "echo 'to publish, run yarn build && (cd dist; yarn publish)' && exit 1",
     "format": "prettier --write --cache --cache-strategy metadata . !dist",
     "prepare": "if ./scripts/utils/check-is-in-git-install.sh; then ./scripts/build; fi",

scripts/build-deno

@@ -16,7 +16,7 @@ This is a build produced from https://github.com/openai/openai-node – please g
 Usage:
 
 \`\`\`ts
-import OpenAI from "https://deno.land/x/[email protected].2/mod.ts";
+import OpenAI from "https://deno.land/x/[email protected].3/mod.ts";
 
 const client = new OpenAI();
 \`\`\`

src/index.ts

@@ -492,7 +492,6 @@ const _deployments_endpoints = new Set([
   '/audio/translations',
   '/audio/speech',
   '/images/generations',
-  '/batches',
 ]);
 
 const API_KEY_SENTINEL = '<Missing Key>';

src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.47.2'; // x-release-please-version
+export const VERSION = '4.47.3'; // x-release-please-version

tests/lib/azure.test.ts

@@ -290,15 +290,15 @@ describe('azure request building', () => {
         fetch: testFetch,
       });
 
-      test('handles Batch', async () => {
+      test('handles batch', async () => {
         expect(
           await client.batches.create({
             completion_window: '24h',
             endpoint: '/v1/chat/completions',
             input_file_id: 'file-id',
           }),
         ).toStrictEqual({
-          url: `https://example.com/openai/deployments/${deployment}/batches?api-version=${apiVersion}`,
+          url: `https://example.com/openai/batches?api-version=${apiVersion}`,
         });
       });
 
@@ -423,7 +423,7 @@ describe('azure request building', () => {
         fetch: testFetch,
       });
 
-      test('Batch is not handled', async () => {
+      test('handles batch', async () => {
         expect(
           await client.batches.create({
             completion_window: '24h',