Class: Braintrust::BaseModel

Inherits:

Object

• Object
• Braintrust::BaseModel

Defined in:

lib/braintrust/base_model.rb

Direct Known Subclasses

Models::ACL, Models::ACLBatchUpdateResponse, Models::AISecret, Models::APIKey, Models::ChatCompletionContentPartImage, Models::ChatCompletionContentPartImage::ImageURL, Models::ChatCompletionContentPartText, Models::ChatCompletionMessageToolCall, Models::ChatCompletionMessageToolCall::Function, Models::CodeBundle, Models::CodeBundle::RuntimeContext, Models::CreateAPIKeyOutput, Models::CrossObjectInsertResponse, Models::DataSummary, Models::Dataset, Models::DatasetEvent, Models::EnvVar, Models::EnvVarListResponse, Models::Experiment, Models::ExperimentEvent, Models::ExperimentEvent::Context, Models::ExperimentEvent::Metrics, Models::ExperimentEvent::SpanAttributes, Models::FeedbackDatasetItem, Models::FeedbackExperimentItem, Models::FeedbackProjectLogsItem, Models::FeedbackResponseSchema, Models::FetchDatasetEventsResponse, Models::FetchExperimentEventsResponse, Models::FetchProjectLogsEventsResponse, Models::Function, Models::Function::FunctionSchema, Models::Function::Origin, Models::FunctionToolChoice, Models::Group, Models::InsertDatasetEventMerge, Models::InsertDatasetEventReplace, Models::InsertEventsResponse, Models::InsertExperimentEventMerge, Models::InsertExperimentEventMerge::Context, Models::InsertExperimentEventMerge::Metrics, Models::InsertExperimentEventMerge::SpanAttributes, Models::InsertExperimentEventReplace, Models::InsertExperimentEventReplace::Context, Models::InsertExperimentEventReplace::Metrics, Models::InsertExperimentEventReplace::SpanAttributes, Models::InsertProjectLogsEventMerge, Models::InsertProjectLogsEventMerge::Context, Models::InsertProjectLogsEventMerge::Metrics, Models::InsertProjectLogsEventMerge::SpanAttributes, Models::InsertProjectLogsEventReplace, Models::InsertProjectLogsEventReplace::Context, Models::InsertProjectLogsEventReplace::Metrics, Models::InsertProjectLogsEventReplace::SpanAttributes, Models::MetricSummary, Models::OnlineScoreConfig, Models::Organization, Models::PatchOrganizationMembersOutput, Models::PathLookupFilter, Models::Project, Models::ProjectLogsEvent, Models::ProjectLogsEvent::Context, Models::ProjectLogsEvent::Metrics, Models::ProjectLogsEvent::SpanAttributes, Models::ProjectScore, Models::ProjectScoreCategory, Models::ProjectScoreConfig, Models::ProjectSettings, Models::ProjectTag, Models::Prompt, Models::PromptData, Models::PromptData::Options, Models::PromptData::Origin, Models::PromptData::Parser, Models::RepoInfo, Models::Role, Models::Role::MemberPermission, Models::ScoreSummary, Models::Scorer, Models::SummarizeDatasetResponse, Models::SummarizeExperimentResponse, Models::Task, Models::User, Models::View, Models::ViewData, Models::ViewDataSearch, Models::ViewOptions

Instance Method Summary

• #[](key) ⇒ Object

  Lookup attribute value by key in the object.

• #initialize(data = {}) ⇒ BaseModel constructor

  Create a new instance of a model.

• #inspect ⇒ String
• #to_h ⇒ Hash{Symbol => Object} (also: #to_hash)

  Returns a Hash of the data underlying this object.

• #to_s ⇒ String

Constructor Details

#initialize(data = {}) ⇒ BaseModel

Create a new instance of a model.

Parameters:

• data (Hash) (defaults to: {}) —

  Model attributes.

# File 'lib/braintrust/base_model.rb', line 144

def initialize(data = {})
  @data = {}
  # TODO: what if data isn't a hash?
  data.each do |field_name, value|
    next if value.nil?

    field = self.class.fields[field_name.to_sym]
    if field
      next if field[:mode] == :w
    end
    @data[field_name.to_sym] = value
  end
end

Instance Method Details

#[](key) ⇒ Object

Lookup attribute value by key in the object. If this key was not provided when the object was formed (e.g. because the API response did not include that key), returns nil. It is valid to lookup keys that are not in the API spec, for example to access undocumented features. Lookup by anything other than a Symbol is an ArgumentError.

Parameters:

• key (Symbol) —

  Key to look up by.

Returns:

• (Object) —

  Parsed / typed value at the given key, or nil if no data is available.

# File 'lib/braintrust/base_model.rb', line 183

def [](key)
  if !key.instance_of?(Symbol)
    raise ArgumentError, "Expected symbol key for lookup, got #{key.inspect}"
  end
  @data[key]
end

#inspect ⇒ String

Returns:

• (String)

# File 'lib/braintrust/base_model.rb', line 191

def inspect
  "#<#{self.class.name}:0x#{object_id.to_s(16)} #{@data.inspect}>"
end

#to_h ⇒ Hash{Symbol => Object} Also known as: to_hash

Returns a Hash of the data underlying this object. Keys are Symbols and values are the parsed / typed domain objects. The return value indicates which values were ever set on the object - i.e. there will be a key in this hash if they ever were, even if the set value was nil. This method is not recursive. The returned value is shared by the object, so it should not be mutated.

Returns:

• (Hash{Symbol => Object}) —

  Data for this object.

# File 'lib/braintrust/base_model.rb', line 167

def to_h
  @data
end

#to_s ⇒ String

Returns:

• (String)

# File 'lib/braintrust/base_model.rb', line 196

def to_s
  @data.to_s
end