vellum_ai 1.11.3 → 1.11.8

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a60ad69d455a95ad07f2fc8f372c4b33f02ff1d029706aa9bda14a4e02ac654e
4
- data.tar.gz: 942fd246875f6513a390560f37eacaf9e8ca9c121d79f5a64066a0b56a91639f
3
+ metadata.gz: a15dd554d78522d4dc0205b34f344d8030be92823d34422a484ee99037284c82
4
+ data.tar.gz: 12b49269a10430bb0819c6a71acb91e080e13d2db05e1c3558523586a1050e98
5
5
  SHA512:
6
- metadata.gz: ff5e52bda3751837cede9f49267451deb82d64af6d7002862e21dce749b2da24659c855520075e93ef7fa4182faa759ee00646831ef55521fc282fb400dc9408
7
- data.tar.gz: c7bdcd32fa746bcc784e4f2979333350f26718c7c1a4501204e136d423c0837a885b6b3b1041077d78a780fb23d464daf6fc362d4f3482c7506f745b372b0235
6
+ metadata.gz: 1541e46c678c02c8f7f132f6e2eaeaa7be67e8899592668dd9fd1d361dccefeaa218f9bd89bf13f4c062311a82ece7b03f8714888e4cb4047df9c7e60f1aa3bb
7
+ data.tar.gz: 4d853bcf26d3adccf2461465ef05a038599455a1ca2fd199e247ff542fd5e9f044c19f58ef18dcc06ef07f303955f2727804b168684fd6de52b1a20fcc37b57a
data/lib/requests.rb CHANGED
@@ -56,7 +56,7 @@ end
56
56
  end
57
57
  # @return [Hash{String => String}]
58
58
  def get_headers
59
- headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.11.3' }
59
+ headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.11.8' }
60
60
  headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
61
61
  headers
62
62
  end
@@ -107,7 +107,7 @@ end
107
107
  end
108
108
  # @return [Hash{String => String}]
109
109
  def get_headers
110
- headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.11.3' }
110
+ headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '1.11.8' }
111
111
  headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
112
112
  headers
113
113
  end
data/lib/types_export.rb CHANGED
@@ -450,6 +450,7 @@ require_relative "vellum_ai/types/release_tag_release"
450
450
  require_relative "vellum_ai/types/release_tag_source"
451
451
  require_relative "vellum_ai/types/replace_test_suite_test_case_request"
452
452
  require_relative "vellum_ai/types/rich_text_child_block"
453
+ require_relative "vellum_ai/types/runner_config_request"
453
454
  require_relative "vellum_ai/types/sandbox_scenario"
454
455
  require_relative "vellum_ai/types/scenario_input_string_variable_value"
455
456
  require_relative "vellum_ai/types/scenario_input_json_variable_value"
@@ -17,7 +17,9 @@ module Vellum
17
17
  # * `LMNT` - LMNT
18
18
  # * `LINKEDIN` - LinkedIn
19
19
  # * `MAILCHIMP` - Mailchimp
20
+ # * `MIRO` - Miro
20
21
  # * `MEM0` - Mem0
22
+ # * `MONDAY` - Monday
21
23
  # * `NEON` - Neon
22
24
  # * `GITHUB` - Github
23
25
  # * `GOOGLE_SHEETS` - Google Sheets
@@ -70,10 +72,12 @@ module Vellum
70
72
  # * `SERPAPI` - Serp Api
71
73
  # * `SHARE_POINT` - SharePoint
72
74
  # * `SHORTCUT` - Shortcut
75
+ # * `SPOTIFY` - Spotify
73
76
  # * `STRIPE` - Stripe
74
77
  # * `SUPABASE` - Supabase
75
78
  # * `TAVILY` - Tavily
76
79
  # * `TELEGRAM` - Telegram
80
+ # * `TODOIST` - Todoist
77
81
  # * `WEBFLOW` - Webflow
78
82
  # * `YOUSEARCH` - You Search
79
83
  # * `ZENDESK` - Zendesk
