OpenAI 转录
Spring AI 支持 OpenAI 的转录模型。
先决条件
你需要使用 OpenAI 创建一个 API 密钥来访问 ChatGPT 模型。在 OpenAI 注册页面 创建一个帐户,并在 API 密钥页面 生成令牌。Spring AI 项目定义了一个名为 spring.ai.openai.api-key
的配置属性,你应该将其设置为从 openai.com 获得的 API 密钥
的值。导出环境变量是一种设置该配置属性的方法
自动配置
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.audio.transcription
用作属性前缀,可用于配置 OpenAI 图像模型的重试机制。
属性 | 说明 | 默认值 |
---|---|---|
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 |
采样温度,介于 0 到 1 之间。0.8 等较高值会使输出更加随机,而 0.2 等较低值会使输出更加集中和确定。如果设置为 0,模型将使用对数概率自动增加温度,直到达到某些阈值。 |
0 |
spring.ai.openai.audio.transcription.options.timestamp_granularities |
为此转录填充的时间戳粒度。response_format 必须设置为 verbose_json 才能使用时间戳粒度。支持以下选项中的一个或两个:word 或 segment。注意:segment 时间戳没有额外的延迟,但生成 word 时间戳会产生额外的延迟。 |
segment |
运行时选项
OpenAiAudioTranscriptionOptions
类提供了在进行转录时使用的选项。在启动时,将使用 spring.ai.openai.audio.transcription
指定的选项,但你可以在运行时覆盖这些选项。
例如
OpenAiAudioApi.TranscriptResponseFormat responseFormat = OpenAiAudioApi.TranscriptResponseFormat.VTT;
OpenAiAudioTranscriptionOptions transcriptionOptions = OpenAiAudioTranscriptionOptions.builder()
.withLanguage("en")
.withPrompt("Ask not this, but ask that")
.withTemperature(0f)
.withResponseFormat(responseFormat)
.build();
AudioTranscriptionPrompt transcriptionRequest = new AudioTranscriptionPrompt(audioFile, transcriptionOptions);
AudioTranscriptionResponse response = openAiTranscriptionModel.call(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(openAiAudioApi);
var transcriptionOptions = OpenAiAudioTranscriptionOptions.builder()
.withResponseFormat(TranscriptResponseFormat.TEXT)
.withTemperature(0f)
.build();
var audioFile = new FileSystemResource("/path/to/your/resource/speech/jfk.flac");
AudioTranscriptionPrompt transcriptionRequest = new AudioTranscriptionPrompt(audioFile, transcriptionOptions);
AudioTranscriptionResponse response = openAiTranscriptionModel.call(transcriptionRequest);
示例代码
-
OpenAiTranscriptionModelIT.java 测试提供了一些如何使用该库的通用示例。