Package org.springframework.ai.embedding.observation

Class DefaultEmbeddingModelObservationConvention

java.lang.Object

org.springframework.ai.embedding.observation.DefaultEmbeddingModelObservationConvention

All Implemented Interfaces:

io.micrometer.observation.KeyValuesConvention, io.micrometer.observation.ObservationConvention<EmbeddingModelObservationContext>, EmbeddingModelObservationConvention

public class DefaultEmbeddingModelObservationConvention
extends Object
implements EmbeddingModelObservationConvention

Default conventions to populate observations for embedding model operations.

Since:

1.0.0

Author:

Thomas Vitale, Soby Chacko, Mengqi Xu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NAME

Fields inherited from interface io.micrometer.observation.ObservationConvention

EMPTY

Constructor Summary

Constructors

Constructor	Description
DefaultEmbeddingModelObservationConvention()

Method Summary

Modifier and Type	Method	Description
protected io.micrometer.common.KeyValue	aiOperationType(EmbeddingModelObservationContext context)
protected io.micrometer.common.KeyValue	aiProvider(EmbeddingModelObservationContext context)
String	getContextualName(EmbeddingModelObservationContext context)
io.micrometer.common.KeyValues	getHighCardinalityKeyValues(EmbeddingModelObservationContext context)
io.micrometer.common.KeyValues	getLowCardinalityKeyValues(EmbeddingModelObservationContext context)
String	getName()
protected io.micrometer.common.KeyValues	requestEmbeddingDimension(io.micrometer.common.KeyValues keyValues, EmbeddingModelObservationContext context)
protected io.micrometer.common.KeyValue	requestModel(EmbeddingModelObservationContext context)
protected io.micrometer.common.KeyValue	responseModel(EmbeddingModelObservationContext context)
protected io.micrometer.common.KeyValues	usageInputTokens(io.micrometer.common.KeyValues keyValues, EmbeddingModelObservationContext context)
protected io.micrometer.common.KeyValues	usageTotalTokens(io.micrometer.common.KeyValues keyValues, EmbeddingModelObservationContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ai.embedding.observation.EmbeddingModelObservationConvention

supportsContext

Field Details

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

• Constant Field Values

Constructor Details

DefaultEmbeddingModelObservationConvention

public DefaultEmbeddingModelObservationConvention()

Method Details

getName

public String getName()

Specified by:

getName in interface io.micrometer.observation.ObservationConvention<EmbeddingModelObservationContext>

getContextualName

public String getContextualName(EmbeddingModelObservationContext context)

Specified by:

getContextualName in interface io.micrometer.observation.ObservationConvention<EmbeddingModelObservationContext>

getLowCardinalityKeyValues

public io.micrometer.common.KeyValues getLowCardinalityKeyValues(EmbeddingModelObservationContext context)

Specified by:

getLowCardinalityKeyValues in interface io.micrometer.observation.ObservationConvention<EmbeddingModelObservationContext>

aiOperationType

protected io.micrometer.common.KeyValue aiOperationType(EmbeddingModelObservationContext context)

aiProvider

protected io.micrometer.common.KeyValue aiProvider(EmbeddingModelObservationContext context)

requestModel

protected io.micrometer.common.KeyValue requestModel(EmbeddingModelObservationContext context)

responseModel

protected io.micrometer.common.KeyValue responseModel(EmbeddingModelObservationContext context)

getHighCardinalityKeyValues

public io.micrometer.common.KeyValues getHighCardinalityKeyValues(EmbeddingModelObservationContext context)

Specified by:

getHighCardinalityKeyValues in interface io.micrometer.observation.ObservationConvention<EmbeddingModelObservationContext>

requestEmbeddingDimension

protected io.micrometer.common.KeyValues requestEmbeddingDimension(io.micrometer.common.KeyValues keyValues,
 EmbeddingModelObservationContext context)

usageInputTokens

protected io.micrometer.common.KeyValues usageInputTokens(io.micrometer.common.KeyValues keyValues,
 EmbeddingModelObservationContext context)

usageTotalTokens

protected io.micrometer.common.KeyValues usageTotalTokens(io.micrometer.common.KeyValues keyValues,
 EmbeddingModelObservationContext context)