openai 0.64.0 → 0.65.0

data/rbi/openai/models/conversations/conversation_item.rbi

@@ -24,6 +24,7 @@ module OpenAI
               OpenAI::Responses::ResponseComputerToolCallOutputItem,
               OpenAI::Responses::ResponseToolSearchCall,
               OpenAI::Responses::ResponseToolSearchOutputItem,
+              OpenAI::Conversations::ConversationItem::AdditionalTools,
               OpenAI::Responses::ResponseReasoningItem,
               OpenAI::Responses::ResponseCompactionItem,
               OpenAI::Responses::ResponseCodeInterpreterToolCall,
@@ -153,6 +154,155 @@ module OpenAI
           end
         end
 
+        class AdditionalTools < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Conversations::ConversationItem::AdditionalTools,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the additional tools item.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The role that provided the additional tools.
+          sig do
+            returns(
+              OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol
+            )
+          end
+          attr_accessor :role
+
+          # The additional tool definitions made available at this item.
+          sig { returns(T::Array[OpenAI::Responses::Tool::Variants]) }
+          attr_accessor :tools
+
+          # The type of the item. Always `additional_tools`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          sig do
+            params(
+              id: String,
+              role:
+                OpenAI::Conversations::ConversationItem::AdditionalTools::Role::OrSymbol,
+              tools:
+                T::Array[
+                  T.any(
+                    OpenAI::Responses::FunctionTool::OrHash,
+                    OpenAI::Responses::FileSearchTool::OrHash,
+                    OpenAI::Responses::ComputerTool::OrHash,
+                    OpenAI::Responses::ComputerUsePreviewTool::OrHash,
+                    OpenAI::Responses::Tool::Mcp::OrHash,
+                    OpenAI::Responses::Tool::CodeInterpreter::OrHash,
+                    OpenAI::Responses::Tool::ImageGeneration::OrHash,
+                    OpenAI::Responses::Tool::LocalShell::OrHash,
+                    OpenAI::Responses::FunctionShellTool::OrHash,
+                    OpenAI::Responses::CustomTool::OrHash,
+                    OpenAI::Responses::NamespaceTool::OrHash,
+                    OpenAI::Responses::ToolSearchTool::OrHash,
+                    OpenAI::Responses::ApplyPatchTool::OrHash,
+                    OpenAI::Responses::WebSearchTool::OrHash,
+                    OpenAI::Responses::WebSearchPreviewTool::OrHash
+                  )
+                ],
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The unique ID of the additional tools item.
+            id:,
+            # The role that provided the additional tools.
+            role:,
+            # The additional tool definitions made available at this item.
+            tools:,
+            # The type of the item. Always `additional_tools`.
+            type: :additional_tools
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                role:
+                  OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol,
+                tools: T::Array[OpenAI::Responses::Tool::Variants],
+                type: Symbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The role that provided the additional tools.
+          module Role
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Conversations::ConversationItem::AdditionalTools::Role
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            UNKNOWN =
+              T.let(
+                :unknown,
+                OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol
+              )
+            USER =
+              T.let(
+                :user,
+                OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol
+              )
+            ASSISTANT =
+              T.let(
+                :assistant,
+                OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol
+              )
+            SYSTEM =
+              T.let(
+                :system,
+                OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol
+              )
+            CRITIC =
+              T.let(
+                :critic,
+                OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol
+              )
+            DISCRIMINATOR =
+              T.let(
+                :discriminator,
+                OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol
+              )
+            DEVELOPER =
+              T.let(
+                :developer,
+                OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol
+              )
+            TOOL =
+              T.let(
+                :tool,
+                OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Conversations::ConversationItem::AdditionalTools::Role::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         class LocalShellCall < OpenAI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/openai/models/conversations/conversation_item_list.rbi

@@ -52,6 +52,7 @@ module OpenAI
                   OpenAI::Responses::ResponseComputerToolCallOutputItem::OrHash,
                   OpenAI::Responses::ResponseToolSearchCall::OrHash,
                   OpenAI::Responses::ResponseToolSearchOutputItem::OrHash,
+                  OpenAI::Conversations::ConversationItem::AdditionalTools::OrHash,
                   OpenAI::Responses::ResponseReasoningItem::OrHash,
                   OpenAI::Responses::ResponseCompactionItem::OrHash,
                   OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,

data/rbi/openai/models/conversations/item_create_params.rbi

@@ -34,6 +34,7 @@ module OpenAI
                 OpenAI::Responses::ResponseInputItem::FunctionCallOutput,
                 OpenAI::Responses::ResponseInputItem::ToolSearchCall,
                 OpenAI::Responses::ResponseToolSearchOutputItemParam,
+                OpenAI::Responses::ResponseInputItem::AdditionalTools,
                 OpenAI::Responses::ResponseReasoningItem,
                 OpenAI::Responses::ResponseCompactionItemParam,
                 OpenAI::Responses::ResponseInputItem::ImageGenerationCall,
@@ -92,6 +93,7 @@ module OpenAI
                   OpenAI::Responses::ResponseInputItem::FunctionCallOutput::OrHash,
                   OpenAI::Responses::ResponseInputItem::ToolSearchCall::OrHash,
                   OpenAI::Responses::ResponseToolSearchOutputItemParam::OrHash,
+                  OpenAI::Responses::ResponseInputItem::AdditionalTools::OrHash,
                   OpenAI::Responses::ResponseReasoningItem::OrHash,
                   OpenAI::Responses::ResponseCompactionItemParam::OrHash,
                   OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OrHash,
@@ -146,6 +148,7 @@ module OpenAI
                     OpenAI::Responses::ResponseInputItem::FunctionCallOutput,
                     OpenAI::Responses::ResponseInputItem::ToolSearchCall,
                     OpenAI::Responses::ResponseToolSearchOutputItemParam,
+                    OpenAI::Responses::ResponseInputItem::AdditionalTools,
                     OpenAI::Responses::ResponseReasoningItem,
                     OpenAI::Responses::ResponseCompactionItemParam,
                     OpenAI::Responses::ResponseInputItem::ImageGenerationCall,

data/rbi/openai/models/responses/compacted_response.rbi

@@ -56,6 +56,7 @@ module OpenAI
                   OpenAI::Responses::ResponseReasoningItem::OrHash,
                   OpenAI::Responses::ResponseToolSearchCall::OrHash,
                   OpenAI::Responses::ResponseToolSearchOutputItem::OrHash,
+                  OpenAI::Responses::ResponseOutputItem::AdditionalTools::OrHash,
                   OpenAI::Responses::ResponseCompactionItem::OrHash,
                   OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OrHash,
                   OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,

data/rbi/openai/models/responses/input_token_count_params.rbi

@@ -55,6 +55,32 @@ module OpenAI
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :parallel_tool_calls
 
+        # A model-owned style preset to apply to this request. Omit this parameter to use
+        # the model's default style. Supported values may expand over time. Values must be
+        # at most 64 characters.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                String,
+                OpenAI::Responses::InputTokenCountParams::Personality::OrSymbol
+              )
+            )
+          )
+        end
+        attr_reader :personality
+
+        sig do
+          params(
+            personality:
+              T.any(
+                String,
+                OpenAI::Responses::InputTokenCountParams::Personality::OrSymbol
+              )
+          ).void
+        end
+        attr_writer :personality
+
         # 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).
