openai 0.111.0 → 0.112.0

data/lib/openai/models/live/decision_system_message.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class DecisionSystemMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The text input to the model.
+        #
+        #   @return [String, Array<OpenAI::Models::Live::DecisionInputText>]
+        required :content, union: -> { OpenAI::Live::DecisionSystemMessage::Content }
+
+        # @!attribute role
+        #
+        #   @return [Symbol, :system]
+        required :role, const: :system
+
+        # @!attribute id
+        #   The unique ID of this message item.
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [Symbol, OpenAI::Models::Live::DecisionSystemMessage::Type, nil]
+        optional :type, enum: -> { OpenAI::Live::DecisionSystemMessage::Type }
+
+        # @!method initialize(content:, id: nil, type: nil, role: :system)
+        #   @param content [String, Array<OpenAI::Models::Live::DecisionInputText>]
+        #     The text input to the model.
+        #
+        #   @param id [String, nil]
+        #     The unique ID of this message item.
+        #
+        #   @param type [Symbol, OpenAI::Models::Live::DecisionSystemMessage::Type]
+        #
+        #   @param role [Symbol, :system]
+
+        # The text input to the model.
+        #
+        # @see OpenAI::Models::Live::DecisionSystemMessage#content
+        module Content
+          extend OpenAI::Internal::Type::Union
+
+          # The text input to the model.
+          variant String
+
+          variant -> { OpenAI::Models::Live::DecisionSystemMessage::Content::DecisionInputTextArray }
+
+          # @!method self.variants
+          #   @return [Array(String, Array<OpenAI::Models::Live::DecisionInputText>)]
+
+          # @type [OpenAI::Internal::Type::Converter]
+          DecisionInputTextArray = OpenAI::Internal::Type::ArrayOf[-> { OpenAI::Live::DecisionInputText }]
+        end
+
+        # @see OpenAI::Models::Live::DecisionSystemMessage#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          MESSAGE = :message
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/live/decision_trigger.rb

@@ -32,273 +32,21 @@ module OpenAI
 
         # @see OpenAI::Models::Live::DecisionTrigger#decisions
         class Decisions < OpenAI::Internal::Type::BaseModel
+          require_relative "decision_question"
+          Question = ::OpenAI::Models::Live::DecisionQuestion
+
           # @!attribute questions
           #   Native Decision API questions evaluated together, in order.
           #
-          #   @return [Array<OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Predicate, OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Choice, OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Score>]
-          required(
-            :questions,
-            -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Live::DecisionTrigger::Decisions::Question] }
-          )
+          #   @return [Array<OpenAI::Models::Live::DecisionQuestion::Choice, OpenAI::Models::Live::DecisionQuestion::Predicate, OpenAI::Models::Live::DecisionQuestion::Score>]
+          required :questions, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Live::DecisionQuestion] }
 
           # @!method initialize(questions:)
           #   Questions evaluated using the current transcript and the session's shared
           #   Decision items.
           #
-          #   @param questions [Array<OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Predicate, OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Choice, OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Score>]
+          #   @param questions [Array<OpenAI::Models::Live::DecisionQuestion::Choice, OpenAI::Models::Live::DecisionQuestion::Predicate, OpenAI::Models::Live::DecisionQuestion::Score>]
           #     Native Decision API questions evaluated together, in order.
