vellum_ai 0.3.14 → 0.14.74

data/lib/vellum_ai/types/variable_prompt_block.rb

@@ -0,0 +1,85 @@
+# 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 a variable in a prompt template.
+  class VariablePromptBlock
+  # @return [String] 
+    attr_reader :block_type
+  # @return [Vellum::PromptBlockState] 
+    attr_reader :state
+  # @return [Vellum::EphemeralPromptCacheConfig] 
+    attr_reader :cache_config
+  # @return [String] 
+    attr_reader :input_variable
+  # @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 input_variable [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::VariablePromptBlock]
+    def initialize(block_type:, state: OMIT, cache_config: OMIT, input_variable:, additional_properties: nil)
+      @block_type = block_type
+      @state = state if state != OMIT
+      @cache_config = cache_config if cache_config != OMIT
+      @input_variable = input_variable
+      @additional_properties = additional_properties
+      @_field_set = { "block_type": block_type, "state": state, "cache_config": cache_config, "input_variable": input_variable }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of VariablePromptBlock
+    #
+    # @param json_object [String] 
+    # @return [Vellum::VariablePromptBlock]
+    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
+      input_variable = parsed_json["input_variable"]
+      new(
+        block_type: block_type,
+        state: state,
+        cache_config: cache_config,
+        input_variable: input_variable,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of VariablePromptBlock 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.input_variable.is_a?(String) != false || raise("Passed value for field obj.input_variable is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/vellum_audio.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+  class VellumAudio
+  # @return [String] A valid data URL containing the audio data.
+    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 src [String] A valid data URL containing the audio data.
+    # @param metadata [Hash{String => Object}] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::VellumAudio]
+    def initialize(src:, metadata: OMIT, additional_properties: nil)
+      @src = src
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "src": src, "metadata": metadata }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of VellumAudio
+    #
+    # @param json_object [String] 
+    # @return [Vellum::VellumAudio]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      src = parsed_json["src"]
+      metadata = parsed_json["metadata"]
+      new(
+        src: src,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of VellumAudio 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.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/vellum_audio_request.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+  class VellumAudioRequest
+  # @return [String] A valid data URL containing the audio data.
+    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 src [String] A valid data URL containing the audio data.
+    # @param metadata [Hash{String => Object}] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::VellumAudioRequest]
+    def initialize(src:, metadata: OMIT, additional_properties: nil)
+      @src = src
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "src": src, "metadata": metadata }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of VellumAudioRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::VellumAudioRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      src = parsed_json["src"]
+      metadata = parsed_json["metadata"]
+      new(
+        src: src,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of VellumAudioRequest 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.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/vellum_code_resource_definition.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+  class VellumCodeResourceDefinition
+  # @return [String] 
+    attr_reader :name
+  # @return [Array<String>] The module that this resource is defined in.
+    attr_reader :module_
+  # @return [String] 
+    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 name [String] 
+    # @param module_ [Array<String>] The module that this resource is defined in.
+    # @param id [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::VellumCodeResourceDefinition]
+    def initialize(name:, module_:, id:, additional_properties: nil)
+      @name = name
+      @module_ = module_
+      @id = id
+      @additional_properties = additional_properties
+      @_field_set = { "name": name, "module": module_, "id": id }
+    end
+# Deserialize a JSON object to an instance of VellumCodeResourceDefinition
+    #
+    # @param json_object [String] 
+    # @return [Vellum::VellumCodeResourceDefinition]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      module_ = parsed_json["module"]
+      id = parsed_json["id"]
+      new(
+        name: name,
+        module_: module_,
+        id: id,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of VellumCodeResourceDefinition 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.module_.is_a?(Array) != false || raise("Passed value for field obj.module_ is not the expected type, validation failed.")
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/vellum_document.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+  class VellumDocument
+  # @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 src [String] 
+    # @param metadata [Hash{String => Object}] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::VellumDocument]
+    def initialize(src:, metadata: OMIT, additional_properties: nil)
+      @src = src
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "src": src, "metadata": metadata }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of VellumDocument
+    #
+    # @param json_object [String] 
+    # @return [Vellum::VellumDocument]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      src = parsed_json["src"]
+      metadata = parsed_json["metadata"]
+      new(
+        src: src,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of VellumDocument 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.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/vellum_document_request.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+  class VellumDocumentRequest
+  # @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 src [String] 
+    # @param metadata [Hash{String => Object}] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::VellumDocumentRequest]
+    def initialize(src:, metadata: OMIT, additional_properties: nil)
+      @src = src
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "src": src, "metadata": metadata }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of VellumDocumentRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::VellumDocumentRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      src = parsed_json["src"]
+      metadata = parsed_json["metadata"]
+      new(
+        src: src,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of VellumDocumentRequest 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.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/vellum_error.rb

@@ -1,51 +1,62 @@
 # frozen_string_literal: true
-
 require_relative "vellum_error_code_enum"
+require "ostruct"
 require "json"
 
 module Vellum
   class VellumError
-    attr_reader :message, :code, :additional_properties
+  # @return [String] 
+    attr_reader :message
+  # @return [Vellum::VellumErrorCodeEnum] 
+    attr_reader :code
+  # @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 message [String]
-    # @param code [VELLUM_ERROR_CODE_ENUM]
+    # @param message [String] 
+    # @param code [Vellum::VellumErrorCodeEnum] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [VellumError]
+    # @return [Vellum::VellumError]
     def initialize(message:, code:, additional_properties: nil)
-      # @type [String]
       @message = message
-      # @type [VELLUM_ERROR_CODE_ENUM]
       @code = code
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
+      @_field_set = { "message": message, "code": code }
     end
-
-    # Deserialize a JSON object to an instance of VellumError
+# Deserialize a JSON object to an instance of VellumError
     #
-    # @param json_object [JSON]
-    # @return [VellumError]
+    # @param json_object [String] 
+    # @return [Vellum::VellumError]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      message = struct.message
-      code = VELLUM_ERROR_CODE_ENUM.key(parsed_json["code"]) || parsed_json["code"]
-      new(message: message, code: code, additional_properties: struct)
+      message = parsed_json["message"]
+      code = parsed_json["code"]
+      new(
+        message: message,
+        code: code,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of VellumError to a JSON object
+# Serialize an instance of VellumError to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "message": @message, "code": VELLUM_ERROR_CODE_ENUM[@code] || @code }.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.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
-      obj.code.is_a?(VELLUM_ERROR_CODE_ENUM) != false || raise("Passed value for field obj.code is not the expected type, validation failed.")
+      obj.code.is_a?(Vellum::VellumErrorCodeEnum) != false || raise("Passed value for field obj.code is not the expected type, validation failed.")
     end
   end
-end
+end

data/lib/vellum_ai/types/vellum_error_code_enum.rb

@@ -1,11 +1,20 @@
 # frozen_string_literal: true
 
 module Vellum
-  # @type [VELLUM_ERROR_CODE_ENUM]
-  VELLUM_ERROR_CODE_ENUM = {
-    invalid_request: "INVALID_REQUEST",
-    provider_error: "PROVIDER_ERROR",
-    internal_server_error: "INTERNAL_SERVER_ERROR",
-    user_defined_error: "USER_DEFINED_ERROR"
-  }.freeze
-end
+# * `INVALID_REQUEST` - INVALID_REQUEST
+#  * `INVALID_INPUTS` - INVALID_INPUTS
+#  * `PROVIDER_ERROR` - PROVIDER_ERROR
+#  * `REQUEST_TIMEOUT` - REQUEST_TIMEOUT
+#  * `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR
+#  * `USER_DEFINED_ERROR` - USER_DEFINED_ERROR
+  class VellumErrorCodeEnum
+
+    INVALID_REQUEST = "INVALID_REQUEST"
+    INVALID_INPUTS = "INVALID_INPUTS"
+    PROVIDER_ERROR = "PROVIDER_ERROR"
+    REQUEST_TIMEOUT = "REQUEST_TIMEOUT"
+    INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR"
+    USER_DEFINED_ERROR = "USER_DEFINED_ERROR"
+
+  end
+end

data/lib/vellum_ai/types/vellum_error_request.rb

@@ -1,51 +1,62 @@
 # frozen_string_literal: true
-
 require_relative "vellum_error_code_enum"
+require "ostruct"
 require "json"
 
 module Vellum
   class VellumErrorRequest
-    attr_reader :message, :code, :additional_properties
+  # @return [String] 
+    attr_reader :message
+  # @return [Vellum::VellumErrorCodeEnum] 
+    attr_reader :code
+  # @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 message [String]
-    # @param code [VELLUM_ERROR_CODE_ENUM]
+    # @param message [String] 
+    # @param code [Vellum::VellumErrorCodeEnum] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [VellumErrorRequest]
+    # @return [Vellum::VellumErrorRequest]
     def initialize(message:, code:, additional_properties: nil)
-      # @type [String]
       @message = message
-      # @type [VELLUM_ERROR_CODE_ENUM]
       @code = code
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
+      @_field_set = { "message": message, "code": code }
     end
-
-    # Deserialize a JSON object to an instance of VellumErrorRequest
+# Deserialize a JSON object to an instance of VellumErrorRequest
     #
-    # @param json_object [JSON]
-    # @return [VellumErrorRequest]
+    # @param json_object [String] 
+    # @return [Vellum::VellumErrorRequest]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      message = struct.message
-      code = VELLUM_ERROR_CODE_ENUM.key(parsed_json["code"]) || parsed_json["code"]
-      new(message: message, code: code, additional_properties: struct)
+      message = parsed_json["message"]
+      code = parsed_json["code"]
+      new(
+        message: message,
+        code: code,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of VellumErrorRequest to a JSON object
+# Serialize an instance of VellumErrorRequest to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      { "message": @message, "code": VELLUM_ERROR_CODE_ENUM[@code] || @code }.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.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
-      obj.code.is_a?(VELLUM_ERROR_CODE_ENUM) != false || raise("Passed value for field obj.code is not the expected type, validation failed.")
+      obj.code.is_a?(Vellum::VellumErrorCodeEnum) != false || raise("Passed value for field obj.code is not the expected type, validation failed.")
     end
   end
-end
+end