vellum_ai 0.3.14 → 0.14.74

data/lib/vellum_ai/types/rich_text_child_block.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+require "json"
+require_relative "variable_prompt_block"
+require_relative "plain_text_prompt_block"
+
+module Vellum
+  class RichTextChildBlock
+
+
+# Deserialize a JSON object to an instance of RichTextChildBlock
+    #
+    # @param json_object [String] 
+    # @return [Vellum::RichTextChildBlock]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vellum::VariablePromptBlock.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::VariablePromptBlock.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::PlainTextPromptBlock.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::PlainTextPromptBlock.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+ return struct
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      begin
+        return Vellum::VariablePromptBlock.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::PlainTextPromptBlock.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/rich_text_prompt_block.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+require_relative "prompt_block_state"
+require_relative "ephemeral_prompt_cache_config"
+require_relative "rich_text_child_block"
+require "ostruct"
+require "json"
+
+module Vellum
+# A block that includes a combination of plain text and variable blocks.
+  class RichTextPromptBlock
+  # @return [String] 
+    attr_reader :block_type
+  # @return [Vellum::PromptBlockState] 
+    attr_reader :state
+  # @return [Vellum::EphemeralPromptCacheConfig] 
+    attr_reader :cache_config
+  # @return [Array<Vellum::RichTextChildBlock>] 
+    attr_reader :blocks
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param block_type [String] 
+    # @param state [Vellum::PromptBlockState] 
+    # @param cache_config [Vellum::EphemeralPromptCacheConfig] 
+    # @param blocks [Array<Vellum::RichTextChildBlock>] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::RichTextPromptBlock]
+    def initialize(block_type:, state: OMIT, cache_config: OMIT, blocks:, additional_properties: nil)
+      @block_type = block_type
+      @state = state if state != OMIT
+      @cache_config = cache_config if cache_config != OMIT
+      @blocks = blocks
+      @additional_properties = additional_properties
+      @_field_set = { "block_type": block_type, "state": state, "cache_config": cache_config, "blocks": blocks }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of RichTextPromptBlock
+    #
+    # @param json_object [String] 
+    # @return [Vellum::RichTextPromptBlock]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      block_type = parsed_json["block_type"]
+      state = parsed_json["state"]
+      unless parsed_json["cache_config"].nil?
+        cache_config = parsed_json["cache_config"].to_json
+        cache_config = Vellum::EphemeralPromptCacheConfig.from_json(json_object: cache_config)
+      else
+        cache_config = nil
+      end
+      blocks = parsed_json["blocks"]&.map do | item |
+  item = item.to_json
+  Vellum::RichTextChildBlock.from_json(json_object: item)
+end
+      new(
+        block_type: block_type,
+        state: state,
+        cache_config: cache_config,
+        blocks: blocks,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of RichTextPromptBlock to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.block_type.is_a?(String) != false || raise("Passed value for field obj.block_type is not the expected type, validation failed.")
+      obj.state&.is_a?(Vellum::PromptBlockState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      obj.cache_config.nil? || Vellum::EphemeralPromptCacheConfig.validate_raw(obj: obj.cache_config)
+      obj.blocks.is_a?(Array) != false || raise("Passed value for field obj.blocks is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/sandbox_scenario.rb

@@ -1,54 +1,70 @@
 # frozen_string_literal: true
-
 require_relative "scenario_input"
+require "ostruct"
 require "json"
 
 module Vellum
+# Sandbox Scenario
   class SandboxScenario
-    attr_reader :label, :inputs, :id, :additional_properties
+  # @return [String] 
+    attr_reader :label
+  # @return [Array<Vellum::ScenarioInput>] The inputs for the scenario
+    attr_reader :inputs
+  # @return [String] The id of the scenario
+    attr_reader :id
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
 
-    # @param label [String]
-    # @param inputs [Array<ScenarioInput>] The inputs for the scenario
+    # @param label [String] 
+    # @param inputs [Array<Vellum::ScenarioInput>] The inputs for the scenario
     # @param id [String] The id of the scenario
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [SandboxScenario]
-    def initialize(inputs:, id:, label: nil, additional_properties: nil)
-      # @type [String]
-      @label = label
-      # @type [Array<ScenarioInput>] The inputs for the scenario
+    # @return [Vellum::SandboxScenario]
+    def initialize(label: OMIT, inputs:, id:, additional_properties: nil)
+      @label = label if label != OMIT
       @inputs = inputs
-      # @type [String] The id of the scenario
       @id = id
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
+      @_field_set = { "label": label, "inputs": inputs, "id": id }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of SandboxScenario
+# Deserialize a JSON object to an instance of SandboxScenario
     #
-    # @param json_object [JSON]
-    # @return [SandboxScenario]
+    # @param json_object [String] 
+    # @return [Vellum::SandboxScenario]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      label = struct.label
-      inputs = parsed_json["inputs"].map do |v|
-        v = v.to_json
-        ScenarioInput.from_json(json_object: v)
-      end
-      id = struct.id
-      new(label: label, inputs: inputs, id: id, additional_properties: struct)
+      label = parsed_json["label"]
+      inputs = parsed_json["inputs"]&.map do | item |
+  item = item.to_json
+  Vellum::ScenarioInput.from_json(json_object: item)
+end
+      id = parsed_json["id"]
+      new(
+        label: label,
+        inputs: inputs,
+        id: id,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of SandboxScenario to a JSON object
+# Serialize an instance of SandboxScenario to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "label": @label, "inputs": @inputs, "id": @id }.to_json
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
     end
-
-    # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
     #
-    # @param obj [Object]
+    # @param obj [Object] 
     # @return [Void]
     def self.validate_raw(obj:)
       obj.label&.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
@@ -56,4 +72,4 @@ module Vellum
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/scenario_input.rb

@@ -1,70 +1,74 @@
 # frozen_string_literal: true
-
-require_relative "scenario_input_type_enum"
-require_relative "chat_message"
 require "json"
+require_relative "scenario_input_string_variable_value"
+require_relative "scenario_input_json_variable_value"
+require_relative "scenario_input_chat_history_variable_value"
 
 module Vellum
   class ScenarioInput
-    attr_reader :key, :type, :value, :chat_history, :additional_properties
 
-    # @param key [String]
-    # @param type [SCENARIO_INPUT_TYPE_ENUM]
-    # @param value [String]
-    # @param chat_history [Array<ChatMessage>]
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [ScenarioInput]
-    def initialize(key:, type: nil, value: nil, chat_history: nil, additional_properties: nil)
-      # @type [String]
-      @key = key
-      # @type [SCENARIO_INPUT_TYPE_ENUM]
-      @type = type
-      # @type [String]
-      @value = value
-      # @type [Array<ChatMessage>]
-      @chat_history = chat_history
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
-      @additional_properties = additional_properties
-    end
 
-    # Deserialize a JSON object to an instance of ScenarioInput
+# Deserialize a JSON object to an instance of ScenarioInput
     #
-    # @param json_object [JSON]
-    # @return [ScenarioInput]
+    # @param json_object [String] 
+    # @return [Vellum::ScenarioInput]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      key = struct.key
-      type = SCENARIO_INPUT_TYPE_ENUM.key(parsed_json["type"]) || parsed_json["type"]
-      value = struct.value
-      chat_history = parsed_json["chat_history"].map do |v|
-        v = v.to_json
-        ChatMessage.from_json(json_object: v)
+      begin
+        Vellum::ScenarioInputStringVariableValue.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ScenarioInputStringVariableValue.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
       end
-      new(key: key, type: type, value: value, chat_history: chat_history, additional_properties: struct)
-    end
-
-    # Serialize an instance of ScenarioInput to a JSON object
-    #
-    # @return [JSON]
-    def to_json(*_args)
-      {
-        "key": @key,
-        "type": SCENARIO_INPUT_TYPE_ENUM[@type] || @type,
-        "value": @value,
-        "chat_history": @chat_history
-      }.to_json
+      begin
+        Vellum::ScenarioInputJsonVariableValue.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ScenarioInputJsonVariableValue.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::ScenarioInputChatHistoryVariableValue.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ScenarioInputChatHistoryVariableValue.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+ return struct
     end
-
-    # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
     #
-    # @param obj [Object]
+    # @param obj [Object] 
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
-      obj.type&.is_a?(SCENARIO_INPUT_TYPE_ENUM) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
-      obj.value&.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
-      obj.chat_history&.is_a?(Array) != false || raise("Passed value for field obj.chat_history is not the expected type, validation failed.")
+      begin
+        return Vellum::ScenarioInputStringVariableValue.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::ScenarioInputJsonVariableValue.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::ScenarioInputChatHistoryVariableValue.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/scenario_input_chat_history_variable_value.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+require_relative "chat_message"
+require "ostruct"
+require "json"
+
+module Vellum
+# Prompt Sandbox Scenario input value that is of type CHAT_HISTORY
+  class ScenarioInputChatHistoryVariableValue
+  # @return [String] 
+    attr_reader :type
+  # @return [Array<Vellum::ChatMessage>] 
+    attr_reader :value
+  # @return [String] 
+    attr_reader :input_variable_id
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param type [String] 
+    # @param value [Array<Vellum::ChatMessage>] 
+    # @param input_variable_id [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::ScenarioInputChatHistoryVariableValue]
+    def initialize(type:, value: OMIT, input_variable_id:, additional_properties: nil)
+      @type = type
+      @value = value if value != OMIT
+      @input_variable_id = input_variable_id
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value, "input_variable_id": input_variable_id }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of
+#  ScenarioInputChatHistoryVariableValue
+    #
+    # @param json_object [String] 
+    # @return [Vellum::ScenarioInputChatHistoryVariableValue]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      value = parsed_json["value"]&.map do | item |
+  item = item.to_json
+  Vellum::ChatMessage.from_json(json_object: item)
+end
+      input_variable_id = parsed_json["input_variable_id"]
+      new(
+        type: type,
+        value: value,
+        input_variable_id: input_variable_id,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of ScenarioInputChatHistoryVariableValue to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.value&.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      obj.input_variable_id.is_a?(String) != false || raise("Passed value for field obj.input_variable_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/scenario_input_json_variable_value.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# Prompt Sandbox Scenario input value that is of type JSON
+  class ScenarioInputJsonVariableValue
+  # @return [String] 
+    attr_reader :type
+  # @return [Object] 
+    attr_reader :value
+  # @return [String] 
+    attr_reader :input_variable_id
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param type [String] 
+    # @param value [Object] 
+    # @param input_variable_id [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::ScenarioInputJsonVariableValue]
+    def initialize(type:, value:, input_variable_id:, additional_properties: nil)
+      @type = type
+      @value = value
+      @input_variable_id = input_variable_id
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value, "input_variable_id": input_variable_id }
+    end
+# Deserialize a JSON object to an instance of ScenarioInputJsonVariableValue
+    #
+    # @param json_object [String] 
+    # @return [Vellum::ScenarioInputJsonVariableValue]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      value = parsed_json["value"]
+      input_variable_id = parsed_json["input_variable_id"]
+      new(
+        type: type,
+        value: value,
+        input_variable_id: input_variable_id,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of ScenarioInputJsonVariableValue to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.value.is_a?(Object) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      obj.input_variable_id.is_a?(String) != false || raise("Passed value for field obj.input_variable_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/scenario_input_string_variable_value.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# Prompt Sandbox Scenario input value that is of type STRING
+  class ScenarioInputStringVariableValue
+  # @return [String] 
+    attr_reader :type
+  # @return [String] 
+    attr_reader :value
+  # @return [String] 
+    attr_reader :input_variable_id
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param type [String] 
+    # @param value [String] 
+    # @param input_variable_id [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::ScenarioInputStringVariableValue]
+    def initialize(type:, value: OMIT, input_variable_id:, additional_properties: nil)
+      @type = type
+      @value = value if value != OMIT
+      @input_variable_id = input_variable_id
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value, "input_variable_id": input_variable_id }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of ScenarioInputStringVariableValue
+    #
+    # @param json_object [String] 
+    # @return [Vellum::ScenarioInputStringVariableValue]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      value = parsed_json["value"]
+      input_variable_id = parsed_json["input_variable_id"]
+      new(
+        type: type,
+        value: value,
+        input_variable_id: input_variable_id,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of ScenarioInputStringVariableValue to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.value&.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      obj.input_variable_id.is_a?(String) != false || raise("Passed value for field obj.input_variable_id is not the expected type, validation failed.")
+    end
+  end
+end