vellum_ai 0.3.7 → 0.3.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/lib/requests.rb +2 -2
  3. data/lib/types_export.rb +16 -0
  4. data/lib/vellum_ai/deployments/client.rb +2 -2
  5. data/lib/vellum_ai/types/array_enum.rb +5 -0
  6. data/lib/vellum_ai/types/array_variable_value_item.rb +155 -0
  7. data/lib/vellum_ai/types/chat_history_variable_value.rb +49 -0
  8. data/lib/vellum_ai/types/code_execution_node_result_data.rb +9 -4
  9. data/lib/vellum_ai/types/node_input_compiled_array_value.rb +59 -0
  10. data/lib/vellum_ai/types/node_input_variable_compiled_value.rb +13 -0
  11. data/lib/vellum_ai/types/node_output_compiled_array_value.rb +54 -0
  12. data/lib/vellum_ai/types/node_output_compiled_function_value.rb +56 -0
  13. data/lib/vellum_ai/types/node_output_compiled_value.rb +26 -0
  14. data/lib/vellum_ai/types/number_variable_value.rb +45 -0
  15. data/lib/vellum_ai/types/prompt_node_result_data.rb +10 -4
  16. data/lib/vellum_ai/types/search_results_variable_value.rb +49 -0
  17. data/lib/vellum_ai/types/subworkflow_enum.rb +5 -0
  18. data/lib/vellum_ai/types/subworkflow_node_result.rb +40 -0
  19. data/lib/vellum_ai/types/terminal_node_array_result.rb +59 -0
  20. data/lib/vellum_ai/types/terminal_node_function_call_result.rb +61 -0
  21. data/lib/vellum_ai/types/terminal_node_result_output.rb +26 -0
  22. data/lib/vellum_ai/types/vellum_error_code_enum.rb +2 -1
  23. data/lib/vellum_ai/types/workflow_deployment_read.rb +118 -0
  24. data/lib/vellum_ai/types/workflow_execution_event_error_code.rb +2 -1
  25. data/lib/vellum_ai/types/workflow_node_result_data.rb +13 -0
  26. data/lib/vellum_ai/types/workflow_output.rb +13 -0
  27. data/lib/vellum_ai/types/workflow_output_array.rb +60 -0
  28. data/lib/vellum_ai/types/workflow_request_chat_history_input_request.rb +1 -0
  29. data/lib/vellum_ai/types/workflow_request_json_input_request.rb +1 -0
  30. data/lib/vellum_ai/types/workflow_request_number_input_request.rb +1 -0
  31. data/lib/vellum_ai/types/workflow_request_string_input_request.rb +1 -0
  32. data/lib/vellum_ai/types/workflow_result_event_output_data.rb +26 -0
  33. data/lib/vellum_ai/types/workflow_result_event_output_data_array.rb +83 -0
  34. data/lib/vellum_ai/types/workflow_result_event_output_data_function_call.rb +85 -0
  35. data/lib/vellum_ai/workflow_deployments/client.rb +35 -6
  36. data/lib/vellum_ai.rb +4 -4
  37. metadata +18 -2
@@ -0,0 +1,60 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "array_variable_value_item"
4
+ require "json"
5
+
6
+ module Vellum
7
+ # An array output from a Workflow execution.
8
+ class WorkflowOutputArray
9
+ attr_reader :id, :name, :value, :additional_properties
10
+
11
+ # @param id [String]
12
+ # @param name [String] The output's name, as defined in the workflow
13
+ # @param value [Array<ArrayVariableValueItem>]
14
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
15
+ # @return [WorkflowOutputArray]
16
+ def initialize(id:, name:, value:, additional_properties: nil)
17
+ # @type [String]
18
+ @id = id
19
+ # @type [String] The output's name, as defined in the workflow
20
+ @name = name
21
+ # @type [Array<ArrayVariableValueItem>]
22
+ @value = value
23
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
24
+ @additional_properties = additional_properties
25
+ end
26
+
27
+ # Deserialize a JSON object to an instance of WorkflowOutputArray
28
+ #
29
+ # @param json_object [JSON]
30
+ # @return [WorkflowOutputArray]
31
+ def self.from_json(json_object:)
32
+ struct = JSON.parse(json_object, object_class: OpenStruct)
33
+ parsed_json = JSON.parse(json_object)
34
+ id = struct.id
35
+ name = struct.name
36
+ value = parsed_json["value"].map do |v|
37
+ v = v.to_json
38
+ ArrayVariableValueItem.from_json(json_object: v)
39
+ end
40
+ new(id: id, name: name, value: value, additional_properties: struct)
41
+ end
42
+
43
+ # Serialize an instance of WorkflowOutputArray to a JSON object
44
+ #
45
+ # @return [JSON]
46
+ def to_json(*_args)
47
+ { "id": @id, "name": @name, "value": @value }.to_json
48
+ end
49
+
50
+ # 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.
51
+ #
52
+ # @param obj [Object]
53
+ # @return [Void]
54
+ def self.validate_raw(obj:)
55
+ obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
56
+ obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
57
+ obj.value.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
58
+ end
59
+ end
60
+ end
@@ -4,6 +4,7 @@ require_relative "chat_message_request"
4
4
  require "json"
