Lists visible vector keys with optional prefix and cursor arguments.
Paginated responses use opaque cursors. Clients should pass the returned cursor back to the same command shape and must not parse cursor contents.
Examples
List keys in a collection, in key order.
CLI
$ strata vector collection create docs 3 cosine
$ strata vector upsert docs a [1.0,0.0,0.0]
$ strata vector upsert docs b [0.0,1.0,0.0]
$ strata vector keys docs
Wire
{"collection":"docs","dimension":3,"metric":"cosine","type":"vector_create_collection"}
{"collection":"docs","key":"a","type":"vector_upsert","vector":[1.0,0.0,0.0]}
{"collection":"docs","key":"b","type":"vector_upsert","vector":[0.0,1.0,0.0]}
{"collection":"docs","type":"vector_list_keys"}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
as_of | integer | no | Optional timestamp in microseconds. |
collection | string | yes | Collection name. |
cursor | string | no | Optional key cursor. |
limit | integer | no | Optional item limit. Defaults to 100. |
prefix | string | no | Optional key prefix. |
Plus the optional scope: branch and space (default to the session branch and the "default" space).
Returns
Page<String, String>.
Errors
failed_precondition.engine.runtime_closednot_found.engine.branchinvalid_argument.engine.product_spaceinvalid_argument.engine.vector_collectioninvalid_argument.engine.vector_keynot_found.engine.vector_collection
Invocation
- CLI:
strata vector keys - Wire type:
vector_list_keys