@@ -104,7 +108,9 @@ module Vellum
104
108
  LMNT = "LMNT"
105
109
  LINKEDIN = "LINKEDIN"
106
110
  MAILCHIMP = "MAILCHIMP"
111
+ MIRO = "MIRO"
107
112
  MEM_0 = "MEM0"
113
+ MONDAY = "MONDAY"
108
114
  NEON = "NEON"
109
115
  GITHUB = "GITHUB"
110
116
  GOOGLE_SHEETS = "GOOGLE_SHEETS"
@@ -157,10 +163,12 @@ module Vellum
157
163
  SERPAPI = "SERPAPI"
158
164
  SHARE_POINT = "SHARE_POINT"
159
165
  SHORTCUT = "SHORTCUT"
166
+ SPOTIFY = "SPOTIFY"
160
167
  STRIPE = "STRIPE"
161
168
  SUPABASE = "SUPABASE"
162
169
  TAVILY = "TAVILY"
163
170
  TELEGRAM = "TELEGRAM"
171
+ TODOIST = "TODOIST"
164
172
  WEBFLOW = "WEBFLOW"
165
173
  YOUSEARCH = "YOUSEARCH"
166
174
  ZENDESK = "ZENDESK"
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+ require "ostruct"
3
+ require "json"
4
+
5
+ module Vellum
6
+ class RunnerConfigRequest
7
+ # @return [String]
8
+ attr_reader :container_image_name
9
+ # @return [String]
10
+ attr_reader :container_image_tag
11
+ # @return [String]
12
+ attr_reader :codegen_version
13
+ # @return [String]
14
+ attr_reader :sdk_version
15
+ # @return [Boolean]
16
+ attr_reader :is_deployment_inlining_enabled
17
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
18
+ attr_reader :additional_properties
19
+ # @return [Object]
20
+ attr_reader :_field_set
21
+ protected :_field_set
22
+
23
+ OMIT = Object.new
24
+
25
+ # @param container_image_name [String]
26
+ # @param container_image_tag [String]
27
+ # @param codegen_version [String]
28
+ # @param sdk_version [String]
29
+ # @param is_deployment_inlining_enabled [Boolean]
30
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
31
+ # @return [Vellum::RunnerConfigRequest]
32
+ def initialize(container_image_name: OMIT, container_image_tag: OMIT, codegen_version: OMIT, sdk_version: OMIT, is_deployment_inlining_enabled: OMIT, additional_properties: nil)
33
+ @container_image_name = container_image_name if container_image_name != OMIT
34
+ @container_image_tag = container_image_tag if container_image_tag != OMIT
35
+ @codegen_version = codegen_version if codegen_version != OMIT
36
+ @sdk_version = sdk_version if sdk_version != OMIT
37
+ @is_deployment_inlining_enabled = is_deployment_inlining_enabled if is_deployment_inlining_enabled != OMIT
38
+ @additional_properties = additional_properties
39
+ @_field_set = { "container_image_name": container_image_name, "container_image_tag": container_image_tag, "codegen_version": codegen_version, "sdk_version": sdk_version, "is_deployment_inlining_enabled": is_deployment_inlining_enabled }.reject do | _k, v |
40
+ v == OMIT
41
+ end
42
+ end
43
+ # Deserialize a JSON object to an instance of RunnerConfigRequest
44
+ #
45
+ # @param json_object [String]
46
+ # @return [Vellum::RunnerConfigRequest]
47
+ def self.from_json(json_object:)
48
+ struct = JSON.parse(json_object, object_class: OpenStruct)
49
+ parsed_json = JSON.parse(json_object)
50
+ container_image_name = parsed_json["container_image_name"]
51
+ container_image_tag = parsed_json["container_image_tag"]
52
+ codegen_version = parsed_json["codegen_version"]
53
+ sdk_version = parsed_json["sdk_version"]
54
+ is_deployment_inlining_enabled = parsed_json["is_deployment_inlining_enabled"]
55
+ new(
56
+ container_image_name: container_image_name,
57
+ container_image_tag: container_image_tag,
58
+ codegen_version: codegen_version,
59
+ sdk_version: sdk_version,
60
+ is_deployment_inlining_enabled: is_deployment_inlining_enabled,
61
+ additional_properties: struct
62
+ )
63
+ end
64
+ # Serialize an instance of RunnerConfigRequest to a JSON object
65
+ #
66
+ # @return [String]
67
+ def to_json
68
+ @_field_set&.to_json
69
+ end
70
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
71
+ # hash and check each fields type against the current object's property
72
+ # definitions.
73
+ #
74
+ # @param obj [Object]
75
+ # @return [Void]
76
+ def self.validate_raw(obj:)
77
+ obj.container_image_name&.is_a?(String) != false || raise("Passed value for field obj.container_image_name is not the expected type, validation failed.")
78
+ obj.container_image_tag&.is_a?(String) != false || raise("Passed value for field obj.container_image_tag is not the expected type, validation failed.")
79
+ obj.codegen_version&.is_a?(String) != false || raise("Passed value for field obj.codegen_version is not the expected type, validation failed.")
80
+ obj.sdk_version&.is_a?(String) != false || raise("Passed value for field obj.sdk_version is not the expected type, validation failed.")
81
+ obj.is_deployment_inlining_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.is_deployment_inlining_enabled is not the expected type, validation failed.")
82
+ end
83
+ end
84
+ end
@@ -4,7 +4,16 @@ require "json"
4
4
 