5
5
 
6
6
  module Vellum
7
+ # The input for a chat history variable in a Workflow.
7
8
  class WorkflowRequestChatHistoryInputRequest
8
9
  attr_reader :name, :value, :additional_properties
9
10
 
@@ -3,6 +3,7 @@
3
3
  require "json"
4
4
 
5
5
  module Vellum
6
+ # The input for a JSON variable in a Workflow.
6
7
  class WorkflowRequestJsonInputRequest
7
8
  attr_reader :name, :value, :additional_properties
8
9
 
@@ -3,6 +3,7 @@
3
3
  require "json"
4
4
 
5
5
  module Vellum
6
+ # The input for a number variable in a Workflow.
6
7
  class WorkflowRequestNumberInputRequest
7
8
  attr_reader :name, :value, :additional_properties
8
9
 
@@ -3,6 +3,7 @@
3
3
  require "json"
4
4
 
5
5
  module Vellum
6
+ # The input for a string variable in a Workflow.
6
7
  class WorkflowRequestStringInputRequest
7
8
  attr_reader :name, :value, :additional_properties
8
9
 
@@ -6,6 +6,8 @@ require_relative "workflow_result_event_output_data_number"
6
6
  require_relative "workflow_result_event_output_data_json"
7
7
  require_relative "workflow_result_event_output_data_chat_history"
8
8
  require_relative "workflow_result_event_output_data_search_results"
9
+ require_relative "workflow_result_event_output_data_array"
10
+ require_relative "workflow_result_event_output_data_function_call"
9
11
  require_relative "workflow_result_event_output_data_error"
10
12
 
11
13
  module Vellum
@@ -41,6 +43,10 @@ module Vellum
41
43
  WorkflowResultEventOutputDataChatHistory.from_json(json_object: json_object)
42
44
  when "SEARCH_RESULTS"
43
45
  WorkflowResultEventOutputDataSearchResults.from_json(json_object: json_object)
46
+ when "ARRAY"
47
+ WorkflowResultEventOutputDataArray.from_json(json_object: json_object)
48
+ when "FUNCTION_CALL"
49
+ WorkflowResultEventOutputDataFunctionCall.from_json(json_object: json_object)
44
50
  when "ERROR"
45
51
  WorkflowResultEventOutputDataError.from_json(json_object: json_object)
46
52
  else
@@ -64,6 +70,10 @@ module Vellum
64
70
  { **@member.to_json, type: @discriminant }.to_json
65
71
  when "SEARCH_RESULTS"
66
72
  { **@member.to_json, type: @discriminant }.to_json
73
+ when "ARRAY"
74
+ { **@member.to_json, type: @discriminant }.to_json
75
+ when "FUNCTION_CALL"
76
+ { **@member.to_json, type: @discriminant }.to_json
67
77
  when "ERROR"
68
78
  { **@member.to_json, type: @discriminant }.to_json
69
79
  else
@@ -88,6 +98,10 @@ module Vellum
88
98
  WorkflowResultEventOutputDataChatHistory.validate_raw(obj: obj)
89
99
  when "SEARCH_RESULTS"
90
100
  WorkflowResultEventOutputDataSearchResults.validate_raw(obj: obj)
