vellum_ai 0.14.88 → 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.
Files changed (23) hide show
  1. checksums.yaml +4 -4
  2. data/lib/requests.rb +27 -8
  3. data/lib/vellum_ai/ad_hoc/client.rb +14 -8
  4. data/lib/vellum_ai/container_images/client.rb +30 -6
  5. data/lib/vellum_ai/deployments/client.rb +50 -2
  6. data/lib/vellum_ai/document_indexes/client.rb +56 -8
  7. data/lib/vellum_ai/documents/client.rb +30 -14
  8. data/lib/vellum_ai/folder_entities/client.rb +12 -0
  9. data/lib/vellum_ai/metric_definitions/client.rb +14 -2
  10. data/lib/vellum_ai/ml_models/client.rb +6 -0
  11. data/lib/vellum_ai/organizations/client.rb +6 -0
  12. data/lib/vellum_ai/prompts/client.rb +14 -2
  13. data/lib/vellum_ai/release_reviews/client.rb +6 -0
  14. data/lib/vellum_ai/sandboxes/client.rb +20 -10
  15. data/lib/vellum_ai/test_suite_runs/client.rb +18 -0
  16. data/lib/vellum_ai/test_suites/client.rb +20 -2
  17. data/lib/vellum_ai/workflow_deployments/client.rb +48 -0
  18. data/lib/vellum_ai/workflow_sandboxes/client.rb +12 -0
  19. data/lib/vellum_ai/workflows/client.rb +12 -14
  20. data/lib/vellum_ai/workspace_secrets/client.rb +12 -0
  21. data/lib/vellum_ai/workspaces/client.rb +6 -0
  22. data/lib/vellum_ai.rb +77 -24
  23. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1d5beb8e0ce7871d6f505db6fb0e330786d09c49e39617aae69e888b5caef2a9
4
- data.tar.gz: 2dcb52b95b6f2518e64df757b4975802e8abe5855baad12196bcdedccde84e0e
3
+ metadata.gz: a15bd7cc17abb4955f07a5b4e3be975c97d602236053399a69ce937b38d4d3a2
4
+ data.tar.gz: 138cea70fe5489754b85d2f315cc0a04aebc5e7af4da0355af98816250f46abf
5
5
  SHA512:
6
- metadata.gz: b2d4b9ca0b5725394a518689f851a611256655daba9fe4abbf8f910e86e66b16bcf36b9233997f3d92ca66689c94b0a33ef7d9467d786787b9bacbe4150b560c
7
- data.tar.gz: a05f0f1216540358b36d32bf7e81fe2201b8218b22c7a010809187b3bcc812ac310689ea06990c744bd362def416657aa03f1044561e6133eb4af95fad8befd1
6
+ metadata.gz: 621a43b4515e82c8626707a9d600a65fb35bb4e5f94636e991930e8e3f7dce422746a0f1d515956770cd8dd3f9354a0eff238463366924048ad50acf36755d90
7
+ data.tar.gz: 00b6526b2e94ae2c93d706cfd00fa3cd1269592d0a9752e1f9c7fb0b6553963949bcca2d2c348e9d2023b67dbf3ab743c48d841e88fc98caa2c3c05190f3df23
data/lib/requests.rb CHANGED
@@ -1,5 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
  require_relative "environment"
3
+ require_relative "vellum_ai/types/api_version_enum"
3
4
  require "faraday"
4
5
  require "faraday/multipart"
5
6
  require "faraday/retry"
@@ -26,11 +27,16 @@ module Vellum
26
27
  # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
27
28
  # @param timeout_in_seconds [Long]
28
29
  # @param api_key [String]
30
+ # @param api_version [Vellum::ApiVersionEnum]
29
31
  # @return [Vellum::RequestClient]
30
- def initialize(base_url: nil, environment: Vellum::Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil, api_key:)
32
+ def initialize(base_url: nil, environment: Vellum::Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil, api_key:, api_version: nil)
31
33
  @default_environment = environment
