vellum_ai 1.12.9 → 1.12.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '029663fe47808fb95f9c217bb9549b7705611aa23671baac9d049d23f7f4d5d6'
-  data.tar.gz: 6050e4b8921ca1b4ecbaaabb04a676378edf4d766b10e38b24d50dfcde0c8e0a
+  metadata.gz: ae78f900913e3723580e9ee1179cd0e70f2dd12bb180214d1b8f72d87ae3a420
+  data.tar.gz: 2e0541b5b250c957c05ca36c9c6374c192f0fb3098b28d3628a0ca8efa987324
 SHA512:
-  metadata.gz: 9f4a7929ad92558e45a975ea540900ef4d232898c221ab326a0036091b5049c74dd073d7892145fe0936adb3ffbba85c42574b6a4c5eb362071bf3d43faf8f81
-  data.tar.gz: 863c92142214ccb03844d26a4fb9a8a9c0ec6f3527868534d91c48229163178d809740126960357ddad266ac434a84ba100e180d5643148ec9aaf23bbdbe703c
+  metadata.gz: 6029a1ae20600f5f8dfc15cc7126aa37dc5c4064580a0d26ca9e1ee599cac5a9ea5df8fccfc45efa49de0c7313ac5630d359ab971462d372c0bd6e992290dfa3
+  data.tar.gz: e6907f7cb7e53c4b7c4715c58b12c5a7d7af1dec8a86b61f11a56aa502de1af03e72425c05f5c1499b63cfcfe6a51de729c497f024ae99f2ccab2ec5f86d5522

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Vellum.
+Copyright (c) 2026 Vellum.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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

@@ -68,6 +68,7 @@ require_relative "vellum_ai/types/chat_message_content_request"
 require_relative "vellum_ai/types/chat_message_prompt_block"
 require_relative "vellum_ai/types/chat_message_request"
 require_relative "vellum_ai/types/chat_message_role"
+require_relative "vellum_ai/types/check_workflow_execution_status_response"
 require_relative "vellum_ai/types/code_execution_node_array_result"
 require_relative "vellum_ai/types/code_execution_node_chat_history_result"
 require_relative "vellum_ai/types/code_execution_node_error_result"

data/lib/vellum_ai/types/check_workflow_execution_status_response.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+require_relative "workflow_result_event_state"
+require "ostruct"
+require "json"
+
+module Vellum
+# Response serializer for workflow execution status check.
+  class CheckWorkflowExecutionStatusResponse
+  # @return [Vellum::WorkflowResultEventState] 
+    attr_reader :status
+  # @return [Hash{String => Object}] 
+    attr_reader :outputs
+  # @return [String] 
+    attr_reader :execution_id
+  # @return [String] 
+    attr_reader :execution_detail_url
+  # @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 status [Vellum::WorkflowResultEventState] 
+    # @param outputs [Hash{String => Object}] 
+    # @param execution_id [String] 
+    # @param execution_detail_url [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::CheckWorkflowExecutionStatusResponse]
+    def initialize(status:, outputs: OMIT, execution_id:, execution_detail_url: OMIT, additional_properties: nil)
+      @status = status
+      @outputs = outputs if outputs != OMIT
+      @execution_id = execution_id
+      @execution_detail_url = execution_detail_url if execution_detail_url != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "status": status, "outputs": outputs, "execution_id": execution_id, "execution_detail_url": execution_detail_url }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of CheckWorkflowExecutionStatusResponse
+    #
+    # @param json_object [String] 
+    # @return [Vellum::CheckWorkflowExecutionStatusResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      status = parsed_json["status"]
+      outputs = parsed_json["outputs"]
+      execution_id = parsed_json["execution_id"]
+      execution_detail_url = parsed_json["execution_detail_url"]
+      new(
+        status: status,
+        outputs: outputs,
+        execution_id: execution_id,
+        execution_detail_url: execution_detail_url,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of CheckWorkflowExecutionStatusResponse 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.status.is_a?(Vellum::WorkflowResultEventState) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.outputs&.is_a?(Hash) != false || raise("Passed value for field obj.outputs is not the expected type, validation failed.")
+      obj.execution_id.is_a?(String) != false || raise("Passed value for field obj.execution_id is not the expected type, validation failed.")
+      obj.execution_detail_url&.is_a?(String) != false || raise("Passed value for field obj.execution_detail_url is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/workflows/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require_relative "../../requests"
 require_relative "../types/workflow_resolved_state"
+require_relative "../types/check_workflow_execution_status_response"
 require_relative "../types/workflow_push_deployment_config_request"
 require_relative "../types/dataset_row_push_request"
 require_relative "../types/workflow_push_response"
@@ -11,6 +12,7 @@ require "async"
 require "async"
 require "async"
 require "async"
+require "async"
 require_relative "../../requests"
 
 module Vellum
@@ -98,6 +100,44 @@ end
 end
       Vellum::WorkflowResolvedState.from_json(json_object: response.body)
     end
+# Checks if a workflow execution is currently executing (not fulfilled, not
+#  rejected, and has no end time).
+#  Uses the ClickHouse Prime summary materialized view.
+    #
+    # @param execution_id [String] 
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::CheckWorkflowExecutionStatusResponse]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.workflows.workflow_execution_status(execution_id: "execution_id")
+    def workflow_execution_status(execution_id:, request_options: nil)
+      response = @request_client.conn.get 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
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(environment: Predict, request_options: request_options)}/v1/workflows/executions/#{execution_id}/status"
+end
+      Vellum::CheckWorkflowExecutionStatusResponse.from_json(json_object: response.body)
+    end
     # @param exec_config [String] The execution configuration of the workflow. If not provided, it will be derived
 #  from the artifact.
     # @param workflow_sandbox_id [String] 
@@ -274,6 +314,46 @@ end
         Vellum::WorkflowResolvedState.from_json(json_object: response.body)
       end
     end
+# Checks if a workflow execution is currently executing (not fulfilled, not
+#  rejected, and has no end time).
+#  Uses the ClickHouse Prime summary materialized view.
+    #
+    # @param execution_id [String] 
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::CheckWorkflowExecutionStatusResponse]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.workflows.workflow_execution_status(execution_id: "execution_id")
+    def workflow_execution_status(execution_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get 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
+  unless request_options.nil? || request_options&.additional_body_parameters.nil?
+    req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+  end
+  req.url "#{@request_client.get_url(environment: Predict, request_options: request_options)}/v1/workflows/executions/#{execution_id}/status"
+end
+        Vellum::CheckWorkflowExecutionStatusResponse.from_json(json_object: response.body)
+      end
+    end
     # @param exec_config [String] The execution configuration of the workflow. If not provided, it will be derived
 #  from the artifact.
     # @param workflow_sandbox_id [String] 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vellum_ai
 version: !ruby/object:Gem::Version
-  version: 1.12.9
+  version: 1.12.10
 platform: ruby
 authors:
 - Vellum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-06 00:00:00.000000000 Z
+date: 2026-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -203,6 +203,7 @@ files:
 - lib/vellum_ai/types/chat_message_prompt_block.rb
 - lib/vellum_ai/types/chat_message_request.rb
 - lib/vellum_ai/types/chat_message_role.rb
+- lib/vellum_ai/types/check_workflow_execution_status_response.rb
 - lib/vellum_ai/types/code_execution_node_array_result.rb
 - lib/vellum_ai/types/code_execution_node_chat_history_result.rb
 - lib/vellum_ai/types/code_execution_node_error_result.rb