Package org.springframework.ai.observation.conventions

Enum Class AiOperationType

java.lang.Object

java.lang.Enum<AiOperationType>

org.springframework.ai.observation.conventions.AiOperationType

All Implemented Interfaces:

Serializable, Comparable<AiOperationType>, Constable

public enum AiOperationType
extends Enum<AiOperationType>

Types of operations performed by AI systems. Inspired by the OpenTelemetry Semantic Conventions for Generative AI.

Since:

1.0.0

Author:

Thomas Vitale

See Also:

• OpenTelemetry Semantic Conventions for Generative AI.

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
CHAT	AI operation type for chat completion.
EMBEDDING	AI operation type for embedding.
EXECUTE_TOOL	AI operation type for tool execution.
FRAMEWORK	AI operation type for framework.
IMAGE	AI operation type for image.
TEXT_COMPLETION	AI operation type for text completion.

Method Summary

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

CHAT

public static final AiOperationType CHAT

AI operation type for chat completion.

EMBEDDING

public static final AiOperationType EMBEDDING

AI operation type for embedding.

EXECUTE_TOOL

public static final AiOperationType EXECUTE_TOOL

AI operation type for tool execution.

FRAMEWORK

public static final AiOperationType FRAMEWORK

AI operation type for framework.

IMAGE

public static final AiOperationType IMAGE

AI operation type for image.

TEXT_COMPLETION

public static final AiOperationType TEXT_COMPLETION

AI operation type for text completion.

Method Details

values

public static AiOperationType[] 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 AiOperationType 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 operation type.

Returns:

the value of the operation type