vellum_ai 0.14.87 → 0.14.89

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.
data/lib/vellum_ai.rb CHANGED
@@ -1,6 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
  require_relative "environment"
3
3
  require_relative "types_export"
4
+ require_relative "vellum_ai/types/api_version_enum"
4
5
  require_relative "requests"
5
6
  require_relative "vellum_ai/ad_hoc/client"
6
7
  require_relative "vellum_ai/container_images/client"
@@ -93,14 +94,16 @@ module Vellum
93
94
  # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
94
95
  # @param timeout_in_seconds [Long]
95
96
  # @param api_key [String]
97
+ # @param api_version [Vellum::ApiVersionEnum]
96
98
  # @return [Vellum::Client]
97
- def initialize(base_url: nil, environment: Vellum::Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil, api_key:)
99
+ def initialize(base_url: nil, environment: Vellum::Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil, api_key:, api_version: nil)
98
100
  @request_client = Vellum::RequestClient.new(
99
101
  base_url: base_url,
100
102
  environment: environment,
101
103
  max_retries: max_retries,
102
104
  timeout_in_seconds: timeout_in_seconds,
103
- api_key: api_key
105
+ api_key: api_key,
106
+ api_version: api_version
104
107
  )
105
108
  @ad_hoc = Vellum::AdHocClient.new(request_client: @request_client)
106
109
  @container_images = Vellum::ContainerImagesClient.new(request_client: @request_client)
@@ -135,7 +138,7 @@ module Vellum
135
138
  # environment: Vellum::Environment::PRODUCTION,
136
139
  # api_key: "YOUR_API_KEY"
137
140
  # )
138
- # api.execute_api(url: "url")
141
+ # api.execute_api(url: "x")
139
142
  def execute_api(url:, method: nil, body: nil, headers: nil, bearer_token: nil, request_options: nil)
140
143
  response = @request_client.conn.post do | req |
141
144
  unless request_options&.timeout_in_seconds.nil?
@@ -144,6 +147,9 @@ module Vellum
144
147
  unless request_options&.api_key.nil?
145
148
  req.headers["X-API-KEY"] = request_options.api_key
146
149
  end
150
+ unless request_options&.api_version.nil?
151
+ req.headers["X-API-Version"] = request_options.api_version
152
+ end
147
153
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
148
154
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
149
155
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -170,10 +176,10 @@ end
170
176
  # api_key: "YOUR_API_KEY"
171
177
  # )
172
178
  # api.execute_code(
173
- # code: "code",
179
+ # code: "x",
174
180
  # runtime: PYTHON_3_11_6,
175
- # input_values: [{ name: "name", type: "STRING", value: "value" }],
176
- # packages: [{ version: "version", name: "name" }],
181
+ # input_values: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }],
182
+ # packages: [{ version: "version", name: "name" }, { version: "version", name: "name" }],
177
183
  # output_type: STRING
178
184
  # )
179
185
  def execute_code(code:, runtime:, input_values:, packages:, output_type:, request_options: nil)
@@ -184,6 +190,9 @@ end
184
190
  unless request_options&.api_key.nil?
185
191
  req.headers["X-API-KEY"] = request_options.api_key
186
192
  end
193
+ unless request_options&.api_version.nil?
194
+ req.headers["X-API-Version"] = request_options.api_version
195
+ end
187
196
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
188
197
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
189
198
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -234,7 +243,7 @@ end
234
243
  # environment: Vellum::Environment::PRODUCTION,
235
244
  # api_key: "YOUR_API_KEY"
236
245
  # )
237
- # api.execute_prompt(inputs: [{ name: "name", type: "STRING", value: "value" }])
246
+ # api.execute_prompt(inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
238
247
  def execute_prompt(inputs:, prompt_deployment_id: nil, prompt_deployment_name: nil, release_tag: nil, external_id: nil, expand_meta: nil, raw_overrides: nil, expand_raw: nil, metadata: nil, request_options: nil)
239
248
  response = @request_client.conn.post do | req |
240
249
  unless request_options&.timeout_in_seconds.nil?
@@ -243,6 +252,9 @@ end
243
252
  unless request_options&.api_key.nil?
244
253
  req.headers["X-API-KEY"] = request_options.api_key
245
254
  end
255
+ unless request_options&.api_version.nil?
256
+ req.headers["X-API-Version"] = request_options.api_version
257
+ end
246
258
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
247
259
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
248
260
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -282,7 +294,7 @@ end
282
294
  # environment: Vellum::Environment::PRODUCTION,
283
295
  # api_key: "YOUR_API_KEY"
284
296
  # )
