vellum_ai 0.14.89 → 1.0.3

data/lib/vellum_ai/types/workflow_execution_detail.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+require_relative "parent_context"
+require "date"
+require "date"
+require_relative "execution_vellum_value"
+require_relative "workflow_error"
+require_relative "workflow_execution_usage_result"
+require_relative "vellum_span"
+require "ostruct"
+require "json"
+
+module Vellum
+  class WorkflowExecutionDetail
+  # @return [String] 
+    attr_reader :span_id
+  # @return [Vellum::ParentContext] 
+    attr_reader :parent_context
+  # @return [DateTime] 
+    attr_reader :start
+  # @return [DateTime] 
+    attr_reader :end_
+  # @return [Array<Vellum::ExecutionVellumValue>] 
+    attr_reader :inputs
+  # @return [Array<Vellum::ExecutionVellumValue>] 
+    attr_reader :outputs
+  # @return [Vellum::WorkflowError] 
+    attr_reader :error
+  # @return [Array<Vellum::WorkflowExecutionUsageResult>] 
+    attr_reader :usage_results
+  # @return [Array<Vellum::VellumSpan>] 
+    attr_reader :spans
+  # @return [Hash{String => Object}] 
+    attr_reader :state
+  # @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 span_id [String] 
+    # @param parent_context [Vellum::ParentContext] 
+    # @param start [DateTime] 
+    # @param end_ [DateTime] 
+    # @param inputs [Array<Vellum::ExecutionVellumValue>] 
+    # @param outputs [Array<Vellum::ExecutionVellumValue>] 
+    # @param error [Vellum::WorkflowError] 
+    # @param usage_results [Array<Vellum::WorkflowExecutionUsageResult>] 
+    # @param spans [Array<Vellum::VellumSpan>] 
+    # @param state [Hash{String => Object}] 
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::WorkflowExecutionDetail]
+    def initialize(span_id:, parent_context: OMIT, start:, end_: OMIT, inputs:, outputs:, error: OMIT, usage_results: OMIT, spans:, state: OMIT, additional_properties: nil)
+      @span_id = span_id
+      @parent_context = parent_context if parent_context != OMIT
+      @start = start
+      @end_ = end_ if end_ != OMIT
+      @inputs = inputs
+      @outputs = outputs
+      @error = error if error != OMIT
+      @usage_results = usage_results if usage_results != OMIT
+      @spans = spans
+      @state = state if state != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "span_id": span_id, "parent_context": parent_context, "start": start, "end": end_, "inputs": inputs, "outputs": outputs, "error": error, "usage_results": usage_results, "spans": spans, "state": state }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of WorkflowExecutionDetail
+    #
+    # @param json_object [String] 
+    # @return [Vellum::WorkflowExecutionDetail]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      span_id = parsed_json["span_id"]
+      unless parsed_json["parent_context"].nil?
+        parent_context = parsed_json["parent_context"].to_json
+        parent_context = Vellum::ParentContext.from_json(json_object: parent_context)
+      else
+        parent_context = nil
+      end
+      start = unless parsed_json["start"].nil?
+  DateTime.parse(parsed_json["start"])
+else
+  nil
+end
+      end_ = unless parsed_json["end"].nil?
+  DateTime.parse(parsed_json["end"])
+else
+  nil
+end
+      inputs = parsed_json["inputs"]&.map do | item |
+  item = item.to_json
+  Vellum::ExecutionVellumValue.from_json(json_object: item)
+end
+      outputs = parsed_json["outputs"]&.map do | item |
+  item = item.to_json
+  Vellum::ExecutionVellumValue.from_json(json_object: item)
+end
+      unless parsed_json["error"].nil?
+        error = parsed_json["error"].to_json
+        error = Vellum::WorkflowError.from_json(json_object: error)
+      else
+        error = nil
+      end
+      usage_results = parsed_json["usage_results"]&.map do | item |
+  item = item.to_json
+  Vellum::WorkflowExecutionUsageResult.from_json(json_object: item)
+end
+      spans = parsed_json["spans"]&.map do | item |
+  item = item.to_json
+  Vellum::VellumSpan.from_json(json_object: item)
+end
+      state = parsed_json["state"]
+      new(
+        span_id: span_id,
+        parent_context: parent_context,
+        start: start,
+        end_: end_,
+        inputs: inputs,
+        outputs: outputs,
+        error: error,
+        usage_results: usage_results,
+        spans: spans,
+        state: state,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of WorkflowExecutionDetail 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.span_id.is_a?(String) != false || raise("Passed value for field obj.span_id is not the expected type, validation failed.")
+      obj.parent_context.nil? || Vellum::ParentContext.validate_raw(obj: obj.parent_context)
+      obj.start.is_a?(DateTime) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
+      obj.end_&.is_a?(DateTime) != false || raise("Passed value for field obj.end_ 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.")
+      obj.outputs.is_a?(Array) != false || raise("Passed value for field obj.outputs is not the expected type, validation failed.")
+      obj.error.nil? || Vellum::WorkflowError.validate_raw(obj: obj.error)
+      obj.usage_results&.is_a?(Array) != false || raise("Passed value for field obj.usage_results is not the expected type, validation failed.")
+      obj.spans.is_a?(Array) != false || raise("Passed value for field obj.spans 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.")
+    end
+  end
+end

data/lib/vellum_ai/workflow_deployments/client.rb

@@ -55,6 +55,8 @@ module Vellum
   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
   req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "status": status }.compact
