vector
metadata.update
Patch metadata for one vector.
strata vector update-metadatadb.vectors.update_metadata(collection: 'str', key: 'str', metadata: 'dict') -> 'Any'wire vector_update_metadata
Applies a top-level metadata patch to one visible vector. Missing vectors return a no-op mutation acknowledgement.
Successful mutations return an acknowledgement of the outcome: for a state-changing write, the affected target with the mutation effect and commit facts; for mutations that produce a domain result (such as a branch or a promotion outcome), that result object.
To see the complete help for this command, run:
strata vector update-metadata --helphelp(db.vectors.update_metadata)
Example
Patch the metadata of an existing vector.
strata vector collection create docs 3 --metric cosinecreated collection docs (3 dimensions, cosine)strata vector upsert docs a '[1.0,0.0,0.0]' --metadata '{"tag":"x"}'created a in docsstrata vector update-metadata docs a '{"tag":"z"}'updated a in docsstrata vector get docs akey avector_revision 2version …embedding [1.0,0.0,0.0]metadata {"tag":"z"}
_ = db.vectors.create_collection("docs", 3, metric="cosine")_ = db.vectors.upsert("docs", "a", [1.0, 0.0, 0.0], metadata={"tag": "x"})_ = db.vectors.update_metadata("docs", "a", {"tag": "z"})db.vectors.get("docs", "a").data.metadata
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| collection | string | yes | Collection name. |
| key | string | yes | Vector key. |
| patch | any | yes | Top-level metadata patch. |
| branch | string or null | no | Target branch. Defaults to the executor handle branch. |
| space | string or null | no | Target product space. Defaults to `"default"`. |
Returns
MutationAck
- dataobject
- typestring
Errors
Recover by code. Retry policy and commit outcome come from the shipped error registry.
| Code | Retry | Commit outcome |
|---|---|---|
| failed_precondition.engine.runtime_closed | never | not_started |
| not_found.engine.branch | never | not_applicable |
| invalid_argument.engine.product_space | never | not_started |
| invalid_argument.engine.vector_collection | never | not_started |
| invalid_argument.engine.vector_key | never | not_started |
| not_found.engine.vector_collection | never | not_applicable |
| invalid_argument.engine.vector_metadata_patch | never | not_started |