@@ -174,6 +200,11 @@ module OpenAI
             instructions: T.nilable(String),
             model: T.nilable(String),
             parallel_tool_calls: T.nilable(T::Boolean),
+            personality:
+              T.any(
+                String,
+                OpenAI::Responses::InputTokenCountParams::Personality::OrSymbol
+              ),
             previous_response_id: T.nilable(String),
             reasoning: T.nilable(OpenAI::Reasoning::OrHash),
             text:
@@ -239,6 +270,10 @@ module OpenAI
           model: nil,
           # Whether to allow the model to run tool calls in parallel.
           parallel_tool_calls: nil,
+          # A model-owned style preset to apply to this request. Omit this parameter to use
+          # the model's default style. Supported values may expand over time. Values must be
+          # at most 64 characters.
+          personality: 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).
@@ -282,6 +317,11 @@ module OpenAI
               instructions: T.nilable(String),
               model: T.nilable(String),
               parallel_tool_calls: T.nilable(T::Boolean),
+              personality:
+                T.any(
+                  String,
+                  OpenAI::Responses::InputTokenCountParams::Personality::OrSymbol
+                ),
               previous_response_id: T.nilable(String),
               reasoning: T.nilable(OpenAI::Reasoning),
               text: T.nilable(OpenAI::Responses::InputTokenCountParams::Text),
