File size: 1,023 Bytes
b3d711f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | """Attachable function definitions for ChromaDB collections.
This module provides function constants that can be attached to collections
to perform automatic computations on collection data.
Example:
>>> from chromadb.api.functions import STATISTICS_FUNCTION
>>> attached_fn = collection.attach_function(
... function=STATISTICS_FUNCTION,
... name="my_stats",
... output_collection="my_stats_output"
... )
"""
from enum import Enum
class Function(str, Enum):
"""Available functions that can be attached to collections."""
STATISTICS = "statistics"
"""Computes metadata value frequencies for a collection."""
RECORD_COUNTER = "record_counter"
"""Counts records in a collection."""
# Used only for failure testing - not a real function
_NONEXISTENT_TEST_ONLY = "nonexistent_function"
# Convenience aliases for cleaner imports
STATISTICS_FUNCTION = Function.STATISTICS
RECORD_COUNTER_FUNCTION = Function.RECORD_COUNTER
|