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用作属性前缀，允许您连接到 OpenAI。

属性

描述

默认值

spring.ai.openai.base-url

连接到的 URL

api.openai.com

spring.ai.openai.api-key

API 密钥

-

spring.ai.openai.organization-id

您可以选择指定用于 API 请求的组织。

-

spring.ai.openai.project-id

您可以选择指定用于 API 请求的项目。

-
对于属于多个组织的用户（或通过其旧版用户 API 密钥访问其项目的用户），您可以选择指定用于 API 请求的组织和项目。来自这些 API 请求的使用将计入指定组织和项目的用量。

配置属性

前缀spring.ai.openai.audio.transcription用作属性前缀，允许您配置 OpenAI 转录模型的重试机制。

属性 描述 默认值

spring.ai.openai.audio.transcription.base-url

连接到的 URL

api.openai.com

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（由我们的开源 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
您可以覆盖常见的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()
    .withLanguage("en")
    .withPrompt("Ask not this, but ask that")
    .withTemperature(0f)
    .withResponseFormat(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()
    .withResponseFormat(TranscriptResponseFormat.TEXT)
    .withTemperature(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);

示例代码