cn.hutool.ai.model.doubao

Class DoubaoServiceImpl

java.lang.Object

cn.hutool.ai.core.BaseAIService

cn.hutool.ai.model.doubao.DoubaoServiceImpl

All Implemented Interfaces:

AIService, DoubaoService

public class DoubaoServiceImpl
extends BaseAIService
implements DoubaoService

Doubao服务，AI具体功能的实现

Since:

5.8.38

Author:

elichow

Field Summary

Fields inherited from class cn.hutool.ai.core.BaseAIService

config

Constructor Summary

Constructors

Constructor and Description
DoubaoServiceImpl(AIConfig config)

Method Summary

Modifier and Type	Method and Description
String	batchChat(List<Message> messages) 批量推理 Chat 注意：调用该方法时，配置config中的model为您创建的批量推理接入点（Endpoint）ID。
String	botsChat(List<Message> messages) 应用(Bot) config中model设置为您创建的应用ID
void	botsChat(List<Message> messages, Consumer<String> callback) 应用(Bot)-SSE流式输出 config中model设置为您创建的应用ID
String	chat(List<Message> messages) 对话
void	chat(List<Message> messages, Consumer<String> callback) 对话-SSE流式输出
String	chatContext(List<Message> messages, String contextId) 上下文缓存对话： 向大模型发起带上下文缓存的请求 注意：配置config中的model可以为您创建的推理接入点（Endpoint）ID，也可以是支持chat的model
void	chatContext(List<Message> messages, String contextId, Consumer<String> callback) 上下文缓存对话-SSE流式输出 注意：配置config中的model可以为您创建的推理接入点（Endpoint）ID，也可以是支持chat的model
String	chatVision(String prompt, List<String> images, String detail) 图像理解：模型会依据传入的图片信息以及问题，给出回复。
void	chatVision(String prompt, List<String> images, String detail, Consumer<String> callback) 图像理解-SSE流式输出
String	createContext(List<Message> messages, String mode) 创建上下文缓存： 创建上下文缓存，获得缓存 id字段后，在上下文缓存对话 API中使用。
String	embeddingText(String[] input) 文本向量化
String	embeddingVision(String text, String image) 图文向量化：仅支持单一文本、单张图片或文本与图片的组合输入（即一段文本 + 一张图片），暂不支持批量文本 / 图片的同时处理
String	getVideoTasksInfo(String taskId) 查询视频生成任务信息
String	imagesGenerations(String prompt) 文生图 请设置config中model为支持图片功能的模型，目前支持Doubao-Seedream-3.0-t2i
String	tokenization(String[] text) 分词：可以将文本转换为模型可理解的 token id，并返回文本的 tokens 数量、token id、 token 在原始文本中的偏移量等信息
String	videoTasks(String text, String image, List<DoubaoCommon.DoubaoVideo> videoParams) 创建视频生成任务 注意：调用该方法时，配置config中的model为您创建的推理接入点（Endpoint）ID。

Methods inherited from class cn.hutool.ai.core.BaseAIService

sendFormData, sendGet, sendPost, sendPostStream

Methods inherited from class java.lang.Object

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

Methods inherited from interface cn.hutool.ai.model.doubao.DoubaoService

batchChat, chatContext, chatContext, chatVision, chatVision, createContext, videoTasks

Methods inherited from interface cn.hutool.ai.core.AIService

chat, chat

Constructor Detail

DoubaoServiceImpl

public DoubaoServiceImpl(AIConfig config)

Method Detail

chat

public String chat(List<Message> messages)

Description copied from interface: AIService

对话

Specified by:

chat in interface AIService

Parameters:

messages - 由目前为止的对话组成的消息列表，可以设置role，content。详细参考官方文档

Returns:

AI回答

chat

public void chat(List<Message> messages,
                 Consumer<String> callback)

Description copied from interface: AIService

对话-SSE流式输出

Specified by:

chat in interface AIService

Parameters:

messages - 由目前为止的对话组成的消息列表，可以设置role，content。详细参考官方文档

callback - 流式数据回调函数

chatVision

public String chatVision(String prompt,
                         List<String> images,
                         String detail)

Description copied from interface: DoubaoService

图像理解：模型会依据传入的图片信息以及问题，给出回复。

Specified by:

chatVision in interface DoubaoService

Parameters:

prompt - 提问

images - 图片列表/或者图片Base64编码图片列表(URI形式)

detail - 手动设置图片的质量，取值范围high、low、auto,默认为auto

Returns:

AI回答

chatVision

public void chatVision(String prompt,
                       List<String> images,
                       String detail,
                       Consumer<String> callback)

Description copied from interface: DoubaoService

图像理解-SSE流式输出

Specified by:

chatVision in interface DoubaoService

Parameters:

prompt - 提问

images - 传入的图片列表地址/或者图片Base64编码图片列表(URI形式)

detail - 手动设置图片的质量，取值范围high、low、auto,默认为auto

callback - 流式数据回调函数

videoTasks

public String videoTasks(String text,
                         String image,
                         List<DoubaoCommon.DoubaoVideo> videoParams)

Description copied from interface: DoubaoService

