Package com.azure.ai.openai.models

Class ChatCompletionModality

java.lang.Object

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

com.azure.ai.openai.models.ChatCompletionModality

All Implemented Interfaces:

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

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

Values to specified the required modality for the model to use.

Field Summary

Fields

Modifier and Type	Field	Description
static final ChatCompletionModality	AUDIO	The model is to generate audio output.
static final ChatCompletionModality	TEXT	The model is to generate text output.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ChatCompletionModality	fromString(String name)	Creates or finds a ChatCompletionModality from its string representation.
static Collection<ChatCompletionModality>	values()	Gets known ChatCompletionModality 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

TEXT

public static final ChatCompletionModality TEXT

The model is to generate text output.

AUDIO

public static final ChatCompletionModality AUDIO

The model is to generate audio output.

Constructor Details

ChatCompletionModality

@Deprecated
public ChatCompletionModality()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ChatCompletionModality value.

Method Details

fromString

public static ChatCompletionModality fromString(String name)

Creates or finds a ChatCompletionModality from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ChatCompletionModality.

values

public static Collection<ChatCompletionModality> values()

Gets known ChatCompletionModality values.

Returns:

known ChatCompletionModality values.