285
- # api.execute_workflow(inputs: [{ name: "name", type: "STRING", value: "value" }])
297
+ # api.execute_workflow(inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
286
298
  def execute_workflow(inputs:, expand_meta: nil, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil, external_id: nil, metadata: nil, request_options: nil)
287
299
  response = @request_client.conn.post do | req |
288
300
  unless request_options&.timeout_in_seconds.nil?
@@ -291,6 +303,9 @@ end
291
303
  unless request_options&.api_key.nil?
292
304
  req.headers["X-API-KEY"] = request_options.api_key
293
305
  end
306
+ unless request_options&.api_version.nil?
307
+ req.headers["X-API-Version"] = request_options.api_version
308
+ end
294
309
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
295
310
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
296
311
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -322,7 +337,7 @@ end
322
337
  # environment: Vellum::Environment::PRODUCTION,
323
338
  # api_key: "YOUR_API_KEY"
324
339
  # )
325
- # api.generate(requests: [{ input_values: { "key": "value" } }])
340
+ # api.generate(requests: [{ input_values: { "input_values": {"key":"value"} } }, { input_values: { "input_values": {"key":"value"} } }])
326
341
  def generate(deployment_id: nil, deployment_name: nil, requests:, options: nil, request_options: nil)
327
342
  response = @request_client.conn.post do | req |
328
343
  unless request_options&.timeout_in_seconds.nil?
@@ -331,6 +346,9 @@ end
331
346
  unless request_options&.api_key.nil?
332
347
  req.headers["X-API-KEY"] = request_options.api_key
333
348
  end
349
+ unless request_options&.api_version.nil?
350
+ req.headers["X-API-Version"] = request_options.api_version
351
+ end
334
352
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
335
353
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
336
354
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -367,7 +385,7 @@ end
367
385
  # environment: Vellum::Environment::PRODUCTION,
368
386
  # api_key: "YOUR_API_KEY"
369
387
  # )
370
- # api.search(query: "query")
388
+ # api.search(query: "x")
371
389
  def search(index_id: nil, index_name: nil, query:, options: nil, document_index: nil, request_options: nil)
372
390
  response = @request_client.conn.post do | req |
373
391
  unless request_options&.timeout_in_seconds.nil?
@@ -376,6 +394,9 @@ end
376
394
  unless request_options&.api_key.nil?
377
395
  req.headers["X-API-KEY"] = request_options.api_key
378
396
  end
397
+ unless request_options&.api_version.nil?
398
+ req.headers["X-API-Version"] = request_options.api_version
399
+ end
379
400
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
380
401
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
381
402
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -405,7 +426,7 @@ end
405
426
  # environment: Vellum::Environment::PRODUCTION,
406
427
  # api_key: "YOUR_API_KEY"
407
428
  # )
408
- # api.submit_completion_actuals(actuals: [{ }])
429
+ # api.submit_completion_actuals(actuals: [{ }, { }])
409
430
  def submit_completion_actuals(deployment_id: nil, deployment_name: nil, actuals:, request_options: nil)
410
431
  response = @request_client.conn.post do | req |
411
432
  unless request_options&.timeout_in_seconds.nil?
@@ -414,6 +435,9 @@ end
414
435
  unless request_options&.api_key.nil?
415
436
  req.headers["X-API-KEY"] = request_options.api_key
416
437
  end
438
+ unless request_options&.api_version.nil?
439
+ req.headers["X-API-Version"] = request_options.api_version
440
+ end
417
441
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
418
442
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
419
443
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -440,7 +464,7 @@ end
440
464
  # environment: Vellum::Environment::PRODUCTION,
441
465
  # api_key: "YOUR_API_KEY"
442
466
  # )
443
- # api.submit_workflow_execution_actuals(actuals: [{ output_type: "STRING" }])
467
+ # api.submit_workflow_execution_actuals(actuals: [{ output_type: "STRING" }, { output_type: "STRING" }])
444
468
  def submit_workflow_execution_actuals(actuals:, execution_id: nil, external_id: nil, request_options: nil)
445
469
  response = @request_client.conn.post do | req |
446
470
  unless request_options&.timeout_in_seconds.nil?
@@ -449,6 +473,9 @@ end
449
473
  unless request_options&.api_key.nil?
450
474
  req.headers["X-API-KEY"] = request_options.api_key
451
475
  end
476
+ unless request_options&.api_version.nil?
477
+ req.headers["X-API-Version"] = request_options.api_version
478
+ end
452
479
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
453
480
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
454
481
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -504,14 +531,16 @@ end
504
531
  # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
505
532
  # @param timeout_in_seconds [Long]
506
533
  # @param api_key [String]
