Class: Braintrust::Models::SummarizeExperimentResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/braintrust/models/summarize_experiment_response.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #initialize, #inspect, #to_h, #to_s

Constructor Details

This class inherits a constructor from Braintrust::BaseModel

Instance Attribute Details

#comparison_experiment_name ⇒ String

The experiment which scores are baselined against

Returns:

  • (String) 


29
 
# File 'lib/braintrust/models/summarize_experiment_response.rb', line 29

optional :comparison_experiment_name, String

#experiment_name ⇒ String

Name of the experiment

Returns:

  • (String) 


9
 
# File 'lib/braintrust/models/summarize_experiment_response.rb', line 9

required :experiment_name, String

#experiment_url ⇒ String

URL to the experiment's page in the Braintrust app

Returns:

  • (String) 


14
 
# File 'lib/braintrust/models/summarize_experiment_response.rb', line 14

required :experiment_url, String

#metrics ⇒ Hash

Summary of the experiment's metrics

Returns:

  • (Hash) 


34
 
# File 'lib/braintrust/models/summarize_experiment_response.rb', line 34

optional :metrics, Hash

#project_name ⇒ String

Name of the project that the experiment belongs to

Returns:

  • (String) 


19
 
# File 'lib/braintrust/models/summarize_experiment_response.rb', line 19

required :project_name, String

#project_url ⇒ String

URL to the project's page in the Braintrust app

Returns:

  • (String) 


24
 
# File 'lib/braintrust/models/summarize_experiment_response.rb', line 24

required :project_url, String

#scores ⇒ Hash

Summary of the experiment's scores

Returns:

  • (Hash) 


39
 
# File 'lib/braintrust/models/summarize_experiment_response.rb', line 39

optional :scores, Hash