Class: Vellum::TestSuiteRunsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Vellum::TestSuiteRunsClient

Parameters:



19
20
21
 
# File 'lib/vellum_ai/test_suite_runs/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/test_suite_runs/client.rb', line 14

def request_client
  @request_client
end

Instance Method Details

#create(test_suite_id: nil, test_suite_name: nil, exec_config:, request_options: nil) ⇒ Object

api.test_suite_runs.create(exec_config: { type: “DEPLOYMENT_RELEASE_TAG”, data: { deployment_id: “deployment_id” } })



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/vellum_ai/test_suite_runs/client.rb', line 36

def create(test_suite_id: nil, test_suite_name: nil, exec_config:, 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 || {}), test_suite_id: test_suite_id, test_suite_name: test_suite_name, exec_config: exec_config }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/test-suite-runs"
end
  Vellum::TestSuiteRunRead.from_json(json_object: response.body)
end

#list_executions(id:, expand: nil, limit: nil, offset: nil, request_options: nil) ⇒ Object

api.test_suite_runs.list_executions(id: “id”)



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/vellum_ai/test_suite_runs/client.rb', line 113

def list_executions(id:, expand: nil, limit: nil, offset: 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 || {}), "expand": expand, "limit": limit, "offset": offset }.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/test-suite-runs/#{id}/executions"
end
  Vellum::PaginatedTestSuiteRunExecutionList.from_json(json_object: response.body)
end

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

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/vellum_ai/test_suite_runs/client.rb', line 70

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/test-suite-runs/#{id}"
end
  Vellum::TestSuiteRunRead.from_json(json_object: response.body)
end