Package org.springframework.ai.observation.conventions

Enum Class VectorStoreObservationAttributes

java.lang.Object
java.lang.Enum<VectorStoreObservationAttributes>
org.springframework.ai.observation.conventions.VectorStoreObservationAttributes
All Implemented Interfaces:
Serializable, Comparable<VectorStoreObservationAttributes>, Constable
public enum VectorStoreObservationAttributes extends Enum<VectorStoreObservationAttributes>
Collection of attribute keys used in vector store observations (spans, metrics, events). Based on the OpenTelemetry Semantic Conventions for Vector Databases.
Since:
1.0.0
Author:
Thomas Vitale
See Also:

  • Enum Constant Details

    • DB_COLLECTION_NAME

      public static final VectorStoreObservationAttributes DB_COLLECTION_NAME
      The name of a collection (table, container) within the database.

    • DB_NAMESPACE

      public static final VectorStoreObservationAttributes DB_NAMESPACE
      The name of the database, fully qualified within the server address and port.

    • DB_OPERATION_NAME

      public static final VectorStoreObservationAttributes DB_OPERATION_NAME
      The name of the operation or command being executed.

    • DB_RECORD_ID

      public static final VectorStoreObservationAttributes DB_RECORD_ID
      The record identifier if present.

    • DB_SYSTEM

      public static final VectorStoreObservationAttributes DB_SYSTEM
      The database management system (DBMS) product as identified by the client instrumentation.

    • DB_SEARCH_SIMILARITY_METRIC

      public static final VectorStoreObservationAttributes DB_SEARCH_SIMILARITY_METRIC
      The metric used in similarity search.

    • DB_VECTOR_DIMENSION_COUNT

      public static final VectorStoreObservationAttributes DB_VECTOR_DIMENSION_COUNT
      The dimension of the vector.

    • DB_VECTOR_FIELD_NAME

      public static final VectorStoreObservationAttributes DB_VECTOR_FIELD_NAME
      The name field as of the vector (e.g. a field name).

    • DB_VECTOR_QUERY_CONTENT

      public static final VectorStoreObservationAttributes DB_VECTOR_QUERY_CONTENT
      The content of the search query being executed.

    • DB_VECTOR_QUERY_FILTER

      public static final VectorStoreObservationAttributes DB_VECTOR_QUERY_FILTER
      The metadata filters used in the search query.

    • DB_VECTOR_QUERY_RESPONSE_DOCUMENTS

      public static final VectorStoreObservationAttributes DB_VECTOR_QUERY_RESPONSE_DOCUMENTS
      Returned documents from a similarity search query.

    • DB_VECTOR_QUERY_SIMILARITY_THRESHOLD

      public static final VectorStoreObservationAttributes DB_VECTOR_QUERY_SIMILARITY_THRESHOLD
      Similarity 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 VectorStoreObservationAttributes DB_VECTOR_QUERY_TOP_K
      The top-k most similar vectors returned by a query.

  • Method Details

    • values

      public static VectorStoreObservationAttributes[] 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 VectorStoreObservationAttributes 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

    • value

      public String value()
      Return the string value of the attribute.
      Returns:
      the string value of the attribute