Package io.github.stefanbratanov.jvm.openai

Class AudioClient

java.lang.Object

io.github.stefanbratanov.jvm.openai.AudioClient

public final class AudioClient
extends Object

Turn audio into text or text into audio.

Based on Audio

Field Summary

Fields

Modifier and Type	Field	Description
protected final HttpClient	httpClient
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Method Summary

Modifier and Type	Method	Description
void	createSpeech(SpeechRequest request, Path output)	Generates audio from the input text.
CompletableFuture<Void>	createSpeechAsync(SpeechRequest request, Path output)	Same as createSpeech(SpeechRequest,Path) but returns a response in a CompletableFuture
String	createTranscript(TranscriptionRequest request)	Transcribes audio into the input language.
CompletableFuture<String>	createTranscriptAsync(TranscriptionRequest request)	Same as createTranscript(TranscriptionRequest) but returns a response in a CompletableFuture
String	createTranslation(TranslationRequest request)	Translates audio into English.
CompletableFuture<String>	createTranslationAsync(TranslationRequest request)	Same as createTranslation(TranslationRequest) but returns a response in a CompletableFuture

Methods inherited from class java.lang.Object

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

Field Details

httpClient

protected final HttpClient httpClient

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

Method Details

createSpeech

public void createSpeech(SpeechRequest request,
 Path output)

Generates audio from the input text.

Parameters:

output - the file where to save the audio

Throws:

OpenAIException - in case of API errors

createSpeechAsync

public CompletableFuture<Void> createSpeechAsync(SpeechRequest request,
 Path output)

Same as createSpeech(SpeechRequest,Path) but returns a response in a CompletableFuture

createTranscript

public String createTranscript(TranscriptionRequest request)

Transcribes audio into the input language.

Throws:

OpenAIException - in case of API errors

createTranscriptAsync

public CompletableFuture<String> createTranscriptAsync(TranscriptionRequest request)

Same as createTranscript(TranscriptionRequest) but returns a response in a CompletableFuture

createTranslation

public String createTranslation(TranslationRequest request)

Translates audio into English.

Throws:

OpenAIException - in case of API errors

createTranslationAsync

public CompletableFuture<String> createTranslationAsync(TranslationRequest request)

Same as createTranslation(TranslationRequest) but returns a response in a CompletableFuture