vellum_ai 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e08267f4b41dfd7ec77f636ad9bf6206ccf400ce3d0b80cd7cbe2b4f393b5e3
-  data.tar.gz: 7bec737c942214d9eb1e13c2c74cbb1c6b897667e53f92aec786f710873d39e8
+  metadata.gz: c89bc8d37213b301ac14a66e24d44df3d041c79d01ed00bbd137c28cf7d389fe
+  data.tar.gz: cf6d35d419139341e0a4ab93c2c8906a834eea5533727fa9c806f8d08278775e
 SHA512:
-  metadata.gz: b72ea1ae6d167d34ddc4da4f5cb2812a1cc053259a927303585887c73c76283629a7cc45e0cab44caea461e10281c89e22657e4124c1d66003672aadc6326c53
-  data.tar.gz: 7e82ea31fd99ec1dbd09c1222a347aab7e20b70047b428c61378af65d50e158743d01bb916eea35aedeb65b137a22534121bbc698cd5ed7cf181e32b7a1bc156
+  metadata.gz: d33c9db1f5584045ee3eb4cba2c811d3188001e9a1445eb5d2473c9a01cf5ff000519c8fb299fdfea908cad6fd61d5838bf1e32d6d5a614ee1bb6bf6593145a0
+  data.tar.gz: b7f0937f2ef0c8fbba53bc6bbe71f2acaa395a8785d4934cdd47885ca1d128f704929dc9021f93949edbf80a30f6404c2dbe7a7504501a4bda291ee6a525400c

data/lib/requests.rb

@@ -56,7 +56,7 @@ end
     end
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.3.1' }
+      headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.3.3' }
       headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
  headers
     end
@@ -107,7 +107,7 @@ end
     end
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.3.1' }
+      headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.3.3' }
       headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
  headers
     end

data/lib/types_export.rb

@@ -101,6 +101,21 @@ require_relative "vellum_ai/types/container_image_build_config"
 require_relative "vellum_ai/types/container_image_container_image_tag"
 require_relative "vellum_ai/types/container_image_read"
 require_relative "vellum_ai/types/create_test_suite_test_case_request"
+require_relative "vellum_ai/types/node_execution_initiated_event"
+require_relative "vellum_ai/types/node_execution_streaming_event"
+require_relative "vellum_ai/types/node_execution_fulfilled_event"
+require_relative "vellum_ai/types/node_execution_rejected_event"
+require_relative "vellum_ai/types/node_execution_paused_event"
+require_relative "vellum_ai/types/node_execution_resumed_event"
+require_relative "vellum_ai/types/workflow_execution_initiated_event"
+require_relative "vellum_ai/types/workflow_execution_streaming_event"
+require_relative "vellum_ai/types/workflow_execution_rejected_event"
+require_relative "vellum_ai/types/workflow_execution_fulfilled_event"
+require_relative "vellum_ai/types/workflow_execution_paused_event"
+require_relative "vellum_ai/types/workflow_execution_resumed_event"
+require_relative "vellum_ai/types/workflow_execution_snapshotted_event"
+require_relative "vellum_ai/types/workflow_event"
+require_relative "vellum_ai/types/create_workflow_event_request"
 require_relative "vellum_ai/types/delimiter_chunker_config"
 require_relative "vellum_ai/types/delimiter_chunker_config_request"
 require_relative "vellum_ai/types/delimiter_chunking"
@@ -111,6 +126,16 @@ require_relative "vellum_ai/types/deployment_provider_payload_response"
 require_relative "vellum_ai/types/deployment_read"
 require_relative "vellum_ai/types/deployment_release_tag_deployment_history_item"
 require_relative "vellum_ai/types/deployment_release_tag_read"
