OpenAI 转录

Spring AI 支持 OpenAI 的 Transcription 模型。spring-doc.cadn.net.cn

先决条件

您需要使用 OpenAI 创建 API 密钥才能访问 ChatGPT 模型。 在 OpenAI 注册页面创建一个帐户，并在 API 密钥页面上生成令牌。 Spring AI 项目定义了一个名为spring.ai.openai.api-key，您应该设置为API Key从 openai.com 获得。 导出环境变量是设置该配置属性的一种方法：spring-doc.cadn.net.cn

自动配置

Spring AI 为 OpenAI Transcription Client 提供 Spring Boot 自动配置。 要启用它，请将以下依赖项添加到项目的 Maven 中pom.xml文件：spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-openai-spring-boot-starter</artifactId>
</dependency>

或发送到您的 Gradlebuild.gradlebuild 文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

转录属性

连接属性

前缀spring.ai.openai用作允许您连接到 OpenAI 的属性前缀。spring-doc.cadn.net.cn

财产spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

违约spring-doc.cadn.net.cn

spring.ai.openai.base-urlspring-doc.cadn.net.cn

要连接到的 URLspring-doc.cadn.net.cn

api.openai.comspring-doc.cadn.net.cn

spring.ai.openai.api-keyspring-doc.cadn.net.cn

API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.organization-idspring-doc.cadn.net.cn

（可选）您可以指定用于 API 请求的组织。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.project-idspring-doc.cadn.net.cn

（可选）您可以指定用于 API 请求的项目。spring-doc.cadn.net.cn

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

配置属性

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

财产 描述 违约

spring.ai.openai.audio.transcription.base-urlspring-doc.cadn.net.cn

要连接到的 URLspring-doc.cadn.net.cn

api.openai.comspring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.api-keyspring-doc.cadn.net.cn

API 密钥spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.organization-idspring-doc.cadn.net.cn

（可选）您可以指定用于 API 请求的组织。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.project-idspring-doc.cadn.net.cn

（可选）您可以指定用于 API 请求的项目。spring-doc.cadn.net.cn

-spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.modelspring-doc.cadn.net.cn

要使用的模型的 ID。目前只有 whisper-1（由我们的开源 Whisper V2 模型提供支持）可用。spring-doc.cadn.net.cn

whisper-1 （耳语-1）spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.response-formatspring-doc.cadn.net.cn

脚本输出的格式，采用以下选项之一：json、text、srt、verbose_json 或 vtt。spring-doc.cadn.net.cn

JSON 格式spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.promptspring-doc.cadn.net.cn

一个可选文本，用于引导模型的样式或继续上一个音频片段。提示应与音频语言匹配。spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.languagespring-doc.cadn.net.cn

输入音频的语言。以 ISO-639-1 格式提供输入语言将提高准确性和延迟时间。spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.temperaturespring-doc.cadn.net.cn

采样温度，介于 0 和 1 之间。较高的值（如 0.8）将使输出更加随机，而较低的值（如 0.2）将使其更加集中和确定。如果设置为 0，则模型将使用对数概率自动增加温度，直到达到某些阈值。spring-doc.cadn.net.cn

0spring-doc.cadn.net.cn

spring.ai.openai.audio.transcription.options.timestamp_granularitiesspring-doc.cadn.net.cn

要为此转录填充的时间戳粒度。必须verbose_json response_format 设置为使用时间戳粒度。支持以下选项中的一个或两个：word 或 segment。注意：段时间戳没有额外的延迟，但生成单词时间戳会产生额外的延迟。spring-doc.cadn.net.cn

段spring-doc.cadn.net.cn
您可以覆盖常见的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如果设置了 properties，则优先于 common properties。 如果您想为不同的模型和不同的模型终端节点使用不同的 OpenAI 账户，这将非常有用。
所有前缀为spring.ai.openai.transcription.options可以在运行时覆盖。

运行时选项

这OpenAiAudioTranscriptionOptionsclass 提供进行转录时要使用的选项。 启动时，由spring.ai.openai.audio.transcription，但您可以在运行时覆盖这些 API。spring-doc.cadn.net.cn

例如：spring-doc.cadn.net.cn

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依赖项添加到项目的 Mavenpom.xml文件：spring-doc.cadn.net.cn

<dependency>
    <groupId>org.springframework.ai</groupId>
    <artifactId>spring-ai-openai</artifactId>
</dependency>

或发送到您的 Gradlebuild.gradlebuild 文件。spring-doc.cadn.net.cn

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}
请参阅 Dependency Management 部分，将 Spring AI BOM 添加到您的构建文件中。

接下来，创建一个OpenAiAudioTranscriptionModelspring-doc.cadn.net.cn

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);

示例代码