vellum_ai 0.3.4

data/lib/vellum_ai/types/workflow_output_json.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  # A JSON output from a Workflow execution.
+  class WorkflowOutputJson
+    attr_reader :id, :name, :value, :additional_properties
+
+    # @param id [String]
+    # @param name [String] The output's name, as defined in the workflow
+    # @param value [Hash{String => String}]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowOutputJson]
+    def initialize(id:, name:, value:, additional_properties: nil)
+      # @type [String]
+      @id = id
+      # @type [String] The output's name, as defined in the workflow
+      @name = name
+      # @type [Hash{String => String}]
+      @value = value
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowOutputJson
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowOutputJson]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      id = struct.id
+      name = struct.name
+      value = struct.value
+      new(id: id, name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowOutputJson to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "id": @id, "name": @name, "value": @value }.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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.value.is_a?(Hash) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/workflow_output_number.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  # A number output from a Workflow execution.
+  class WorkflowOutputNumber
+    attr_reader :id, :name, :value, :additional_properties
+
+    # @param id [String]
+    # @param name [String] The output's name, as defined in the workflow
+    # @param value [Float]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowOutputNumber]
+    def initialize(id:, name:, value:, additional_properties: nil)
+      # @type [String]
+      @id = id
+      # @type [String] The output's name, as defined in the workflow
+      @name = name
+      # @type [Float]
+      @value = value
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowOutputNumber
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowOutputNumber]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      id = struct.id
+      name = struct.name
+      value = struct.value
+      new(id: id, name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowOutputNumber to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "id": @id, "name": @name, "value": @value }.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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.value.is_a?(Float) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/workflow_output_search_results.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "search_result"
+require "json"
+
+module Vellum
+  # A search results output from a Workflow execution.
+  class WorkflowOutputSearchResults
+    attr_reader :id, :name, :value, :additional_properties
+
+    # @param id [String]
+    # @param name [String] The output's name, as defined in the workflow
+    # @param value [Array<SearchResult>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowOutputSearchResults]
+    def initialize(id:, name:, value:, additional_properties: nil)
+      # @type [String]
+      @id = id
+      # @type [String] The output's name, as defined in the workflow
+      @name = name
+      # @type [Array<SearchResult>]
+      @value = value
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowOutputSearchResults
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowOutputSearchResults]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = struct.id
+      name = struct.name
+      value = parsed_json["value"].map do |v|
+        v = v.to_json
+        SearchResult.from_json(json_object: v)
+      end
+      new(id: id, name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowOutputSearchResults to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "id": @id, "name": @name, "value": @value }.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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.value.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/workflow_output_string.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  # A string output from a Workflow execution.
+  class WorkflowOutputString
+    attr_reader :id, :name, :value, :additional_properties
+
+    # @param id [String]
+    # @param name [String] The output's name, as defined in the workflow
+    # @param value [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowOutputString]
+    def initialize(id:, name:, value:, additional_properties: nil)
+      # @type [String]
+      @id = id
+      # @type [String] The output's name, as defined in the workflow
+      @name = name
+      # @type [String]
+      @value = value
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowOutputString
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowOutputString]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      id = struct.id
+      name = struct.name
+      value = struct.value
+      new(id: id, name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowOutputString to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "id": @id, "name": @name, "value": @value }.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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/workflow_request_chat_history_input_request.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "chat_message_request"
+require "json"
+
+module Vellum
+  class WorkflowRequestChatHistoryInputRequest
+    attr_reader :name, :value, :additional_properties
+
+    # @param name [String] The variable's name, as defined in the Workflow.
+    # @param value [Array<ChatMessageRequest>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowRequestChatHistoryInputRequest]
+    def initialize(name:, value:, additional_properties: nil)
+      # @type [String] The variable's name, as defined in the Workflow.
+      @name = name
+      # @type [Array<ChatMessageRequest>]
+      @value = value
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowRequestChatHistoryInputRequest
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowRequestChatHistoryInputRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = struct.name
+      value = parsed_json["value"].map do |v|
+        v = v.to_json
+        ChatMessageRequest.from_json(json_object: v)
+      end
+      new(name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowRequestChatHistoryInputRequest to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "name": @name, "value": @value }.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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.value.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/workflow_request_input_request.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "workflow_request_string_input_request"
+require_relative "workflow_request_json_input_request"
+require_relative "workflow_request_chat_history_input_request"
+require_relative "workflow_request_number_input_request"
+
+module Vellum
+  class WorkflowRequestInputRequest
+    attr_reader :member, :discriminant
+
+    private_class_method :new
+    alias kind_of? is_a?
+    # @param member [Object]
+    # @param discriminant [String]
+    # @return [WorkflowRequestInputRequest]
+    def initialize(member:, discriminant:)
+      # @type [Object]
+      @member = member
+      # @type [String]
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowRequestInputRequest
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowRequestInputRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "STRING"
+                 WorkflowRequestStringInputRequest.from_json(json_object: json_object)
+               when "JSON"
+                 WorkflowRequestJsonInputRequest.from_json(json_object: json_object)
+               when "CHAT_HISTORY"
+                 WorkflowRequestChatHistoryInputRequest.from_json(json_object: json_object)
+               when "NUMBER"
+                 WorkflowRequestNumberInputRequest.from_json(json_object: json_object)
+               else
+                 WorkflowRequestStringInputRequest.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      case @discriminant
+      when "STRING"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "JSON"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "CHAT_HISTORY"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "NUMBER"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.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:)
+      case obj.type
+      when "STRING"
+        WorkflowRequestStringInputRequest.validate_raw(obj: obj)
+      when "JSON"
+        WorkflowRequestJsonInputRequest.validate_raw(obj: obj)
+      when "CHAT_HISTORY"
+        WorkflowRequestChatHistoryInputRequest.validate_raw(obj: obj)
+      when "NUMBER"
+        WorkflowRequestNumberInputRequest.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [WorkflowRequestStringInputRequest]
+    # @return [WorkflowRequestInputRequest]
+    def self.string(member:)
+      new(member: member, discriminant: "STRING")
+    end
+
+    # @param member [WorkflowRequestJsonInputRequest]
+    # @return [WorkflowRequestInputRequest]
+    def self.json(member:)
+      new(member: member, discriminant: "JSON")
+    end
+
+    # @param member [WorkflowRequestChatHistoryInputRequest]
+    # @return [WorkflowRequestInputRequest]
+    def self.chat_history(member:)
+      new(member: member, discriminant: "CHAT_HISTORY")
+    end
+
+    # @param member [WorkflowRequestNumberInputRequest]
+    # @return [WorkflowRequestInputRequest]
+    def self.number(member:)
+      new(member: member, discriminant: "NUMBER")
+    end
+  end
+end

