OpenAI

OpenAI Transcriptions

Spring AI 支持 OpenAI 的转录模型。

先决条件

您需要使用 OpenAI 创建 API密钥 来访问 ChatGPT 模型。

在OpenAI 注册页面 创建帐户 并在API 密钥页面生成令牌。 Spring AI 项目定义了一个名为的配置属性，您应该将其设置为从 openai.com 获取的spring.ai.openai.api-key值。

导出环境变量是设置该配置属性的一种方法：

export SPRING_AI_OPENAI_API_KEY=<INSERT KEY HERE>

自动配置

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.openai.audio.transcription 前缀的属性，可让您配置 OpenAI 的 OpenAiAudioTranscriptionClient 实现。

运行时选项

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(responseFormat)
    .build();
AudioTranscriptionPrompt transcriptionRequest = new AudioTranscriptionPrompt(audioFile, transcriptionOptions);
AudioTranscriptionResponse response = openAiTranscriptionClient.call(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'
}

接下来，创建一个 OpenAiAudioTranscriptionClient 实例：

var openAiAudioApi = new OpenAiAudioApi(System.getenv("OPENAI_API_KEY"));

var openAiAudioTranscriptionClient = new OpenAiAudioTranscriptionClient(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(audioFile, transcriptionOptions);
AudioTranscriptionResponse response = openAiTranscriptionClient.call(transcriptionRequest);

示例代码

OpenAiTranscriptionClientIT.java 测试提供了一些如何使用该库的常规示例。