Package org.springframework.ai.observation.conventions

Enum Class AiObservationMetricNames

java.lang.Object

java.lang.Enum<AiObservationMetricNames>

org.springframework.ai.observation.conventions.AiObservationMetricNames

All Implemented Interfaces:

Serializable, Comparable<AiObservationMetricNames>, Constable

public enum AiObservationMetricNames
extends Enum<AiObservationMetricNames>

Enumeration of metric names used in AI observations.

Based on OpenTelemetry's 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
OPERATION_DURATION	The duration of the AI operation.
TOKEN_USAGE	The number of AI operations.

Method Summary

Modifier and Type	Method	Description
String	value()	Return the value of the metric name.
static AiObservationMetricNames	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AiObservationMetricNames[]	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

OPERATION_DURATION

public static final AiObservationMetricNames OPERATION_DURATION

The duration of the AI operation.

TOKEN_USAGE

public static final AiObservationMetricNames TOKEN_USAGE

The number of AI operations.

Method Details

values

public static AiObservationMetricNames[] 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 AiObservationMetricNames 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 metric name.

Returns:

the value of the metric name