llm4s-docs
API
Generated with
llm4s-docs/org.llm4s/org.llm4s.jev/JevQuestion

JevQuestion

org.llm4s.jev.JevQuestion
See theJevQuestion companion trait
object JevQuestion

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

final case class Choice(instructions: Value, options: Seq[(String, Option[Value])]) extends JevQuestion

Picks one option from a set you define.

Picks one option from a set you define.

Value parameters

instructions

what the model should decide

options

each option with its description; None when an option needs no description. Order is kept on the wire.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait JevQuestion
class Object
trait Matchable
class Any
Show all
final case class Noul(instructions: Value, yes: Option[Value], no: Option[Value]) extends JevQuestion

A yes/no question; the answer is the probability of yes.

A yes/no question; the answer is the probability of yes.

Value parameters

instructions

the yes/no question

no

what a no (a value near 0) means, if it needs saying

yes

what a yes (a value near 1) means, if it needs saying

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait JevQuestion
class Object
trait Matchable
class Any
Show all
final case class Score(instructions: Value, levels: Seq[Value]) extends JevQuestion

Rates the state along ordered levels you describe; the answer is a probability-weighted score that can land between levels.

Rates the state along ordered levels you describe; the answer is a probability-weighted score that can land between levels.

Value parameters

instructions

what the model should rate

levels

the level descriptions, lowest first (level 0 is the first)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait JevQuestion
class Object
trait Matchable
class Any
Show all

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def choice(instructions: String, options: (String, String)*): Choice

A Choice given as text: options pairs each option with its description.

A Choice given as text: options pairs each option with its description.

Attributes

def choiceOf(instructions: String, options: String*): Choice

A Choice of bare options that need no description.

A Choice of bare options that need no description.

Attributes

def noul(question: String): Noul

A yes/no question given as text.

A yes/no question given as text.

Attributes

def noul(question: String, yes: String, no: String): Noul

A yes/no question given as text, with a description of what yes and no mean.

A yes/no question given as text, with a description of what yes and no mean.

Attributes

def score(instructions: String, levels: String*): Score

A Score given as text: levels describe the levels, lowest first.

A Score given as text: levels describe the levels, lowest first.

Attributes

Concrete fields

val MaxChoiceOptions: Int

The most options the API accepts in one Choice.

The most options the API accepts in one Choice.

Attributes

val MaxScoreLevels: Int

The most levels the API accepts in one Score.

The most levels the API accepts in one Score.

Attributes

val MinScoreLevels: Int

The fewest levels a Score should have.

The fewest levels a Score should have.

Attributes

Generated with