Package dev.langchain4j.data.message

Class UserMessage

java.lang.Object

dev.langchain4j.data.message.UserMessage

All Implemented Interfaces:

ChatMessage

public class UserMessage
extends Object
implements ChatMessage

Represents a message from a user, typically an end user of the application.
Depending on the supported modalities (text, image, audio, video, etc.) of the model, user messages can contain either a single text (a String) or multiple Contents, which can be either TextContent, ImageContent, AudioContent, VideoContent, or PdfFileContent.
Optionally, user message can contain a name of the user. Be aware that not all models support names in UserMessage.

Constructor Summary

Constructors

Constructor	Description
UserMessage(Content... contents)	Creates a UserMessage from one or multiple Contents.
UserMessage(String text)	Creates a UserMessage from a text.
UserMessage(String name, Content... contents)	Creates a UserMessage from a name and one or multiple Contents.
UserMessage(String name, String text)	Creates a UserMessage from a name and a text.
UserMessage(String name, List<Content> contents)	Creates a UserMessage from a name and a list of Contents.
UserMessage(List<Content> contents)	Creates a UserMessage from a list of Contents.

Method Summary

Modifier and Type	Method	Description
List<Content>	contents()	The contents of the message.
boolean	equals(Object o)
static UserMessage	from(Content... contents)	Create a UserMessage from contents.
static UserMessage	from(String text)	Create a UserMessage from a text.
static UserMessage	from(String name, Content... contents)	Create a UserMessage from a name and contents.
static UserMessage	from(String name, String text)	Create a UserMessage from a name and a text.
static UserMessage	from(String name, List<Content> contents)	Create a UserMessage from a name and contents.
static UserMessage	from(List<Content> contents)	Create a UserMessage from contents.
int	hashCode()
boolean	hasSingleText()	Whether this message contains a single TextContent.
String	name()	The name of the user.
String	singleText()	Returns text from a single TextContent.
String	text()	Deprecated, for removal: This API element is subject to removal in a future version. Use singleText() or contents() instead.
String	toString()
ChatMessageType	type()	The type of the message.
static UserMessage	userMessage(Content... contents)	Create a UserMessage from contents.
static UserMessage	userMessage(String text)	Create a UserMessage from a text.
static UserMessage	userMessage(String name, Content... contents)	Create a UserMessage from a name and contents.
static UserMessage	userMessage(String name, String text)	Create a UserMessage from a name and a text.
static UserMessage	userMessage(String name, List<Content> contents)	Create a UserMessage from a name and contents.
static UserMessage	userMessage(List<Content> contents)	Create a UserMessage from contents.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UserMessage

public UserMessage(String text)

Creates a UserMessage from a text.

Parameters:

text - the text.

UserMessage

public UserMessage(String name,
 String text)

Creates a UserMessage from a name and a text.

Parameters:

name - the name.

text - the text.

UserMessage

public UserMessage(Content... contents)

Creates a UserMessage from one or multiple Contents. Content can be either TextContent or ImageContent.
Will have a null name.

Parameters:

contents - the contents.

UserMessage

public UserMessage(String name,
 Content... contents)

Creates a UserMessage from a name and one or multiple Contents. Content can be either TextContent or ImageContent.

Parameters:

name - the name.

contents - the contents.

UserMessage

public UserMessage(List<Content> contents)

Creates a UserMessage from a list of Contents. Content can be either TextContent or ImageContent.
Will have a null name.

Parameters:

contents - the contents.

UserMessage

public UserMessage(String name,
 List<Content> contents)

Creates a UserMessage from a name and a list of Contents. Content can be either TextContent or ImageContent.

Parameters:

name - the name.

contents - the contents.

Method Details

name

public String name()

The name of the user.

Returns:

the name, or null if not set.

contents

public List<Content> contents()

The contents of the message. Content can be either TextContent or ImageContent.

Returns:

the contents.

singleText

public String singleText()

Returns text from a single TextContent. Use this accessor only if you are certain that the message contains only a single text. If the message contains multiple Contents, or if the only Content is not a TextContent, a RuntimeException is thrown.

Returns:

a single text.

See Also:

• hasSingleText()

hasSingleText

public boolean hasSingleText()

Whether this message contains a single TextContent.

Returns:

true if this message contains a single TextContent, false otherwise.

text

@Deprecated(forRemoval=true)
public String text()

Deprecated, for removal: This API element is subject to removal in a future version.

Use singleText() or contents() instead.

UserMessage can contain not just a single String text, but also multiple Contents, which can be either TextContent or ImageContent. Therefore, this method is deprecated. Please use singleText() if you only expect a single text, or use contents() otherwise.

Specified by:

text in interface ChatMessage

Returns:

the text of the message

type

public ChatMessageType type()

Description copied from interface: ChatMessage

The type of the message.

Specified by:

type in interface ChatMessage

Returns:

the type of the message

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static UserMessage from(String text)

Create a UserMessage from a text.

Parameters:

text - the text.

Returns:

the UserMessage.

from

public static UserMessage from(String name,
 String text)

Create a UserMessage from a name and a text.

Parameters:

name - the name.

text - the text.

Returns:

the UserMessage.

from

public static UserMessage from(Content... contents)

Create a UserMessage from contents.

Parameters:

contents - the contents.

Returns:

the UserMessage.

from

public static UserMessage from(String name,
 Content... contents)

Create a UserMessage from a name and contents.

Parameters:

name - the name.

contents - the contents.

Returns:

the UserMessage.

from

public static UserMessage from(List<Content> contents)

Create a UserMessage from contents.

Parameters:

contents - the contents.

Returns:

the UserMessage.

from

public static UserMessage from(String name,
 List<Content> contents)

Create a UserMessage from a name and contents.

Parameters:

name - the name.

contents - the contents.

Returns:

the UserMessage.

userMessage

public static UserMessage userMessage(String text)

Create a UserMessage from a text.

Parameters:

text - the text.

Returns:

the UserMessage.

userMessage

public static UserMessage userMessage(String name,
 String text)

Create a UserMessage from a name and a text.

Parameters:

name - the name.

text - the text.

Returns:

the UserMessage.

userMessage

public static UserMessage userMessage(Content... contents)

Create a UserMessage from contents.

Parameters:

contents - the contents.

Returns:

the UserMessage.

userMessage

public static UserMessage userMessage(String name,
 Content... contents)

Create a UserMessage from a name and contents.

Parameters:

name - the name.

contents - the contents.

Returns:

the UserMessage.

userMessage

public static UserMessage userMessage(List<Content> contents)

Create a UserMessage from contents.

Parameters:

contents - the contents.

Returns:

the UserMessage.

userMessage

public static UserMessage userMessage(String name,
 List<Content> contents)

Create a UserMessage from a name and contents.

Parameters:

name - the name.

contents - the contents.

Returns:

the UserMessage.