release: 4.63.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.62.1"
+  ".": "4.63.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 68
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-ff407aa10917e62f2b0c12d1ad2c4f1258ed083bd45753c70eaaf5b1cf8356ae.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-de1981b64ac229493473670d618500c6362c195f1057eb7de00bd1bc9184fbd5.yml

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 4.63.0 (2024-09-20)
+
+Full Changelog: [v4.62.1...v4.63.0](https://github.com/openai/openai-node/compare/v4.62.1...v4.63.0)
+
+### Features
+
+* **client:** send retry count header ([#1087](https://github.com/openai/openai-node/issues/1087)) ([7bcebc0](https://github.com/openai/openai-node/commit/7bcebc0e3965c2decd1dffb1e67f5197260ca89e))
+
+
+### Chores
+
+* **types:** improve type name for embedding models ([#1089](https://github.com/openai/openai-node/issues/1089)) ([d6966d9](https://github.com/openai/openai-node/commit/d6966d9872a14b7fbee85a7bb1fae697852b8ce0))
+
 ## 4.62.1 (2024-09-18)
 
 Full Changelog: [v4.62.0...v4.62.1](https://github.com/openai/openai-node/compare/v4.62.0...v4.62.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.62.1/mod.ts';
+import OpenAI from 'https://deno.land/x/openai@v4.63.0/mod.ts';
 ```
 
 <!-- x-release-please-end -->

api.md

@@ -64,6 +64,7 @@ Types:
 
 - <code><a href="./src/resources/embeddings.ts">CreateEmbeddingResponse</a></code>
 - <code><a href="./src/resources/embeddings.ts">Embedding</a></code>
+- <code><a href="./src/resources/embeddings.ts">EmbeddingModel</a></code>
 
 Methods:
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.62.1",
+  "version": "4.63.0",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",

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/openai@v4.62.1/mod.ts";
+import OpenAI from "https://deno.land/x/openai@v4.63.0/mod.ts";
 
 const client = new OpenAI();
 \`\`\`

src/core.ts

@@ -308,7 +308,10 @@ export abstract class APIClient {
     return null;
   }
 
-  buildRequest<Req>(options: FinalRequestOptions<Req>): { req: RequestInit; url: string; timeout: number } {
+  buildRequest<Req>(
+    options: FinalRequestOptions<Req>,
+    { retryCount = 0 }: { retryCount?: number } = {},
+  ): { req: RequestInit; url: string; timeout: number } {
     const { method, path, query, headers: headers = {} } = options;
 
     const body =
@@ -340,7 +343,7 @@ export abstract class APIClient {
       headers[this.idempotencyHeader] = options.idempotencyKey;
     }
 
-    const reqHeaders = this.buildHeaders({ options, headers, contentLength });
+    const reqHeaders = this.buildHeaders({ options, headers, contentLength, retryCount });
 
     const req: RequestInit = {
       method,
@@ -359,10 +362,12 @@ export abstract class APIClient {
     options,
     headers,
     contentLength,
+    retryCount,
   }: {
     options: FinalRequestOptions;
     headers: Record<string, string | null | undefined>;
     contentLength: string | null | undefined;
+    retryCount: number;
   }): Record<string, string> {
     const reqHeaders: Record<string, string> = {};
     if (contentLength) {
@@ -378,6 +383,8 @@ export abstract class APIClient {
       delete reqHeaders['content-type'];
     }
 
+    reqHeaders['x-stainless-retry-count'] = String(retryCount);
+
     this.validateHeaders(reqHeaders, headers);
 
     return reqHeaders;
@@ -429,13 +436,14 @@ export abstract class APIClient {
     retriesRemaining: number | null,
   ): Promise<APIResponseProps> {
     const options = await optionsInput;
+    const maxRetries = options.maxRetries ?? this.maxRetries;
     if (retriesRemaining == null) {
-      retriesRemaining = options.maxRetries ?? this.maxRetries;
+      retriesRemaining = maxRetries;
     }
 
     await this.prepareOptions(options);
 
-    const { req, url, timeout } = this.buildRequest(options);
+    const { req, url, timeout } = this.buildRequest(options, { retryCount: maxRetries - retriesRemaining });
 
     await this.prepareRequest(req, { url, options });
 

src/index.ts

@@ -276,6 +276,7 @@ export namespace OpenAI {
   export import Embeddings = API.Embeddings;
   export import CreateEmbeddingResponse = API.CreateEmbeddingResponse;
   export import Embedding = API.Embedding;
+  export import EmbeddingModel = API.EmbeddingModel;
   export import EmbeddingCreateParams = API.EmbeddingCreateParams;
 
   export import Files = API.Files;

src/resources/embeddings.ts

@@ -77,6 +77,8 @@ export interface Embedding {
   object: 'embedding';
 }
 
+export type EmbeddingModel = 'text-embedding-ada-002' | 'text-embedding-3-small' | 'text-embedding-3-large';
+
 export interface EmbeddingCreateParams {
   /**
    * Input text to embed, encoded as a string or array of tokens. To embed multiple
@@ -96,7 +98,7 @@ export interface EmbeddingCreateParams {
    * [Model overview](https://platform.openai.com/docs/models/overview) for
    * descriptions of them.
    */
-  model: (string & {}) | 'text-embedding-ada-002' | 'text-embedding-3-small' | 'text-embedding-3-large';
+  model: (string & {}) | EmbeddingModel;
 
   /**
    * The number of dimensions the resulting output embeddings should have. Only
@@ -121,5 +123,6 @@ export interface EmbeddingCreateParams {
 export namespace Embeddings {
   export import CreateEmbeddingResponse = EmbeddingsAPI.CreateEmbeddingResponse;
   export import Embedding = EmbeddingsAPI.Embedding;
+  export import EmbeddingModel = EmbeddingsAPI.EmbeddingModel;
   export import EmbeddingCreateParams = EmbeddingsAPI.EmbeddingCreateParams;
 }

src/resources/index.ts

@@ -22,7 +22,13 @@ export {
   CompletionCreateParamsStreaming,
   Completions,
 } from './completions';
-export { CreateEmbeddingResponse, Embedding, EmbeddingCreateParams, Embeddings } from './embeddings';
+export {
+  CreateEmbeddingResponse,
+  Embedding,
+  EmbeddingModel,
+  EmbeddingCreateParams,
+  Embeddings,
+} from './embeddings';
 export {
   FileContent,
   FileDeleted,

src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.62.1'; // x-release-please-version
+export const VERSION = '4.63.0'; // x-release-please-version

tests/index.test.ts

@@ -241,6 +241,31 @@ describe('retries', () => {
     expect(count).toEqual(3);
   });
 
+  test('retry count header', async () => {
+    let count = 0;
+    let capturedRequest: RequestInit | undefined;
+    const testFetch = async (url: RequestInfo, init: RequestInit = {}): Promise<Response> => {
+      count++;
+      if (count <= 2) {
+        return new Response(undefined, {
+          status: 429,
+          headers: {
+            'Retry-After': '0.1',
+          },
+        });
+      }
+      capturedRequest = init;
+      return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } });
+    };
+
+    const client = new OpenAI({ apiKey: 'My API Key', fetch: testFetch, maxRetries: 4 });
+
+    expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 });
+
+    expect((capturedRequest!.headers as Headers)['x-stainless-retry-count']).toEqual('2');
+    expect(count).toEqual(3);
+  });
+
   test('retry on 429 with retry-after', async () => {
     let count = 0;
     const testFetch = async (url: RequestInfo, { signal }: RequestInit = {}): Promise<Response> => {