@@ -383,6 +423,51 @@ module OpenAI
             )
         end
 
+        # A model-owned style preset to apply to this request. Omit this parameter to use
+        # the model's default style. Supported values may expand over time. Values must be
+        # at most 64 characters.
+        module Personality
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                OpenAI::Responses::InputTokenCountParams::Personality::TaggedSymbol
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::InputTokenCountParams::Personality::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::InputTokenCountParams::Personality
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FRIENDLY =
+            T.let(
+              :friendly,
+              OpenAI::Responses::InputTokenCountParams::Personality::TaggedSymbol
+            )
+          PRAGMATIC =
+            T.let(
+              :pragmatic,
+              OpenAI::Responses::InputTokenCountParams::Personality::TaggedSymbol
+            )
+        end
+
         class Text < OpenAI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/openai/models/responses/response.rbi

@@ -202,6 +202,14 @@ module OpenAI
         # prompt caching, which keeps cached prefixes active for longer, up to a maximum
         # of 24 hours.
         # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+        #
+        # For older models that support both `in_memory` and `24h`, the default depends on
+        # your organization's data retention policy:
+        #
+        # - Organizations without ZDR enabled default to `24h`.
+        # - Organizations with ZDR enabled default to `in_memory` when
+        #   `prompt_cache_retention` is not specified.
         sig do
           returns(
             T.nilable(
@@ -345,6 +353,7 @@ module OpenAI
                   OpenAI::Responses::ResponseReasoningItem::OrHash,
                   OpenAI::Responses::ResponseToolSearchCall::OrHash,
                   OpenAI::Responses::ResponseToolSearchOutputItem::OrHash,
+                  OpenAI::Responses::ResponseOutputItem::AdditionalTools::OrHash,
                   OpenAI::Responses::ResponseCompactionItem::OrHash,
                   OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::OrHash,
                   OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
@@ -530,6 +539,14 @@ module OpenAI
           # prompt caching, which keeps cached prefixes active for longer, up to a maximum
           # of 24 hours.
           # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+          # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+          #
+          # For older models that support both `in_memory` and `24h`, the default depends on
+          # your organization's data retention policy:
+          #
+          # - Organizations without ZDR enabled default to `24h`.
+          # - Organizations with ZDR enabled default to `in_memory` when
+          #   `prompt_cache_retention` is not specified.
           prompt_cache_retention: nil,
           # **gpt-5 and o-series models only**
           #
@@ -828,6 +845,14 @@ module OpenAI
         # prompt caching, which keeps cached prefixes active for longer, up to a maximum
         # of 24 hours.
         # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+        #
+        # For older models that support both `in_memory` and `24h`, the default depends on
+        # your organization's data retention policy:
+        #
+        # - Organizations without ZDR enabled default to `24h`.
+        # - Organizations with ZDR enabled default to `in_memory` when
+        #   `prompt_cache_retention` is not specified.
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/responses/response_create_params.rbi

@@ -189,6 +189,14 @@ module OpenAI
         # prompt caching, which keeps cached prefixes active for longer, up to a maximum
         # of 24 hours.
         # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+        #
+        # For older models that support both `in_memory` and `24h`, the default depends on
+        # your organization's data retention policy:
+        #
+        # - Organizations without ZDR enabled default to `24h`.
+        # - Organizations with ZDR enabled default to `in_memory` when
+        #   `prompt_cache_retention` is not specified.
         sig do
           returns(
             T.nilable(
@@ -623,6 +631,14 @@ module OpenAI
           # prompt caching, which keeps cached prefixes active for longer, up to a maximum
           # of 24 hours.
           # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+          # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+          #
+          # For older models that support both `in_memory` and `24h`, the default depends on
+          # your organization's data retention policy:
+          #
+          # - Organizations without ZDR enabled default to `24h`.
+          # - Organizations with ZDR enabled default to `in_memory` when
+          #   `prompt_cache_retention` is not specified.
           prompt_cache_retention: nil,
           # **gpt-5 and o-series models only**
           #
@@ -910,6 +926,14 @@ module OpenAI
         # prompt caching, which keeps cached prefixes active for longer, up to a maximum
         # of 24 hours.
         # [Learn more](https://platform.openai.com/docs/guides/prompt-caching#prompt-cache-retention).
+        # For `gpt-5.5`, `gpt-5.5-pro`, and future models, only `24h` is supported.
+        #
+        # For older models that support both `in_memory` and `24h`, the default depends on
+        # your organization's data retention policy:
+        #
+        # - Organizations without ZDR enabled default to `24h`.
+        # - Organizations with ZDR enabled default to `in_memory` when
+        #   `prompt_cache_retention` is not specified.
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/responses/response_function_web_search.rbi

@@ -113,10 +113,6 @@ module OpenAI
                 )
               end
 
-            # [DEPRECATED] The search query.
-            sig { returns(String) }
-            attr_accessor :query
-
             # The action type.
             sig { returns(Symbol) }
             attr_accessor :type
@@ -128,6 +124,13 @@ module OpenAI
             sig { params(queries: T::Array[String]).void }
             attr_writer :queries
 
+            # The search query.
+            sig { returns(T.nilable(String)) }
+            attr_reader :query
+
+            sig { params(query: String).void }
+            attr_writer :query
+
             # The sources used in the search.
             sig do
               returns(
@@ -153,8 +156,8 @@ module OpenAI
             # Action type "search" - Performs a web search query.
             sig do
               params(
-                query: String,
                 queries: T::Array[String],
+                query: String,
                 sources:
                   T::Array[
                     OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source::OrHash
@@ -163,10 +166,10 @@ module OpenAI
               ).returns(T.attached_class)
             end
             def self.new(
-              # [DEPRECATED] The search query.
-              query:,
               # The search queries.
               queries: nil,
+              # The search query.
+              query: nil,
               # The sources used in the search.
               sources: nil,
               # The action type.
@@ -177,9 +180,9 @@ module OpenAI
             sig do
               override.returns(
                 {
-                  query: String,
                   type: Symbol,
                   queries: T::Array[String],
+                  query: String,
                   sources:
                     T::Array[
                       OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source

data/rbi/openai/models/responses/response_input_item.rbi

@@ -25,6 +25,7 @@ module OpenAI
               OpenAI::Responses::ResponseInputItem::FunctionCallOutput,
               OpenAI::Responses::ResponseInputItem::ToolSearchCall,
               OpenAI::Responses::ResponseToolSearchOutputItemParam,
+              OpenAI::Responses::ResponseInputItem::AdditionalTools,
               OpenAI::Responses::ResponseReasoningItem,
               OpenAI::Responses::ResponseCompactionItemParam,
               OpenAI::Responses::ResponseInputItem::ImageGenerationCall,
@@ -834,6 +835,125 @@ module OpenAI
           end
         end
 
+        class AdditionalTools < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponseInputItem::AdditionalTools,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The role that provided the additional tools. Only `developer` is supported.
+          sig { returns(Symbol) }
+          attr_accessor :role
+
+          # A list of additional tools made available at this item.
+          sig do
+            returns(
+              T::Array[
+                T.any(
+                  OpenAI::Responses::FunctionTool,
+                  OpenAI::Responses::FileSearchTool,
+                  OpenAI::Responses::ComputerTool,
+                  OpenAI::Responses::ComputerUsePreviewTool,
+                  OpenAI::Responses::Tool::Mcp,
+                  OpenAI::Responses::Tool::CodeInterpreter,
+                  OpenAI::Responses::Tool::ImageGeneration,
+                  OpenAI::Responses::Tool::LocalShell,
+                  OpenAI::Responses::FunctionShellTool,
+                  OpenAI::Responses::CustomTool,
+                  OpenAI::Responses::NamespaceTool,
+                  OpenAI::Responses::ToolSearchTool,
+                  OpenAI::Responses::ApplyPatchTool,
+                  OpenAI::Responses::WebSearchTool,
+                  OpenAI::Responses::WebSearchPreviewTool
+                )
+              ]
+            )
+          end
+          attr_accessor :tools
+
+          # The item type. Always `additional_tools`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # The unique ID of this additional tools item.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :id
+
+          sig do
+            params(
+              tools:
+                T::Array[
+                  T.any(
+                    OpenAI::Responses::FunctionTool::OrHash,
+                    OpenAI::Responses::FileSearchTool::OrHash,
+                    OpenAI::Responses::ComputerTool::OrHash,
+                    OpenAI::Responses::ComputerUsePreviewTool::OrHash,
+                    OpenAI::Responses::Tool::Mcp::OrHash,
+                    OpenAI::Responses::Tool::CodeInterpreter::OrHash,
+                    OpenAI::Responses::Tool::ImageGeneration::OrHash,
+                    OpenAI::Responses::Tool::LocalShell::OrHash,
+                    OpenAI::Responses::FunctionShellTool::OrHash,
+                    OpenAI::Responses::CustomTool::OrHash,
+                    OpenAI::Responses::NamespaceTool::OrHash,
+                    OpenAI::Responses::ToolSearchTool::OrHash,
+                    OpenAI::Responses::ApplyPatchTool::OrHash,
+                    OpenAI::Responses::WebSearchTool::OrHash,
+                    OpenAI::Responses::WebSearchPreviewTool::OrHash
+                  )
+                ],
+              id: T.nilable(String),
+              role: Symbol,
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # A list of additional tools made available at this item.
+            tools:,
+            # The unique ID of this additional tools item.
+            id: nil,
+            # The role that provided the additional tools. Only `developer` is supported.
+            role: :developer,
+            # The item type. Always `additional_tools`.
+            type: :additional_tools
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                role: Symbol,
+                tools:
+                  T::Array[
+                    T.any(
+                      OpenAI::Responses::FunctionTool,
+                      OpenAI::Responses::FileSearchTool,
+                      OpenAI::Responses::ComputerTool,
+                      OpenAI::Responses::ComputerUsePreviewTool,
+                      OpenAI::Responses::Tool::Mcp,
+                      OpenAI::Responses::Tool::CodeInterpreter,
+                      OpenAI::Responses::Tool::ImageGeneration,
+                      OpenAI::Responses::Tool::LocalShell,
+                      OpenAI::Responses::FunctionShellTool,
+                      OpenAI::Responses::CustomTool,
+                      OpenAI::Responses::NamespaceTool,
+                      OpenAI::Responses::ToolSearchTool,
+                      OpenAI::Responses::ApplyPatchTool,
+                      OpenAI::Responses::WebSearchTool,
+                      OpenAI::Responses::WebSearchPreviewTool
+                    )
+                  ],
+                type: Symbol,
+                id: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
         class ImageGenerationCall < OpenAI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do