openai 0.33.0 → 0.34.0

data/lib/openai/models/responses/tool.rb

@@ -30,11 +30,8 @@ module OpenAI
         # A tool that generates images using a model like `gpt-image-1`.
         variant :image_generation, -> { OpenAI::Responses::Tool::ImageGeneration }
 
-        # A tool that allows the model to execute shell commands in a local environment.
         variant :local_shell, -> { OpenAI::Responses::Tool::LocalShell }
 
-        # A custom tool that processes input using a specified format. Learn more about
-        # [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools).
         variant :custom, -> { OpenAI::Responses::CustomTool }
 
         # Search the Internet for sources related to the prompt. Learn more about the
@@ -375,8 +372,7 @@ module OpenAI
             # The container ID.
             variant String
 
-            # Configuration for a code interpreter container. Optionally specify the IDs
-            # of the files to run the code on.
+            # Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
             variant -> { OpenAI::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto }
 
             class CodeInterpreterToolAuto < OpenAI::Internal::Type::BaseModel
@@ -393,10 +389,6 @@ module OpenAI
               optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
 
               # @!method initialize(file_ids: nil, type: :auto)
-              #   Some parameter documentations has been truncated, see
-              #   {OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto}
-              #   for more details.
-              #
               #   Configuration for a code interpreter container. Optionally specify the IDs of
               #   the files to run the code on.
               #
@@ -498,7 +490,7 @@ module OpenAI
           #
           #   @param background [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::Background] Background type for the generated image. One of `transparent`,
           #
-          #   @param input_fidelity [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::InputFidelity, nil] Control how much effort the model will exert to match the style and features,
+          #   @param input_fidelity [Symbol, OpenAI::Models::Responses::Tool::ImageGeneration::InputFidelity, nil]
           #
           #   @param input_image_mask [OpenAI::Models::Responses::Tool::ImageGeneration::InputImageMask] Optional mask for inpainting. Contains `image_url`
           #
@@ -658,8 +650,6 @@ module OpenAI
           required :type, const: :local_shell
 
           # @!method initialize(type: :local_shell)
-          #   A tool that allows the model to execute shell commands in a local environment.
-          #
           #   @param type [Symbol, :local_shell] The type of the local shell tool. Always `local_shell`.
         end
 

data/lib/openai/resources/conversations/items.rb

@@ -79,7 +79,7 @@ module OpenAI
         #
         # @param after [String] An item ID to list items after, used in pagination.
         #
-        # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Specify additional output data to include in the model response. Currently
+        # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Specify additional output data to include in the model response. Currently suppo
         #
         # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between
         #

data/lib/openai/resources/images.rb

@@ -55,7 +55,7 @@ module OpenAI
       #
       # @param background [Symbol, OpenAI::Models::ImageEditParams::Background, nil] Allows to set transparency for the background of the generated image(s).
       #
-      # @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil] Control how much effort the model will exert to match the style and features,
+      # @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
       #
       # @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart] An additional image whose fully transparent areas (e.g. where alpha is zero) ind
       #
@@ -114,7 +114,7 @@ module OpenAI
       #
       # @param background [Symbol, OpenAI::Models::ImageEditParams::Background, nil] Allows to set transparency for the background of the generated image(s).
       #
-      # @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil] Control how much effort the model will exert to match the style and features,
+      # @param input_fidelity [Symbol, OpenAI::Models::ImageEditParams::InputFidelity, nil]
       #
       # @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart] An additional image whose fully transparent areas (e.g. where alpha is zero) ind
       #

