release: 4.36.0

.devcontainer/Dockerfile

@@ -7,6 +7,10 @@ RUN apt-get update && apt-get install -y \
   yarnpkg \
   && apt-get clean autoclean
 
+# Ensure UTF-8 encoding
+ENV LANG=C.UTF-8
+ENV LC_ALL=C.UTF-8
+
 # Yarn
 RUN ln -sf /usr/bin/yarnpkg /usr/bin/yarn
 

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.35.0"
+  ".": "4.36.0"
 }

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 4.36.0 (2024-04-16)
+
+Full Changelog: [v4.35.0...v4.36.0](https://github.com/openai/openai-node/compare/v4.35.0...v4.36.0)
+
+### Features
+
+* **client:** add header OpenAI-Project ([#772](https://github.com/openai/openai-node/issues/772)) ([bb4df37](https://github.com/openai/openai-node/commit/bb4df3722082fb44b7d4feb7a47df796149150a2))
+* extract chat models to a named enum ([#775](https://github.com/openai/openai-node/issues/775)) ([141d2ed](https://github.com/openai/openai-node/commit/141d2ed308141dc751869353208e4d0632d3650c))
+
+
+### Build System
+
+* configure UTF-8 locale in devcontainer ([#774](https://github.com/openai/openai-node/issues/774)) ([bebf4f0](https://github.com/openai/openai-node/commit/bebf4f0ca1f884f8747caff0f0e065aafffde096))
+
 ## 4.35.0 (2024-04-15)
 
 Full Changelog: [v4.34.0...v4.35.0](https://github.com/openai/openai-node/compare/v4.34.0...v4.35.0)

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.35.0/mod.ts';
+import OpenAI from 'https://deno.land/x/openai@v4.36.0/mod.ts';
 ```
 
 <!-- x-release-please-end -->

api.md

@@ -20,6 +20,10 @@ Methods:
 
 # Chat
 
+Types:
+
+- <code><a href="./src/resources/chat/chat.ts">ChatModel</a></code>
+
 ## Completions
 
 Types:

build-deno

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.35.0",
+  "version": "4.36.0",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <support@openai.com>",
   "types": "dist/index.d.ts",

src/index.ts

@@ -18,6 +18,11 @@ export interface ClientOptions {
    */
   organization?: string | null | undefined;
 
+  /**
+   * Defaults to process.env['OPENAI_PROJECT_ID'].
+   */
+  project?: string | null | undefined;
+
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
@@ -85,6 +90,7 @@ export interface ClientOptions {
 export class OpenAI extends Core.APIClient {
   apiKey: string;
   organization: string | null;
+  project: string | null;
 
   private _options: ClientOptions;
 
@@ -93,6 +99,7 @@ export class OpenAI extends Core.APIClient {
    *
    * @param {string | undefined} [opts.apiKey=process.env['OPENAI_API_KEY'] ?? undefined]
    * @param {string | null | undefined} [opts.organization=process.env['OPENAI_ORG_ID'] ?? null]
+   * @param {string | null | undefined} [opts.project=process.env['OPENAI_PROJECT_ID'] ?? null]
    * @param {string} [opts.baseURL=process.env['OPENAI_BASE_URL'] ?? https://api.openai.com/v1] - Override the default base URL for the API.
    * @param {number} [opts.timeout=10 minutes] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
@@ -106,6 +113,7 @@ export class OpenAI extends Core.APIClient {
     baseURL = Core.readEnv('OPENAI_BASE_URL'),
     apiKey = Core.readEnv('OPENAI_API_KEY'),
     organization = Core.readEnv('OPENAI_ORG_ID') ?? null,
+    project = Core.readEnv('OPENAI_PROJECT_ID') ?? null,
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
@@ -117,6 +125,7 @@ export class OpenAI extends Core.APIClient {
     const options: ClientOptions = {
       apiKey,
       organization,
+      project,
       ...opts,
       baseURL: baseURL || `https://api.openai.com/v1`,
     };
@@ -138,6 +147,7 @@ export class OpenAI extends Core.APIClient {
 
     this.apiKey = apiKey;
     this.organization = organization;
+    this.project = project;
   }
 
   completions: API.Completions = new API.Completions(this);
@@ -160,6 +170,7 @@ export class OpenAI extends Core.APIClient {
     return {
       ...super.defaultHeaders(opts),
       'OpenAI-Organization': this.organization,
+      'OpenAI-Project': this.project,
       ...this._options.defaultHeaders,
     };
   }
@@ -227,6 +238,7 @@ export namespace OpenAI {
   export import CompletionCreateParamsStreaming = API.CompletionCreateParamsStreaming;
 
   export import Chat = API.Chat;
+  export import ChatModel = API.ChatModel;
   export import ChatCompletion = API.ChatCompletion;
   export import ChatCompletionAssistantMessageParam = API.ChatCompletionAssistantMessageParam;
   export import ChatCompletionChunk = API.ChatCompletionChunk;

src/resources/chat/chat.ts

@@ -1,13 +1,36 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from 'openai/resource';
+import * as ChatAPI from 'openai/resources/chat/chat';
 import * as CompletionsAPI from 'openai/resources/chat/completions';
 
 export class Chat extends APIResource {
   completions: CompletionsAPI.Completions = new CompletionsAPI.Completions(this._client);
 }
 
+export type ChatModel =
+  | 'gpt-4-turbo'
+  | 'gpt-4-turbo-2024-04-09'
+  | 'gpt-4-0125-preview'
+  | 'gpt-4-turbo-preview'
+  | 'gpt-4-1106-preview'
+  | 'gpt-4-vision-preview'
+  | 'gpt-4'
+  | 'gpt-4-0314'
+  | 'gpt-4-0613'
+  | 'gpt-4-32k'
+  | 'gpt-4-32k-0314'
+  | 'gpt-4-32k-0613'
+  | 'gpt-3.5-turbo'
+  | 'gpt-3.5-turbo-16k'
+  | 'gpt-3.5-turbo-0301'
+  | 'gpt-3.5-turbo-0613'
+  | 'gpt-3.5-turbo-1106'
+  | 'gpt-3.5-turbo-0125'
+  | 'gpt-3.5-turbo-16k-0613';
+
 export namespace Chat {
+  export import ChatModel = ChatAPI.ChatModel;
   export import Completions = CompletionsAPI.Completions;
   export import ChatCompletion = CompletionsAPI.ChatCompletion;
   export import ChatCompletionAssistantMessageParam = CompletionsAPI.ChatCompletionAssistantMessageParam;

src/resources/chat/completions.ts

@@ -6,6 +6,7 @@ import { APIResource } from 'openai/resource';
 import * as ChatCompletionsAPI from 'openai/resources/chat/completions';
 import * as CompletionsAPI from 'openai/resources/completions';
 import * as Shared from 'openai/resources/shared';
+import * as ChatAPI from 'openai/resources/chat/chat';
 import { Stream } from 'openai/streaming';
 
 export class Completions extends APIResource {
@@ -665,27 +666,7 @@ export interface ChatCompletionCreateParamsBase {
    * [model endpoint compatibility](https://platform.openai.com/docs/models/model-endpoint-compatibility)
    * table for details on which models work with the Chat API.
    */
-  model:
-    | (string & {})
-    | 'gpt-4-turbo'
-    | 'gpt-4-turbo-2024-04-09'
-    | 'gpt-4-0125-preview'
-    | 'gpt-4-turbo-preview'
-    | 'gpt-4-1106-preview'
-    | 'gpt-4-vision-preview'
-    | 'gpt-4'
-    | 'gpt-4-0314'
-    | 'gpt-4-0613'
-    | 'gpt-4-32k'
-    | 'gpt-4-32k-0314'
-    | 'gpt-4-32k-0613'
-    | 'gpt-3.5-turbo'
-    | 'gpt-3.5-turbo-16k'
-    | 'gpt-3.5-turbo-0301'
-    | 'gpt-3.5-turbo-0613'
-    | 'gpt-3.5-turbo-1106'
-    | 'gpt-3.5-turbo-0125'
-    | 'gpt-3.5-turbo-16k-0613';
+  model: (string & {}) | ChatAPI.ChatModel;
 
   /**
    * Number between -2.0 and 2.0. Positive values penalize new tokens based on their

src/resources/chat/index.ts

@@ -1,6 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Chat } from './chat';
 export {
   ChatCompletion,
   ChatCompletionAssistantMessageParam,
@@ -30,3 +29,4 @@ export {
   CompletionCreateParamsStreaming,
   Completions,
 } from './completions';
+export { ChatModel, Chat } from './chat';

src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.35.0'; // x-release-please-version
+export const VERSION = '4.36.0'; // x-release-please-version