Package org.springframework.ai.openai

Class OpenAiAudioTranscriptionModel

java.lang.Object

org.springframework.ai.openai.OpenAiAudioTranscriptionModel

All Implemented Interfaces:

TranscriptionModel, Model<AudioTranscriptionPrompt,AudioTranscriptionResponse>

public class OpenAiAudioTranscriptionModel
extends Object
implements TranscriptionModel

OpenAI audio transcription client implementation for backed by OpenAiAudioApi. You provide as input the audio file you want to transcribe and the desired output file format of the transcription of the audio.

Since:

0.8.1

Author:

Michael Lavelle, Christian Tzolov, Thomas Vitale

See Also:

• OpenAiAudioApi

Constructor Summary

Constructors

Constructor	Description
OpenAiAudioTranscriptionModel(OpenAiAudioApi audioApi)	OpenAiAudioTranscriptionModel is a client class used to interact with the OpenAI Audio Transcription API.
OpenAiAudioTranscriptionModel(OpenAiAudioApi audioApi, OpenAiAudioTranscriptionOptions options)	OpenAiAudioTranscriptionModel is a client class used to interact with the OpenAI Audio Transcription API.
OpenAiAudioTranscriptionModel(OpenAiAudioApi audioApi, OpenAiAudioTranscriptionOptions options, org.springframework.retry.support.RetryTemplate retryTemplate)	OpenAiAudioTranscriptionModel is a client class used to interact with the OpenAI Audio Transcription API.

Method Summary

Modifier and Type	Method	Description
AudioTranscriptionResponse	call(AudioTranscriptionPrompt transcriptionPrompt)	Transcribes the audio from the given prompt.
String	call(org.springframework.core.io.Resource audioResource)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ai.audio.transcription.TranscriptionModel

transcribe, transcribe

Constructor Details

OpenAiAudioTranscriptionModel

public OpenAiAudioTranscriptionModel(OpenAiAudioApi audioApi)

OpenAiAudioTranscriptionModel is a client class used to interact with the OpenAI Audio Transcription API.

Parameters:

audioApi - The OpenAiAudioApi instance to be used for making API calls.

OpenAiAudioTranscriptionModel

public OpenAiAudioTranscriptionModel(OpenAiAudioApi audioApi,
 OpenAiAudioTranscriptionOptions options)

OpenAiAudioTranscriptionModel is a client class used to interact with the OpenAI Audio Transcription API.

Parameters:

audioApi - The OpenAiAudioApi instance to be used for making API calls.

options - The OpenAiAudioTranscriptionOptions instance for configuring the audio transcription.

OpenAiAudioTranscriptionModel

public OpenAiAudioTranscriptionModel(OpenAiAudioApi audioApi,
 OpenAiAudioTranscriptionOptions options,
 org.springframework.retry.support.RetryTemplate retryTemplate)

OpenAiAudioTranscriptionModel is a client class used to interact with the OpenAI Audio Transcription API.

Parameters:

audioApi - The OpenAiAudioApi instance to be used for making API calls.

options - The OpenAiAudioTranscriptionOptions instance for configuring the audio transcription.

retryTemplate - The RetryTemplate instance for retrying failed API calls.

Method Details

call

public String call(org.springframework.core.io.Resource audioResource)

call

public AudioTranscriptionResponse call(AudioTranscriptionPrompt transcriptionPrompt)

Description copied from interface: TranscriptionModel

Transcribes the audio from the given prompt.

Specified by:

call in interface Model<AudioTranscriptionPrompt,AudioTranscriptionResponse>

Specified by:

call in interface TranscriptionModel

Parameters:

transcriptionPrompt - The prompt containing the audio resource and options.

Returns:

The transcription response.