vellum_ai 0.3.8 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adb4760882a30ad83ab4941e55cb8a40ae87e258c1bf3e20e3ac448b2813e7f1
-  data.tar.gz: 8c59f859ad9128cb569fa0c4b1139097e46e7d6ad62c060aa87137d85275e001
+  metadata.gz: 7ee15857c4f6d078afa21d87b58baf72fa919289417db31edd4d749d76616dac
+  data.tar.gz: 2b3ef152052326857531cfcea45ee4baa5ec17285aeceab9f1e1fb42719e08f7
 SHA512:
-  metadata.gz: 5174ac6dcb5de429f610cf186a21badc4210d412c3a9286cde43e6c71687a604a3ea907e7a842a8be93e3cef159963c71e150455e7ab74122ced178e9fca03f7
-  data.tar.gz: 2bcf48bbf3e24cc50d1c3f06554cce5fff4381d9005bf4e965bb2df29e25a4ad2483f187f4ace29919c989d17c19923e888338f368812e54479ccd6523f1d68f
+  metadata.gz: 46b1deb69aee31554a0fef8440a43de43027687f2be4d39c39491a3b0221852961a00759ad42837ce6d2ad16a0aea89ecd2a7671e387e70fa3ac91c1093c7879
+  data.tar.gz: d9325756359ce00b83ba6fa59f6ae988e801c04e420645ae653e43f592a5ae702caac0ccc00c58e026c2ce4f92bd0490c99a6cf25c1865e689e3295d47a5440e

data/lib/requests.rb

@@ -20,7 +20,7 @@ module Vellum
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "Vellum",
-        "X-Fern-SDK-Version": "0.3.8",
+        "X-Fern-SDK-Version": "0.3.10",
         "X_API_KEY": api_key.to_s
       }
       @conn = Faraday.new(headers: @headers) do |faraday|
@@ -46,7 +46,7 @@ module Vellum
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "Vellum",
-        "X-Fern-SDK-Version": "0.3.8",
+        "X-Fern-SDK-Version": "0.3.10",
         "X_API_KEY": api_key.to_s
       }
       @conn = Faraday.new(headers: @headers) do |faraday|

data/lib/types_export.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "vellum_ai/deployments/types/deployments_list_request_status"
+require_relative "vellum_ai/document_indexes/types/document_indexes_list_request_status"
 require_relative "vellum_ai/workflow_deployments/types/workflow_deployments_list_request_status"
 require_relative "vellum_ai/types/api_node_result"
 require_relative "vellum_ai/types/api_node_result_data"
@@ -123,6 +124,7 @@ require_relative "vellum_ai/types/normalized_log_probs"
 require_relative "vellum_ai/types/normalized_token_log_probs"
 require_relative "vellum_ai/types/number_enum"
 require_relative "vellum_ai/types/number_variable_value"
+require_relative "vellum_ai/types/paginated_document_index_read_list"
 require_relative "vellum_ai/types/paginated_slim_deployment_read_list"
 require_relative "vellum_ai/types/paginated_slim_document_list"
 require_relative "vellum_ai/types/paginated_slim_workflow_deployment_list"
@@ -192,6 +194,8 @@ require_relative "vellum_ai/types/string_variable_value"
 require_relative "vellum_ai/types/submit_completion_actual_request"
 require_relative "vellum_ai/types/submit_completion_actuals_error_response"
 require_relative "vellum_ai/types/submit_workflow_execution_actual_request"
+require_relative "vellum_ai/types/subworkflow_enum"
+require_relative "vellum_ai/types/subworkflow_node_result"
 require_relative "vellum_ai/types/templating_node_chat_history_result"
 require_relative "vellum_ai/types/templating_node_error_result"
 require_relative "vellum_ai/types/templating_node_json_result"
@@ -201,8 +205,10 @@ require_relative "vellum_ai/types/templating_node_result_data"
 require_relative "vellum_ai/types/templating_node_result_output"
 require_relative "vellum_ai/types/templating_node_search_results_result"
 require_relative "vellum_ai/types/templating_node_string_result"
+require_relative "vellum_ai/types/terminal_node_array_result"
 require_relative "vellum_ai/types/terminal_node_chat_history_result"
 require_relative "vellum_ai/types/terminal_node_error_result"
+require_relative "vellum_ai/types/terminal_node_function_call_result"
 require_relative "vellum_ai/types/terminal_node_json_result"
 require_relative "vellum_ai/types/terminal_node_number_result"
 require_relative "vellum_ai/types/terminal_node_result"
