openai 0.67.0 → 0.69.0

data/rbi/openai/models/beta/beta_response_tool_search_output_item_param.rbi

@@ -0,0 +1,307 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseToolSearchOutputItemParam =
+      Beta::BetaResponseToolSearchOutputItemParam
+
+    module Beta
+      class BetaResponseToolSearchOutputItemParam < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The loaded tool definitions returned by the tool search output.
+        sig do
+          returns(
+            T::Array[
+              T.any(
+                OpenAI::Beta::BetaFunctionTool,
+                OpenAI::Beta::BetaFileSearchTool,
+                OpenAI::Beta::BetaComputerTool,
+                OpenAI::Beta::BetaComputerUsePreviewTool,
+                OpenAI::Beta::BetaTool::Mcp,
+                OpenAI::Beta::BetaTool::CodeInterpreter,
+                OpenAI::Beta::BetaTool::ProgrammaticToolCalling,
+                OpenAI::Beta::BetaTool::ImageGeneration,
+                OpenAI::Beta::BetaTool::LocalShell,
+                OpenAI::Beta::BetaFunctionShellTool,
+                OpenAI::Beta::BetaCustomTool,
+                OpenAI::Beta::BetaNamespaceTool,
+                OpenAI::Beta::BetaToolSearchTool,
+                OpenAI::Beta::BetaApplyPatchTool,
+                OpenAI::Beta::BetaWebSearchTool,
+                OpenAI::Beta::BetaWebSearchPreviewTool
+              )
+            ]
+          )
+        end
+        attr_accessor :tools
+
+        # The item type. Always `tool_search_output`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The unique ID of this tool search output.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # The agent that produced this item.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Agent
+            )
+          )
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Agent::OrHash
+              )
+          ).void
+        end
+        attr_writer :agent
+
+        # The unique ID of the tool search call generated by the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :call_id
+
+        # Whether tool search was executed by the server or by the client.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Execution::OrSymbol
+            )
+          )
+        end
+        attr_reader :execution
+
+        sig do
+          params(
+            execution:
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Execution::OrSymbol
+          ).void
+        end
+        attr_writer :execution
+
+        # The status of the tool search output.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Status::OrSymbol
+            )
+          )
+        end
+        attr_accessor :status
+
+        sig do
+          params(
+            tools:
+              T::Array[
+                T.any(
+                  OpenAI::Beta::BetaFunctionTool::OrHash,
+                  OpenAI::Beta::BetaFileSearchTool::OrHash,
+                  OpenAI::Beta::BetaComputerTool::OrHash,
+                  OpenAI::Beta::BetaComputerUsePreviewTool::OrHash,
+                  OpenAI::Beta::BetaTool::Mcp::OrHash,
+                  OpenAI::Beta::BetaTool::CodeInterpreter::OrHash,
+                  OpenAI::Beta::BetaTool::ProgrammaticToolCalling::OrHash,
+                  OpenAI::Beta::BetaTool::ImageGeneration::OrHash,
+                  OpenAI::Beta::BetaTool::LocalShell::OrHash,
+                  OpenAI::Beta::BetaFunctionShellTool::OrHash,
+                  OpenAI::Beta::BetaCustomTool::OrHash,
+                  OpenAI::Beta::BetaNamespaceTool::OrHash,
+                  OpenAI::Beta::BetaToolSearchTool::OrHash,
+                  OpenAI::Beta::BetaApplyPatchTool::OrHash,
+                  OpenAI::Beta::BetaWebSearchTool::OrHash,
+                  OpenAI::Beta::BetaWebSearchPreviewTool::OrHash
+                )
+              ],
+            id: T.nilable(String),
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Agent::OrHash
+              ),
+            call_id: T.nilable(String),
+            execution:
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Execution::OrSymbol,
+            status:
+              T.nilable(
+                OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Status::OrSymbol
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The loaded tool definitions returned by the tool search output.
+          tools:,
+          # The unique ID of this tool search output.
+          id: nil,
+          # The agent that produced this item.
+          agent: nil,
+          # The unique ID of the tool search call generated by the model.
+          call_id: nil,
+          # Whether tool search was executed by the server or by the client.
+          execution: nil,
+          # The status of the tool search output.
+          status: nil,
+          # The item type. Always `tool_search_output`.
+          type: :tool_search_output
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              tools:
+                T::Array[
+                  T.any(
+                    OpenAI::Beta::BetaFunctionTool,
+                    OpenAI::Beta::BetaFileSearchTool,
+                    OpenAI::Beta::BetaComputerTool,
+                    OpenAI::Beta::BetaComputerUsePreviewTool,
+                    OpenAI::Beta::BetaTool::Mcp,
+                    OpenAI::Beta::BetaTool::CodeInterpreter,
+                    OpenAI::Beta::BetaTool::ProgrammaticToolCalling,
+                    OpenAI::Beta::BetaTool::ImageGeneration,
+                    OpenAI::Beta::BetaTool::LocalShell,
+                    OpenAI::Beta::BetaFunctionShellTool,
+                    OpenAI::Beta::BetaCustomTool,
+                    OpenAI::Beta::BetaNamespaceTool,
+                    OpenAI::Beta::BetaToolSearchTool,
+                    OpenAI::Beta::BetaApplyPatchTool,
+                    OpenAI::Beta::BetaWebSearchTool,
+                    OpenAI::Beta::BetaWebSearchPreviewTool
+                  )
+                ],
+              type: Symbol,
+              id: T.nilable(String),
+              agent:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Agent
+                ),
+              call_id: T.nilable(String),
+              execution:
+                OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Execution::OrSymbol,
+              status:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Status::OrSymbol
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Agent,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The canonical name of the agent that produced this item.
+          sig { returns(String) }
+          attr_accessor :agent_name
+
+          # The agent that produced this item.
+          sig { params(agent_name: String).returns(T.attached_class) }
+          def self.new(
+            # The canonical name of the agent that produced this item.
+            agent_name:
+          )
+          end
+
+          sig { override.returns({ agent_name: String }) }
+          def to_hash
+          end
+        end
+
+        # Whether tool search was executed by the server or by the client.
+        module Execution
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Execution
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SERVER =
+            T.let(
+              :server,
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Execution::TaggedSymbol
+            )
+          CLIENT =
+            T.let(
+              :client,
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Execution::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Execution::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The status of the tool search output.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_response_usage.rbi

@@ -0,0 +1,163 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseUsage = Beta::BetaResponseUsage
+
+    module Beta
+      class BetaResponseUsage < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Beta::BetaResponseUsage, OpenAI::Internal::AnyHash)
+          end
+
+        # The number of input tokens.
+        sig { returns(Integer) }
+        attr_accessor :input_tokens
+
+        # A detailed breakdown of the input tokens.
+        sig { returns(OpenAI::Beta::BetaResponseUsage::InputTokensDetails) }
+        attr_reader :input_tokens_details
+
+        sig do
+          params(
+            input_tokens_details:
+              OpenAI::Beta::BetaResponseUsage::InputTokensDetails::OrHash
+          ).void
+        end
+        attr_writer :input_tokens_details
+
+        # The number of output tokens.
+        sig { returns(Integer) }
+        attr_accessor :output_tokens
+
+        # A detailed breakdown of the output tokens.
+        sig { returns(OpenAI::Beta::BetaResponseUsage::OutputTokensDetails) }
+        attr_reader :output_tokens_details
+
+        sig do
+          params(
+            output_tokens_details:
+              OpenAI::Beta::BetaResponseUsage::OutputTokensDetails::OrHash
+          ).void
+        end
+        attr_writer :output_tokens_details
+
+        # The total number of tokens used.
+        sig { returns(Integer) }
+        attr_accessor :total_tokens
+
+        # Represents token usage details including input tokens, output tokens, a
+        # breakdown of output tokens, and the total tokens used.
+        sig do
+          params(
+            input_tokens: Integer,
+            input_tokens_details:
+              OpenAI::Beta::BetaResponseUsage::InputTokensDetails::OrHash,
+            output_tokens: Integer,
+            output_tokens_details:
+              OpenAI::Beta::BetaResponseUsage::OutputTokensDetails::OrHash,
+            total_tokens: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The number of input tokens.
+          input_tokens:,
+          # A detailed breakdown of the input tokens.
+          input_tokens_details:,
+          # The number of output tokens.
+          output_tokens:,
+          # A detailed breakdown of the output tokens.
+          output_tokens_details:,
+          # The total number of tokens used.
+          total_tokens:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              input_tokens: Integer,
+              input_tokens_details:
+                OpenAI::Beta::BetaResponseUsage::InputTokensDetails,
+              output_tokens: Integer,
+              output_tokens_details:
+                OpenAI::Beta::BetaResponseUsage::OutputTokensDetails,
+              total_tokens: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseUsage::InputTokensDetails,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The number of input tokens that were written to the cache.
+          sig { returns(Integer) }
+          attr_accessor :cache_write_tokens
+
+          # The number of tokens that were retrieved from the cache.
+          # [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
+          sig { returns(Integer) }
+          attr_accessor :cached_tokens
+
+          # A detailed breakdown of the input tokens.
+          sig do
+            params(cache_write_tokens: Integer, cached_tokens: Integer).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The number of input tokens that were written to the cache.
+            cache_write_tokens:,
+            # The number of tokens that were retrieved from the cache.
+            # [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
+            cached_tokens:
+          )
+          end
+
+          sig do
+            override.returns(
+              { cache_write_tokens: Integer, cached_tokens: Integer }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class OutputTokensDetails < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseUsage::OutputTokensDetails,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The number of reasoning tokens.
+          sig { returns(Integer) }
+          attr_accessor :reasoning_tokens
+
+          # A detailed breakdown of the output tokens.
+          sig { params(reasoning_tokens: Integer).returns(T.attached_class) }
+          def self.new(
+            # The number of reasoning tokens.
+            reasoning_tokens:
+          )
+          end
+
+          sig { override.returns({ reasoning_tokens: Integer }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_response_web_search_call_completed_event.rbi

@@ -0,0 +1,126 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseWebSearchCallCompletedEvent =
+      Beta::BetaResponseWebSearchCallCompletedEvent
+
+    module Beta
+      class BetaResponseWebSearchCallCompletedEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseWebSearchCallCompletedEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Unique ID for the output item associated with the web search call.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item that the web search call is associated with.
+        sig { returns(Integer) }
+        attr_accessor :output_index
+
+        # The sequence number of the web search call being processed.
+        sig { returns(Integer) }
+        attr_accessor :sequence_number
+
+        # The type of the event. Always `response.web_search_call.completed`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The agent that owns this multi-agent streaming event.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseWebSearchCallCompletedEvent::Agent
+            )
+          )
+        end
+        attr_reader :agent
+
+        sig do
+          params(
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseWebSearchCallCompletedEvent::Agent::OrHash
+              )
+          ).void
+        end
+        attr_writer :agent
+
+        # Emitted when a web search call is completed.
+        sig do
+          params(
+            item_id: String,
+            output_index: Integer,
+            sequence_number: Integer,
+            agent:
+              T.nilable(
+                OpenAI::Beta::BetaResponseWebSearchCallCompletedEvent::Agent::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique ID for the output item associated with the web search call.
+          item_id:,
+          # The index of the output item that the web search call is associated with.
+          output_index:,
+          # The sequence number of the web search call being processed.
+          sequence_number:,
+          # The agent that owns this multi-agent streaming event.
+          agent: nil,
+          # The type of the event. Always `response.web_search_call.completed`.
+          type: :"response.web_search_call.completed"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              item_id: String,
+              output_index: Integer,
+              sequence_number: Integer,
+              type: Symbol,
+              agent:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseWebSearchCallCompletedEvent::Agent
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Agent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseWebSearchCallCompletedEvent::Agent,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The canonical name of the agent that produced this item.
+          sig { returns(String) }
+          attr_accessor :agent_name
+
+          # The agent that owns this multi-agent streaming event.
+          sig { params(agent_name: String).returns(T.attached_class) }
+          def self.new(
+            # The canonical name of the agent that produced this item.
+            agent_name:
+          )
+          end
+
+          sig { override.returns({ agent_name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end