openai 0.29.0 → 0.30.0

data/rbi/openai/models/beta/chatkit/thread_list_items_params.rbi

@@ -0,0 +1,138 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ThreadListItemsParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ThreadListItemsParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # List items created after this thread item ID. Defaults to null for the first
+          # page.
+          sig { returns(T.nilable(String)) }
+          attr_reader :after
+
+          sig { params(after: String).void }
+          attr_writer :after
+
+          # List items created before this thread item ID. Defaults to null for the newest
+          # results.
+          sig { returns(T.nilable(String)) }
+          attr_reader :before
+
+          sig { params(before: String).void }
+          attr_writer :before
+
+          # Maximum number of thread items to return. Defaults to 20.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :limit
+
+          sig { params(limit: Integer).void }
+          attr_writer :limit
+
+          # Sort order for results by creation time. Defaults to `desc`.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Beta::ChatKit::ThreadListItemsParams::Order::OrSymbol
+              )
+            )
+          end
+          attr_reader :order
+
+          sig do
+            params(
+              order:
+                OpenAI::Beta::ChatKit::ThreadListItemsParams::Order::OrSymbol
+            ).void
+          end
+          attr_writer :order
+
+          sig do
+            params(
+              after: String,
+              before: String,
+              limit: Integer,
+              order:
+                OpenAI::Beta::ChatKit::ThreadListItemsParams::Order::OrSymbol,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # List items created after this thread item ID. Defaults to null for the first
+            # page.
+            after: nil,
+            # List items created before this thread item ID. Defaults to null for the newest
+            # results.
+            before: nil,
+            # Maximum number of thread items to return. Defaults to 20.
+            limit: nil,
+            # Sort order for results by creation time. Defaults to `desc`.
+            order: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                after: String,
+                before: String,
+                limit: Integer,
+                order:
+                  OpenAI::Beta::ChatKit::ThreadListItemsParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Sort order for results by creation time. Defaults to `desc`.
+          module Order
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Beta::ChatKit::ThreadListItemsParams::Order
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ASC =
+              T.let(
+                :asc,
+                OpenAI::Beta::ChatKit::ThreadListItemsParams::Order::TaggedSymbol
+              )
+            DESC =
+              T.let(
+                :desc,
+                OpenAI::Beta::ChatKit::ThreadListItemsParams::Order::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Beta::ChatKit::ThreadListItemsParams::Order::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/chatkit/thread_list_params.rbi

@@ -0,0 +1,145 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      module ChatKit
+        class ThreadListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKit::ThreadListParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # List items created after this thread item ID. Defaults to null for the first
+          # page.
+          sig { returns(T.nilable(String)) }
+          attr_reader :after
+
+          sig { params(after: String).void }
+          attr_writer :after
+
+          # List items created before this thread item ID. Defaults to null for the newest
+          # results.
+          sig { returns(T.nilable(String)) }
+          attr_reader :before
+
+          sig { params(before: String).void }
+          attr_writer :before
+
+          # Maximum number of thread items to return. Defaults to 20.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :limit
+
+          sig { params(limit: Integer).void }
+          attr_writer :limit
+
+          # Sort order for results by creation time. Defaults to `desc`.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Beta::ChatKit::ThreadListParams::Order::OrSymbol
+              )
+            )
+          end
+          attr_reader :order
+
+          sig do
+            params(
+              order: OpenAI::Beta::ChatKit::ThreadListParams::Order::OrSymbol
+            ).void
+          end
+          attr_writer :order
+
+          # Filter threads that belong to this user identifier. Defaults to null to return
+          # all users.
+          sig { returns(T.nilable(String)) }
+          attr_reader :user
+
+          sig { params(user: String).void }
+          attr_writer :user
+
+          sig do
+            params(
+              after: String,
+              before: String,
+              limit: Integer,
+              order: OpenAI::Beta::ChatKit::ThreadListParams::Order::OrSymbol,
+              user: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # List items created after this thread item ID. Defaults to null for the first
+            # page.
+            after: nil,
+            # List items created before this thread item ID. Defaults to null for the newest
+            # results.
+            before: nil,
+            # Maximum number of thread items to return. Defaults to 20.
+            limit: nil,
+            # Sort order for results by creation time. Defaults to `desc`.
+            order: nil,
+            # Filter threads that belong to this user identifier. Defaults to null to return
+            # all users.
+            user: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                after: String,
+                before: String,
+                limit: Integer,
+                order: OpenAI::Beta::ChatKit::ThreadListParams::Order::OrSymbol,
+                user: String,
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Sort order for results by creation time. Defaults to `desc`.
+          module Order
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Beta::ChatKit::ThreadListParams::Order)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ASC =
+              T.let(
+                :asc,
+                OpenAI::Beta::ChatKit::ThreadListParams::Order::TaggedSymbol
+              )
+            DESC =
+              T.let(
+                :desc,
+                OpenAI::Beta::ChatKit::ThreadListParams::Order::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Beta::ChatKit::ThreadListParams::Order::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/chatkit/thread_retrieve_params.rbi

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

data/rbi/openai/models/beta/chatkit_upload_file_params.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      class ChatKitUploadFileParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::ChatKitUploadFileParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Binary file contents to store with the ChatKit session. Supports PDFs and PNG,
+        # JPG, JPEG, GIF, or WEBP images.
+        sig { returns(OpenAI::Internal::FileInput) }
+        attr_accessor :file
+
+        sig do
+          params(
+            file: OpenAI::Internal::FileInput,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Binary file contents to store with the ChatKit session. Supports PDFs and PNG,
+          # JPG, JPEG, GIF, or WEBP images.
+          file:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              file: OpenAI::Internal::FileInput,
+              request_options: OpenAI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/chatkit_upload_file_response.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      # Represents either a file or image attachment.
+      module ChatKitUploadFileResponse
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(OpenAI::Beta::FilePart, OpenAI::Beta::ImagePart)
+          end
+
+        sig do
+          override.returns(
+            T::Array[OpenAI::Models::Beta::ChatKitUploadFileResponse::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/chatkit_workflow.rbi

@@ -0,0 +1,134 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      class ChatKitWorkflow < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Beta::ChatKitWorkflow, OpenAI::Internal::AnyHash)
+          end
+
+        # Identifier of the workflow backing the session.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # State variable key-value pairs applied when invoking the workflow. Defaults to
+        # null when no overrides were provided.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                OpenAI::Beta::ChatKitWorkflow::StateVariable::Variants
+              ]
+            )
+          )
+        end
+        attr_accessor :state_variables
+
+        # Tracing settings applied to the workflow.
+        sig { returns(OpenAI::Beta::ChatKitWorkflow::Tracing) }
+        attr_reader :tracing
+
+        sig do
+          params(tracing: OpenAI::Beta::ChatKitWorkflow::Tracing::OrHash).void
+        end
+        attr_writer :tracing
+
+        # Specific workflow version used for the session. Defaults to null when using the
+        # latest deployment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :version
+
+        # Workflow metadata and state returned for the session.
+        sig do
+          params(
+            id: String,
+            state_variables:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  OpenAI::Beta::ChatKitWorkflow::StateVariable::Variants
+                ]
+              ),
+            tracing: OpenAI::Beta::ChatKitWorkflow::Tracing::OrHash,
+            version: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Identifier of the workflow backing the session.
+          id:,
+          # State variable key-value pairs applied when invoking the workflow. Defaults to
+          # null when no overrides were provided.
+          state_variables:,
+          # Tracing settings applied to the workflow.
+          tracing:,
+          # Specific workflow version used for the session. Defaults to null when using the
+          # latest deployment.
+          version:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              state_variables:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    OpenAI::Beta::ChatKitWorkflow::StateVariable::Variants
+                  ]
+                ),
+              tracing: OpenAI::Beta::ChatKitWorkflow::Tracing,
+              version: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module StateVariable
+          extend OpenAI::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, T::Boolean, Float) }
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Beta::ChatKitWorkflow::StateVariable::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        class Tracing < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::ChatKitWorkflow::Tracing,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Indicates whether tracing is enabled.
+          sig { returns(T::Boolean) }
+          attr_accessor :enabled
+
+          # Tracing settings applied to the workflow.
+          sig { params(enabled: T::Boolean).returns(T.attached_class) }
+          def self.new(
+            # Indicates whether tracing is enabled.
+            enabled:
+          )
+          end
+
+          sig { override.returns({ enabled: T::Boolean }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/file_part.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      class FilePart < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Beta::FilePart, OpenAI::Internal::AnyHash)
+          end
+
+        # Unique identifier for the uploaded file.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # MIME type reported for the uploaded file. Defaults to null when unknown.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :mime_type
+
+        # Original filename supplied by the uploader. Defaults to null when unnamed.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # Type discriminator that is always `file`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Signed URL for downloading the uploaded file. Defaults to null when no download
+        # link is available.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :upload_url
+
+        # Metadata for a non-image file uploaded through ChatKit.
+        sig do
+          params(
+            id: String,
+            mime_type: T.nilable(String),
+            name: T.nilable(String),
+            upload_url: T.nilable(String),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for the uploaded file.
+          id:,
+          # MIME type reported for the uploaded file. Defaults to null when unknown.
+          mime_type:,
+          # Original filename supplied by the uploader. Defaults to null when unnamed.
+          name:,
+          # Signed URL for downloading the uploaded file. Defaults to null when no download
+          # link is available.
+          upload_url:,
+          # Type discriminator that is always `file`.
+          type: :file
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              mime_type: T.nilable(String),
+              name: T.nilable(String),
+              type: Symbol,
+              upload_url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/image_part.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Beta
+      class ImagePart < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Beta::ImagePart, OpenAI::Internal::AnyHash)
+          end
+
+        # Unique identifier for the uploaded image.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # MIME type of the uploaded image.
+        sig { returns(String) }
+        attr_accessor :mime_type
+
+        # Original filename for the uploaded image. Defaults to null when unnamed.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # Preview URL that can be rendered inline for the image.
+        sig { returns(String) }
+        attr_accessor :preview_url
+
+        # Type discriminator that is always `image`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Signed URL for downloading the uploaded image. Defaults to null when no download
+        # link is available.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :upload_url
+
+        # Metadata for an image uploaded through ChatKit.
+        sig do
+          params(
+            id: String,
+            mime_type: String,
+            name: T.nilable(String),
+            preview_url: String,
+            upload_url: T.nilable(String),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for the uploaded image.
+          id:,
+          # MIME type of the uploaded image.
+          mime_type:,
+          # Original filename for the uploaded image. Defaults to null when unnamed.
+          name:,
+          # Preview URL that can be rendered inline for the image.
+          preview_url:,
+          # Signed URL for downloading the uploaded image. Defaults to null when no download
+          # link is available.
+          upload_url:,
+          # Type discriminator that is always `image`.
+          type: :image
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              mime_type: String,
+              name: T.nilable(String),
+              preview_url: String,
+              type: Symbol,
+              upload_url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end