Class: Braintrust::Models::InsertDatasetEventMerge

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/braintrust/models/insert_dataset_event_merge.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

#_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_dataset_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_dataset_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 dataset event deleted. Deleted events will not show up in subsequent fetches for this dataset

Returns:

  • (Boolean) 


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

optional :_object_delete, Braintrust::BooleanModel

#created ⇒ DateTime

The timestamp the dataset event was created

Returns:

  • (DateTime) 


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

optional :created, DateTime

#expected ⇒ Object

The output of your application, including post-processing (an arbitrary, JSON serializable object)

Returns:

  • (Object) 


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

optional :expected, Braintrust::Unknown

#id ⇒ String

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

Returns:

  • (String) 


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

optional :id, String

#input ⇒ Object

The argument that uniquely define an input case (an arbitrary, JSON serializable object)

Returns:

  • (Object) 


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

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) 


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

optional :metadata, Hash

#tags ⇒ Array<String>

A list of tags to log

Returns:

  • (Array<String>) 


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

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