openai 4.87.2 → 4.87.4

package/src/resources/responses/responses.ts

@@ -9,12 +9,13 @@ import {
 import * as Core from '../../core';
 import { APIPromise, isRequestOptions } from '../../core';
 import { APIResource } from '../../resource';
-import { Stream } from '../../streaming';
 import * as Shared from '../shared';
 import * as InputItemsAPI from './input-items';
-import { InputItemListParams, InputItems, ResponseItemList, ResponseItemListDataPage } from './input-items';
+import { InputItemListParams, InputItems, ResponseItemList } from './input-items';
 import * as ResponsesAPI from './responses';
 import { ResponseStream, ResponseStreamParams } from '../../lib/responses/ResponseStream';
+import { CursorPage } from '../../pagination';
+import { Stream } from '../../streaming';
 
 export interface ParsedResponseOutputText<ParsedT> extends ResponseOutputText {
   parsed: ParsedT | null;
@@ -36,7 +37,7 @@ export type ParsedResponseOutputItem<ParsedT> =
   | ResponseFileSearchToolCall
   | ResponseFunctionWebSearch
   | ResponseComputerToolCall
-  | ResponseOutputItem.Reasoning;
+  | ResponseReasoningItem;
 
 export interface ParsedResponse<ParsedT> extends Response {
   output: Array<ParsedResponseOutputItem<ParsedT>>;
@@ -137,6 +138,8 @@ export class Responses extends APIResource {
   }
 }
 
+export class ResponseItemsPage extends CursorPage<ResponseItem> {}
+
 /**
  * A tool that controls a virtual computer. Learn more about the
  * [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
@@ -966,6 +969,83 @@ export namespace ResponseComputerToolCall {
   }
 }
 
+export interface ResponseComputerToolCallOutputItem {
+  /**
+   * The unique ID of the computer call tool output.
+   */
+  id: string;
+
+  /**
+   * The ID of the computer tool call that produced the output.
+   */
+  call_id: string;
+
+  /**
+   * A computer screenshot image used with the computer use tool.
+   */
+  output: ResponseComputerToolCallOutputScreenshot;
+
+  /**
+   * The type of the computer tool call output. Always `computer_call_output`.
+   */
+  type: 'computer_call_output';
+
+  /**
+   * The safety checks reported by the API that have been acknowledged by the
+   * developer.
+   */
+  acknowledged_safety_checks?: Array<ResponseComputerToolCallOutputItem.AcknowledgedSafetyCheck>;
+
+  /**
+   * The status of the message input. One of `in_progress`, `completed`, or
+   * `incomplete`. Populated when input items are returned via API.
+   */
+  status?: 'in_progress' | 'completed' | 'incomplete';
+}
+
+export namespace ResponseComputerToolCallOutputItem {
+  /**
+   * A pending safety check for the computer call.
+   */
+  export interface AcknowledgedSafetyCheck {
+    /**
+     * The ID of the pending safety check.
+     */
+    id: string;
+
+    /**
+     * The type of the pending safety check.
+     */
+    code: string;
+
+    /**
+     * Details about the pending safety check.
+     */
+    message: string;
+  }
+}
+
+/**
+ * A computer screenshot image used with the computer use tool.
+ */
+export interface ResponseComputerToolCallOutputScreenshot {
+  /**
+   * Specifies the event type. For a computer screenshot, this property is always set
+   * to `computer_screenshot`.
+   */
+  type: 'computer_screenshot';
+
+  /**
+   * The identifier of an uploaded file that contains the screenshot.
+   */
+  file_id?: string;
+
+  /**
+   * The URL of the screenshot image.
+   */
+  image_url?: string;
+}
+
 /**
  * Multi-modal input and output contents.
  */
@@ -1362,11 +1442,6 @@ export interface ResponseFunctionCallArgumentsDoneEvent {
  * for more information.
  */
 export interface ResponseFunctionToolCall {
-  /**
-   * The unique ID of the function tool call.
-   */
-  id: string;
-
   /**
    * A JSON string of the arguments to pass to the function.
    */
@@ -1387,6 +1462,51 @@ export interface ResponseFunctionToolCall {
    */
   type: 'function_call';
 
+  /**
+   * The unique ID of the function tool call.
+   */
+  id?: string;
+
+  /**
+   * The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+   * Populated when items are returned via API.
+   */
+  status?: 'in_progress' | 'completed' | 'incomplete';
+}
+
+/**
+ * A tool call to run a function. See the
+ * [function calling guide](https://platform.openai.com/docs/guides/function-calling)
+ * for more information.
+ */
+export interface ResponseFunctionToolCallItem extends ResponseFunctionToolCall {
+  /**
+   * The unique ID of the function call tool output.
+   */
+  id: string;
+}
+
+export interface ResponseFunctionToolCallOutputItem {
+  /**
+   * The unique ID of the function call tool output.
+   */
+  id: string;
+
+  /**
+   * The unique ID of the function tool call generated by the model.
+   */
+  call_id: string;
+
+  /**
+   * A JSON string of the output of the function tool call.
+   */
+  output: string;
+
+  /**
+   * The type of the function tool call output. Always `function_call_output`.
+   */
+  type: 'function_call_output';
+
   /**
    * The status of the item. One of `in_progress`, `completed`, or `incomplete`.
    * Populated when items are returned via API.
@@ -1562,7 +1682,7 @@ export type ResponseInputItem =
   | ResponseFunctionWebSearch
   | ResponseFunctionToolCall
   | ResponseInputItem.FunctionCallOutput
-  | ResponseInputItem.Reasoning
+  | ResponseReasoningItem
   | ResponseInputItem.ItemReference;
 
 export namespace ResponseInputItem {
@@ -1607,7 +1727,7 @@ export namespace ResponseInputItem {
     /**
      * A computer screenshot image used with the computer use tool.
      */
-    output: ComputerCallOutput.Output;
+    output: ResponsesAPI.ResponseComputerToolCallOutputScreenshot;
 
     /**
      * The type of the computer tool call output. Always `computer_call_output`.
@@ -1633,27 +1753,6 @@ export namespace ResponseInputItem {
   }
 
   export namespace ComputerCallOutput {
-    /**
-     * A computer screenshot image used with the computer use tool.
-     */
-    export interface Output {
-      /**
-       * Specifies the event type. For a computer screenshot, this property is always set
-       * to `computer_screenshot`.
-       */
-      type: 'computer_screenshot';
-
-      /**
-       * The identifier of an uploaded file that contains the screenshot.
-       */
-      file_id?: string;
-
-      /**
-       * The URL of the screenshot image.
-       */
-      image_url?: string;
-    }
-
     /**
      * A pending safety check for the computer call.
      */
@@ -1707,47 +1806,6 @@ export namespace ResponseInputItem {
     status?: 'in_progress' | 'completed' | 'incomplete';
   }
 
-  /**
-   * A description of the chain of thought used by a reasoning model while generating
-   * a response.
-   */
-  export interface Reasoning {
-    /**
-     * The unique identifier of the reasoning content.
-     */
-    id: string;
-
-    /**
-     * Reasoning text contents.
-     */
-    content: Array<Reasoning.Content>;
-
-    /**
-     * The type of the object. Always `reasoning`.
-     */
-    type: 'reasoning';
-
-    /**
-     * The status of the item. One of `in_progress`, `completed`, or `incomplete`.
-     * Populated when items are returned via API.
-     */
-    status?: 'in_progress' | 'completed' | 'incomplete';
-  }
-
-  export namespace Reasoning {
-    export interface Content {
-      /**
-       * A short summary of the reasoning used by the model when generating the response.
-       */
-      text: string;
-
-      /**
-       * The type of the object. Always `text`.
-       */
-      type: 'reasoning_summary';
-    }
-  }
-
   /**
    * An internal identifier for an item to reference.
    */
@@ -1770,6 +1828,35 @@ export namespace ResponseInputItem {
  */
 export type ResponseInputMessageContentList = Array<ResponseInputContent>;
 
+export interface ResponseInputMessageItem {
+  /**
+   * The unique ID of the message input.
+   */
+  id: string;
+
+  /**
+   * A list of one or many input items to the model, containing different content
+   * types.
+   */
+  content: ResponseInputMessageContentList;
+
+  /**
+   * The role of the message input. One of `user`, `system`, or `developer`.
+   */
+  role: 'user' | 'system' | 'developer';
+
+  /**
+   * The status of item. One of `in_progress`, `completed`, or `incomplete`.
+   * Populated when items are returned via API.
+   */
+  status?: 'in_progress' | 'completed' | 'incomplete';
+
+  /**
+   * The type of the message input. Always set to `message`.
+   */
+  type?: 'message';
+}
+
 /**
  * A text input to the model.
  */
@@ -1785,6 +1872,19 @@ export interface ResponseInputText {
   type: 'input_text';
 }
 
+/**
+ * Content item used to generate a response.
+ */
+export type ResponseItem =
+  | ResponseInputMessageItem
+  | ResponseOutputMessage
+  | ResponseFileSearchToolCall
+  | ResponseComputerToolCall
+  | ResponseComputerToolCallOutputItem
+  | ResponseFunctionWebSearch
+  | ResponseFunctionToolCallItem
+  | ResponseFunctionToolCallOutputItem;
+
 /**
  * An audio output from the model.
  */
@@ -1814,50 +1914,7 @@ export type ResponseOutputItem =
   | ResponseFunctionToolCall
   | ResponseFunctionWebSearch
   | ResponseComputerToolCall
-  | ResponseOutputItem.Reasoning;
-
-export namespace ResponseOutputItem {
-  /**
-   * A description of the chain of thought used by a reasoning model while generating
-   * a response.
-   */
-  export interface Reasoning {
-    /**
-     * The unique identifier of the reasoning content.
-     */
-    id: string;
-
-    /**
-     * Reasoning text contents.
-     */
-    content: Array<Reasoning.Content>;
-
-    /**
-     * The type of the object. Always `reasoning`.
-     */
-    type: 'reasoning';
-
-    /**
-     * The status of the item. One of `in_progress`, `completed`, or `incomplete`.
-     * Populated when items are returned via API.
-     */
-    status?: 'in_progress' | 'completed' | 'incomplete';
-  }
-
-  export namespace Reasoning {
-    export interface Content {
-      /**
-       * A short summary of the reasoning used by the model when generating the response.
-       */
-      text: string;
-
-      /**
-       * The type of the object. Always `text`.
-       */
-      type: 'reasoning_summary';
-    }
-  }
-}
+  | ResponseReasoningItem;
 
 /**
  * Emitted when a new output item is added.
@@ -2039,6 +2096,47 @@ export namespace ResponseOutputText {
   }
 }
 
+/**
+ * A description of the chain of thought used by a reasoning model while generating
+ * a response.
+ */
+export interface ResponseReasoningItem {
+  /**
+   * The unique identifier of the reasoning content.
+   */
+  id: string;
+
+  /**
+   * Reasoning text contents.
+   */
+  summary: Array<ResponseReasoningItem.Summary>;
+
+  /**
+   * The type of the object. Always `reasoning`.
+   */
+  type: 'reasoning';
+
+  /**
+   * The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+   * Populated when items are returned via API.
+   */
+  status?: 'in_progress' | 'completed' | 'incomplete';
+}
+
+export namespace ResponseReasoningItem {
+  export interface Summary {
+    /**
+     * A short summary of the reasoning used by the model when generating the response.
+     */
+    text: string;
+
+    /**
+     * The type of the object. Always `summary_text`.
+     */
+    type: 'summary_text';
+  }
+}
+
 /**
  * Emitted when there is a partial refusal text.
  */
@@ -2348,6 +2446,11 @@ export interface ResponseUsage {
    */
   input_tokens: number;
 
+  /**
+   * A detailed breakdown of the input tokens.
+   */
+  input_tokens_details: ResponseUsage.InputTokensDetails;
+
   /**
    * The number of output tokens.
    */
@@ -2365,6 +2468,17 @@ export interface ResponseUsage {
 }
 
 export namespace ResponseUsage {
+  /**
+   * A detailed breakdown of the input tokens.
+   */
+  export interface InputTokensDetails {
+    /**
+     * The number of tokens that were retrieved from the cache.
+     * [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
+     */
+    cached_tokens: number;
+  }
+
   /**
    * A detailed breakdown of the output tokens.
    */
@@ -2749,13 +2863,11 @@ export interface ResponseRetrieveParams {
 }
 
 Responses.InputItems = InputItems;
-Responses.ResponseItemListDataPage = ResponseItemListDataPage;
 
 export declare namespace Responses {
   export {
     InputItems as InputItems,
     type ResponseItemList as ResponseItemList,
-    ResponseItemListDataPage as ResponseItemListDataPage,
     type InputItemListParams as InputItemListParams,
   };
 }

package/src/resources/shared.ts

@@ -171,10 +171,10 @@ export interface Reasoning {
    * supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
    * result in faster responses and fewer tokens used on reasoning in a response.
    */
-  effort: ReasoningEffort | null;
+  effort?: ReasoningEffort | null;
 
   /**
-   * **o-series models only**
+   * **computer_use_preview only**
    *
    * A summary of the reasoning performed by the model. This can be useful for
    * debugging and understanding the model's reasoning process. One of `concise` or

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.87.2'; // x-release-please-version
+export const VERSION = '4.87.4'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.87.2";
+export declare const VERSION = "4.87.4";
 //# 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.87.2'; // x-release-please-version
+exports.VERSION = '4.87.4'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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