Enum Class OpenAiCompatibleHostedTool

java.lang.Object

java.lang.Enum<OpenAiCompatibleHostedTool>

uno.anahata.asi.openai.compatible.OpenAiCompatibleHostedTool

All Implemented Interfaces:

Serializable, Comparable<OpenAiCompatibleHostedTool>, Constable

public enum OpenAiCompatibleHostedTool
extends Enum<OpenAiCompatibleHostedTool>

Enumeration of native server-side tools provided by OpenAI via the Responses API.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CODE_INTERPRETER	Executes Python code in a sandboxed environment.
COMPUTER_USE	Interacts with a virtual computer environment.
IMAGE_GENERATION	Generates images using DALL-E.
WEB_SEARCH	Searches the web using OpenAI's native tool.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	description	The human-readable description.
private final String	id	The unique hosted tool identifier.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	OpenAiCompatibleHostedTool()

Method Summary

Modifier and Type	Method	Description
static OpenAiCompatibleHostedTool	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenAiCompatibleHostedTool[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

WEB_SEARCH

public static final OpenAiCompatibleHostedTool WEB_SEARCH

Searches the web using OpenAI's native tool.

CODE_INTERPRETER

public static final OpenAiCompatibleHostedTool CODE_INTERPRETER

Executes Python code in a sandboxed environment.

COMPUTER_USE

public static final OpenAiCompatibleHostedTool COMPUTER_USE

Interacts with a virtual computer environment.

IMAGE_GENERATION

public static final OpenAiCompatibleHostedTool IMAGE_GENERATION

Generates images using DALL-E.

Field Details

id

private final String id

The unique hosted tool identifier.

description

private final String description

The human-readable description.

Constructor Details

OpenAiCompatibleHostedTool

private OpenAiCompatibleHostedTool()

Method Details

values

public static OpenAiCompatibleHostedTool[] values()

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

Returns:

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

valueOf

public static OpenAiCompatibleHostedTool valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null