org.noear.solon.ai.chat.message

接口 ChatMessage

所有超级接口:

java.io.Serializable

所有已知实现类:

AssistantMessage, ChatMessageBase, SystemMessage, ToolMessage, UserMessage

public interface ChatMessage
extends java.io.Serializable

聊天消息

从以下版本开始:

3.1

方法概要

限定符和类型	方法和说明
ChatMessage	addMetadata(java.util.Map<java.lang.String,java.lang.Object> map) 添加元数据
ChatMessage	addMetadata(java.lang.String key, java.lang.Object value) 添加元数据
static ChatMessage	augment(java.lang.String message, java.lang.Object context) 已过时。 3.3 ofUserAugment(String, Object)
static ChatMessage	fromJson(org.noear.snack4.ONode oNode)
static ChatMessage	fromJson(java.lang.String json) 从 json 反序列化为消息
static java.util.List<ChatMessage>	fromNdjson(java.io.InputStream ins) 从 ndjson 反序列化为消息
static void	fromNdjson(java.io.InputStream ins, java.util.function.Consumer<ChatMessage> consumer) 从 ndjson 反序列化为消息
static java.util.List<ChatMessage>	fromNdjson(java.lang.String ndjson) 从 ndjson 反序列化为消息
static void	fromNdjson(java.lang.String ndjson, java.util.function.Consumer<ChatMessage> consumer) 从 ndjson 反序列化为消息
java.lang.String	getContent() 内容
java.util.Map<java.lang.String,java.lang.Object>	getMetadata() 获取元数据
<T> T	getMetadataAs(java.lang.String key) 获取元数据
ChatRole	getRole() 角色
default boolean	isThinking() 是否思考中
static AssistantMessage	ofAssistant(java.lang.String content)
static SystemMessage	ofSystem(java.lang.String content) 构建系统消息
static SystemMessage	ofSystem(java.lang.String role, java.lang.String instruction) 构建系统消息
static SystemMessageTemplate	ofSystemTmpl(java.lang.String tmpl) 创建系统消息模板
static ToolMessage	ofTool(java.lang.String content, java.lang.String name, java.lang.String toolCallId) 构建工具消息
static ToolMessage	ofTool(ToolResult toolResult, java.lang.String name, java.lang.String toolCallId, boolean returnDirect) 构建工具消息
static UserMessage	ofUser(ContentBlock block) 构建用户消息
static UserMessage	ofUser(Contents contents)
static UserMessage	ofUser(java.lang.String content) 构建用户消息
static UserMessage	ofUser(java.lang.String content, ContentBlock... blocks) 构建用户消息
static UserMessage	ofUser(java.lang.String content, java.util.List<ContentBlock> blocks) 构建用户消息
static UserMessage	ofUserAugment(java.lang.String message, java.lang.Object context) 用户消息增强
static UserMessageTemplate	ofUserTmpl(java.lang.String tmpl) 创建用户消息模板
static UserMessageTemplate	template(java.lang.String tmpl) 已过时。 3.3 ofUserTmpl(String)
static java.lang.String	toJson(ChatMessage message) 序列化为 json
static java.lang.String	toNdjson(java.util.Collection<ChatMessage> messages) 序列化为 ndjson
static void	toNdjson(java.util.Collection<ChatMessage> messages, java.io.OutputStream out) 序列化为 ndjson

方法详细资料

getRole

ChatRole getRole()

角色

getContent

java.lang.String getContent()

内容

getMetadata

java.util.Map<java.lang.String,java.lang.Object> getMetadata()

获取元数据

getMetadataAs

<T> T getMetadataAs(java.lang.String key)

获取元数据

addMetadata

ChatMessage addMetadata(java.util.Map<java.lang.String,java.lang.Object> map)

添加元数据

addMetadata

ChatMessage addMetadata(java.lang.String key,
                        java.lang.Object value)

添加元数据

isThinking

default boolean isThinking()

是否思考中

ofAssistant

static AssistantMessage ofAssistant(java.lang.String content)

ofSystem

static SystemMessage ofSystem(java.lang.String content)

构建系统消息

ofSystem

static SystemMessage ofSystem(java.lang.String role,
                              java.lang.String instruction)

构建系统消息

ofUser

static UserMessage ofUser(java.lang.String content)

构建用户消息

ofUser

static UserMessage ofUser(java.lang.String content,
                          java.util.List<ContentBlock> blocks)

构建用户消息

ofUser

static UserMessage ofUser(java.lang.String content,
                          ContentBlock... blocks)

构建用户消息

ofUser

static UserMessage ofUser(ContentBlock block)

构建用户消息

ofUser

static UserMessage ofUser(Contents contents)

ofTool

static ToolMessage ofTool(java.lang.String content,
                          java.lang.String name,
                          java.lang.String toolCallId)

构建工具消息

ofTool

static ToolMessage ofTool(ToolResult toolResult,
                          java.lang.String name,
                          java.lang.String toolCallId,
                          boolean returnDirect)

构建工具消息

ofUserAugment

static UserMessage ofUserAugment(java.lang.String message,
                                 java.lang.Object context)

用户消息增强

ofSystemTmpl

static SystemMessageTemplate ofSystemTmpl(java.lang.String tmpl)

创建系统消息模板

ofUserTmpl

static UserMessageTemplate ofUserTmpl(java.lang.String tmpl)

创建用户消息模板

template

@Deprecated
static UserMessageTemplate template(java.lang.String tmpl)

已过时。 3.3 ofUserTmpl(String)

创建用户消息模板

augment

@Deprecated
static ChatMessage augment(java.lang.String message,
                                       java.lang.Object context)

已过时。 3.3 ofUserAugment(String, Object)

用户消息增强

toJson

static java.lang.String toJson(ChatMessage message)

序列化为 json

fromJson

static ChatMessage fromJson(java.lang.String json)

从 json 反序列化为消息

fromJson

static ChatMessage fromJson(org.noear.snack4.ONode oNode)

toNdjson

static java.lang.String toNdjson(java.util.Collection<ChatMessage> messages)
                          throws java.io.IOException

序列化为 ndjson

抛出:

java.io.IOException

toNdjson

static void toNdjson(java.util.Collection<ChatMessage> messages,
                     java.io.OutputStream out)
              throws java.io.IOException

序列化为 ndjson

抛出:

java.io.IOException

fromNdjson

static java.util.List<ChatMessage> fromNdjson(java.lang.String ndjson)
                                       throws java.io.IOException

从 ndjson 反序列化为消息

抛出:

java.io.IOException

fromNdjson

static void fromNdjson(java.lang.String ndjson,
                       java.util.function.Consumer<ChatMessage> consumer)
                throws java.io.IOException

从 ndjson 反序列化为消息

抛出:

java.io.IOException

fromNdjson

static java.util.List<ChatMessage> fromNdjson(java.io.InputStream ins)
                                       throws java.io.IOException

从 ndjson 反序列化为消息

抛出:

java.io.IOException

fromNdjson

static void fromNdjson(java.io.InputStream ins,
                       java.util.function.Consumer<ChatMessage> consumer)
                throws java.io.IOException

从 ndjson 反序列化为消息

抛出:

java.io.IOException