101
+ when "ARRAY"
102
+ WorkflowResultEventOutputDataArray.validate_raw(obj: obj)
103
+ when "FUNCTION_CALL"
104
+ WorkflowResultEventOutputDataFunctionCall.validate_raw(obj: obj)
91
105
  when "ERROR"
92
106
  WorkflowResultEventOutputDataError.validate_raw(obj: obj)
93
107
  else
@@ -133,6 +147,18 @@ module Vellum
133
147
  new(member: member, discriminant: "SEARCH_RESULTS")
134
148
  end
135
149
 
150
+ # @param member [WorkflowResultEventOutputDataArray]
151
+ # @return [WorkflowResultEventOutputData]
152
+ def self.array(member:)
153
+ new(member: member, discriminant: "ARRAY")
154
+ end
155
+
156
+ # @param member [WorkflowResultEventOutputDataFunctionCall]
157
+ # @return [WorkflowResultEventOutputData]
158
+ def self.function_call(member:)
159
+ new(member: member, discriminant: "FUNCTION_CALL")
160
+ end
161
+
136
162
  # @param member [WorkflowResultEventOutputDataError]
137
163
  # @return [WorkflowResultEventOutputData]
138
164
  def self.error(member:)
@@ -0,0 +1,83 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "workflow_node_result_event_state"
4
+ require_relative "array_variable_value_item"
5
+ require "json"
6
+
7
+ module Vellum
8
+ # An Array output returned from a Workflow execution.
9
+ class WorkflowResultEventOutputDataArray
10
+ attr_reader :id, :name, :state, :node_id, :delta, :value, :additional_properties
11
+
12
+ # @param id [String]
13
+ # @param name [String]
14
+ # @param state [WORKFLOW_NODE_RESULT_EVENT_STATE]
15
+ # @param node_id [String]
16
+ # @param delta [String] The newly output string value. Only relevant for string outputs with a state of STREAMING.
17
+ # @param value [Array<ArrayVariableValueItem>]
18
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
19
+ # @return [WorkflowResultEventOutputDataArray]
20
+ def initialize(name:, state:, node_id:, id: nil, delta: nil, value: nil, additional_properties: nil)
21
+ # @type [String]
22
+ @id = id
23
+ # @type [String]
24
+ @name = name
25
+ # @type [WORKFLOW_NODE_RESULT_EVENT_STATE]
26
+ @state = state
27
+ # @type [String]
28
+ @node_id = node_id
29
+ # @type [String] The newly output string value. Only relevant for string outputs with a state of STREAMING.
30
+ @delta = delta
31
+ # @type [Array<ArrayVariableValueItem>]
32
+ @value = value
33
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
34
+ @additional_properties = additional_properties
35
+ end
36
+
37
+ # Deserialize a JSON object to an instance of WorkflowResultEventOutputDataArray
38
+ #
39
+ # @param json_object [JSON]
40
+ # @return [WorkflowResultEventOutputDataArray]
41
+ def self.from_json(json_object:)
42
+ struct = JSON.parse(json_object, object_class: OpenStruct)
43
+ parsed_json = JSON.parse(json_object)
44
+ id = struct.id
45
+ name = struct.name
46
+ state = WORKFLOW_NODE_RESULT_EVENT_STATE.key(parsed_json["state"]) || parsed_json["state"]
47
+ node_id = struct.node_id
48
+ delta = struct.delta
49
+ value = parsed_json["value"].map do |v|
50
+ v = v.to_json
51
+ ArrayVariableValueItem.from_json(json_object: v)
52
+ end
53
+ new(id: id, name: name, state: state, node_id: node_id, delta: delta, value: value, additional_properties: struct)
54
+ end
55
+
56
+ # Serialize an instance of WorkflowResultEventOutputDataArray to a JSON object
57
+ #
58
+ # @return [JSON]
59
+ def to_json(*_args)
60
+ {
61
+ "id": @id,
62
+ "name": @name,
63
+ "state": WORKFLOW_NODE_RESULT_EVENT_STATE[@state] || @state,
64
+ "node_id": @node_id,
65
+ "delta": @delta,
66
+ "value": @value
67
+ }.to_json
68
+ end
69
+
70
+ # 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.
71
+ #
72
+ # @param obj [Object]
73
+ # @return [Void]
74
+ def self.validate_raw(obj:)
75
+ obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
76
+ obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
77
+ obj.state.is_a?(WORKFLOW_NODE_RESULT_EVENT_STATE) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
78
+ obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
79
+ obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
80
+ obj.value&.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
81
+ end
82
+ end
83
+ end
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "workflow_node_result_event_state"
4
+ require_relative "function_call"
5
+ require "json"
6
+
7
+ module Vellum
8
+ # A Function Call output returned from a Workflow execution.
9
+ class WorkflowResultEventOutputDataFunctionCall
10
+ attr_reader :id, :name, :state, :node_id, :delta, :value, :additional_properties
11
+
12
+ # @param id [String]
13
+ # @param name [String]
14
+ # @param state [WORKFLOW_NODE_RESULT_EVENT_STATE]
15
+ # @param node_id [String]
16
+ # @param delta [String] The newly output string value. Only relevant for string outputs with a state of STREAMING.
17
+ # @param value [FunctionCall]
18
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
19
+ # @return [WorkflowResultEventOutputDataFunctionCall]
20
+ def initialize(name:, state:, node_id:, id: nil, delta: nil, value: nil, additional_properties: nil)
21
+ # @type [String]
22
+ @id = id
23
+ # @type [String]
24
+ @name = name
25
+ # @type [WORKFLOW_NODE_RESULT_EVENT_STATE]
26
+ @state = state
27
+ # @type [String]
28
+ @node_id = node_id
29
+ # @type [String] The newly output string value. Only relevant for string outputs with a state of STREAMING.
30
+ @delta = delta
31
+ # @type [FunctionCall]
32
+ @value = value
33
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
34
+ @additional_properties = additional_properties
35
+ end
36
+
37
+ # Deserialize a JSON object to an instance of WorkflowResultEventOutputDataFunctionCall
38
+ #
39
+ # @param json_object [JSON]
40
+ # @return [WorkflowResultEventOutputDataFunctionCall]
41
+ def self.from_json(json_object:)
42
+ struct = JSON.parse(json_object, object_class: OpenStruct)
43
+ parsed_json = JSON.parse(json_object)
44
+ id = struct.id
45
+ name = struct.name
46
+ state = WORKFLOW_NODE_RESULT_EVENT_STATE.key(parsed_json["state"]) || parsed_json["state"]
47
+ node_id = struct.node_id
48
+ delta = struct.delta
49
+ if parsed_json["value"].nil?
50
+ value = nil
51
+ else
52
+ value = parsed_json["value"].to_json
53
+ value = FunctionCall.from_json(json_object: value)
54
+ end
55
+ new(id: id, name: name, state: state, node_id: node_id, delta: delta, value: value, additional_properties: struct)
56
+ end
57
+
58
+ # Serialize an instance of WorkflowResultEventOutputDataFunctionCall to a JSON object
59
+ #
60
+ # @return [JSON]
61
+ def to_json(*_args)
62
+ {
63
+ "id": @id,
64
+ "name": @name,
65
+ "state": WORKFLOW_NODE_RESULT_EVENT_STATE[@state] || @state,
66
+ "node_id": @node_id,
67
+ "delta": @delta,
68
+ "value": @value
69
+ }.to_json
70
+ end
71
+
72
+ # 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.
73
+ #
74
+ # @param obj [Object]
75
+ # @return [Void]
76
+ def self.validate_raw(obj:)
77
+ obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
78
+ obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
79
+ obj.state.is_a?(WORKFLOW_NODE_RESULT_EVENT_STATE) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
80
+ obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
81
+ obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
82
+ obj.value.nil? || FunctionCall.validate_raw(obj: obj.value)
83
+ end
84
+ end
85
+ end
@@ -3,6 +3,7 @@
3
3
  require_relative "../../requests"
