openai 0.67.0 → 0.69.0

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @type [OpenAI::Internal::Type::Converter]
+      BetaResponseInputMessageContentList =
+        OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Beta::BetaResponseInputContent }]
+    end
+
+    # @type [OpenAI::Internal::Type::Converter]
+    BetaResponseInputMessageContentList = Beta::BetaResponseInputMessageContentList
+  end
+end

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

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseInputMessageItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the message input.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute content
+        #   A list of one or many input items to the model, containing different content
+        #   types.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>]
+        required :content, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseInputContent] }
+
+        # @!attribute role
+        #   The role of the message input. One of `user`, `system`, or `developer`.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseInputMessageItem::Role]
+        required :role, enum: -> { OpenAI::Beta::BetaResponseInputMessageItem::Role }
+
+        # @!attribute type
+        #   The type of the message input. Always set to `message`.
+        #
+        #   @return [Symbol, :message]
+        required :type, const: :message
+
+        # @!attribute agent
+        #   The agent that produced this item.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseInputMessageItem::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseInputMessageItem::Agent }, nil?: true
+
+        # @!attribute status
+        #   The status of item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are returned via API.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseInputMessageItem::Status, nil]
+        optional :status, enum: -> { OpenAI::Beta::BetaResponseInputMessageItem::Status }
+
+        # @!method initialize(id:, content:, role:, agent: nil, status: nil, type: :message)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseInputMessageItem} for more details.
+        #
+        #   @param id [String] The unique ID of the message input.
+        #
+        #   @param content [Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>] A list of one or many input items to the model, containing different content
+        #
+        #   @param role [Symbol, OpenAI::Models::Beta::BetaResponseInputMessageItem::Role] The role of the message input. One of `user`, `system`, or `developer`.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseInputMessageItem::Agent, nil] The agent that produced this item.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseInputMessageItem::Status] The status of item. One of `in_progress`, `completed`, or
+        #
+        #   @param type [Symbol, :message] The type of the message input. Always set to `message`.
+
+        # The role of the message input. One of `user`, `system`, or `developer`.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseInputMessageItem#role
+        module Role
+          extend OpenAI::Internal::Type::Enum
+
+          USER = :user
+          SYSTEM = :system
+          DEVELOPER = :developer
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseInputMessageItem#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that produced this item.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+
+        # The status of item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseInputMessageItem#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS = :in_progress
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaResponseInputMessageItem = Beta::BetaResponseInputMessageItem
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseInputText < OpenAI::Internal::Type::BaseModel
+        # @!attribute text
+        #   The text input to the model.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #   The type of the input item. Always `input_text`.
+        #
+        #   @return [Symbol, :input_text]
+        required :type, const: :input_text
+
+        # @!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::BetaResponseInputText::PromptCacheBreakpoint, nil]
+        optional :prompt_cache_breakpoint, -> { OpenAI::Beta::BetaResponseInputText::PromptCacheBreakpoint }
+
+        # @!method initialize(text:, prompt_cache_breakpoint: nil, type: :input_text)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseInputText} for more details.
+        #
+        #   A text input to the model.
+        #
+        #   @param text [String] The text input to the model.
+        #
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Beta::BetaResponseInputText::PromptCacheBreakpoint] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #
+        #   @param type [Symbol, :input_text] The type of the input item. Always `input_text`.
+
+        # @see OpenAI::Models::Beta::BetaResponseInputText#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
+
+    BetaResponseInputText = Beta::BetaResponseInputText
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseInputTextContent < OpenAI::Internal::Type::BaseModel
+        # @!attribute text
+        #   The text input to the model.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #   The type of the input item. Always `input_text`.
+        #
+        #   @return [Symbol, :input_text]
+        required :type, const: :input_text
+
+        # @!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::BetaResponseInputTextContent::PromptCacheBreakpoint, nil]
+        optional :prompt_cache_breakpoint,
+                 -> { OpenAI::Beta::BetaResponseInputTextContent::PromptCacheBreakpoint },
+                 nil?: true
+
+        # @!method initialize(text:, prompt_cache_breakpoint: nil, type: :input_text)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseInputTextContent} for more details.
+        #
+        #   A text input to the model.
+        #
+        #   @param text [String] The text input to the model.
+        #
+        #   @param prompt_cache_breakpoint [OpenAI::Models::Beta::BetaResponseInputTextContent::PromptCacheBreakpoint, nil] Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #
+        #   @param type [Symbol, :input_text] The type of the input item. Always `input_text`.
+
+        # @see OpenAI::Models::Beta::BetaResponseInputTextContent#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
+
+    BetaResponseInputTextContent = Beta::BetaResponseInputTextContent
+  end
+end