GetIndexes ========== List native index definitions. Any authenticated user may call this command; no input or output blobs are used. The optional filters are ``target``, ``class``, ``property``, and ``kind``. Omitted filters match all definitions. Supported kinds are ``ordered``, ``trigram``, ``similarity``, ``fulltext``, ``type``, ``array``, ``flat``, ``ivf``, ``hnsw``, and ``acorn``. An unmatched selector returns an empty result. .. _selector-compatibility: .. include:: metadata_targets.rst Response -------- ``indexes`` is a flat array. Each definition includes its complete target/class selector, property, kind and normalized params. Vector definitions can also include customer ``metadata``. Each vector index has its own entry with its engine as ``kind``. ``returned`` counts definitions. Vector definitions also include ``progress`` from the command's transaction: ``generation``, ``retiring`` (whether older physical namespaces await cleanup), and ``backends`` entries with ``engine``, ``metric``, ``indexed``, ``pending`` and ``trained``. ``indexed`` counts physical live backend vectors. ``pending`` counts unacknowledged row changes, including updates and deletions; it is shared across an engine's metrics. Metric eligibility and superseded pending rows mean these values must not be added to obtain a descriptor count. Use FindDescriptor counts for graph rows. Removal hides the definition immediately; physical retirement can continue afterwards. .. TESTED_EXAMPLE: GetIndexes_1_response .. code-block:: json { "status": 0, "indexes": [ {"target":"entity","class":"Person","property":"name","kind":"ordered", "params":{"text":"case_sensitive"}}, {"target":"descriptor","class":"Faces","property":"_blob","kind":"flat", "params":{"dimensions":128,"dtype":"float32","metric":["L2"], "lazy_indexing":false}, "metadata":{"model":"face-v1"}, "progress":{"generation":1,"retiring":false,"backends":[ {"engine":"Flat","metric":"L2","indexed":12,"pending":0,"trained":true}]}} ], "returned": 2 } Empty results contain ``indexes: []`` and ``returned: 0``. Indexes are not graph objects and cannot be selected with Find commands, referenced or connected. Examples -------- .. TESTED_EXAMPLE: GetIndexes_1 .. code-block:: json [{"GetIndexes":{}}]