Enum Class VectorStoreObservationDocumentation.HighCardinalityKeyNames
java.lang.Object
java.lang.Enum<VectorStoreObservationDocumentation.HighCardinalityKeyNames>
org.springframework.ai.vectorstore.observation.VectorStoreObservationDocumentation.HighCardinalityKeyNames
- All Implemented Interfaces:
io.micrometer.common.docs.KeyName,Serializable,Comparable<VectorStoreObservationDocumentation.HighCardinalityKeyNames>,Constable
- Enclosing class:
- VectorStoreObservationDocumentation
public static enum VectorStoreObservationDocumentation.HighCardinalityKeyNames
extends Enum<VectorStoreObservationDocumentation.HighCardinalityKeyNames>
implements io.micrometer.common.docs.KeyName
High-cardinality observation key names for vector store operations.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe name of a collection (table, container) within the database.The namespace of the database.The metric used in similarity search.The dimension of the vector.The name field as of the vector (e.g.The content of the search query being executed.The metadata filters used in the search query.Returned documents from a similarity search query.Similarity threshold that accepts all search scores.The top-k most similar vectors returned by a query. -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum constant of this class with the specified name.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, valueOfMethods inherited from interface io.micrometer.common.docs.KeyName
asString, isRequired, withValue, withValue
-
Enum Constant Details
-
DB_COLLECTION_NAME
The name of a collection (table, container) within the database. -
DB_NAMESPACE
The namespace of the database. -
DB_SEARCH_SIMILARITY_METRIC
public static final VectorStoreObservationDocumentation.HighCardinalityKeyNames DB_SEARCH_SIMILARITY_METRICThe metric used in similarity search. -
DB_VECTOR_DIMENSION_COUNT
public static final VectorStoreObservationDocumentation.HighCardinalityKeyNames DB_VECTOR_DIMENSION_COUNTThe dimension of the vector. -
DB_VECTOR_FIELD_NAME
public static final VectorStoreObservationDocumentation.HighCardinalityKeyNames DB_VECTOR_FIELD_NAMEThe name field as of the vector (e.g. a field name). -
DB_VECTOR_QUERY_CONTENT
public static final VectorStoreObservationDocumentation.HighCardinalityKeyNames DB_VECTOR_QUERY_CONTENTThe content of the search query being executed. -
DB_VECTOR_QUERY_FILTER
public static final VectorStoreObservationDocumentation.HighCardinalityKeyNames DB_VECTOR_QUERY_FILTERThe metadata filters used in the search query. -
DB_VECTOR_QUERY_RESPONSE_DOCUMENTS
public static final VectorStoreObservationDocumentation.HighCardinalityKeyNames DB_VECTOR_QUERY_RESPONSE_DOCUMENTSReturned documents from a similarity search query. -
DB_VECTOR_QUERY_SIMILARITY_THRESHOLD
public static final VectorStoreObservationDocumentation.HighCardinalityKeyNames DB_VECTOR_QUERY_SIMILARITY_THRESHOLDSimilarity threshold that accepts all search scores. A threshold value of 0.0 means any similarity is accepted or disable the similarity threshold filtering. A threshold value of 1.0 means an exact match is required. -
DB_VECTOR_QUERY_TOP_K
public static final VectorStoreObservationDocumentation.HighCardinalityKeyNames DB_VECTOR_QUERY_TOP_KThe top-k most similar vectors returned by a query.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-