+require_relative "vellum_ai/types/workflow_input"
+require_relative "vellum_ai/types/prompt_request_string_input"
+require_relative "vellum_ai/types/prompt_request_json_input"
+require_relative "vellum_ai/types/prompt_request_chat_history_input"
+require_relative "vellum_ai/types/prompt_request_audio_input"
+require_relative "vellum_ai/types/prompt_request_video_input"
+require_relative "vellum_ai/types/prompt_request_image_input"
+require_relative "vellum_ai/types/prompt_request_document_input"
+require_relative "vellum_ai/types/prompt_request_input"
+require_relative "vellum_ai/types/deprecated_prompt_request_input"
 require_relative "vellum_ai/types/docker_service_token"
 require_relative "vellum_ai/types/document_document_to_document_index"
 require_relative "vellum_ai/types/reducto_chunking"
@@ -298,19 +323,13 @@ require_relative "vellum_ai/types/named_test_case_video_variable_value_request"
 require_relative "vellum_ai/types/named_test_case_variable_value_request"
 require_relative "vellum_ai/types/new_member_join_behavior_enum"
 require_relative "vellum_ai/types/node_execution_fulfilled_body"
-require_relative "vellum_ai/types/node_execution_fulfilled_event"
 require_relative "vellum_ai/types/node_execution_initiated_body"
-require_relative "vellum_ai/types/node_execution_initiated_event"
 require_relative "vellum_ai/types/node_execution_paused_body"
-require_relative "vellum_ai/types/node_execution_paused_event"
 require_relative "vellum_ai/types/node_execution_rejected_body"
-require_relative "vellum_ai/types/node_execution_rejected_event"
 require_relative "vellum_ai/types/node_execution_resumed_body"
-require_relative "vellum_ai/types/node_execution_resumed_event"
 require_relative "vellum_ai/types/node_execution_span"
 require_relative "vellum_ai/types/node_execution_span_attributes"
 require_relative "vellum_ai/types/node_execution_streaming_body"
-require_relative "vellum_ai/types/node_execution_streaming_event"
 require_relative "vellum_ai/types/node_input_compiled_array_value"
 require_relative "vellum_ai/types/node_input_compiled_audio_value"
 require_relative "vellum_ai/types/node_input_compiled_chat_history_value"
@@ -386,14 +405,6 @@ require_relative "vellum_ai/types/thinking_vellum_value"
 require_relative "vellum_ai/types/prompt_output"
 require_relative "vellum_ai/types/prompt_parameters"
 require_relative "vellum_ai/types/prompt_push_response"
-require_relative "vellum_ai/types/prompt_request_audio_input"
-require_relative "vellum_ai/types/prompt_request_chat_history_input"
-require_relative "vellum_ai/types/prompt_request_document_input"
-require_relative "vellum_ai/types/prompt_request_image_input"
-require_relative "vellum_ai/types/prompt_request_string_input"
-require_relative "vellum_ai/types/prompt_request_json_input"
-require_relative "vellum_ai/types/prompt_request_video_input"
-require_relative "vellum_ai/types/prompt_request_input"
 require_relative "vellum_ai/types/prompt_settings"
 require_relative "vellum_ai/types/prompt_version_build_config_sandbox"
 require_relative "vellum_ai/types/components_schemas_prompt_version_build_config_sandbox"
@@ -586,13 +597,6 @@ require_relative "vellum_ai/types/vellum_variable_extensions"
 require_relative "vellum_ai/types/vellum_variable_type"
 require_relative "vellum_ai/types/vellum_video"
 require_relative "vellum_ai/types/vellum_video_request"
-require_relative "vellum_ai/types/workflow_execution_initiated_event"
-require_relative "vellum_ai/types/workflow_execution_streaming_event"
-require_relative "vellum_ai/types/workflow_execution_fulfilled_event"
-require_relative "vellum_ai/types/workflow_execution_rejected_event"
-require_relative "vellum_ai/types/workflow_execution_paused_event"
-require_relative "vellum_ai/types/workflow_execution_resumed_event"
-require_relative "vellum_ai/types/workflow_execution_snapshotted_event"
 require_relative "vellum_ai/types/vellum_workflow_execution_event"
 require_relative "vellum_ai/types/workflow_deployment_event_executions_response"
 require_relative "vellum_ai/types/workflow_deployment_history_item"
@@ -603,7 +607,6 @@ require_relative "vellum_ai/types/workflow_deployment_release_workflow_version"
 require_relative "vellum_ai/types/workflow_event_error"
 require_relative "vellum_ai/types/workflow_initialization_error"
 require_relative "vellum_ai/types/workflow_error"
