Package com.sap.ai.sdk.foundationmodels.openai.realtime

Class RealtimeParamVoice

java.lang.Object

com.sap.ai.sdk.foundationmodels.openai.realtime.RealtimeParamVoice

All Implemented Interfaces:

RealtimeParam

@Beta
public final class RealtimeParamVoice
extends Object
implements RealtimeParam

Allows to configure model output voice.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.ai.sdk.foundationmodels.openai.realtime.RealtimeParam

RealtimeParam.ParamName

Field Summary

Fields

Modifier and Type	Field	Description
static final RealtimeParamVoice	DEFAULT_1	Standard voice 1.
static final RealtimeParamVoice	DEFAULT_2	Standard voice 2.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
RealtimeParam.ParamName	getParamName()	Returns param name.
String	getValueAsString()	Returns string value representation of the param.
int	hashCode()
static RealtimeParamVoice	withExplicitVoice(String voiceName)	Allows to configure raw voice name as named by model provider.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_1

@Beta
public static final RealtimeParamVoice DEFAULT_1

Standard voice 1.

DEFAULT_2

@Beta
public static final RealtimeParamVoice DEFAULT_2

Standard voice 2.

Method Details

withExplicitVoice

@Nonnull
@Beta
public static RealtimeParamVoice withExplicitVoice(@Nonnull
 String voiceName)

Allows to configure raw voice name as named by model provider. Unsafe because SDK cannot verify in advance if the provided voice name is correct and supported by the chosen model and use case NOTE: this method does not check voice name and incorrect input may produce runtime exceptions (unsafe).

Parameters:

voiceName - as named by model provider.

Returns:

typed voice client configuration param.

getParamName

@Beta
@Nonnull
public RealtimeParam.ParamName getParamName()

Description copied from interface: RealtimeParam

Returns param name.

Specified by:

getParamName in interface RealtimeParam

Returns:

name.

getValueAsString

@Beta
@Nonnull
public String getValueAsString()

Description copied from interface: RealtimeParam

Returns string value representation of the param.

Specified by:

getValueAsString in interface RealtimeParam

Returns:

string value.

equals

@Beta
public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

@Beta
public int hashCode()

Overrides:

hashCode in class Object