vellum_ai 0.3.15 → 0.14.75

data/lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require_relative "instructor_vectorizer_config"
+require "ostruct"
+require "json"
+
+module Vellum
+# Vectorizer for hkunlp/instructor-xl.
+  class HkunlpInstructorXlVectorizer
+  # @return [String] 
+    attr_reader :model_name
+  # @return [Vellum::InstructorVectorizerConfig] 
+    attr_reader :config
+  # @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 model_name [String] 
+    # @param config [Vellum::InstructorVectorizerConfig] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::HkunlpInstructorXlVectorizer]
+    def initialize(model_name:, config:, additional_properties: nil)
+      @model_name = model_name
+      @config = config
+      @additional_properties = additional_properties
+      @_field_set = { "model_name": model_name, "config": config }
+    end
+# Deserialize a JSON object to an instance of HkunlpInstructorXlVectorizer
+    #
+    # @param json_object [String] 
+    # @return [Vellum::HkunlpInstructorXlVectorizer]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      model_name = parsed_json["model_name"]
+      unless parsed_json["config"].nil?
+        config = parsed_json["config"].to_json
+        config = Vellum::InstructorVectorizerConfig.from_json(json_object: config)
+      else
+        config = nil
+      end
+      new(
+        model_name: model_name,
+        config: config,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of HkunlpInstructorXlVectorizer 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.model_name.is_a?(String) != false || raise("Passed value for field obj.model_name is not the expected type, validation failed.")
+      Vellum::InstructorVectorizerConfig.validate_raw(obj: obj.config)
+    end
+  end
+end

data/lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer_request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require_relative "instructor_vectorizer_config_request"
+require "ostruct"
+require "json"
+
+module Vellum
+# Vectorizer for hkunlp/instructor-xl.
+  class HkunlpInstructorXlVectorizerRequest
+  # @return [String] 
+    attr_reader :model_name
+  # @return [Vellum::InstructorVectorizerConfigRequest] 
+    attr_reader :config
+  # @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 model_name [String] 
+    # @param config [Vellum::InstructorVectorizerConfigRequest] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::HkunlpInstructorXlVectorizerRequest]
+    def initialize(model_name:, config:, additional_properties: nil)
+      @model_name = model_name
+      @config = config
+      @additional_properties = additional_properties
+      @_field_set = { "model_name": model_name, "config": config }
+    end
+# Deserialize a JSON object to an instance of HkunlpInstructorXlVectorizerRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::HkunlpInstructorXlVectorizerRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      model_name = parsed_json["model_name"]
+      unless parsed_json["config"].nil?
+        config = parsed_json["config"].to_json
+        config = Vellum::InstructorVectorizerConfigRequest.from_json(json_object: config)
+      else
+        config = nil
+      end
+      new(
+        model_name: model_name,
+        config: config,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of HkunlpInstructorXlVectorizerRequest 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.model_name.is_a?(String) != false || raise("Passed value for field obj.model_name is not the expected type, validation failed.")
+      Vellum::InstructorVectorizerConfigRequest.validate_raw(obj: obj.config)
+    end
+  end
+end

data/lib/vellum_ai/types/image_chat_message_content.rb

@@ -1,52 +1,68 @@
 # frozen_string_literal: true
-
 require_relative "vellum_image"
+require "ostruct"
 require "json"
 
 module Vellum
-  # An image value that is used in a chat message.
+# An image value that is used in a chat message.
   class ImageChatMessageContent
-    attr_reader :value, :additional_properties
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::VellumImage] 
+    attr_reader :value
+  # @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 value [VellumImage]
+    # @param type [String] 
+    # @param value [Vellum::VellumImage] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [ImageChatMessageContent]
-    def initialize(value:, additional_properties: nil)
-      # @type [VellumImage]
+    # @return [Vellum::ImageChatMessageContent]
+    def initialize(type:, value:, additional_properties: nil)
+      @type = type
       @value = value
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value }
     end
-
-    # Deserialize a JSON object to an instance of ImageChatMessageContent
+# Deserialize a JSON object to an instance of ImageChatMessageContent
     #
-    # @param json_object [JSON]
-    # @return [ImageChatMessageContent]
+    # @param json_object [String] 
+    # @return [Vellum::ImageChatMessageContent]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      if parsed_json["value"].nil?
-        value = nil
-      else
+      type = parsed_json["type"]
+      unless parsed_json["value"].nil?
         value = parsed_json["value"].to_json
-        value = VellumImage.from_json(json_object: value)
+        value = Vellum::VellumImage.from_json(json_object: value)
+      else
+        value = nil
       end
-      new(value: value, additional_properties: struct)
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of ImageChatMessageContent to a JSON object
+# Serialize an instance of ImageChatMessageContent to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "value": @value }.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:)
-      VellumImage.validate_raw(obj: obj.value)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::VellumImage.validate_raw(obj: obj.value)
     end
   end
-end
+end

data/lib/vellum_ai/types/image_chat_message_content_request.rb

@@ -1,52 +1,68 @@
 # frozen_string_literal: true
-
 require_relative "vellum_image_request"
