Package org.springframework.ai.chat.observation

Enum Class ChatModelObservationDocumentation

java.lang.Object

java.lang.Enum<ChatModelObservationDocumentation>

org.springframework.ai.chat.observation.ChatModelObservationDocumentation

All Implemented Interfaces:

io.micrometer.observation.docs.ObservationDocumentation, Serializable, Comparable<ChatModelObservationDocumentation>, Constable

public enum ChatModelObservationDocumentation
extends Enum<ChatModelObservationDocumentation>
implements io.micrometer.observation.docs.ObservationDocumentation

Documented conventions for chat model observations.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChatModelObservationDocumentation.Events	Events for chat model operations.
static enum	ChatModelObservationDocumentation.HighCardinalityKeyNames	High-cardinality observation key names for chat model operations.
static enum	ChatModelObservationDocumentation.LowCardinalityKeyNames	Low-cardinality observation key names for chat model operations.

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHAT_MODEL_OPERATION

Field Summary

Fields inherited from interface io.micrometer.observation.docs.ObservationDocumentation

EMPTY, EMPTY_EVENT_NAMES

Method Summary

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

Methods inherited from interface io.micrometer.observation.docs.ObservationDocumentation

getContextualName, getDefaultConvention, getEvents, getHighCardinalityKeyNames, getLowCardinalityKeyNames, getName, getPrefix, observation, observation, observation, start, start, start

Enum Constant Details

CHAT_MODEL_OPERATION

public static final ChatModelObservationDocumentation CHAT_MODEL_OPERATION

Method Details

values

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