openai 4.16.2 → 4.17.0

package/src/resources/chat/completions.ts

@@ -5,6 +5,7 @@ import { APIPromise } from "../../core";
 import { APIResource } from "../../resource";
 import * as ChatCompletionsAPI from "./completions";
 import * as CompletionsAPI from "../completions";
+import * as Shared from "../shared";
 import { Stream } from "../../streaming";
 
 export class Completions extends APIResource {
@@ -180,7 +181,6 @@ export interface ChatCompletionChunk {
 
   /**
    * This fingerprint represents the backend configuration that the model runs with.
-   *
    * Can be used in conjunction with the `seed` request parameter to understand when
    * backend changes have been made that might impact determinism.
    */
@@ -486,7 +486,7 @@ export interface ChatCompletionSystemMessageParam {
 }
 
 export interface ChatCompletionTool {
-  function: ChatCompletionTool.Function;
+  function: Shared.FunctionDefinition;
 
   /**
    * The type of the tool. Currently, only `function` is supported.
@@ -494,34 +494,6 @@ export interface ChatCompletionTool {
   type: 'function';
 }
 
-export namespace ChatCompletionTool {
-  export interface Function {
-    /**
-     * 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>;
-
-    /**
-     * A description of what the function does, used by the model to choose when and
-     * how to call the function.
-     */
-    description?: string;
-  }
-}
-
 /**
  * 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
@@ -668,8 +640,18 @@ export interface ChatCompletionCreateParamsBase {
   presence_penalty?: number | null;
 
   /**
-   * An object specifying the format that the model must output. Used to enable JSON
-   * mode.
+   * An object specifying the format that the model must output.
+   *
+   * Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the
+   * message the model generates is valid JSON.
+   *
+   * **Important:** when using JSON mode, you **must** also instruct the model to
+   * produce JSON yourself via a system or user message. Without this, the model may
+   * generate an unending stream of whitespace until the generation reaches the token
+   * limit, resulting in increased latency and appearance of a "stuck" request. Also
+   * note that the message content may be partially cut off if
+   * `finish_reason="length"`, which indicates the generation exceeded `max_tokens`
+   * or the conversation exceeded the max context length.
    */
   response_format?: ChatCompletionCreateParams.ResponseFormat;
 
@@ -761,7 +743,7 @@ export namespace ChatCompletionCreateParams {
      * To describe a function that accepts no parameters, provide the value
      * `{"type": "object", "properties": {}}`.
      */
-    parameters: Record<string, unknown>;
+    parameters: Shared.FunctionParameters;
 
     /**
      * A description of what the function does, used by the model to choose when and
@@ -771,21 +753,21 @@ export namespace ChatCompletionCreateParams {
   }
 
   /**
-   * An object specifying the format that the model must output. Used to enable JSON
-   * mode.
+   * An object specifying the format that the model must output.
+   *
+   * Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the
+   * message the model generates is valid JSON.
+   *
+   * **Important:** when using JSON mode, you **must** also instruct the model to
+   * produce JSON yourself via a system or user message. Without this, the model may
+   * generate an unending stream of whitespace until the generation reaches the token
+   * limit, resulting in increased latency and appearance of a "stuck" request. Also
+   * note that the message content may be partially cut off if
+   * `finish_reason="length"`, which indicates the generation exceeded `max_tokens`
+   * or the conversation exceeded the max context length.
    */
   export interface ResponseFormat {
     /**
-     * Setting to `json_object` enables JSON mode. This guarantees that the message the
-     * model generates is valid JSON.
-     *
-     * Note that your system prompt must still instruct the model to produce JSON, and
-     * to help ensure you don't forget, the API will throw an error if the string
-     * `JSON` does not appear in your system message. Also note that the message
-     * content may be partial (i.e. cut off) if `finish_reason="length"`, which
-     * indicates the generation exceeded `max_tokens` or the conversation exceeded the
-     * max context length.
-     *
      * Must be one of `text` or `json_object`.
      */
     type?: 'text' | 'json_object';

package/src/resources/index.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless.
 
 export * from './chat/index';
+export * from './shared';
 export { Audio } from './audio/audio';
 export { Beta } from './beta/beta';
 export {

package/src/resources/shared.ts

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export interface FunctionDefinition {
+  /**
+   * 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: FunctionParameters;
+
+  /**
+   * A description of what the function does, used by the model to choose when and
+   * how to call the function.
+   */
+  description?: 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": {}}`.
+ */
+export type FunctionParameters = Record<string, unknown>;

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.16.2'; // x-release-please-version
+export const VERSION = '4.17.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.16.2";
+export declare const VERSION = "4.17.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.16.2'; // x-release-please-version
+exports.VERSION = '4.17.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.16.2'; // x-release-please-version
+export const VERSION = '4.17.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map