Package org.springframework.ai.vectorstore.observation

Class VectorStoreObservationContext

java.lang.Object

io.micrometer.observation.Observation.Context

org.springframework.ai.vectorstore.observation.VectorStoreObservationContext

All Implemented Interfaces:

io.micrometer.observation.Observation.ContextView

public class VectorStoreObservationContext
extends io.micrometer.observation.Observation.Context

Context used to store metadata for vector store operations.

Since:

1.0.0

Author:

Christian Tzolov, Thomas Vitale, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VectorStoreObservationContext.Builder
static enum	VectorStoreObservationContext.Operation

Constructor Summary

Constructors

Constructor	Description
VectorStoreObservationContext(String databaseSystem, String operationName)

Method Summary

Modifier and Type	Method	Description
static VectorStoreObservationContext.Builder	builder(String databaseSystem, String operationName)
static VectorStoreObservationContext.Builder	builder(String databaseSystem, VectorStoreObservationContext.Operation operation)
String	getCollectionName()
String	getDatabaseSystem()
Integer	getDimensions()
String	getFieldName()
String	getNamespace()
String	getOperationName()
SearchRequest	getQueryRequest()
List<Document>	getQueryResponse()
String	getSimilarityMetric()
void	setCollectionName(String collectionName)
void	setDimensions(Integer dimensions)
void	setFieldName(String fieldName)
void	setNamespace(String namespace)
void	setQueryRequest(SearchRequest queryRequest)
void	setQueryResponse(List<Document> queryResponse)
void	setSimilarityMetric(String similarityMetric)

Methods inherited from class io.micrometer.observation.Observation.Context

addHighCardinalityKeyValue, addHighCardinalityKeyValues, addLowCardinalityKeyValue, addLowCardinalityKeyValues, clear, computeIfAbsent, containsKey, get, getAllKeyValues, getContextualName, getError, getHighCardinalityKeyValue, getHighCardinalityKeyValues, getLowCardinalityKeyValue, getLowCardinalityKeyValues, getName, getOrDefault, getParentObservation, getRequired, put, remove, removeHighCardinalityKeyValue, removeHighCardinalityKeyValues, removeLowCardinalityKeyValue, removeLowCardinalityKeyValues, setContextualName, setError, setName, setParentObservation, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micrometer.observation.Observation.ContextView

getOrDefault

Constructor Details

VectorStoreObservationContext

public VectorStoreObservationContext(String databaseSystem,
 String operationName)

Method Details

builder

public static VectorStoreObservationContext.Builder builder(String databaseSystem,
 String operationName)

builder

public static VectorStoreObservationContext.Builder builder(String databaseSystem,
 VectorStoreObservationContext.Operation operation)

getDatabaseSystem

public String getDatabaseSystem()

getOperationName

public String getOperationName()

getCollectionName

@Nullable
public String getCollectionName()

setCollectionName

public void setCollectionName(@Nullable
 String collectionName)

getDimensions

@Nullable
public Integer getDimensions()

setDimensions

public void setDimensions(@Nullable
 Integer dimensions)

getFieldName

@Nullable
public String getFieldName()

setFieldName

public void setFieldName(@Nullable
 String fieldName)

getNamespace

@Nullable
public String getNamespace()

setNamespace

public void setNamespace(@Nullable
 String namespace)

getSimilarityMetric

@Nullable
public String getSimilarityMetric()

setSimilarityMetric

public void setSimilarityMetric(@Nullable
 String similarityMetric)

getQueryRequest

@Nullable
public SearchRequest getQueryRequest()

setQueryRequest

public void setQueryRequest(@Nullable
 SearchRequest queryRequest)

getQueryResponse

@Nullable
public List<Document> getQueryResponse()

setQueryResponse

public void setQueryResponse(@Nullable
 List<Document> queryResponse)