chore(api): openapi updates for conversations

stainless-app[bot] · stainless-app[bot] · commit ce76a591d8c5 · 2025-09-22T23:21:08.000Z
diff --git a/.stats.yml b/.stats.yml
@@ -1,4 +1,4 @@
 configured_endpoints: 118
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-65d42621b731238ad4e59a35a705fc0608b17f53a14d047e66ce480c793da26b.yml
-openapi_spec_hash: d7ca86b2507600cbd5ed197cf31263c2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-937fcfac8cbab692796cd9822b37e48a311e2220a8b103106ded0ee92a0b9484.yml
+openapi_spec_hash: 74a0c58b5b8c4e06792d79b685e02a01
 config_hash: 666d6bb4b564f0d9d431124b5d1a0665
diff --git a/lib/openai/models/conversations/conversation_create_params.rb b/lib/openai/models/conversations/conversation_create_params.rb
@@ -32,7 +32,7 @@ class ConversationCreateParams < OpenAI::Internal::Type::BaseModel
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Conversations::ConversationCreateParams} for more details.
         #
-        #   @param items [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] Initial items to include in the conversation context.
+        #   @param items [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] Initial items to include in the conversation context. You may add up to 20 items
         #
         #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
         #
diff --git a/lib/openai/models/conversations/conversation_update_params.rb b/lib/openai/models/conversations/conversation_update_params.rb
@@ -11,18 +11,19 @@ class ConversationUpdateParams < OpenAI::Internal::Type::BaseModel
         # @!attribute metadata
         #   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
-        #   length of 64 characters. Values are strings with a maximum length of 512
-        #   characters.
+        #   querying for objects via API or the dashboard.
         #
-        #   @return [Hash{Symbol=>String}]
-        required :metadata, OpenAI::Internal::Type::HashOf[String]
+        #   Keys are strings with a maximum length of 64 characters. Values are strings with
+        #   a maximum length of 512 characters.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
 
         # @!method initialize(metadata:, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Conversations::ConversationUpdateParams} for more details.
         #
-        #   @param metadata [Hash{Symbol=>String}] Set of 16 key-value pairs that can be attached to an object. This can be
+        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end
diff --git a/lib/openai/resources/conversations.rb b/lib/openai/resources/conversations.rb
@@ -13,7 +13,7 @@ class Conversations
       #
       # @overload create(items: nil, metadata: nil, request_options: {})
       #
-      # @param items [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] Initial items to include in the conversation context.
+      # @param items [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] Initial items to include in the conversation context. You may add up to 20 items
       #
       # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
       #
@@ -33,7 +33,7 @@ def create(params = {})
         )
       end
 
-      # Get a conversation with the given ID.
+      # Get a conversation
       #
       # @overload retrieve(conversation_id, request_options: {})
       #
@@ -56,13 +56,13 @@ def retrieve(conversation_id, params = {})
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::Conversations::ConversationUpdateParams} for more details.
       #
-      # Update a conversation's metadata with the given ID.
+      # Update a conversation
       #
       # @overload update(conversation_id, metadata:, request_options: {})
       #
       # @param conversation_id [String] The ID of the conversation to update.
       #
-      # @param metadata [Hash{Symbol=>String}] Set of 16 key-value pairs that can be attached to an object. This can be
+      # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -80,7 +80,7 @@ def update(conversation_id, params)
         )
       end
 
-      # Delete a conversation with the given ID.
+      # Delete a conversation. Items in the conversation will not be deleted.
       #
       # @overload delete(conversation_id, request_options: {})
       #
diff --git a/rbi/openai/models/conversations/conversation_update_params.rbi b/rbi/openai/models/conversations/conversation_update_params.rbi
@@ -17,24 +17,26 @@ module OpenAI
 
         # 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
-        # length of 64 characters. Values are strings with a maximum length of 512
-        # characters.
-        sig { returns(T::Hash[Symbol, String]) }
+        # querying for objects via API or the dashboard.
+        #
+        # Keys are strings with a maximum length of 64 characters. Values are strings with
+        # a maximum length of 512 characters.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_accessor :metadata
 
         sig do
           params(
-            metadata: T::Hash[Symbol, String],
+            metadata: T.nilable(T::Hash[Symbol, String]),
             request_options: OpenAI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           # 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
-          # length of 64 characters. Values are strings with a maximum length of 512
-          # characters.
+          # querying for objects via API or the dashboard.
+          #
+          # Keys are strings with a maximum length of 64 characters. Values are strings with
+          # a maximum length of 512 characters.
           metadata:,
           request_options: {}
         )
@@ -43,7 +45,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              metadata: T::Hash[Symbol, String],
+              metadata: T.nilable(T::Hash[Symbol, String]),
               request_options: OpenAI::RequestOptions
             }
           )
diff --git a/rbi/openai/resources/conversations.rbi b/rbi/openai/resources/conversations.rbi
@@ -56,7 +56,7 @@ module OpenAI
       )
       end
 
-      # Get a conversation with the given ID.
+      # Get a conversation
       sig do
         params(
           conversation_id: String,
@@ -70,11 +70,11 @@ module OpenAI
       )
       end
 
