Skip to main content
Version: 0.0.7 (stable)

agrag.common.data_models.index_record.IndexInfo

IndexInfo(name:str, state:str, population_percent:float | None, type:str, labels:list[str], properties:list[str], dimensions:int | None = None) -> None

One search or lookup index in the graph database.

Attributes:

  • name (str) – The index name. Backends that do not name indexes derive the same deterministic name that vector_index_name and fulltext_index_name build.
  • state (str) – ONLINE when queries can use the index. Any other value means the index is still being built or has failed.
  • population_percent (float | None) – How much of the index is built, from 0 to 100. None when the backend does not report progress.
  • type (str) – VECTOR, FULLTEXT, or another backend index type.
  • labels (list[str]) – The node labels or relationship types the index covers.
  • properties (list[str]) – The indexed property names.
  • dimensions (int | None) – The embedding size of a VECTOR index, otherwise None.

dimensions​

dimensions: int | None = None

labels​

labels: list[str]

name​

name: str

population_percent​

population_percent: float | None

properties​

properties: list[str]

state​

state: str

type​

type: str