vellum_ai 1.2.2 → 1.2.3

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 (32) hide show
  1. checksums.yaml +4 -4
  2. data/lib/requests.rb +2 -2
  3. data/lib/types_export.rb +20 -0
  4. data/lib/vellum_ai/types/audio_input_request.rb +75 -0
  5. data/lib/vellum_ai/types/delimiter_chunker_config.rb +63 -0
  6. data/lib/vellum_ai/types/delimiter_chunker_config_request.rb +63 -0
  7. data/lib/vellum_ai/types/delimiter_chunking.rb +69 -0
  8. data/lib/vellum_ai/types/delimiter_chunking_request.rb +69 -0
  9. data/lib/vellum_ai/types/document_index_chunking.rb +16 -0
  10. data/lib/vellum_ai/types/document_index_chunking_request.rb +16 -0
  11. data/lib/vellum_ai/types/document_input_request.rb +75 -0
  12. data/lib/vellum_ai/types/execution_audio_vellum_value.rb +84 -0
  13. data/lib/vellum_ai/types/execution_document_vellum_value.rb +84 -0
  14. data/lib/vellum_ai/types/execution_image_vellum_value.rb +84 -0
  15. data/lib/vellum_ai/types/execution_vellum_value.rb +64 -0
  16. data/lib/vellum_ai/types/execution_video_vellum_value.rb +84 -0
  17. data/lib/vellum_ai/types/image_input_request.rb +75 -0
  18. data/lib/vellum_ai/types/logical_operator.rb +2 -0
  19. data/lib/vellum_ai/types/node_input_compiled_audio_value.rb +83 -0
  20. data/lib/vellum_ai/types/node_input_compiled_document_value.rb +83 -0
  21. data/lib/vellum_ai/types/node_input_compiled_image_value.rb +83 -0
  22. data/lib/vellum_ai/types/node_input_compiled_video_value.rb +83 -0
  23. data/lib/vellum_ai/types/node_input_variable_compiled_value.rb +64 -0
  24. data/lib/vellum_ai/types/prompt_deployment_input_request.rb +64 -0
  25. data/lib/vellum_ai/types/prompt_request_audio_input.rb +74 -0
  26. data/lib/vellum_ai/types/prompt_request_document_input.rb +74 -0
  27. data/lib/vellum_ai/types/prompt_request_image_input.rb +74 -0
  28. data/lib/vellum_ai/types/prompt_request_input.rb +64 -0
  29. data/lib/vellum_ai/types/prompt_request_video_input.rb +74 -0
  30. data/lib/vellum_ai/types/video_input_request.rb +75 -0
  31. data/lib/vellum_ai/workflow_executions/client.rb +8 -8
  32. metadata +22 -2
