vellum_ai 0.3.9 → 0.3.11

data/lib/vellum_ai/types/execution_search_results_vellum_value.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "search_result"
+require "json"
+
+module Vellum
+  class ExecutionSearchResultsVellumValue
+    attr_reader :id, :name, :value, :additional_properties
+
+    # @param id [String] The variable's uniquely identifying internal id.
+    # @param name [String]
+    # @param value [Array<SearchResult>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [ExecutionSearchResultsVellumValue]
+    def initialize(id:, name:, value: nil, additional_properties: nil)
+      # @type [String] The variable's uniquely identifying internal id.
+      @id = id
+      # @type [String]
+      @name = name
+      # @type [Array<SearchResult>]
+      @value = value
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of ExecutionSearchResultsVellumValue
+    #
+    # @param json_object [JSON]
+    # @return [ExecutionSearchResultsVellumValue]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = struct.id
+      name = struct.name
+      value = parsed_json["value"].map do |v|
+        v = v.to_json
+        SearchResult.from_json(json_object: v)
+      end
+      new(id: id, name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of ExecutionSearchResultsVellumValue to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "id": @id, "name": @name, "value": @value }.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.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.value&.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/execution_string_vellum_value.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  class ExecutionStringVellumValue
+    attr_reader :id, :name, :value, :additional_properties
+
+    # @param id [String] The variable's uniquely identifying internal id.
+    # @param name [String]
+    # @param value [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [ExecutionStringVellumValue]
+    def initialize(id:, name:, value: nil, additional_properties: nil)
+      # @type [String] The variable's uniquely identifying internal id.
+      @id = id
+      # @type [String]
+      @name = name
+      # @type [String]
+      @value = value
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of ExecutionStringVellumValue
+    #
+    # @param json_object [JSON]
+    # @return [ExecutionStringVellumValue]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      id = struct.id
+      name = struct.name
+      value = struct.value
+      new(id: id, name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of ExecutionStringVellumValue to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "id": @id, "name": @name, "value": @value }.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.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.value&.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/execution_vellum_value.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "execution_string_vellum_value"
+require_relative "execution_number_vellum_value"
+require_relative "execution_json_vellum_value"
+require_relative "execution_chat_history_vellum_value"
+require_relative "execution_search_results_vellum_value"
+require_relative "execution_error_vellum_value"
+require_relative "execution_array_vellum_value"
+require_relative "execution_function_call_vellum_value"
+
+module Vellum
+  class ExecutionVellumValue
+    attr_reader :member, :discriminant
+
+    private_class_method :new
+    alias kind_of? is_a?
+    # @param member [Object]
+    # @param discriminant [String]
+    # @return [ExecutionVellumValue]
+    def initialize(member:, discriminant:)
+      # @type [Object]
+      @member = member
+      # @type [String]
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of ExecutionVellumValue
+    #
+    # @param json_object [JSON]
+    # @return [ExecutionVellumValue]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "STRING"
+                 ExecutionStringVellumValue.from_json(json_object: json_object)
+               when "NUMBER"
+                 ExecutionNumberVellumValue.from_json(json_object: json_object)
+               when "JSON"
+                 ExecutionJsonVellumValue.from_json(json_object: json_object)
+               when "CHAT_HISTORY"
+                 ExecutionChatHistoryVellumValue.from_json(json_object: json_object)
+               when "SEARCH_RESULTS"
+                 ExecutionSearchResultsVellumValue.from_json(json_object: json_object)
+               when "ERROR"
+                 ExecutionErrorVellumValue.from_json(json_object: json_object)
+               when "ARRAY"
+                 ExecutionArrayVellumValue.from_json(json_object: json_object)
+               when "FUNCTION_CALL"
+                 ExecutionFunctionCallVellumValue.from_json(json_object: json_object)
+               else
+                 ExecutionStringVellumValue.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      case @discriminant
+      when "STRING"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "NUMBER"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "JSON"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "CHAT_HISTORY"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "SEARCH_RESULTS"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "ERROR"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "ARRAY"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "FUNCTION_CALL"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.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:)
+      case obj.type
+      when "STRING"
+        ExecutionStringVellumValue.validate_raw(obj: obj)
+      when "NUMBER"
+        ExecutionNumberVellumValue.validate_raw(obj: obj)
+      when "JSON"
+        ExecutionJsonVellumValue.validate_raw(obj: obj)
+      when "CHAT_HISTORY"
+        ExecutionChatHistoryVellumValue.validate_raw(obj: obj)
+      when "SEARCH_RESULTS"
+        ExecutionSearchResultsVellumValue.validate_raw(obj: obj)
+      when "ERROR"
+        ExecutionErrorVellumValue.validate_raw(obj: obj)
+      when "ARRAY"
+        ExecutionArrayVellumValue.validate_raw(obj: obj)
+      when "FUNCTION_CALL"
+        ExecutionFunctionCallVellumValue.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [ExecutionStringVellumValue]
+    # @return [ExecutionVellumValue]
+    def self.string(member:)
+      new(member: member, discriminant: "STRING")
+    end
+
+    # @param member [ExecutionNumberVellumValue]
+    # @return [ExecutionVellumValue]
+    def self.number(member:)
+      new(member: member, discriminant: "NUMBER")
+    end
+
+    # @param member [ExecutionJsonVellumValue]
+    # @return [ExecutionVellumValue]
+    def self.json(member:)
+      new(member: member, discriminant: "JSON")
+    end
+
+    # @param member [ExecutionChatHistoryVellumValue]
+    # @return [ExecutionVellumValue]
+    def self.chat_history(member:)
+      new(member: member, discriminant: "CHAT_HISTORY")
+    end
+
+    # @param member [ExecutionSearchResultsVellumValue]
+    # @return [ExecutionVellumValue]
+    def self.search_results(member:)
+      new(member: member, discriminant: "SEARCH_RESULTS")
+    end
+
+    # @param member [ExecutionErrorVellumValue]
+    # @return [ExecutionVellumValue]
+    def self.error(member:)
+      new(member: member, discriminant: "ERROR")
+    end
+
+    # @param member [ExecutionArrayVellumValue]
+    # @return [ExecutionVellumValue]
+    def self.array(member:)
+      new(member: member, discriminant: "ARRAY")
+    end
+
+    # @param member [ExecutionFunctionCallVellumValue]
+    # @return [ExecutionVellumValue]
+    def self.function_call(member:)
+      new(member: member, discriminant: "FUNCTION_CALL")
+    end
+  end
+end

