release: 4.17.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.16.2"
+  ".": "4.17.0"
 }

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 4.17.0 (2023-11-08)
+
+Full Changelog: [v4.16.2...v4.17.0](https://github.com/openai/openai-node/compare/v4.16.2...v4.17.0)
+
+### Features
+
+* **api:** unify function types ([#467](https://github.com/openai/openai-node/issues/467)) ([d51cd94](https://github.com/openai/openai-node/commit/d51cd94b3103219789447e2e9afc4762ae672e5a))
+
+
+### Refactors
+
+* **api:** rename FunctionObject to FunctionDefinition ([#470](https://github.com/openai/openai-node/issues/470)) ([f3990c7](https://github.com/openai/openai-node/commit/f3990c779e596309b62f41d7a1253d8629aca3bf))
+
 ## 4.16.2 (2023-11-08)
 
 Full Changelog: [v4.16.1...v4.16.2](https://github.com/openai/openai-node/compare/v4.16.1...v4.16.2)

README.md

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

api.md

@@ -1,3 +1,10 @@
+# Shared
+
+Types:
+
+- <code><a href="./src/resources/shared.ts">FunctionDefinition</a></code>
+- <code><a href="./src/resources/shared.ts">FunctionParameters</a></code>
+
 # Completions
 
 Types:

build-deno

@@ -15,7 +15,7 @@ This is a build produced from https://github.com/openai/openai-node – please g
 Usage:
 
 \`\`\`ts
-import OpenAI from "$(echo 'https://deno.land/x/openai@v4.16.1/mod.ts' | sed -E s/@\.+\\//@"$PACKAGE_VERSION"\\//)";
+import OpenAI from "$(echo 'https://deno.land/x/openai@v4.16.2/mod.ts' | sed -E s/@\.+\\//@"$PACKAGE_VERSION"\\//)";
 
 const client = new OpenAI();
 \`\`\`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai",
-  "version": "4.16.2",
+  "version": "4.17.0",
   "description": "Client library for the OpenAI API",
   "author": "OpenAI <support@openai.com>",
   "types": "dist/index.d.ts",

src/index.ts

@@ -296,6 +296,9 @@ export namespace OpenAI {
   export import FineTuneListEventsParamsStreaming = API.FineTuneListEventsParamsStreaming;
 
   export import Beta = API.Beta;
+
+  export import FunctionDefinition = API.FunctionDefinition;
+  export import FunctionParameters = API.FunctionParameters;
 }
 
 export default OpenAI;

src/resources/beta/assistants/assistants.ts

@@ -4,6 +4,7 @@ import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
 import { isRequestOptions } from 'openai/core';
 import * as AssistantsAPI from 'openai/resources/beta/assistants/assistants';
+import * as Shared from 'openai/resources/shared';
 import * as FilesAPI from 'openai/resources/beta/assistants/files';
 import { CursorPage, type CursorPageParams } from 'openai/pagination';
 
@@ -163,47 +164,13 @@ export namespace Assistant {
   }
 
   export interface Function {
-    /**
-     * The function definition.
-     */
-    function: Function.Function;
+    function: Shared.FunctionDefinition;
 
     /**
      * The type of tool being defined: `function`
      */
     type: 'function';
   }
-
-  export namespace Function {
-    /**
-     * The function definition.
-     */
-    export interface Function {
-      /**
-       * A description of what the function does, used by the model to choose when and
-       * how to call the function.
-       */
-      description: string;
-
-      /**
-       * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
-       * underscores and dashes, with a maximum length of 64.
-       */
-      name: string;
-
-      /**
-       * The parameters the functions accepts, described as a JSON Schema object. See the
-       * [guide](https://platform.openai.com/docs/guides/gpt/function-calling) for
-       * examples, and the
-       * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
-       * documentation about the format.
-       *
-       * To describe a function that accepts no parameters, provide the value
-       * `{"type": "object", "properties": {}}`.
-       */
-      parameters: Record<string, unknown>;
-    }
-  }
 }
 
 export interface AssistantDeleted {
@@ -282,47 +249,13 @@ export namespace AssistantCreateParams {
   }
 
   export interface AssistantToolsFunction {
-    /**
-     * The function definition.
-     */
-    function: AssistantToolsFunction.Function;
+    function: Shared.FunctionDefinition;
 
     /**
      * The type of tool being defined: `function`
      */
     type: 'function';
   }
-
-  export namespace AssistantToolsFunction {
-    /**
-     * The function definition.
-     */
-    export interface Function {
-      /**
-       * A description of what the function does, used by the model to choose when and
-       * how to call the function.
-       */
-      description: string;
-
-      /**
-       * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
-       * underscores and dashes, with a maximum length of 64.
-       */
-      name: string;
-
-      /**
-       * The parameters the functions accepts, described as a JSON Schema object. See the
-       * [guide](https://platform.openai.com/docs/guides/gpt/function-calling) for
-       * examples, and the
-       * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
-       * documentation about the format.
-       *
-       * To describe a function that accepts no parameters, provide the value
-       * `{"type": "object", "properties": {}}`.
-       */
-      parameters: Record<string, unknown>;
-    }
-  }
 }
 
 export interface AssistantUpdateParams {
@@ -395,47 +328,13 @@ export namespace AssistantUpdateParams {
   }
 
   export interface AssistantToolsFunction {
-    /**
-     * The function definition.
-     */
-    function: AssistantToolsFunction.Function;
+    function: Shared.FunctionDefinition;
 
     /**
      * The type of tool being defined: `function`
      */
     type: 'function';
   }
-
-  export namespace AssistantToolsFunction {
-    /**
-     * The function definition.
-     */
-    export interface Function {
-      /**
-       * A description of what the function does, used by the model to choose when and
-       * how to call the function.
-       */
-      description: string;
-
-      /**
-       * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
-       * underscores and dashes, with a maximum length of 64.
-       */
-      name: string;
-
-      /**
-       * The parameters the functions accepts, described as a JSON Schema object. See the
-       * [guide](https://platform.openai.com/docs/guides/gpt/function-calling) for
-       * examples, and the
-       * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
-       * documentation about the format.
-       *
-       * To describe a function that accepts no parameters, provide the value
-       * `{"type": "object", "properties": {}}`.
-       */
-      parameters: Record<string, unknown>;
-    }
-  }
 }
 
 export interface AssistantListParams extends CursorPageParams {

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

@@ -4,6 +4,7 @@ import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
 import { isRequestOptions } from 'openai/core';
 import * as RunsAPI from 'openai/resources/beta/threads/runs/runs';
+import * as Shared from 'openai/resources/shared';
 import * as StepsAPI from 'openai/resources/beta/threads/runs/steps';
 import { CursorPage, type CursorPageParams } from 'openai/pagination';
 
@@ -221,9 +222,9 @@ export interface Run {
   model: string;
 
   /**
-   * The object type, which is always `assistant.run`.
+   * The object type, which is always `thread.run`.
    */
-  object: 'assistant.run';
+  object: 'thread.run';
 
   /**
    * Details on the action required to continue the run. Will be `null` if no action
@@ -324,47 +325,13 @@ export namespace Run {
   }
 
   export interface AssistantToolsFunction {
-    /**
-     * The function definition.
-     */
-    function: AssistantToolsFunction.Function;
+    function: Shared.FunctionDefinition;
 
     /**
      * The type of tool being defined: `function`
      */
     type: 'function';
   }
-
-  export namespace AssistantToolsFunction {
-    /**
-     * The function definition.
-     */
-    export interface Function {
-      /**
-       * A description of what the function does, used by the model to choose when and
-       * how to call the function.
-       */
-      description: string;
-
-      /**
-       * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
-       * underscores and dashes, with a maximum length of 64.
-       */
-      name: string;
-
-      /**
-       * The parameters the functions accepts, described as a JSON Schema object. See the
-       * [guide](https://platform.openai.com/docs/guides/gpt/function-calling) for
-       * examples, and the
-       * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
-       * documentation about the format.
-       *
-       * To describe a function that accepts no parameters, provide the value
-       * `{"type": "object", "properties": {}}`.
-       */
-      parameters: Record<string, unknown>;
-    }
-  }
 }
 
 export interface RunCreateParams {
@@ -424,47 +391,13 @@ export namespace RunCreateParams {
   }
 
   export interface AssistantToolsFunction {
-    /**
-     * The function definition.
-     */
-    function: AssistantToolsFunction.Function;
+    function: Shared.FunctionDefinition;
 
     /**
      * The type of tool being defined: `function`
      */
     type: 'function';
   }
-
-  export namespace AssistantToolsFunction {
-    /**
-     * The function definition.
-     */
-    export interface Function {
-      /**
-       * A description of what the function does, used by the model to choose when and
-       * how to call the function.
-       */
-      description: string;
-
-      /**
-       * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
-       * underscores and dashes, with a maximum length of 64.
-       */
-      name: string;
-
-      /**
-       * The parameters the functions accepts, described as a JSON Schema object. See the
-       * [guide](https://platform.openai.com/docs/guides/gpt/function-calling) for
-       * examples, and the
-       * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
-       * documentation about the format.
-       *
-       * To describe a function that accepts no parameters, provide the value
-       * `{"type": "object", "properties": {}}`.
-       */
-      parameters: Record<string, unknown>;
-    }
-  }
 }
 
 export interface RunUpdateParams {

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

@@ -269,9 +269,9 @@ export interface RunStep {
   metadata: unknown | null;
 
   /**
-   * The object type, which is always `assistant.run.step``.
+   * The object type, which is always `thread.run.step``.
    */
-  object: 'assistant.run.step';
+  object: 'thread.run.step';
 
   /**
    * The ID of the [run](https://platform.openai.com/docs/api-reference/runs) that
@@ -280,8 +280,8 @@ export interface RunStep {
   run_id: string;
 
   /**
-   * The status of the run, which can be either `in_progress`, `cancelled`, `failed`,
-   * `completed`, or `expired`.
+   * The status of the run step, which can be either `in_progress`, `cancelled`,
+   * `failed`, `completed`, or `expired`.
    */
   status: 'in_progress' | 'cancelled' | 'failed' | 'completed' | 'expired';