UserMessage

org.llm4s.llmconnect.model.UserMessage
See theUserMessage companion object
@Stable
final class UserMessage(val parts: Vector[ContentPart]) extends Message, Serializable

A user message: text, images and documents, as ContentParts.

UserMessage(text) is the one-part message. A provider that cannot send one of the parts fails the request with an org.llm4s.error.UnsupportedContentPartError.

'''Not a case class, on purpose.''' It has no extractor, so case UserMessage(content) => does not compile: before content parts that pattern bound the text, and an extractor of the parts would have kept code compiling that used the binder only in a string - and so sent Vector(Text(...)) as the text, or silently dropped the media. Match the type, case u: UserMessage, and read u.content (the text) or u.parts. Equality is by parts.

Value parameters

parts

the message's content, in order.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Message
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def content: String

The message's text parts, joined by newlines; "" when it is all media.

The message's text parts, joined by newlines; "" when it is all media.

Attributes

override def equals(other: Any): Boolean

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 x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

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

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
override def hashCode: Int

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
override def toString: String

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
Message -> Any
override def validate: Result[Message]

Validates that this message satisfies its role-specific content constraints.

Validates that this message satisfies its role-specific content constraints.

Returns Left(ValidationError) when content is blank; AssistantMessage additionally requires at least one of content or toolCalls to be present.

Attributes

Definition Classes
def withParts(parts: Vector[ContentPart]): UserMessage

This message with parts instead.

This message with parts instead.

Attributes

Concrete fields

val parts: Vector[ContentPart]