@@ -240,6 +246,7 @@ require_relative "vellum_ai/types/workflow_node_result_data"
 require_relative "vellum_ai/types/workflow_node_result_event"
 require_relative "vellum_ai/types/workflow_node_result_event_state"
 require_relative "vellum_ai/types/workflow_output"
+require_relative "vellum_ai/types/workflow_output_array"
 require_relative "vellum_ai/types/workflow_output_chat_history"
 require_relative "vellum_ai/types/workflow_output_error"
 require_relative "vellum_ai/types/workflow_output_function_call"
@@ -255,8 +262,10 @@ require_relative "vellum_ai/types/workflow_request_number_input_request"
 require_relative "vellum_ai/types/workflow_request_string_input_request"
 require_relative "vellum_ai/types/workflow_result_event"
 require_relative "vellum_ai/types/workflow_result_event_output_data"
+require_relative "vellum_ai/types/workflow_result_event_output_data_array"
 require_relative "vellum_ai/types/workflow_result_event_output_data_chat_history"
 require_relative "vellum_ai/types/workflow_result_event_output_data_error"
+require_relative "vellum_ai/types/workflow_result_event_output_data_function_call"
 require_relative "vellum_ai/types/workflow_result_event_output_data_json"
 require_relative "vellum_ai/types/workflow_result_event_output_data_number"
 require_relative "vellum_ai/types/workflow_result_event_output_data_search_results"

data/lib/vellum_ai/document_indexes/client.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
+require_relative "types/document_indexes_list_request_status"
+require_relative "../types/paginated_document_index_read_list"
 require_relative "../types/entity_status"
 require_relative "../types/environment_enum"
 require_relative "../types/document_index_read"
@@ -17,6 +19,33 @@ module Vellum
       @request_client = request_client
     end
 
+    # Used to retrieve a list of Document Indexes.
+    #
+    # @param limit [Integer] Number of results to return per page.
+    # @param offset [Integer] The initial index from which to return the results.
+    # @param ordering [String] Which field to use when ordering the results.
+    # @param status [DOCUMENT_INDEXES_LIST_REQUEST_STATUS] The current status of the document index
+    #   - `ACTIVE` - Active
+    #   - `ARCHIVED` - Archived
+    # @param request_options [RequestOptions]
+    # @return [PaginatedDocumentIndexReadList]
+    def list(limit: nil, offset: nil, ordering: nil, status: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "limit": limit,
+          "offset": offset,
+          "ordering": ordering,
+          "status": status
+        }.compact
+        req.url "#{@request_client.default_environment[:Default]}/v1/document-indexes"
+      end
+      PaginatedDocumentIndexReadList.from_json(json_object: response.body)
+    end
+
     # Creates a new document index.
     #
     # @param label [String] A human-readable label for the document index
@@ -78,6 +107,35 @@ module Vellum
       @request_client = request_client
     end
 
+    # Used to retrieve a list of Document Indexes.
+    #
+    # @param limit [Integer] Number of results to return per page.
+    # @param offset [Integer] The initial index from which to return the results.
+    # @param ordering [String] Which field to use when ordering the results.
+    # @param status [DOCUMENT_INDEXES_LIST_REQUEST_STATUS] The current status of the document index
+    #   - `ACTIVE` - Active
+    #   - `ARCHIVED` - Archived
+    # @param request_options [RequestOptions]
+    # @return [PaginatedDocumentIndexReadList]
+    def list(limit: nil, offset: nil, ordering: nil, status: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "limit": limit,
+            "offset": offset,
+            "ordering": ordering,
+            "status": status
+          }.compact
+          req.url "#{@request_client.default_environment[:Default]}/v1/document-indexes"
+        end
+        PaginatedDocumentIndexReadList.from_json(json_object: response.body)
+      end
+    end
+
     # Creates a new document index.
     #
     # @param label [String] A human-readable label for the document index

data/lib/vellum_ai/document_indexes/types/document_indexes_list_request_status.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vellum
+  module DocumentIndexes
+    # @type [DOCUMENT_INDEXES_LIST_REQUEST_STATUS]
+    DOCUMENT_INDEXES_LIST_REQUEST_STATUS = { active: "ACTIVE", archived: "ARCHIVED" }.freeze
+  end
+end

data/lib/vellum_ai/types/code_execution_node_result_data.rb