@@ -0,0 +1,74 @@
1
+ # frozen_string_literal: true
2
+ require_relative "vellum_video"
3
+ require "ostruct"
4
+ require "json"
5
+
6
+ module Vellum
7
+ class PromptRequestVideoInput
8
+ # @return [String] The variable's name, as defined in the Prompt.
9
+ attr_reader :key
10
+ # @return [String]
11
+ attr_reader :type
12
+ # @return [Vellum::VellumVideo]
13
+ attr_reader :value
14
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
15
+ attr_reader :additional_properties
16
+ # @return [Object]
17
+ attr_reader :_field_set
18
+ protected :_field_set
19
+
20
+ OMIT = Object.new
21
+
22
+ # @param key [String] The variable's name, as defined in the Prompt.
23
+ # @param type [String]
24
+ # @param value [Vellum::VellumVideo]
25
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
26
+ # @return [Vellum::PromptRequestVideoInput]
27
+ def initialize(key:, type:, value:, additional_properties: nil)
28
+ @key = key
29
+ @type = type
30
+ @value = value
31
+ @additional_properties = additional_properties
32
+ @_field_set = { "key": key, "type": type, "value": value }
33
+ end
34
+ # Deserialize a JSON object to an instance of PromptRequestVideoInput
35
+ #
36
+ # @param json_object [String]
37
+ # @return [Vellum::PromptRequestVideoInput]
38
+ def self.from_json(json_object:)
39
+ struct = JSON.parse(json_object, object_class: OpenStruct)
40
+ parsed_json = JSON.parse(json_object)
41
+ key = parsed_json["key"]
42
+ type = parsed_json["type"]
43
+ unless parsed_json["value"].nil?
44
+ value = parsed_json["value"].to_json
45
+ value = Vellum::VellumVideo.from_json(json_object: value)
46
+ else
47
+ value = nil
48
+ end
49
+ new(
50
+ key: key,
51
+ type: type,
52
+ value: value,
53
+ additional_properties: struct
54
+ )
55
+ end
56
+ # Serialize an instance of PromptRequestVideoInput to a JSON object
57
+ #
58
+ # @return [String]
59
+ def to_json
60
+ @_field_set&.to_json
61
+ end
62
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
63
+ # hash and check each fields type against the current object's property
64
+ # definitions.
65
+ #
66
+ # @param obj [Object]
67
+ # @return [Void]
68
+ def self.validate_raw(obj:)
69
+ obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
70
+ obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
71
+ Vellum::VellumVideo.validate_raw(obj: obj.value)
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,75 @@
1
+ # frozen_string_literal: true
2
+ require_relative "vellum_video_request"
3
+ require "ostruct"
4
+ require "json"
5
+
6
+ module Vellum
7
+ # A user input representing a Vellum Video value
8
+ class VideoInputRequest
9
+ # @return [String] The variable's name
10
+ attr_reader :name
11
+ # @return [String]
12
+ attr_reader :type
13
+ # @return [Vellum::VellumVideoRequest]
14
+ attr_reader :value
15
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
16
+ attr_reader :additional_properties
17
+ # @return [Object]
18
+ attr_reader :_field_set
19
+ protected :_field_set
20
+
21
+ OMIT = Object.new
22
+
23
+ # @param name [String] The variable's name
24
+ # @param type [String]
25
+ # @param value [Vellum::VellumVideoRequest]
26
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
27
+ # @return [Vellum::VideoInputRequest]
28
+ def initialize(name:, type:, value:, additional_properties: nil)
29
+ @name = name
30
+ @type = type
31
+ @value = value
32
+ @additional_properties = additional_properties
33
+ @_field_set = { "name": name, "type": type, "value": value }
34
+ end
35
+ # Deserialize a JSON object to an instance of VideoInputRequest
36
+ #
37
+ # @param json_object [String]
38
+ # @return [Vellum::VideoInputRequest]
39
+ def self.from_json(json_object:)
40
+ struct = JSON.parse(json_object, object_class: OpenStruct)
41
+ parsed_json = JSON.parse(json_object)
42
+ name = parsed_json["name"]
43
+ type = parsed_json["type"]
44
+ unless parsed_json["value"].nil?
45
+ value = parsed_json["value"].to_json
46
+ value = Vellum::VellumVideoRequest.from_json(json_object: value)
47
+ else
48
+ value = nil
49
+ end
50
+ new(
51
+ name: name,
52
+ type: type,
53
+ value: value,
54
+ additional_properties: struct
55
+ )
56
+ end
57
+ # Serialize an instance of VideoInputRequest to a JSON object
58
+ #
59
+ # @return [String]
60
+ def to_json
61
+ @_field_set&.to_json
62
+ end
63
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
64
+ # hash and check each fields type against the current object's property
65
+ # definitions.
66
+ #
67
+ # @param obj [Object]
68
+ # @return [Void]
69
+ def self.validate_raw(obj:)
70
+ obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
71
+ obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
72
+ Vellum::VellumVideoRequest.validate_raw(obj: obj.value)
73
+ end
74
+ end
75
+ end
@@ -16,6 +16,8 @@ module Vellum
16
16
  @request_client = request_client
17
17
  end
18
18
  # @param execution_id [String]
19
+ # @param prev_span_id [String] Optional keyset cursor span_id to continue from (exclusive)
20
+ # @param span_limit [Integer] Maximum number of spans to return (for lazy loading)
19
21
  # @param request_options [Vellum::RequestOptions]
20
22
  # @return [Vellum::WorkflowExecutionDetail]
21
23
  # @example
@@ -25,7 +27,7 @@ module Vellum
25
27
  # api_key: "YOUR_API_KEY"
26
28
  # )
27
29
  # api.workflow_executions.retrieve_workflow_execution_detail(execution_id: "execution_id")
28
- def retrieve_workflow_execution_detail(execution_id:, request_options: nil)
30
+ def retrieve_workflow_execution_detail(execution_id:, prev_span_id: nil, span_limit: nil, request_options: nil)
29
31
  response = @request_client.conn.get do | req |
30
32
  unless request_options&.timeout_in_seconds.nil?
31
33
  req.options.timeout = request_options.timeout_in_seconds
@@ -39,9 +41,7 @@ module Vellum
39
41
  req.headers["X-API-Version"] = "2025-07-30"
40
42
  end
41
43
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
42
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
43
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
44
- end
44
+ req.params = { **(request_options&.additional_query_parameters || {}), "prev_span_id": prev_span_id, "span_limit": span_limit }.compact
45
45
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
46
46
  req.body = { **(request_options&.additional_body_parameters || {}) }.compact