5
5
  module Vellum
6
6
  class VellumAudio
7
- # @return [String] A valid data URL containing the audio data.
7
+ # @return [String] The reference to the source data. This can be one of the following formats:
8
+ # 1. A base64-encoded data URL (e.g.,
9
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
10
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
11
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
12
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
13
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
14
+ # given its ID. See
15
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
16
+ # details.
8
17
  attr_reader :src
9
18
  # @return [Hash{String => Object}]
10
19
  attr_reader :metadata
@@ -16,7 +25,16 @@ module Vellum
16
25
 
17
26
  OMIT = Object.new
18
27
 
19
- # @param src [String] A valid data URL containing the audio data.
28
+ # @param src [String] The reference to the source data. This can be one of the following formats:
29
+ # 1. A base64-encoded data URL (e.g.,
30
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
31
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
32
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
33
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
34
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
35
+ # given its ID. See
36
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
37
+ # details.
20
38
  # @param metadata [Hash{String => Object}]
21
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
22
40
  # @return [Vellum::VellumAudio]
@@ -4,7 +4,16 @@ require "json"
4
4
 
5
5
  module Vellum
6
6
  class VellumAudioRequest
7
- # @return [String] A valid data URL containing the audio data.
7
+ # @return [String] The reference to the source data. This can be one of the following formats:
8
+ # 1. A base64-encoded data URL (e.g.,
9
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
10
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
11
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
12
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
13
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
14
+ # given its ID. See
15
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
16
+ # details.
8
17
  attr_reader :src
9
18
  # @return [Hash{String => Object}]
10
19
  attr_reader :metadata
@@ -16,7 +25,16 @@ module Vellum
16
25
 
17
26
  OMIT = Object.new
18
27
 
19
- # @param src [String] A valid data URL containing the audio data.
28
+ # @param src [String] The reference to the source data. This can be one of the following formats:
29
+ # 1. A base64-encoded data URL (e.g.,
30
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
31
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
32
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
33
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
34
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
35
+ # given its ID. See
36
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
37
+ # details.
20
38
  # @param metadata [Hash{String => Object}]
21
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
22
40
  # @return [Vellum::VellumAudioRequest]
@@ -4,7 +4,16 @@ require "json"
4
4
 
5
5
  module Vellum
6
6
  class VellumDocument
7
- # @return [String] A valid data URL containing the document data.
7
+ # @return [String] The reference to the source data. This can be one of the following formats:
8
+ # 1. A base64-encoded data URL (e.g.,
9
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
10
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
11
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
12
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
13
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
14
+ # given its ID. See
15
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
16
+ # details.
8
17
  attr_reader :src