+require "ostruct"
 require "json"
 
 module Vellum
-  # An image value that is used in a chat message.
+# An image value that is used in a chat message.
   class ImageChatMessageContentRequest
-    attr_reader :value, :additional_properties
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::VellumImageRequest] 
+    attr_reader :value
+  # @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 value [VellumImageRequest]
+    # @param type [String] 
+    # @param value [Vellum::VellumImageRequest] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [ImageChatMessageContentRequest]
-    def initialize(value:, additional_properties: nil)
-      # @type [VellumImageRequest]
+    # @return [Vellum::ImageChatMessageContentRequest]
+    def initialize(type:, value:, additional_properties: nil)
+      @type = type
       @value = value
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value }
     end
-
-    # Deserialize a JSON object to an instance of ImageChatMessageContentRequest
+# Deserialize a JSON object to an instance of ImageChatMessageContentRequest
     #
-    # @param json_object [JSON]
-    # @return [ImageChatMessageContentRequest]
+    # @param json_object [String] 
+    # @return [Vellum::ImageChatMessageContentRequest]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      if parsed_json["value"].nil?
-        value = nil
-      else
+      type = parsed_json["type"]
+      unless parsed_json["value"].nil?
         value = parsed_json["value"].to_json
-        value = VellumImageRequest.from_json(json_object: value)
+        value = Vellum::VellumImageRequest.from_json(json_object: value)
+      else
+        value = nil
       end
-      new(value: value, additional_properties: struct)
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of ImageChatMessageContentRequest to a JSON object
+# Serialize an instance of ImageChatMessageContentRequest to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "value": @value }.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:)
-      VellumImageRequest.validate_raw(obj: obj.value)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::VellumImageRequest.validate_raw(obj: obj.value)
     end
   end
-end
+end

data/lib/vellum_ai/types/image_prompt_block.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+require_relative "prompt_block_state"
+require_relative "ephemeral_prompt_cache_config"
+require "ostruct"
+require "json"
+
+module Vellum
+# A block that represents an image in a prompt template.
+  class ImagePromptBlock
+  # @return [String] 
+    attr_reader :block_type
+  # @return [Vellum::PromptBlockState] 
+    attr_reader :state
+  # @return [Vellum::EphemeralPromptCacheConfig] 
+    attr_reader :cache_config
+  # @return [String] 
+    attr_reader :src
+  # @return [Hash{String => Object}] 
+    attr_reader :metadata
+  # @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 src [String] 
+    # @param metadata [Hash{String => Object}] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::ImagePromptBlock]
+    def initialize(block_type:, state: OMIT, cache_config: OMIT, src:, metadata: OMIT, additional_properties: nil)
+      @block_type = block_type
+      @state = state if state != OMIT
+      @cache_config = cache_config if cache_config != OMIT
+      @src = src
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "block_type": block_type, "state": state, "cache_config": cache_config, "src": src, "metadata": metadata }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of ImagePromptBlock
+    #
+    # @param json_object [String] 
+    # @return [Vellum::ImagePromptBlock]
+    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
+      src = parsed_json["src"]
+      metadata = parsed_json["metadata"]
+      new(
+        block_type: block_type,
+        state: state,
+        cache_config: cache_config,
+        src: src,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of ImagePromptBlock 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.src.is_a?(String) != false || raise("Passed value for field obj.src is not the expected type, validation failed.")
+      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/image_vellum_value.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require_relative "vellum_image"
+require "ostruct"
+require "json"
+
+module Vellum
+# A base Vellum primitive value representing an image.
+  class ImageVellumValue
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::VellumImage] 
+    attr_reader :value
+  # @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 [Vellum::VellumImage] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::ImageVellumValue]
+    def initialize(type:, value: OMIT, additional_properties: nil)
+      @type = type
+      @value = value if value != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of ImageVellumValue
+    #
+    # @param json_object [String] 
+    # @return [Vellum::ImageVellumValue]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      unless parsed_json["value"].nil?
+        value = parsed_json["value"].to_json
+        value = Vellum::VellumImage.from_json(json_object: value)
+      else
+        value = nil
+      end
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of ImageVellumValue 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.nil? || Vellum::VellumImage.validate_raw(obj: obj.value)
+    end
+  end
+end

data/lib/vellum_ai/types/image_vellum_value_request.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require_relative "vellum_image_request"
+require "ostruct"
+require "json"
+
+module Vellum
+# A base Vellum primitive value representing an image.
+  class ImageVellumValueRequest
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::VellumImageRequest] 
+    attr_reader :value
+  # @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 [Vellum::VellumImageRequest] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::ImageVellumValueRequest]
+    def initialize(type:, value: OMIT, additional_properties: nil)
+      @type = type
+      @value = value if value != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of ImageVellumValueRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::ImageVellumValueRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      unless parsed_json["value"].nil?
+        value = parsed_json["value"].to_json
+        value = Vellum::VellumImageRequest.from_json(json_object: value)
+      else
+        value = nil
+      end
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of ImageVellumValueRequest 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.nil? || Vellum::VellumImageRequest.validate_raw(obj: obj.value)
+    end
+  end
+end