Spring AI 支持 OpenAI 的语音转文字模型。
前提条件
你需要创建一个 OpenAI API 密钥才能访问 ChatGPT 模型。在 OpenAI 注册页面创建账户,并在 API 密钥页面生成令牌。Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性,你需要将其设置为从 openai.com 获取的 API 密钥值。导出环境变量是设置该配置属性的一种方式:
自动配置
Spring AI 自动配置、启动器模块的工件名称发生了重大变化。有关详细信息,请参阅升级说明。
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 | 连接地址 | 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.transcription 为前缀的顶级属性进行配置。
启用:spring.ai.model.audio.transcription=openai(默认启用)
禁用:spring.ai.model.audio.transcription=none(或任何与 openai 不匹配的值)
进行此更改是为了支持多模型配置。
spring.ai.openai.audio.transcription 前缀用作属性前缀,可让你配置 OpenAI 语音转文字模型的重试机制。
| 属性 | 描述 | 默认值 |
|---|---|---|
| spring.ai.model.audio.transcription | 启用 OpenAI 音频语音转文字模型 | openai |
| spring.ai.openai.audio.transcription.base-url | 连接地址 | api.openai.com |
| spring.ai.openai.audio.transcription.api-key | API 密钥 | - |
| spring.ai.openai.audio.transcription.organization-id | 可选,指定 API 请求使用的组织 | - |
| spring.ai.openai.audio.transcription.project-id | 可选,指定 API 请求使用的项目 | - |
| spring.ai.openai.audio.transcription.options.model | 语音转文字使用的模型 ID,可用模型:gpt-4o-transcribe(基于 GPT-4o 的语音转文字)、gpt-4o-mini-transcribe(基于 GPT-4o mini 的语音转文字)、whisper-1(通用语音识别模型,默认值) | whisper-1 |
| spring.ai.openai.audio.transcription.options.response-format | 语音转文字输出格式,可选值:json、text、srt、verbose_json、vtt | json |
| spring.ai.openai.audio.transcription.options.prompt | 可选文本,用于引导模型风格或延续上一段音频,提示词需与音频语言匹配 | |
| spring.ai.openai.audio.transcription.options.language | 输入音频的语言,使用 ISO-639-1 格式可提升准确率和响应速度 | |
| spring.ai.openai.audio.transcription.options.temperature | 采样温度,取值 0-1。数值越高(如 0.8)输出越随机,数值越低(如 0.2)输出越聚焦确定。设为 0 时,模型会通过对数概率自动提升温度直至达到阈值 | 0 |
| spring.ai.openai.audio.transcription.options.timestamp_granularities | 语音转文字的时间戳粒度,需将 response_format 设置为 verbose_json 才可使用。支持 word(字词)、segment(段落)其中一个或两个。注意:段落时间戳无额外延迟,生成字词时间戳会产生额外延迟 | segment |
你可以覆盖通用的 spring.ai.openai.base-url、spring.ai.openai.api-key、spring.ai.openai.organization-id 和 spring.ai.openai.project-id 属性。如果设置了 spring.ai.openai.audio.transcription.base-url、spring.ai.openai.audio.transcription.api-key、spring.ai.openai.audio.transcription.organization-id 和 spring.ai.openai.audio.transcription.project-id 属性,它们将优先于通用属性生效。如果你希望为不同模型和不同模型端点使用不同的 OpenAI 账户,这一配置会非常实用。
所有以 spring.ai.openai.transcription.options 为前缀的属性都可以在运行时覆盖。
运行时选项
OpenAiAudioTranscriptionOptions 类提供了进行语音转文字时可使用的选项。启动时会使用由 spring.ai.openai.audio.transcription 指定的选项,但你可以在运行时覆盖这些配置。
示例:
OpenAiAudioApi.TranscriptResponseFormat responseFormat = OpenAiAudioApi.TranscriptResponseFormat.VTT;
OpenAiAudioTranscriptionOptions transcriptionOptions = OpenAiAudioTranscriptionOptions.builder()
.language("en")
.prompt("Ask not this, but ask that")
.temperature(0f)
.responseFormat(this.responseFormat)
.build();
AudioTranscriptionPrompt transcriptionRequest = new AudioTranscriptionPrompt(audioFile, this.transcriptionOptions);
AudioTranscriptionResponse response = openAiTranscriptionModel.call(this.transcriptionRequest);手动配置
将 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 添加到你的构建文件中。
接下来,创建 OpenAiAudioTranscriptionModel 实例:
var openAiAudioApi = new OpenAiAudioApi(System.getenv("OPENAI_API_KEY"));
var openAiAudioTranscriptionModel = new OpenAiAudioTranscriptionModel(this.openAiAudioApi);
var transcriptionOptions = OpenAiAudioTranscriptionOptions.builder()
.responseFormat(TranscriptResponseFormat.TEXT)
.temperature(0f)
.build();
var audioFile = new FileSystemResource("/path/to/your/resource/speech/jfk.flac");
AudioTranscriptionPrompt transcriptionRequest = new AudioTranscriptionPrompt(this.audioFile, this.transcriptionOptions);
AudioTranscriptionResponse response = openAiTranscriptionModel.call(this.transcriptionRequest);示例代码
OpenAiTranscriptionModelIT.java 测试类提供了一些使用该库的通用示例。