9
18
  # @return [Hash{String => Object}]
10
19
  attr_reader :metadata
@@ -16,7 +25,16 @@ module Vellum
16
25
 
17
26
  OMIT = Object.new
18
27
 
19
- # @param src [String] A valid data URL containing the document data.
28
+ # @param src [String] The reference to the source data. This can be one of the following formats:
29
+ # 1. A base64-encoded data URL (e.g.,
30
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
31
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
32
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
33
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
34
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
35
+ # given its ID. See
36
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
37
+ # details.
20
38
  # @param metadata [Hash{String => Object}]
21
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
22
40
  # @return [Vellum::VellumDocument]
@@ -4,7 +4,16 @@ require "json"
4
4
 
5
5
  module Vellum
6
6
  class VellumDocumentRequest
7
- # @return [String] A valid data URL containing the document data.
7
+ # @return [String] The reference to the source data. This can be one of the following formats:
8
+ # 1. A base64-encoded data URL (e.g.,
9
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
10
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
11
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
12
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
13
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
14
+ # given its ID. See
15
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
16
+ # details.
8
17
  attr_reader :src
9
18
  # @return [Hash{String => Object}]
10
19
  attr_reader :metadata
@@ -16,7 +25,16 @@ module Vellum
16
25
 
17
26
  OMIT = Object.new
18
27
 
19
- # @param src [String] A valid data URL containing the document data.
28
+ # @param src [String] The reference to the source data. This can be one of the following formats:
29
+ # 1. A base64-encoded data URL (e.g.,
30
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
31
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
32
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
33
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
34
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
35
+ # given its ID. See
36
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
37
+ # details.
20
38
  # @param metadata [Hash{String => Object}]
21
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
22
40
  # @return [Vellum::VellumDocumentRequest]
@@ -4,7 +4,16 @@ require "json"
4
4
 
5
5
  module Vellum
6
6
  class VellumImage
7
- # @return [String] A valid data URL containing the image data.
7
+ # @return [String] The reference to the source data. This can be one of the following formats:
8
+ # 1. A base64-encoded data URL (e.g.,
9
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
10
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
11
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
12
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
13
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
14
+ # given its ID. See
15
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
16
+ # details.
8
17
  attr_reader :src
9
18
  # @return [Hash{String => Object}]
10
19
  attr_reader :metadata
@@ -16,7 +25,16 @@ module Vellum
16
25
 
17
26
  OMIT = Object.new
18
27
 
19
- # @param src [String] A valid data URL containing the image data.
28
+ # @param src [String] The reference to the source data. This can be one of the following formats:
29
+ # 1. A base64-encoded data URL (e.g.,
30
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
31
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
32
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
33
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
34
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
35
+ # given its ID. See
36
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
37
+ # details.
20
38
  # @param metadata [Hash{String => Object}]
21
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
22
40
  # @return [Vellum::VellumImage]
@@ -4,7 +4,16 @@ require "json"
4
4
 
5
5
  module Vellum
6
6
  class VellumImageRequest
7
- # @return [String] A valid data URL containing the image data.
7
+ # @return [String] The reference to the source data. This can be one of the following formats:
8
+ # 1. A base64-encoded data URL (e.g.,
9
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
10
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
11
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
12
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
13
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
14
+ # given its ID. See
15
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
16
+ # details.
8
17
  attr_reader :src
9
18
  # @return [Hash{String => Object}]
10
19
  attr_reader :metadata
@@ -16,7 +25,16 @@ module Vellum
16
25
 
17
26
  OMIT = Object.new
18
27
 
19
- # @param src [String] A valid data URL containing the image data.
28
+ # @param src [String] The reference to the source data. This can be one of the following formats:
29
+ # 1. A base64-encoded data URL (e.g.,
30
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
31
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
32
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
33
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
34
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
35
+ # given its ID. See
36
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
37
+ # details.
20
38
  # @param metadata [Hash{String => Object}]
21
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
22
40
  # @return [Vellum::VellumImageRequest]
