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.

An exact node target is its type and class, for example {"target":"image","class":"Photos"}.

For a connection, class names the source class, connection class, and destination class. target supplies the corresponding endpoint types.

{
  "class": {"src": "People", "connection": "AppearsIn", "dst": "Photos"},
  "target": {"src": "entity", "dst": "image"}
}

Metadata mutations require all five values for a connection. Class names are nonempty, cannot begin with _, and are matched without case sensitivity. Index selectors also include property and kind. With GetIndexes and GetAggregates you can supply only the fields you want to match, such as {"class":{"connection":"AppearsIn"},"target":{"dst":"image"}}.

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.

{
  "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

[{"GetIndexes":{}}]