Package com.alibaba.cloud.ai.tool.observation

Enum Class ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames

java.lang.Object

java.lang.Enum<ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames>

com.alibaba.cloud.ai.tool.observation.ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames

All Implemented Interfaces:

io.micrometer.common.docs.KeyName, Serializable, Comparable<ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames>, Constable

Enclosing class:

ArmsToolCallingObservationDocumentation

public static enum ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames
extends Enum<ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames>
implements io.micrometer.common.docs.KeyName

High-cardinality observation key names for execute tool operations.

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
GEN_AI_TOOL_CALL_ID	The identifier of the executed tool.
GEN_AI_TOOL_NAME	The name of the executed tool.
INPUT_VALUE	The extended input of the tool execution.
OUTPUT_VALUE	The full output of the tool execution.
TOOL_DESCRIPTION	The description of the executed tool.
TOOL_NAME	The name of the executed tool in ARMS semantic convention.
TOOL_PARAMETERS	The parameters of the executed tool.
TOOL_RETURN_DIRECT	Whether to return the result of the tool call directly.

Method Summary

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

asString, isRequired, withValue, withValue

Enum Constant Details

GEN_AI_TOOL_CALL_ID

public static final ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames GEN_AI_TOOL_CALL_ID

The identifier of the executed tool.

GEN_AI_TOOL_NAME

public static final ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames GEN_AI_TOOL_NAME

The name of the executed tool.

TOOL_NAME

public static final ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames TOOL_NAME

The name of the executed tool in ARMS semantic convention.

TOOL_DESCRIPTION

public static final ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames TOOL_DESCRIPTION

The description of the executed tool.

TOOL_RETURN_DIRECT

public static final ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames TOOL_RETURN_DIRECT

Whether to return the result of the tool call directly.

TOOL_PARAMETERS

public static final ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames TOOL_PARAMETERS

The parameters of the executed tool.

INPUT_VALUE

public static final ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames INPUT_VALUE

The extended input of the tool execution.

OUTPUT_VALUE

public static final ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames OUTPUT_VALUE

The full output of the tool execution.

Method Details

values

public static ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames[] 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 ArmsToolCallingObservationDocumentation.HighCardinalityKeyNames 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