vellum_ai 1.10.9 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 130a7100771ff919699318c13d6b0fb1a63b3cced17536a55273f25b21415274
-  data.tar.gz: 77450c38111fd477491f7cb3437aa6e4d280a3d5fb1b2495ff8c1bd2a64dd29d
+  metadata.gz: ccd1ca7ad21297e3886feaa9a31a00d06ca1a68f4d33454b9496f9fce2283e31
+  data.tar.gz: 6cbf944cf1ea593d32bee316e1dc89ba34e73f1847dab9952151cebce3c84b1e
 SHA512:
-  metadata.gz: b9ef0aada48fa7e131b0f36f096efd78a6a611686d46fa00174022e0154a7d27d7da50d13a18d95291ab3188835e15bf71bfbcada497820be29d35fd61f5252b
-  data.tar.gz: 1d69346feb2071466bd3c7539f0f74235de94a20e1dcf7a0df86c354c164e0de20584336a0e2fcc694860e627ea0aa4d793539bee615309348e56648ac7bd3f6
+  metadata.gz: 4cd470bfd9abd70f0d114aeed273e423e6f27097ed5158e6e666945e9f29148d3619906e7950ed661ebef862711d6a1c1c2b564760c6f2e172087087048025ed
+  data.tar.gz: 4a017b28dd6158ab7b994b545cd96a58823af8835cb00358d4078dc0ed6dd63451613419e7cda59598923824ddb6983f5b7d3bc42a611c3aa284f9b585b277b4

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.10.9' }
+      headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.11.0' }
       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.10.9' }
+      headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.11.0' }
       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

@@ -187,6 +187,7 @@ require_relative "vellum_ai/types/rejected_execute_prompt_response"
 require_relative "vellum_ai/types/execute_prompt_response"
 require_relative "vellum_ai/types/components_schemas_composio_execute_tool_request"
 require_relative "vellum_ai/types/components_schemas_composio_execute_tool_response"
+require_relative "vellum_ai/types/execute_workflow_async_response"
 require_relative "vellum_ai/types/execute_workflow_response"
 require_relative "vellum_ai/types/fulfilled_execute_workflow_workflow_result_event"
 require_relative "vellum_ai/types/rejected_execute_workflow_workflow_result_event"

data/lib/vellum_ai/types/execute_workflow_async_response.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+# The response from an async Workflow Deployment execution.
+  class ExecuteWorkflowAsyncResponse
+  # @return [String] The ID of the workflow execution.
+    attr_reader :execution_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 execution_id [String] The ID of the workflow execution.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::ExecuteWorkflowAsyncResponse]
+    def initialize(execution_id:, additional_properties: nil)
+      @execution_id = execution_id
+      @additional_properties = additional_properties
+      @_field_set = { "execution_id": execution_id }
+    end
+# Deserialize a JSON object to an instance of ExecuteWorkflowAsyncResponse
+    #
+    # @param json_object [String] 
+    # @return [Vellum::ExecuteWorkflowAsyncResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      execution_id = parsed_json["execution_id"]
+      new(execution_id: execution_id, additional_properties: struct)
+    end
+# Serialize an instance of ExecuteWorkflowAsyncResponse 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.execution_id.is_a?(String) != false || raise("Passed value for field obj.execution_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai.rb

@@ -44,6 +44,7 @@ require_relative "vellum_ai/types/execute_prompt_response"
 require_relative "vellum_ai/types/workflow_request_input_request"
 require_relative "vellum_ai/types/workflow_expand_meta_request"
 require_relative "vellum_ai/types/execute_workflow_response"
+require_relative "vellum_ai/types/execute_workflow_async_response"
 require_relative "vellum_ai/types/generate_request"
 require_relative "vellum_ai/types/generate_options_request"
 require_relative "vellum_ai/types/generate_response"
@@ -348,6 +349,53 @@ end
 end
       Vellum::ExecuteWorkflowResponse.from_json(json_object: response.body)
     end
