class BBS::AI::Persona

Who the model plays, as data. The YAML file:

system: |                 # the system prompt; line breaks are kept
  You are …
examples:                 # turns in the right voice, sent before the history
  - user: hi
    assistant: I am here.
options:                  # extra request fields (sampling), optional
  temperature: 0.8
  max_tokens: 96
deflect:                  # answered without the model, tried first:
  - match: '\b(code|python)\b'   # what a small model gets wrong
    reply: I do not write code.
fallback:                 # canned replies, tried top to bottom
  replies:
    - match: '\b(hello|hi)\b'   # a case-insensitive regexp
      reply: I am here.
  default: 'You said: "{input}".'

Attributes

examples [R]

The system prompt String (stripped), the example turns as an Array of chat messages ({ role:, content: } Hashes, user and assistant in turn), and the extra request fields as a Hash with Symbol keys. All three are frozen or read-only data.

options [R]

system [R]

Public Class Methods

load (path)

Source

# File lib/bbs/ai.rb, line 59
def self.load(path)
  data = YAML.safe_load_file(path, aliases: false) || {}
  new(**data.transform_keys(&:to_sym).slice(:system, :examples, :options, :deflect, :fallback))
end

Reads the YAML file at path and returns a Persona built from its system, examples, options, deflect and fallback keys; other keys are ignored. Raises the usual file and Psych errors for a missing or invalid file.

new (system: '', examples: [], options: {}, deflect: [], fallback: {})

Source

# File lib/bbs/ai.rb, line 77
def initialize(system: '', examples: [], options: {}, deflect: [], fallback: {})
  @system   = system.to_s.strip
  @examples = turns(examples)
  @options  = (options || {}).transform_keys(&:to_sym).freeze
  fallback ||= {}
  @deflect  = rules(deflect)
  @replies  = rules(fallback['replies'])
  @default  = fallback['default'].to_s.strip
end

Creates a persona from the parts of the YAML file (see the class description), with String keys inside examples, deflect and fallback as YAML gives them.

system: the system prompt
examples: Array of {'user' => ..., 'assistant' => ...} turns
options: extra fields for every request, such as temperature
deflect: Array of {'match' => regexp, 'reply' => text} rules answered without the model
fallback: Hash with replies (rules as for deflect) and default

Raises KeyError when an example or rule lacks a key, RegexpError for an invalid match.

Public Instance Methods

deflect (text)

Source

# File lib/bbs/ai.rb, line 90
def deflect(text)
  _, reply = @deflect.find { |pattern, _| pattern.match?(text) }
  reply&.gsub('{input}') { text }
end

Returns the reply for text that needs no model, or nil when no deflect rule matches: for questions a small model answers out of character. {input} in the reply is replaced by text.

fallback (text)

Source

# File lib/bbs/ai.rb, line 98
def fallback(text)
  _, reply = @replies.find { |pattern, _| pattern.match?(text) }
  (reply || @default).gsub('{input}') { text }
end

Returns the canned reply for text: that of the first matching fallback rule, else the default (an empty String when the persona has none). {input} in the reply is replaced by text.

messages (facts = nil)

Source

# File lib/bbs/ai.rb, line 108
def messages(facts = nil)
  system = [@system, facts.to_s.strip].reject(&:empty?).join("\n\n")
  [({ role: 'system', content: system } unless system.empty?), *@examples].compact
end

Returns the messages that open every request: the system prompt (left out when empty) followed by the example turns. facts (a String) is added to the system prompt for this one request: what the character should know right now, such as something looked up for the question at hand.