vellum_ai 1.6.4 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0377a4b9756ec0e34a6d69632958c6e569a6ec67ef1afde3f2b227db4f867890
-  data.tar.gz: 5dfdd50460f69e6edbfe780c854ab0304b1a61dfc4bb87726e016c074e0318ce
+  metadata.gz: 71eebd4545302eb788cc0a346efd39bdda98c6d88dd021c6e84db4ea62fb0d92
+  data.tar.gz: ecdbc69b304159caf540743308869bac22cc0bd6ce3294df9fe16cdd110762be
 SHA512:
-  metadata.gz: 29a623e57d8fe230cb5a95cf7078338132aee079f250ab45ab7a894a0caaa453abf8a79b6e564a48265310960ce4547175459409e7639cd21b92aab4cac85728
-  data.tar.gz: 8fa886e52b59943909a8adfc3037d47d39ddda8b78d1ea21fe3b23b0a03bb408af3c2c082ca2d27e47b86988061b7bfcb68be7ca89c362e4a10134c51203aca7
+  metadata.gz: 3142112780004864ba815f1c21d07bab490ff58c2138e1668e9ebb015c756f1d8eae86fb1b36e473a3ae8141f5e1be0c5989fe5b778a39c9e7ae45215fbf91d2
+  data.tar.gz: 844d8072a79987e863f708ef34e07b9477c091f594c7e4ee4837e01181093a81e32f4e20f048ac2438e508edeb2df2451d7e196e24479f61a05c90b380f16512

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

@@ -678,6 +678,7 @@ require_relative "vellum_ai/types/workflow_request_json_input_request"
 require_relative "vellum_ai/types/workflow_request_number_input_request"
 require_relative "vellum_ai/types/workflow_request_video_input_request"
 require_relative "vellum_ai/types/workflow_request_input_request"
+require_relative "vellum_ai/types/workflow_resolved_state"
 require_relative "vellum_ai/types/workflow_result_event"
 require_relative "vellum_ai/types/workflow_result_event_output_data_string"
 require_relative "vellum_ai/types/workflow_result_event_output_data_number"

data/lib/vellum_ai/container_images/client.rb

@@ -128,6 +128,7 @@ end
     # @param name [String] 
     # @param sha [String] 
     # @param tags [Array<String>] 
+    # @param force [Boolean] 
     # @param request_options [Vellum::RequestOptions] 
     # @return [Vellum::ContainerImageRead]
     # @example
@@ -141,7 +142,7 @@ end
 #    sha: "x",
 #    tags: ["tags", "tags"]
 #  )
-    def push_container_image(name:, sha:, tags:, request_options: nil)
+    def push_container_image(name:, sha:, tags:, force: 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
@@ -158,7 +159,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 || {}), name: name, sha: sha, tags: tags }.compact
+  req.body = { **(request_options&.additional_body_parameters || {}), name: name, sha: sha, tags: tags, force: force }.compact
   req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/container-images/push"
 end
       Vellum::ContainerImageRead.from_json(json_object: response.body)
@@ -288,6 +289,7 @@ end
     # @param name [String] 
     # @param sha [String] 
     # @param tags [Array<String>] 
+    # @param force [Boolean] 
     # @param request_options [Vellum::RequestOptions] 
     # @return [Vellum::ContainerImageRead]
     # @example
@@ -301,7 +303,7 @@ end
 #    sha: "x",
 #    tags: ["tags", "tags"]
 #  )
-    def push_container_image(name:, sha:, tags:, request_options: nil)
+    def push_container_image(name:, sha:, tags:, force: nil, request_options: nil)
       Async do
         response = @request_client.conn.post do | req |
   unless request_options&.timeout_in_seconds.nil?
@@ -319,7 +321,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 || {}), name: name, sha: sha, tags: tags }.compact
+  req.body = { **(request_options&.additional_body_parameters || {}), name: name, sha: sha, tags: tags, force: force }.compact
   req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/container-images/push"
 end
         Vellum::ContainerImageRead.from_json(json_object: response.body)

