vellum_ai 0.3.15 → 0.14.74

data/lib/vellum_ai/types/function_call_chat_message_content_value_request.rb

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require_relative "function_call"
+require "ostruct"
+require "json"
+
+module Vellum
+# A user input representing a Vellum Function Call value
+  class FunctionCallInput
+  # @return [String] The variable's name
+    attr_reader :name
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::FunctionCall] 
+    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 name [String] The variable's name
+    # @param type [String] 
+    # @param value [Vellum::FunctionCall] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FunctionCallInput]
+    def initialize(name:, type:, value:, additional_properties: nil)
+      @name = name
+      @type = type
+      @value = value
+      @additional_properties = additional_properties
+      @_field_set = { "name": name, "type": type, "value": value }
+    end
+# Deserialize a JSON object to an instance of FunctionCallInput
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FunctionCallInput]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      type = parsed_json["type"]
+      unless parsed_json["value"].nil?
+        value = parsed_json["value"].to_json
+        value = Vellum::FunctionCall.from_json(json_object: value)
+      else
+        value = nil
+      end
+      new(
+        name: name,
+        type: type,
+        value: value,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FunctionCallInput 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::FunctionCall.validate_raw(obj: obj.value)
+    end
+  end
+end

data/lib/vellum_ai/types/function_call_prompt_block.rb

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

data/lib/vellum_ai/types/function_call_request.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# The final resolved function call value.
+  class FunctionCallRequest
+  # @return [Hash{String => Object}] 
+    attr_reader :arguments
+  # @return [String] 
+    attr_reader :id
+  # @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 arguments [Hash{String => Object}] 
+    # @param id [String] 
+    # @param name [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FunctionCallRequest]
+    def initialize(arguments:, id: OMIT, name:, additional_properties: nil)
+      @arguments = arguments
+      @id = id if id != OMIT
+      @name = name
+      @additional_properties = additional_properties
+      @_field_set = { "arguments": arguments, "id": id, "name": name }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of FunctionCallRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FunctionCallRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      arguments = parsed_json["arguments"]
+      id = parsed_json["id"]
+      name = parsed_json["name"]
+      new(
+        arguments: arguments,
+        id: id,
+        name: name,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FunctionCallRequest 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.arguments.is_a?(Hash) != false || raise("Passed value for field obj.arguments 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.")
+      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/function_call_vellum_value.rb

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

data/lib/vellum_ai/types/function_call_vellum_value_request.rb

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

data/lib/vellum_ai/types/function_definition.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+require_relative "prompt_block_state"
+require_relative "ephemeral_prompt_cache_config"
+require "ostruct"
+require "json"
+
+module Vellum
+# The definition of a Function (aka "Tool Call") that a Prompt/Model has access
+#  to.
+  class FunctionDefinition
+  # @return [Vellum::PromptBlockState] 
+    attr_reader :state
+  # @return [Vellum::EphemeralPromptCacheConfig] 
+    attr_reader :cache_config
+  # @return [String] The name identifying the function.
+    attr_reader :name
+  # @return [String] A description to help guide the model when to invoke this function.
+    attr_reader :description
+  # @return [Hash{String => Object}] An OpenAPI specification of parameters that are supported by this function.
+    attr_reader :parameters
+  # @return [Boolean] Set this option to true to force the model to return a function call of this
+#  function.
+    attr_reader :forced
+  # @return [Boolean] Set this option to use strict schema decoding when available.
+    attr_reader :strict
+  # @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 state [Vellum::PromptBlockState] 
+    # @param cache_config [Vellum::EphemeralPromptCacheConfig] 
+    # @param name [String] The name identifying the function.
+    # @param description [String] A description to help guide the model when to invoke this function.
+    # @param parameters [Hash{String => Object}] An OpenAPI specification of parameters that are supported by this function.
+    # @param forced [Boolean] Set this option to true to force the model to return a function call of this
+#  function.
+    # @param strict [Boolean] Set this option to use strict schema decoding when available.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::FunctionDefinition]
+    def initialize(state: OMIT, cache_config: OMIT, name: OMIT, description: OMIT, parameters: OMIT, forced: OMIT, strict: OMIT, additional_properties: nil)
+      @state = state if state != OMIT
+      @cache_config = cache_config if cache_config != OMIT
+      @name = name if name != OMIT
+      @description = description if description != OMIT
+      @parameters = parameters if parameters != OMIT
+      @forced = forced if forced != OMIT
+      @strict = strict if strict != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "state": state, "cache_config": cache_config, "name": name, "description": description, "parameters": parameters, "forced": forced, "strict": strict }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of FunctionDefinition
+    #
+    # @param json_object [String] 
+    # @return [Vellum::FunctionDefinition]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      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
+      name = parsed_json["name"]
+      description = parsed_json["description"]
+      parameters = parsed_json["parameters"]
+      forced = parsed_json["forced"]
+      strict = parsed_json["strict"]
+      new(
+        state: state,
+        cache_config: cache_config,
+        name: name,
+        description: description,
+        parameters: parameters,
+        forced: forced,
+        strict: strict,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of FunctionDefinition 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.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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.parameters&.is_a?(Hash) != false || raise("Passed value for field obj.parameters is not the expected type, validation failed.")
+      obj.forced&.is_a?(Boolean) != false || raise("Passed value for field obj.forced is not the expected type, validation failed.")
+      obj.strict&.is_a?(Boolean) != false || raise("Passed value for field obj.strict is not the expected type, validation failed.")
+    end
+  end
+end