openai 0.34.1 → 0.35.0

data/rbi/openai/resources/realtime/calls.rbi

@@ -57,7 +57,7 @@ module OpenAI
         end
         def accept(
           # The identifier for the call provided in the
-          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook-events/realtime/call/incoming)
           # webhook.
           call_id,
           # Configuration for input and output audio.
@@ -105,8 +105,19 @@ module OpenAI
           # `auto` will create a trace for the session with default values for the workflow
           # name, group id, and metadata.
           tracing: nil,
-          # Controls how the realtime conversation is truncated prior to model inference.
-          # The default is `auto`.
+          # When the number of tokens in a conversation exceeds the model's input token
+          # limit, the conversation be truncated, meaning messages (starting from the
+          # oldest) will not be included in the model's context. A 32k context model with
+          # 4,096 max output tokens can only include 28,224 tokens in the context before
+          # truncation occurs. Clients can configure truncation behavior to truncate with a
+          # lower max token limit, which is an effective way to control token usage and
+          # cost. Truncation will reduce the number of cached tokens on the next turn
+          # (busting the cache), since messages are dropped from the beginning of the
+          # context. However, clients can also configure truncation to retain messages up to
+          # a fraction of the maximum context size, which will reduce the need for future
+          # truncations and thus improve the cache rate. Truncation can be disabled
+          # entirely, which means the server will never truncate but would instead return an
+          # error if the conversation exceeds the model's input token limit.
           truncation: nil,
           # The type of session to create. Always `realtime` for the Realtime API.
           type: :realtime,
@@ -123,7 +134,7 @@ module OpenAI
         end
         def hangup(
           # The identifier for the call. For SIP calls, use the value provided in the
-          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook-events/realtime/call/incoming)
           # webhook. For WebRTC sessions, reuse the call ID returned in the `Location`
           # header when creating the call with
           # [`POST /v1/realtime/calls`](https://platform.openai.com/docs/api-reference/realtime/create-call).
@@ -142,7 +153,7 @@ module OpenAI
         end
         def refer(
           # The identifier for the call provided in the
-          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook-events/realtime/call/incoming)
           # webhook.
           call_id,
           # URI that should appear in the SIP Refer-To header. Supports values like
@@ -162,7 +173,7 @@ module OpenAI
         end
         def reject(
           # The identifier for the call provided in the
-          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook-events/realtime/call/incoming)
           # webhook.
           call_id,
           # SIP response code to send back to the caller. Defaults to `603` (Decline) when

data/rbi/openai/resources/vector_stores/file_batches.rbi