32
34
  @api_key = api_key
33
- @conn = Faraday.new do | faraday |
35
+ @headers = { }
36
+ unless api_version.nil?
37
+ @headers["X-API-Version"] = api_version
38
+ end
39
+ @conn = Faraday.new(headers: @headers) do | faraday |
34
40
  faraday.request :multipart
35
41
  faraday.request :json
36
42
  faraday.response :raise_error, include_request: true
@@ -50,7 +56,7 @@ end
50
56
  end
51
57
  # @return [Hash{String => String}]
52
58
  def get_headers
53
- headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '0.14.88' }
59
+ headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '0.14.89' }
54
60
  headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
55
61
  headers
56
62
  end
@@ -71,11 +77,16 @@ end
71
77
  # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
72
78
  # @param timeout_in_seconds [Long]
73
79
  # @param api_key [String]
80
+ # @param api_version [Vellum::ApiVersionEnum]
74
81
  # @return [Vellum::AsyncRequestClient]
75
- def initialize(base_url: nil, environment: Vellum::Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil, api_key:)
82
+ def initialize(base_url: nil, environment: Vellum::Environment::PRODUCTION, max_retries: nil, timeout_in_seconds: nil, api_key:, api_version: nil)
76
83
  @default_environment = environment
77
84
  @api_key = api_key
78
- @conn = Faraday.new do | faraday |
85
+ @headers = { }
86
+ unless api_version.nil?
87
+ @headers["X-API-Version"] = api_version
88
+ end
89
+ @conn = Faraday.new(headers: @headers) do | faraday |
79
90
  faraday.request :multipart
80
91
  faraday.request :json
81
92
  faraday.response :raise_error, include_request: true
@@ -96,7 +107,7 @@ end
96
107
  end
97
108
  # @return [Hash{String => String}]
98
109
  def get_headers
99
- headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '0.14.88' }
110
+ headers = { "X-Fern-Language": 'Ruby', "X-Fern-SDK-Name": 'vellum_ai', "X-Fern-SDK-Version": '0.14.89' }
100
111
  headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
101
112
  headers
102
113
  end
@@ -108,6 +119,8 @@ end
108
119
  attr_reader :base_url
109
120
  # @return [String]
110
121
  attr_reader :api_key
122
+ # @return [Vellum::ApiVersionEnum]
123
+ attr_reader :api_version
111
124
  # @return [Hash{String => Object}]
112
125
  attr_reader :additional_headers
113
126
  # @return [Hash{String => Object}]
@@ -120,14 +133,16 @@ end
120
133
 
121
134
  # @param base_url [String]
122
135
  # @param api_key [String]
136
+ # @param api_version [Vellum::ApiVersionEnum]
123
137
  # @param additional_headers [Hash{String => Object}]
124
138
  # @param additional_query_parameters [Hash{String => Object}]
125
139
  # @param additional_body_parameters [Hash{String => Object}]
126
140
  # @param timeout_in_seconds [Long]
127
141
  # @return [Vellum::RequestOptions]
128
- def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil, additional_body_parameters: nil, timeout_in_seconds: nil)
142
+ def initialize(base_url: nil, api_key: nil, api_version: nil, additional_headers: nil, additional_query_parameters: nil, additional_body_parameters: nil, timeout_in_seconds: nil)
129
143
  @base_url = base_url
130
144
  @api_key = api_key
145
+ @api_version = api_version
131
146
  @additional_headers = additional_headers
132
147
  @additional_query_parameters = additional_query_parameters
133
148
  @additional_body_parameters = additional_body_parameters
@@ -141,6 +156,8 @@ end
141
156
  attr_reader :base_url
142
157
  # @return [String]
143
158
  attr_reader :api_key
159
+ # @return [Vellum::ApiVersionEnum]
160
+ attr_reader :api_version
144
161
  # @return [Hash{String => Object}]
145
162
  attr_reader :additional_headers
146
163
  # @return [Hash{String => Object}]