47
47
  end
@@ -61,6 +61,8 @@ end
61
61
  @request_client = request_client
62
62
  end
63
63
  # @param execution_id [String]
64
+ # @param prev_span_id [String] Optional keyset cursor span_id to continue from (exclusive)
65
+ # @param span_limit [Integer] Maximum number of spans to return (for lazy loading)
64
66
  # @param request_options [Vellum::RequestOptions]
65
67
  # @return [Vellum::WorkflowExecutionDetail]
66
68
  # @example
@@ -70,7 +72,7 @@ end
70
72
  # api_key: "YOUR_API_KEY"
71
73
  # )
72
74
  # api.workflow_executions.retrieve_workflow_execution_detail(execution_id: "execution_id")
73
- def retrieve_workflow_execution_detail(execution_id:, request_options: nil)
75
+ def retrieve_workflow_execution_detail(execution_id:, prev_span_id: nil, span_limit: nil, request_options: nil)
74
76
  Async do
75
77
  response = @request_client.conn.get do | req |
76
78
  unless request_options&.timeout_in_seconds.nil?
@@ -85,9 +87,7 @@ end
85
87
  req.headers["X-API-Version"] = "2025-07-30"
86
88
  end
87
89
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
88
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
89
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
90
- end
90
+ req.params = { **(request_options&.additional_query_parameters || {}), "prev_span_id": prev_span_id, "span_limit": span_limit }.compact
91
91
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
92
92
  req.body = { **(request_options&.additional_body_parameters || {}) }.compact
93
93
  end
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: 1.2.2
4
+ version: 1.2.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vellum
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-08-18 00:00:00.000000000 Z
11
+ date: 2025-08-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -174,6 +174,7 @@ files:
174
174
  - lib/vellum_ai/types/array_vellum_value_request.rb
175
175
  - lib/vellum_ai/types/audio_chat_message_content.rb
176
176
  - lib/vellum_ai/types/audio_chat_message_content_request.rb
177
+ - lib/vellum_ai/types/audio_input_request.rb
177
178
  - lib/vellum_ai/types/audio_prompt_block.rb
178
179
  - lib/vellum_ai/types/audio_vellum_value.rb
179
180
  - lib/vellum_ai/types/audio_vellum_value_request.rb
@@ -224,6 +225,10 @@ files:
224
225
  - lib/vellum_ai/types/container_image_container_image_tag.rb
225
226
  - lib/vellum_ai/types/container_image_read.rb
226
227
  - lib/vellum_ai/types/create_test_suite_test_case_request.rb
228
+ - lib/vellum_ai/types/delimiter_chunker_config.rb
229
+ - lib/vellum_ai/types/delimiter_chunker_config_request.rb
230
+ - lib/vellum_ai/types/delimiter_chunking.rb
231
+ - lib/vellum_ai/types/delimiter_chunking_request.rb
227
232
  - lib/vellum_ai/types/deployment_history_item.rb
228
233
  - lib/vellum_ai/types/deployment_provider_payload_response.rb
229
234
  - lib/vellum_ai/types/deployment_provider_payload_response_payload.rb
@@ -239,6 +244,7 @@ files:
239
244
  - lib/vellum_ai/types/document_index_indexing_config.rb
240
245
  - lib/vellum_ai/types/document_index_indexing_config_request.rb
241
246
  - lib/vellum_ai/types/document_index_read.rb
247
+ - lib/vellum_ai/types/document_input_request.rb
242
248
  - lib/vellum_ai/types/document_processing_state.rb
243
249
  - lib/vellum_ai/types/document_prompt_block.rb
244
250
  - lib/vellum_ai/types/document_read.rb
@@ -266,15 +272,19 @@ files:
266
272
  - lib/vellum_ai/types/execute_workflow_response.rb
267
273
  - lib/vellum_ai/types/execute_workflow_workflow_result_event.rb
268
274
  - lib/vellum_ai/types/execution_array_vellum_value.rb
275
+ - lib/vellum_ai/types/execution_audio_vellum_value.rb
269
276
  - lib/vellum_ai/types/execution_chat_history_vellum_value.rb
277
+ - lib/vellum_ai/types/execution_document_vellum_value.rb
270
278
  - lib/vellum_ai/types/execution_error_vellum_value.rb
271
279
  - lib/vellum_ai/types/execution_function_call_vellum_value.rb
280
+ - lib/vellum_ai/types/execution_image_vellum_value.rb
272
281
  - lib/vellum_ai/types/execution_json_vellum_value.rb
