cn.hutool.ai.model.openai

Interface OpenaiService

All Superinterfaces:

AIService

All Known Implementing Classes:

OpenaiServiceImpl

public interface OpenaiService
extends AIService

openai支持的扩展接口

Since:

5.8.38

Author:

elichow

Method Summary

Modifier and Type	Method and Description
default String	chatReasoning(List<Message> messages) 推理chat 支持o3-mini和o1
String	chatReasoning(List<Message> messages, String reasoningEffort) 推理chat 支持o3-mini和o1
default String	chatReasoning(String prompt) 推理chat 支持o3-mini和o1
String	chatReasoning(String prompt, String reasoningEffort) 推理chat 支持o3-mini和o1
default String	chatVision(String prompt, List<String> images) 图像理解：模型会依据传入的图片信息以及问题，给出回复。
String	chatVision(String prompt, List<String> images, String detail) 图像理解：模型会依据传入的图片信息以及问题，给出回复。
String	embeddingText(String input) 文本向量化 请设置config中model为支持文本向量化功能的模型 text-embedding系列
default String	imagesEdits(String prompt, File image) 图片编辑 该方法仅支持 DALL·E 2 model
String	imagesEdits(String prompt, File image, File mask) 图片编辑 该方法仅支持 DALL·E 2 model
String	imagesGenerations(String prompt) 文生图 请设置config中model为支持图片功能的模型 DALL·E系列
String	imagesVariations(File image) 图片变形 该方法仅支持 DALL·E 2 model
default String	moderations(String text) 检查文本是否具有潜在的危害性 仅支持omni-moderation-latest和text-moderation-latest模型
String	moderations(String text, String imgUrl) 检查文本或图像是否具有潜在的危害性 仅支持omni-moderation-latest和text-moderation-latest模型
String	speechToText(File file) STT音频转文本 请设置config中model为支持STT功能的模型 whisper
default InputStream	textToSpeech(String input) TTS文本转语音 请设置config中model为支持TTS功能的模型 TTS系列
InputStream	textToSpeech(String input, OpenaiCommon.OpenaiSpeech voice) TTS文本转语音 请设置config中model为支持TTS功能的模型 TTS系列

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

imagesGenerations

String imagesGenerations(String prompt)

文生图 请设置config中model为支持图片功能的模型 DALL·E系列

Parameters:

prompt - 题词

Returns:

包含生成图片的url

Since:

5.8.38

imagesEdits

String imagesEdits(String prompt,
                   File image,
                   File mask)

图片编辑 该方法仅支持 DALL·E 2 model

Parameters:

prompt - 题词

image - 需要编辑的图像必须是 PNG 格式

mask - 如果提供，则是一个与编辑图像大小相同的遮罩图像应该是灰度图，白色表示需要编辑的区域，黑色表示不需要编辑的区域。

Returns:

包含生成图片的url

Since:

5.8.38

imagesEdits

default String imagesEdits(String prompt,
                           File image)

图片编辑 该方法仅支持 DALL·E 2 model

Parameters:

prompt - 题词

image - 需要编辑的图像必须是 PNG 格式

Returns:

包含生成图片的url

Since:

5.8.38

imagesVariations

String imagesVariations(File image)

图片变形 该方法仅支持 DALL·E 2 model

Parameters:

image - 需要变形的图像必须是 PNG 格式

Returns:

包含生成图片的url

Since:

5.8.38

textToSpeech

InputStream textToSpeech(String input,
                         OpenaiCommon.OpenaiSpeech voice)

TTS文本转语音 请设置config中model为支持TTS功能的模型 TTS系列

Parameters:

input - 需要转成语音的文本

voice - AI的音色

Returns:

返回的音频mp3文件流

Since:

5.8.38

textToSpeech

default InputStream textToSpeech(String input)

TTS文本转语音 请设置config中model为支持TTS功能的模型 TTS系列

Parameters:

input - 需要转成语音的文本

Returns:

返回的音频mp3文件流

Since:

5.8.38

speechToText

String speechToText(File file)

STT音频转文本 请设置config中model为支持STT功能的模型 whisper

Parameters:

file - 需要转成文本的音频文件

Returns:

返回的文本内容

Since:

5.8.38

embeddingText

String embeddingText(String input)

文本向量化 请设置config中model为支持文本向量化功能的模型 text-embedding系列

Parameters:

input - 需要向量化的内容

Returns:

处理后的向量信息

Since:

5.8.38

moderations

String moderations(String text,
                   String imgUrl)

检查文本或图像是否具有潜在的危害性 仅支持omni-moderation-latest和text-moderation-latest模型

Parameters:

text - 需要检查的文本

imgUrl - 需要检查的图片地址

Returns:

AI返回结果

Since:

5.8.38

moderations

default String moderations(String text)

检查文本是否具有潜在的危害性 仅支持omni-moderation-latest和text-moderation-latest模型

Parameters:

text - 需要检查的文本

Returns:

AI返回结果

Since:

5.8.38

chatReasoning

String chatReasoning(String prompt,
                     String reasoningEffort)

推理chat 支持o3-mini和o1

Parameters:

prompt - 对话题词

reasoningEffort - 推理程度

Returns:

AI回答

Since:

5.8.38

chatReasoning

default String chatReasoning(String prompt)

推理chat 支持o3-mini和o1

Parameters:

prompt - 对话题词

Returns:

AI回答

Since:

5.8.38

chatReasoning

String chatReasoning(List<Message> messages,
                     String reasoningEffort)

推理chat 支持o3-mini和o1

Parameters:

messages - 消息列表

reasoningEffort - 推理程度

Returns:

AI回答

Since:

5.8.38

chatReasoning

default String chatReasoning(List<Message> messages)

推理chat 支持o3-mini和o1

Parameters:

messages - 消息列表

Returns:

AI回答

Since:

5.8.38