data/lib/vellum_ai/types/workflow_request_json_input_request.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  class WorkflowRequestJsonInputRequest
+    attr_reader :name, :value, :additional_properties
+
+    # @param name [String] The variable's name, as defined in the Workflow.
+    # @param value [Hash{String => String}]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowRequestJsonInputRequest]
+    def initialize(name:, value:, additional_properties: nil)
+      # @type [String] The variable's name, as defined in the Workflow.
+      @name = name
+      # @type [Hash{String => String}]
+      @value = value
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowRequestJsonInputRequest
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowRequestJsonInputRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      name = struct.name
+      value = struct.value
+      new(name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowRequestJsonInputRequest to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "name": @name, "value": @value }.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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.value.is_a?(Hash) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/workflow_request_number_input_request.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  class WorkflowRequestNumberInputRequest
+    attr_reader :name, :value, :additional_properties
+
+    # @param name [String] The variable's name, as defined in the Workflow.
+    # @param value [Float]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowRequestNumberInputRequest]
+    def initialize(name:, value:, additional_properties: nil)
+      # @type [String] The variable's name, as defined in the Workflow.
+      @name = name
+      # @type [Float]
+      @value = value
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowRequestNumberInputRequest
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowRequestNumberInputRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      name = struct.name
+      value = struct.value
+      new(name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowRequestNumberInputRequest to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "name": @name, "value": @value }.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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.value.is_a?(Float) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/workflow_request_string_input_request.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  class WorkflowRequestStringInputRequest
+    attr_reader :name, :value, :additional_properties
+
+    # @param name [String] The variable's name, as defined in the Workflow.
+    # @param value [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowRequestStringInputRequest]
+    def initialize(name:, value:, additional_properties: nil)
+      # @type [String] The variable's name, as defined in the Workflow.
+      @name = name
+      # @type [String]
+      @value = value
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowRequestStringInputRequest
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowRequestStringInputRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      name = struct.name
+      value = struct.value
+      new(name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowRequestStringInputRequest to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "name": @name, "value": @value }.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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/workflow_result_event.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "workflow_node_result_event_state"
+require "date"
+require_relative "workflow_result_event_output_data"
+require_relative "workflow_event_error"
+require_relative "workflow_output"
+require "json"
+
+module Vellum
+  class WorkflowResultEvent
+    attr_reader :id, :state, :ts, :output, :error, :outputs, :additional_properties
+
+    # @param id [String]
+    # @param state [WORKFLOW_NODE_RESULT_EVENT_STATE]
+    # @param ts [DateTime]
+    # @param output [WorkflowResultEventOutputData]
+    # @param error [WorkflowEventError]
+    # @param outputs [Array<WorkflowOutput>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowResultEvent]
+    def initialize(id:, state:, ts:, output: nil, error: nil, outputs: nil, additional_properties: nil)
+      # @type [String]
+      @id = id
+      # @type [WORKFLOW_NODE_RESULT_EVENT_STATE]
+      @state = state
+      # @type [DateTime]
+      @ts = ts
+      # @type [WorkflowResultEventOutputData]
+      @output = output
+      # @type [WorkflowEventError]
+      @error = error
+      # @type [Array<WorkflowOutput>]
+      @outputs = outputs
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowResultEvent
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowResultEvent]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = struct.id
+      state = WORKFLOW_NODE_RESULT_EVENT_STATE.key(parsed_json["state"]) || parsed_json["state"]
+      ts = DateTime.parse(parsed_json["ts"])
+      if parsed_json["output"].nil?
+        output = nil
+      else
+        output = parsed_json["output"].to_json
+        output = WorkflowResultEventOutputData.from_json(json_object: output)
+      end
+      if parsed_json["error"].nil?
+        error = nil
+      else
+        error = parsed_json["error"].to_json
+        error = WorkflowEventError.from_json(json_object: error)
+      end
+      outputs = parsed_json["outputs"].map do |v|
+        v = v.to_json
+        WorkflowOutput.from_json(json_object: v)
+      end
+      new(id: id, state: state, ts: ts, output: output, error: error, outputs: outputs, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowResultEvent to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      {
+        "id": @id,
+        "state": WORKFLOW_NODE_RESULT_EVENT_STATE[@state] || @state,
+        "ts": @ts,
+        "output": @output,
+        "error": @error,
+        "outputs": @outputs
+      }.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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.state.is_a?(WORKFLOW_NODE_RESULT_EVENT_STATE) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      obj.ts.is_a?(DateTime) != false || raise("Passed value for field obj.ts is not the expected type, validation failed.")
+      obj.output.nil? || WorkflowResultEventOutputData.validate_raw(obj: obj.output)
+      obj.error.nil? || WorkflowEventError.validate_raw(obj: obj.error)
+      obj.outputs&.is_a?(Array) != false || raise("Passed value for field obj.outputs is not the expected type, validation failed.")
+    end
+  end
+end