534
+ # @param api_version [Vellum::ApiVersionEnum]
507
535
  # @return [Vellum::AsyncClient]
508
- def initialize(base_url: nil, environment: Vellum::Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil, api_key:)
536
+ def initialize(base_url: nil, environment: Vellum::Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil, api_key:, api_version: nil)
509
537
  @async_request_client = Vellum::AsyncRequestClient.new(
510
538
  base_url: base_url,
511
539
  environment: environment,
512
540
  max_retries: max_retries,
513
541
  timeout_in_seconds: timeout_in_seconds,
514
- api_key: api_key
542
+ api_key: api_key,
543
+ api_version: api_version
515
544
  )
516
545
  @ad_hoc = Vellum::AsyncAdHocClient.new(request_client: @async_request_client)
517
546
  @container_images = Vellum::AsyncContainerImagesClient.new(request_client: @async_request_client)
@@ -546,7 +575,7 @@ end
546
575
  # environment: Vellum::Environment::PRODUCTION,
547
576
  # api_key: "YOUR_API_KEY"
548
577
  # )
549
- # api.execute_api(url: "url")
578
+ # api.execute_api(url: "x")
550
579
  def execute_api(url:, method: nil, body: nil, headers: nil, bearer_token: nil, request_options: nil)
551
580
  response = @async_request_client.conn.post do | req |
552
581
  unless request_options&.timeout_in_seconds.nil?
@@ -555,6 +584,9 @@ end
555
584
  unless request_options&.api_key.nil?
556
585
  req.headers["X-API-KEY"] = request_options.api_key
557
586
  end
