Class: Vellum::AsyncSandboxesClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Vellum::AsyncSandboxesClient

Parameters:



157
158
159
 
# File 'lib/vellum_ai/sandboxes/client.rb', line 157

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Vellum::AsyncRequestClient (readonly)

Returns:



152
153
154
 
# File 'lib/vellum_ai/sandboxes/client.rb', line 152

def request_client
  @request_client
end

Instance Method Details

#delete_sandbox_scenario(id:, scenario_id:, request_options: nil) ⇒ Object

api.sandboxes.delete_sandbox_scenario(id: “id”, scenario_id: “scenario_id”)



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/vellum_ai/sandboxes/client.rb', line 268

def delete_sandbox_scenario(id:, scenario_id:, request_options: nil)
  Async do
    response = @request_client.conn.delete 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/sandboxes/#{id}/scenarios/#{scenario_id}"
end
  end
end

#deploy_prompt(id:, prompt_variant_id:, prompt_deployment_id: nil, prompt_deployment_name: nil, label: nil, release_tags: nil, release_description: nil, request_options: nil) ⇒ Object

api.sandboxes.deploy_prompt(id: “id”, prompt_variant_id: “prompt_variant_id”)



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/vellum_ai/sandboxes/client.rb', line 183

def deploy_prompt(id:, prompt_variant_id:, prompt_deployment_id: nil, prompt_deployment_name: nil, label: nil, release_tags: nil, release_description: nil, request_options: nil)
  Async do
    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 || {}), prompt_deployment_id: prompt_deployment_id, prompt_deployment_name: prompt_deployment_name, label: label, release_tags: release_tags, release_description: release_description }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/sandboxes/#{id}/prompts/#{prompt_variant_id}/deploy"
end
    Vellum::DeploymentRead.from_json(json_object: response.body)
  end
end

#upsert_sandbox_scenario(id:, label: nil, inputs:, scenario_id: nil, request_options: nil) ⇒ Object

api.sandboxes.upsert_sandbox_scenario(id: “id”, inputs: [{ type: “STRING”, name: “x” }, { type: “STRING”, name: “x” }])



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/vellum_ai/sandboxes/client.rb', line 230

def upsert_sandbox_scenario(id:, label: nil, inputs:, scenario_id: nil, request_options: nil)
  Async do
    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 || {}), label: label, inputs: inputs, scenario_id: scenario_id }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/sandboxes/#{id}/scenarios"
end
    Vellum::SandboxScenario.from_json(json_object: response.body)
  end
end