@@ -4,7 +4,16 @@ require "json"
4
4
 
5
5
  module Vellum
6
6
  class VellumVideo
7
- # @return [String] A valid data URL containing the video data.
7
+ # @return [String] The reference to the source data. This can be one of the following formats:
8
+ # 1. A base64-encoded data URL (e.g.,
9
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
10
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
11
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
12
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
13
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
14
+ # given its ID. See
15
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
16
+ # details.
8
17
  attr_reader :src
9
18
  # @return [Hash{String => Object}]
10
19
  attr_reader :metadata
@@ -16,7 +25,16 @@ module Vellum
16
25
 
17
26
  OMIT = Object.new
18
27
 
19
- # @param src [String] A valid data URL containing the video data.
28
+ # @param src [String] The reference to the source data. This can be one of the following formats:
29
+ # 1. A base64-encoded data URL (e.g.,
30
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
31
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
32
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
33
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
34
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
35
+ # given its ID. See
36
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
37
+ # details.
20
38
  # @param metadata [Hash{String => Object}]
21
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
22
40
  # @return [Vellum::VellumVideo]
@@ -4,7 +4,16 @@ require "json"
4
4
 
5
5
  module Vellum
6
6
  class VellumVideoRequest
7
- # @return [String] A valid data URL containing the video data.
7
+ # @return [String] The reference to the source data. This can be one of the following formats:
8
+ # 1. A base64-encoded data URL (e.g.,
9
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
10
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
11
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
12
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
13
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
14
+ # given its ID. See
15
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
16
+ # details.
8
17
  attr_reader :src
9
18
  # @return [Hash{String => Object}]
10
19
  attr_reader :metadata
@@ -16,7 +25,16 @@ module Vellum
16
25
 
17
26
  OMIT = Object.new
18
27
 
19
- # @param src [String] A valid data URL containing the video data.
28
+ # @param src [String] The reference to the source data. This can be one of the following formats:
29
+ # 1. A base64-encoded data URL (e.g.,
30
+ # 'data:application/pdf;base64,JVBERi0xLjQKJcfs...').
31
+ # 2. A url pointing to a file accessible over HTTP or HTTPS.
32
+ # 3. A reference to a file that's been previously uploaded to Vellum, in the form
33
+ # of 'vellum:uploaded-file:{uploaded_file_id}'.
34
+ # You can use the Uploaded Files API to retrieve the url of the uploaded file
35
+ # given its ID. See
36
+ # https://docs.vellum.ai/developers/client-sdk/uploaded-files/retrieve for
37
+ # details.
20
38
  # @param metadata [Hash{String => Object}]
21
39
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
22
40
  # @return [Vellum::VellumVideoRequest]
@@ -40,11 +40,11 @@ module Vellum
40
40
  # @param value [Array<Vellum::VellumValue>]
41
41
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
42
42
  # @return [Vellum::WorkflowResultEventOutputDataArray]
43
- def initialize(id: OMIT, name:, state:, node_id:, delta: OMIT, type:, value: OMIT, additional_properties: nil)
43
+ def initialize(id: OMIT, name:, state:, node_id: OMIT, delta: OMIT, type:, value: OMIT, additional_properties: nil)
44
44
  @id = id if id != OMIT
45
45
  @name = name
46
46
  @state = state
47
- @node_id = node_id
47
+ @node_id = node_id if node_id != OMIT
48
48
  @delta = delta if delta != OMIT
49
49
  @type = type
50
50
  @value = value if value != OMIT
