获取最新的快照版本，请使用 Spring AI 1.1.3！spring-doc.cadn.net.cn

OpenAI 文本转语音（TTS）

简介

音频API提供了基于OpenAI的TTS（文本转语音）模型的语音端点，使用户能够：spring-doc.cadn.net.cn

前提条件

  1. 创建一个OpenAI账户并获取API密钥。您可以在OpenAI注册页面上注册，并在API密钥页面上生成API密钥。spring-doc.cadn.net.cn

  2. 将 spring-ai-openai 依赖项添加到项目的构建文件中。更多信息，请参阅依赖管理部分。spring-doc.cadn.net.cn

自动配置

There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。spring-doc.cadn.net.cn

Spring AI 为 OpenAI 文本转语音客户端提供了 Spring Boot 自动配置功能。要启用此功能，请在项目的 Maven pom.xml 文件中添加以下依赖项：spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-starter-model-openai</artifactId>
</dependency>

或者添加到你的 Gradle build.gradle 构建文件中：spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}
参考以下依赖管理部分，添加Spring AI BOM到你的构建文件中。

语音属性

连接属性

前缀 spring.ai.openai 用于作为属性前缀，以便您连接到OpenAI。spring-doc.cadn.net.cn

属性spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

默认spring-doc.cadn.net.cn

spring.ai.openai.base-urlspring-doc.cadn.net.cn

要连接的URLspring-doc.cadn.net.cn

api.openai.comspring-doc.cadn.net.cn

spring.ai.openai.api-keyspring-doc.cadn.net.cn

API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.organization-idspring-doc.cadn.net.cn

您可以选择性地指定用于API请求的组织。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.project-idspring-doc.cadn.net.cn

您可以选择性地指定用于API请求的项目。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn
对于属于多个组织（或通过其旧版用户API密钥访问项目）的用户，可选地，您可以指定用于API请求的组织和项目。 来自这些API请求的使用将计为指定组织和项目的使用量。

配置属性

音频语音自动配置的启用和禁用现在通过带有前缀spring.ai.model.audio.speech的顶级属性进行配置。spring-doc.cadn.net.cn

要启用，请设置 spring.ai.model.audio.speech=openai （默认情况下已启用）spring-doc.cadn.net.cn

要禁用，请设置 spring.ai.model.audio.speech=none（或任何不匹配openai的值）spring-doc.cadn.net.cn

这种修改是为了允许配置多个模型。spring-doc.cadn.net.cn

前缀 spring.ai.openai.audio.speech 用于作为属性前缀，以便您配置OpenAI文本转语音客户端。spring-doc.cadn.net.cn

属性 描述 默认

spring.ai.model.audio.speechspring-doc.cadn.net.cn

启用音频语音模型spring-doc.cadn.net.cn

开源人工智能spring-doc.cadn.net.cn

spring.ai.openai.audio.speech.base-urlspring-doc.cadn.net.cn

要连接的URLspring-doc.cadn.net.cn

api.openai.comspring-doc.cadn.net.cn

spring.ai.openai.audio.speech.api-keyspring-doc.cadn.net.cn

API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.audio.speech.organization-idspring-doc.cadn.net.cn

您可以选择性地指定用于API请求的组织。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.audio.speech.project-idspring-doc.cadn.net.cn

您可以选择性地指定用于API请求的项目。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.audio.speech.options.modelspring-doc.cadn.net.cn

用于生成音频的模型 ID。对于 OpenAI 的 TTS API，使用可用的模型之一：tts-1 或 tts-1-hd。spring-doc.cadn.net.cn

tts-1spring-doc.cadn.net.cn

spring.ai.openai.audio.speech.options.voicespring-doc.cadn.net.cn

用于合成的声音。对于OpenAI的TTS API，所选模型可用的声音之一：alloy、echo、fable、onyx、nova和shimmer。spring-doc.cadn.net.cn

合金spring-doc.cadn.net.cn

spring.ai.openai.audio.speech.options.response-formatspring-doc.cadn.net.cn