273
282
  - lib/vellum_ai/types/execution_number_vellum_value.rb
274
283
  - lib/vellum_ai/types/execution_search_results_vellum_value.rb
275
284
  - lib/vellum_ai/types/execution_string_vellum_value.rb
276
285
  - lib/vellum_ai/types/execution_thinking_vellum_value.rb
277
286
  - lib/vellum_ai/types/execution_vellum_value.rb
287
+ - lib/vellum_ai/types/execution_video_vellum_value.rb
278
288
  - lib/vellum_ai/types/external_input_descriptor.rb
279
289
  - lib/vellum_ai/types/external_parent_context.rb
280
290
  - lib/vellum_ai/types/external_test_case_execution.rb
@@ -333,6 +343,7 @@ files:
333
343
  - lib/vellum_ai/types/hkunlp_instructor_xl_vectorizer_request.rb
334
344
  - lib/vellum_ai/types/image_chat_message_content.rb
335
345
  - lib/vellum_ai/types/image_chat_message_content_request.rb
346
+ - lib/vellum_ai/types/image_input_request.rb
336
347
  - lib/vellum_ai/types/image_prompt_block.rb
337
348
  - lib/vellum_ai/types/image_vellum_value.rb
338
349
  - lib/vellum_ai/types/image_vellum_value_request.rb
@@ -408,14 +419,18 @@ files:
408
419
  - lib/vellum_ai/types/node_execution_streaming_body.rb
409
420
  - lib/vellum_ai/types/node_execution_streaming_event.rb
410
421
  - lib/vellum_ai/types/node_input_compiled_array_value.rb
422
+ - lib/vellum_ai/types/node_input_compiled_audio_value.rb
411
423
  - lib/vellum_ai/types/node_input_compiled_chat_history_value.rb
424
+ - lib/vellum_ai/types/node_input_compiled_document_value.rb
412
425
  - lib/vellum_ai/types/node_input_compiled_error_value.rb
413
426
  - lib/vellum_ai/types/node_input_compiled_function_call_value.rb
427
+ - lib/vellum_ai/types/node_input_compiled_image_value.rb
414
428
  - lib/vellum_ai/types/node_input_compiled_json_value.rb
415
429
  - lib/vellum_ai/types/node_input_compiled_number_value.rb
416
430
  - lib/vellum_ai/types/node_input_compiled_search_results_value.rb
417
431
  - lib/vellum_ai/types/node_input_compiled_secret_value.rb
418
432
  - lib/vellum_ai/types/node_input_compiled_string_value.rb
433
+ - lib/vellum_ai/types/node_input_compiled_video_value.rb
419
434
  - lib/vellum_ai/types/node_input_variable_compiled_value.rb
420
435
  - lib/vellum_ai/types/node_output_compiled_array_value.rb
421
436
  - lib/vellum_ai/types/node_output_compiled_chat_history_value.rb
@@ -475,10 +490,14 @@ files:
475
490
  - lib/vellum_ai/types/prompt_output.rb
476
491
  - lib/vellum_ai/types/prompt_parameters.rb
477
492
  - lib/vellum_ai/types/prompt_push_response.rb
493
+ - lib/vellum_ai/types/prompt_request_audio_input.rb
478
494
  - lib/vellum_ai/types/prompt_request_chat_history_input.rb
495
+ - lib/vellum_ai/types/prompt_request_document_input.rb
496
+ - lib/vellum_ai/types/prompt_request_image_input.rb
479
497
  - lib/vellum_ai/types/prompt_request_input.rb
480
498
  - lib/vellum_ai/types/prompt_request_json_input.rb
481
499
  - lib/vellum_ai/types/prompt_request_string_input.rb
500
+ - lib/vellum_ai/types/prompt_request_video_input.rb
482
501
  - lib/vellum_ai/types/prompt_settings.rb
483
502
  - lib/vellum_ai/types/prompt_version_build_config_sandbox.rb
484
503
  - lib/vellum_ai/types/raw_prompt_execution_overrides_request.rb
@@ -682,6 +701,7 @@ files:
682
701
  - lib/vellum_ai/types/vellum_workflow_execution_event.rb
683
702
  - lib/vellum_ai/types/video_chat_message_content.rb
684
703
  - lib/vellum_ai/types/video_chat_message_content_request.rb
704
+ - lib/vellum_ai/types/video_input_request.rb
685
705
  - lib/vellum_ai/types/video_prompt_block.rb
686
706
  - lib/vellum_ai/types/video_vellum_value.rb
687
707
  - lib/vellum_ai/types/video_vellum_value_request.rb