@@ -97,7 +97,7 @@ end
97
97
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
98
98
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
99
99
  obj.state.is_a?(Vellum::WorkflowNodeResultEventState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
100
- obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
100
+ obj.node_id&.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
101
101
  obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
102
102
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
103
103
  obj.value&.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
@@ -40,11 +40,11 @@ module Vellum
40
40
  # @param value [Array<Vellum::ChatMessage>]
41
41
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
42
42
  # @return [Vellum::WorkflowResultEventOutputDataChatHistory]
43
- def initialize(id: OMIT, name:, state:, node_id:, delta: OMIT, type:, value: OMIT, additional_properties: nil)
43
+ def initialize(id: OMIT, name:, state:, node_id: OMIT, delta: OMIT, type:, value: OMIT, additional_properties: nil)
44
44
  @id = id if id != OMIT
45
45
  @name = name
46
46
  @state = state
47
- @node_id = node_id
47
+ @node_id = node_id if node_id != OMIT
48
48
  @delta = delta if delta != OMIT
49
49
  @type = type
50
50
  @value = value if value != OMIT
@@ -99,7 +99,7 @@ end
99
99
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
100
100
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
101
101
  obj.state.is_a?(Vellum::WorkflowNodeResultEventState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
102
- obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
102
+ obj.node_id&.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
103
103
  obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
104
104
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
105
105
  obj.value&.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
@@ -40,11 +40,11 @@ module Vellum
40
40
  # @param value [Vellum::VellumError]
41
41
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
42
42
  # @return [Vellum::WorkflowResultEventOutputDataError]
43
- def initialize(id: OMIT, name:, state:, node_id:, delta: OMIT, type:, value: OMIT, additional_properties: nil)
43
+ def initialize(id: OMIT, name:, state:, node_id: OMIT, delta: OMIT, type:, value: OMIT, additional_properties: nil)
44
44
  @id = id if id != OMIT
45
45
  @name = name
46
46
  @state = state
47
- @node_id = node_id
47
+ @node_id = node_id if node_id != OMIT
48
48
  @delta = delta if delta != OMIT
49
49
  @type = type
50
50
  @value = value if value != OMIT
@@ -99,7 +99,7 @@ end
99
99
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
100
100
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
101
101
  obj.state.is_a?(Vellum::WorkflowNodeResultEventState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
102
- obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
102
+ obj.node_id&.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
103
103
  obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
104
104
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
105
105
  obj.value.nil? || Vellum::VellumError.validate_raw(obj: obj.value)
@@ -40,11 +40,11 @@ module Vellum
40
40
  # @param value [Vellum::FunctionCall]
41
41
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
42
42
  # @return [Vellum::WorkflowResultEventOutputDataFunctionCall]
43
- def initialize(id: OMIT, name:, state:, node_id:, delta: OMIT, type:, value: OMIT, additional_properties: nil)
43
+ def initialize(id: OMIT, name:, state:, node_id: OMIT, delta: OMIT, type:, value: OMIT, additional_properties: nil)
44
44
  @id = id if id != OMIT
45
45
  @name = name
46
46
  @state = state
47
- @node_id = node_id
47
+ @node_id = node_id if node_id != OMIT
48
48
  @delta = delta if delta != OMIT
49
49
  @type = type
50
50
  @value = value if value != OMIT
@@ -101,7 +101,7 @@ end
101
101
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
102
102
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
103
103
  obj.state.is_a?(Vellum::WorkflowNodeResultEventState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
104
- obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
104
+ obj.node_id&.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
105
105
  obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
106
106
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
107
107
  obj.value.nil? || Vellum::FunctionCall.validate_raw(obj: obj.value)
@@ -39,11 +39,11 @@ module Vellum
39
39
  # @param value [Object]
40
40
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
41
41
  # @return [Vellum::WorkflowResultEventOutputDataJson]
42
- def initialize(id: OMIT, name:, state:, node_id:, delta: OMIT, type:, value:, additional_properties: nil)
42
+ def initialize(id: OMIT, name:, state:, node_id: OMIT, delta: OMIT, type:, value:, additional_properties: nil)
43
43
  @id = id if id != OMIT
44
44
  @name = name
45
45
  @state = state
46
- @node_id = node_id
46
+ @node_id = node_id if node_id != OMIT
47
47
  @delta = delta if delta != OMIT
48
48
  @type = type
49
49
  @value = value
@@ -93,7 +93,7 @@ end
93
93
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
94
94
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
95
95
  obj.state.is_a?(Vellum::WorkflowNodeResultEventState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
96
- obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
96
+ obj.node_id&.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
97
97
  obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
98
98
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
99
99
  obj.value.is_a?(Object) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
@@ -39,11 +39,11 @@ module Vellum
39
39
  # @param value [Float]
40
40
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
41
41
  # @return [Vellum::WorkflowResultEventOutputDataNumber]
42
- def initialize(id: OMIT, name:, state:, node_id:, delta: OMIT, type:, value: OMIT, additional_properties: nil)
42
+ def initialize(id: OMIT, name:, state:, node_id: OMIT, delta: OMIT, type:, value: OMIT, additional_properties: nil)
43
43
  @id = id if id != OMIT
44
44
  @name = name
45
45
  @state = state
46
- @node_id = node_id
46
+ @node_id = node_id if node_id != OMIT
47
47
  @delta = delta if delta != OMIT
48
48
  @type = type
49
49
  @value = value if value != OMIT
@@ -93,7 +93,7 @@ end
93
93
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
94
94
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
95
95
  obj.state.is_a?(Vellum::WorkflowNodeResultEventState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
96
- obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
96
+ obj.node_id&.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
97
97
  obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
98
98
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
99
99
  obj.value&.is_a?(Float) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
@@ -40,11 +40,11 @@ module Vellum
40
40
  # @param value [Array<Vellum::SearchResult>]
41
41
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
42
42
  # @return [Vellum::WorkflowResultEventOutputDataSearchResults]
43
- def initialize(id: OMIT, name:, state:, node_id:, delta: OMIT, type:, value: OMIT, additional_properties: nil)
43
+ def initialize(id: OMIT, name:, state:, node_id: OMIT, delta: OMIT, type:, value: OMIT, additional_properties: nil)
44
44
  @id = id if id != OMIT
45
45
  @name = name
46
46
  @state = state
47
- @node_id = node_id
47
+ @node_id = node_id if node_id != OMIT
48
48
  @delta = delta if delta != OMIT
49
49
  @type = type
50
50
  @value = value if value != OMIT
@@ -99,7 +99,7 @@ end
99
99
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
100
100
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
101
101
  obj.state.is_a?(Vellum::WorkflowNodeResultEventState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
102
- obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
102
+ obj.node_id&.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
103
103
  obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
104
104
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
105
105
  obj.value&.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
@@ -39,11 +39,11 @@ module Vellum
39
39
  # @param value [String] The entire string value. Will be non-null for events of state FULFILLED.
40
40
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
41
41
  # @return [Vellum::WorkflowResultEventOutputDataString]
42
- def initialize(id: OMIT, name:, state:, node_id:, delta: OMIT, type:, value: OMIT, additional_properties: nil)
42
+ def initialize(id: OMIT, name:, state:, node_id: OMIT, delta: OMIT, type:, value: OMIT, additional_properties: nil)
43
43
  @id = id if id != OMIT
44
44
  @name = name
45
45
  @state = state
46
- @node_id = node_id
46
+ @node_id = node_id if node_id != OMIT
47
47
  @delta = delta if delta != OMIT
48
48
  @type = type
49
49
  @value = value if value != OMIT
@@ -93,7 +93,7 @@ end
93
93
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
94
94
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
95
95
  obj.state.is_a?(Vellum::WorkflowNodeResultEventState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
96
- obj.node_id.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
96
+ obj.node_id&.is_a?(String) != false || raise("Passed value for field obj.node_id is not the expected type, validation failed.")
97
97
  obj.delta&.is_a?(String) != false || raise("Passed value for field obj.delta is not the expected type, validation failed.")
98
98
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
99
99
  obj.value&.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
@@ -5,6 +5,7 @@ require_relative "../types/workflow_push_deployment_config_request"
5
5
  require_relative "../types/dataset_row_push_request"
6
6
  require_relative "../types/workflow_push_response"
7
7
  require_relative "../../core/file_utilities"
8
+ require_relative "../types/runner_config_request"
8
9
  require "json"
9
10
  require "async"
10
11
  require "async"
@@ -141,6 +142,12 @@ end
141
142
  #
142
143
  # @param files [Hash{String => Object}]
143
144
  # @param module_ [String]
145
+ # @param runner_config [Hash] Request of type Vellum::RunnerConfigRequest, as a Hash
146
+ # * :container_image_name (String)
147
+ # * :container_image_tag (String)
148
+ # * :codegen_version (String)
149
+ # * :sdk_version (String)
150
+ # * :is_deployment_inlining_enabled (Boolean)
144
151
  # @param request_options [Vellum::RequestOptions]
145
152
  # @return [Hash{String => Object}]
146
153
  # @example
@@ -150,7 +157,7 @@ end
150
157
  # api_key: "YOUR_API_KEY"
151
158
  # )
152
159
  # api.workflows.serialize_workflow_files(files: { "files": {"key":"value"} })
153
- def serialize_workflow_files(files:, module_: nil, request_options: nil)
160
+ def serialize_workflow_files(files:, module_: nil, runner_config: nil, request_options: nil)
154
161
  response = @request_client.conn.post do | req |
155
162
  unless request_options&.timeout_in_seconds.nil?
156
163
  req.options.timeout = request_options.timeout_in_seconds
@@ -167,7 +174,7 @@ end
167
174
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
168
175
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
169
176
  end
170
- req.body = { **(request_options&.additional_body_parameters || {}), files: files, module: module_ }.compact
177
+ req.body = { **(request_options&.additional_body_parameters || {}), files: files, module: module_, runner_config: runner_config }.compact
171
178
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflows/serialize"
172
179
  end
173
180
  parsed_json = JSON.parse(response.body)
@@ -308,6 +315,12 @@ end
308
315
  #
309
316
  # @param files [Hash{String => Object}]
310
317
  # @param module_ [String]
318
+ # @param runner_config [Hash] Request of type Vellum::RunnerConfigRequest, as a Hash
319
+ # * :container_image_name (String)
320
+ # * :container_image_tag (String)
321
+ # * :codegen_version (String)
322
+ # * :sdk_version (String)
323
+ # * :is_deployment_inlining_enabled (Boolean)
311
324
  # @param request_options [Vellum::RequestOptions]
312
325
  # @return [Hash{String => Object}]
313
326
  # @example
@@ -317,7 +330,7 @@ end
317
330
  # api_key: "YOUR_API_KEY"
318
331
  # )
319
332
  # api.workflows.serialize_workflow_files(files: { "files": {"key":"value"} })
320
- def serialize_workflow_files(files:, module_: nil, request_options: nil)
333
+ def serialize_workflow_files(files:, module_: nil, runner_config: nil, request_options: nil)
321
334
  Async do
322
335
  response = @request_client.conn.post do | req |
323
336
  unless request_options&.timeout_in_seconds.nil?
@@ -335,7 +348,7 @@ end
335
348
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
336
349
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
337
350
  end
338
- req.body = { **(request_options&.additional_body_parameters || {}), files: files, module: module_ }.compact
351
+ req.body = { **(request_options&.additional_body_parameters || {}), files: files, module: module_, runner_config: runner_config }.compact
339
352
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/workflows/serialize"
340
353
  end
341
354
  parsed_json = JSON.parse(response.body)
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.11.3
4
+ version: 1.11.8
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vellum
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-11-22 00:00:00.000000000 Z
11
+ date: 2025-11-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -571,6 +571,7 @@ files:
571
571
  - lib/vellum_ai/types/replace_test_suite_test_case_request.rb
572
572
  - lib/vellum_ai/types/rich_text_child_block.rb
573
573
  - lib/vellum_ai/types/rich_text_prompt_block.rb
574
+ - lib/vellum_ai/types/runner_config_request.rb
574
575
  - lib/vellum_ai/types/sandbox_scenario.rb
575
576
  - lib/vellum_ai/types/scenario_input.rb
576
577
  - lib/vellum_ai/types/scenario_input_audio_variable_value.rb