openai 0.68.0 → 0.69.0

data/lib/openai/models/beta/beta_response_input_file.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseInputFile < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the input item. Always `input_file`.
+        #
+        #   @return [Symbol, :input_file]
+        required :type, const: :input_file
+
+        # @!attribute detail
+        #   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`.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseInputFile::Detail, nil]
+        optional :detail, enum: -> { OpenAI::Beta::BetaResponseInputFile::Detail }
+
+        # @!attribute file_data
+        #   The content of the file to be sent to the model.
+        #
+        #   @return [String, nil]
+        optional :file_data, String
+
+        # @!attribute file_id
+        #   The ID of the file to be sent to the model.
+        #
+        #   @return [String, nil]
+        optional :file_id, String, nil?: true
+
+        # @!attribute file_url
+        #   The URL of the file to be sent to the model.
+        #
+        #   @return [String, nil]
+        optional :file_url, String
+
+        # @!attribute filename
+        #   The name of the file to be sent to the model.
+        #
+        #   @return [String, nil]
+        optional :filename, String
+
+        # @!attribute prompt_cache_breakpoint
+        #   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.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseInputFile::PromptCacheBreakpoint, nil]
+        optional :prompt_cache_breakpoint, -> { OpenAI::Beta::BetaResponseInputFile::PromptCacheBreakpoint }
+
+        # @!method initialize(detail: nil, file_data: nil, file_id: nil, file_url: nil, filename: nil, prompt_cache_breakpoint: nil, type: :input_file)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseInputFile} for more details.
+        #
+        #   A file input to the model.
+        #
+        #   @param detail [Symbol, OpenAI::Models::Beta::BetaResponseInputFile::Detail] The detail level of the file to be sent to the model. Use `auto` to let the syst
+        #
+        #   @param file_data [String] The content of the file to be sent to the model.
+        #
+        #   @param file_id [String, nil] The ID of the file to be sent to the model.
+        #
+        #   @param file_url [String] The URL of the file to be sent to the model.
+        #
+        #   @param filename [String] The name of the file to be sent to the model.
+        #
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Beta::BetaResponseInputFile::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #
+        #   @param type [Symbol, :input_file] The type of the input item. Always `input_file`.
+
+        # 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`.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseInputFile#detail
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO = :auto
+          LOW = :low
+          HIGH = :high
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseInputFile#prompt_cache_breakpoint
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # @!attribute mode
+          #   The breakpoint mode. Always `explicit`.
+          #
+          #   @return [Symbol, :explicit]
+          required :mode, const: :explicit
+
+          # @!method initialize(mode: :explicit)
+          #   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.
+          #
+          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+        end
+      end
+    end
+
+    BetaResponseInputFile = Beta::BetaResponseInputFile
+  end
+end

data/lib/openai/models/beta/beta_response_input_file_content.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseInputFileContent < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the input item. Always `input_file`.
+        #
+        #   @return [Symbol, :input_file]
+        required :type, const: :input_file
+
+        # @!attribute detail
+        #   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`.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseInputFileContent::Detail, nil]
+        optional :detail, enum: -> { OpenAI::Beta::BetaResponseInputFileContent::Detail }
+
+        # @!attribute file_data
+        #   The base64-encoded data of the file to be sent to the model.
+        #
+        #   @return [String, nil]
+        optional :file_data, String, nil?: true
+
+        # @!attribute file_id
+        #   The ID of the file to be sent to the model.
+        #
+        #   @return [String, nil]
+        optional :file_id, String, nil?: true
+
+        # @!attribute file_url
+        #   The URL of the file to be sent to the model.
+        #
+        #   @return [String, nil]
+        optional :file_url, String, nil?: true
+
+        # @!attribute filename
+        #   The name of the file to be sent to the model.
+        #
+        #   @return [String, nil]
+        optional :filename, String, nil?: true
+
+        # @!attribute prompt_cache_breakpoint
+        #   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.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseInputFileContent::PromptCacheBreakpoint, nil]
+        optional :prompt_cache_breakpoint,
+                 -> { OpenAI::Beta::BetaResponseInputFileContent::PromptCacheBreakpoint },
+                 nil?: true
+
+        # @!method initialize(detail: nil, file_data: nil, file_id: nil, file_url: nil, filename: nil, prompt_cache_breakpoint: nil, type: :input_file)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseInputFileContent} for more details.
+        #
+        #   A file input to the model.
+        #
+        #   @param detail [Symbol, OpenAI::Models::Beta::BetaResponseInputFileContent::Detail] The detail level of the file to be sent to the model. Use `auto` to let the syst
+        #
+        #   @param file_data [String, nil] The base64-encoded data of the file to be sent to the model.
+        #
+        #   @param file_id [String, nil] The ID of the file to be sent to the model.
+        #
+        #   @param file_url [String, nil] The URL of the file to be sent to the model.
+        #
+        #   @param filename [String, nil] The name of the file to be sent to the model.
+        #
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Beta::BetaResponseInputFileContent::PromptCacheBreakpoint, nil] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #
+        #   @param type [Symbol, :input_file] The type of the input item. Always `input_file`.
+
+        # 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`.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseInputFileContent#detail
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO = :auto
+          LOW = :low
+          HIGH = :high
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseInputFileContent#prompt_cache_breakpoint
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # @!attribute mode
+          #   The breakpoint mode. Always `explicit`.
+          #
+          #   @return [Symbol, :explicit]
+          required :mode, const: :explicit
+
+          # @!method initialize(mode: :explicit)
+          #   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.
+          #
+          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+        end
+      end
+    end
+
+    BetaResponseInputFileContent = Beta::BetaResponseInputFileContent
+  end
+end