data/lib/vellum_ai/types/paginated_document_index_read_list.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "document_index_read"
+require "json"
+
+module Vellum
+  class PaginatedDocumentIndexReadList
+    attr_reader :count, :next_, :previous, :results, :additional_properties
+
+    # @param count [Integer]
+    # @param next_ [String]
+    # @param previous [String]
+    # @param results [Array<DocumentIndexRead>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [PaginatedDocumentIndexReadList]
+    def initialize(count: nil, next_: nil, previous: nil, results: nil, additional_properties: nil)
+      # @type [Integer]
+      @count = count
+      # @type [String]
+      @next_ = next_
+      # @type [String]
+      @previous = previous
+      # @type [Array<DocumentIndexRead>]
+      @results = results
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of PaginatedDocumentIndexReadList
+    #
+    # @param json_object [JSON]
+    # @return [PaginatedDocumentIndexReadList]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      count = struct.count
+      next_ = struct.next
+      previous = struct.previous
+      results = parsed_json["results"].map do |v|
+        v = v.to_json
+        DocumentIndexRead.from_json(json_object: v)
+      end
+      new(count: count, next_: next_, previous: previous, results: results, additional_properties: struct)
+    end
+
+    # Serialize an instance of PaginatedDocumentIndexReadList to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "count": @count, "next": @next_, "previous": @previous, "results": @results }.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.count&.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
+      obj.next_&.is_a?(String) != false || raise("Passed value for field obj.next_ is not the expected type, validation failed.")
+      obj.previous&.is_a?(String) != false || raise("Passed value for field obj.previous is not the expected type, validation failed.")
+      obj.results&.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/prompt_template_block_properties.rb