@@ -87,6 +89,8 @@ end
   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?
@@ -122,6 +126,8 @@ end
   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
   req.params = { **(request_options&.additional_query_parameters || {}), "filters": filters, "limit": limit, "offset": offset }.compact
@@ -153,6 +159,8 @@ end
   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?
@@ -192,6 +200,8 @@ end
   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?
@@ -230,6 +240,8 @@ end
   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
   req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "source": source }.compact
@@ -265,6 +277,8 @@ end
   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?
@@ -303,6 +317,8 @@ end
   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?
@@ -350,6 +366,8 @@ end
   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
   req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "status": status }.compact
@@ -384,6 +402,8 @@ end
   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?
@@ -421,6 +441,8 @@ end
   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
   req.params = { **(request_options&.additional_query_parameters || {}), "filters": filters, "limit": limit, "offset": offset }.compact
@@ -454,6 +476,8 @@ end
   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?
@@ -495,6 +519,8 @@ end
   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?
@@ -535,6 +561,8 @@ end
   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
   req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "source": source }.compact
@@ -572,6 +600,8 @@ end
   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?
@@ -612,6 +642,8 @@ end
   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?

data/lib/vellum_ai/workflow_executions/client.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+require_relative "../../requests"
+require_relative "../types/workflow_execution_detail"
+require "async"
+require_relative "../../requests"
+
+module Vellum
+  class WorkflowExecutionsClient
+  # @return [Vellum::RequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Vellum::RequestClient] 
+    # @return [Vellum::WorkflowExecutionsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+    # @param execution_id [String] 
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::WorkflowExecutionDetail]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.workflow_executions.retrieve_workflow_execution_detail(execution_id: "execution_id")
+    def retrieve_workflow_execution_detail(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: Default, request_options: request_options)}/v1/workflow-executions/#{execution_id}/detail"
+end
+      Vellum::WorkflowExecutionDetail.from_json(json_object: response.body)
+    end
+  end
+  class AsyncWorkflowExecutionsClient
+  # @return [Vellum::AsyncRequestClient] 
+    attr_reader :request_client
+
+
+    # @param request_client [Vellum::RequestClient] 
+    # @return [Vellum::AsyncWorkflowExecutionsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+    # @param execution_id [String] 
+    # @param request_options [Vellum::RequestOptions] 
+    # @return [Vellum::WorkflowExecutionDetail]
+    # @example
+#  api = Vellum::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Vellum::Environment::PRODUCTION,
+#    api_key: "YOUR_API_KEY"
+#  )
+#  api.workflow_executions.retrieve_workflow_execution_detail(execution_id: "execution_id")
+    def retrieve_workflow_execution_detail(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: Default, request_options: request_options)}/v1/workflow-executions/#{execution_id}/detail"
+end
+        Vellum::WorkflowExecutionDetail.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/vellum_ai/workflow_sandboxes/client.rb

@@ -51,6 +51,8 @@ module Vellum
   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?
@@ -87,6 +89,8 @@ end
   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
   req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "tag": tag }.compact
@@ -142,6 +146,8 @@ end
   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?
@@ -180,6 +186,8 @@ end
   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
   req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "tag": tag }.compact

data/lib/vellum_ai/workflows/client.rb

@@ -39,6 +39,8 @@ module Vellum
   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
   req.options.on_data = on_data
@@ -71,6 +73,8 @@ end
   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?
@@ -116,6 +120,8 @@ end
   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
   req.options.on_data = on_data
@@ -150,6 +156,8 @@ end
   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?

data/lib/vellum_ai/workspace_secrets/client.rb

@@ -38,6 +38,8 @@ module Vellum
   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?
@@ -74,6 +76,8 @@ end
   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?
@@ -118,6 +122,8 @@ end
   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?
@@ -156,6 +162,8 @@ end
   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?

data/lib/vellum_ai/workspaces/client.rb

@@ -36,6 +36,8 @@ module Vellum
   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?
@@ -81,6 +83,8 @@ end
   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?