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 preconfiguredTranscriptionHttpExecutorhttp client,
HttpExecutorContext,SdkAuthor leave it todefaults().
Further configuration happens on multiple bypassable stages, whatever is important for specific needs.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static HttpBuilder<AIModelStage>authenticate(HttpExecutorContext context)static HttpBuilder<AIModelStage>authenticate(SdkAuth auth)Authenticates against OpenAI API with an implementation ofSdkAuth.static HttpBuilder<AIModelStage>defaults()Authenticates against OpenAPI with the first success fromFromEnvironmentandFromJson
authentication methods.static PreSimplifiedStagesimply()Authenticates against OpenAPI with the first success fromFromEnvironmentandFromJson
authentication methods.static PreSimplifiedStagesimply(SdkAuth auth)Authenticates against OpenAI API with an implementation ofSdkAuthand preconfigures simpleWhisper10for prompting.static AIModelStagethroughHttp(TranscriptionHttpExecutor executor)
-
-
-
Method Detail
-
throughHttp
public static AIModelStage throughHttp(TranscriptionHttpExecutor executor)
- Parameters:
executor- ConfiguredTranscriptionHttpExecutorwith manually setHttpExecutorContext,OkHttpClientand/orObjectMapper.- Returns:
AIModelStageto configure the necessaryModelType
-
authenticate
public static HttpBuilder<AIModelStage> authenticate(HttpExecutorContext context)
Authenticates against OpenAI API with manually supplied
ApiCredentialsandHttpTimeouts. Mostly used if credentials
are fetched from external source.- Parameters:
context-HttpExecutorContext- Returns:
HttpBuilderso timeouts can be reconfigured and possiblyObjectMapperis supplied.
-
authenticate
public static HttpBuilder<AIModelStage> authenticate(SdkAuth auth)
Authenticates against OpenAI API with an implementation ofSdkAuth.- Parameters:
auth- of typeSdkAuth
Allows you to choose from one of the default authentication methods
Options:FromDeveloper,FromJson,FromEnvironment- Returns:
HttpBuilderso timeouts can be reconfigured and possiblyObjectMapperis supplied.
-
simply
public static PreSimplifiedStage simply(SdkAuth auth)
Authenticates against OpenAI API with an implementation ofSdkAuthand preconfigures simpleWhisper10for prompting.- Parameters:
auth- of typeSdkAuth
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 fromFromEnvironmentandFromJson
authentication methods. Preconfigures simpleWhisper10for prompting.- Returns:
PreSimplifiedStage
-
defaults
public static HttpBuilder<AIModelStage> defaults()
Authenticates against OpenAPI with the first success fromFromEnvironmentandFromJson
authentication methods. All other configurations can be manually customized- Returns:
HttpBuilderso timeouts can be reconfigured and possiblyObjectMapperis supplied.
-
-