OpenAI 文字轉語音 (TTS)

簡介

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

串流即時音訊

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

範例程式碼