跳到主要内容

无标题 :: Spring AI 参考文档

OpenAI 转录​

前提条件​

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

自动配置​

Spring AI 为 OpenAI 转录客户端提供了 Spring Boot 自动配置。要启用它，请将以下依赖项添加到项目的 Maven pom.xml 文件中：

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

或添加到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter'
}
groovy
提示

请参考 依赖管理 部分，将 Spring AI BOM 添加到您的构建文件中。

转录属性​

连接属性​

前缀 spring.ai.openai 用作属性前缀，允许你连接到 OpenAI。

属性描述默认值
spring.ai.openai.base-url连接的 URLapi.openai.com
spring.ai.openai.api-keyAPI 密钥-
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连接的 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。目前只有 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()
    .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);
java

手动配置​

将 spring-ai-openai 依赖项添加到项目的 Maven pom.xml 文件中：

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

或者到你的 Gradle build.gradle 构建文件中。

dependencies {
    implementation 'org.springframework.ai:spring-ai-openai'
}
groovy

:::提示
请参考依赖管理部分，将 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);
java

示例代码​