@@ -153,14 +170,16 @@ end
153
170
 
154
171
  # @param base_url [String]
155
172
  # @param api_key [String]
173
+ # @param api_version [Vellum::ApiVersionEnum]
156
174
  # @param additional_headers [Hash{String => Object}]
157
175
  # @param additional_query_parameters [Hash{String => Object}]
158
176
  # @param additional_body_parameters [Hash{String => Object}]
159
177
  # @param timeout_in_seconds [Long]
160
178
  # @return [Vellum::IdempotencyRequestOptions]
161
- def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil, additional_body_parameters: nil, timeout_in_seconds: nil)
179
+ def initialize(base_url: nil, api_key: nil, api_version: nil, additional_headers: nil, additional_query_parameters: nil, additional_body_parameters: nil, timeout_in_seconds: nil)
162
180
  @base_url = base_url
163
181
  @api_key = api_key
182
+ @api_version = api_version
164
183
  @additional_headers = additional_headers
165
184
  @additional_query_parameters = additional_query_parameters
166
185
  @additional_body_parameters = additional_body_parameters
data/lib/vellum_ai/ad_hoc/client.rb CHANGED
@@ -69,11 +69,11 @@ module Vellum
69
69
  # api_key: "YOUR_API_KEY"
70
70
  # )
71
71
  # api.ad_hoc.adhoc_execute_prompt(
72
- # ml_model: "ml_model",
73
- # input_values: [{ key: "key", type: "STRING", value: "value" }],
74
- # input_variables: [{ id: "id", key: "key", type: STRING }],
72
+ # ml_model: "x",
73
+ # input_values: [{ key: "x", type: "STRING", value: "value" }, { key: "x", type: "STRING", value: "value" }],
74
+ # input_variables: [{ id: "x", key: "key", type: STRING }, { id: "x", key: "key", type: STRING }],
75
75
  # parameters: { },
76
- # blocks: [{ block_type: "JINJA", template: "template" }]
76
+ # blocks: [{ block_type: "JINJA", template: "template" }, { block_type: "JINJA", template: "template" }]
77
77
  # )
78
78
  def adhoc_execute_prompt(ml_model:, input_values:, input_variables:, parameters:, settings: nil, blocks:, functions: nil, expand_meta: nil, request_options: nil)
79
79
  response = @request_client.conn.post do | req |
@@ -83,6 +83,9 @@ module Vellum
83
83
  unless request_options&.api_key.nil?
84
84
  req.headers["X-API-KEY"] = request_options.api_key
85
85
  end
86
+ unless request_options&.api_version.nil?
87
+ req.headers["X-API-Version"] = request_options.api_version
88
+ end
86
89
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
87
90
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
88
91
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -150,11 +153,11 @@ end
150
153
  # api_key: "YOUR_API_KEY"
151
154
  # )
152
155
  # api.ad_hoc.adhoc_execute_prompt(
153
- # ml_model: "ml_model",
154
- # input_values: [{ key: "key", type: "STRING", value: "value" }],
155
- # input_variables: [{ id: "id", key: "key", type: STRING }],
156
+ # ml_model: "x",
157
+ # input_values: [{ key: "x", type: "STRING", value: "value" }, { key: "x", type: "STRING", value: "value" }],
158
+ # input_variables: [{ id: "x", key: "key", type: STRING }, { id: "x", key: "key", type: STRING }],
156
159
  # parameters: { },
157
- # blocks: [{ block_type: "JINJA", template: "template" }]
160
+ # blocks: [{ block_type: "JINJA", template: "template" }, { block_type: "JINJA", template: "template" }]
158
161
  # )
159
162
  def adhoc_execute_prompt(ml_model:, input_values:, input_variables:, parameters:, settings: nil, blocks:, functions: nil, expand_meta: nil, request_options: nil)
160
163
  Async do
@@ -165,6 +168,9 @@ end
165
168
  unless request_options&.api_key.nil?
166
169
  req.headers["X-API-KEY"] = request_options.api_key
