openai 0.18.1 → 0.19.0

data/rbi/openai/models/conversations/top_log_prob.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class TopLogProb < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Conversations::TopLogProb, OpenAI::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :token
+
+        sig { returns(T::Array[Integer]) }
+        attr_accessor :bytes
+
+        sig { returns(Float) }
+        attr_accessor :logprob
+
+        sig do
+          params(
+            token: String,
+            bytes: T::Array[Integer],
+            logprob: Float
+          ).returns(T.attached_class)
+        end
+        def self.new(token:, bytes:, logprob:)
+        end
+
+        sig do
+          override.returns(
+            { token: String, bytes: T::Array[Integer], logprob: Float }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/url_citation_body.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class URLCitationBody < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::URLCitationBody,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The index of the last character of the URL citation in the message.
+        sig { returns(Integer) }
+        attr_accessor :end_index
+
+        # The index of the first character of the URL citation in the message.
+        sig { returns(Integer) }
+        attr_accessor :start_index
+
+        # The title of the web resource.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The type of the URL citation. Always `url_citation`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The URL of the web resource.
+        sig { returns(String) }
+        attr_accessor :url
+
+        sig do
+          params(
+            end_index: Integer,
+            start_index: Integer,
+            title: String,
+            url: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The index of the last character of the URL citation in the message.
+          end_index:,
+          # The index of the first character of the URL citation in the message.
+          start_index:,
+          # The title of the web resource.
+          title:,
+          # The URL of the web resource.
+          url:,
+          # The type of the URL citation. Always `url_citation`.
+          type: :url_citation
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              end_index: Integer,
+              start_index: Integer,
+              title: String,
+              type: Symbol,
+              url: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/evals/create_eval_completions_run_data_source.rbi

@@ -441,7 +441,7 @@ module OpenAI
                 T::Array[
                   T.any(
                     OpenAI::Responses::EasyInputMessage,
-                    OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message
+                    OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem
                   )
                 ]
               )
@@ -458,7 +458,7 @@ module OpenAI
                   T::Array[
                     T.any(
                       OpenAI::Responses::EasyInputMessage::OrHash,
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::OrHash
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::OrHash
                     )
                   ],
                 type: Symbol
@@ -480,7 +480,7 @@ module OpenAI
                     T::Array[
                       T.any(
                         OpenAI::Responses::EasyInputMessage,
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem
                       )
                     ],
                   type: Symbol
@@ -502,15 +502,15 @@ module OpenAI
                 T.type_alias do
                   T.any(
                     OpenAI::Responses::EasyInputMessage,
-                    OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message
+                    OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem
                   )
                 end
 
-              class Message < OpenAI::Internal::Type::BaseModel
+              class EvalItem < OpenAI::Internal::Type::BaseModel
                 OrHash =
                   T.type_alias do
                     T.any(
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message,
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem,
                       OpenAI::Internal::AnyHash
                     )
                   end
@@ -521,8 +521,8 @@ module OpenAI
                     T.any(
                       String,
                       OpenAI::Responses::ResponseInputText,
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::OutputText,
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::InputImage,
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText,
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage,
                       T::Array[T.anything]
                     )
                   )
@@ -533,7 +533,7 @@ module OpenAI
                 # `developer`.
                 sig do
                   returns(
-                    OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Role::OrSymbol
+                    OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role::OrSymbol
                   )
                 end
                 attr_accessor :role
@@ -542,7 +542,7 @@ module OpenAI
                 sig do
                   returns(
                     T.nilable(
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Type::OrSymbol
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type::OrSymbol
                     )
                   )
                 end
@@ -551,7 +551,7 @@ module OpenAI
                 sig do
                   params(
                     type:
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Type::OrSymbol
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type::OrSymbol
                   ).void
                 end
                 attr_writer :type
@@ -567,14 +567,14 @@ module OpenAI
                       T.any(
                         String,
                         OpenAI::Responses::ResponseInputText::OrHash,
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::OutputText::OrHash,
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::InputImage::OrHash,
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText::OrHash,
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage::OrHash,
                         T::Array[T.anything]
                       ),
                     role:
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Role::OrSymbol,
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role::OrSymbol,
                     type:
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Type::OrSymbol
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type::OrSymbol
                   ).returns(T.attached_class)
                 end
                 def self.new(
@@ -595,14 +595,14 @@ module OpenAI
                         T.any(
                           String,
                           OpenAI::Responses::ResponseInputText,
-                          OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::OutputText,
-                          OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::InputImage,
+                          OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText,
+                          OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage,
                           T::Array[T.anything]
                         ),
                       role:
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Role::OrSymbol,
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role::OrSymbol,
                       type:
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Type::OrSymbol
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type::OrSymbol
                     }
                   )
                 end
