Class: Vellum::MetricDefinitionsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Vellum::MetricDefinitionsClient

Parameters:



18
19
20
 
# File 'lib/vellum_ai/metric_definitions/client.rb', line 18

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Vellum::RequestClient (readonly)

Returns:



13
14
15
 
# File 'lib/vellum_ai/metric_definitions/client.rb', line 13

def request_client
  @request_client
end

Instance Method Details

#execute_metric_definition(id:, inputs:, release_tag: nil, request_options: nil) ⇒ Object

api.metric_definitions.execute_metric_definition(id: “id”, inputs: [{ name: “x”, type: “STRING”, value: “value” }, { name: “x”, type: “STRING”, value: “value” }])



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/vellum_ai/metric_definitions/client.rb', line 33

def execute_metric_definition(id:, inputs:, release_tag: 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 || {}), inputs: inputs, release_tag: release_tag }.compact
  req.url "#{@request_client.get_url(environment: Predict, request_options: request_options)}/v1/metric-definitions/#{id}/execute"
end
  Vellum::MetricDefinitionExecution.from_json(json_object: response.body)
end

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

api.metric_definitions.metric_definition_history_item_retrieve(history_id_or_release_tag: “history_id_or_release_tag”, id: “id”)



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

def metric_definition_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/metric-definitions/#{history_id_or_release_tag}/history/#{id}"
end
  Vellum::MetricDefinitionHistoryItem.from_json(json_object: response.body)
end