|
此版本仍在开发中,尚未被视为稳定版。如需最新的快照版本,请使用 Spring AI 1.1.3! |
OpenAI 转录文本
Spring AI 支持 OpenAI 的转录模型。
前置条件
您需要创建一个 OpenAI API 密钥以访问 ChatGPT 模型。
请在 OpenAI 注册页面 创建账户,并在 API 密钥页面 生成Tokens。
Spring AI 项目定义了一个名为 spring.ai.openai.api-key 的配置属性,您应将其设置为从 openai.com 获得的 API Key 的值。
导出环境变量是设置该配置属性的一种方法:
Auto-configuration
|
Spring AI自动配置和starter模块的artifact名称有了重大变化。 请参阅升级说明获取更多信息。 |
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。
<property> </property> |
<description> </description> |
默认 |
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 转录模型的重试机制。
| <property> </property> | <description> </description> | 默认 |
|---|---|---|
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(片段级)。注意:片段级时间戳不会产生额外延迟,但生成词级时间戳会产生额外延迟。 |
段 |
您可以覆盖通用的 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 测试提供了一些如何使用该库的通用示例。