openai 0.68.0 → 0.69.0

data/rbi/openai/models/beta/beta_response_input_file.rbi

@@ -0,0 +1,210 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseInputFile = Beta::BetaResponseInputFile
+
+    module Beta
+      class BetaResponseInputFile < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseInputFile,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The type of the input item. Always `input_file`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The detail level of the file to be sent to the model. Use `auto` to let the
+        # system select the detail level; for GPT-5.6 and later models, `auto` uses
+        # high-quality rendering, which may increase input token usage. Use `low` for
+        # lower-cost rendering, or `high` to render the file at higher quality. Defaults
+        # to `auto`.
+        sig do
+          returns(
+            T.nilable(OpenAI::Beta::BetaResponseInputFile::Detail::OrSymbol)
+          )
+        end
+        attr_reader :detail
+
+        sig do
+          params(
+            detail: OpenAI::Beta::BetaResponseInputFile::Detail::OrSymbol
+          ).void
+        end
+        attr_writer :detail
+
+        # The content of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_reader :file_data
+
+        sig { params(file_data: String).void }
+        attr_writer :file_data
+
+        # The ID of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :file_id
+
+        # The URL of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_reader :file_url
+
+        sig { params(file_url: String).void }
+        attr_writer :file_url
+
+        # The name of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_reader :filename
+
+        sig { params(filename: String).void }
+        attr_writer :filename
+
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseInputFile::PromptCacheBreakpoint
+            )
+          )
+        end
+        attr_reader :prompt_cache_breakpoint
+
+        sig do
+          params(
+            prompt_cache_breakpoint:
+              OpenAI::Beta::BetaResponseInputFile::PromptCacheBreakpoint::OrHash
+          ).void
+        end
+        attr_writer :prompt_cache_breakpoint
+
+        # A file input to the model.
+        sig do
+          params(
+            detail: OpenAI::Beta::BetaResponseInputFile::Detail::OrSymbol,
+            file_data: String,
+            file_id: T.nilable(String),
+            file_url: String,
+            filename: String,
+            prompt_cache_breakpoint:
+              OpenAI::Beta::BetaResponseInputFile::PromptCacheBreakpoint::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The detail level of the file to be sent to the model. Use `auto` to let the
+          # system select the detail level; for GPT-5.6 and later models, `auto` uses
+          # high-quality rendering, which may increase input token usage. Use `low` for
+          # lower-cost rendering, or `high` to render the file at higher quality. Defaults
+          # to `auto`.
+          detail: nil,
+          # The content of the file to be sent to the model.
+          file_data: nil,
+          # The ID of the file to be sent to the model.
+          file_id: nil,
+          # The URL of the file to be sent to the model.
+          file_url: nil,
+          # The name of the file to be sent to the model.
+          filename: nil,
+          # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+          # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+          # token block.
+          prompt_cache_breakpoint: nil,
+          # The type of the input item. Always `input_file`.
+          type: :input_file
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              type: Symbol,
+              detail: OpenAI::Beta::BetaResponseInputFile::Detail::OrSymbol,
+              file_data: String,
+              file_id: T.nilable(String),
+              file_url: String,
+              filename: String,
+              prompt_cache_breakpoint:
+                OpenAI::Beta::BetaResponseInputFile::PromptCacheBreakpoint
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The detail level of the file to be sent to the model. Use `auto` to let the
+        # system select the detail level; for GPT-5.6 and later models, `auto` uses
+        # high-quality rendering, which may increase input token usage. Use `low` for
+        # lower-cost rendering, or `high` to render the file at higher quality. Defaults
+        # to `auto`.
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Beta::BetaResponseInputFile::Detail)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AUTO =
+            T.let(
+              :auto,
+              OpenAI::Beta::BetaResponseInputFile::Detail::TaggedSymbol
+            )
+          LOW =
+            T.let(
+              :low,
+              OpenAI::Beta::BetaResponseInputFile::Detail::TaggedSymbol
+            )
+          HIGH =
+            T.let(
+              :high,
+              OpenAI::Beta::BetaResponseInputFile::Detail::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseInputFile::Detail::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseInputFile::PromptCacheBreakpoint,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The breakpoint mode. Always `explicit`.
+          sig { returns(Symbol) }
+          attr_accessor :mode
+
+          # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+          # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+          # token block.
+          sig { params(mode: Symbol).returns(T.attached_class) }
+          def self.new(
+            # The breakpoint mode. Always `explicit`.
+            mode: :explicit
+          )
+          end
+
+          sig { override.returns({ mode: Symbol }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_response_input_file_content.rbi

@@ -0,0 +1,211 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseInputFileContent = Beta::BetaResponseInputFileContent
+
+    module Beta
+      class BetaResponseInputFileContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseInputFileContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The type of the input item. Always `input_file`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The detail level of the file to be sent to the model. Use `auto` to let the
+        # system select the detail level; for GPT-5.6 and later models, `auto` uses
+        # high-quality rendering, which may increase input token usage. Use `low` for
+        # lower-cost rendering, or `high` to render the file at higher quality. Defaults
+        # to `auto`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseInputFileContent::Detail::OrSymbol
+            )
+          )
+        end
+        attr_reader :detail
+
+        sig do
+          params(
+            detail: OpenAI::Beta::BetaResponseInputFileContent::Detail::OrSymbol
+          ).void
+        end
+        attr_writer :detail
+
+        # The base64-encoded data of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :file_data
+
+        # The ID of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :file_id
+
+        # The URL of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :file_url
+
+        # The name of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :filename
+
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseInputFileContent::PromptCacheBreakpoint
+            )
+          )
+        end
+        attr_reader :prompt_cache_breakpoint
+
+        sig do
+          params(
+            prompt_cache_breakpoint:
+              T.nilable(
+                OpenAI::Beta::BetaResponseInputFileContent::PromptCacheBreakpoint::OrHash
+              )
+          ).void
+        end
+        attr_writer :prompt_cache_breakpoint
+
+        # A file input to the model.
+        sig do
+          params(
+            detail:
+              OpenAI::Beta::BetaResponseInputFileContent::Detail::OrSymbol,
+            file_data: T.nilable(String),
+            file_id: T.nilable(String),
+            file_url: T.nilable(String),
+            filename: T.nilable(String),
+            prompt_cache_breakpoint:
+              T.nilable(
+                OpenAI::Beta::BetaResponseInputFileContent::PromptCacheBreakpoint::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The detail level of the file to be sent to the model. Use `auto` to let the
+          # system select the detail level; for GPT-5.6 and later models, `auto` uses
+          # high-quality rendering, which may increase input token usage. Use `low` for
+          # lower-cost rendering, or `high` to render the file at higher quality. Defaults
+          # to `auto`.
+          detail: nil,
+          # The base64-encoded data of the file to be sent to the model.
+          file_data: nil,
+          # The ID of the file to be sent to the model.
+          file_id: nil,
+          # The URL of the file to be sent to the model.
+          file_url: nil,
+          # The name of the file to be sent to the model.
+          filename: nil,
+          # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+          # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+          # token block.
+          prompt_cache_breakpoint: nil,
+          # The type of the input item. Always `input_file`.
+          type: :input_file
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              type: Symbol,
+              detail:
+                OpenAI::Beta::BetaResponseInputFileContent::Detail::OrSymbol,
+              file_data: T.nilable(String),
+              file_id: T.nilable(String),
+              file_url: T.nilable(String),
+              filename: T.nilable(String),
+              prompt_cache_breakpoint:
+                T.nilable(
+                  OpenAI::Beta::BetaResponseInputFileContent::PromptCacheBreakpoint
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The detail level of the file to be sent to the model. Use `auto` to let the
+        # system select the detail level; for GPT-5.6 and later models, `auto` uses
+        # high-quality rendering, which may increase input token usage. Use `low` for
+        # lower-cost rendering, or `high` to render the file at higher quality. Defaults
+        # to `auto`.
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Beta::BetaResponseInputFileContent::Detail)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AUTO =
+            T.let(
+              :auto,
+              OpenAI::Beta::BetaResponseInputFileContent::Detail::TaggedSymbol
+            )
+          LOW =
+            T.let(
+              :low,
+              OpenAI::Beta::BetaResponseInputFileContent::Detail::TaggedSymbol
+            )
+          HIGH =
+            T.let(
+              :high,
+              OpenAI::Beta::BetaResponseInputFileContent::Detail::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseInputFileContent::Detail::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseInputFileContent::PromptCacheBreakpoint,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The breakpoint mode. Always `explicit`.
+          sig { returns(Symbol) }
+          attr_accessor :mode
+
+          # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+          # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+          # token block.
+          sig { params(mode: Symbol).returns(T.attached_class) }
+          def self.new(
+            # The breakpoint mode. Always `explicit`.
+            mode: :explicit
+          )
+          end
+
+          sig { override.returns({ mode: Symbol }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/beta_response_input_image.rbi

@@ -0,0 +1,173 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    BetaResponseInputImage = Beta::BetaResponseInputImage
+
+    module Beta
+      class BetaResponseInputImage < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Beta::BetaResponseInputImage,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The detail level of the image to be sent to the model. One of `high`, `low`,
+        # `auto`, or `original`. Defaults to `auto`.
+        sig { returns(OpenAI::Beta::BetaResponseInputImage::Detail::OrSymbol) }
+        attr_accessor :detail
+
+        # The type of the input item. Always `input_image`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The ID of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :file_id
+
+        # The URL of the image to be sent to the model. A fully qualified URL or base64
+        # encoded image in a data URL.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :image_url
+
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Beta::BetaResponseInputImage::PromptCacheBreakpoint
+            )
+          )
+        end
+        attr_reader :prompt_cache_breakpoint
+
+        sig do
+          params(
+            prompt_cache_breakpoint:
+              OpenAI::Beta::BetaResponseInputImage::PromptCacheBreakpoint::OrHash
+          ).void
+        end
+        attr_writer :prompt_cache_breakpoint
+
+        # An image input to the model. Learn about
+        # [image inputs](https://platform.openai.com/docs/guides/vision).
+        sig do
+          params(
+            detail: OpenAI::Beta::BetaResponseInputImage::Detail::OrSymbol,
+            file_id: T.nilable(String),
+            image_url: T.nilable(String),
+            prompt_cache_breakpoint:
+              OpenAI::Beta::BetaResponseInputImage::PromptCacheBreakpoint::OrHash,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The detail level of the image to be sent to the model. One of `high`, `low`,
+          # `auto`, or `original`. Defaults to `auto`.
+          detail:,
+          # The ID of the file to be sent to the model.
+          file_id: nil,
+          # The URL of the image to be sent to the model. A fully qualified URL or base64
+          # encoded image in a data URL.
+          image_url: nil,
+          # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+          # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+          # token block.
+          prompt_cache_breakpoint: nil,
+          # The type of the input item. Always `input_image`.
+          type: :input_image
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              detail: OpenAI::Beta::BetaResponseInputImage::Detail::OrSymbol,
+              type: Symbol,
+              file_id: T.nilable(String),
+              image_url: T.nilable(String),
+              prompt_cache_breakpoint:
+                OpenAI::Beta::BetaResponseInputImage::PromptCacheBreakpoint
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The detail level of the image to be sent to the model. One of `high`, `low`,
+        # `auto`, or `original`. Defaults to `auto`.
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Beta::BetaResponseInputImage::Detail)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOW =
+            T.let(
+              :low,
+              OpenAI::Beta::BetaResponseInputImage::Detail::TaggedSymbol
+            )
+          HIGH =
+            T.let(
+              :high,
+              OpenAI::Beta::BetaResponseInputImage::Detail::TaggedSymbol
+            )
+          AUTO =
+            T.let(
+              :auto,
+              OpenAI::Beta::BetaResponseInputImage::Detail::TaggedSymbol
+            )
+          ORIGINAL =
+            T.let(
+              :original,
+              OpenAI::Beta::BetaResponseInputImage::Detail::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Beta::BetaResponseInputImage::Detail::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Beta::BetaResponseInputImage::PromptCacheBreakpoint,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The breakpoint mode. Always `explicit`.
+          sig { returns(Symbol) }
+          attr_accessor :mode
+
+          # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+          # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+          # token block.
+          sig { params(mode: Symbol).returns(T.attached_class) }
+          def self.new(
+            # The breakpoint mode. Always `explicit`.
+            mode: :explicit
+          )
+          end
+
+          sig { override.returns({ mode: Symbol }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end