Package com.azure.ai.agents.persistent.models

Class ResponseFormat

java.lang.Object

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

com.azure.ai.agents.persistent.models.ResponseFormat

All Implemented Interfaces:

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

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

Possible API response formats.

Field Summary

Fields

Modifier and Type	Field	Description
static final ResponseFormat	JSON_OBJECT	Using `json_object` format will limit the usage of ToolCall to only functions.
static final ResponseFormat	TEXT	`text` format should be used for requests involving any sort of ToolCall.

Constructor Summary

Constructors

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

Method Summary

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

`text` format should be used for requests involving any sort of ToolCall.

JSON_OBJECT

public static final ResponseFormat JSON_OBJECT

Using `json_object` format will limit the usage of ToolCall to only functions.

Constructor Details

ResponseFormat

@Deprecated
public ResponseFormat()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ResponseFormat value.

Method Details

fromString

public static ResponseFormat fromString(String name)

Creates or finds a ResponseFormat from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ResponseFormat.

values

public static Collection<ResponseFormat> values()

Gets known ResponseFormat values.

Returns:

known ResponseFormat values.