/* * Copyright 2023-present the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.springframework.ai.chat.messages; import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; import org.springframework.ai.content.Media; import org.springframework.ai.content.MediaContent; import org.springframework.core.io.Resource; import org.springframework.lang.NonNull; import org.springframework.lang.Nullable; import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** * A message of the type 'user' passed as input Messages with the user role are from the * end-user or developer. They represent questions, prompts, or any input that you want * the generative to respond to. */ public class UserMessage extends AbstractMessage implements MediaContent { protected final List media; public UserMessage(String textContent) { this(textContent, new ArrayList<>(), Map.of()); } private UserMessage(String textContent, Collection media, Map metadata) { super(MessageType.USER, textContent, metadata); Assert.notNull(media, "media cannot be null"); Assert.noNullElements(media, "media cannot have null elements"); this.media = new ArrayList<>(media); } public UserMessage(Resource resource) { this(MessageUtils.readResource(resource)); } @Override public String toString() { return "UserMessage{" + "content='" + getText() + '\'' + ", metadata=" + this.metadata + ", messageType=" + this.messageType + '}'; } @Override @NonNull public String getText() { return this.textContent; } @Override public List getMedia() { return this.media; } public UserMessage copy() { return new Builder().text(getText()).media(List.copyOf(getMedia())).metadata(Map.copyOf(getMetadata())).build(); } public Builder mutate() { return new Builder().text(getText()).media(List.copyOf(getMedia())).metadata(Map.copyOf(getMetadata())); } public static Builder builder() { return new Builder(); } public static final class Builder { @Nullable private String textContent; @Nullable private Resource resource; private List media = new ArrayList<>(); private Map metadata = new HashMap<>(); public Builder text(String textContent) { this.textContent = textContent; return this; } public Builder text(Resource resource) { this.resource = resource; return this; } public Builder media(List media) { this.media = media; return this; } public Builder media(@Nullable Media... media) { if (media != null) { this.media = Arrays.asList(media); } return this; } public Builder metadata(Map metadata) { this.metadata = metadata; return this; } public UserMessage build() { if (StringUtils.hasText(this.textContent) && this.resource != null) { throw new IllegalArgumentException("textContent and resource cannot be set at the same time"); } else if (this.resource != null) { this.textContent = MessageUtils.readResource(this.resource); } return new UserMessage(this.textContent, this.media, this.metadata); } } }