openai 0.1.0.pre.beta.2

data/rbi/openai/models/beta/threads/message_content.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module Threads
+        # References an image [File](https://platform.openai.com/docs/api-reference/files)
+        # in the content of a message.
+        module MessageContent
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::Threads::ImageFileContentBlock,
+                OpenAI::Beta::Threads::ImageURLContentBlock,
+                OpenAI::Beta::Threads::TextContentBlock,
+                OpenAI::Beta::Threads::RefusalContentBlock
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Beta::Threads::MessageContent::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/threads/message_content_delta.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module Threads
+        # References an image [File](https://platform.openai.com/docs/api-reference/files)
+        # in the content of a message.
+        module MessageContentDelta
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::Threads::ImageFileDeltaBlock,
+                OpenAI::Beta::Threads::TextDeltaBlock,
+                OpenAI::Beta::Threads::RefusalDeltaBlock,
+                OpenAI::Beta::Threads::ImageURLDeltaBlock
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Beta::Threads::MessageContentDelta::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/threads/message_content_part_param.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module Threads
+        # References an image [File](https://platform.openai.com/docs/api-reference/files)
+        # in the content of a message.
+        module MessageContentPartParam
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::Threads::ImageFileContentBlock,
+                OpenAI::Beta::Threads::ImageURLContentBlock,
+                OpenAI::Beta::Threads::TextContentBlockParam
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Beta::Threads::MessageContentPartParam::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/threads/message_create_params.rbi