-      # Update a conversation's metadata with the given ID.
+      # Update a conversation
       sig do
         params(
           conversation_id: String,
-          metadata: T::Hash[Symbol, String],
+          metadata: T.nilable(T::Hash[Symbol, String]),
           request_options: OpenAI::RequestOptions::OrHash
         ).returns(OpenAI::Conversations::Conversation)
       end
@@ -83,15 +83,16 @@ module OpenAI
         conversation_id,
         # 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
-        # length of 64 characters. Values are strings with a maximum length of 512
-        # characters.
+        # querying for objects via API or the dashboard.
+        #
+        # Keys are strings with a maximum length of 64 characters. Values are strings with
+        # a maximum length of 512 characters.
         metadata:,
         request_options: {}
       )
       end
 
-      # Delete a conversation with the given ID.
+      # Delete a conversation. Items in the conversation will not be deleted.
       sig do
         params(
           conversation_id: String,
diff --git a/sig/openai/models/conversations/conversation_update_params.rbs b/sig/openai/models/conversations/conversation_update_params.rbs
@@ -2,22 +2,22 @@ module OpenAI
   module Models
     module Conversations
       type conversation_update_params =
-        { metadata: ::Hash[Symbol, String] }
+        { metadata: OpenAI::Models::metadata? }
         & OpenAI::Internal::Type::request_parameters
 
       class ConversationUpdateParams < OpenAI::Internal::Type::BaseModel
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
-        attr_accessor metadata: ::Hash[Symbol, String]
+        attr_accessor metadata: OpenAI::Models::metadata?
 
         def initialize: (
-          metadata: ::Hash[Symbol, String],
+          metadata: OpenAI::Models::metadata?,
           ?request_options: OpenAI::request_opts
         ) -> void
 
         def to_hash: -> {
-          metadata: ::Hash[Symbol, String],
+          metadata: OpenAI::Models::metadata?,
           request_options: OpenAI::RequestOptions
         }
       end
diff --git a/sig/openai/resources/conversations.rbs b/sig/openai/resources/conversations.rbs
@@ -16,7 +16,7 @@ module OpenAI
 
       def update: (
         String conversation_id,
-        metadata: ::Hash[Symbol, String],
+        metadata: OpenAI::Models::metadata?,
         ?request_options: OpenAI::request_opts
       ) -> OpenAI::Conversations::Conversation
 

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class ConversationCreateParams < OpenAI::Internal::Type::BaseModel`
`32`	`32`	`# Some parameter documentations has been truncated, see`
`33`	`33`	`# {OpenAI::Models::Conversations::ConversationCreateParams} for more details.`
`34`	`34`	`#`
`35`		- # @param items [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] Initial items to include in the conversation context.
	`35`	+ # @param items [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] Initial items to include in the conversation context. You may add up to 20 items
`36`	`36`	`#`
`37`	`37`	`# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be`
`38`	`38`	`#`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class Conversations`
`13`	`13`	`#`
`14`	`14`	`# @overload create(items: nil, metadata: nil, request_options: {})`
`15`	`15`	`#`
`16`		- # @param items [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] Initial items to include in the conversation context.
	`16`	+ # @param items [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] Initial items to include in the conversation context. You may add up to 20 items
`17`	`17`	`#`
`18`	`18`	`# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be`
`19`	`19`	`#`
`@@ -33,7 +33,7 @@ def create(params = {})`
`33`	`33`	`)`
`34`	`34`	`end`
`35`	`35`
`36`		`- # Get a conversation with the given ID.`
	`36`	`+ # Get a conversation`
`37`	`37`	`#`
`38`	`38`	`# @overload retrieve(conversation_id, request_options: {})`
`39`	`39`	`#`
`@@ -56,13 +56,13 @@ def retrieve(conversation_id, params = {})`
`56`	`56`	`# Some parameter documentations has been truncated, see`
`57`	`57`	`# {OpenAI::Models::Conversations::ConversationUpdateParams} for more details.`
`58`	`58`	`#`
`59`		`- # Update a conversation's metadata with the given ID.`
	`59`	`+ # Update a conversation`
`60`	`60`	`#`
`61`	`61`	`# @overload update(conversation_id, metadata:, request_options: {})`
`62`	`62`	`#`
`63`	`63`	`# @param conversation_id [String] The ID of the conversation to update.`
`64`	`64`	`#`
`65`		`- # @param metadata [Hash{Symbol=>String}] Set of 16 key-value pairs that can be attached to an object. This can be`
	`65`	`+ # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be`
`66`	`66`	`#`
`67`	`67`	`# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]`
`68`	`68`	`#`
`@@ -80,7 +80,7 @@ def update(conversation_id, params)`
`80`	`80`	`)`
`81`	`81`	`end`
`82`	`82`
`83`		`- # Delete a conversation with the given ID.`
	`83`	`+ # Delete a conversation. Items in the conversation will not be deleted.`
`84`	`84`	`#`
`85`	`85`	`# @overload delete(conversation_id, request_options: {})`
`86`	`86`	`#`