Skip to content

feature: Add common TranscriptionModel interface for audio transcription #1484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -29,8 +29,8 @@
import org.springframework.ai.azure.openai.AzureOpenAiAudioTranscriptionOptions.StructuredResponse.Word;
import org.springframework.ai.azure.openai.AzureOpenAiAudioTranscriptionOptions.TranscriptResponseFormat;
import org.springframework.ai.azure.openai.metadata.AzureOpenAiAudioTranscriptionResponseMetadata;
import org.springframework.ai.model.Model;
import org.springframework.ai.model.ModelOptionsUtils;
import org.springframework.ai.model.TranscriptionModel;
import org.springframework.core.io.Resource;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
@@ -45,7 +45,7 @@
*
* @author Piotr Olaszewski
*/
public class AzureOpenAiAudioTranscriptionModel implements Model<AudioTranscriptionPrompt, AudioTranscriptionResponse> {
public class AzureOpenAiAudioTranscriptionModel implements TranscriptionModel {

private static final List<AudioTranscriptionFormat> JSON_FORMATS = List.of(AudioTranscriptionFormat.JSON,
AudioTranscriptionFormat.VERBOSE_JSON);
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@
import org.slf4j.LoggerFactory;

import org.springframework.ai.chat.metadata.RateLimit;
import org.springframework.ai.model.Model;
import org.springframework.ai.model.TranscriptionModel;
import org.springframework.ai.openai.api.OpenAiAudioApi;
import org.springframework.ai.openai.api.OpenAiAudioApi.StructuredResponse;
import org.springframework.ai.audio.transcription.AudioTranscription;
@@ -60,7 +60,7 @@
* @see OpenAiAudioApi
* @since 0.8.1
*/
public class OpenAiAudioTranscriptionModel implements Model<AudioTranscriptionPrompt, AudioTranscriptionResponse> {
public class OpenAiAudioTranscriptionModel implements TranscriptionModel {

private final Logger logger = LoggerFactory.getLogger(getClass());

Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package org.springframework.ai.model;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this interface be in the package org.springframework.ai.model.audio.transcription?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, it should.

Model interfaces should be placed in packages that reflect their functional domain:

  • For single-level domains:
    org.springframework.ai.<domain>

  • For hierarchical domains:
    org.springframework.ai.<category>.<subdomain>

Model Interface Package Location
EmbeddingModel org.springframework.ai.embedding
ModerationModel org.springframework.ai.moderation
TextToSpeechModel org.springframework.ai.audio.tts


import org.springframework.ai.audio.transcription.AudioTranscriptionOptions;
import org.springframework.ai.audio.transcription.AudioTranscriptionPrompt;
import org.springframework.ai.audio.transcription.AudioTranscriptionResponse;
import org.springframework.core.io.Resource;

public interface TranscriptionModel extends Model<AudioTranscriptionPrompt, AudioTranscriptionResponse> {

AudioTranscriptionResponse call(AudioTranscriptionPrompt transcriptionPrompt);

default String transcribe(Resource resource) {
AudioTranscriptionPrompt prompt = new AudioTranscriptionPrompt(resource);
return this.call(prompt).getResult().getOutput();
}

default String transcribe(Resource resource, AudioTranscriptionOptions options) {
AudioTranscriptionPrompt prompt = new AudioTranscriptionPrompt(resource, options);
return this.call(prompt).getResult().getOutput();
}

}