587
+ unless request_options&.api_version.nil?
588
+ req.headers["X-API-Version"] = request_options.api_version
589
+ end
558
590
  req.headers = { **(req.headers || {}), **@async_request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
559
591
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
560
592
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -581,10 +613,10 @@ end
581
613
  # api_key: "YOUR_API_KEY"
582
614
  # )
583
615
  # api.execute_code(
584
- # code: "code",
616
+ # code: "x",
585
617
  # runtime: PYTHON_3_11_6,
586
- # input_values: [{ name: "name", type: "STRING", value: "value" }],
587
- # packages: [{ version: "version", name: "name" }],
618
+ # input_values: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }],
619
+ # packages: [{ version: "version", name: "name" }, { version: "version", name: "name" }],
588
620
  # output_type: STRING
589
621
  # )
590
622
  def execute_code(code:, runtime:, input_values:, packages:, output_type:, request_options: nil)
@@ -595,6 +627,9 @@ end
595
627
  unless request_options&.api_key.nil?
596
628
  req.headers["X-API-KEY"] = request_options.api_key
597
629
  end
630
+ unless request_options&.api_version.nil?
631
+ req.headers["X-API-Version"] = request_options.api_version
632
+ end
598
633
  req.headers = { **(req.headers || {}), **@async_request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
599
634
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
600
635
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -645,7 +680,7 @@ end
645
680
  # environment: Vellum::Environment::PRODUCTION,
646
681
  # api_key: "YOUR_API_KEY"
647
682
  # )
648
- # api.execute_prompt(inputs: [{ name: "name", type: "STRING", value: "value" }])
683
+ # api.execute_prompt(inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
649
684
  def execute_prompt(inputs:, prompt_deployment_id: nil, prompt_deployment_name: nil, release_tag: nil, external_id: nil, expand_meta: nil, raw_overrides: nil, expand_raw: nil, metadata: nil, request_options: nil)
650
685
  response = @async_request_client.conn.post do | req |
651
686
  unless request_options&.timeout_in_seconds.nil?
@@ -654,6 +689,9 @@ end
654
689
  unless request_options&.api_key.nil?
655
690
  req.headers["X-API-KEY"] = request_options.api_key
656
691
  end
692
+ unless request_options&.api_version.nil?
693
+ req.headers["X-API-Version"] = request_options.api_version
694
+ end
657
695
  req.headers = { **(req.headers || {}), **@async_request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
658
696
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
659
697
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -693,7 +731,7 @@ end
693
731
  # environment: Vellum::Environment::PRODUCTION,
694
732
  # api_key: "YOUR_API_KEY"
695
733
  # )
696
- # api.execute_workflow(inputs: [{ name: "name", type: "STRING", value: "value" }])
734
+ # api.execute_workflow(inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
697
735
  def execute_workflow(inputs:, expand_meta: nil, workflow_deployment_id: nil, workflow_deployment_name: nil, release_tag: nil, external_id: nil, metadata: nil, request_options: nil)
698
736
  response = @async_request_client.conn.post do | req |
699
737
  unless request_options&.timeout_in_seconds.nil?
@@ -702,6 +740,9 @@ end
702
740
  unless request_options&.api_key.nil?
703
741
  req.headers["X-API-KEY"] = request_options.api_key
704
742
  end
743
+ unless request_options&.api_version.nil?
744
+ req.headers["X-API-Version"] = request_options.api_version
745
+ end
705
746
  req.headers = { **(req.headers || {}), **@async_request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
706
747
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
707
748
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -733,7 +774,7 @@ end
733
774
  # environment: Vellum::Environment::PRODUCTION,
734
775
  # api_key: "YOUR_API_KEY"
735
776
  # )
736
- # api.generate(requests: [{ input_values: { "key": "value" } }])
777
+ # api.generate(requests: [{ input_values: { "input_values": {"key":"value"} } }, { input_values: { "input_values": {"key":"value"} } }])
737
778
  def generate(deployment_id: nil, deployment_name: nil, requests:, options: nil, request_options: nil)
738
779
  response = @async_request_client.conn.post do | req |
739
780
  unless request_options&.timeout_in_seconds.nil?
@@ -742,6 +783,9 @@ end
742
783
  unless request_options&.api_key.nil?
743
784
  req.headers["X-API-KEY"] = request_options.api_key
744
785
  end
786
+ unless request_options&.api_version.nil?
787
+ req.headers["X-API-Version"] = request_options.api_version
788
+ end
745
789
  req.headers = { **(req.headers || {}), **@async_request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
746
790
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
747
791
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -778,7 +822,7 @@ end
778
822
  # environment: Vellum::Environment::PRODUCTION,
779
823
  # api_key: "YOUR_API_KEY"
780
824
  # )
781
- # api.search(query: "query")
825
+ # api.search(query: "x")
782
826
  def search(index_id: nil, index_name: nil, query:, options: nil, document_index: nil, request_options: nil)
783
827
  response = @async_request_client.conn.post do | req |
784
828
  unless request_options&.timeout_in_seconds.nil?
@@ -787,6 +831,9 @@ end
787
831
  unless request_options&.api_key.nil?
788
832
  req.headers["X-API-KEY"] = request_options.api_key
789
833
  end
834
+ unless request_options&.api_version.nil?
835
+ req.headers["X-API-Version"] = request_options.api_version
836
+ end
790
837
  req.headers = { **(req.headers || {}), **@async_request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
791
838
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
792
839
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -816,7 +863,7 @@ end
816
863
  # environment: Vellum::Environment::PRODUCTION,
817
864
  # api_key: "YOUR_API_KEY"
818
865
  # )
819
- # api.submit_completion_actuals(actuals: [{ }])
866
+ # api.submit_completion_actuals(actuals: [{ }, { }])
820
867
  def submit_completion_actuals(deployment_id: nil, deployment_name: nil, actuals:, request_options: nil)
821
868
  response = @async_request_client.conn.post do | req |
822
869
  unless request_options&.timeout_in_seconds.nil?
@@ -825,6 +872,9 @@ end
825
872
  unless request_options&.api_key.nil?
826
873
  req.headers["X-API-KEY"] = request_options.api_key
827
874
  end
875
+ unless request_options&.api_version.nil?
876
+ req.headers["X-API-Version"] = request_options.api_version
877
+ end
828
878
  req.headers = { **(req.headers || {}), **@async_request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
829
879
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
830
880
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -851,7 +901,7 @@ end
851
901
  # environment: Vellum::Environment::PRODUCTION,
852
902
  # api_key: "YOUR_API_KEY"
853
903
  # )
854
- # api.submit_workflow_execution_actuals(actuals: [{ output_type: "STRING" }])
904
+ # api.submit_workflow_execution_actuals(actuals: [{ output_type: "STRING" }, { output_type: "STRING" }])
855
905
  def submit_workflow_execution_actuals(actuals:, execution_id: nil, external_id: nil, request_options: nil)
856
906
  response = @async_request_client.conn.post do | req |
857
907
  unless request_options&.timeout_in_seconds.nil?
@@ -860,6 +910,9 @@ end
860
910
  unless request_options&.api_key.nil?
861
911
  req.headers["X-API-KEY"] = request_options.api_key
862
912
  end
913
+ unless request_options&.api_version.nil?
914
+ req.headers["X-API-Version"] = request_options.api_version
915
+ end
863
916
  req.headers = { **(req.headers || {}), **@async_request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
864
917
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
865
918
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
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.14.87
4
+ version: 0.14.89
5
5
  platform: ruby
6
6
  authors:
7
7
  - Vellum
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2025-07-11 00:00:00.000000000 Z
11
+ date: 2025-07-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday