OpenAI 转录

本站(springdoc.cn)中的内容来源于 spring.io ，原始版权归属于 spring.io。由 springdoc.cn 进行翻译，整理。可供个人学习、研究，未经许可，不得进行任何转载、商用或与之相关的行为。 商标声明：Spring 是 Pivotal Software, Inc. 在美国以及其他国家的商标。

Spring AI 支持 OpenAI 的语音转录模型。

先决条件

你需要创建 OpenAI API Key 以访问 ChatGPT 模型。请先在 OpenAI 注册页面 创建账户，然后在 API Key 页面 生成 Token。Spring AI项目定义了 spring.ai.openai.api-key 配置属性，你需将其设置为从 openai.com 获取的 API Key。可通过环境变量设置此配置属性。

自动配置

Spring AI 的自动配置及 Starter 模块的构件名称发生重大变更。详情请参阅 升级说明。

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

要连接的 URL

api.openai.com

spring.ai.openai.api-key

API Key

-

spring.ai.openai.organization-id

指定 API 请求所使用的机构（组织）

-

spring.ai.openai.project-id

可以指定 API 请求使用哪个项目

-
对于属于多个组织的用户（或通过旧版用户 API Key 访问项目的用户），可选择性地指定 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

要连接的 URL

api.openai.com

spring.ai.openai.audio.transcription.api-key

API Key

-

spring.ai.openai.audio.transcription.organization-id

指定 API 请求所使用的机构/组织

-

spring.ai.openai.audio.transcription.project-id

指定 API 请求使用哪个项目

-

spring.ai.openai.audio.transcription.options.model

要使用的模型 ID。目前只有 whisper-1（由我们的开源 Whisper V2 模型驱动）可用。

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

采样温度（temperature），介于 0 和 1 之间。0.8 等较高值会使输出更加随机，而 0.2 等较低值则会使输出更加集中和确定。如果设置为 0，模型将使用对数概率自动提高温度，直到达到特定阈值。

0

spring.ai.openai.audio.transcription.options.timestamp_granularities

要使用时间戳粒度，response_format 必须设置为 verbose_json。支持以下任一或两个选项：word 或 segment。注意：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);

手动配置

在项目的 Maven pom.xml 文件中添加 spring-ai-openai 依赖：

<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 测试提供了一些使用该库的一般示例。