Package com.azure.ai.openai.responses.models

Enum ResponsesToolType

java.lang.Object

java.lang.Enum<ResponsesToolType>

com.azure.ai.openai.responses.models.ResponsesToolType

All Implemented Interfaces:

Serializable, Comparable<ResponsesToolType>, java.lang.constant.Constable

public enum ResponsesToolType
extends Enum<ResponsesToolType>

Defines values for ResponsesToolType.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPUTER	Enum value computer_use_preview.
FILE_SEARCH	Enum value file_search.
FUNCTION	Enum value function.
WEB_SEARCH	Enum value web_search_preview.

Method Summary

Modifier and Type	Method	Description
static ResponsesToolType	fromString(String value)	Parses a serialized value to a ResponsesToolType instance.
String	toString()
static ResponsesToolType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ResponsesToolType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FUNCTION

public static final ResponsesToolType FUNCTION

Enum value function.

FILE_SEARCH

public static final ResponsesToolType FILE_SEARCH

Enum value file_search.

WEB_SEARCH

public static final ResponsesToolType WEB_SEARCH

Enum value web_search_preview.

COMPUTER

public static final ResponsesToolType COMPUTER

Enum value computer_use_preview.

Method Details

values

public static ResponsesToolType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResponsesToolType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static ResponsesToolType fromString(String value)

Parses a serialized value to a ResponsesToolType instance.

Parameters:

value - the serialized value to parse.

Returns:

the parsed ResponsesToolType object, or null if unable to parse.

toString

public String toString()

Overrides:

toString in class Enum<ResponsesToolType>