A prompt built with the prompt"..." and system"..." interpolators: text whose interpolated values were each rendered by a Promptable checked at compile time, and whose Untrusted values are fenced.
import org.llm4s.prompt.*
val conversation: Result[Conversation] =
(system"You are a support triage assistant." ++ prompt"Classify: ${Untrusted.text(email)}").toConversation
A prompt is a sequence of parts, each a system or a user part. ++ appends; adjacent parts of the same role become one message, joined by a blank line. Fences are numbered u1, u2, ... in order across the whole prompt when it is rendered, so prompts combined with ++ never reuse an id.
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Value members
Concrete methods
Compares the receiver object (this) with the argument object (that) for equivalence.
Compares the receiver object (this) with the argument object (that) for equivalence.
Any implementation of this method should be an equivalence relation:
- It is reflexive: for any instance
xof typeAny,x.equals(x)should returntrue. - It is symmetric: for any instances
xandyof typeAny,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any instances
x,y, andzof typeAnyifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).
Value parameters
- that
-
the object to compare against this object for equality.
Attributes
- Returns
-
trueif the receiver object is equivalent to the argument;falseotherwise. - Definition Classes
-
Any
Calculates a hash code value for the object.
Calculates a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
Attributes
- Returns
-
the hash code value for this object.
- Definition Classes
-
Any
The messages: one per run of adjacent parts with the same role, in order. Not validated.
The messages: one per run of adjacent parts with the same role, in order. Not validated.
Attributes
This prompt with the margin stripped from its literal text: on each line of the template, leading blanks followed by | are removed, as String#stripMargin does. Interpolated values are never changed, so a value that contains | keeps it.
This prompt with the margin stripped from its literal text: on each line of the template, leading blanks followed by | are removed, as String#stripMargin does. Interpolated values are never changed, so a value that contains | keeps it.
Attributes
The text of every message, joined by a blank line; the roles are not shown.
The text of every message, joined by a blank line; the roles are not shown.
Attributes
The prompt as a conversation, validated (no empty message).
The prompt as a conversation, validated (no empty message).
Attributes
The prompt as one message; a Left if it is empty, blank or holds more than one message.
The prompt as one message; a Left if it is empty, blank or holds more than one message.
Attributes
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns
-
a string representation of the object.
- Definition Classes
-
Any