167
170
  end
171
+ unless request_options&.api_version.nil?
172
+ req.headers["X-API-Version"] = request_options.api_version
173
+ end
168
174
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
169
175
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
170
176
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
data/lib/vellum_ai/container_images/client.rb CHANGED
@@ -42,6 +42,9 @@ module Vellum
42
42
  unless request_options&.api_key.nil?
43
43
  req.headers["X-API-KEY"] = request_options.api_key
44
44
  end
45
+ unless request_options&.api_version.nil?
46
+ req.headers["X-API-Version"] = request_options.api_version
47
+ end
45
48
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
46
49
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering }.compact
47
50
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -71,6 +74,9 @@ end
71
74
  unless request_options&.api_key.nil?
72
75
  req.headers["X-API-KEY"] = request_options.api_key
73
76
  end
77
+ unless request_options&.api_version.nil?
78
+ req.headers["X-API-Version"] = request_options.api_version
79
+ end
74
80
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
75
81
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
76
82
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -99,6 +105,9 @@ end
99
105
  unless request_options&.api_key.nil?
100
106
  req.headers["X-API-KEY"] = request_options.api_key
101
107
  end
108
+ unless request_options&.api_version.nil?
109
+ req.headers["X-API-Version"] = request_options.api_version
110
+ end
102
111
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
103
112
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
104
113
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -122,9 +131,9 @@ end
122
131
  # api_key: "YOUR_API_KEY"
123
132
  # )
124
133
  # api.container_images.push_container_image(
125
- # name: "name",
126
- # sha: "sha",
127
- # tags: ["tags"]
134
+ # name: "x",
135
+ # sha: "x",
136
+ # tags: ["tags", "tags"]
128
137
  # )
129
138
  def push_container_image(name:, sha:, tags:, request_options: nil)
130
139
  response = @request_client.conn.post do | req |
@@ -134,6 +143,9 @@ end
134
143
  unless request_options&.api_key.nil?
135
144
  req.headers["X-API-KEY"] = request_options.api_key
136
145
  end
146
+ unless request_options&.api_version.nil?
147
+ req.headers["X-API-Version"] = request_options.api_version
148
+ end
137
149
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
138
150
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
139
151
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -177,6 +189,9 @@ end
177
189
  unless request_options&.api_key.nil?
178
190
  req.headers["X-API-KEY"] = request_options.api_key
179
191
  end
192
+ unless request_options&.api_version.nil?
193
+ req.headers["X-API-Version"] = request_options.api_version
194
+ end
180
195
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
181
196
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering }.compact
182
197
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -208,6 +223,9 @@ end
208
223
  unless request_options&.api_key.nil?
209
224
  req.headers["X-API-KEY"] = request_options.api_key
210
225
  end
226
+ unless request_options&.api_version.nil?
227
+ req.headers["X-API-Version"] = request_options.api_version
228
+ end
211
229
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
212
230
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
213
231
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -238,6 +256,9 @@ end
238
256
  unless request_options&.api_key.nil?
239
257
  req.headers["X-API-KEY"] = request_options.api_key
240
258
  end
259
+ unless request_options&.api_version.nil?
260
+ req.headers["X-API-Version"] = request_options.api_version
261
+ end
241
262
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
242
263
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
243
264
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -262,9 +283,9 @@ end
262
283
  # api_key: "YOUR_API_KEY"
263
284
  # )
264
285
  # api.container_images.push_container_image(
265
- # name: "name",
266
- # sha: "sha",
267
- # tags: ["tags"]
286
+ # name: "x",
287
+ # sha: "x",
288
+ # tags: ["tags", "tags"]
268
289
  # )
269
290
  def push_container_image(name:, sha:, tags:, request_options: nil)
270
291
  Async do
@@ -275,6 +296,9 @@ end
275
296
  unless request_options&.api_key.nil?
276
297
  req.headers["X-API-KEY"] = request_options.api_key
277
298
  end