@@ -8,7 +8,6 @@ module OpenAI
         sig do
           params(
             vector_store_id: String,
-            file_ids: T::Array[String],
             attributes:
               T.nilable(
                 T::Hash[
@@ -21,16 +20,17 @@ module OpenAI
                 OpenAI::AutoFileChunkingStrategyParam::OrHash,
                 OpenAI::StaticFileChunkingStrategyObjectParam::OrHash
               ),
+            file_ids: T::Array[String],
+            files:
+              T::Array[
+                OpenAI::VectorStores::FileBatchCreateParams::File::OrHash
+              ],
             request_options: OpenAI::RequestOptions::OrHash
           ).returns(OpenAI::VectorStores::VectorStoreFileBatch)
         end
         def create(
           # The ID of the vector store for which to create a File Batch.
           vector_store_id,
-          # A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
-          # the vector store should use. Useful for tools like `file_search` that can access
-          # files.
-          file_ids:,
           # Set of 16 key-value pairs that can be attached to an object. This can be useful
           # for storing additional information about the object in a structured format, and
           # querying for objects via API or the dashboard. Keys are strings with a maximum
@@ -40,6 +40,16 @@ module OpenAI
           # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
           # strategy. Only applicable if `file_ids` is non-empty.
           chunking_strategy: nil,
+          # A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
+          # the vector store should use. Useful for tools like `file_search` that can access
+          # files. If `attributes` or `chunking_strategy` are provided, they will be applied
+          # to all files in the batch. Mutually exclusive with `files`.
+          file_ids: nil,
+          # A list of objects that each include a `file_id` plus optional `attributes` or
+          # `chunking_strategy`. Use this when you need to override metadata for specific
+          # files. The global `attributes` or `chunking_strategy` will be ignored and must
+          # be specified for each file. Mutually exclusive with `file_ids`.
+          files: nil,
           request_options: {}
         )
         end

data/sig/openai/internal/transport/base_client.rbs

@@ -87,6 +87,8 @@ module OpenAI
 
         private def auth_headers: -> ::Hash[String, String]
 
+        private def user_agent: -> String
+
         private def generate_idempotency_key: -> String
 
         private def build_request: (

data/sig/openai/models/realtime/realtime_truncation_retention_ratio.rbs

@@ -2,19 +2,46 @@ module OpenAI
   module Models
     module Realtime
       type realtime_truncation_retention_ratio =
-        { retention_ratio: Float, type: :retention_ratio }
+        {
+          retention_ratio: Float,
+          type: :retention_ratio,
+          token_limits: OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits
+        }
 
       class RealtimeTruncationRetentionRatio < OpenAI::Internal::Type::BaseModel
         attr_accessor retention_ratio: Float
 
         attr_accessor type: :retention_ratio
 
+        attr_reader token_limits: OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits?
+
+        def token_limits=: (
+          OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits
+        ) -> OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits
+
         def initialize: (
           retention_ratio: Float,
+          ?token_limits: OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits,
           ?type: :retention_ratio
         ) -> void
 
-        def to_hash: -> { retention_ratio: Float, type: :retention_ratio }
+        def to_hash: -> {
+          retention_ratio: Float,
+          type: :retention_ratio,
+          token_limits: OpenAI::Realtime::RealtimeTruncationRetentionRatio::TokenLimits
+        }
+
+        type token_limits = { post_instructions: Integer }
+
+        class TokenLimits < OpenAI::Internal::Type::BaseModel
+          attr_reader post_instructions: Integer?
+
+          def post_instructions=: (Integer) -> Integer
+
+          def initialize: (?post_instructions: Integer) -> void
+
+          def to_hash: -> { post_instructions: Integer }
+        end
       end
     end
   end

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

@@ -53,11 +53,18 @@ module OpenAI
 
         type ranking_options =
           {
+            hybrid_search: OpenAI::Responses::FileSearchTool::RankingOptions::HybridSearch,
             ranker: OpenAI::Models::Responses::FileSearchTool::RankingOptions::ranker,
             score_threshold: Float
           }
 
         class RankingOptions < OpenAI::Internal::Type::BaseModel
+          attr_reader hybrid_search: OpenAI::Responses::FileSearchTool::RankingOptions::HybridSearch?
+
+          def hybrid_search=: (
+            OpenAI::Responses::FileSearchTool::RankingOptions::HybridSearch
+          ) -> OpenAI::Responses::FileSearchTool::RankingOptions::HybridSearch
+
           attr_reader ranker: OpenAI::Models::Responses::FileSearchTool::RankingOptions::ranker?
 
           def ranker=: (
@@ -69,15 +76,32 @@ module OpenAI
           def score_threshold=: (Float) -> Float
 
           def initialize: (
+            ?hybrid_search: OpenAI::Responses::FileSearchTool::RankingOptions::HybridSearch,
             ?ranker: OpenAI::Models::Responses::FileSearchTool::RankingOptions::ranker,
             ?score_threshold: Float
           ) -> void
 
           def to_hash: -> {
+            hybrid_search: OpenAI::Responses::FileSearchTool::RankingOptions::HybridSearch,
             ranker: OpenAI::Models::Responses::FileSearchTool::RankingOptions::ranker,
             score_threshold: Float
           }
 
+          type hybrid_search = { embedding_weight: Float, text_weight: Float }
+
+          class HybridSearch < OpenAI::Internal::Type::BaseModel
+            attr_accessor embedding_weight: Float
+
+            attr_accessor text_weight: Float
+
+            def initialize: (
+              embedding_weight: Float,
+              text_weight: Float
+            ) -> void
+
+            def to_hash: -> { embedding_weight: Float, text_weight: Float }
+          end
+
           type ranker = :auto | :"default-2024-11-15"
 
           module Ranker

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

@@ -5,7 +5,6 @@ module OpenAI
         OpenAI::Responses::ResponseInputText
         | OpenAI::Responses::ResponseInputImage
         | OpenAI::Responses::ResponseInputFile
-        | OpenAI::Responses::ResponseInputAudio
         | OpenAI::Responses::ResponseOutputText
         | OpenAI::Responses::ResponseOutputRefusal
         | OpenAI::Responses::ResponseContent::ReasoningTextContent

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

@@ -5,7 +5,6 @@ module OpenAI
         OpenAI::Responses::ResponseInputText
         | OpenAI::Responses::ResponseInputImage
         | OpenAI::Responses::ResponseInputFile
-        | OpenAI::Responses::ResponseInputAudio
 
       module ResponseInputContent
         extend OpenAI::Internal::Type::Union

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

@@ -4,36 +4,32 @@ module OpenAI
       type response_output_text =
         {
           annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation],
+          logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob],
           text: String,
-          type: :output_text,
-          logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
+          type: :output_text
         }
 
       class ResponseOutputText < OpenAI::Internal::Type::BaseModel
         attr_accessor annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation]
 