-
-          # A question about the request's input, with an optional correlation name.
-          module Question
-            extend OpenAI::Internal::Type::Union
-
-            discriminator :type
-
-            # Estimate how likely it is that a statement about the input is true.
-            variant :predicate, -> { OpenAI::Live::DecisionTrigger::Decisions::Question::Predicate }
-
-            # Choose from the supplied options based on the input.
-            variant :choice, -> { OpenAI::Live::DecisionTrigger::Decisions::Question::Choice }
-
-            # Rate the input against the supplied ordered levels.
-            variant :score, -> { OpenAI::Live::DecisionTrigger::Decisions::Question::Score }
-
-            class Predicate < OpenAI::Internal::Type::BaseModel
-              # @!attribute instructions
-              #
-              #   @return [String, Array<OpenAI::Models::DecisionQuestionInputText, OpenAI::Models::DecisionQuestionInputImage, OpenAI::Models::DecisionInputJSON>]
-              required(
-                :instructions,
-                union: -> { OpenAI::Live::DecisionTrigger::Decisions::Question::Predicate::Instructions }
-              )
-
-              # @!attribute type
-              #   The type of the object. Always `predicate`.
-              #
-              #   @return [Symbol, :predicate]
-              required :type, const: :predicate
-
-              # @!attribute name
-              #
-              #   @return [String, nil]
-              optional :name, String
-
-              # @!method initialize(instructions:, name: nil, type: :predicate)
-              #   Estimate how likely it is that a statement about the input is true.
-              #
-              #   @param instructions [String, Array<OpenAI::Models::DecisionQuestionInputText, OpenAI::Models::DecisionQuestionInputImage, OpenAI::Models::DecisionInputJSON>]
-              #
-              #   @param name [String]
-              #
-              #   @param type [Symbol, :predicate]
-              #     The type of the object. Always `predicate`.
-
-              # @see OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Predicate#instructions
-              module Instructions
-                extend OpenAI::Internal::Type::Union
-
-                variant String
-
-                variant(
-                  -> {
-                    OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Predicate::Instructions::DecisionQuestionInputPartArray
-                  }
-                )
-
-                # @!method self.variants
-                #   @return [Array(String, Array<OpenAI::Models::DecisionQuestionInputText, OpenAI::Models::DecisionQuestionInputImage, OpenAI::Models::DecisionInputJSON>)]
-
-                # @type [OpenAI::Internal::Type::Converter]
-                DecisionQuestionInputPartArray = OpenAI::Internal::Type::ArrayOf[
-                  union: -> { OpenAI::DecisionQuestionInputPart }
-                ]
-              end
-            end
-
-            class Choice < OpenAI::Internal::Type::BaseModel
-              # @!attribute choices
-              #   Provide between 2 and 255 choices. Each choice must be unique.
-              #
-              #   @return [Array<OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Choice::Choice>]
-              required(
-                :choices,
-                -> {
-                  OpenAI::Internal::Type::ArrayOf[OpenAI::Live::DecisionTrigger::Decisions::Question::Choice::Choice]
-                }
-              )
-
-              # @!attribute instructions
-              #
-              #   @return [String, Array<OpenAI::Models::DecisionQuestionInputText, OpenAI::Models::DecisionQuestionInputImage, OpenAI::Models::DecisionInputJSON>]
-              required(
-                :instructions,
-                union: -> { OpenAI::Live::DecisionTrigger::Decisions::Question::Choice::Instructions }
-              )
-
-              # @!attribute type
-              #   The type of the object. Always `choice`.
-              #
-              #   @return [Symbol, :choice]
-              required :type, const: :choice
-
-              # @!attribute name
-              #
-              #   @return [String, nil]
-              optional :name, String
-
-              # @!method initialize(choices:, instructions:, name: nil, type: :choice)
-              #   Choose from the supplied options based on the input.
-              #
-              #   @param choices [Array<OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Choice::Choice>]
-              #     Provide between 2 and 255 choices. Each choice must be unique.
-              #
-              #   @param instructions [String, Array<OpenAI::Models::DecisionQuestionInputText, OpenAI::Models::DecisionQuestionInputImage, OpenAI::Models::DecisionInputJSON>]
-              #
-              #   @param name [String]
-              #
-              #   @param type [Symbol, :choice]
-              #     The type of the object. Always `choice`.
-              class Choice < OpenAI::Internal::Type::BaseModel
-                # @!attribute value
-                #   Choice values are typed: a string and a boolean with the same text are distinct.
-                #
-                #   @return [String, Boolean]
-                required(
-                  :value,
-                  union: -> { OpenAI::Live::DecisionTrigger::Decisions::Question::Choice::Choice::Value }
-                )
-
-                # @!attribute description
-                #
-                #   @return [String, nil]
-                optional :description, String
-
-                # @!method initialize(value:, description: nil)
-                #   @param value [String, Boolean]
-                #     Choice values are typed: a string and a boolean with the same text are distinct.
-                #
-                #   @param description [String]
-
-                # Choice values are typed: a string and a boolean with the same text are distinct.
-                #
-                # @see OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Choice::Choice#value
-                module Value
-                  extend OpenAI::Internal::Type::Union
-
-                  variant String
-
-                  variant OpenAI::Internal::Type::Boolean
-
-                  # @!method self.variants
-                  #   @return [Array(String, Boolean)]
-                end
-              end
-
-              # @see OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Choice#instructions
-              module Instructions
-                extend OpenAI::Internal::Type::Union
-
-                variant String
-
-                variant(
-                  -> {
-                    OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Choice::Instructions::DecisionQuestionInputPartArray
-                  }
-                )
-
-                # @!method self.variants
-                #   @return [Array(String, Array<OpenAI::Models::DecisionQuestionInputText, OpenAI::Models::DecisionQuestionInputImage, OpenAI::Models::DecisionInputJSON>)]
-
-                # @type [OpenAI::Internal::Type::Converter]
-                DecisionQuestionInputPartArray = OpenAI::Internal::Type::ArrayOf[
-                  union: -> { OpenAI::DecisionQuestionInputPart }
-                ]
-              end
-            end
-
-            class Score < OpenAI::Internal::Type::BaseModel
-              # @!attribute instructions
-              #
-              #   @return [String, Array<OpenAI::Models::DecisionQuestionInputText, OpenAI::Models::DecisionQuestionInputImage, OpenAI::Models::DecisionInputJSON>]
-              required(
-                :instructions,
-                union: -> { OpenAI::Live::DecisionTrigger::Decisions::Question::Score::Instructions }
-              )
-
-              # @!attribute levels
-              #
-              #   @return [Array<OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Score::Level>]
-              required(
-                :levels,
-                -> {
-                  OpenAI::Internal::Type::ArrayOf[OpenAI::Live::DecisionTrigger::Decisions::Question::Score::Level]
-                }
-              )
-
-              # @!attribute type
-              #   The type of the object. Always `score`.
-              #
-              #   @return [Symbol, :score]
-              required :type, const: :score
-
-              # @!attribute name
-              #
-              #   @return [String, nil]
-              optional :name, String
-
-              # @!method initialize(instructions:, levels:, name: nil, type: :score)
-              #   Rate the input against the supplied ordered levels.
-              #
-              #   @param instructions [String, Array<OpenAI::Models::DecisionQuestionInputText, OpenAI::Models::DecisionQuestionInputImage, OpenAI::Models::DecisionInputJSON>]
-              #
-              #   @param levels [Array<OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Score::Level>]
-              #
-              #   @param name [String]
-              #
-              #   @param type [Symbol, :score]
-              #     The type of the object. Always `score`.
-
-              # @see OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Score#instructions
-              module Instructions
-                extend OpenAI::Internal::Type::Union
-
-                variant String
-
-                variant(
-                  -> {
-                    OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Score::Instructions::DecisionQuestionInputPartArray
-                  }
-                )
-
-                # @!method self.variants
-                #   @return [Array(String, Array<OpenAI::Models::DecisionQuestionInputText, OpenAI::Models::DecisionQuestionInputImage, OpenAI::Models::DecisionInputJSON>)]
-
-                # @type [OpenAI::Internal::Type::Converter]
-                DecisionQuestionInputPartArray = OpenAI::Internal::Type::ArrayOf[
-                  union: -> { OpenAI::DecisionQuestionInputPart }
-                ]
-              end
-
-              class Level < OpenAI::Internal::Type::BaseModel
-                # @!attribute label
-                #
-                #   @return [String]
-                required :label, String
-
-                # @!attribute description
-                #
-                #   @return [String, nil]
-                optional :description, String
-
-                # @!method initialize(label:, description: nil)
-                #   @param label [String]
-                #   @param description [String]
-              end
-            end
-
-            # @!method self.variants
-            #   @return [Array(OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Predicate, OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Choice, OpenAI::Models::Live::DecisionTrigger::Decisions::Question::Score)]
-          end
         end
 
         # @see OpenAI::Models::Live::DecisionTrigger#event_type