-require_relative "vellum_ai/types/workflow_event"
 require_relative "vellum_ai/types/workflow_event_execution_read"
 require_relative "vellum_ai/types/workflow_execution_actual"
 require_relative "vellum_ai/types/workflow_execution_detail"

data/lib/vellum_ai/ad_hoc/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 require_relative "../../requests"
-require_relative "../types/prompt_request_input"
+require_relative "../types/deprecated_prompt_request_input"
 require_relative "../types/vellum_variable"
 require_relative "../types/prompt_parameters"
 require_relative "../types/prompt_settings"
@@ -23,7 +23,7 @@ module Vellum
       @request_client = request_client
     end
     # @param ml_model [String] 
-    # @param input_values [Array<Hash>] Request of type Array<Vellum::PromptRequestInput>, as a Hash
+    # @param input_values [Array<Hash>] Request of type Array<Vellum::DeprecatedPromptRequestInput>, as a Hash
     # @param input_variables [Array<Hash>] Request of type Array<Vellum::VellumVariable>, as a Hash
     #   * :id (String) 
     #   * :key (String) 
@@ -70,7 +70,7 @@ module Vellum
 #  )
 #  api.ad_hoc.adhoc_execute_prompt(
 #    ml_model: "x",
-#    input_values: [{ key: "x", type: "STRING", value: "value" }, { key: "x", type: "STRING", value: "value" }],
+#    input_values: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }],
 #    input_variables: [{ id: "x", key: "key", type: STRING }, { id: "x", key: "key", type: STRING }],
 #    parameters: {  },
 #    blocks: [{ block_type: "JINJA", template: "template" }, { block_type: "JINJA", template: "template" }]
@@ -109,7 +109,7 @@ end
       @request_client = request_client
     end
     # @param ml_model [String] 
-    # @param input_values [Array<Hash>] Request of type Array<Vellum::PromptRequestInput>, as a Hash
+    # @param input_values [Array<Hash>] Request of type Array<Vellum::DeprecatedPromptRequestInput>, as a Hash
     # @param input_variables [Array<Hash>] Request of type Array<Vellum::VellumVariable>, as a Hash
     #   * :id (String) 
     #   * :key (String) 
@@ -156,7 +156,7 @@ end
 #  )
 #  api.ad_hoc.adhoc_execute_prompt(
 #    ml_model: "x",
-#    input_values: [{ key: "x", type: "STRING", value: "value" }, { key: "x", type: "STRING", value: "value" }],
+#    input_values: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }],
 #    input_variables: [{ id: "x", key: "key", type: STRING }, { id: "x", key: "key", type: STRING }],
 #    parameters: {  },
 #    blocks: [{ block_type: "JINJA", template: "template" }, { block_type: "JINJA", template: "template" }]

data/lib/vellum_ai/events/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 require_relative "../../requests"
-require_relative "../types/workflow_event"
+require_relative "../types/create_workflow_event_request"
 require_relative "../types/event_create_response"
 require "async"
 require_relative "../../requests"
@@ -16,9 +16,10 @@ module Vellum
     def initialize(request_client:)
       @request_client = request_client
     end
-# Accept an event and publish it to ClickHouse for analytics processing.
+# Accept an event or list of events and publish them to ClickHouse for analytics
+#  processing.
     #
-    # @param request [Vellum::NodeExecutionInitiatedEvent, Vellum::NodeExecutionStreamingEvent, Vellum::NodeExecutionFulfilledEvent, Vellum::NodeExecutionRejectedEvent, Vellum::NodeExecutionPausedEvent, Vellum::NodeExecutionResumedEvent, Vellum::WorkflowExecutionInitiatedEvent, Vellum::WorkflowExecutionStreamingEvent, Vellum::WorkflowExecutionRejectedEvent, Vellum::WorkflowExecutionFulfilledEvent, Vellum::WorkflowExecutionPausedEvent, Vellum::WorkflowExecutionResumedEvent, Vellum::WorkflowExecutionSnapshottedEvent] 
+    # @param request [Array<Vellum::WorkflowEvent>, Vellum::WorkflowEvent] 
     # @param request_options [Vellum::RequestOptions] 
     # @return [Vellum::EventCreateResponse]
     # @example