data/lib/vellum_ai/types/workflow_resolved_state.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+require "date"
+require "ostruct"
+require "json"
+
+module Vellum
+# The latest execution state of a given Workflow Execution
+  class WorkflowResolvedState
+  # @return [String] 
+    attr_reader :trace_id
+  # @return [DateTime] 
+    attr_reader :timestamp
+  # @return [String] 
+    attr_reader :span_id
+  # @return [Hash{String => Object}] 
+    attr_reader :state
+  # @return [String] 
+    attr_reader :previous_span_id
+  # @return [String] 
+    attr_reader :previous_trace_id
+  # @return [String] 
+    attr_reader :root_span_id
+  # @return [String] 
+    attr_reader :root_trace_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 trace_id [String] 
+    # @param timestamp [DateTime] 
+    # @param span_id [String] 
+    # @param state [Hash{String => Object}] 
+    # @param previous_span_id [String] 
+    # @param previous_trace_id [String] 
+    # @param root_span_id [String] 
+    # @param root_trace_id [String] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::WorkflowResolvedState]
+    def initialize(trace_id:, timestamp:, span_id:, state:, previous_span_id: OMIT, previous_trace_id: OMIT, root_span_id: OMIT, root_trace_id: OMIT, additional_properties: nil)
+      @trace_id = trace_id
+      @timestamp = timestamp
+      @span_id = span_id
+      @state = state
+      @previous_span_id = previous_span_id if previous_span_id != OMIT
+      @previous_trace_id = previous_trace_id if previous_trace_id != OMIT
+      @root_span_id = root_span_id if root_span_id != OMIT
+      @root_trace_id = root_trace_id if root_trace_id != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "trace_id": trace_id, "timestamp": timestamp, "span_id": span_id, "state": state, "previous_span_id": previous_span_id, "previous_trace_id": previous_trace_id, "root_span_id": root_span_id, "root_trace_id": root_trace_id }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of WorkflowResolvedState
+    #
+    # @param json_object [String] 
+    # @return [Vellum::WorkflowResolvedState]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      trace_id = parsed_json["trace_id"]
+      timestamp = unless parsed_json["timestamp"].nil?
+  DateTime.parse(parsed_json["timestamp"])
+else
+  nil
+end
+      span_id = parsed_json["span_id"]
+      state = parsed_json["state"]
+      previous_span_id = parsed_json["previous_span_id"]
+      previous_trace_id = parsed_json["previous_trace_id"]
+      root_span_id = parsed_json["root_span_id"]
+      root_trace_id = parsed_json["root_trace_id"]
+      new(
+        trace_id: trace_id,
+        timestamp: timestamp,
+        span_id: span_id,
+        state: state,
+        previous_span_id: previous_span_id,
+        previous_trace_id: previous_trace_id,
+        root_span_id: root_span_id,
+        root_trace_id: root_trace_id,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of WorkflowResolvedState 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.trace_id.is_a?(String) != false || raise("Passed value for field obj.trace_id is not the expected type, validation failed.")
+      obj.timestamp.is_a?(DateTime) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
+      obj.span_id.is_a?(String) != false || raise("Passed value for field obj.span_id is not the expected type, validation failed.")
+      obj.state.is_a?(Hash) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      obj.previous_span_id&.is_a?(String) != false || raise("Passed value for field obj.previous_span_id is not the expected type, validation failed.")
+      obj.previous_trace_id&.is_a?(String) != false || raise("Passed value for field obj.previous_trace_id is not the expected type, validation failed.")
+      obj.root_span_id&.is_a?(String) != false || raise("Passed value for field obj.root_span_id is not the expected type, validation failed.")
+      obj.root_trace_id&.is_a?(String) != false || raise("Passed value for field obj.root_trace_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/workflows/client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require_relative "../../requests"
+require_relative "../types/workflow_resolved_state"
 require_relative "../types/workflow_push_deployment_config_request"
 require_relative "../types/workflow_push_response"
 require_relative "../../core/file_utilities"
@@ -7,6 +8,7 @@ require "json"
 require "async"
 require "async"
 require "async"
+require "async"
 require_relative "../../requests"
 
 module Vellum
@@ -57,6 +59,43 @@ module Vellum
   req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflows/#{id}/pull"
 end
     end
+# Retrieve the current state of a workflow execution.
+#  **Note:** Uses a base url of `https://predict.vellum.ai`.
+    #
+    # @param span_id [String] The span ID of the workflow execution to retrieve state for
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::WorkflowResolvedState]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.workflows.retrieve_state(span_id: "span_id")
+    def retrieve_state(span_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/#{span_id}/state"
+end
+      Vellum::WorkflowResolvedState.from_json(json_object: response.body)
+    end
     # @param exec_config [String] The execution configuration of the workflow.
     # @param workflow_sandbox_id [String] 
     # @param deployment_config [Hash] Request of type Vellum::WorkflowPushDeploymentConfigRequest, as a Hash
@@ -179,6 +218,45 @@ end
 end
       end
     end
+# Retrieve the current state of a workflow execution.
+#  **Note:** Uses a base url of `https://predict.vellum.ai`.
+    #
+    # @param span_id [String] The span ID of the workflow execution to retrieve state for
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::WorkflowResolvedState]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.workflows.retrieve_state(span_id: "span_id")
+    def retrieve_state(span_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/#{span_id}/state"
+end
+        Vellum::WorkflowResolvedState.from_json(json_object: response.body)
+      end
+    end
     # @param exec_config [String] The execution configuration of the workflow.
     # @param workflow_sandbox_id [String] 
     # @param deployment_config [Hash] Request of type Vellum::WorkflowPushDeploymentConfigRequest, as a Hash

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vellum_ai
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.0
 platform: ruby
 authors:
 - Vellum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-03 00:00:00.000000000 Z
+date: 2025-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -829,6 +829,7 @@ files:
 - lib/vellum_ai/types/workflow_request_number_input_request.rb
 - lib/vellum_ai/types/workflow_request_string_input_request.rb
 - lib/vellum_ai/types/workflow_request_video_input_request.rb
+- lib/vellum_ai/types/workflow_resolved_state.rb
 - lib/vellum_ai/types/workflow_result_event.rb
 - lib/vellum_ai/types/workflow_result_event_output_data.rb
 - lib/vellum_ai/types/workflow_result_event_output_data_array.rb