Class ChatCompletionResponseFormatType

java.lang.Object

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

com.azure.search.documents.indexes.models.ChatCompletionResponseFormatType

All Implemented Interfaces:

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

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

Specifies how the LLM should format the response. Possible values: 'text' (plain string), 'json_object' (arbitrary JSON), or 'json_schema' (adheres to provided schema).

Field Summary

Fields

Modifier and Type	Field	Description
static final ChatCompletionResponseFormatType	JSON_OBJECT	Static value jsonObject for ChatCompletionResponseFormatType.
static final ChatCompletionResponseFormatType	JSON_SCHEMA	Static value jsonSchema for ChatCompletionResponseFormatType.
static final ChatCompletionResponseFormatType	TEXT	Static value text for ChatCompletionResponseFormatType.

Constructor Summary

Constructors

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

Method Summary

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

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

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class Object

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

Field Details

TEXT

public static final ChatCompletionResponseFormatType TEXT

Static value text for ChatCompletionResponseFormatType.

JSON_OBJECT

public static final ChatCompletionResponseFormatType JSON_OBJECT

Static value jsonObject for ChatCompletionResponseFormatType.

JSON_SCHEMA

public static final ChatCompletionResponseFormatType JSON_SCHEMA

Static value jsonSchema for ChatCompletionResponseFormatType.

Constructor Details

ChatCompletionResponseFormatType

@Deprecated
public ChatCompletionResponseFormatType()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ChatCompletionResponseFormatType value.

Method Details

fromString

public static ChatCompletionResponseFormatType fromString(String name)

Creates or finds a ChatCompletionResponseFormatType from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ChatCompletionResponseFormatType.

values

public static Collection<ChatCompletionResponseFormatType> values()

Gets known ChatCompletionResponseFormatType values.

Returns:

known ChatCompletionResponseFormatType values.