openai 0.33.0 → 0.34.0

data/rbi/openai/models/responses/response_computer_tool_call.rbi

@@ -173,8 +173,7 @@ module OpenAI
             end
             attr_accessor :button
 
-            # Specifies the event type. For a click action, this property is always set to
-            # `click`.
+            # Specifies the event type. For a click action, this property is always `click`.
             sig { returns(Symbol) }
             attr_accessor :type
 
@@ -204,8 +203,7 @@ module OpenAI
               x:,
               # The y-coordinate where the click occurred.
               y_:,
-              # Specifies the event type. For a click action, this property is always set to
-              # `click`.
+              # Specifies the event type. For a click action, this property is always `click`.
               type: :click
             )
             end
@@ -410,7 +408,7 @@ module OpenAI
               sig { returns(Integer) }
               attr_accessor :y_
 
-              # A series of x/y coordinate pairs in the drag path.
+              # An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`.
               sig { params(x: Integer, y_: Integer).returns(T.attached_class) }
               def self.new(
                 # The x-coordinate.
@@ -695,31 +693,39 @@ module OpenAI
           attr_accessor :id
 
           # The type of the pending safety check.
-          sig { returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :code
 
           # Details about the pending safety check.
-          sig { returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :message
 
           # A pending safety check for the computer call.
           sig do
-            params(id: String, code: String, message: String).returns(
-              T.attached_class
-            )
+            params(
+              id: String,
+              code: T.nilable(String),
+              message: T.nilable(String)
+            ).returns(T.attached_class)
           end
           def self.new(
             # The ID of the pending safety check.
             id:,
             # The type of the pending safety check.
-            code:,
+            code: nil,
             # Details about the pending safety check.
-            message:
+            message: nil
           )
           end
 
           sig do
-            override.returns({ id: String, code: String, message: String })
+            override.returns(
+              {
+                id: String,
+                code: T.nilable(String),
+                message: T.nilable(String)
+              }
+            )
           end
           def to_hash
           end

data/rbi/openai/models/responses/response_computer_tool_call_output_item.rbi

@@ -147,31 +147,39 @@ module OpenAI
           attr_accessor :id
 
           # The type of the pending safety check.
-          sig { returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :code
 
           # Details about the pending safety check.
-          sig { returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :message
 
           # A pending safety check for the computer call.
           sig do
-            params(id: String, code: String, message: String).returns(
-              T.attached_class
-            )
+            params(
+              id: String,
+              code: T.nilable(String),
+              message: T.nilable(String)
+            ).returns(T.attached_class)
           end
           def self.new(
             # The ID of the pending safety check.
             id:,
             # The type of the pending safety check.
-            code:,
+            code: nil,
             # Details about the pending safety check.
-            message:
+            message: nil
           )
           end
 
           sig do
-            override.returns({ id: String, code: String, message: String })
+            override.returns(
+              {
+                id: String,
+                code: T.nilable(String),
+                message: T.nilable(String)
+              }
+            )
           end
           def to_hash
           end

data/rbi/openai/models/responses/response_includable.rbi

@@ -28,19 +28,19 @@ module OpenAI
           T.type_alias { T.all(Symbol, OpenAI::Responses::ResponseIncludable) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        CODE_INTERPRETER_CALL_OUTPUTS =
+        FILE_SEARCH_CALL_RESULTS =
           T.let(
-            :"code_interpreter_call.outputs",
+            :"file_search_call.results",
             OpenAI::Responses::ResponseIncludable::TaggedSymbol
           )
-        COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL =
+        WEB_SEARCH_CALL_RESULTS =
           T.let(
-            :"computer_call_output.output.image_url",
+            :"web_search_call.results",
             OpenAI::Responses::ResponseIncludable::TaggedSymbol
           )
-        FILE_SEARCH_CALL_RESULTS =
+        WEB_SEARCH_CALL_ACTION_SOURCES =
           T.let(
-            :"file_search_call.results",
+            :"web_search_call.action.sources",
             OpenAI::Responses::ResponseIncludable::TaggedSymbol
           )
         MESSAGE_INPUT_IMAGE_IMAGE_URL =
@@ -48,9 +48,14 @@ module OpenAI
             :"message.input_image.image_url",
             OpenAI::Responses::ResponseIncludable::TaggedSymbol
           )
-        MESSAGE_OUTPUT_TEXT_LOGPROBS =
+        COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL =
           T.let(
-            :"message.output_text.logprobs",
+            :"computer_call_output.output.image_url",
+            OpenAI::Responses::ResponseIncludable::TaggedSymbol
+          )
+        CODE_INTERPRETER_CALL_OUTPUTS =
+          T.let(
+            :"code_interpreter_call.outputs",
             OpenAI::Responses::ResponseIncludable::TaggedSymbol
           )
         REASONING_ENCRYPTED_CONTENT =
@@ -58,6 +63,11 @@ module OpenAI
             :"reasoning.encrypted_content",
             OpenAI::Responses::ResponseIncludable::TaggedSymbol
           )
+        MESSAGE_OUTPUT_TEXT_LOGPROBS =
+          T.let(
+            :"message.output_text.logprobs",
+            OpenAI::Responses::ResponseIncludable::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/openai/models/responses/tool.rbi

@@ -1335,7 +1335,6 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
-          # A tool that allows the model to execute shell commands in a local environment.
           sig { params(type: Symbol).returns(T.attached_class) }
           def self.new(
             # The type of the local shell tool. Always `local_shell`.

data/rbi/openai/resources/responses/input_tokens.rbi

@@ -0,0 +1,120 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Responses
+      class InputTokens
+        # Get input token counts
+        sig do
+          params(
+            conversation:
+              T.nilable(
+                T.any(
+                  String,
+                  OpenAI::Responses::ResponseConversationParam::OrHash
+                )
+              ),
+            input:
+              T.nilable(
+                OpenAI::Responses::InputTokenCountParams::Input::Variants
+              ),
+            instructions: T.nilable(String),
+            model: T.nilable(String),
+            parallel_tool_calls: T.nilable(T::Boolean),
+            previous_response_id: T.nilable(String),
+            reasoning: T.nilable(OpenAI::Reasoning::OrHash),
+            text:
+              T.nilable(OpenAI::Responses::InputTokenCountParams::Text::OrHash),
+            tool_choice:
+              T.nilable(
+                T.any(
+                  OpenAI::Responses::ToolChoiceOptions::OrSymbol,
+                  OpenAI::Responses::ToolChoiceAllowed::OrHash,
+                  OpenAI::Responses::ToolChoiceTypes::OrHash,
+                  OpenAI::Responses::ToolChoiceFunction::OrHash,
+                  OpenAI::Responses::ToolChoiceMcp::OrHash,
+                  OpenAI::Responses::ToolChoiceCustom::OrHash
+                )
+              ),
+            tools:
+              T.nilable(
+                T::Array[
+                  T.any(
+                    OpenAI::Responses::FunctionTool::OrHash,
+                    OpenAI::Responses::FileSearchTool::OrHash,
+                    OpenAI::Responses::ComputerTool::OrHash,
+                    OpenAI::Responses::Tool::Mcp::OrHash,
+                    OpenAI::Responses::Tool::CodeInterpreter::OrHash,
+                    OpenAI::Responses::Tool::ImageGeneration::OrHash,
+                    OpenAI::Responses::Tool::LocalShell::OrHash,
+                    OpenAI::Responses::CustomTool::OrHash,
+                    OpenAI::Responses::WebSearchTool::OrHash,
+                    OpenAI::Responses::WebSearchPreviewTool::OrHash
+                  )
+                ]
+              ),
+            truncation:
+              OpenAI::Responses::InputTokenCountParams::Truncation::OrSymbol,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(OpenAI::Models::Responses::InputTokenCountResponse)
+        end
+        def count(
+          # The conversation that this response belongs to. Items from this conversation are
+          # prepended to `input_items` for this response request. Input items and output
+          # items from this response are automatically added to this conversation after this
+          # response completes.
+          conversation: nil,
+          # Text, image, or file inputs to the model, used to generate a response
+          input: nil,
+          # A system (or developer) message inserted into the model's context. When used
+          # along with `previous_response_id`, the instructions from a previous response
+          # will not be carried over to the next response. This makes it simple to swap out
+          # system (or developer) messages in new responses.
+          instructions: nil,
+          # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
+          # wide range of models with different capabilities, performance characteristics,
+          # and price points. Refer to the
+          # [model guide](https://platform.openai.com/docs/models) to browse and compare
+          # available models.
+          model: nil,
+          # Whether to allow the model to run tool calls in parallel.
+          parallel_tool_calls: nil,
+          # The unique ID of the previous response to the model. Use this to create
+          # multi-turn conversations. Learn more about
+          # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
+          # Cannot be used in conjunction with `conversation`.
+          previous_response_id: nil,
+          # **gpt-5 and o-series models only** Configuration options for
+          # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+          reasoning: nil,
+          # Configuration options for a text response from the model. Can be plain text or
+          # structured JSON data. Learn more:
+          #
+          # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+          # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+          text: nil,
+          # How the model should select which tool (or tools) to use when generating a
+          # response. See the `tools` parameter to see how to specify which tools the model
+          # can call.
+          tool_choice: nil,
+          # An array of tools the model may call while generating a response. You can
+          # specify which tool to use by setting the `tool_choice` parameter.
+          tools: nil,
+          # The truncation strategy to use for the model response. - `auto`: If the input to
+          # this Response exceeds the model's context window size, the model will truncate
+          # the response to fit the context window by dropping items from the beginning of
+          # the conversation. - `disabled` (default): If the input size will exceed the
+          # context window size for a model, the request will fail with a 400 error.
+          truncation: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/responses.rbi

@@ -6,6 +6,9 @@ module OpenAI
       sig { returns(OpenAI::Resources::Responses::InputItems) }
       attr_reader :input_items
 
+      sig { returns(OpenAI::Resources::Responses::InputTokens) }
+      attr_reader :input_tokens
+
       # See {OpenAI::Resources::Responses#stream_raw} for streaming counterpart.
       #
       # Creates a model response. Provide

data/sig/openai/models/responses/input_token_count_params.rbs

@@ -0,0 +1,165 @@
+module OpenAI
+  module Models
+    module Responses
+      type input_token_count_params =
+        {
+          conversation: OpenAI::Models::Responses::InputTokenCountParams::conversation?,
+          input: OpenAI::Models::Responses::InputTokenCountParams::input?,
+          instructions: String?,
+          model: String?,
+          parallel_tool_calls: bool?,
+          previous_response_id: String?,
+          reasoning: OpenAI::Reasoning?,
+          text: OpenAI::Responses::InputTokenCountParams::Text?,
+          tool_choice: OpenAI::Models::Responses::InputTokenCountParams::tool_choice?,
+          tools: ::Array[OpenAI::Models::Responses::tool]?,
+          truncation: OpenAI::Models::Responses::InputTokenCountParams::truncation
+        }
+        & OpenAI::Internal::Type::request_parameters
+
+      class InputTokenCountParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor conversation: OpenAI::Models::Responses::InputTokenCountParams::conversation?
+
+        attr_accessor input: OpenAI::Models::Responses::InputTokenCountParams::input?
+
+        attr_accessor instructions: String?
+
+        attr_accessor model: String?
+
+        attr_accessor parallel_tool_calls: bool?
+
+        attr_accessor previous_response_id: String?
+
+        attr_accessor reasoning: OpenAI::Reasoning?
+
+        attr_accessor text: OpenAI::Responses::InputTokenCountParams::Text?
+
+        attr_accessor tool_choice: OpenAI::Models::Responses::InputTokenCountParams::tool_choice?
+
+        attr_accessor tools: ::Array[OpenAI::Models::Responses::tool]?
+
+        attr_reader truncation: OpenAI::Models::Responses::InputTokenCountParams::truncation?
+
+        def truncation=: (
+          OpenAI::Models::Responses::InputTokenCountParams::truncation
+        ) -> OpenAI::Models::Responses::InputTokenCountParams::truncation
+
+        def initialize: (
+          ?conversation: OpenAI::Models::Responses::InputTokenCountParams::conversation?,
+          ?input: OpenAI::Models::Responses::InputTokenCountParams::input?,
+          ?instructions: String?,
+          ?model: String?,
+          ?parallel_tool_calls: bool?,
+          ?previous_response_id: String?,
+          ?reasoning: OpenAI::Reasoning?,
+          ?text: OpenAI::Responses::InputTokenCountParams::Text?,
+          ?tool_choice: OpenAI::Models::Responses::InputTokenCountParams::tool_choice?,
+          ?tools: ::Array[OpenAI::Models::Responses::tool]?,
+          ?truncation: OpenAI::Models::Responses::InputTokenCountParams::truncation,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          conversation: OpenAI::Models::Responses::InputTokenCountParams::conversation?,
+          input: OpenAI::Models::Responses::InputTokenCountParams::input?,
+          instructions: String?,
+          model: String?,
+          parallel_tool_calls: bool?,
+          previous_response_id: String?,
+          reasoning: OpenAI::Reasoning?,
+          text: OpenAI::Responses::InputTokenCountParams::Text?,
+          tool_choice: OpenAI::Models::Responses::InputTokenCountParams::tool_choice?,
+          tools: ::Array[OpenAI::Models::Responses::tool]?,
+          truncation: OpenAI::Models::Responses::InputTokenCountParams::truncation,
+          request_options: OpenAI::RequestOptions
+        }
+
+        type conversation =
+          String | OpenAI::Responses::ResponseConversationParam
+
+        module Conversation
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::Responses::InputTokenCountParams::conversation]
+        end
+
+        type input =
+          String | ::Array[OpenAI::Models::Responses::response_input_item]
+
+        module Input
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::Responses::InputTokenCountParams::input]
+
+          ResponseInputItemArray: OpenAI::Internal::Type::Converter
+        end
+
+        type text =
+          {
+            format_: OpenAI::Models::Responses::response_format_text_config,
+            verbosity: OpenAI::Models::Responses::InputTokenCountParams::Text::verbosity?
+          }
+
+        class Text < OpenAI::Internal::Type::BaseModel
+          attr_reader format_: OpenAI::Models::Responses::response_format_text_config?
+
+          def format_=: (
+            OpenAI::Models::Responses::response_format_text_config
+          ) -> OpenAI::Models::Responses::response_format_text_config
+
+          attr_accessor verbosity: OpenAI::Models::Responses::InputTokenCountParams::Text::verbosity?
+
+          def initialize: (
+            ?format_: OpenAI::Models::Responses::response_format_text_config,
+            ?verbosity: OpenAI::Models::Responses::InputTokenCountParams::Text::verbosity?
+          ) -> void
+
+          def to_hash: -> {
+            format_: OpenAI::Models::Responses::response_format_text_config,
+            verbosity: OpenAI::Models::Responses::InputTokenCountParams::Text::verbosity?
+          }
+
+          type verbosity = :low | :medium | :high
+
+          module Verbosity
+            extend OpenAI::Internal::Type::Enum
+
+            LOW: :low
+            MEDIUM: :medium
+            HIGH: :high
+
+            def self?.values: -> ::Array[OpenAI::Models::Responses::InputTokenCountParams::Text::verbosity]
+          end
+        end
+
+        type tool_choice =
+          OpenAI::Models::Responses::tool_choice_options
+          | OpenAI::Responses::ToolChoiceAllowed
+          | OpenAI::Responses::ToolChoiceTypes
+          | OpenAI::Responses::ToolChoiceFunction
+          | OpenAI::Responses::ToolChoiceMcp
+          | OpenAI::Responses::ToolChoiceCustom
+
+        module ToolChoice
+          extend OpenAI::Internal::Type::Union
+
+          def self?.variants: -> ::Array[OpenAI::Models::Responses::InputTokenCountParams::tool_choice]
+        end
+
+        type truncation = :auto | :disabled
+
+        module Truncation
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO: :auto
+          DISABLED: :disabled
+
+          def self?.values: -> ::Array[OpenAI::Models::Responses::InputTokenCountParams::truncation]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/responses/input_token_count_response.rbs

@@ -0,0 +1,24 @@
+module OpenAI
+  module Models
+    module Responses
+      type input_token_count_response =
+        { input_tokens: Integer, object: :"response.input_tokens" }
+
+      class InputTokenCountResponse < OpenAI::Internal::Type::BaseModel
+        attr_accessor input_tokens: Integer
+
+        attr_accessor object: :"response.input_tokens"
+
+        def initialize: (
+          input_tokens: Integer,
+          ?object: :"response.input_tokens"
+        ) -> void
+
+        def to_hash: -> {
+          input_tokens: Integer,
+          object: :"response.input_tokens"
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/responses/response_computer_tool_call.rbs

@@ -253,18 +253,22 @@ module OpenAI
         end
 
         type pending_safety_check =
-          { id: String, code: String, message: String }
+          { id: String, code: String?, message: String? }
 
         class PendingSafetyCheck < OpenAI::Internal::Type::BaseModel
           attr_accessor id: String
 
-          attr_accessor code: String
+          attr_accessor code: String?
 
-          attr_accessor message: String
+          attr_accessor message: String?
 
-          def initialize: (id: String, code: String, message: String) -> void
+          def initialize: (
+            id: String,
+            ?code: String?,
+            ?message: String?
+          ) -> void
 
-          def to_hash: -> { id: String, code: String, message: String }
+          def to_hash: -> { id: String, code: String?, message: String? }
         end
 
         type status = :in_progress | :completed | :incomplete

data/sig/openai/models/responses/response_computer_tool_call_output_item.rbs

@@ -51,18 +51,22 @@ module OpenAI
         }
 
         type acknowledged_safety_check =
-          { id: String, code: String, message: String }
+          { id: String, code: String?, message: String? }
 
         class AcknowledgedSafetyCheck < OpenAI::Internal::Type::BaseModel
           attr_accessor id: String
 
-          attr_accessor code: String
+          attr_accessor code: String?
 
-          attr_accessor message: String
+          attr_accessor message: String?
 
-          def initialize: (id: String, code: String, message: String) -> void
+          def initialize: (
+            id: String,
+            ?code: String?,
+            ?message: String?
+          ) -> void
 
-          def to_hash: -> { id: String, code: String, message: String }
+          def to_hash: -> { id: String, code: String?, message: String? }
         end
 
         type status = :in_progress | :completed | :incomplete

data/sig/openai/models/responses/response_includable.rbs

@@ -2,22 +2,26 @@ module OpenAI
   module Models
     module Responses
       type response_includable =
-        :"code_interpreter_call.outputs"
-        | :"computer_call_output.output.image_url"
-        | :"file_search_call.results"
+        :"file_search_call.results"
+        | :"web_search_call.results"
+        | :"web_search_call.action.sources"
         | :"message.input_image.image_url"
-        | :"message.output_text.logprobs"
+        | :"computer_call_output.output.image_url"
+        | :"code_interpreter_call.outputs"
         | :"reasoning.encrypted_content"
+        | :"message.output_text.logprobs"
 
       module ResponseIncludable
         extend OpenAI::Internal::Type::Enum
 
-        CODE_INTERPRETER_CALL_OUTPUTS: :"code_interpreter_call.outputs"
-        COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL: :"computer_call_output.output.image_url"
         FILE_SEARCH_CALL_RESULTS: :"file_search_call.results"
+        WEB_SEARCH_CALL_RESULTS: :"web_search_call.results"
+        WEB_SEARCH_CALL_ACTION_SOURCES: :"web_search_call.action.sources"
         MESSAGE_INPUT_IMAGE_IMAGE_URL: :"message.input_image.image_url"
-        MESSAGE_OUTPUT_TEXT_LOGPROBS: :"message.output_text.logprobs"
+        COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL: :"computer_call_output.output.image_url"
+        CODE_INTERPRETER_CALL_OUTPUTS: :"code_interpreter_call.outputs"
         REASONING_ENCRYPTED_CONTENT: :"reasoning.encrypted_content"
+        MESSAGE_OUTPUT_TEXT_LOGPROBS: :"message.output_text.logprobs"
 
         def self?.values: -> ::Array[OpenAI::Models::Responses::response_includable]
       end

data/sig/openai/resources/responses/input_tokens.rbs

@@ -0,0 +1,24 @@
+module OpenAI
+  module Resources
+    class Responses
+      class InputTokens
+        def count: (
+          ?conversation: OpenAI::Models::Responses::InputTokenCountParams::conversation?,
+          ?input: OpenAI::Models::Responses::InputTokenCountParams::input?,
+          ?instructions: String?,
+          ?model: String?,
+          ?parallel_tool_calls: bool?,
+          ?previous_response_id: String?,
+          ?reasoning: OpenAI::Reasoning?,
+          ?text: OpenAI::Responses::InputTokenCountParams::Text?,
+          ?tool_choice: OpenAI::Models::Responses::InputTokenCountParams::tool_choice?,
+          ?tools: ::Array[OpenAI::Models::Responses::tool]?,
+          ?truncation: OpenAI::Models::Responses::InputTokenCountParams::truncation,
+          ?request_options: OpenAI::request_opts
+        ) -> OpenAI::Models::Responses::InputTokenCountResponse
+
+        def initialize: (client: OpenAI::Client) -> void
+      end
+    end
+  end
+end

data/sig/openai/resources/responses.rbs

@@ -3,6 +3,8 @@ module OpenAI
     class Responses
       attr_reader input_items: OpenAI::Resources::Responses::InputItems
 
+      attr_reader input_tokens: OpenAI::Resources::Responses::InputTokens
+
       def create: (
         ?background: bool?,
         ?conversation: OpenAI::Models::Responses::ResponseCreateParams::conversation?,