Package com.azure.ai.openai.models

Class ServiceTierOptions

java.lang.Object

com.azure.core.util.ExpandableStringEnum<ServiceTierOptions>

com.azure.ai.openai.models.ServiceTierOptions

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class ServiceTierOptions
extends com.azure.core.util.ExpandableStringEnum<ServiceTierOptions>

Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service: - If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted. - If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guaranty. - If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guaranty. - When not set, the default behavior is 'auto'. When this parameter is set, the response body will include the `service_tier` utilized.

Field Summary

Fields

Modifier and Type	Field	Description
static final ServiceTierOptions	AUTO	Service tier option for auto.
static final ServiceTierOptions	DEFAULT	Service tier option for default.

Constructor Summary

Constructors

Constructor	Description
ServiceTierOptions()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static ServiceTierOptions	fromString(String name)	Creates or finds a ServiceTierOptions from its string representation.
static Collection<ServiceTierOptions>	values()	Get known ServiceTierOptions values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

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

Field Details

AUTO

public static final ServiceTierOptions AUTO

Service tier option for auto.

DEFAULT

public static final ServiceTierOptions DEFAULT

Service tier option for default.

Constructor Details

ServiceTierOptions

@Deprecated
public ServiceTierOptions()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ServiceTierOptions value.

Method Details

fromString

public static ServiceTierOptions fromString(String name)

Creates or finds a ServiceTierOptions from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ServiceTierOptions.

values

public static Collection<ServiceTierOptions> values()

Get known ServiceTierOptions values.

Returns:

a collection of known ServiceTierOptions values.