@@ -27,7 +28,7 @@ module Vellum
 #    environment: Vellum::Environment::PRODUCTION,
 #    api_key: "YOUR_API_KEY"
 #  )
-#  api.events.create(request: { name: "node.execution.initiated", body: { node_definition: { name: "name", module_: ["module", "module"], id: "id" }, inputs: { "inputs": {"key":"value"} } }, id: "id", timestamp: DateTime.parse("2024-01-15T09:30:00.000Z"), trace_id: "trace_id", span_id: "span_id" })
+#  api.events.create(request: [{ name: "node.execution.initiated", body: { node_definition: { name: "name", module_: ["module", "module"], id: "id" }, inputs: { "inputs": {"key":"value"} } }, id: "id", timestamp: DateTime.parse("2024-01-15T09:30:00.000Z"), trace_id: "trace_id", span_id: "span_id" }, { name: "node.execution.initiated", body: { node_definition: { name: "name", module_: ["module", "module"], id: "id" }, inputs: { "inputs": {"key":"value"} } }, id: "id", timestamp: DateTime.parse("2024-01-15T09:30:00.000Z"), trace_id: "trace_id", span_id: "span_id" }])
     def create(request:, request_options: nil)
       response = @request_client.conn.post do | req |
   unless request_options&.timeout_in_seconds.nil?
@@ -61,9 +62,10 @@ end
     def initialize(request_client:)
       @request_client = request_client
     end
-# Accept an event and publish it to ClickHouse for analytics processing.
+# Accept an event or list of events and publish them to ClickHouse for analytics
+#  processing.
     #
-    # @param request [Vellum::NodeExecutionInitiatedEvent, Vellum::NodeExecutionStreamingEvent, Vellum::NodeExecutionFulfilledEvent, Vellum::NodeExecutionRejectedEvent, Vellum::NodeExecutionPausedEvent, Vellum::NodeExecutionResumedEvent, Vellum::WorkflowExecutionInitiatedEvent, Vellum::WorkflowExecutionStreamingEvent, Vellum::WorkflowExecutionRejectedEvent, Vellum::WorkflowExecutionFulfilledEvent, Vellum::WorkflowExecutionPausedEvent, Vellum::WorkflowExecutionResumedEvent, Vellum::WorkflowExecutionSnapshottedEvent] 
+    # @param request [Array<Vellum::WorkflowEvent>, Vellum::WorkflowEvent] 
     # @param request_options [Vellum::RequestOptions] 
     # @return [Vellum::EventCreateResponse]
     # @example
@@ -72,7 +74,7 @@ end
 #    environment: Vellum::Environment::PRODUCTION,
 #    api_key: "YOUR_API_KEY"
 #  )
-#  api.events.create(request: { name: "node.execution.initiated", body: { node_definition: { name: "name", module_: ["module", "module"], id: "id" }, inputs: { "inputs": {"key":"value"} } }, id: "id", timestamp: DateTime.parse("2024-01-15T09:30:00.000Z"), trace_id: "trace_id", span_id: "span_id" })
+#  api.events.create(request: [{ name: "node.execution.initiated", body: { node_definition: { name: "name", module_: ["module", "module"], id: "id" }, inputs: { "inputs": {"key":"value"} } }, id: "id", timestamp: DateTime.parse("2024-01-15T09:30:00.000Z"), trace_id: "trace_id", span_id: "span_id" }, { name: "node.execution.initiated", body: { node_definition: { name: "name", module_: ["module", "module"], id: "id" }, inputs: { "inputs": {"key":"value"} } }, id: "id", timestamp: DateTime.parse("2024-01-15T09:30:00.000Z"), trace_id: "trace_id", span_id: "span_id" }])
     def create(request:, request_options: nil)
       Async do
         response = @request_client.conn.post do | req |

