Package org.springframework.ai.image.observation

Enum Class ImageModelObservationDocumentation.HighCardinalityKeyNames

java.lang.Object

java.lang.Enum<ImageModelObservationDocumentation.HighCardinalityKeyNames>

org.springframework.ai.image.observation.ImageModelObservationDocumentation.HighCardinalityKeyNames

All Implemented Interfaces:

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

Enclosing class:

ImageModelObservationDocumentation

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

High-cardinality observation key names for image model 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
PROMPT	The full prompt sent to the model.
REQUEST_IMAGE_RESPONSE_FORMAT	The format in which the generated image is returned.
REQUEST_IMAGE_SIZE	The size of the image to generate.
REQUEST_IMAGE_STYLE	The style of the image to generate.
RESPONSE_ID	The unique identifier for the AI response.
RESPONSE_MODEL	The name of the model that generated the response.
USAGE_INPUT_TOKENS	The number of tokens used in the model input (prompt).
USAGE_OUTPUT_TOKENS	The number of tokens used in the model output (generation).
USAGE_TOTAL_TOKENS	The total number of tokens used in the model exchange.

Method Summary

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

REQUEST_IMAGE_RESPONSE_FORMAT

public static final ImageModelObservationDocumentation.HighCardinalityKeyNames REQUEST_IMAGE_RESPONSE_FORMAT

The format in which the generated image is returned.

REQUEST_IMAGE_SIZE

public static final ImageModelObservationDocumentation.HighCardinalityKeyNames REQUEST_IMAGE_SIZE

The size of the image to generate.

REQUEST_IMAGE_STYLE

public static final ImageModelObservationDocumentation.HighCardinalityKeyNames REQUEST_IMAGE_STYLE

The style of the image to generate.

RESPONSE_ID

public static final ImageModelObservationDocumentation.HighCardinalityKeyNames RESPONSE_ID

The unique identifier for the AI response.

RESPONSE_MODEL

public static final ImageModelObservationDocumentation.HighCardinalityKeyNames RESPONSE_MODEL

The name of the model that generated the response.

USAGE_INPUT_TOKENS

public static final ImageModelObservationDocumentation.HighCardinalityKeyNames USAGE_INPUT_TOKENS

The number of tokens used in the model input (prompt).

USAGE_OUTPUT_TOKENS

public static final ImageModelObservationDocumentation.HighCardinalityKeyNames USAGE_OUTPUT_TOKENS

The number of tokens used in the model output (generation).

USAGE_TOTAL_TOKENS

public static final ImageModelObservationDocumentation.HighCardinalityKeyNames USAGE_TOTAL_TOKENS

The total number of tokens used in the model exchange.

PROMPT

public static final ImageModelObservationDocumentation.HighCardinalityKeyNames PROMPT

The full prompt sent to the model.

Method Details

values

public static ImageModelObservationDocumentation.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 ImageModelObservationDocumentation.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