获取最新的快照版本，请使用 Spring AI 1.1.3！spring-doc.cadn.net.cn

OpenAI 转录

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

前提条件

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

自动配置

There has been a significant change in the Spring AI auto-configuration, starter modules' artifact names. Please refer to the 升级说明以获取更多信息。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 构建脚本文件中。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

属性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.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

属性 描述 默认

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

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

开源人工智能spring-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.options.modelspring-doc.cadn.net.cn

要使用的模型的 ID。目前仅提供 whisper-1（由我们的开源 Whisper V2 模型提供支持）。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

JSON（JavaScript Object Notation）spring-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。注意：segment时间戳不会增加额外延迟，但生成word时间戳会带来额外延迟。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为前缀的属性都可以在运行时覆盖。

运行时选项

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 构建脚本文件中。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);

示例代码