cn.hutool.ai.model.doubao

Interface DoubaoService

All Superinterfaces:

AIService

All Known Implementing Classes:

DoubaoServiceImpl

public interface DoubaoService
extends AIService

doubao支持的扩展接口

Since:

5.8.38

Author:

elichow

Method Summary

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

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

chat, chat

Method Detail

chatVision

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

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

Parameters:

prompt - 提问

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

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

Returns:

AI回答

Since:

5.8.38

chatVision

default String chatVision(String prompt,
                          List<String> images)

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

Parameters:

prompt - 提问

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

Returns:

AI回答

Since:

5.8.38

videoTasks

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

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

Parameters:

text - 文本提示词

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

videoParams - 视频参数列表

Returns:

生成任务id

Since:

5.8.38

videoTasks

default String videoTasks(String text,
                          String image)

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

Parameters:

text - 文本提示词

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

Returns:

生成任务id

Since:

5.8.38

getVideoTasksInfo

String getVideoTasksInfo(String taskId)

查询视频生成任务信息

Parameters:

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

Returns:

生成任务信息

Since:

5.8.38

embeddingText

String embeddingText(String[] input)

文本向量化

Parameters:

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

Returns:

处理后的向量信息

Since:

5.8.38

embeddingVision

String embeddingVision(String text,
                       String image)

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

Parameters:

text - 需要向量化的内容

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

Returns:

处理后的向量信息

Since:

5.8.38

botsChat

String botsChat(List<Message> messages)

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

Parameters:

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

Returns:

AI回答

Since:

5.8.38

tokenization

String tokenization(String[] text)

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

Parameters:

text - 需要分词的内容列表

Returns:

分词结果

Since:

5.8.38

batchChat

String batchChat(String prompt)

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

Parameters:

prompt - chat内容

Returns:

AI回答

Since:

5.8.38

batchChat

String batchChat(List<Message> messages)

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

Parameters:

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

Returns:

AI回答

Since:

5.8.38

createContext

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

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

Parameters:

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

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

Returns:

返回的缓存id

Since:

5.8.38

createContext

default String createContext(List<Message> messages)

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

Parameters:

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

Returns:

返回的缓存id

Since:

5.8.38

chatContext

String chatContext(String prompt,
                   String contextId)

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

Parameters:

prompt - 对话的内容题词

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

Returns:

AI的回答

Since:

5.8.38

chatContext

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

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

Parameters:

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

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

Returns:

AI的回答

Since:

5.8.38