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

自动配置

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

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

或发送到您的 Gradlebuild.gradlebuild 文件：spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 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.openai.audio.speech用作属性前缀，用于配置 OpenAI Text-to-Speech 客户端。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。目前只有 tts-1 可用。spring-doc.cadn.net.cn

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

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

用于 TTS 输出的语音。可用选项包括：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

MP3 的spring-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如果设置了 properties，则优先于 common properties。 如果您想为不同的模型和不同的模型终端节点使用不同的 OpenAI 账户，这将非常有用。
所有前缀为spring.ai.openai.image.options可以在运行时覆盖。

运行时选项

这OpenAiAudioSpeechOptionsclass 提供在发出文本到语音转换请求时要使用的选项。 启动时，由spring.ai.openai.audio.speech，但您可以在运行时覆盖这些 API。spring-doc.cadn.net.cn

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

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依赖项添加到项目的 Mavenpom.xml文件：spring-doc.cadn.net.cn

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

或发送到您的 Gradlebuild.gradlebuild 文件：spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

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

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

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

示例代码