@@ -7,11 +7,12 @@ require "json"
 
 module Vellum
   class PromptTemplateBlockProperties
-    attr_reader :chat_role, :chat_message_unterminated, :template, :template_type, :function_name,
+    attr_reader :chat_role, :chat_message_unterminated, :chat_source, :template, :template_type, :function_name,
                 :function_description, :function_parameters, :function_forced, :blocks, :additional_properties
 
     # @param chat_role [CHAT_MESSAGE_ROLE]
     # @param chat_message_unterminated [Boolean]
+    # @param chat_source [String]
     # @param template [String]
     # @param template_type [VELLUM_VARIABLE_TYPE]
     # @param function_name [String]
@@ -21,13 +22,15 @@ module Vellum
     # @param blocks [Array<PromptTemplateBlock>]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [PromptTemplateBlockProperties]
-    def initialize(chat_role: nil, chat_message_unterminated: nil, template: nil, template_type: nil,
+    def initialize(chat_role: nil, chat_message_unterminated: nil, chat_source: nil, template: nil, template_type: nil,
                    function_name: nil, function_description: nil, function_parameters: nil, function_forced: nil, blocks: nil, additional_properties: nil)
       # @type [CHAT_MESSAGE_ROLE]
       @chat_role = chat_role
       # @type [Boolean]
       @chat_message_unterminated = chat_message_unterminated
       # @type [String]
+      @chat_source = chat_source
+      # @type [String]
       @template = template
       # @type [VELLUM_VARIABLE_TYPE]
       @template_type = template_type
@@ -54,6 +57,7 @@ module Vellum
       parsed_json = JSON.parse(json_object)
       chat_role = CHAT_MESSAGE_ROLE.key(parsed_json["chat_role"]) || parsed_json["chat_role"]
       chat_message_unterminated = struct.chat_message_unterminated
+      chat_source = struct.chat_source
       template = struct.template
       template_type = VELLUM_VARIABLE_TYPE.key(parsed_json["template_type"]) || parsed_json["template_type"]
       function_name = struct.function_name
@@ -64,8 +68,8 @@ module Vellum
         v = v.to_json
         PromptTemplateBlock.from_json(json_object: v)
       end
-      new(chat_role: chat_role, chat_message_unterminated: chat_message_unterminated, template: template,
-          template_type: template_type, function_name: function_name, function_description: function_description, function_parameters: function_parameters, function_forced: function_forced, blocks: blocks, additional_properties: struct)
+      new(chat_role: chat_role, chat_message_unterminated: chat_message_unterminated, chat_source: chat_source,
+          template: template, template_type: template_type, function_name: function_name, function_description: function_description, function_parameters: function_parameters, function_forced: function_forced, blocks: blocks, additional_properties: struct)
     end
 
     # Serialize an instance of PromptTemplateBlockProperties to a JSON object
@@ -75,6 +79,7 @@ module Vellum
       {
         "chat_role": CHAT_MESSAGE_ROLE[@chat_role] || @chat_role,
         "chat_message_unterminated": @chat_message_unterminated,
+        "chat_source": @chat_source,
         "template": @template,
         "template_type": VELLUM_VARIABLE_TYPE[@template_type] || @template_type,
         "function_name": @function_name,
@@ -92,6 +97,7 @@ module Vellum
     def self.validate_raw(obj:)
       obj.chat_role&.is_a?(CHAT_MESSAGE_ROLE) != false || raise("Passed value for field obj.chat_role is not the expected type, validation failed.")
       obj.chat_message_unterminated&.is_a?(Boolean) != false || raise("Passed value for field obj.chat_message_unterminated is not the expected type, validation failed.")
+      obj.chat_source&.is_a?(String) != false || raise("Passed value for field obj.chat_source is not the expected type, validation failed.")
       obj.template&.is_a?(String) != false || raise("Passed value for field obj.template is not the expected type, validation failed.")
       obj.template_type&.is_a?(VELLUM_VARIABLE_TYPE) != false || raise("Passed value for field obj.template_type is not the expected type, validation failed.")
       obj.function_name&.is_a?(String) != false || raise("Passed value for field obj.function_name is not the expected type, validation failed.")

data/lib/vellum_ai/types/prompt_template_block_properties_request.rb

@@ -7,11 +7,12 @@ require "json"
 
 module Vellum
   class PromptTemplateBlockPropertiesRequest
-    attr_reader :chat_role, :chat_message_unterminated, :template, :template_type, :function_name,
+    attr_reader :chat_role, :chat_message_unterminated, :chat_source, :template, :template_type, :function_name,
                 :function_description, :function_parameters, :function_forced, :blocks, :additional_properties
 
     # @param chat_role [CHAT_MESSAGE_ROLE]
     # @param chat_message_unterminated [Boolean]
+    # @param chat_source [String]
     # @param template [String]
     # @param template_type [VELLUM_VARIABLE_TYPE]
     # @param function_name [String]
@@ -21,13 +22,15 @@ module Vellum
     # @param blocks [Array<PromptTemplateBlockRequest>]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [PromptTemplateBlockPropertiesRequest]
-    def initialize(chat_role: nil, chat_message_unterminated: nil, template: nil, template_type: nil,
+    def initialize(chat_role: nil, chat_message_unterminated: nil, chat_source: nil, template: nil, template_type: nil,
                    function_name: nil, function_description: nil, function_parameters: nil, function_forced: nil, blocks: nil, additional_properties: nil)
       # @type [CHAT_MESSAGE_ROLE]
       @chat_role = chat_role
       # @type [Boolean]
       @chat_message_unterminated = chat_message_unterminated
       # @type [String]
+      @chat_source = chat_source
+      # @type [String]
       @template = template
       # @type [VELLUM_VARIABLE_TYPE]
       @template_type = template_type
@@ -54,6 +57,7 @@ module Vellum
       parsed_json = JSON.parse(json_object)
       chat_role = CHAT_MESSAGE_ROLE.key(parsed_json["chat_role"]) || parsed_json["chat_role"]
       chat_message_unterminated = struct.chat_message_unterminated
+      chat_source = struct.chat_source
       template = struct.template
       template_type = VELLUM_VARIABLE_TYPE.key(parsed_json["template_type"]) || parsed_json["template_type"]
       function_name = struct.function_name
@@ -64,8 +68,8 @@ module Vellum
         v = v.to_json
         PromptTemplateBlockRequest.from_json(json_object: v)
       end
-      new(chat_role: chat_role, chat_message_unterminated: chat_message_unterminated, template: template,
-          template_type: template_type, function_name: function_name, function_description: function_description, function_parameters: function_parameters, function_forced: function_forced, blocks: blocks, additional_properties: struct)
+      new(chat_role: chat_role, chat_message_unterminated: chat_message_unterminated, chat_source: chat_source,
+          template: template, template_type: template_type, function_name: function_name, function_description: function_description, function_parameters: function_parameters, function_forced: function_forced, blocks: blocks, additional_properties: struct)
     end
 
     # Serialize an instance of PromptTemplateBlockPropertiesRequest to a JSON object
@@ -75,6 +79,7 @@ module Vellum
       {
         "chat_role": CHAT_MESSAGE_ROLE[@chat_role] || @chat_role,
         "chat_message_unterminated": @chat_message_unterminated,
+        "chat_source": @chat_source,
         "template": @template,
         "template_type": VELLUM_VARIABLE_TYPE[@template_type] || @template_type,
         "function_name": @function_name,
@@ -92,6 +97,7 @@ module Vellum
     def self.validate_raw(obj:)
       obj.chat_role&.is_a?(CHAT_MESSAGE_ROLE) != false || raise("Passed value for field obj.chat_role is not the expected type, validation failed.")
       obj.chat_message_unterminated&.is_a?(Boolean) != false || raise("Passed value for field obj.chat_message_unterminated is not the expected type, validation failed.")
+      obj.chat_source&.is_a?(String) != false || raise("Passed value for field obj.chat_source is not the expected type, validation failed.")
       obj.template&.is_a?(String) != false || raise("Passed value for field obj.template is not the expected type, validation failed.")
       obj.template_type&.is_a?(VELLUM_VARIABLE_TYPE) != false || raise("Passed value for field obj.template_type is not the expected type, validation failed.")
       obj.function_name&.is_a?(String) != false || raise("Passed value for field obj.function_name is not the expected type, validation failed.")

data/lib/vellum_ai/types/workflow_result_event.rb

@@ -5,11 +5,12 @@ require "date"
 require_relative "workflow_result_event_output_data"
 require_relative "workflow_event_error"
 require_relative "workflow_output"
+require_relative "execution_vellum_value"
 require "json"
 
 module Vellum
   class WorkflowResultEvent
-    attr_reader :id, :state, :ts, :output, :error, :outputs, :additional_properties
+    attr_reader :id, :state, :ts, :output, :error, :outputs, :inputs, :additional_properties
 
     # @param id [String]
     # @param state [WORKFLOW_NODE_RESULT_EVENT_STATE]
@@ -17,9 +18,10 @@ module Vellum
     # @param output [WorkflowResultEventOutputData]
     # @param error [WorkflowEventError]
     # @param outputs [Array<WorkflowOutput>]
+    # @param inputs [Array<ExecutionVellumValue>]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [WorkflowResultEvent]
-    def initialize(id:, state:, ts:, output: nil, error: nil, outputs: nil, additional_properties: nil)
+    def initialize(id:, state:, ts:, output: nil, error: nil, outputs: nil, inputs: nil, additional_properties: nil)
       # @type [String]
       @id = id
       # @type [WORKFLOW_NODE_RESULT_EVENT_STATE]
@@ -32,6 +34,8 @@ module Vellum
       @error = error
       # @type [Array<WorkflowOutput>]
       @outputs = outputs
+      # @type [Array<ExecutionVellumValue>]
+      @inputs = inputs
       # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
     end
@@ -62,7 +66,12 @@ module Vellum
         v = v.to_json
         WorkflowOutput.from_json(json_object: v)
       end
-      new(id: id, state: state, ts: ts, output: output, error: error, outputs: outputs, additional_properties: struct)
+      inputs = parsed_json["inputs"].map do |v|
+        v = v.to_json
+        ExecutionVellumValue.from_json(json_object: v)
+      end
+      new(id: id, state: state, ts: ts, output: output, error: error, outputs: outputs, inputs: inputs,
+          additional_properties: struct)
     end
 
     # Serialize an instance of WorkflowResultEvent to a JSON object
@@ -75,7 +84,8 @@ module Vellum
         "ts": @ts,
         "output": @output,
         "error": @error,
-        "outputs": @outputs
+        "outputs": @outputs,
+        "inputs": @inputs
       }.to_json
     end
 
@@ -90,6 +100,7 @@ module Vellum
       obj.output.nil? || WorkflowResultEventOutputData.validate_raw(obj: obj.output)
       obj.error.nil? || WorkflowEventError.validate_raw(obj: obj.error)
       obj.outputs&.is_a?(Array) != false || raise("Passed value for field obj.outputs is not the expected type, validation failed.")
+      obj.inputs&.is_a?(Array) != false || raise("Passed value for field obj.inputs is not the expected type, validation failed.")
     end
   end
 end

data/lib/vellum_ai.rb

@@ -96,11 +96,11 @@ module Vellum
 
     # Executes a deployed Workflow and returns its outputs.
     #
+    # @param inputs [Array<Hash>] The list of inputs defined in the Workflow's Deployment with their corresponding values.Request of type Array<WorkflowRequestInputRequest>, as a Hash
     # @param workflow_deployment_id [String] The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.
     # @param workflow_deployment_name [String] The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
     # @param release_tag [String] Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
-    # @param inputs [Array<Hash>] The list of inputs defined in the Workflow's Deployment with their corresponding values.Request of type Array<WorkflowRequestInputRequest>, as a Hash
-    # @param external_id [String] Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment.
+    # @param external_id [String] Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
     # @param request_options [RequestOptions]
     # @return [ExecuteWorkflowResponse]
     def execute_workflow(inputs:, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil,
@@ -111,10 +111,10 @@ module Vellum
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
         req.body = {
           **(request_options&.additional_body_parameters || {}),
+          inputs: inputs,
           workflow_deployment_id: workflow_deployment_id,
           workflow_deployment_name: workflow_deployment_name,
           release_tag: release_tag,
-          inputs: inputs,
           external_id: external_id
         }.compact
         req.url "#{@request_client.default_environment[:Predict]}/v1/execute-workflow"
@@ -318,11 +318,11 @@ module Vellum
 
     # Executes a deployed Workflow and returns its outputs.
     #
+    # @param inputs [Array<Hash>] The list of inputs defined in the Workflow's Deployment with their corresponding values.Request of type Array<WorkflowRequestInputRequest>, as a Hash
     # @param workflow_deployment_id [String] The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.
     # @param workflow_deployment_name [String] The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
     # @param release_tag [String] Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
-    # @param inputs [Array<Hash>] The list of inputs defined in the Workflow's Deployment with their corresponding values.Request of type Array<WorkflowRequestInputRequest>, as a Hash
-    # @param external_id [String] Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment.
+    # @param external_id [String] Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
     # @param request_options [RequestOptions]
     # @return [ExecuteWorkflowResponse]
     def execute_workflow(inputs:, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil,
@@ -333,10 +333,10 @@ module Vellum
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
         req.body = {
           **(request_options&.additional_body_parameters || {}),
+          inputs: inputs,
           workflow_deployment_id: workflow_deployment_id,
           workflow_deployment_name: workflow_deployment_name,
           release_tag: release_tag,
-          inputs: inputs,
           external_id: external_id
         }.compact
         req.url "#{@async_request_client.default_environment[:Predict]}/v1/execute-workflow"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vellum_ai
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.11
 platform: ruby
 authors:
 - Vellum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -95,6 +95,7 @@ files:
 - lib/vellum_ai/deployments/client.rb
 - lib/vellum_ai/deployments/types/deployments_list_request_status.rb
 - lib/vellum_ai/document_indexes/client.rb
+- lib/vellum_ai/document_indexes/types/document_indexes_list_request_status.rb
 - lib/vellum_ai/documents/client.rb
 - lib/vellum_ai/folder_entities/client.rb
 - lib/vellum_ai/model_versions/client.rb
@@ -147,6 +148,15 @@ files:
 - lib/vellum_ai/types/execute_workflow_response.rb
 - lib/vellum_ai/types/execute_workflow_stream_error_response.rb
 - lib/vellum_ai/types/execute_workflow_workflow_result_event.rb
+- lib/vellum_ai/types/execution_array_vellum_value.rb
+- lib/vellum_ai/types/execution_chat_history_vellum_value.rb
+- lib/vellum_ai/types/execution_error_vellum_value.rb
+- lib/vellum_ai/types/execution_function_call_vellum_value.rb
+- lib/vellum_ai/types/execution_json_vellum_value.rb
+- lib/vellum_ai/types/execution_number_vellum_value.rb
+- lib/vellum_ai/types/execution_search_results_vellum_value.rb
+- lib/vellum_ai/types/execution_string_vellum_value.rb
+- lib/vellum_ai/types/execution_vellum_value.rb
 - lib/vellum_ai/types/finish_reason_enum.rb
 - lib/vellum_ai/types/fulfilled_enum.rb
 - lib/vellum_ai/types/fulfilled_execute_prompt_event.rb
@@ -222,6 +232,7 @@ files:
 - lib/vellum_ai/types/normalized_token_log_probs.rb
 - lib/vellum_ai/types/number_enum.rb
 - lib/vellum_ai/types/number_variable_value.rb
+- lib/vellum_ai/types/paginated_document_index_read_list.rb
 - lib/vellum_ai/types/paginated_slim_deployment_read_list.rb
 - lib/vellum_ai/types/paginated_slim_document_list.rb
 - lib/vellum_ai/types/paginated_slim_workflow_deployment_list.rb