@@ -5,14 +5,17 @@ require "json"
 
 module Vellum
   class CodeExecutionNodeResultData
-    attr_reader :output, :additional_properties
+    attr_reader :output, :log_output_id, :additional_properties
 
     # @param output [CodeExecutionNodeResultOutput]
+    # @param log_output_id [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [CodeExecutionNodeResultData]
-    def initialize(output:, additional_properties: nil)
+    def initialize(output:, log_output_id: nil, additional_properties: nil)
       # @type [CodeExecutionNodeResultOutput]
       @output = output
+      # @type [String]
+      @log_output_id = log_output_id
       # @type [OpenStruct] Additional properties unmapped to the current class definition
       @additional_properties = additional_properties
     end
@@ -30,14 +33,15 @@ module Vellum
         output = parsed_json["output"].to_json
         output = CodeExecutionNodeResultOutput.from_json(json_object: output)
       end
-      new(output: output, additional_properties: struct)
+      log_output_id = struct.log_output_id
+      new(output: output, log_output_id: log_output_id, additional_properties: struct)
     end
 
     # Serialize an instance of CodeExecutionNodeResultData to a JSON object
     #
     # @return [JSON]
     def to_json(*_args)
-      { "output": @output }.to_json
+      { "output": @output, "log_output_id": @log_output_id }.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.
@@ -46,6 +50,7 @@ module Vellum
     # @return [Void]
     def self.validate_raw(obj:)
       CodeExecutionNodeResultOutput.validate_raw(obj: obj.output)
+      obj.log_output_id&.is_a?(String) != false || raise("Passed value for field obj.log_output_id is not the expected type, validation failed.")
     end
   end
 end

data/lib/vellum_ai/types/node_input_compiled_array_value.rb

@@ -12,7 +12,7 @@ module Vellum
     # @param value [Array<ArrayVariableValueItem>]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [NodeInputCompiledArrayValue]
-    def initialize(node_input_id:, key:, value:, additional_properties: nil)
+    def initialize(node_input_id:, key:, value: nil, additional_properties: nil)
       # @type [String]
       @node_input_id = node_input_id
       # @type [String]
@@ -53,7 +53,7 @@ module Vellum
     def self.validate_raw(obj:)
       obj.node_input_id.is_a?(String) != false || raise("Passed value for field obj.node_input_id is not the expected type, validation failed.")
       obj.key.is_a?(String) != false || raise("Passed value for field obj.key 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.")
+      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/node_output_compiled_array_value.rb

@@ -11,7 +11,7 @@ module Vellum
     # @param value [Array<ArrayVariableValueItem>]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [NodeOutputCompiledArrayValue]
-    def initialize(node_output_id:, value:, additional_properties: nil)
+    def initialize(node_output_id:, value: nil, additional_properties: nil)
       # @type [String]
       @node_output_id = node_output_id
       # @type [Array<ArrayVariableValueItem>]
@@ -48,7 +48,7 @@ module Vellum
     # @return [Void]
     def self.validate_raw(obj:)
       obj.node_output_id.is_a?(String) != false || raise("Passed value for field obj.node_output_id 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.")
+      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/paginated_document_index_read_list.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "document_index_read"
+require "json"
+
+module Vellum
+  class PaginatedDocumentIndexReadList
+    attr_reader :count, :next_, :previous, :results, :additional_properties
+
+    # @param count [Integer]
+    # @param next_ [String]
+    # @param previous [String]
+    # @param results [Array<DocumentIndexRead>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [PaginatedDocumentIndexReadList]
+    def initialize(count: nil, next_: nil, previous: nil, results: nil, additional_properties: nil)
+      # @type [Integer]
+      @count = count
+      # @type [String]
+      @next_ = next_
+      # @type [String]
+      @previous = previous
+      # @type [Array<DocumentIndexRead>]
+      @results = results
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of PaginatedDocumentIndexReadList
+    #
+    # @param json_object [JSON]
+    # @return [PaginatedDocumentIndexReadList]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      count = struct.count
+      next_ = struct.next
+      previous = struct.previous
+      results = parsed_json["results"].map do |v|
+        v = v.to_json
+        DocumentIndexRead.from_json(json_object: v)
+      end
+      new(count: count, next_: next_, previous: previous, results: results, additional_properties: struct)
+    end
+
+    # Serialize an instance of PaginatedDocumentIndexReadList to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "count": @count, "next": @next_, "previous": @previous, "results": @results }.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.count&.is_a?(Integer) != false || raise("Passed value for field obj.count is not the expected type, validation failed.")
+      obj.next_&.is_a?(String) != false || raise("Passed value for field obj.next_ is not the expected type, validation failed.")
+      obj.previous&.is_a?(String) != false || raise("Passed value for field obj.previous is not the expected type, validation failed.")
+      obj.results&.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/subworkflow_enum.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vellum
+  SUBWORKFLOW_ENUM = String
+end