@@ -0,0 +1,318 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module Threads
+        class MessageCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::Threads::MessageCreateParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The text contents of the message.
+          sig do
+            returns(
+              OpenAI::Beta::Threads::MessageCreateParams::Content::Variants
+            )
+          end
+          attr_accessor :content
+
+          # The role of the entity that is creating the message. Allowed values include:
+          #
+          # - `user`: Indicates the message is sent by an actual user and should be used in
+          #   most cases to represent user-generated messages.
+          # - `assistant`: Indicates the message is generated by the assistant. Use this
+          #   value to insert messages from the assistant into the conversation.
+          sig do
+            returns(OpenAI::Beta::Threads::MessageCreateParams::Role::OrSymbol)
+          end
+          attr_accessor :role
+
+          # A list of files attached to the message, and the tools they should be added to.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[OpenAI::Beta::Threads::MessageCreateParams::Attachment]
+              )
+            )
+          end
+          attr_accessor :attachments
+
+          # 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.nilable(T::Hash[Symbol, String])) }
+          attr_accessor :metadata
+
+          sig do
+            params(
+              content:
+                OpenAI::Beta::Threads::MessageCreateParams::Content::Variants,
+              role: OpenAI::Beta::Threads::MessageCreateParams::Role::OrSymbol,
+              attachments:
+                T.nilable(
+                  T::Array[
+                    OpenAI::Beta::Threads::MessageCreateParams::Attachment::OrHash
+                  ]
+                ),
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The text contents of the message.
+            content:,
+            # The role of the entity that is creating the message. Allowed values include:
+            #
+            # - `user`: Indicates the message is sent by an actual user and should be used in
+            #   most cases to represent user-generated messages.
+            # - `assistant`: Indicates the message is generated by the assistant. Use this
+            #   value to insert messages from the assistant into the conversation.
+            role:,
+            # A list of files attached to the message, and the tools they should be added to.
+            attachments: nil,
+            # 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.
+            metadata: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                content:
+                  OpenAI::Beta::Threads::MessageCreateParams::Content::Variants,
+                role:
+                  OpenAI::Beta::Threads::MessageCreateParams::Role::OrSymbol,
+                attachments:
+                  T.nilable(
+                    T::Array[
+                      OpenAI::Beta::Threads::MessageCreateParams::Attachment
+                    ]
+                  ),
+                metadata: T.nilable(T::Hash[Symbol, String]),
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The text contents of the message.
+          module Content
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  String,
+                  T::Array[
+                    OpenAI::Beta::Threads::MessageContentPartParam::Variants
+                  ]
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Beta::Threads::MessageCreateParams::Content::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+
+            MessageContentPartParamArray =
+              T.let(
+                OpenAI::Internal::Type::ArrayOf[
+                  union: OpenAI::Beta::Threads::MessageContentPartParam
+                ],
+                OpenAI::Internal::Type::Converter
+              )
+          end
+
+          # The role of the entity that is creating the message. Allowed values include:
+          #
+          # - `user`: Indicates the message is sent by an actual user and should be used in
+          #   most cases to represent user-generated messages.
+          # - `assistant`: Indicates the message is generated by the assistant. Use this
+          #   value to insert messages from the assistant into the conversation.
+          module Role
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Beta::Threads::MessageCreateParams::Role)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USER =
+              T.let(
+                :user,
+                OpenAI::Beta::Threads::MessageCreateParams::Role::TaggedSymbol
+              )
+            ASSISTANT =
+              T.let(
+                :assistant,
+                OpenAI::Beta::Threads::MessageCreateParams::Role::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Beta::Threads::MessageCreateParams::Role::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class Attachment < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Beta::Threads::MessageCreateParams::Attachment,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The ID of the file to attach to the message.
+            sig { returns(T.nilable(String)) }
+            attr_reader :file_id
+
+            sig { params(file_id: String).void }
+            attr_writer :file_id
+
+            # The tools to add this file to.
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::CodeInterpreterTool,
+                      OpenAI::Beta::Threads::MessageCreateParams::Attachment::Tool::FileSearch
+                    )
+                  ]
+                )
+              )
+            end
+            attr_reader :tools
+
+            sig do
+              params(
+                tools:
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::CodeInterpreterTool::OrHash,
+                      OpenAI::Beta::Threads::MessageCreateParams::Attachment::Tool::FileSearch::OrHash
+                    )
+                  ]
+              ).void
+            end
+            attr_writer :tools
+
+            sig do
+              params(
+                file_id: String,
+                tools:
+                  T::Array[
+                    T.any(
+                      OpenAI::Beta::CodeInterpreterTool::OrHash,
+                      OpenAI::Beta::Threads::MessageCreateParams::Attachment::Tool::FileSearch::OrHash
+                    )
+                  ]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The ID of the file to attach to the message.
+              file_id: nil,
+              # The tools to add this file to.
+              tools: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  file_id: String,
+                  tools:
+                    T::Array[
+                      T.any(
+                        OpenAI::Beta::CodeInterpreterTool,
+                        OpenAI::Beta::Threads::MessageCreateParams::Attachment::Tool::FileSearch
+                      )
+                    ]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module Tool
+              extend OpenAI::Internal::Type::Union
+
+              Variants =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Beta::CodeInterpreterTool,
+                    OpenAI::Beta::Threads::MessageCreateParams::Attachment::Tool::FileSearch
+                  )
+                end
+
+              class FileSearch < OpenAI::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      OpenAI::Beta::Threads::MessageCreateParams::Attachment::Tool::FileSearch,
+                      OpenAI::Internal::AnyHash
+                    )
+                  end
+
+                # The type of tool being defined: `file_search`
+                sig { returns(Symbol) }
+                attr_accessor :type
+
+                sig { params(type: Symbol).returns(T.attached_class) }
+                def self.new(
+                  # The type of tool being defined: `file_search`
+                  type: :file_search
+                )
+                end
+
+                sig { override.returns({ type: Symbol }) }
+                def to_hash
+                end
+              end
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Beta::Threads::MessageCreateParams::Attachment::Tool::Variants
+                  ]
+                )
+              end
+              def self.variants
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/threads/message_delete_params.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module Threads
+        class MessageDeleteParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::Threads::MessageDeleteParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :thread_id
+
+          sig do
+            params(
+              thread_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(thread_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { thread_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/threads/message_deleted.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module Threads
+        class MessageDeleted < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::Threads::MessageDeleted,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(T::Boolean) }
+          attr_accessor :deleted
+
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          sig do
+            params(id: String, deleted: T::Boolean, object: Symbol).returns(
+              T.attached_class
+            )
+          end
+          def self.new(id:, deleted:, object: :"thread.message.deleted")
+          end
+
+          sig do
+            override.returns(
+              { id: String, deleted: T::Boolean, object: Symbol }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/threads/message_delta.rbi

@@ -0,0 +1,128 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module Threads
+        class MessageDelta < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::Threads::MessageDelta,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The content of the message in array of text and/or images.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[OpenAI::Beta::Threads::MessageContentDelta::Variants]
+              )
+            )
+          end
+          attr_reader :content
+
+          sig do
+            params(
+              content:
+                T::Array[
+                  T.any(
+                    OpenAI::Beta::Threads::ImageFileDeltaBlock::OrHash,
+                    OpenAI::Beta::Threads::TextDeltaBlock::OrHash,
+                    OpenAI::Beta::Threads::RefusalDeltaBlock::OrHash,
+                    OpenAI::Beta::Threads::ImageURLDeltaBlock::OrHash
+                  )
+                ]
+            ).void
+          end
+          attr_writer :content
+
+          # The entity that produced the message. One of `user` or `assistant`.
+          sig do
+            returns(
+              T.nilable(OpenAI::Beta::Threads::MessageDelta::Role::TaggedSymbol)
+            )
+          end
+          attr_reader :role
+
+          sig do
+            params(
+              role: OpenAI::Beta::Threads::MessageDelta::Role::OrSymbol
+            ).void
+          end
+          attr_writer :role
+
+          # The delta containing the fields that have changed on the Message.
+          sig do
+            params(
+              content:
+                T::Array[
+                  T.any(
+                    OpenAI::Beta::Threads::ImageFileDeltaBlock::OrHash,
+                    OpenAI::Beta::Threads::TextDeltaBlock::OrHash,
+                    OpenAI::Beta::Threads::RefusalDeltaBlock::OrHash,
+                    OpenAI::Beta::Threads::ImageURLDeltaBlock::OrHash
+                  )
+                ],
+              role: OpenAI::Beta::Threads::MessageDelta::Role::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The content of the message in array of text and/or images.
+            content: nil,
+            # The entity that produced the message. One of `user` or `assistant`.
+            role: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                content:
+                  T::Array[
+                    OpenAI::Beta::Threads::MessageContentDelta::Variants
+                  ],
+                role: OpenAI::Beta::Threads::MessageDelta::Role::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The entity that produced the message. One of `user` or `assistant`.
+          module Role
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Beta::Threads::MessageDelta::Role)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USER =
+              T.let(
+                :user,
+                OpenAI::Beta::Threads::MessageDelta::Role::TaggedSymbol
+              )
+            ASSISTANT =
+              T.let(
+                :assistant,
+                OpenAI::Beta::Threads::MessageDelta::Role::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Beta::Threads::MessageDelta::Role::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/threads/message_delta_event.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module Threads
+        class MessageDeltaEvent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::Threads::MessageDeltaEvent,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The identifier of the message, which can be referenced in API endpoints.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The delta containing the fields that have changed on the Message.
+          sig { returns(OpenAI::Beta::Threads::MessageDelta) }
+          attr_reader :delta
+
+          sig do
+            params(delta: OpenAI::Beta::Threads::MessageDelta::OrHash).void
+          end
+          attr_writer :delta
+
+          # The object type, which is always `thread.message.delta`.
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # Represents a message delta i.e. any changed fields on a message during
+          # streaming.
+          sig do
+            params(
+              id: String,
+              delta: OpenAI::Beta::Threads::MessageDelta::OrHash,
+              object: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The identifier of the message, which can be referenced in API endpoints.
+            id:,
+            # The delta containing the fields that have changed on the Message.
+            delta:,
+            # The object type, which is always `thread.message.delta`.
+            object: :"thread.message.delta"
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                delta: OpenAI::Beta::Threads::MessageDelta,
+                object: Symbol
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end