cn.hutool.ai.model.openai

Class OpenaiServiceImpl

java.lang.Object

cn.hutool.ai.core.BaseAIService

cn.hutool.ai.model.openai.OpenaiServiceImpl

All Implemented Interfaces:

AIService, OpenaiService

public class OpenaiServiceImpl
extends BaseAIService
implements OpenaiService

openai服务，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
OpenaiServiceImpl(AIConfig config)

Method Summary

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

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

sendFormData, sendGet, sendPost

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.openai.OpenaiService

chatReasoning, chatReasoning, chatVision, imagesEdits, moderations, textToSpeech

Constructor Detail

OpenaiServiceImpl

public OpenaiServiceImpl(AIConfig config)

Method Detail

chat

public String chat(String prompt)

Description copied from interface: AIService

对话

Specified by:

chat in interface AIService

Parameters:

prompt - user题词

Returns:

AI回答

chat

public String chat(List<Message> messages)

Description copied from interface: AIService

对话

Specified by:

chat in interface AIService

Parameters:

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

Returns:

AI回答

chatVision

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

Description copied from interface: OpenaiService

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

Specified by:

chatVision in interface OpenaiService

Parameters:

prompt - 题词

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

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

Returns:

AI回答

imagesGenerations

public String imagesGenerations(String prompt)

Description copied from interface: OpenaiService

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

Specified by:

imagesGenerations in interface OpenaiService

Parameters:

prompt - 题词

Returns:

包含生成图片的url

imagesEdits

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

Description copied from interface: OpenaiService

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

Specified by:

imagesEdits in interface OpenaiService

Parameters:

prompt - 题词

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

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

Returns:

包含生成图片的url

imagesVariations

public String imagesVariations(File image)

Description copied from interface: OpenaiService

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

Specified by:

imagesVariations in interface OpenaiService

Parameters:

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

Returns:

包含生成图片的url

textToSpeech

public InputStream textToSpeech(String input,
                                OpenaiCommon.OpenaiSpeech voice)

Description copied from interface: OpenaiService

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

Specified by:

textToSpeech in interface OpenaiService

Parameters:

input - 需要转成语音的文本

voice - AI的音色

Returns:

返回的音频mp3文件流

speechToText

public String speechToText(File file)

Description copied from interface: OpenaiService

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

Specified by:

speechToText in interface OpenaiService

Parameters:

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

Returns:

返回的文本内容

embeddingText

public String embeddingText(String input)

Description copied from interface: OpenaiService

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

Specified by:

embeddingText in interface OpenaiService

Parameters:

input - 需要向量化的内容

Returns:

处理后的向量信息

moderations

public String moderations(String text,
                          String imgUrl)

Description copied from interface: OpenaiService

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

Specified by:

moderations in interface OpenaiService

Parameters:

text - 需要检查的文本

imgUrl - 需要检查的图片地址

Returns:

AI返回结果

chatReasoning

public String chatReasoning(String prompt,
                            String reasoningEffort)

Description copied from interface: OpenaiService

推理chat 支持o3-mini和o1

Specified by:

chatReasoning in interface OpenaiService

Parameters:

prompt - 对话题词

reasoningEffort - 推理程度

Returns:

AI回答

chatReasoning

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

Description copied from interface: OpenaiService

推理chat 支持o3-mini和o1

Specified by:

chatReasoning in interface OpenaiService

Parameters:

messages - 消息列表

reasoningEffort - 推理程度

Returns:

AI回答