Class: Retab::ExperimentRunMetrics

Inherits:
Object
  • Object
show all
Defined in:
lib/retab/experiment_run_metrics.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ExperimentRunMetrics

Returns a new instance of ExperimentRunMetrics.



9
10
11
 
# File 'lib/retab/experiment_run_metrics.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#get(run_id:, view: 'summary', document_id: nil, target_path: nil, include_prior: true, prior_run_id: nil, request_options: {}) ⇒ Retab::ExperimentSummaryMetricsResponse, ...

Get Experiment Metrics For Run

Parameters:

  • run_id (String)
  • view (Retab::Types::ExperimentRunMetricsView, nil) (defaults to: 'summary')
  • document_id (String, nil) (defaults to: nil)
  • target_path (String, nil) (defaults to: nil)
  • include_prior (Boolean, nil) (defaults to: true)
  • prior_run_id (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/retab/experiment_run_metrics.rb', line 22

def get(
  run_id:,
  view: 'summary',
  document_id: nil,
  target_path: nil,
  include_prior: true,
  prior_run_id: nil,
  request_options: {}
)
  params = {
    'run_id' => run_id,
    'view' => view,
    'document_id' => document_id,
    'target_path' => target_path,
    'include_prior' => include_prior,
    'prior_run_id' => prior_run_id
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/workflows/experiments/metrics',
    auth: true,
    params: params,
    request_options: request_options
  )
  JSON.parse(response.body)
end