+# Executes a deployed Workflow asynchronously and returns the execution ID.
+    #
+    # @param inputs [Array<Hash>] The list of inputs defined in the Workflow's Deployment with their corresponding
+#  values.Request of type Array<Vellum::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 external_id [String] Optionally include a unique identifier for tracking purposes. Must be unique
+#  within a given Workspace.
+    # @param previous_execution_id [String] The ID of a previous Workflow Execution to reference for initial State loading.
+    # @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 request_options [Vellum::RequestOptions] 
+    # @return [Vellum::ExecuteWorkflowAsyncResponse]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.execute_workflow_async(inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
+    def execute_workflow_async(inputs:, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil, external_id: nil, previous_execution_id: nil, metadata: 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
+  end
+  unless request_options&.api_key.nil?
+    req.headers["X-API-KEY"] = request_options.api_key
+  end
+  unless request_options&.api_version.nil?
+    req.headers["X-API-Version"] = request_options.api_version
+  else
+    req.headers["X-API-Version"] = "2025-07-30"
+  end
+  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  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, workflow_deployment_id: workflow_deployment_id, workflow_deployment_name: workflow_deployment_name, release_tag: release_tag, external_id: external_id, previous_execution_id: previous_execution_id, metadata: metadata }.compact
+  req.url "#{@request_client.get_url(environment: Predict, request_options: request_options)}/v1/execute-workflow-async"
+end
+      Vellum::ExecuteWorkflowAsyncResponse.from_json(json_object: response.body)
+    end
 # Generate a completion using a previously defined deployment.
 #  Important: This endpoint is DEPRECATED and has been superseded by
 #  [execute-prompt](/api-reference/api-reference/execute-prompt).
@@ -820,6 +868,53 @@ end
 end
       Vellum::ExecuteWorkflowResponse.from_json(json_object: response.body)
     end
+# Executes a deployed Workflow asynchronously and returns the execution ID.
+    #
+    # @param inputs [Array<Hash>] The list of inputs defined in the Workflow's Deployment with their corresponding
+#  values.Request of type Array<Vellum::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 external_id [String] Optionally include a unique identifier for tracking purposes. Must be unique
+#  within a given Workspace.
+    # @param previous_execution_id [String] The ID of a previous Workflow Execution to reference for initial State loading.
+    # @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 request_options [Vellum::RequestOptions] 
+    # @return [Vellum::ExecuteWorkflowAsyncResponse]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.execute_workflow_async(inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
+    def execute_workflow_async(inputs:, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil, external_id: nil, previous_execution_id: nil, metadata: 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
+  end
+  unless request_options&.api_key.nil?
+    req.headers["X-API-KEY"] = request_options.api_key
+  end
+  unless request_options&.api_version.nil?
+    req.headers["X-API-Version"] = request_options.api_version
+  else
+    req.headers["X-API-Version"] = "2025-07-30"
+  end
+  req.headers = { **(req.headers || {}), **@async_request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
+  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, workflow_deployment_id: workflow_deployment_id, workflow_deployment_name: workflow_deployment_name, release_tag: release_tag, external_id: external_id, previous_execution_id: previous_execution_id, metadata: metadata }.compact
+  req.url "#{@async_request_client.get_url(environment: Predict, request_options: request_options)}/v1/execute-workflow-async"
+end
+      Vellum::ExecuteWorkflowAsyncResponse.from_json(json_object: response.body)
+    end
 # Generate a completion using a previously defined deployment.
 #  Important: This endpoint is DEPRECATED and has been superseded by
 #  [execute-prompt](/api-reference/api-reference/execute-prompt).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vellum_ai
 version: !ruby/object:Gem::Version
-  version: 1.10.9
+  version: 1.11.0
 platform: ruby
 authors:
 - Vellum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-19 00:00:00.000000000 Z
+date: 2025-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -291,6 +291,7 @@ files:
 - lib/vellum_ai/types/execute_api_response_json.rb
 - lib/vellum_ai/types/execute_prompt_event.rb
 - lib/vellum_ai/types/execute_prompt_response.rb
+- lib/vellum_ai/types/execute_workflow_async_response.rb
 - lib/vellum_ai/types/execute_workflow_response.rb
 - lib/vellum_ai/types/execute_workflow_workflow_result_event.rb
 - lib/vellum_ai/types/execution_array_vellum_value.rb