299
+ unless request_options&.api_version.nil?
300
+ req.headers["X-API-Version"] = request_options.api_version
301
+ end
278
302
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
279
303
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
280
304
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
data/lib/vellum_ai/deployments/client.rb CHANGED
@@ -55,6 +55,9 @@ module Vellum
55
55
  unless request_options&.api_key.nil?
56
56
  req.headers["X-API-KEY"] = request_options.api_key
57
57
  end
58
+ unless request_options&.api_version.nil?
59
+ req.headers["X-API-Version"] = request_options.api_version
60
+ end
58
61
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
59
62
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "status": status }.compact
60
63
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -84,6 +87,9 @@ end
84
87
  unless request_options&.api_key.nil?
85
88
  req.headers["X-API-KEY"] = request_options.api_key
86
89
  end
90
+ unless request_options&.api_version.nil?
91
+ req.headers["X-API-Version"] = request_options.api_version
92
+ end
87
93
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
88
94
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
89
95
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -120,6 +126,9 @@ end
120
126
  unless request_options&.api_key.nil?
121
127
  req.headers["X-API-KEY"] = request_options.api_key
122
128
  end
129
+ unless request_options&.api_version.nil?
130
+ req.headers["X-API-Version"] = request_options.api_version
131
+ end
123
132
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
124
133
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
125
134
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -155,6 +164,9 @@ end
155
164
  unless request_options&.api_key.nil?
156
165
  req.headers["X-API-KEY"] = request_options.api_key
157
166
  end
167
+ unless request_options&.api_version.nil?
168
+ req.headers["X-API-Version"] = request_options.api_version
169
+ end
158
170
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
159
171
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "source": source }.compact
160
172
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -187,6 +199,9 @@ end
187
199
  unless request_options&.api_key.nil?
188
200
  req.headers["X-API-KEY"] = request_options.api_key
189
201
  end
202
+ unless request_options&.api_version.nil?
203
+ req.headers["X-API-Version"] = request_options.api_version
204
+ end
190
205
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
191
206
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
192
207
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -221,6 +236,9 @@ end
221
236
  unless request_options&.api_key.nil?
222
237
  req.headers["X-API-KEY"] = request_options.api_key
223
238
  end
239
+ unless request_options&.api_version.nil?
240
+ req.headers["X-API-Version"] = request_options.api_version
241
+ end
224
242
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
225
243
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
226
244
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -254,6 +272,9 @@ end
254
272
  unless request_options&.api_key.nil?
255
273
  req.headers["X-API-KEY"] = request_options.api_key
256
274
  end
275
+ unless request_options&.api_version.nil?
276
+ req.headers["X-API-Version"] = request_options.api_version
277
+ end
257
278
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
258
279
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
259
280
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -299,7 +320,7 @@ end
299
320
  # environment: Vellum::Environment::PRODUCTION,
300
321
  # api_key: "YOUR_API_KEY"
301
322
  # )
302
- # api.deployments.retrieve_provider_payload(inputs: [{ name: "name", type: "STRING", value: "value" }])
323
+ # api.deployments.retrieve_provider_payload(inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
303
324
  def retrieve_provider_payload(deployment_id: nil, deployment_name: nil, inputs:, release_tag: nil, expand_meta: nil, request_options: nil)
304
325
  response = @request_client.conn.post do | req |
305
326
  unless request_options&.timeout_in_seconds.nil?
@@ -308,6 +329,9 @@ end
308
329
  unless request_options&.api_key.nil?
309
330
  req.headers["X-API-KEY"] = request_options.api_key
310
331
  end
332
+ unless request_options&.api_version.nil?
333
+ req.headers["X-API-Version"] = request_options.api_version
334
+ end
311
335
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
312
336
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
313
337
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -352,6 +376,9 @@ end
352
376
  unless request_options&.api_key.nil?
353
377
  req.headers["X-API-KEY"] = request_options.api_key
354
378
  end
