ChatCompletionModality Class

Package:

com.azure.ai.openai.models

Maven Artifact:

com.azure:azure-ai-openai:1.0.0-beta.16

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.ai.openai.models.ChatCompletionModality

public final class ChatCompletionModality
extends ExpandableStringEnum<ChatCompletionModality>

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

Field Summary

Modifier and Type	Field and 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

Constructor	Description
ChatCompletionModality()	Deprecated Use the fromString(String name) factory method. Creates a new instance of ChatCompletionModality value.

Method Summary

Modifier and Type	Method and 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 ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

AUDIO

public static final ChatCompletionModality AUDIO

The model is to generate audio output.

TEXT

public static final ChatCompletionModality TEXT

The model is to generate text output.

Constructor Details

ChatCompletionModality

@Deprecated
public ChatCompletionModality()

Deprecated

Use the fromString(String name) 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.