Module indexes (0.2.2)
Stay organized with collections
Save and categorize content based on your preferences.
API documentation for indexes module.
Classes
BaseIndex
BaseIndex(name: Optional[str] = None, index_type: str = 'base', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy = <factory>, partial_indexes: Optional[list[str]] = None)BaseIndex(name: Optional[str] = None, index_type: str = 'base', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy =
DistanceStrategy
DistanceStrategy(value)Enumerator of the Distance strategies.
ExactNearestNeighbor
ExactNearestNeighbor(name: Optional[str] = None, index_type: str = 'exactnearestneighbor', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy = <factory>, partial_indexes: Optional[list[str]] = None)ExactNearestNeighbor(name: Optional[str] = None, index_type: str = 'exactnearestneighbor', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy =
HNSWIndex
HNSWIndex(name: Optional[str] = None, index_type: str = 'hnsw', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy = <factory>, partial_indexes: Optional[list[str]] = None, m: int = 16, ef_construction: int = 64)HNSWIndex(name: Optional[str] = None, index_type: str = 'hnsw', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy =
HNSWQueryOptions
HNSWQueryOptions(ef_search: int = 40)HNSWQueryOptions(ef_search: int = 40)
IVFFlatIndex
IVFFlatIndex(name: Optional[str] = None, index_type: str = 'ivfflat', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy = <factory>, partial_indexes: Optional[list[str]] = None, lists: int = 100)IVFFlatIndex(name: Optional[str] = None, index_type: str = 'ivfflat', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy =
IVFFlatQueryOptions
IVFFlatQueryOptions(probes: int = 1)IVFFlatQueryOptions(probes: int = 1)
IVFIndex
IVFIndex(name: Optional[str] = None, index_type: str = 'ivf', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy = <factory>, partial_indexes: Optional[list[str]] = None, lists: int = 100)IVFIndex(name: Optional[str] = None, index_type: str = 'ivf', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy =
IVFQueryOptions
IVFQueryOptions(probes: int = 1)IVFQueryOptions(probes: int = 1)
QueryOptions
QueryOptions()API documentation for QueryOptions class.
ScaNNIndex
ScaNNIndex(name: Optional[str] = None, index_type: str = 'ScaNN', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy = <factory>, partial_indexes: Optional[list[str]] = None, num_leaves: int = 5)ScaNNIndex(name: Optional[str] = None, index_type: str = 'ScaNN', distance_strategy: llama_index_alloydb_pg.indexes.DistanceStrategy =
ScaNNQueryOptions
ScaNNQueryOptions(
num_leaves_to_search: int = 1, pre_reordering_num_neighbors: int = -1
)ScaNNQueryOptions(num_leaves_to_search: int = 1, pre_reordering_num_neighbors: int = -1)
StrategyMixin
StrategyMixin(
operator: str, search_function: str, index_function: str, scann_index_function: str
)API documentation for StrategyMixin class.