Class: Braintrust::Models::Prompt

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

Defined Under Namespace

Classes: PromptData

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

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

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 prompt (see the version parameter)

Returns:

  • (String) 


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

required :_xact_id, String

#created ⇒ String

Date of prompt creation

Returns:

  • (String) 


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

optional :created, String

#description ⇒ String

Textual description of the prompt

Returns:

  • (String) 


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

optional :description, String

#id ⇒ String

Unique identifier for the prompt

Returns:

  • (String) 


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

required :id, String

#log_id ⇒ Symbol

A literal 'p' which identifies the object as a project prompt

Returns:

  • (Symbol) 


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

required :log_id, Braintrust::Enum.new(:'p')

#metadata ⇒ Hash

User-controlled metadata about the prompt

Returns:

  • (Hash) 


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

optional :metadata, Hash

#name_ ⇒ String

Name of the prompt

Returns:

  • (String) 


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

required :name_, String

#org_id ⇒ String

Unique identifier for the organization

Returns:

  • (String) 


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

required :org_id, String

#project_id ⇒ String

Unique identifier for the project that the prompt belongs under

Returns:

  • (String) 


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

required :project_id, String

#prompt_data ⇒ Braintrust::Models::Prompt::PromptData

The prompt, model, and its parameters

Returns:



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

optional :prompt_data, -> { Braintrust::Models::Prompt::PromptData }

#slug ⇒ String

Unique identifier for the prompt

Returns:

  • (String) 


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

required :slug, String

#tags ⇒ Array<String>

A list of tags for the prompt

Returns:

  • (Array<String>) 


64
 
# File 'lib/braintrust/models/prompt.rb', line 64

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