程序包 com.ajaxjs.mcp.message

类 UserMessage

java.lang.Object

com.ajaxjs.mcp.message.UserMessage

所有已实现的接口:

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

,

引用无效

PdfFileContent

, or

引用无效

TextFileContent

.
Optionally, user message can contain a name of the user. Be aware that not all models support names in UserMessage.

嵌套类概要

嵌套类

修饰符和类型	类	说明
static class	UserMessage.Builder

构造器概要

构造器

构造器	说明
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.

方法概要

修饰符和类型	方法	说明
static UserMessage.Builder	builder()
List<Content>	contents()	The Contents of the message.
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.
boolean	hasSingleText()	Whether this message contains a single TextContent.
String	name()	The name of the user.
String	singleText()	Returns text from a single TextContent.
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.

从类继承的方法 java.lang.Object

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

构造器详细资料

UserMessage

public UserMessage(String text)

Creates a UserMessage from a text.

参数:

text - the text.

UserMessage

public UserMessage(String name,
 String text)

Creates a UserMessage from a name and a text.

参数:

name - the name.

text - the text.

UserMessage

public UserMessage(Content... contents)

Creates a UserMessage from one or multiple Contents.
Will have a null name.

参数:

contents - the contents.

UserMessage

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

Creates a UserMessage from a name and one or multiple Contents.

参数:

name - the name.

contents - the contents.

UserMessage

public UserMessage(List<Content> contents)

Creates a UserMessage from a list of Contents.
Will have a null name.

参数:

contents - the contents.

UserMessage

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

Creates a UserMessage from a name and a list of Contents.

参数:

name - the name.

contents - the contents.

方法详细资料

name

public String name()

The name of the user.

返回:

the name, or null if not set.

contents

public List<Content> contents()

The Contents of the message.

返回:

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.

返回:

a single text.

另请参阅:

• hasSingleText()

hasSingleText

public boolean hasSingleText()

Whether this message contains a single TextContent.

返回:

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

type

public ChatMessageType type()

从接口复制的说明: ChatMessage

The type of the message.

指定者:

type 在接口中 ChatMessage

返回:

the type of the message

builder

public static UserMessage.Builder builder()

from

public static UserMessage from(String text)

Create a UserMessage from a text.

参数:

text - the text.

返回:

the UserMessage.

from

public static UserMessage from(String name,
 String text)

Create a UserMessage from a name and a text.

参数:

name - the name.

text - the text.

返回:

the UserMessage.

from

public static UserMessage from(Content... contents)

Create a UserMessage from contents.

参数:

contents - the contents.

返回:

the UserMessage.

from

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

Create a UserMessage from a name and contents.

参数:

name - the name.

contents - the contents.

返回:

the UserMessage.

from

public static UserMessage from(List<Content> contents)

Create a UserMessage from contents.

参数:

contents - the contents.

返回:

the UserMessage.

from

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

Create a UserMessage from a name and contents.

参数:

name - the name.

contents - the contents.

返回:

the UserMessage.

userMessage

public static UserMessage userMessage(String text)

Create a UserMessage from a text.

参数:

text - the text.

返回:

the UserMessage.

userMessage

public static UserMessage userMessage(String name,
 String text)

Create a UserMessage from a name and a text.

参数:

name - the name.

text - the text.

返回:

the UserMessage.

userMessage

public static UserMessage userMessage(Content... contents)

Create a UserMessage from contents.

参数:

contents - the contents.

返回:

the UserMessage.

userMessage

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

Create a UserMessage from a name and contents.

参数:

name - the name.

contents - the contents.

返回:

the UserMessage.

userMessage

public static UserMessage userMessage(List<Content> contents)

Create a UserMessage from contents.

参数:

contents - the contents.

返回:

the UserMessage.

userMessage

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

Create a UserMessage from a name and contents.

参数:

name - the name.

contents - the contents.

返回:

the UserMessage.