Class: Braintrust::Models::InsertExperimentEventMerge

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

Defined Under Namespace

Classes: Context, Metrics, SpanAttributes

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

#_is_merge ⇒ Object

The _is_merge field controls how the row is merged with any existing row with the same id in the DB. By default (or when set to false), the existing row is completely replaced by the new row. When set to true, the new row is deep-merged into the existing row



11
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 11

required :_is_merge, Braintrust::BooleanModel

#_merge_paths ⇒ Object

The _merge_paths field allows controlling the depth of the merge. It can only be specified alongside _is_merge=true. _merge_paths is a list of paths, where each path is a list of field names. The deep merge will not descend below any of the specified merge paths.



23
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 23

optional :_merge_paths, Braintrust::ArrayOf.new(Braintrust::ArrayOf.new(String))

#_object_delete ⇒ Boolean

Pass _object_delete=true to mark the experiment event deleted. Deleted events will not show up in subsequent fetches for this experiment

Returns:

  • (Boolean) 


28
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 28

optional :_object_delete, Braintrust::BooleanModel

#context ⇒ Braintrust::Models::InsertExperimentEventMerge::Context

Context is additional information about the code that produced the experiment event. It is essentially the textual counterpart to metrics. Use the caller_* attributes to track the location in code which produced the experiment event

Returns:



33
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 33

optional :context, -> { Braintrust::Models::InsertExperimentEventMerge::Context }

#created ⇒ DateTime

The timestamp the experiment event was created

Returns:

  • (DateTime) 


38
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 38

optional :created, DateTime

#dataset_record_id ⇒ String

If the experiment is associated to a dataset, this is the event-level dataset id this experiment event is tied to

Returns:

  • (String) 


43
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 43

optional :dataset_record_id, String

#error ⇒ Object

The error that occurred, if any.

Returns:

  • (Object) 


48
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 48

optional :error, Braintrust::Unknown

#expected ⇒ Object

The ground truth value (an arbitrary, JSON serializable object) that you'd compare to output to determine if your output value is correct or not. Braintrust currently does not compare output to expected for you, since there are so many different ways to do that correctly. Instead, these values are just used to help you navigate your experiments while digging into analyses. However, we may later use these values to re-score outputs or fine-tune your models

Returns:

  • (Object) 


53
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 53

optional :expected, Braintrust::Unknown

#id ⇒ String

A unique identifier for the experiment event. If you don't provide one, BrainTrust will generate one for you

Returns:

  • (String) 


16
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 16

optional :id, String

#input ⇒ Object

The arguments that uniquely define a test case (an arbitrary, JSON serializable object). Later on, Braintrust will use the input to know whether two test cases are the same between experiments, so they should not contain experiment-specific state. A simple rule of thumb is that if you run the same experiment twice, the input should be identical

Returns:

  • (Object) 


58
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 58

optional :input, Braintrust::Unknown

#metadata ⇒ Hash

A dictionary with additional data about the test example, model outputs, or just about anything else that's relevant, that you can use to help find and analyze examples later. For example, you could log the prompt, example's id, or anything else that would be useful to slice/dice later. The values in metadata can be any JSON-serializable type, but its keys must be strings

Returns:

  • (Hash) 


63
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 63

optional :metadata, Hash

#metrics ⇒ Braintrust::Models::InsertExperimentEventMerge::Metrics

Metrics are numerical measurements tracking the execution of the code that produced the experiment event. Use "start" and "end" to track the time span over which the experiment event was produced

Returns:



68
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 68

optional :metrics, -> { Braintrust::Models::InsertExperimentEventMerge::Metrics }

#output ⇒ Object

The output of your application, including post-processing (an arbitrary, JSON serializable object), that allows you to determine whether the result is correct or not. For example, in an app that generates SQL queries, the output should be the result of the SQL query generated by the model, not the query itself, because there may be multiple valid queries that answer a single question

Returns:

  • (Object) 


73
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 73

optional :output, Braintrust::Unknown

#scores ⇒ Hash

A dictionary of numeric values (between 0 and 1) to log. The scores should give you a variety of signals that help you determine how accurate the outputs are compared to what you expect and diagnose failures. For example, a summarization app might have one score that tells you how accurate the summary is, and another that measures the word similarity between the generated and grouth truth summary. The word similarity score could help you determine whether the summarization was covering similar concepts or not. You can use these scores to help you sort, filter, and compare experiments

Returns:

  • (Hash) 


78
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 78

optional :scores, Hash

#span_attributes ⇒ Braintrust::Models::InsertExperimentEventMerge::SpanAttributes

Human-identifying attributes of the span, such as name, type, etc.

Returns:



83
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 83

optional :span_attributes, -> { Braintrust::Models::InsertExperimentEventMerge::SpanAttributes }

#tags ⇒ Array<String>

A list of tags to log

Returns:

  • (Array<String>) 


88
 
# File 'lib/braintrust/models/insert_experiment_event_merge.rb', line 88

optional :tags, Braintrust::ArrayOf.new(String)