Package org.springframework.ai.chat.messages

Class UserMessage.Builder

java.lang.Object

org.springframework.ai.chat.messages.UserMessage.Builder

Enclosing class:

UserMessage

public static final class UserMessage.Builder
extends Object

Builder for UserMessage.

Parts added through part(MessagePart) and parts(List) keep their order. text(String) and text(Resource) replace the text parts: the new text takes the place of the first text part, or comes first when there is none. media(List) replaces the media parts: the new media go where the first media part was, or last when there is none. A builder without explicit parts therefore produces the legacy order, text then media.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserMessage	build()
UserMessage.Builder	media(List<Media> media)
UserMessage.Builder	media(Media... media)
UserMessage.Builder	metadata(Map<String,Object> metadata)
UserMessage.Builder	part(MessagePart part)	Adds a part.
UserMessage.Builder	parts(List<MessagePart> parts)	Adds parts, in order.
UserMessage.Builder	text(String textContent)
UserMessage.Builder	text(org.springframework.core.io.Resource resource)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

part

public UserMessage.Builder part(MessagePart part)

Adds a part.

Parameters:

part - the part

Returns:

this builder

Since:

2.1.0

parts

public UserMessage.Builder parts(List<MessagePart> parts)

Adds parts, in order.

Parameters:

parts - the parts

Returns:

this builder

Since:

2.1.0

text

public UserMessage.Builder text(String textContent)

text

public UserMessage.Builder text(org.springframework.core.io.Resource resource)

media

public UserMessage.Builder media(List<Media> media)

media

public UserMessage.Builder media(Media... media)

metadata

public UserMessage.Builder metadata(Map<String,Object> metadata)

build

public UserMessage build()