跳到主要内容

未命名 :: Spring AI 参考文档

OpenAI 转录​

Spring AI 支持 OpenAI 的转录模型。

先决条件​

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

自动配置​

备注

Spring AI 的自动配置和启动模块的工件名称发生了重大变化。请参阅升级说明以获取更多信息。

Spring AI 为 OpenAI Transcription Client 提供了 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连接的 URLapi.openai.com
spring.ai.openai.api-keyAPI Key-
spring.ai.openai.organization-id可选，可指定用于 API 请求的组织 ID-
spring.ai.openai.project-id可选，可指定用于 API 请求的项目 ID-
提示

对于属于多个组织的用户（或通过其旧版用户 API 密钥访问项目），您可以选择指定哪个组织和项目用于 API 请求。这些 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连接的 URLapi.openai.com
spring.ai.openai.audio.transcription.api-keyAPI 密钥-
spring.ai.openai.audio.transcription.organization-id可选，可以指定用于 API 请求的组织。-
spring.ai.openai.audio.transcription.project-id可选，可以指定用于 API 请求的项目。-
spring.ai.openai.audio.transcription.options.model用于转录的模型 ID。可用模型：gpt-4o-transcribe（由 GPT-4o 驱动的语音转文本），gpt-4o-mini-transcribe（由 GPT-4o mini 驱动的语音转文本），或 whisper-1（通用语音识别模型，默认）。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);

示例代码​