4
4
  require_relative "types/workflow_deployments_list_request_status"
5
5
  require_relative "../types/paginated_slim_workflow_deployment_list"
6
+ require_relative "../types/workflow_deployment_read"
6
7
  require "async"
7
8
 
8
9
  module Vellum
@@ -19,9 +20,7 @@ module Vellum
19
20
  # @param limit [Integer] Number of results to return per page.
20
21
  # @param offset [Integer] The initial index from which to return the results.
21
22
  # @param ordering [String] Which field to use when ordering the results.
22
- # @param status [WORKFLOW_DEPLOYMENTS_LIST_REQUEST_STATUS] The current status of the workflow deployment
23
- # - `ACTIVE` - Active
24
- # - `ARCHIVED` - Archived
23
+ # @param status [WORKFLOW_DEPLOYMENTS_LIST_REQUEST_STATUS] status
25
24
  # @param request_options [RequestOptions]
26
25
  # @return [PaginatedSlimWorkflowDeploymentList]
27
26
  def list(limit: nil, offset: nil, ordering: nil, status: nil, request_options: nil)
@@ -40,6 +39,21 @@ module Vellum
40
39
  end
41
40
  PaginatedSlimWorkflowDeploymentList.from_json(json_object: response.body)
42
41
  end
42
+
43
+ # Used to retrieve a workflow deployment given its ID or name.
44
+ #
45
+ # @param id [String] Either the Workflow Deployment's ID or its unique name
46
+ # @param request_options [RequestOptions]
47
+ # @return [WorkflowDeploymentRead]
48
+ def retrieve(id:, request_options: nil)
49
+ response = @request_client.conn.get do |req|
50
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
51
+ req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
52
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
53
+ req.url "#{@request_client.default_environment[:Default]}/v1/workflow-deployments/#{id}"
54
+ end
55
+ WorkflowDeploymentRead.from_json(json_object: response.body)
56
+ end
43
57
  end
