vellum_ai 0.3.15 → 0.14.75

data/lib/vellum_ai/types/audio_chat_message_content.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require_relative "vellum_audio"
+require "ostruct"
+require "json"
+
+module Vellum
+# An audio value that is used in a chat message.
+  class AudioChatMessageContent
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::VellumAudio] 
+    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::VellumAudio] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::AudioChatMessageContent]
+    def initialize(type:, value:, additional_properties: nil)
+      @type = type
+      @value = value
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value }
+    end
+# Deserialize a JSON object to an instance of AudioChatMessageContent
+    #
+    # @param json_object [String] 
+    # @return [Vellum::AudioChatMessageContent]
+    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::VellumAudio.from_json(json_object: value)
+      else
+        value = nil
+      end
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of AudioChatMessageContent 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.")
+      Vellum::VellumAudio.validate_raw(obj: obj.value)
+    end
+  end
+end

data/lib/vellum_ai/types/audio_chat_message_content_request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require_relative "vellum_audio_request"
+require "ostruct"
+require "json"
+
+module Vellum
+# An audio value that is used in a chat message.
+  class AudioChatMessageContentRequest
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::VellumAudioRequest] 
+    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::VellumAudioRequest] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::AudioChatMessageContentRequest]
+    def initialize(type:, value:, additional_properties: nil)
+      @type = type
+      @value = value
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "value": value }
+    end
+# Deserialize a JSON object to an instance of AudioChatMessageContentRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::AudioChatMessageContentRequest]
+    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::VellumAudioRequest.from_json(json_object: value)
+      else
+        value = nil
+      end
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of AudioChatMessageContentRequest 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.")
+      Vellum::VellumAudioRequest.validate_raw(obj: obj.value)
+    end
+  end
+end

data/lib/vellum_ai/types/audio_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 audio file in a prompt template.
+  class AudioPromptBlock
+  # @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::AudioPromptBlock]
+    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 AudioPromptBlock
+    #
+    # @param json_object [String] 
+    # @return [Vellum::AudioPromptBlock]
+    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 AudioPromptBlock 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/audio_vellum_value.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require_relative "vellum_audio"
+require "ostruct"
+require "json"
+
+module Vellum
+# A base Vellum primitive value representing audio.
+  class AudioVellumValue
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::VellumAudio] 
+    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::VellumAudio] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::AudioVellumValue]
+    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 AudioVellumValue
+    #
+    # @param json_object [String] 
+    # @return [Vellum::AudioVellumValue]
+    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::VellumAudio.from_json(json_object: value)
+      else
+        value = nil
+      end
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of AudioVellumValue 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::VellumAudio.validate_raw(obj: obj.value)
+    end
+  end
+end

