Package org.springframework.ai.observation.conventions

Enum Class AiTokenType

java.lang.Object

java.lang.Enum<AiTokenType>

org.springframework.ai.observation.conventions.AiTokenType

All Implemented Interfaces:

Serializable, Comparable<AiTokenType>, Constable

public enum AiTokenType
extends Enum<AiTokenType>

Types of tokens produced and consumed in an AI operation. Based on the OpenTelemetry Semantic Conventions for AI Systems.

Since:

1.0.0

Author:

Thomas Vitale

See Also:

• OTel Semantic Conventions.

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
INPUT	Input token.
OUTPUT	Output token.
TOTAL	Total token.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INPUT

public static final AiTokenType INPUT

Input token.

OUTPUT

public static final AiTokenType OUTPUT

Output token.

TOTAL

public static final AiTokenType TOTAL

Total token.

Method Details

values

public static AiTokenType[] 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 AiTokenType 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

value

public String value()

Return the value of the token type.

Returns:

the value of the token type