data/lib/vellum_ai/types/create_workflow_event_request.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require "json"
+require_relative "workflow_event"
+
+module Vellum
+  class CreateWorkflowEventRequest
+
+
+# Deserialize a JSON object to an instance of CreateWorkflowEventRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::CreateWorkflowEventRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        struct.is_a?(Array) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        unless struct.nil?
+  return struct&.map do | item |
+  item = item.to_json
+  Vellum::WorkflowEvent.from_json(json_object: item)
+end
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::WorkflowEvent.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowEvent.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+ return struct
+    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:)
+      begin
+        return obj.is_a?(Array) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::WorkflowEvent.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/deprecated_prompt_request_input.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+require "json"
+require_relative "workflow_input"
+require_relative "prompt_request_input"
+
+module Vellum
+  class DeprecatedPromptRequestInput
+
+
+# Deserialize a JSON object to an instance of DeprecatedPromptRequestInput
+    #
+    # @param json_object [String] 
+    # @return [Vellum::DeprecatedPromptRequestInput]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vellum::WorkflowInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::WorkflowInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::PromptRequestInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::PromptRequestInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+ return struct
+    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:)
+      begin
+        return Vellum::WorkflowInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::PromptRequestInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/event_create_response.rb

@@ -7,6 +7,8 @@ module Vellum
   class EventCreateResponse
   # @return [Boolean] Indicates whether the event was published successfully.
     attr_reader :success
+  # @return [Integer] Number of events processed
+    attr_reader :count
   # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
   # @return [Object] 
@@ -16,12 +18,14 @@ module Vellum
     OMIT = Object.new
 
     # @param success [Boolean] Indicates whether the event was published successfully.
+    # @param count [Integer] Number of events processed
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vellum::EventCreateResponse]
-    def initialize(success: OMIT, additional_properties: nil)
+    def initialize(success: OMIT, count:, additional_properties: nil)
       @success = success if success != OMIT
+      @count = count
       @additional_properties = additional_properties
-      @_field_set = { "success": success }.reject do | _k, v |
+      @_field_set = { "success": success, "count": count }.reject do | _k, v |
   v == OMIT
 end
     end
@@ -33,7 +37,12 @@ end
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
       success = parsed_json["success"]
-      new(success: success, additional_properties: struct)
+      count = parsed_json["count"]
+      new(
+        success: success,
+        count: count,
+        additional_properties: struct
+      )
     end
 # Serialize an instance of EventCreateResponse to a JSON object
     #
@@ -49,6 +58,7 @@ end
     # @return [Void]
     def self.validate_raw(obj:)
       obj.success&.is_a?(Boolean) != false || raise("Passed value for field obj.success is not the expected type, validation failed.")
+      obj.count.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
     end
   end
 end

data/lib/vellum_ai/types/logical_operator.rb

@@ -19,6 +19,7 @@ module Vellum
 #  * `notIn` - NOT_IN
 #  * `between` - BETWEEN
 #  * `notBetween` - NOT_BETWEEN
+#  * `concat` - CONCAT
 #  * `blank` - BLANK
 #  * `notBlank` - NOT_BLANK
 #  * `coalesce` - COALESCE
@@ -48,6 +49,7 @@ module Vellum
     NOT_IN = "notIn"
     BETWEEN = "between"
     NOT_BETWEEN = "notBetween"
+    CONCAT = "concat"
     BLANK = "blank"
     NOT_BLANK = "notBlank"
     COALESCE = "coalesce"

data/lib/vellum_ai/types/processing_failure_reason_enum.rb

@@ -3,10 +3,12 @@
 module Vellum
 # * `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
 #  * `INVALID_FILE` - Invalid File
+#  * `INVALID_CREDENTIALS` - Invalid Credentials
   class ProcessingFailureReasonEnum
 
     EXCEEDED_CHARACTER_LIMIT = "EXCEEDED_CHARACTER_LIMIT"
     INVALID_FILE = "INVALID_FILE"
+    INVALID_CREDENTIALS = "INVALID_CREDENTIALS"
 
   end
 end

data/lib/vellum_ai/types/slim_document.rb

@@ -23,6 +23,7 @@ module Vellum
 #  unless processing_state is FAILED.
 #  * `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
 #  * `INVALID_FILE` - Invalid File