@@ -618,8 +618,8 @@ module OpenAI
                       T.any(
                         String,
                         OpenAI::Responses::ResponseInputText,
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::OutputText,
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::InputImage,
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText,
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage,
                         T::Array[T.anything]
                       )
                     end
@@ -628,7 +628,7 @@ module OpenAI
                     OrHash =
                       T.type_alias do
                         T.any(
-                          OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::OutputText,
+                          OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::OutputText,
                           OpenAI::Internal::AnyHash
                         )
                       end
@@ -664,7 +664,7 @@ module OpenAI
                     OrHash =
                       T.type_alias do
                         T.any(
-                          OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::InputImage,
+                          OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::InputImage,
                           OpenAI::Internal::AnyHash
                         )
                       end
@@ -716,7 +716,7 @@ module OpenAI
                   sig do
                     override.returns(
                       T::Array[
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Content::Variants
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Content::Variants
                       ]
                     )
                   end
@@ -741,7 +741,7 @@ module OpenAI
                     T.type_alias do
                       T.all(
                         Symbol,
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Role
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role
                       )
                     end
                   OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -749,28 +749,28 @@ module OpenAI
                   USER =
                     T.let(
                       :user,
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Role::TaggedSymbol
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role::TaggedSymbol
                     )
                   ASSISTANT =
                     T.let(
                       :assistant,
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Role::TaggedSymbol
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role::TaggedSymbol
                     )
                   SYSTEM =
                     T.let(
                       :system,
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Role::TaggedSymbol
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role::TaggedSymbol
                     )
                   DEVELOPER =
                     T.let(
                       :developer,
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Role::TaggedSymbol
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role::TaggedSymbol
                     )
 
                   sig do
                     override.returns(
                       T::Array[
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Role::TaggedSymbol
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Role::TaggedSymbol
                       ]
                     )
                   end
@@ -786,7 +786,7 @@ module OpenAI
                     T.type_alias do
                       T.all(
                         Symbol,
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Type
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type
                       )
                     end
                   OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -794,13 +794,13 @@ module OpenAI
                   MESSAGE =
                     T.let(
                       :message,
-                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Type::TaggedSymbol
+                      OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type::TaggedSymbol
                     )
 
                   sig do
                     override.returns(
                       T::Array[
-                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::Message::Type::TaggedSymbol
+                        OpenAI::Evals::CreateEvalCompletionsRunDataSource::InputMessages::Template::Template::EvalItem::Type::TaggedSymbol
                       ]
                     )
                   end

data/rbi/openai/models/responses/input_item_list_params.rbi

@@ -22,13 +22,6 @@ module OpenAI
         sig { params(after: String).void }
         attr_writer :after
 
-        # An item ID to list items before, used in pagination.
-        sig { returns(T.nilable(String)) }
-        attr_reader :before
-
-        sig { params(before: String).void }
-        attr_writer :before
-
         # Additional fields to include in the response. See the `include` parameter for
         # Response creation above for more information.
         sig do