+        attr_accessor logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
+
         attr_accessor text: String
 
         attr_accessor type: :output_text
 
-        attr_reader logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]?
-
-        def logprobs=: (
-          ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
-        ) -> ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
-
         def initialize: (
           annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation],
+          logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob],
           text: String,
-          ?logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob],
           ?type: :output_text
         ) -> void
 
         def to_hash: -> {
           annotations: ::Array[OpenAI::Models::Responses::ResponseOutputText::annotation],
+          logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob],
           text: String,
-          type: :output_text,
-          logprobs: ::Array[OpenAI::Responses::ResponseOutputText::Logprob]
+          type: :output_text
         }
 
         type annotation =

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

@@ -258,7 +258,11 @@ module OpenAI
             extend OpenAI::Internal::Type::Union
 
             type code_interpreter_tool_auto =
-              { type: :auto, file_ids: ::Array[String] }
+              {
+                type: :auto,
+                file_ids: ::Array[String],
+                memory_limit: OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto::memory_limit?
+              }
 
             class CodeInterpreterToolAuto < OpenAI::Internal::Type::BaseModel
               attr_accessor type: :auto
@@ -267,9 +271,32 @@ module OpenAI
 
               def file_ids=: (::Array[String]) -> ::Array[String]
 
-              def initialize: (?file_ids: ::Array[String], ?type: :auto) -> void
+              attr_accessor memory_limit: OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto::memory_limit?
+
+              def initialize: (
+                ?file_ids: ::Array[String],
+                ?memory_limit: OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto::memory_limit?,
+                ?type: :auto
+              ) -> void
+
+              def to_hash: -> {
+                type: :auto,
+                file_ids: ::Array[String],
+                memory_limit: OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto::memory_limit?
+              }
+
+              type memory_limit = :"1g" | :"4g" | :"16g" | :"64g"
 
-              def to_hash: -> { type: :auto, file_ids: ::Array[String] }
+              module MemoryLimit
+                extend OpenAI::Internal::Type::Enum
+
+                MEMORY_LIMIT_1G: :"1g"
+                MEMORY_LIMIT_4G: :"4g"
+                MEMORY_LIMIT_16G: :"16g"
+                MEMORY_LIMIT_64G: :"64g"
+
+                def self?.values: -> ::Array[OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto::memory_limit]
+              end
             end
 
             def self?.variants: -> ::Array[OpenAI::Models::Responses::Tool::CodeInterpreter::container]

data/sig/openai/models/vector_stores/file_batch_create_params.rbs

@@ -3,9 +3,10 @@ module OpenAI
     module VectorStores
       type file_batch_create_params =
         {
-          file_ids: ::Array[String],
           attributes: ::Hash[Symbol, OpenAI::Models::VectorStores::FileBatchCreateParams::attribute]?,
-          chunking_strategy: OpenAI::Models::file_chunking_strategy_param
+          chunking_strategy: OpenAI::Models::file_chunking_strategy_param,
+          file_ids: ::Array[String],
+          files: ::Array[OpenAI::VectorStores::FileBatchCreateParams::File]
         }
         & OpenAI::Internal::Type::request_parameters
 
@@ -13,8 +14,6 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
-        attr_accessor file_ids: ::Array[String]
-
         attr_accessor attributes: ::Hash[Symbol, OpenAI::Models::VectorStores::FileBatchCreateParams::attribute]?
 
         attr_reader chunking_strategy: OpenAI::Models::file_chunking_strategy_param?
@@ -23,17 +22,29 @@ module OpenAI
           OpenAI::Models::file_chunking_strategy_param
         ) -> OpenAI::Models::file_chunking_strategy_param
 
+        attr_reader file_ids: ::Array[String]?
+
+        def file_ids=: (::Array[String]) -> ::Array[String]
+
+        attr_reader files: ::Array[OpenAI::VectorStores::FileBatchCreateParams::File]?
+
+        def files=: (
+          ::Array[OpenAI::VectorStores::FileBatchCreateParams::File]
+        ) -> ::Array[OpenAI::VectorStores::FileBatchCreateParams::File]
+
         def initialize: (
-          file_ids: ::Array[String],
           ?attributes: ::Hash[Symbol, OpenAI::Models::VectorStores::FileBatchCreateParams::attribute]?,
           ?chunking_strategy: OpenAI::Models::file_chunking_strategy_param,
+          ?file_ids: ::Array[String],
+          ?files: ::Array[OpenAI::VectorStores::FileBatchCreateParams::File],
           ?request_options: OpenAI::request_opts
         ) -> void
 
         def to_hash: -> {
-          file_ids: ::Array[String],
           attributes: ::Hash[Symbol, OpenAI::Models::VectorStores::FileBatchCreateParams::attribute]?,
           chunking_strategy: OpenAI::Models::file_chunking_strategy_param,
+          file_ids: ::Array[String],
+          files: ::Array[OpenAI::VectorStores::FileBatchCreateParams::File],
           request_options: OpenAI::RequestOptions
         }
 
@@ -44,6 +55,45 @@ module OpenAI
 
           def self?.variants: -> ::Array[OpenAI::Models::VectorStores::FileBatchCreateParams::attribute]
         end
+
+        type file =
+          {
+            file_id: String,
+            attributes: ::Hash[Symbol, OpenAI::Models::VectorStores::FileBatchCreateParams::File::attribute]?,
+            chunking_strategy: OpenAI::Models::file_chunking_strategy_param
+          }
+
+        class File < OpenAI::Internal::Type::BaseModel
+          attr_accessor file_id: String
+
+          attr_accessor attributes: ::Hash[Symbol, OpenAI::Models::VectorStores::FileBatchCreateParams::File::attribute]?
+
+          attr_reader chunking_strategy: OpenAI::Models::file_chunking_strategy_param?
+
+          def chunking_strategy=: (
+            OpenAI::Models::file_chunking_strategy_param
+          ) -> OpenAI::Models::file_chunking_strategy_param
+
+          def initialize: (
+            file_id: String,
+            ?attributes: ::Hash[Symbol, OpenAI::Models::VectorStores::FileBatchCreateParams::File::attribute]?,
+            ?chunking_strategy: OpenAI::Models::file_chunking_strategy_param
+          ) -> void
+
+          def to_hash: -> {
+            file_id: String,
+            attributes: ::Hash[Symbol, OpenAI::Models::VectorStores::FileBatchCreateParams::File::attribute]?,
+            chunking_strategy: OpenAI::Models::file_chunking_strategy_param
+          }
+
+          type attribute = String | Float | bool
+
+          module Attribute
+            extend OpenAI::Internal::Type::Union
+
+            def self?.variants: -> ::Array[OpenAI::Models::VectorStores::FileBatchCreateParams::File::attribute]
+          end
+        end
       end
     end
   end

data/sig/openai/models/video.rbs

@@ -10,6 +10,7 @@ module OpenAI
         model: OpenAI::Models::video_model,
         object: :video,
         progress: Integer,
+        prompt: String?,
         remixed_from_video_id: String?,
         seconds: OpenAI::Models::video_seconds,
         size: OpenAI::Models::video_size,
@@ -33,6 +34,8 @@ module OpenAI
 
       attr_accessor progress: Integer
 
+      attr_accessor prompt: String?
+
       attr_accessor remixed_from_video_id: String?
 
       attr_accessor seconds: OpenAI::Models::video_seconds
@@ -49,6 +52,7 @@ module OpenAI
         expires_at: Integer?,
         model: OpenAI::Models::video_model,
         progress: Integer,
+        prompt: String?,
         remixed_from_video_id: String?,
         seconds: OpenAI::Models::video_seconds,
         size: OpenAI::Models::video_size,
@@ -65,6 +69,7 @@ module OpenAI
         model: OpenAI::Models::video_model,
         object: :video,
         progress: Integer,
+        prompt: String?,
         remixed_from_video_id: String?,
         seconds: OpenAI::Models::video_seconds,
         size: OpenAI::Models::video_size,

data/sig/openai/resources/vector_stores/file_batches.rbs

@@ -4,9 +4,10 @@ module OpenAI
       class FileBatches
         def create: (
           String vector_store_id,
-          file_ids: ::Array[String],
           ?attributes: ::Hash[Symbol, OpenAI::Models::VectorStores::FileBatchCreateParams::attribute]?,
           ?chunking_strategy: OpenAI::Models::file_chunking_strategy_param,
+          ?file_ids: ::Array[String],
+          ?files: ::Array[OpenAI::VectorStores::FileBatchCreateParams::File],
           ?request_options: OpenAI::request_opts
         ) -> OpenAI::VectorStores::VectorStoreFileBatch
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.34.1
+  version: 0.35.0
 platform: ruby
 authors:
 - OpenAI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-20 00:00:00.000000000 Z
+date: 2025-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -2228,7 +2228,8 @@ files:
 - sig/openai/resources/webhooks.rbs
 - sig/openai/version.rbs
 homepage: https://gemdocs.org/gems/openai
-licenses: []
+licenses:
+- Apache-2.0
 metadata:
   homepage_uri: https://gemdocs.org/gems/openai
   source_code_uri: https://github.com/openai/openai-ruby