创建视频生成任务 注意：调用该方法时，配置config中的model为您创建的推理接入点（Endpoint）ID。详细参考官方文档

Specified by:

videoTasks in interface DoubaoService

Parameters:

text - 文本提示词

image - 图片/或者图片Base64编码图片(URI形式)

videoParams - 视频参数列表

Returns:

生成任务id

getVideoTasksInfo

public String getVideoTasksInfo(String taskId)

Description copied from interface: DoubaoService

查询视频生成任务信息

Specified by:

getVideoTasksInfo in interface DoubaoService

Parameters:

taskId - 通过创建生成视频任务返回的生成任务id

Returns:

生成任务信息

embeddingText

public String embeddingText(String[] input)

Description copied from interface: DoubaoService

文本向量化

Specified by:

embeddingText in interface DoubaoService

Parameters:

input - 需要向量化的内容列表，支持中文、英文

Returns:

处理后的向量信息

embeddingVision

public String embeddingVision(String text,
                              String image)

Description copied from interface: DoubaoService

图文向量化：仅支持单一文本、单张图片或文本与图片的组合输入（即一段文本 + 一张图片），暂不支持批量文本 / 图片的同时处理

Specified by:

embeddingVision in interface DoubaoService

Parameters:

text - 需要向量化的内容

image - 需要向量化的图片地址/或者图片Base64编码图片(URI形式)

Returns:

处理后的向量信息

botsChat

public String botsChat(List<Message> messages)

Description copied from interface: DoubaoService

应用(Bot) config中model设置为您创建的应用ID

Specified by:

botsChat in interface DoubaoService

Parameters:

messages - 由对话组成的消息列表。如系统人设，背景信息等，用户自定义的信息

Returns:

AI回答

botsChat

public void botsChat(List<Message> messages,
                     Consumer<String> callback)

Description copied from interface: DoubaoService

应用(Bot)-SSE流式输出 config中model设置为您创建的应用ID

Specified by:

botsChat in interface DoubaoService

Parameters:

messages - 由对话组成的消息列表。如系统人设，背景信息等，用户自定义的信息

callback - 流式数据回调函数

tokenization

public String tokenization(String[] text)

Description copied from interface: DoubaoService

分词：可以将文本转换为模型可理解的 token id，并返回文本的 tokens 数量、token id、 token 在原始文本中的偏移量等信息

Specified by:

tokenization in interface DoubaoService

Parameters:

text - 需要分词的内容列表

Returns:

分词结果

batchChat

public String batchChat(List<Message> messages)

Description copied from interface: DoubaoService

批量推理 Chat 注意：调用该方法时，配置config中的model为您创建的批量推理接入点（Endpoint）ID。详细参考官方文档 该方法不支持流式

Specified by:

batchChat in interface DoubaoService

Parameters:

messages - 由对话组成的消息列表。如系统人设，背景信息等，用户自定义的信息

Returns:

AI回答

createContext

public String createContext(List<Message> messages,
                            String mode)

Description copied from interface: DoubaoService

创建上下文缓存： 创建上下文缓存，获得缓存 id字段后，在上下文缓存对话 API中使用。 注意：调用该方法时，配置config中的model为您创建的推理接入点（Endpoint）ID, 推理接入点中使用的模型需要在模型管理中开启缓存功能。详细参考官方文档

Specified by:

createContext in interface DoubaoService

Parameters:

messages - 由对话组成的消息列表。如系统人设，背景信息等，用户自定义的信息

mode - 上下文缓存的类型,详细参考官方文档 默认为session

Returns:

返回的缓存id

chatContext

public String chatContext(List<Message> messages,
                          String contextId)

Description copied from interface: DoubaoService

上下文缓存对话： 向大模型发起带上下文缓存的请求 注意：配置config中的model可以为您创建的推理接入点（Endpoint）ID，也可以是支持chat的model

Specified by:

chatContext in interface DoubaoService

Parameters:

messages - 对话的信息 不支持最后一个元素的role设置为assistant。如使用session 缓存（mode设置为session）传入最新一轮对话的信息，无需传入历史信息

contextId - 创建上下文缓存后获取的缓存id

Returns:

AI的回答

chatContext

public void chatContext(List<Message> messages,
                        String contextId,
                        Consumer<String> callback)

Description copied from interface: DoubaoService

上下文缓存对话-SSE流式输出 注意：配置config中的model可以为您创建的推理接入点（Endpoint）ID，也可以是支持chat的model

Specified by:

chatContext in interface DoubaoService

Parameters:

messages - 对话的信息 不支持最后一个元素的role设置为assistant。如使用session 缓存（mode设置为session）传入最新一轮对话的信息，无需传入历史信息

contextId - 创建上下文缓存后获取的缓存id

callback - 流式数据回调函数

imagesGenerations

public String imagesGenerations(String prompt)

Description copied from interface: DoubaoService

文生图 请设置config中model为支持图片功能的模型，目前支持Doubao-Seedream-3.0-t2i

Specified by:

imagesGenerations in interface DoubaoService

Parameters:

prompt - 题词

Returns:

包含生成图片的url