data/lib/vellum_ai/types/audio_vellum_value_request.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require_relative "vellum_audio_request"
+require "ostruct"
+require "json"
+
+module Vellum
+# A base Vellum primitive value representing audio.
+  class AudioVellumValueRequest
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::VellumAudioRequest] 
+    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::VellumAudioRequest] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::AudioVellumValueRequest]
+    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 AudioVellumValueRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::AudioVellumValueRequest]
+    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::VellumAudioRequest.from_json(json_object: value)
+      else
+        value = nil
+      end
+      new(
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of AudioVellumValueRequest 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::VellumAudioRequest.validate_raw(obj: obj.value)
+    end
+  end
+end

data/lib/vellum_ai/types/base_output.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+  class BaseOutput
+  # @return [Hash{String => Object}] 
+    attr_reader :value
+  # @return [Hash{String => Object}] 
+    attr_reader :delta
+  # @return [String] 
+    attr_reader :name
+  # @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 [Hash{String => Object}] 
+    # @param delta [Hash{String => Object}] 
+    # @param name [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::BaseOutput]
+    def initialize(value: OMIT, delta: OMIT, name:, additional_properties: nil)
+      @value = value if value != OMIT
+      @delta = delta if delta != OMIT
+      @name = name
+      @additional_properties = additional_properties
+      @_field_set = { "value": value, "delta": delta, "name": name }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of BaseOutput
+    #
+    # @param json_object [String] 
+    # @return [Vellum::BaseOutput]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      value = parsed_json["value"]
+      delta = parsed_json["delta"]
+      name = parsed_json["name"]
+      new(
+        value: value,
+        delta: delta,
+        name: name,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of BaseOutput 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.value&.is_a?(Hash) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+      obj.delta&.is_a?(Hash) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/basic_vectorizer_intfloat_multilingual_e_5_large.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# Basic vectorizer for intfloat/multilingual-e5-large.
+  class BasicVectorizerIntfloatMultilingualE5Large
+  # @return [Hash{String => Object}] 
+    attr_reader :config
+  # @return [String] 
+    attr_reader :model_name
+  # @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 config [Hash{String => Object}] 
+    # @param model_name [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::BasicVectorizerIntfloatMultilingualE5Large]
+    def initialize(config: OMIT, model_name:, additional_properties: nil)
+      @config = config if config != OMIT
+      @model_name = model_name
+      @additional_properties = additional_properties
+      @_field_set = { "config": config, "model_name": model_name }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of
+#  BasicVectorizerIntfloatMultilingualE5Large
+    #
+    # @param json_object [String] 
+    # @return [Vellum::BasicVectorizerIntfloatMultilingualE5Large]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      config = parsed_json["config"]
+      model_name = parsed_json["model_name"]
+      new(
+        config: config,
+        model_name: model_name,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of BasicVectorizerIntfloatMultilingualE5Large 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.config&.is_a?(Hash) != false || raise("Passed value for field obj.config is not the expected type, validation failed.")
+      obj.model_name.is_a?(String) != false || raise("Passed value for field obj.model_name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/basic_vectorizer_intfloat_multilingual_e_5_large_request.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# Basic vectorizer for intfloat/multilingual-e5-large.
+  class BasicVectorizerIntfloatMultilingualE5LargeRequest
+  # @return [Hash{String => Object}] 
+    attr_reader :config
+  # @return [String] 
+    attr_reader :model_name
+  # @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 config [Hash{String => Object}] 
+    # @param model_name [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::BasicVectorizerIntfloatMultilingualE5LargeRequest]
+    def initialize(config: OMIT, model_name:, additional_properties: nil)
+      @config = config if config != OMIT
+      @model_name = model_name
+      @additional_properties = additional_properties
+      @_field_set = { "config": config, "model_name": model_name }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of
+#  BasicVectorizerIntfloatMultilingualE5LargeRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::BasicVectorizerIntfloatMultilingualE5LargeRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      config = parsed_json["config"]
+      model_name = parsed_json["model_name"]
+      new(
+        config: config,
+        model_name: model_name,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of BasicVectorizerIntfloatMultilingualE5LargeRequest 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.config&.is_a?(Hash) != false || raise("Passed value for field obj.config is not the expected type, validation failed.")
+      obj.model_name.is_a?(String) != false || raise("Passed value for field obj.model_name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/basic_vectorizer_sentence_transformers_multi_qa_mpnet_base_cos_v_1.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.
+  class BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1
+  # @return [Hash{String => Object}] 
+    attr_reader :config
+  # @return [String] 
+    attr_reader :model_name
+  # @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 config [Hash{String => Object}] 
+    # @param model_name [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1]
+    def initialize(config: OMIT, model_name:, additional_properties: nil)
+      @config = config if config != OMIT
+      @model_name = model_name
+      @additional_properties = additional_properties
+      @_field_set = { "config": config, "model_name": model_name }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of
+#  BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1
+    #
+    # @param json_object [String] 
+    # @return [Vellum::BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      config = parsed_json["config"]
+      model_name = parsed_json["model_name"]
+      new(
+        config: config,
+        model_name: model_name,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of
+#  BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1 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.config&.is_a?(Hash) != false || raise("Passed value for field obj.config is not the expected type, validation failed.")
+      obj.model_name.is_a?(String) != false || raise("Passed value for field obj.model_name is not the expected type, validation failed.")
+    end
+  end
+end