379
+ unless request_options&.api_version.nil?
380
+ req.headers["X-API-Version"] = request_options.api_version
381
+ end
355
382
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
356
383
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "status": status }.compact
357
384
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -383,6 +410,9 @@ end
383
410
  unless request_options&.api_key.nil?
384
411
  req.headers["X-API-KEY"] = request_options.api_key
385
412
  end
413
+ unless request_options&.api_version.nil?
414
+ req.headers["X-API-Version"] = request_options.api_version
415
+ end
386
416
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
387
417
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
388
418
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -421,6 +451,9 @@ end
421
451
  unless request_options&.api_key.nil?
422
452
  req.headers["X-API-KEY"] = request_options.api_key
423
453
  end
454
+ unless request_options&.api_version.nil?
455
+ req.headers["X-API-Version"] = request_options.api_version
456
+ end
424
457
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
425
458
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
426
459
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -458,6 +491,9 @@ end
458
491
  unless request_options&.api_key.nil?
459
492
  req.headers["X-API-KEY"] = request_options.api_key
460
493
  end
494
+ unless request_options&.api_version.nil?
495
+ req.headers["X-API-Version"] = request_options.api_version
496
+ end
461
497
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
462
498
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "source": source }.compact
463
499
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -492,6 +528,9 @@ end
492
528
  unless request_options&.api_key.nil?
493
529
  req.headers["X-API-KEY"] = request_options.api_key
494
530
  end
531
+ unless request_options&.api_version.nil?
532
+ req.headers["X-API-Version"] = request_options.api_version
533
+ end
495
534
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
496
535
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
497
536
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -528,6 +567,9 @@ end
528
567
  unless request_options&.api_key.nil?
529
568
  req.headers["X-API-KEY"] = request_options.api_key
530
569
  end
570
+ unless request_options&.api_version.nil?
571
+ req.headers["X-API-Version"] = request_options.api_version
572
+ end
531
573
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
532
574
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
533
575
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -563,6 +605,9 @@ end
563
605
  unless request_options&.api_key.nil?
564
606
  req.headers["X-API-KEY"] = request_options.api_key
565
607
  end
608
+ unless request_options&.api_version.nil?
609
+ req.headers["X-API-Version"] = request_options.api_version
610
+ end
566
611
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
567
612
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
568
613
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -609,7 +654,7 @@ end
609
654
  # environment: Vellum::Environment::PRODUCTION,
610
655
  # api_key: "YOUR_API_KEY"
611
656
  # )
612
- # api.deployments.retrieve_provider_payload(inputs: [{ name: "name", type: "STRING", value: "value" }])
657
+ # api.deployments.retrieve_provider_payload(inputs: [{ name: "x", type: "STRING", value: "value" }, { name: "x", type: "STRING", value: "value" }])
613
658
  def retrieve_provider_payload(deployment_id: nil, deployment_name: nil, inputs:, release_tag: nil, expand_meta: nil, request_options: nil)
614
659
  Async do
615
660
  response = @request_client.conn.post do | req |
@@ -619,6 +664,9 @@ end
619
664
  unless request_options&.api_key.nil?
620
665
  req.headers["X-API-KEY"] = request_options.api_key
621
666
  end
667
+ unless request_options&.api_version.nil?
668
+ req.headers["X-API-Version"] = request_options.api_version
669
+ end
622
670
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
623
671
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
624
672
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
data/lib/vellum_ai/document_indexes/client.rb CHANGED
@@ -53,6 +53,9 @@ module Vellum
53
53
  unless request_options&.api_key.nil?
54
54
  req.headers["X-API-KEY"] = request_options.api_key
55
55
  end
56
+ unless request_options&.api_version.nil?
57
+ req.headers["X-API-Version"] = request_options.api_version
58
+ end
56
59
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
57
60
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "search": search, "status": status }.compact
58
61
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -83,9 +86,9 @@ end
83
86
  # api_key: "YOUR_API_KEY"
84
87
  # )
85
88
  # api.document_indexes.create(
86
- # label: "My Document Index",
87
- # name: "my-document-index",
88
- # indexing_config: { vectorizer: { model_name: "hkunlp/instructor-xl", config: { instruction_domain: "", instruction_query_text_type: "plain_text", instruction_document_text_type: "plain_text" } }, chunking: { chunker_name: "sentence-chunker", chunker_config: { character_limit: 1000, min_overlap_ratio: 0.5 } } }
89
+ # label: "x",
90
+ # name: "x",
91
+ # indexing_config: { vectorizer: { config: { }, model_name: "text-embedding-3-small" } }
89
92
  # )
90
93
  def create(label:, name:, status: nil, indexing_config:, copy_documents_from_index_id: nil, request_options: nil)
91
94
  response = @request_client.conn.post do | req |
@@ -95,6 +98,9 @@ end
95
98
  unless request_options&.api_key.nil?
96
99
  req.headers["X-API-KEY"] = request_options.api_key
97
100
  end
101
+ unless request_options&.api_version.nil?
102
+ req.headers["X-API-Version"] = request_options.api_version
103
+ end
98
104
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
99
105
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
100
106
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -124,6 +130,9 @@ end
124
130
  unless request_options&.api_key.nil?
125
131
  req.headers["X-API-KEY"] = request_options.api_key
126
132
  end
133
+ unless request_options&.api_version.nil?
134
+ req.headers["X-API-Version"] = request_options.api_version
135
+ end
127
136
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
128
137
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
129
138
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -150,7 +159,7 @@ end
150
159
  # environment: Vellum::Environment::PRODUCTION,
151
160
  # api_key: "YOUR_API_KEY"
152
161
  # )
153
- # api.document_indexes.update(id: "id", label: "label")
162
+ # api.document_indexes.update(id: "id", label: "x")
154
163
  def update(id:, label:, status: nil, request_options: nil)
155
164
  response = @request_client.conn.put do | req |
156
165
  unless request_options&.timeout_in_seconds.nil?
@@ -159,6 +168,9 @@ end
159
168
  unless request_options&.api_key.nil?
160
169
  req.headers["X-API-KEY"] = request_options.api_key
161
170
  end
171
+ unless request_options&.api_version.nil?
172
+ req.headers["X-API-Version"] = request_options.api_version
173
+ end
162
174
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
163
175
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
164
176
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -188,6 +200,9 @@ end
188
200
  unless request_options&.api_key.nil?
189
201
  req.headers["X-API-KEY"] = request_options.api_key
190
202
  end
203
+ unless request_options&.api_version.nil?
204
+ req.headers["X-API-Version"] = request_options.api_version
205
+ end
191
206
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
192
207
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
193
208
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -222,6 +237,9 @@ end
222
237
  unless request_options&.api_key.nil?
223
238
  req.headers["X-API-KEY"] = request_options.api_key
224
239
  end
240
+ unless request_options&.api_version.nil?
241
+ req.headers["X-API-Version"] = request_options.api_version
242
+ end
225
243
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
226
244
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
227
245
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -254,6 +272,9 @@ end
254
272
  unless request_options&.api_key.nil?
255
273
  req.headers["X-API-KEY"] = request_options.api_key
256
274
  end
275
+ unless request_options&.api_version.nil?
276
+ req.headers["X-API-Version"] = request_options.api_version
277
+ end
257
278
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
258
279
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
259
280
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -287,6 +308,9 @@ end
287
308
  unless request_options&.api_key.nil?
288
309
  req.headers["X-API-KEY"] = request_options.api_key
289
310
  end
311
+ unless request_options&.api_version.nil?
312
+ req.headers["X-API-Version"] = request_options.api_version
313
+ end
290
314
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
291
315
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
292
316
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -336,6 +360,9 @@ end
336
360
  unless request_options&.api_key.nil?
337
361
  req.headers["X-API-KEY"] = request_options.api_key
338
362
  end
