OpenAI 文本转语音 (TTS)

介绍

音频 API 提供了一个基于 OpenAI 的 TTS（文本转语音）模型的语音端点，使用户能够

  • 叙述书面博客文章。

  • 生成多种语言的语音音频。

  • 使用流媒体提供实时音频输出。

前提条件

  1. 创建一个 OpenAI 帐户并获取 API 密钥。您可以在 OpenAI 注册页面 注册，并在 API 密钥页面 生成 API 密钥。

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

自动配置

Spring AI 为 OpenAI 文本转语音客户端提供 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件

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

或 Gradle build.gradle 构建文件

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

语音属性

连接属性

使用前缀spring.ai.openai作为属性前缀，允许您连接到 OpenAI。

属性

描述

默认值

spring.ai.openai.base-url

连接到的 URL

api.openai.com

spring.ai.openai.api-key

API 密钥

-

spring.ai.openai.organization-id

您可以选择指定用于 API 请求的组织。

-

spring.ai.openai.project-id

您可以选择指定用于 API 请求的项目。

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

配置属性

使用前缀spring.ai.openai.audio.speech作为属性前缀，允许您配置 OpenAI 文本转语音客户端。

属性 描述 默认值

spring.ai.openai.audio.speech.base-url

连接到的 URL

api.openai.com

spring.ai.openai.audio.speech.api-key

API 密钥

-

spring.ai.openai.audio.speech.organization-id

您可以选择指定用于 API 请求的组织。

-

spring.ai.openai.audio.speech.project-id

您可以选择指定用于 API 请求的项目。

-

spring.ai.openai.audio.speech.options.model

要使用的模型 ID。目前仅支持 tts-1。

tts-1

spring.ai.openai.audio.speech.options.voice

用于 TTS 输出的语音。可用选项包括：alloy、echo、fable、onyx、nova 和 shimmer。

alloy

spring.ai.openai.audio.speech.options.response-format

音频输出的格式。支持的格式包括 mp3、opus、aac、flac、wav 和 pcm。

mp3

spring.ai.openai.audio.speech.options.speed

语音合成的速度。可接受的范围是从 0.25（最慢）到 4.0（最快）。

1.0
您可以覆盖常用的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指定的选项，但您可以在运行时覆盖这些选项。

例如

OpenAiAudioSpeechOptions speechOptions = OpenAiAudioSpeechOptions.builder()
    .withModel("tts-1")
    .withVoice(OpenAiAudioApi.SpeechRequest.Voice.ALLOY)
    .withResponseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat.MP3)
    .withSpeed(1.0f)
    .build();

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

手动配置

将spring-ai-openai依赖项添加到项目的 Maven pom.xml 文件

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

或 Gradle build.gradle 构建文件

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

接下来，创建一个OpenAiAudioSpeechModel

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

var openAiAudioSpeechModel = new OpenAiAudioSpeechModel(this.openAiAudioApi);

var speechOptions = OpenAiAudioSpeechOptions.builder()
    .withResponseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat.MP3)
    .withSpeed(1.0f)
    .withModel(OpenAiAudioApi.TtsModel.TTS_1.value)
    .build();

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

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

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

流式实时音频

语音 API 支持使用分块传输编码进行实时音频流式传输。这意味着音频可以在生成完整文件并使其可访问之前播放。

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

var openAiAudioSpeechModel = new OpenAiAudioSpeechModel(this.openAiAudioApi);

OpenAiAudioSpeechOptions speechOptions = OpenAiAudioSpeechOptions.builder()
    .withVoice(OpenAiAudioApi.SpeechRequest.Voice.ALLOY)
    .withSpeed(1.0f)
    .withResponseFormat(OpenAiAudioApi.SpeechRequest.AudioResponseFormat.MP3)
    .withModel(OpenAiAudioApi.TtsModel.TTS_1.value)
    .build();

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

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

示例代码