data/lib/openai/models/beta/beta_response_input_image.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseInputImage < OpenAI::Internal::Type::BaseModel
+        # @!attribute detail
+        #   The detail level of the image to be sent to the model. One of `high`, `low`,
+        #   `auto`, or `original`. Defaults to `auto`.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseInputImage::Detail]
+        required :detail, enum: -> { OpenAI::Beta::BetaResponseInputImage::Detail }
+
+        # @!attribute type
+        #   The type of the input item. Always `input_image`.
+        #
+        #   @return [Symbol, :input_image]
+        required :type, const: :input_image
+
+        # @!attribute file_id
+        #   The ID of the file to be sent to the model.
+        #
+        #   @return [String, nil]
+        optional :file_id, String, nil?: true
+
+        # @!attribute image_url
+        #   The URL of the image to be sent to the model. A fully qualified URL or base64
+        #   encoded image in a data URL.
+        #
+        #   @return [String, nil]
+        optional :image_url, String, nil?: true
+
+        # @!attribute prompt_cache_breakpoint
+        #   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.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseInputImage::PromptCacheBreakpoint, nil]
+        optional :prompt_cache_breakpoint, -> { OpenAI::Beta::BetaResponseInputImage::PromptCacheBreakpoint }
+
+        # @!method initialize(detail:, file_id: nil, image_url: nil, prompt_cache_breakpoint: nil, type: :input_image)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseInputImage} for more details.
+        #
+        #   An image input to the model. Learn about
+        #   [image inputs](https://platform.openai.com/docs/guides/vision).
+        #
+        #   @param detail [Symbol, OpenAI::Models::Beta::BetaResponseInputImage::Detail] The detail level of the image to be sent to the model. One of `high`, `low`, `au
+        #
+        #   @param file_id [String, nil] The ID of the file to be sent to the model.
+        #
+        #   @param image_url [String, nil] The URL of the image to be sent to the model. A fully qualified URL or base64 en
+        #
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Beta::BetaResponseInputImage::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #
+        #   @param type [Symbol, :input_image] The type of the input item. Always `input_image`.
+
+        # The detail level of the image to be sent to the model. One of `high`, `low`,
+        # `auto`, or `original`. Defaults to `auto`.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseInputImage#detail
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          LOW = :low
+          HIGH = :high
+          AUTO = :auto
+          ORIGINAL = :original
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseInputImage#prompt_cache_breakpoint
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # @!attribute mode
+          #   The breakpoint mode. Always `explicit`.
+          #
+          #   @return [Symbol, :explicit]
+          required :mode, const: :explicit
+
+          # @!method initialize(mode: :explicit)
+          #   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.
+          #
+          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+        end
+      end
+    end
+
+    BetaResponseInputImage = Beta::BetaResponseInputImage
+  end
+end

data/lib/openai/models/beta/beta_response_input_image_content.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseInputImageContent < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the input item. Always `input_image`.
+        #
+        #   @return [Symbol, :input_image]
+        required :type, const: :input_image
+
+        # @!attribute detail
+        #   The detail level of the image to be sent to the model. One of `high`, `low`,
+        #   `auto`, or `original`. Defaults to `auto`.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseInputImageContent::Detail, nil]
+        optional :detail, enum: -> { OpenAI::Beta::BetaResponseInputImageContent::Detail }, nil?: true
+
+        # @!attribute file_id
+        #   The ID of the file to be sent to the model.
+        #
+        #   @return [String, nil]
+        optional :file_id, String, nil?: true
+
+        # @!attribute image_url
+        #   The URL of the image to be sent to the model. A fully qualified URL or base64
+        #   encoded image in a data URL.
+        #
+        #   @return [String, nil]
+        optional :image_url, String, nil?: true
+
+        # @!attribute prompt_cache_breakpoint
+        #   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.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseInputImageContent::PromptCacheBreakpoint, nil]
+        optional :prompt_cache_breakpoint,
+                 -> { OpenAI::Beta::BetaResponseInputImageContent::PromptCacheBreakpoint },
+                 nil?: true
+
+        # @!method initialize(detail: nil, file_id: nil, image_url: nil, prompt_cache_breakpoint: nil, type: :input_image)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseInputImageContent} for more details.
+        #
+        #   An image input to the model. Learn about
+        #   [image inputs](https://platform.openai.com/docs/guides/vision)
+        #
+        #   @param detail [Symbol, OpenAI::Models::Beta::BetaResponseInputImageContent::Detail, nil] The detail level of the image to be sent to the model. One of `high`, `low`, `au
+        #
+        #   @param file_id [String, nil] The ID of the file to be sent to the model.
+        #
+        #   @param image_url [String, nil] The URL of the image to be sent to the model. A fully qualified URL or base64 en
+        #
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Beta::BetaResponseInputImageContent::PromptCacheBreakpoint, nil] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #
+        #   @param type [Symbol, :input_image] The type of the input item. Always `input_image`.
+
+        # The detail level of the image to be sent to the model. One of `high`, `low`,
+        # `auto`, or `original`. Defaults to `auto`.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseInputImageContent#detail
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          LOW = :low
+          HIGH = :high
+          AUTO = :auto
+          ORIGINAL = :original
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseInputImageContent#prompt_cache_breakpoint
+        class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # @!attribute mode
+          #   The breakpoint mode. Always `explicit`.
+          #
+          #   @return [Symbol, :explicit]
+          required :mode, const: :explicit
+
+          # @!method initialize(mode: :explicit)
+          #   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.
+          #
+          #   @param mode [Symbol, :explicit] The breakpoint mode. Always `explicit`.
+        end
+      end
+    end
+
+    BetaResponseInputImageContent = Beta::BetaResponseInputImageContent
+  end
+end