363
+ unless request_options&.api_version.nil?
364
+ req.headers["X-API-Version"] = request_options.api_version
365
+ end
339
366
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
340
367
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "search": search, "status": status }.compact
341
368
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -367,9 +394,9 @@ end
367
394
  # api_key: "YOUR_API_KEY"
368
395
  # )
369
396
  # api.document_indexes.create(
370
- # label: "My Document Index",
371
- # name: "my-document-index",
372
- # indexing_config: { vectorizer: { model_name: "hkunlp/instructor-xl", config: { instruction_domain: "", instruction_query_text_type: "plain_text", instruction_document_text_type: "plain_text" } }, chunking: { chunker_name: "sentence-chunker", chunker_config: { character_limit: 1000, min_overlap_ratio: 0.5 } } }
397
+ # label: "x",
398
+ # name: "x",
399
+ # indexing_config: { vectorizer: { config: { }, model_name: "text-embedding-3-small" } }
373
400
  # )
374
401
  def create(label:, name:, status: nil, indexing_config:, copy_documents_from_index_id: nil, request_options: nil)
375
402
  Async do
@@ -380,6 +407,9 @@ end
380
407
  unless request_options&.api_key.nil?
381
408
  req.headers["X-API-KEY"] = request_options.api_key
382
409
  end
410
+ unless request_options&.api_version.nil?
411
+ req.headers["X-API-Version"] = request_options.api_version
412
+ end
383
413
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
384
414
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
385
415
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -411,6 +441,9 @@ end
411
441
  unless request_options&.api_key.nil?
412
442
  req.headers["X-API-KEY"] = request_options.api_key
413
443
  end
444
+ unless request_options&.api_version.nil?
445
+ req.headers["X-API-Version"] = request_options.api_version
446
+ end
414
447
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
415
448
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
416
449
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -438,7 +471,7 @@ end
438
471
  # environment: Vellum::Environment::PRODUCTION,
439
472
  # api_key: "YOUR_API_KEY"
440
473
  # )
441
- # api.document_indexes.update(id: "id", label: "label")
474
+ # api.document_indexes.update(id: "id", label: "x")
442
475
  def update(id:, label:, status: nil, request_options: nil)
443
476
  Async do
444
477
  response = @request_client.conn.put do | req |
@@ -448,6 +481,9 @@ end
448
481
  unless request_options&.api_key.nil?
449
482
  req.headers["X-API-KEY"] = request_options.api_key
450
483
  end
484
+ unless request_options&.api_version.nil?
485
+ req.headers["X-API-Version"] = request_options.api_version
486
+ end
451
487
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
452
488
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
453
489
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -479,6 +515,9 @@ end
479
515
  unless request_options&.api_key.nil?
480
516
  req.headers["X-API-KEY"] = request_options.api_key
481
517
  end
518
+ unless request_options&.api_version.nil?
519
+ req.headers["X-API-Version"] = request_options.api_version
520
+ end
482
521
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
483
522
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
484
523
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -515,6 +554,9 @@ end
515
554
  unless request_options&.api_key.nil?
516
555
  req.headers["X-API-KEY"] = request_options.api_key
517
556
  end
557
+ unless request_options&.api_version.nil?
558
+ req.headers["X-API-Version"] = request_options.api_version
559
+ end
518
560
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
519
561
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
520
562
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -549,6 +591,9 @@ end
549
591
  unless request_options&.api_key.nil?
550
592
  req.headers["X-API-KEY"] = request_options.api_key
551
593
  end
594
+ unless request_options&.api_version.nil?
595
+ req.headers["X-API-Version"] = request_options.api_version
596
+ end
552
597
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
553
598
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
554
599
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -584,6 +629,9 @@ end
584
629
  unless request_options&.api_key.nil?
585
630
  req.headers["X-API-KEY"] = request_options.api_key
586
631
  end
632
+ unless request_options&.api_version.nil?
633
+ req.headers["X-API-Version"] = request_options.api_version
634
+ end
587
635
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
588
636
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
589
637
  req.params = { **(request_options&.additional_query_parameters || {}) }.compact