Class: Vellum::SandboxesClient

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::SandboxesClient

Parameters:



19
20
21
 
# File 'lib/vellum_ai/sandboxes/client.rb', line 19

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Vellum::RequestClient (readonly)

Returns:



14
15
16
 
# File 'lib/vellum_ai/sandboxes/client.rb', line 14

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”)



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/sandboxes/client.rb', line 126

def delete_sandbox_scenario(id:, scenario_id:, request_options: nil)
  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

#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”)



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/vellum_ai/sandboxes/client.rb', line 45

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)
  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

#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” }])



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/vellum_ai/sandboxes/client.rb', line 90

def upsert_sandbox_scenario(id:, label: nil, inputs:, scenario_id: 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 || {}), 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