data/lib/openai/models/live/decision_user_message.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Live
+      class DecisionUserMessage < OpenAI::Internal::Type::BaseModel
+        # @!attribute content
+        #   The text input to the model.
+        #
+        #   @return [String, Array<OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputText, OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputImage, OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputJSON>]
+        required :content, union: -> { OpenAI::Live::DecisionUserMessage::Content }
+
+        # @!attribute role
+        #   The message role. Always `user`.
+        #
+        #   @return [Symbol, :user]
+        required :role, const: :user
+
+        # @!attribute id
+        #   The unique ID of this message item.
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [Symbol, OpenAI::Models::Live::DecisionUserMessage::Type, nil]
+        optional :type, enum: -> { OpenAI::Live::DecisionUserMessage::Type }
+
+        # @!method initialize(content:, id: nil, type: nil, role: :user)
+        #   @param content [String, Array<OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputText, OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputImage, OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputJSON>]
+        #     The text input to the model.
+        #
+        #   @param id [String, nil]
+        #     The unique ID of this message item.
+        #
+        #   @param type [Symbol, OpenAI::Models::Live::DecisionUserMessage::Type]
+        #
+        #   @param role [Symbol, :user]
+        #     The message role. Always `user`.
+
+        # The text input to the model.
+        #
+        # @see OpenAI::Models::Live::DecisionUserMessage#content
+        module Content
+          extend OpenAI::Internal::Type::Union
+
+          # The text input to the model.
+          variant String
+
+          variant -> { OpenAI::Models::Live::DecisionUserMessage::Content::PartsArray }
+
+          module Part
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            variant :input_text, -> { OpenAI::Live::DecisionUserMessage::Content::Part::InputText }
+
+            variant :input_image, -> { OpenAI::Live::DecisionUserMessage::Content::Part::InputImage }
+
+            variant :input_json, -> { OpenAI::Live::DecisionUserMessage::Content::Part::InputJSON }
+
+            class InputText < OpenAI::Internal::Type::BaseModel
+              # @!attribute text
+              #   The text input to the model.
+              #
+              #   @return [String]
+              required :text, String
+
+              # @!attribute type
+              #
+              #   @return [Symbol, :input_text]
+              required :type, const: :input_text
+
+              # @!method initialize(text:, type: :input_text)
+              #   @param text [String]
+              #     The text input to the model.
+              #
+              #   @param type [Symbol, :input_text]
+            end
+
+            class InputImage < OpenAI::Internal::Type::BaseModel
+              # @!attribute image_url
+              #   A base64-encoded image data URL or a publicly accessible HTTP(S) image URL.
+              #
+              #   @return [String]
+              required :image_url, String
+
+              # @!attribute type
+              #
+              #   @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::Live::DecisionUserMessage::Content::Part::InputImage::Detail, nil]
+              optional(
+                :detail,
+                enum: -> { OpenAI::Live::DecisionUserMessage::Content::Part::InputImage::Detail },
+                nil?: true
+              )
+
+              # @!method initialize(image_url:, detail: nil, type: :input_image)
+              #   @param image_url [String]
+              #     A base64-encoded image data URL or a publicly accessible HTTP(S) image URL.
+              #
+              #   @param detail [Symbol, OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputImage::Detail, nil]
+              #     The detail level of the image to be sent to the model. One of `high`, `low`,
+              #     `auto`, or `original`. Defaults to `auto`.
+              #
+              #   @param type [Symbol, :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::Live::DecisionUserMessage::Content::Part::InputImage#detail
+              module Detail
+                extend OpenAI::Internal::Type::Enum
+
+                LOW = :low
+                HIGH = :high
+                AUTO = :auto
+                ORIGINAL = :original
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class InputJSON < OpenAI::Internal::Type::BaseModel
+              # @!attribute data
+              #
+              #   @return [Hash{Symbol=>Object}, Array<Hash{Symbol=>Object}>]
+              required :data, union: -> { OpenAI::Live::DecisionUserMessage::Content::Part::InputJSON::Data }
+
+              # @!attribute type
+              #
+              #   @return [Symbol, :input_json]
+              required :type, const: :input_json
+
+              # @!method initialize(data:, type: :input_json)
+              #   @param data [Hash{Symbol=>Object}, Array<Hash{Symbol=>Object}>]
+              #   @param type [Symbol, :input_json]
+
+              # @see OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputJSON#data
+              module Data
+                extend OpenAI::Internal::Type::Union
+
+                variant OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+
+                variant(
+                  -> {
+                    OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputJSON::Data::DecisionJSONObjectArray
+                  }
+                )
+
+                # @!method self.variants
+                #   @return [Array(Hash{Symbol=>Object}, Array<Hash{Symbol=>Object}>)]
+
+                # @type [OpenAI::Internal::Type::Converter]
+                DecisionJSONObjectArray = OpenAI::Internal::Type::ArrayOf[
+                  OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+                ]
+              end
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputText, OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputImage, OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputJSON)]
+          end
+
+          # @!method self.variants
+          #   @return [Array(String, Array<OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputText, OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputImage, OpenAI::Models::Live::DecisionUserMessage::Content::Part::InputJSON>)]
+
+          # @type [OpenAI::Internal::Type::Converter]
+          PartsArray = OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Live::DecisionUserMessage::Content::Part }]
+        end
+
+        # @see OpenAI::Models::Live::DecisionUserMessage#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          MESSAGE = :message
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end