update_vector_table_annotation

Use the update vector table annotation operation to update the comment and annotations for an existing vector table.

Modifies the table comment and annotations without affecting stored data.

Parameters

Parameter	Type	Value Range	Required	Default	Description	Notes
name	str	Valid vector table identifier	Yes	No default	Name of the vector table to update.	Table must exist in the database schema.
comment	str	Valid string	No	None	Updated table comment.	Returned as comment in table metadata.
annotations	dict	Object or NULL	No	None	Replacement annotations for the table.	Update replaces annotations instead of merging them; include existing annotations that must be preserved.
debug_flags	dict	Object or NULL	No	None	Debug or tracing flags for detailed logging.	Optional; omit unless diagnostics are needed.

Raises Exception – InvalidTableNameFormatError may be raised when the table name is invalid. The operation can also fail if the table does not exist or parameters are invalid.

Update table annotation metadata

response = client.update_vector_table_annotation(
    name='products',
    comment='Updated product embeddings',
    annotations={'version': '2.0', 'updated': '2025-01-27'}
)
print(response)

Return type VectorTableResponse

Returns JSON response confirming the update. Example response:

{
    "table_name": "products",
    "annotations": {
        "version": "2.0",
        "updated": "2025-01-27"
    },
    "comment": "Product embeddings"
}