+#  * `INVALID_CREDENTIALS` - Invalid Credentials
     attr_reader :processing_failure_reason
   # @return [Vellum::DOCUMENT_STATUS] The document's current status.
 #  * `ACTIVE` - Active
@@ -52,6 +53,7 @@ module Vellum
 #  unless processing_state is FAILED.
 #  * `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
 #  * `INVALID_FILE` - Invalid File
+#  * `INVALID_CREDENTIALS` - Invalid Credentials
     # @param status [Vellum::DOCUMENT_STATUS] The document's current status.
 #  * `ACTIVE` - Active
     # @param keywords [Array<String>] A list of keywords associated with this document. Originally provided when

data/lib/vellum_ai/types/workflow_input.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+require "json"
+require_relative "string_input"
+require_relative "json_input"
+require_relative "chat_history_input"
+require_relative "number_input"
+require_relative "search_results_input"
+require_relative "error_input"
+require_relative "array_input"
+require_relative "function_call_input"
+require_relative "audio_input"
+require_relative "video_input"
+require_relative "image_input"
+require_relative "document_input"
+
+module Vellum
+  class WorkflowInput
+
+
+# Deserialize a JSON object to an instance of WorkflowInput
+    #
+    # @param json_object [String] 
+    # @return [Vellum::WorkflowInput]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vellum::StringInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::StringInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::JsonInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::JsonInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::ChatHistoryInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ChatHistoryInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::NumberInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::NumberInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::SearchResultsInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::SearchResultsInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::ErrorInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ErrorInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::ArrayInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ArrayInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::FunctionCallInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::FunctionCallInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::AudioInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::AudioInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::VideoInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::VideoInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::ImageInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::ImageInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vellum::DocumentInput.validate_raw(obj: struct)
+        unless struct.nil?
+  return Vellum::DocumentInput.from_json(json_object: struct)
+else
+  return nil
+end
+      rescue StandardError
+        # noop
+      end
+ return struct
+    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:)
+      begin
+        return Vellum::StringInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::JsonInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::ChatHistoryInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::NumberInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::SearchResultsInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::ErrorInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::ArrayInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::FunctionCallInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::AudioInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::VideoInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::ImageInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vellum::DocumentInput.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai.rb

@@ -296,6 +296,7 @@ end
     # @param metadata [Hash{String => Object}] Arbitrary JSON metadata associated with this request. Can be used to capture
 #  additional monitoring data such as user id, session id, etc. for future
 #  analysis.
+    # @param previous_execution_id [String] The ID of a previous Workflow Execution to reference for initial State loading.
     # @param request_options [Vellum::RequestOptions] 
     # @return [Vellum::ExecuteWorkflowResponse]
     # @example
@@ -305,7 +306,7 @@ end
 #    api_key: "YOUR_API_KEY"
 #  )
 #  api.execute_workflow(inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
-    def execute_workflow(inputs:, expand_meta: nil, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil, external_id: nil, metadata: nil, request_options: nil)
+    def execute_workflow(inputs:, expand_meta: nil, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil, external_id: nil, metadata: nil, previous_execution_id: nil, request_options: nil)
       response = @request_client.conn.post do | req |
   unless request_options&.timeout_in_seconds.nil?
     req.options.timeout = request_options.timeout_in_seconds
@@ -322,7 +323,7 @@ end
   unless request_options.nil? || request_options&.additional_query_parameters.nil?
     req.params = { **(request_options&.additional_query_parameters || {}) }.compact
   end
-  req.body = { **(request_options&.additional_body_parameters || {}), inputs: inputs, expand_meta: expand_meta, workflow_deployment_id: workflow_deployment_id, workflow_deployment_name: workflow_deployment_name, release_tag: release_tag, external_id: external_id, metadata: metadata }.compact
+  req.body = { **(request_options&.additional_body_parameters || {}), inputs: inputs, expand_meta: expand_meta, workflow_deployment_id: workflow_deployment_id, workflow_deployment_name: workflow_deployment_name, release_tag: release_tag, external_id: external_id, metadata: metadata, previous_execution_id: previous_execution_id }.compact
   req.url "#{@request_client.get_url(environment: Predict, request_options: request_options)}/v1/execute-workflow"
 end
       Vellum::ExecuteWorkflowResponse.from_json(json_object: response.body)