44
58
 
45
59
  class AsyncWorkflowDeploymentsClient
@@ -55,9 +69,7 @@ module Vellum
55
69
  # @param limit [Integer] Number of results to return per page.
56
70
  # @param offset [Integer] The initial index from which to return the results.
57
71
  # @param ordering [String] Which field to use when ordering the results.
58
- # @param status [WORKFLOW_DEPLOYMENTS_LIST_REQUEST_STATUS] The current status of the workflow deployment
59
- # - `ACTIVE` - Active
60
- # - `ARCHIVED` - Archived
72
+ # @param status [WORKFLOW_DEPLOYMENTS_LIST_REQUEST_STATUS] status
61
73
  # @param request_options [RequestOptions]
62
74
  # @return [PaginatedSlimWorkflowDeploymentList]
63
75
  def list(limit: nil, offset: nil, ordering: nil, status: nil, request_options: nil)
@@ -78,5 +90,22 @@ module Vellum
78
90
  PaginatedSlimWorkflowDeploymentList.from_json(json_object: response.body)
79
91
  end
80
92
  end
93
+
94
+ # Used to retrieve a workflow deployment given its ID or name.
95
+ #
96
+ # @param id [String] Either the Workflow Deployment's ID or its unique name
97
+ # @param request_options [RequestOptions]
98
+ # @return [WorkflowDeploymentRead]
99
+ def retrieve(id:, request_options: nil)
100
+ Async do
101
+ response = @request_client.conn.get do |req|
102
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
103
+ req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
104
+ req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
105
+ req.url "#{@request_client.default_environment[:Default]}/v1/workflow-deployments/#{id}"
106
+ end
107
+ WorkflowDeploymentRead.from_json(json_object: response.body)
108
+ end
109
+ end
81
110
  end
82
111
  end
data/lib/vellum_ai.rb CHANGED
@@ -56,7 +56,7 @@ module Vellum
56
56
  # @param prompt_deployment_id [String] The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name.
57
57
  # @param prompt_deployment_name [String] The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
58
58
  # @param release_tag [String] Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
59
- # @param external_id [String]
59
+ # @param external_id [String] "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
60
60
  # @param expand_meta [Hash] The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.Request of type PromptDeploymentExpandMetaRequestRequest, as a Hash
61
61
  # * :model_name (Boolean)
62
62
  # * :latency (Boolean)
@@ -100,7 +100,7 @@ module Vellum
100
100
  # @param workflow_deployment_name [String] The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
101
101
  # @param release_tag [String] Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
102
102
  # @param inputs [Array<Hash>] The list of inputs defined in the Workflow's Deployment with their corresponding values.Request of type Array<WorkflowRequestInputRequest>, as a Hash
103
- # @param external_id [String] Optionally include a unique identifier for monitoring purposes.
103
+ # @param external_id [String] Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment.
104
104
  # @param request_options [RequestOptions]
105
105
  # @return [ExecuteWorkflowResponse]
