Class: Vellum::DeploymentsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/deployments/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Vellum::DeploymentsClient

Parameters:



32
33
34
 
# File 'lib/vellum_ai/deployments/client.rb', line 32

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Vellum::RequestClient (readonly)

Returns:



27
28
29
 
# File 'lib/vellum_ai/deployments/client.rb', line 27

def request_client
  @request_client
end

Instance Method Details

#deployment_history_item_retrieve(history_id_or_release_tag:, id:, request_options: nil) ⇒ Object

api.deployments.deployment_history_item_retrieve(history_id_or_release_tag: “history_id_or_release_tag”, id: “id”)



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/vellum_ai/deployments/client.rb', line 125

def deployment_history_item_retrieve(history_id_or_release_tag:, id:, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/deployments/#{history_id_or_release_tag}/history/#{id}"
end
  Vellum::DeploymentHistoryItem.from_json(json_object: response.body)
end

#list(limit: nil, offset: nil, ordering: nil, status: nil, request_options: nil) ⇒ Object

api.deployments.list



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/vellum_ai/deployments/client.rb', line 50

def list(limit: nil, offset: nil, ordering: nil, status: nil, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "status": status }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/deployments"
end
  Vellum::PaginatedSlimDeploymentReadList.from_json(json_object: response.body)
end

#list_deployment_release_tags(id:, limit: nil, offset: nil, ordering: nil, source: nil, request_options: nil) ⇒ Object

api.deployments.list_deployment_release_tags(id: “id”)



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/vellum_ai/deployments/client.rb', line 165

def list_deployment_release_tags(id:, limit: nil, offset: nil, ordering: nil, source: nil, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "offset": offset, "ordering": ordering, "source": source }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/deployments/#{id}/release-tags"
end
  Vellum::PaginatedDeploymentReleaseTagReadList.from_json(json_object: response.body)
end

#retrieve(id:, request_options: nil) ⇒ Object

api.deployments.retrieve(id: “id”)



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/vellum_ai/deployments/client.rb', line 84

def retrieve(id:, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/deployments/#{id}"
end
  Vellum::DeploymentRead.from_json(json_object: response.body)
end

#retrieve_deployment_release_tag(id:, name:, request_options: nil) ⇒ Object

api.deployments.retrieve_deployment_release_tag(id: “id”, name: “name”)



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/vellum_ai/deployments/client.rb', line 202

def retrieve_deployment_release_tag(id:, name:, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/deployments/#{id}/release-tags/#{name}"
end
  Vellum::DeploymentReleaseTagRead.from_json(json_object: response.body)
end

#retrieve_prompt_deployment_release(id:, release_id_or_release_tag:, request_options: nil) ⇒ Object

api.deployments.retrieve_prompt_deployment_release(id: “id”, release_id_or_release_tag: “release_id_or_release_tag”)



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/vellum_ai/deployments/client.rb', line 279

def retrieve_prompt_deployment_release(id:, release_id_or_release_tag:, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/deployments/#{id}/releases/#{release_id_or_release_tag}"
end
  Vellum::PromptDeploymentRelease.from_json(json_object: response.body)
end

#retrieve_provider_payload(deployment_id: nil, deployment_name: nil, inputs:, release_tag: nil, expand_meta: nil, request_options: nil) ⇒ Object

api.deployments.retrieve_provider_payload(inputs: [{ name: “x”, type: “STRING”, value: “value” }, { name: “x”, type: “STRING”, value: “value” }])



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/vellum_ai/deployments/client.rb', line 338

def retrieve_provider_payload(deployment_id: nil, deployment_name: nil, inputs:, release_tag: nil, expand_meta: nil, request_options: nil)
  response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), deployment_id: deployment_id, deployment_name: deployment_name, inputs: inputs, release_tag: release_tag, expand_meta: expand_meta }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/deployments/provider-payload"
end
  Vellum::DeploymentProviderPayloadResponse.from_json(json_object: response.body)
end

#update_deployment_release_tag(id:, name:, history_item_id: nil, request_options: nil) ⇒ Object

api.deployments.update_deployment_release_tag(id: “id”, name: “name”)



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/vellum_ai/deployments/client.rb', line 241

def update_deployment_release_tag(id:, name:, history_item_id: nil, request_options: nil)
  response = @request_client.conn.patch do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), history_item_id: history_item_id }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/deployments/#{id}/release-tags/#{name}"
end
  Vellum::DeploymentReleaseTagRead.from_json(json_object: response.body)
end