data/lib/openai/resources/responses/input_tokens.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Responses
+      class InputTokens
+        # Some parameter documentations has been truncated, see
+        # {OpenAI::Models::Responses::InputTokenCountParams} for more details.
+        #
+        # Get input token counts
+        #
+        # @overload count(conversation: nil, input: nil, instructions: nil, model: nil, parallel_tool_calls: nil, previous_response_id: nil, reasoning: nil, text: nil, tool_choice: nil, tools: nil, truncation: nil, request_options: {})
+        #
+        # @param conversation [String, OpenAI::Models::Responses::ResponseConversationParam, nil] The conversation that this response belongs to. Items from this conversation are
+        #
+        # @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Text, image, or file inputs to the model, used to generate a response
+        #
+        # @param instructions [String, nil] A system (or developer) message inserted into the model's context.
+        #
+        # @param model [String, nil] Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a w
+        #
+        # @param parallel_tool_calls [Boolean, nil] Whether to allow the model to run tool calls in parallel.
+        #
+        # @param previous_response_id [String, nil] The unique ID of the previous response to the model. Use this to create multi-tu
+        #
+        # @param reasoning [OpenAI::Models::Reasoning, nil] **gpt-5 and o-series models only** Configuration options for [reasoning models](
+        #
+        # @param text [OpenAI::Models::Responses::InputTokenCountParams::Text, nil] Configuration options for a text response from the model. Can be plain
+        #
+        # @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, nil] How the model should select which tool (or tools) to use when generating
+        #
+        # @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil] An array of tools the model may call while generating a response. You can specif
+        #
+        # @param truncation [Symbol, OpenAI::Models::Responses::InputTokenCountParams::Truncation] The truncation strategy to use for the model response. - `auto`: If the input to
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Responses::InputTokenCountResponse]
+        #
+        # @see OpenAI::Models::Responses::InputTokenCountParams
+        def count(params = {})
+          parsed, options = OpenAI::Responses::InputTokenCountParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "responses/input_tokens",
+            body: parsed,
+            model: OpenAI::Models::Responses::InputTokenCountResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [OpenAI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/responses.rb

@@ -6,6 +6,9 @@ module OpenAI
       # @return [OpenAI::Resources::Responses::InputItems]
       attr_reader :input_items
 
+      # @return [OpenAI::Resources::Responses::InputTokens]
+      attr_reader :input_tokens
+
       # See {OpenAI::Resources::Responses#stream_raw} for streaming counterpart.
       #
       # Some parameter documentations has been truncated, see
@@ -29,7 +32,7 @@ module OpenAI
       #
       # @param conversation [String, OpenAI::Models::Responses::ResponseConversationParam, nil] The conversation that this response belongs to. Items from this conversation are
       #
-      # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently
+      # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently suppo
       #
       # @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
       #
@@ -128,7 +131,7 @@ module OpenAI
       #
       # @param conversation [String, OpenAI::Models::Responses::ResponseConversationParam, nil] The conversation that this response belongs to. Items from this conversation are
       #
-      # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently
+      # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil] Specify additional output data to include in the model response. Currently suppo
       #
       # @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Text, image, or file inputs to the model, used to generate a response.
       #
@@ -458,6 +461,7 @@ module OpenAI
       def initialize(client:)
         @client = client
         @input_items = OpenAI::Resources::Responses::InputItems.new(client: client)
+        @input_tokens = OpenAI::Resources::Responses::InputTokens.new(client: client)
       end
 
       private

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.33.0"
+  VERSION = "0.34.0"
 end

data/lib/openai.rb

@@ -533,6 +533,8 @@ require_relative "openai/models/responses/easy_input_message"
 require_relative "openai/models/responses/file_search_tool"
 require_relative "openai/models/responses/function_tool"
 require_relative "openai/models/responses/input_item_list_params"
+require_relative "openai/models/responses/input_token_count_params"
+require_relative "openai/models/responses/input_token_count_response"
 require_relative "openai/models/responses/response"
 require_relative "openai/models/responses/response_audio_delta_event"
 require_relative "openai/models/responses/response_audio_done_event"
@@ -747,6 +749,7 @@ require_relative "openai/resources/realtime/calls"
 require_relative "openai/resources/realtime/client_secrets"
 require_relative "openai/resources/responses"
 require_relative "openai/resources/responses/input_items"
+require_relative "openai/resources/responses/input_tokens"
 require_relative "openai/resources/uploads"
 require_relative "openai/resources/uploads/parts"
 require_relative "openai/resources/vector_stores"

data/rbi/openai/models/custom_tool_input_format.rbi

@@ -27,7 +27,6 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # Unconstrained free-form text.
         sig { params(type: Symbol).returns(T.attached_class) }
         def self.new(
           # Unconstrained text format. Always `text`.
@@ -63,7 +62,6 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # A grammar defined by the user.
         sig do
           params(
             definition: String,

data/rbi/openai/models/responses/custom_tool.rbi

@@ -48,8 +48,6 @@ module OpenAI
         end
         attr_writer :format_
 
-        # A custom tool that processes input using a specified format. Learn more about
-        # [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools).
         sig do
           params(
             name: String,