@@ -752,6 +753,7 @@ end
     # @param metadata [Hash{String => Object}] Arbitrary JSON metadata associated with this request. Can be used to capture
 #  additional monitoring data such as user id, session id, etc. for future
 #  analysis.
+    # @param previous_execution_id [String] The ID of a previous Workflow Execution to reference for initial State loading.
     # @param request_options [Vellum::RequestOptions] 
     # @return [Vellum::ExecuteWorkflowResponse]
     # @example
@@ -761,7 +763,7 @@ end
 #    api_key: "YOUR_API_KEY"
 #  )
 #  api.execute_workflow(inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
-    def execute_workflow(inputs:, expand_meta: nil, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil, external_id: nil, metadata: nil, request_options: nil)
+    def execute_workflow(inputs:, expand_meta: nil, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil, external_id: nil, metadata: nil, previous_execution_id: nil, request_options: nil)
       response = @async_request_client.conn.post do | req |
   unless request_options&.timeout_in_seconds.nil?
     req.options.timeout = request_options.timeout_in_seconds
@@ -778,7 +780,7 @@ end
   unless request_options.nil? || request_options&.additional_query_parameters.nil?
     req.params = { **(request_options&.additional_query_parameters || {}) }.compact
   end
-  req.body = { **(request_options&.additional_body_parameters || {}), inputs: inputs, expand_meta: expand_meta, workflow_deployment_id: workflow_deployment_id, workflow_deployment_name: workflow_deployment_name, release_tag: release_tag, external_id: external_id, metadata: metadata }.compact
+  req.body = { **(request_options&.additional_body_parameters || {}), inputs: inputs, expand_meta: expand_meta, workflow_deployment_id: workflow_deployment_id, workflow_deployment_name: workflow_deployment_name, release_tag: release_tag, external_id: external_id, metadata: metadata, previous_execution_id: previous_execution_id }.compact
   req.url "#{@async_request_client.get_url(environment: Predict, request_options: request_options)}/v1/execute-workflow"
 end
       Vellum::ExecuteWorkflowResponse.from_json(json_object: response.body)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vellum_ai
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Vellum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-28 00:00:00.000000000 Z
+date: 2025-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -226,6 +226,7 @@ files:
 - lib/vellum_ai/types/container_image_container_image_tag.rb
 - lib/vellum_ai/types/container_image_read.rb
 - lib/vellum_ai/types/create_test_suite_test_case_request.rb
+- lib/vellum_ai/types/create_workflow_event_request.rb
 - lib/vellum_ai/types/delimiter_chunker_config.rb
 - lib/vellum_ai/types/delimiter_chunker_config_request.rb
 - lib/vellum_ai/types/delimiter_chunking.rb
@@ -236,6 +237,7 @@ files:
 - lib/vellum_ai/types/deployment_read.rb
 - lib/vellum_ai/types/deployment_release_tag_deployment_history_item.rb
 - lib/vellum_ai/types/deployment_release_tag_read.rb
+- lib/vellum_ai/types/deprecated_prompt_request_input.rb
 - lib/vellum_ai/types/docker_service_token.rb
 - lib/vellum_ai/types/document_chat_message_content.rb
 - lib/vellum_ai/types/document_chat_message_content_request.rb
@@ -772,6 +774,7 @@ files:
 - lib/vellum_ai/types/workflow_execution_workflow_result_event.rb
 - lib/vellum_ai/types/workflow_expand_meta_request.rb
 - lib/vellum_ai/types/workflow_initialization_error.rb
+- lib/vellum_ai/types/workflow_input.rb
 - lib/vellum_ai/types/workflow_node_result_data.rb
 - lib/vellum_ai/types/workflow_node_result_event.rb
 - lib/vellum_ai/types/workflow_node_result_event_state.rb