Package bg.codexio.ai.openai.api.sdk.voice.speech

Class Speech

java.lang.Object

bg.codexio.ai.openai.api.sdk.voice.speech.Speech

public final class Speech
extends Object

Entrypoint for Speech API.
The interaction starts by configuring the HTTP connection
either by providing a preconfigured SpeechHttpExecutor http client,
HttpExecutorContext, SdkAuth or leave it to defaults().
Further configuration happens on multiple bypassable stages, whatever is important for specific needs.

Method Summary

Modifier and Type	Method	Description
static HttpBuilder<AIModelStage>	authenticate(HttpExecutorContext context)	Authenticates against OpenAI API with manually supplied ApiCredentials and HttpTimeouts.
static HttpBuilder<AIModelStage>	authenticate(SdkAuth auth)	Authenticates against OpenAI API with an implementation of SdkAuth.
static HttpBuilder<AIModelStage>	defaults()	Authenticates against OpenAPI with the first success from FromEnvironment and FromJson authentication methods.
static SynchronousPromptStage	simply()	Authenticates against OpenAPI with the first success from FromEnvironment and FromJson authentication methods.
static SynchronousPromptStage	simply(SdkAuth auth)	Authenticates against OpenAI API with an implementation of SdkAuth and preconfigures simple TTS1HDModel for prompting.
static AIModelStage	throughHttp(SpeechHttpExecutor executor)

Methods inherited from class java.lang.Object

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

Method Details

throughHttp

public static AIModelStage throughHttp(SpeechHttpExecutor executor)

Parameters:

executor - Configured SpeechHttpExecutor with manually set HttpExecutorContext, OkHttpClient and/or ObjectMapper.

Returns:

AIModelStage to configure the necessary ModelType

authenticate

public static HttpBuilder<AIModelStage> authenticate(HttpExecutorContext context)

Authenticates against OpenAI API with manually supplied
ApiCredentials and HttpTimeouts. Mostly used if credentials
are fetched from external source.

Parameters:

context - HttpExecutorContext

Returns:

HttpBuilder<AIModelStage> so timeouts can be reconfigured and possibly ObjectMapper is supplied.

authenticate

public static HttpBuilder<AIModelStage> authenticate(SdkAuth auth)

Authenticates against OpenAI API with an implementation of SdkAuth.

Parameters:

auth - of type SdkAuth
Allows you to choose from one of the default authentication methods
Options: FromDeveloper, FromJson, FromEnvironment

Returns:

HttpBuilder<AIModelStage> so timeouts can be reconfigured and possibly ObjectMapper is supplied.

simply

public static SynchronousPromptStage simply(SdkAuth auth)

Authenticates against OpenAI API with an implementation of SdkAuth and
preconfigures simple TTS1HDModel for prompting.

Parameters:

auth - of type SdkAuth
Allows you to choose from one of the default authentication methods
Options: FromDeveloper, FromJson, FromEnvironment

Returns:

SynchronousPromptStage

simply

public static SynchronousPromptStage simply()

Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods. Preconfigures simple TTS1HDModel for prompting.

Returns:

SynchronousPromptStage

defaults

public static HttpBuilder<AIModelStage> defaults()

Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods. All other configurations can be manually customized

Returns:

HttpBuilder<AIModelStage> so timeouts can be reconfigured and possibly ObjectMapper is supplied.