data/lib/vellum_ai/types/subworkflow_node_result.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vellum
+  # A Node Result Event emitted from a Subworkflow Node.
+  class SubworkflowNodeResult
+    attr_reader :additional_properties
+
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [SubworkflowNodeResult]
+    def initialize(additional_properties: nil)
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of SubworkflowNodeResult
+    #
+    # @param json_object [JSON]
+    # @return [SubworkflowNodeResult]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      new(additional_properties: struct)
+    end
+
+    # Serialize an instance of SubworkflowNodeResult to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      {}.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:); end
+  end
+end

data/lib/vellum_ai/types/terminal_node_array_result.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "array_variable_value_item"
+require "json"
+
+module Vellum
+  class TerminalNodeArrayResult
+    attr_reader :id, :name, :value, :additional_properties
+
+    # @param id [String]
+    # @param name [String] The unique name given to the terminal node that produced this output.
+    # @param value [Array<ArrayVariableValueItem>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TerminalNodeArrayResult]
+    def initialize(name:, id: nil, value: nil, additional_properties: nil)
+      # @type [String]
+      @id = id
+      # @type [String] The unique name given to the terminal node that produced this output.
+      @name = name
+      # @type [Array<ArrayVariableValueItem>]
+      @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 TerminalNodeArrayResult
+    #
+    # @param json_object [JSON]
+    # @return [TerminalNodeArrayResult]
+    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
+        ArrayVariableValueItem.from_json(json_object: v)
+      end
+      new(id: id, name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of TerminalNodeArrayResult 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/terminal_node_function_call_result.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "function_call"
+require "json"
+
+module Vellum
+  class TerminalNodeFunctionCallResult
+    attr_reader :id, :name, :value, :additional_properties
+
+    # @param id [String]
+    # @param name [String] The unique name given to the terminal node that produced this output.
+    # @param value [FunctionCall]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TerminalNodeFunctionCallResult]
+    def initialize(name:, id: nil, value: nil, additional_properties: nil)
+      # @type [String]
+      @id = id
+      # @type [String] The unique name given to the terminal node that produced this output.
+      @name = name
+      # @type [FunctionCall]
+      @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 TerminalNodeFunctionCallResult
+    #
+    # @param json_object [JSON]
+    # @return [TerminalNodeFunctionCallResult]
+    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
+      if parsed_json["value"].nil?
+        value = nil
+      else
+        value = parsed_json["value"].to_json
+        value = FunctionCall.from_json(json_object: value)
+      end
+      new(id: id, name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of TerminalNodeFunctionCallResult 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.nil? || FunctionCall.validate_raw(obj: obj.value)
+    end
+  end
+end

data/lib/vellum_ai/types/terminal_node_result_output.rb

@@ -6,6 +6,8 @@ require_relative "terminal_node_number_result"
 require_relative "terminal_node_json_result"
 require_relative "terminal_node_chat_history_result"
 require_relative "terminal_node_search_results_result"
+require_relative "terminal_node_array_result"
+require_relative "terminal_node_function_call_result"
 require_relative "terminal_node_error_result"
 
 module Vellum
@@ -41,6 +43,10 @@ module Vellum
                  TerminalNodeChatHistoryResult.from_json(json_object: json_object)
                when "SEARCH_RESULTS"
                  TerminalNodeSearchResultsResult.from_json(json_object: json_object)
+               when "ARRAY"
+                 TerminalNodeArrayResult.from_json(json_object: json_object)
+               when "FUNCTION_CALL"
+                 TerminalNodeFunctionCallResult.from_json(json_object: json_object)
                when "ERROR"
                  TerminalNodeErrorResult.from_json(json_object: json_object)
                else
@@ -64,6 +70,10 @@ module Vellum
         { **@member.to_json, type: @discriminant }.to_json
       when "SEARCH_RESULTS"
         { **@member.to_json, type: @discriminant }.to_json
+      when "ARRAY"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "FUNCTION_CALL"
+        { **@member.to_json, type: @discriminant }.to_json
       when "ERROR"
         { **@member.to_json, type: @discriminant }.to_json
       else
@@ -88,6 +98,10 @@ module Vellum
         TerminalNodeChatHistoryResult.validate_raw(obj: obj)
       when "SEARCH_RESULTS"
         TerminalNodeSearchResultsResult.validate_raw(obj: obj)
+      when "ARRAY"
+        TerminalNodeArrayResult.validate_raw(obj: obj)
+      when "FUNCTION_CALL"
+        TerminalNodeFunctionCallResult.validate_raw(obj: obj)
       when "ERROR"
         TerminalNodeErrorResult.validate_raw(obj: obj)
       else
@@ -133,6 +147,18 @@ module Vellum
       new(member: member, discriminant: "SEARCH_RESULTS")
     end
 
+    # @param member [TerminalNodeArrayResult]
+    # @return [TerminalNodeResultOutput]
+    def self.array(member:)
+      new(member: member, discriminant: "ARRAY")
+    end
+
+    # @param member [TerminalNodeFunctionCallResult]
+    # @return [TerminalNodeResultOutput]
+    def self.function_call(member:)
+      new(member: member, discriminant: "FUNCTION_CALL")
+    end
+
     # @param member [TerminalNodeErrorResult]
     # @return [TerminalNodeResultOutput]
     def self.error(member:)

data/lib/vellum_ai/types/vellum_error_code_enum.rb

@@ -5,6 +5,7 @@ module Vellum
   VELLUM_ERROR_CODE_ENUM = {
     invalid_request: "INVALID_REQUEST",
     provider_error: "PROVIDER_ERROR",
-    internal_server_error: "INTERNAL_SERVER_ERROR"
+    internal_server_error: "INTERNAL_SERVER_ERROR",
+    user_defined_error: "USER_DEFINED_ERROR"
   }.freeze
 end

data/lib/vellum_ai/types/workflow_execution_event_error_code.rb

@@ -8,6 +8,7 @@ module Vellum
     internal_server_error: "INTERNAL_SERVER_ERROR",
     node_execution: "NODE_EXECUTION",
     llm_provider: "LLM_PROVIDER",
-    invalid_template: "INVALID_TEMPLATE"
+    invalid_template: "INVALID_TEMPLATE",
+    user_defined_error: "USER_DEFINED_ERROR"
   }.freeze
 end

data/lib/vellum_ai/types/workflow_node_result_data.rb

@@ -8,6 +8,7 @@ require_relative "code_execution_node_result"
 require_relative "conditional_node_result"
 require_relative "api_node_result"
 require_relative "terminal_node_result"
+require_relative "subworkflow_node_result"
 
 module Vellum
   class WorkflowNodeResultData
@@ -46,6 +47,8 @@ module Vellum
                  ApiNodeResult.from_json(json_object: json_object)
                when "TERMINAL"
                  TerminalNodeResult.from_json(json_object: json_object)
+               when "SUBWORKFLOW"
+                 SubworkflowNodeResult.from_json(json_object: json_object)
                else
                  PromptNodeResult.from_json(json_object: json_object)
                end
@@ -71,6 +74,8 @@ module Vellum
         { **@member.to_json, type: @discriminant }.to_json
       when "TERMINAL"
         { **@member.to_json, type: @discriminant }.to_json
+      when "SUBWORKFLOW"
+        { **@member.to_json, type: @discriminant }.to_json
       else
         { "type": @discriminant, value: @member }.to_json
       end
@@ -97,6 +102,8 @@ module Vellum
         ApiNodeResult.validate_raw(obj: obj)
       when "TERMINAL"
         TerminalNodeResult.validate_raw(obj: obj)
+      when "SUBWORKFLOW"
+        SubworkflowNodeResult.validate_raw(obj: obj)
       else
         raise("Passed value matched no type within the union, validation failed.")
       end
@@ -151,5 +158,11 @@ module Vellum
     def self.terminal(member:)
       new(member: member, discriminant: "TERMINAL")
     end
+
+    # @param member [SubworkflowNodeResult]
+    # @return [WorkflowNodeResultData]
+    def self.subworkflow(member:)
+      new(member: member, discriminant: "SUBWORKFLOW")
+    end
   end
 end

data/lib/vellum_ai/types/workflow_output.rb

@@ -6,6 +6,7 @@ require_relative "workflow_output_number"
 require_relative "workflow_output_json"
 require_relative "workflow_output_chat_history"
 require_relative "workflow_output_search_results"
+require_relative "workflow_output_array"
 require_relative "workflow_output_error"
 require_relative "workflow_output_function_call"
 require_relative "workflow_output_image"
@@ -43,6 +44,8 @@ module Vellum
                  WorkflowOutputChatHistory.from_json(json_object: json_object)
                when "SEARCH_RESULTS"
                  WorkflowOutputSearchResults.from_json(json_object: json_object)
+               when "ARRAY"
+                 WorkflowOutputArray.from_json(json_object: json_object)
                when "ERROR"
                  WorkflowOutputError.from_json(json_object: json_object)
                when "FUNCTION_CALL"
@@ -70,6 +73,8 @@ module Vellum
         { **@member.to_json, type: @discriminant }.to_json
       when "SEARCH_RESULTS"
         { **@member.to_json, type: @discriminant }.to_json
+      when "ARRAY"
+        { **@member.to_json, type: @discriminant }.to_json
       when "ERROR"
         { **@member.to_json, type: @discriminant }.to_json
       when "FUNCTION_CALL"
@@ -98,6 +103,8 @@ module Vellum
         WorkflowOutputChatHistory.validate_raw(obj: obj)
       when "SEARCH_RESULTS"
         WorkflowOutputSearchResults.validate_raw(obj: obj)
+      when "ARRAY"
+        WorkflowOutputArray.validate_raw(obj: obj)
       when "ERROR"
         WorkflowOutputError.validate_raw(obj: obj)
       when "FUNCTION_CALL"
@@ -147,6 +154,12 @@ module Vellum
       new(member: member, discriminant: "SEARCH_RESULTS")
     end
 
+    # @param member [WorkflowOutputArray]
+    # @return [WorkflowOutput]
+    def self.array(member:)
+      new(member: member, discriminant: "ARRAY")
+    end
+
     # @param member [WorkflowOutputError]
     # @return [WorkflowOutput]
     def self.error(member:)

data/lib/vellum_ai/types/workflow_output_array.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "array_variable_value_item"
+require "json"
+
+module Vellum
+  # An array output from a Workflow execution.
+  class WorkflowOutputArray
+    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<ArrayVariableValueItem>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowOutputArray]
+    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<ArrayVariableValueItem>]
+      @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 WorkflowOutputArray
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowOutputArray]
+    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
+        ArrayVariableValueItem.from_json(json_object: v)
+      end
+      new(id: id, name: name, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowOutputArray 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_result_event_output_data.rb

@@ -6,6 +6,8 @@ require_relative "workflow_result_event_output_data_number"
 require_relative "workflow_result_event_output_data_json"
 require_relative "workflow_result_event_output_data_chat_history"
 require_relative "workflow_result_event_output_data_search_results"
+require_relative "workflow_result_event_output_data_array"
+require_relative "workflow_result_event_output_data_function_call"
 require_relative "workflow_result_event_output_data_error"
 
 module Vellum
@@ -41,6 +43,10 @@ module Vellum
                  WorkflowResultEventOutputDataChatHistory.from_json(json_object: json_object)
                when "SEARCH_RESULTS"
                  WorkflowResultEventOutputDataSearchResults.from_json(json_object: json_object)
+               when "ARRAY"
+                 WorkflowResultEventOutputDataArray.from_json(json_object: json_object)
+               when "FUNCTION_CALL"
+                 WorkflowResultEventOutputDataFunctionCall.from_json(json_object: json_object)
                when "ERROR"
                  WorkflowResultEventOutputDataError.from_json(json_object: json_object)
                else
@@ -64,6 +70,10 @@ module Vellum
         { **@member.to_json, type: @discriminant }.to_json
       when "SEARCH_RESULTS"
         { **@member.to_json, type: @discriminant }.to_json
+      when "ARRAY"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "FUNCTION_CALL"
+        { **@member.to_json, type: @discriminant }.to_json
       when "ERROR"
         { **@member.to_json, type: @discriminant }.to_json
       else
@@ -88,6 +98,10 @@ module Vellum
         WorkflowResultEventOutputDataChatHistory.validate_raw(obj: obj)
       when "SEARCH_RESULTS"
         WorkflowResultEventOutputDataSearchResults.validate_raw(obj: obj)
+      when "ARRAY"
+        WorkflowResultEventOutputDataArray.validate_raw(obj: obj)
+      when "FUNCTION_CALL"
+        WorkflowResultEventOutputDataFunctionCall.validate_raw(obj: obj)
       when "ERROR"
         WorkflowResultEventOutputDataError.validate_raw(obj: obj)
       else
@@ -133,6 +147,18 @@ module Vellum
       new(member: member, discriminant: "SEARCH_RESULTS")
     end
 
+    # @param member [WorkflowResultEventOutputDataArray]
+    # @return [WorkflowResultEventOutputData]
+    def self.array(member:)
+      new(member: member, discriminant: "ARRAY")
+    end
+
+    # @param member [WorkflowResultEventOutputDataFunctionCall]
+    # @return [WorkflowResultEventOutputData]
+    def self.function_call(member:)
+      new(member: member, discriminant: "FUNCTION_CALL")
+    end
+
     # @param member [WorkflowResultEventOutputDataError]
     # @return [WorkflowResultEventOutputData]
     def self.error(member:)

data/lib/vellum_ai/types/workflow_result_event_output_data_array.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "workflow_node_result_event_state"
+require_relative "array_variable_value_item"
+require "json"
+
+module Vellum
+  # An Array output returned from a Workflow execution.
+  class WorkflowResultEventOutputDataArray
+    attr_reader :id, :name, :state, :node_id, :delta, :value, :additional_properties
+
+    # @param id [String]
+    # @param name [String]
+    # @param state [WORKFLOW_NODE_RESULT_EVENT_STATE]
+    # @param node_id [String]
+    # @param delta [String] The newly output string value. Only relevant for string outputs with a state of STREAMING.
+    # @param value [Array<ArrayVariableValueItem>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowResultEventOutputDataArray]
+    def initialize(name:, state:, node_id:, id: nil, delta: nil, value: nil, additional_properties: nil)
+      # @type [String]
+      @id = id
+      # @type [String]
+      @name = name
+      # @type [WORKFLOW_NODE_RESULT_EVENT_STATE]
+      @state = state
+      # @type [String]
+      @node_id = node_id
+      # @type [String] The newly output string value. Only relevant for string outputs with a state of STREAMING.
+      @delta = delta
+      # @type [Array<ArrayVariableValueItem>]
+      @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 WorkflowResultEventOutputDataArray
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowResultEventOutputDataArray]
+    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
+      state = WORKFLOW_NODE_RESULT_EVENT_STATE.key(parsed_json["state"]) || parsed_json["state"]
+      node_id = struct.node_id
+      delta = struct.delta
+      value = parsed_json["value"].map do |v|
+        v = v.to_json
+        ArrayVariableValueItem.from_json(json_object: v)
+      end
+      new(id: id, name: name, state: state, node_id: node_id, delta: delta, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowResultEventOutputDataArray to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      {
+        "id": @id,
+        "name": @name,
+        "state": WORKFLOW_NODE_RESULT_EVENT_STATE[@state] || @state,
+        "node_id": @node_id,
+        "delta": @delta,
+        "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.state.is_a?(WORKFLOW_NODE_RESULT_EVENT_STATE) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
+      obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta 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_result_event_output_data_function_call.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "workflow_node_result_event_state"
+require_relative "function_call"
+require "json"
+
+module Vellum
+  # A Function Call output returned from a Workflow execution.
+  class WorkflowResultEventOutputDataFunctionCall
+    attr_reader :id, :name, :state, :node_id, :delta, :value, :additional_properties
+
+    # @param id [String]
+    # @param name [String]
+    # @param state [WORKFLOW_NODE_RESULT_EVENT_STATE]
+    # @param node_id [String]
+    # @param delta [String] The newly output string value. Only relevant for string outputs with a state of STREAMING.
+    # @param value [FunctionCall]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [WorkflowResultEventOutputDataFunctionCall]
+    def initialize(name:, state:, node_id:, id: nil, delta: nil, value: nil, additional_properties: nil)
+      # @type [String]
+      @id = id
+      # @type [String]
+      @name = name
+      # @type [WORKFLOW_NODE_RESULT_EVENT_STATE]
+      @state = state
+      # @type [String]
+      @node_id = node_id
+      # @type [String] The newly output string value. Only relevant for string outputs with a state of STREAMING.
+      @delta = delta
+      # @type [FunctionCall]
+      @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 WorkflowResultEventOutputDataFunctionCall
+    #
+    # @param json_object [JSON]
+    # @return [WorkflowResultEventOutputDataFunctionCall]
+    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
+      state = WORKFLOW_NODE_RESULT_EVENT_STATE.key(parsed_json["state"]) || parsed_json["state"]
+      node_id = struct.node_id
+      delta = struct.delta
+      if parsed_json["value"].nil?
+        value = nil
+      else
+        value = parsed_json["value"].to_json
+        value = FunctionCall.from_json(json_object: value)
+      end
+      new(id: id, name: name, state: state, node_id: node_id, delta: delta, value: value, additional_properties: struct)
+    end
+
+    # Serialize an instance of WorkflowResultEventOutputDataFunctionCall to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      {
+        "id": @id,
+        "name": @name,
+        "state": WORKFLOW_NODE_RESULT_EVENT_STATE[@state] || @state,
+        "node_id": @node_id,
+        "delta": @delta,
+        "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.state.is_a?(WORKFLOW_NODE_RESULT_EVENT_STATE) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
+      obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
+      obj.value.nil? || FunctionCall.validate_raw(obj: obj.value)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vellum_ai
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.10
 platform: ruby
 authors:
 - Vellum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -95,6 +95,7 @@ files:
 - lib/vellum_ai/deployments/client.rb
 - lib/vellum_ai/deployments/types/deployments_list_request_status.rb
 - lib/vellum_ai/document_indexes/client.rb
+- lib/vellum_ai/document_indexes/types/document_indexes_list_request_status.rb
 - lib/vellum_ai/documents/client.rb
 - lib/vellum_ai/folder_entities/client.rb
 - lib/vellum_ai/model_versions/client.rb
@@ -222,6 +223,7 @@ files:
 - lib/vellum_ai/types/normalized_token_log_probs.rb
 - lib/vellum_ai/types/number_enum.rb
 - lib/vellum_ai/types/number_variable_value.rb
+- lib/vellum_ai/types/paginated_document_index_read_list.rb
 - lib/vellum_ai/types/paginated_slim_deployment_read_list.rb
 - lib/vellum_ai/types/paginated_slim_document_list.rb
 - lib/vellum_ai/types/paginated_slim_workflow_deployment_list.rb
@@ -291,6 +293,8 @@ files:
 - lib/vellum_ai/types/submit_completion_actual_request.rb
 - lib/vellum_ai/types/submit_completion_actuals_error_response.rb
 - lib/vellum_ai/types/submit_workflow_execution_actual_request.rb
+- lib/vellum_ai/types/subworkflow_enum.rb
+- lib/vellum_ai/types/subworkflow_node_result.rb
 - lib/vellum_ai/types/templating_node_chat_history_result.rb
 - lib/vellum_ai/types/templating_node_error_result.rb
 - lib/vellum_ai/types/templating_node_json_result.rb
@@ -300,8 +304,10 @@ files:
 - lib/vellum_ai/types/templating_node_result_output.rb
 - lib/vellum_ai/types/templating_node_search_results_result.rb
 - lib/vellum_ai/types/templating_node_string_result.rb
+- lib/vellum_ai/types/terminal_node_array_result.rb
 - lib/vellum_ai/types/terminal_node_chat_history_result.rb
 - lib/vellum_ai/types/terminal_node_error_result.rb
+- lib/vellum_ai/types/terminal_node_function_call_result.rb
 - lib/vellum_ai/types/terminal_node_json_result.rb
 - lib/vellum_ai/types/terminal_node_number_result.rb
 - lib/vellum_ai/types/terminal_node_result.rb
@@ -339,6 +345,7 @@ files:
 - lib/vellum_ai/types/workflow_node_result_event.rb
 - lib/vellum_ai/types/workflow_node_result_event_state.rb
 - lib/vellum_ai/types/workflow_output.rb
+- lib/vellum_ai/types/workflow_output_array.rb
 - lib/vellum_ai/types/workflow_output_chat_history.rb
 - lib/vellum_ai/types/workflow_output_error.rb
 - lib/vellum_ai/types/workflow_output_function_call.rb
@@ -354,8 +361,10 @@ files:
 - lib/vellum_ai/types/workflow_request_string_input_request.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
 - lib/vellum_ai/types/workflow_result_event_output_data_chat_history.rb
 - lib/vellum_ai/types/workflow_result_event_output_data_error.rb
+- lib/vellum_ai/types/workflow_result_event_output_data_function_call.rb
 - lib/vellum_ai/types/workflow_result_event_output_data_json.rb
 - lib/vellum_ai/types/workflow_result_event_output_data_number.rb
 - lib/vellum_ai/types/workflow_result_event_output_data_search_results.rb