Package org.springframework.ai.openai

Class OpenAiAudioTranscriptionClient

java.lang.Object

org.springframework.ai.openai.OpenAiAudioTranscriptionClient

All Implemented Interfaces:

ModelClient<AudioTranscriptionPrompt,AudioTranscriptionResponse>

public class OpenAiAudioTranscriptionClient
extends Object
implements ModelClient<AudioTranscriptionPrompt,AudioTranscriptionResponse>

OpenAI audio transcription client implementation for backed by OpenAiAudioApi.

Since:

0.8.1

Author:

Michael Lavelle, Christian Tzolov

See Also:

• OpenAiAudioApi

Field Summary

Fields

Modifier and Type	Field	Description
final org.springframework.retry.support.RetryTemplate	retryTemplate

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AudioTranscriptionResponse	call(AudioTranscriptionPrompt request)	Executes a method call to the AI model.
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

Field Details

retryTemplate

public final org.springframework.retry.support.RetryTemplate retryTemplate

Constructor Details

OpenAiAudioTranscriptionClient

public OpenAiAudioTranscriptionClient(OpenAiAudioApi audioApi)

OpenAiAudioTranscriptionClient 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.

OpenAiAudioTranscriptionClient

public OpenAiAudioTranscriptionClient(OpenAiAudioApi audioApi,
 OpenAiAudioTranscriptionOptions options)

OpenAiAudioTranscriptionClient 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.

OpenAiAudioTranscriptionClient

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

OpenAiAudioTranscriptionClient 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 request)

Description copied from interface: ModelClient

Executes a method call to the AI model.

Specified by:

call in interface ModelClient<AudioTranscriptionPrompt,AudioTranscriptionResponse>

Parameters:

request - the request object to be sent to the AI model

Returns:

the response from the AI model