106
106
  def execute_workflow(inputs:, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil,
@@ -278,7 +278,7 @@ module Vellum
278
278
  # @param prompt_deployment_id [String] The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name.
279
279
  # @param prompt_deployment_name [String] The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
280
280
  # @param release_tag [String] Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
281
- # @param external_id [String]
281
+ # @param external_id [String] "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
282
282
  # @param expand_meta [Hash] The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.Request of type PromptDeploymentExpandMetaRequestRequest, as a Hash
283
283
  # * :model_name (Boolean)
284
284
  # * :latency (Boolean)
@@ -322,7 +322,7 @@ module Vellum
322
322
  # @param workflow_deployment_name [String] The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
323
323
  # @param release_tag [String] Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
324
324
  # @param inputs [Array<Hash>] The list of inputs defined in the Workflow's Deployment with their corresponding values.Request of type Array<WorkflowRequestInputRequest>, as a Hash
325
- # @param external_id [String] Optionally include a unique identifier for monitoring purposes.
325
+ # @param external_id [String] Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment.
326
326
  # @param request_options [RequestOptions]
327
327
  # @return [ExecuteWorkflowResponse]
328
328
  def execute_workflow(inputs:, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: vellum_ai
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.7
4
+ version: 0.3.9
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vellum
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2024-02-29 00:00:00.000000000 Z
11
+ date: 2024-03-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: async-http-faraday
@@ -107,9 +107,12 @@ files:
107
107
  - lib/vellum_ai/types/array_chat_message_content_item.rb
108
108
  - lib/vellum_ai/types/array_chat_message_content_item_request.rb
109
109
  - lib/vellum_ai/types/array_chat_message_content_request.rb
110
+ - lib/vellum_ai/types/array_enum.rb
111
+ - lib/vellum_ai/types/array_variable_value_item.rb
110
112
  - lib/vellum_ai/types/block_type_enum.rb
111
113
  - lib/vellum_ai/types/chat_history_enum.rb
112
114
  - lib/vellum_ai/types/chat_history_input_request.rb
115
+ - lib/vellum_ai/types/chat_history_variable_value.rb
113
116
  - lib/vellum_ai/types/chat_message.rb
114
117
  - lib/vellum_ai/types/chat_message_content.rb
115
118
  - lib/vellum_ai/types/chat_message_content_request.rb
@@ -198,6 +201,7 @@ files:
198
201
  - lib/vellum_ai/types/named_test_case_search_results_variable_value_request.rb
199
202
  - lib/vellum_ai/types/named_test_case_string_variable_value_request.rb
200
203
  - lib/vellum_ai/types/named_test_case_variable_value_request.rb
204
+ - lib/vellum_ai/types/node_input_compiled_array_value.rb
201
205
  - lib/vellum_ai/types/node_input_compiled_chat_history_value.rb
202
206
  - lib/vellum_ai/types/node_input_compiled_error_value.rb
203
207
  - lib/vellum_ai/types/node_input_compiled_json_value.rb
@@ -205,8 +209,10 @@ files:
205
209
  - lib/vellum_ai/types/node_input_compiled_search_results_value.rb
206
210
  - lib/vellum_ai/types/node_input_compiled_string_value.rb
207
211
  - lib/vellum_ai/types/node_input_variable_compiled_value.rb
212
+ - lib/vellum_ai/types/node_output_compiled_array_value.rb
208
213
  - lib/vellum_ai/types/node_output_compiled_chat_history_value.rb
209
214
  - lib/vellum_ai/types/node_output_compiled_error_value.rb
215
+ - lib/vellum_ai/types/node_output_compiled_function_value.rb
210
216
  - lib/vellum_ai/types/node_output_compiled_json_value.rb
211
217
  - lib/vellum_ai/types/node_output_compiled_number_value.rb
212
218
  - lib/vellum_ai/types/node_output_compiled_search_results_value.rb
@@ -215,6 +221,7 @@ files:
215
221
  - lib/vellum_ai/types/normalized_log_probs.rb
216
222
  - lib/vellum_ai/types/normalized_token_log_probs.rb
217
223
  - lib/vellum_ai/types/number_enum.rb
224
+ - lib/vellum_ai/types/number_variable_value.rb
218
225
  - lib/vellum_ai/types/paginated_slim_deployment_read_list.rb
219
226
  - lib/vellum_ai/types/paginated_slim_document_list.rb
220
227
  - lib/vellum_ai/types/paginated_slim_workflow_deployment_list.rb
@@ -267,6 +274,7 @@ files:
267
274
  - lib/vellum_ai/types/search_result_merging_request.rb
268
275
  - lib/vellum_ai/types/search_result_request.rb
269
276
  - lib/vellum_ai/types/search_results_enum.rb
277
+ - lib/vellum_ai/types/search_results_variable_value.rb
270
278
  - lib/vellum_ai/types/search_weights_request.rb
271
279
  - lib/vellum_ai/types/slim_deployment_read.rb
272
280
  - lib/vellum_ai/types/slim_document.rb
@@ -283,6 +291,8 @@ files:
283
291
  - lib/vellum_ai/types/submit_completion_actual_request.rb
284
292
  - lib/vellum_ai/types/submit_completion_actuals_error_response.rb
285
293
  - lib/vellum_ai/types/submit_workflow_execution_actual_request.rb
294
+ - lib/vellum_ai/types/subworkflow_enum.rb
295
+ - lib/vellum_ai/types/subworkflow_node_result.rb
286
296
  - lib/vellum_ai/types/templating_node_chat_history_result.rb
287
297
  - lib/vellum_ai/types/templating_node_error_result.rb
288
298
  - lib/vellum_ai/types/templating_node_json_result.rb
@@ -292,8 +302,10 @@ files:
292
302
  - lib/vellum_ai/types/templating_node_result_output.rb
293
303
  - lib/vellum_ai/types/templating_node_search_results_result.rb
294
304
  - lib/vellum_ai/types/templating_node_string_result.rb
305
+ - lib/vellum_ai/types/terminal_node_array_result.rb
295
306
  - lib/vellum_ai/types/terminal_node_chat_history_result.rb
296
307
  - lib/vellum_ai/types/terminal_node_error_result.rb
308
+ - lib/vellum_ai/types/terminal_node_function_call_result.rb
297
309
  - lib/vellum_ai/types/terminal_node_json_result.rb
298
310
  - lib/vellum_ai/types/terminal_node_number_result.rb
299
311
  - lib/vellum_ai/types/terminal_node_result.rb
@@ -318,6 +330,7 @@ files:
318
330
  - lib/vellum_ai/types/vellum_image_request.rb
319
331
  - lib/vellum_ai/types/vellum_variable.rb
320
332
  - lib/vellum_ai/types/vellum_variable_type.rb
333
+ - lib/vellum_ai/types/workflow_deployment_read.rb
321
334
  - lib/vellum_ai/types/workflow_event_error.rb
322
335
  - lib/vellum_ai/types/workflow_execution_actual_chat_history_request.rb
323
336
  - lib/vellum_ai/types/workflow_execution_actual_json_request.rb
@@ -330,6 +343,7 @@ files:
330
343
  - lib/vellum_ai/types/workflow_node_result_event.rb
331
344
  - lib/vellum_ai/types/workflow_node_result_event_state.rb
332
345
  - lib/vellum_ai/types/workflow_output.rb
346
+ - lib/vellum_ai/types/workflow_output_array.rb
333
347
  - lib/vellum_ai/types/workflow_output_chat_history.rb
334
348
  - lib/vellum_ai/types/workflow_output_error.rb
335
349
  - lib/vellum_ai/types/workflow_output_function_call.rb
@@ -345,8 +359,10 @@ files:
345
359
  - lib/vellum_ai/types/workflow_request_string_input_request.rb
346
360
  - lib/vellum_ai/types/workflow_result_event.rb
347
361
  - lib/vellum_ai/types/workflow_result_event_output_data.rb
362
+ - lib/vellum_ai/types/workflow_result_event_output_data_array.rb
348
363
  - lib/vellum_ai/types/workflow_result_event_output_data_chat_history.rb
349
364
  - lib/vellum_ai/types/workflow_result_event_output_data_error.rb
365
+ - lib/vellum_ai/types/workflow_result_event_output_data_function_call.rb
350
366
  - lib/vellum_ai/types/workflow_result_event_output_data_json.rb
351
367
  - lib/vellum_ai/types/workflow_result_event_output_data_number.rb
352
368
  - lib/vellum_ai/types/workflow_result_event_output_data_search_results.rb