音频输出的格式。支持的格式有：mp3、opus、aac、flac、wav和pcm。spring-doc.cadn.net.cn

mp3spring-doc.cadn.net.cn

spring.ai.openai.audio.speech.options.speedspring-doc.cadn.net.cn

语音合成的速度。可接受的范围是从0.25（最慢）到4.0（最快）。spring-doc.cadn.net.cn

1.0spring-doc.cadn.net.cn
您可以覆盖常用的spring.ai.openai.base-url、spring.ai.openai.api-key、spring.ai.openai.organization-id和spring.ai.openai.project-id属性。 如果设置了spring.ai.openai.audio.speech.base-url、spring.ai.openai.audio.speech.api-key、spring.ai.openai.audio.speech.organization-id和spring.ai.openai.audio.speech.project-id属性，它们将优先于常用属性。 这对于希望为不同模型和不同的模型端点使用不同的OpenAI账户非常有用。
所有以spring.ai.openai.image.options为前缀的属性都可以在运行时覆盖。

运行时选项

OpenAiAudioSpeechOptions 类提供了在进行文本转语音请求时使用的选项。 启动时，使用由 spring.ai.openai.audio.speech 指定的选项，但您可以在运行时覆盖这些选项。spring-doc.cadn.net.cn

例如：spring-doc.cadn.net.cn

OpenAiAudioSpeechOptions speechOptions = OpenAiAudioSpeechOptions.builder()
    .model("tts-1")
    .voice(OpenAiAudioApi.SpeechRequest.Voice.ALLOY)
    .responseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat.MP3)
    .speed(1.0f)
    .build();

SpeechPrompt speechPrompt = new SpeechPrompt("Hello, this is a text-to-speech example.", speechOptions);
SpeechResponse response = openAiAudioSpeechModel.call(speechPrompt);

手动配置

将 spring-ai-openai 依赖添加到您项目的 Maven pom.xml 文件中：spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-openai</artifactId>
</dependency>

或者添加到你的 Gradle build.gradle 构建文件中：spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}
参考以下依赖管理部分，添加Spring AI BOM到你的构建文件中。

接下来，创建一个 OpenAiAudioSpeechModel:spring-doc.cadn.net.cn

var openAiAudioApi = new OpenAiAudioApi()
    .apiKey(System.getenv("OPENAI_API_KEY"))
    .build();

var openAiAudioSpeechModel = new OpenAiAudioSpeechModel(openAiAudioApi);

var speechOptions = OpenAiAudioSpeechOptions.builder()
    .responseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat.MP3)
    .speed(1.0f)
    .model(OpenAiAudioApi.TtsModel.TTS_1.value)
    .build();

var speechPrompt = new SpeechPrompt("Hello, this is a text-to-speech example.", speechOptions);
SpeechResponse response = openAiAudioSpeechModel.call(speechPrompt);

// Accessing metadata (rate limit info)
OpenAiAudioSpeechResponseMetadata metadata = response.getMetadata();

byte[] responseAsBytes = response.getResult().getOutput();

实时流音频

语音API提供了使用分块传输编码的实时音频流支持。这意味着在完整文件生成并可访问之前，音频就能够开始播放。spring-doc.cadn.net.cn

var openAiAudioApi = new OpenAiAudioApi()
    .apiKey(System.getenv("OPENAI_API_KEY"))
    .build();

var openAiAudioSpeechModel = new OpenAiAudioSpeechModel(openAiAudioApi);

OpenAiAudioSpeechOptions speechOptions = OpenAiAudioSpeechOptions.builder()
    .voice(OpenAiAudioApi.SpeechRequest.Voice.ALLOY)
    .speed(1.0f)
    .responseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat.MP3)
    .model(OpenAiAudioApi.TtsModel.TTS_1.value)
    .build();

SpeechPrompt speechPrompt = new SpeechPrompt("Today is a wonderful day to build something people love!", speechOptions);

Flux<SpeechResponse> responseStream = openAiAudioSpeechModel.stream(speechPrompt);

示例代码