UserMessage (langchain4j-core 0.26.0 API)

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.

Constructor Summary

Constructors
Constructor and Description
`UserMessage(Content... contents)` Creates a `UserMessage` from contents.
`UserMessage(List<Content> contents)` Creates a `UserMessage` from contents.
`UserMessage(String text)` Creates a `UserMessage` from a text.
`UserMessage(String name, Content... contents)` Creates a `UserMessage` from a name and contents.
`UserMessage(String name, List<Content> contents)` Creates a `UserMessage` from a name and contents.
`UserMessage(String name, String text)` Creates a `UserMessage` from a name and a text.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and 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(List<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, List<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.
`int`	`hashCode()`
`boolean`	`hasSingleText()` Whether this message has a single text content.
`String`	`name()` The name of the user.
`String`	`text()` Deprecated.
`String`	`toString()`
`ChatMessageType`	`type()` The type of the message.
`static UserMessage`	`userMessage(Content... contents)` Create a `UserMessage` from contents.
`static UserMessage`	`userMessage(List<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, List<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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - 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 contents.
    Will have a {code null} name.
    
    Parameters:
    
    contents - the contents.
  - UserMessage
```
public UserMessage(String name,
                   Content... contents)
```
    Creates a UserMessage from a name and contents.
    
    Parameters:
    
    name - the name.
    
    contents - the contents.
  - UserMessage
```
public UserMessage(List<Content> contents)
```
    Creates a UserMessage from contents.
    Will have a {code null} name.
    
    Parameters:
    
    contents - the contents.
  - UserMessage
```
public UserMessage(String name,
                   List<Content> contents)
```
    Creates a UserMessage from a name and contents.
    
    Parameters:
    
    name - the name.
    
    contents - the contents.
- Method Detail
  - 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.
    
    Returns:
    
    the contents.
  - text
```
@Deprecated
public String text()
```
    Deprecated.
    
    Description copied from interface: ChatMessage
    
    The text of the message.
    
    Specified by:
    
    text in interface ChatMessage
    
    Returns:
    
    the text of the message
  - hasSingleText
```
public boolean hasSingleText()
```
    Whether this message has a single text content.
    
    Returns:
    
    true if this message has a single text content, false otherwise.
  - 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.

Class UserMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserMessage

UserMessage

UserMessage

UserMessage

UserMessage

UserMessage

Method Detail

name

contents

text

hasSingleText

type

equals

hashCode

toString

from

from

from

from

from

from

userMessage

userMessage

userMessage

userMessage

userMessage

userMessage