@@ -74,7 +67,6 @@ module OpenAI
         sig do
           params(
             after: String,
-            before: String,
             include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
             limit: Integer,
             order: OpenAI::Responses::InputItemListParams::Order::OrSymbol,
@@ -84,8 +76,6 @@ module OpenAI
         def self.new(
           # An item ID to list items after, used in pagination.
           after: nil,
-          # An item ID to list items before, used in pagination.
-          before: nil,
           # Additional fields to include in the response. See the `include` parameter for
           # Response creation above for more information.
           include: nil,
@@ -105,7 +95,6 @@ module OpenAI
           override.returns(
             {
               after: String,
-              before: String,
               include:
                 T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
               limit: Integer,

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

@@ -136,6 +136,19 @@ module OpenAI
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :background
 
+        # The conversation that this response belongs to. Input items and output items
+        # from this response are automatically added to this conversation.
+        sig { returns(T.nilable(OpenAI::Responses::Response::Conversation)) }
+        attr_reader :conversation
+
+        sig do
+          params(
+            conversation:
+              T.nilable(OpenAI::Responses::Response::Conversation::OrHash)
+          ).void
+        end
+        attr_writer :conversation
+
         # An upper bound for the number of tokens that can be generated for a response,
         # including visible output tokens and
         # [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
@@ -152,6 +165,7 @@ module OpenAI
         # 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).
+        # Cannot be used in conjunction with `conversation`.
         sig { returns(T.nilable(String)) }
         attr_accessor :previous_response_id
 
@@ -340,6 +354,8 @@ module OpenAI
               ],
             top_p: T.nilable(Float),
             background: T.nilable(T::Boolean),
+            conversation:
+              T.nilable(OpenAI::Responses::Response::Conversation::OrHash),
             max_output_tokens: T.nilable(Integer),
             max_tool_calls: T.nilable(Integer),
             previous_response_id: T.nilable(String),
@@ -432,6 +448,9 @@ module OpenAI
           # Whether to run the model response in the background.
           # [Learn more](https://platform.openai.com/docs/guides/background).
           background: nil,
+          # The conversation that this response belongs to. Input items and output items
+          # from this response are automatically added to this conversation.
+          conversation: nil,
           # An upper bound for the number of tokens that can be generated for a response,
           # including visible output tokens and
           # [reasoning tokens](https://platform.openai.com/docs/guides/reasoning).
@@ -444,6 +463,7 @@ module OpenAI
           # 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).
+          # Cannot be used in conjunction with `conversation`.
           previous_response_id: nil,
           # Reference to a prompt template and its variables.
           # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
@@ -534,6 +554,8 @@ module OpenAI
               tools: T::Array[OpenAI::Responses::Tool::Variants],
               top_p: T.nilable(Float),
               background: T.nilable(T::Boolean),
+              conversation:
+                T.nilable(OpenAI::Responses::Response::Conversation),
               max_output_tokens: T.nilable(Integer),
               max_tool_calls: T.nilable(Integer),
               previous_response_id: T.nilable(String),
@@ -707,6 +729,33 @@ module OpenAI
           end
         end
 
+        class Conversation < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::Response::Conversation,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the conversation.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The conversation that this response belongs to. Input items and output items
+          # from this response are automatically added to this conversation.
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The unique ID of the conversation.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
         # Specifies the processing type used for serving the request.
         #
         # - If set to 'auto', then the request will be processed with the service tier

data/rbi/openai/models/responses/response_conversation_param.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseConversationParam < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Responses::ResponseConversationParam,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the conversation.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The conversation that this response belongs to.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The unique ID of the conversation.
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,19 @@ module OpenAI
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :background
 
+        # The conversation that this response belongs to. Items from this conversation are
+        # prepended to `input_items` for this response request. Input items and output
+        # items from this response are automatically added to this conversation after this
+        # response completes.
+        sig do
+          returns(
+            T.nilable(
+              T.any(String, OpenAI::Responses::ResponseConversationParam)
+            )
+          )
+        end
+        attr_accessor :conversation
+
         # Specify additional output data to include in the model response. Currently
         # supported values are:
         #
@@ -133,6 +146,7 @@ module OpenAI
         # 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).
+        # Cannot be used in conjunction with `conversation`.
         sig { returns(T.nilable(String)) }
         attr_accessor :previous_response_id
 
@@ -385,6 +399,13 @@ module OpenAI
         sig do
           params(
             background: T.nilable(T::Boolean),
+            conversation:
+              T.nilable(
+                T.any(
+                  String,
+                  OpenAI::Responses::ResponseConversationParam::OrHash
+                )
+              ),
             include:
               T.nilable(
                 T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
@@ -454,6 +475,11 @@ module OpenAI
           # Whether to run the model response in the background.
           # [Learn more](https://platform.openai.com/docs/guides/background).
           background: nil,
+          # The conversation that this response belongs to. Items from this conversation are
+          # prepended to `input_items` for this response request. Input items and output
+          # items from this response are automatically added to this conversation after this
+          # response completes.
+          conversation: nil,
           # Specify additional output data to include in the model response. Currently
           # supported values are:
           #
@@ -514,6 +540,7 @@ module OpenAI
           # 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).
+          # Cannot be used in conjunction with `conversation`.
           previous_response_id: nil,
           # Reference to a prompt template and its variables.
           # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
@@ -617,6 +644,10 @@ module OpenAI
           override.returns(
             {
               background: T.nilable(T::Boolean),
+              conversation:
+                T.nilable(
+                  T.any(String, OpenAI::Responses::ResponseConversationParam)
+                ),
               include:
                 T.nilable(
                   T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
@@ -686,6 +717,29 @@ module OpenAI
         def to_hash
         end
 
+        # The conversation that this response belongs to. Items from this conversation are
+        # prepended to `input_items` for this response request. Input items and output
+        # items from this response are automatically added to this conversation after this
+        # response completes.
+        module Conversation
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(String, OpenAI::Responses::ResponseConversationParam)
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseCreateParams::Conversation::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
         # Text, image, or file inputs to the model, used to generate a response.
         #
         # Learn more: