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

Class Transcription

java.lang.Object

bg.codexio.ai.openai.api.sdk.voice.transcription.Transcription

public final class Transcription
extends Object

Entrypoint for Transcription API.
The interaction starts by configuring the HTTP connection
either by providing a preconfigured TranscriptionHttpExecutor 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 PreSimplifiedStage	simply()	Authenticates against OpenAPI with the first success from FromEnvironment and FromJson authentication methods.
static PreSimplifiedStage	simply(SdkAuth auth)	Authenticates against OpenAI API with an implementation of SdkAuth and preconfigures simple Whisper10 for prompting.
static AIModelStage	throughHttp(TranscriptionHttpExecutor 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(TranscriptionHttpExecutor executor)

Parameters:

executor - Configured TranscriptionHttpExecutor 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 PreSimplifiedStage simply(SdkAuth auth)

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

Parameters:

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

Returns:

PreSimplifiedStage

simply

public static PreSimplifiedStage simply()

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

Returns:

PreSimplifiedStage

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.