OpenAI 转录
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 |
要连接的 URL |
|
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=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 |
|
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。可用模型: |
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 |
您可以覆盖通用的 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 测试提供了一些如何使用该库的通用示例。