release: 4.39.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.38.5"
+  ".": "4.39.0"
 }

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 4.39.0 (2024-04-29)
+
+Full Changelog: [v4.38.5...v4.39.0](https://github.com/openai/openai-node/compare/v4.38.5...v4.39.0)
+
+### Features
+
+* **api:** add required tool_choice ([#803](https://github.com/openai/openai-node/issues/803)) ([99693e6](https://github.com/openai/openai-node/commit/99693e61debc67327a45dffb2c10c113341bffd6))
+
+
+### Chores
+
+* **internal:** add scripts/test and scripts/mock ([#801](https://github.com/openai/openai-node/issues/801)) ([6656105](https://github.com/openai/openai-node/commit/6656105fa1346a91d17e2b7a5e075f3091310c2f))
+
 ## 4.38.5 (2024-04-24)
 
 Full Changelog: [v4.38.4...v4.38.5](https://github.com/openai/openai-node/compare/v4.38.4...v4.38.5)

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

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

jest.config.ts

@@ -17,6 +17,7 @@ const config: JestConfigWithTsJest = {
     '<rootDir>/deno/',
     '<rootDir>/deno_tests/',
   ],
+  testPathIgnorePatterns: ['scripts'],
 };
 
 export default config;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.38.5",
+  "version": "4.39.0",
   "description": "The official TypeScript library for the OpenAI API",
   "author": "OpenAI <[email protected]>",
   "types": "dist/index.d.ts",
@@ -14,7 +14,7 @@
   ],
   "private": false,
   "scripts": {
-    "test": "bin/check-test-server && yarn jest",
+    "test": "./scripts/test",
     "build": "bash ./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",

scripts/mock

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+if [ -z "$1" ]; then
+  URL="$1"
+  shift
+else
+  URL="$(grep 'openapi_spec_url' .stats.yml | cut -d' ' -f2)"
+fi
+
+# Check if the URL is empty
+if [ -z "$URL" ]; then
+  echo "Error: No OpenAPI spec path/url provided or found in .stats.yml"
+  exit 1
+fi
+
+# Run prism mock on the given spec
+if [ "$1" == "--daemon" ]; then
+  npm exec prism mock "$URL" &> .prism.log &
+
+  # Wait for server to come online
+  while ! grep -q "✖  fatal\|Prism is listening" ".prism.log" ; do
+    echo -n "."
+    sleep 0.1
+  done
+
+  if grep -q "✖  fatal" ".prism.log"; then
+    cat .prism.log
+    exit 1
+  fi
+
+  echo
+else
+  npm exec prism mock "$URL"
+fi

scripts/test

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+function prism_is_running() {
+  curl --silent "http://localhost:4010" >/dev/null 2>&1
+}
+
+kill_server_on_port() {
+  pids=$(lsof -t -i tcp:"$1" || echo "")
+  if [ "$pids" != "" ]; then
+    kill "$pids"
+    echo "Stopped $pids."
+  fi
+}
+
+if ! prism_is_running; then
+  # When we exit this script, make sure to kill the background mock server process
+  trap 'kill_server_on_port 4010' EXIT
+
+  # Start the dev server
+  ./scripts/mock --daemon
+
+  # Sanity check and print a nice error message
+  if ! ./bin/check-test-server; then
+    exit
+  fi
+fi
+
+# Run tests
+./node_modules/.bin/jest

src/resources/beta/threads/runs/runs.ts

@@ -445,8 +445,9 @@ export interface Run {
   /**
    * Controls which (if any) tool is called by the model. `none` means the model will
    * not call any tools and instead generates a message. `auto` is the default value
-   * and means the model can pick between generating a message or calling a tool.
-   * Specifying a particular tool like `{"type": "file_search"}` or
+   * and means the model can pick between generating a message or calling one or more
+   * tools. `required` means the model must call one or more tools before responding
+   * to the user. Specifying a particular tool like `{"type": "file_search"}` or
    * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
    * call that tool.
    */
@@ -713,8 +714,9 @@ export interface RunCreateParamsBase {
   /**
    * Controls which (if any) tool is called by the model. `none` means the model will
    * not call any tools and instead generates a message. `auto` is the default value
-   * and means the model can pick between generating a message or calling a tool.
-   * Specifying a particular tool like `{"type": "file_search"}` or
+   * and means the model can pick between generating a message or calling one or more
+   * tools. `required` means the model must call one or more tools before responding
+   * to the user. Specifying a particular tool like `{"type": "file_search"}` or
    * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
    * call that tool.
    */
@@ -964,8 +966,9 @@ export interface RunCreateAndPollParams {
   /**
    * Controls which (if any) tool is called by the model. `none` means the model will
    * not call any tools and instead generates a message. `auto` is the default value
-   * and means the model can pick between generating a message or calling a tool.
-   * Specifying a particular tool like `{"type": "file_search"}` or
+   * and means the model can pick between generating a message or calling one or more
+   * tools. `required` means the model must call one or more tools before responding
+   * to the user. Specifying a particular tool like `{"type": "file_search"}` or
    * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
    * call that tool.
    */
@@ -1168,8 +1171,9 @@ export interface RunCreateAndStreamParams {
   /**
    * Controls which (if any) tool is called by the model. `none` means the model will
    * not call any tools and instead generates a message. `auto` is the default value
-   * and means the model can pick between generating a message or calling a tool.
-   * Specifying a particular tool like `{"type": "file_search"}` or
+   * and means the model can pick between generating a message or calling one or more
+   * tools. `required` means the model must call one or more tools before responding
+   * to the user. Specifying a particular tool like `{"type": "file_search"}` or
    * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
    * call that tool.
    */
@@ -1372,8 +1376,9 @@ export interface RunStreamParams {
   /**
    * Controls which (if any) tool is called by the model. `none` means the model will
    * not call any tools and instead generates a message. `auto` is the default value
-   * and means the model can pick between generating a message or calling a tool.
-   * Specifying a particular tool like `{"type": "file_search"}` or
+   * and means the model can pick between generating a message or calling one or more
+   * tools. `required` means the model must call one or more tools before responding
+   * to the user. Specifying a particular tool like `{"type": "file_search"}` or
    * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
    * call that tool.
    */

src/resources/beta/threads/threads.ts

@@ -169,12 +169,13 @@ export interface AssistantToolChoiceFunction {
 /**
  * Controls which (if any) tool is called by the model. `none` means the model will
  * not call any tools and instead generates a message. `auto` is the default value
- * and means the model can pick between generating a message or calling a tool.
- * Specifying a particular tool like `{"type": "file_search"}` or
+ * and means the model can pick between generating a message or calling one or more
+ * tools. `required` means the model must call one or more tools before responding
+ * to the user. Specifying a particular tool like `{"type": "file_search"}` or
  * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
  * call that tool.
  */
-export type AssistantToolChoiceOption = 'none' | 'auto' | AssistantToolChoice;
+export type AssistantToolChoiceOption = 'none' | 'auto' | 'required' | AssistantToolChoice;
 
 /**
  * Represents a thread that contains
@@ -551,8 +552,9 @@ export interface ThreadCreateAndRunParamsBase {
   /**
    * Controls which (if any) tool is called by the model. `none` means the model will
    * not call any tools and instead generates a message. `auto` is the default value
-   * and means the model can pick between generating a message or calling a tool.
-   * Specifying a particular tool like `{"type": "file_search"}` or
+   * and means the model can pick between generating a message or calling one or more
+   * tools. `required` means the model must call one or more tools before responding
+   * to the user. Specifying a particular tool like `{"type": "file_search"}` or
    * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
    * call that tool.
    */
@@ -900,8 +902,9 @@ export interface ThreadCreateAndRunPollParams {
   /**
    * Controls which (if any) tool is called by the model. `none` means the model will
    * not call any tools and instead generates a message. `auto` is the default value
-   * and means the model can pick between generating a message or calling a tool.
-   * Specifying a particular tool like `{"type": "file_search"}` or
+   * and means the model can pick between generating a message or calling one or more
+   * tools. `required` means the model must call one or more tools before responding
+   * to the user. Specifying a particular tool like `{"type": "file_search"}` or
    * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
    * call that tool.
    */
@@ -1228,8 +1231,9 @@ export interface ThreadCreateAndRunStreamParams {
   /**
    * Controls which (if any) tool is called by the model. `none` means the model will
    * not call any tools and instead generates a message. `auto` is the default value
-   * and means the model can pick between generating a message or calling a tool.
-   * Specifying a particular tool like `{"type": "file_search"}` or
+   * and means the model can pick between generating a message or calling one or more
+   * tools. `required` means the model must call one or more tools before responding
+   * to the user. Specifying a particular tool like `{"type": "file_search"}` or
    * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
    * call that tool.
    */

src/resources/chat/completions.ts

@@ -598,17 +598,17 @@ export interface ChatCompletionTool {
 }
 
 /**
- * Controls which (if any) function is called by the model. `none` means the model
- * will not call a function and instead generates a message. `auto` means the model
- * can pick between generating a message or calling a function. Specifying a
- * particular function via
+ * Controls which (if any) tool is called by the model. `none` means the model will
+ * not call any tool and instead generates a message. `auto` means the model can
+ * pick between generating a message or calling one or more tools. `required` means
+ * the model must call one or more tools. Specifying a particular tool via
  * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
- * call that function.
+ * call that tool.
  *
- * `none` is the default when no functions are present. `auto` is the default if
- * functions are present.
+ * `none` is the default when no tools are present. `auto` is the default if tools
+ * are present.
  */
-export type ChatCompletionToolChoiceOption = 'none' | 'auto' | ChatCompletionNamedToolChoice;
+export type ChatCompletionToolChoiceOption = 'none' | 'auto' | 'required' | ChatCompletionNamedToolChoice;
 
 export interface ChatCompletionToolMessageParam {
   /**
@@ -796,15 +796,15 @@ export interface ChatCompletionCreateParamsBase {
   temperature?: number | null;
 
   /**
-   * Controls which (if any) function is called by the model. `none` means the model
-   * will not call a function and instead generates a message. `auto` means the model
-   * can pick between generating a message or calling a function. Specifying a
-   * particular function via
+   * Controls which (if any) tool is called by the model. `none` means the model will
+   * not call any tool and instead generates a message. `auto` means the model can
+   * pick between generating a message or calling one or more tools. `required` means
+   * the model must call one or more tools. Specifying a particular tool via
    * `{"type": "function", "function": {"name": "my_function"}}` forces the model to
-   * call that function.
+   * call that tool.
    *
-   * `none` is the default when no functions are present. `auto` is the default if
-   * functions are present.
+   * `none` is the default when no tools are present. `auto` is the default if tools
+   * are present.
    */
   tool_choice?: ChatCompletionToolChoiceOption;
 

src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.38.5'; // x-release-please-version
+export const VERSION = '4.39.0'; // x-release-please-version