OpenAI 文本转语音 (TTS)

简介

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

  • 叙述一篇书面博客文章。

  • 生成多种语言的语音。

  • 使用流式传输提供实时音频输出。

先决条件

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

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

自动配置

Spring AI 自动配置、启动器模块的 artifact 名称发生了重大变化。 有关更多信息，请参阅 升级说明。

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

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

或添加到您的 Gradle build.gradle 构建文件中：

dependencies {
    implementation 'org.springframework.ai:spring-ai-starter-model-openai'
}

请参阅 依赖管理 部分，将 Spring AI BOM 添加到您的构建文件中。

语音属性

连接属性

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

属性

描述

默认值

spring.ai.openai.base-url

要连接的 URL

[role="bare"][role="bare"][role="bare"]https://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.model.audio.speech 的顶级属性进行配置。 要启用，spring.ai.model.audio.speech=openai（默认启用） 要禁用，spring.ai.model.audio.speech=none（或任何不匹配 openai 的值） 此更改是为了允许配置多个模型。

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

属性 描述 默认值

spring.ai.model.audio.speech

启用音频语音模型

openai

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

要连接的 URL

[role="bare"][role="bare"][role="bare"]https://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。对于 OpenAI 的 TTS API，请使用可用的模型之一：tts-1 或 tts-1-hd。

tts-1

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

用于合成的语音。对于 OpenAI 的 TTS API，所选模型可用的语音之一：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()
    .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 文件中：

<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()
    .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 支持使用分块传输编码进行实时音频流式传输。这意味着音频可以在完整文件生成并可访问之前播放。

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);

示例代码