Class: Braintrust::Models::DatasetEvent

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

#_xact_id ⇒ String

The transaction id of an event is unique to the network operation that processed the event insertion. Transaction ids are monotonically increasing over time and can be used to retrieve a versioned snapshot of the dataset (see the version parameter)

Returns:

  • (String) 


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

required :_xact_id, String

#created ⇒ DateTime

The timestamp the dataset event was created

Returns:

  • (DateTime) 


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

required :created, DateTime

#dataset_id ⇒ String

Unique identifier for the dataset

Returns:

  • (String) 


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

required :dataset_id, String

#expected ⇒ Object

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

Returns:

  • (Object) 


44
 
# File 'lib/braintrust/models/dataset_event.rb', line 44

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) 


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

required :id, String

#input ⇒ Object

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

Returns:

  • (Object) 


49
 
# File 'lib/braintrust/models/dataset_event.rb', line 49

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) 


54
 
# File 'lib/braintrust/models/dataset_event.rb', line 54

optional :metadata, Hash

#project_id ⇒ String

Unique identifier for the project that the dataset belongs under

Returns:

  • (String) 


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

required :project_id, String

#root_span_id ⇒ String

The span_id of the root of the trace this dataset event belongs to

Returns:

  • (String) 


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

required :root_span_id, String

#span_id ⇒ String

A unique identifier used to link different dataset events together as part of a full trace. See the tracing guide for full details on tracing

Returns:

  • (String) 


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

required :span_id, String

#tags ⇒ Array<String>

A list of tags to log

Returns:

  • (Array<String>) 


59
 
# File 'lib/braintrust/models/dataset_event.rb', line 59

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