此版本仍在开发中，尚未被视为稳定版。如需最新的快照版本，请使用 Spring AI 1.1.3！spring-doc.cadn.net.cn

OpenAI 转录文本

Spring AI 支持 OpenAI 的转录模型。spring-doc.cadn.net.cn

前置条件

您需要创建一个 OpenAI API 密钥以访问 ChatGPT 模型。 请在 OpenAI 注册页面 创建账户，并在 API 密钥页面 生成Tokens。 Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性，您应将其设置为从 openai.com 获得的 API Key 的值。 导出环境变量是设置该配置属性的一种方法：spring-doc.cadn.net.cn

Auto-configuration

Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。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-starter-model-openai</artifactId>
</dependency>

请将以下内容添加到您的Gradle build.gradle 构建文件中。spring-doc.cadn.net.cn

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

转录属性

连接属性

使用前缀spring.ai.openai作为属性前缀，以便连接到OpenAI。spring-doc.cadn.net.cn

<property> </property>spring-doc.cadn.net.cn

<description> </description>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.model.audio.transcription 的顶层属性进行配置。spring-doc.cadn.net.cn

要启用，请设置 spring.ai.model.audio.transcription=openai（默认已启用）spring-doc.cadn.net.cn

要禁用此功能，请设置 spring.ai.model.audio.transcription=none（或任何不与 openai 匹配的值）spring-doc.cadn.net.cn

此更改是为了允许配置多个模型。spring-doc.cadn.net.cn

前缀 spring.ai.openai.audio.transcription 用作属性前缀，允许您配置 OpenAI 转录模型的重试机制。spring-doc.cadn.net.cn

<property> </property> <description> </description> 默认

spring.ai.model.audio.transcriptionspring-doc.cadn.net.cn

启用 OpenAI 音频转录模型spring-doc.cadn.net.cn

OpenAIspring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.base-urlspring-doc.cadn.net.cn

连接的URLspring-doc.cadn.net.cn

api.openai.comspring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.api-keyspring-doc.cadn.net.cn

API密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.organization-idspring-doc.cadn.net.cn

您可以选择指定用于 API 请求的组织。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.project-idspring-doc.cadn.net.cn

（可选）您可以指定用于 API 请求的项目。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.transcription-pathspring-doc.cadn.net.cn

音频转录的 API 端点路径。适用于具有不同端点结构的兼容 OpenAI 的 API。spring-doc.cadn.net.cn

/v1/audio/transcriptionsspring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.modelspring-doc.cadn.net.cn

用于转录的模型 ID。可用模型：gpt-4o-transcribe（由 GPT-4o 驱动的语音转文本）、gpt-4o-mini-transcribe（由 GPT-4o mini 驱动的语音转文本）或 whisper-1（通用语音识别模型，默认）。spring-doc.cadn.net.cn

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

spring.ai.openai.audio.transcription.options.response-formatspring-doc.cadn.net.cn

转录输出的格式，可选以下其中之一：json、text、srt、verbose_json 或 vtt。spring-doc.cadn.net.cn

JSONspring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.promptspring-doc.cadn.net.cn

一段可选文本，用于引导模型的风格或延续之前的音频片段。该提示语应与音频语言相匹配。spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.languagespring-doc.cadn.net.cn

输入音频的语言。以 ISO-639-1 格式提供输入语言将提高准确性和降低延迟。spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.temperaturespring-doc.cadn.net.cn

采样温度，范围在 0 到 1 之间。较高的值（如 0.8）会使输出更随机，而较低的值（如 0.2）会使输出更集中且确定性更强。如果设置为 0，模型将使用对数概率自动提高温度，直到达到特定阈值。spring-doc.cadn.net.cn

0spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.timestamp_granularitiesspring-doc.cadn.net.cn

为此转录填充的时间戳粒度。必须将 response_format 设置为 verbose_json 才能使用时间戳粒度。支持以下任一或两个选项：word（词级）或 segment（片段级）。注意：片段级时间戳不会产生额外延迟，但生成词级时间戳会产生额外延迟。spring-doc.cadn.net.cn

段spring-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.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 为前缀的属性都可以在运行时被覆盖。

自定义 API 路径

对于使用不同端点路径的 OpenAI 兼容 API（例如 LocalAI、具有 OpenAI 兼容性的 Ollama 或自定义代理），您可以配置转录路径：spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.transcription-path=/custom/path/to/transcriptions

这在以下情况下特别有用：spring-doc.cadn.net.cn

运行时选项

OpenAiAudioTranscriptionOptions 类提供了进行转录时使用的选项。 启动时，会使用由 spring.ai.openai.audio.transcription 指定的选项，但您可以在运行时覆盖这些选项。spring-doc.cadn.net.cn

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

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文件中：spring-doc.cadn.net.cn

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

请将以下内容添加到您的Gradle build.gradle 构建文件中。spring-doc.cadn.net.cn

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

接下来，创建一个 OpenAiAudioTranscriptionModelspring-doc.cadn.net.cn

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

示例代码