Skip to content

Commit a20e44f

Browse files
authored
Update API.md
1 parent d5179a9 commit a20e44f

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

API.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,11 @@ SELECT vector_cleanup('documents', 'embedding');
166166
**Returns:** `BLOB`
167167

168168
**Description:**
169-
Encodes a vector into the required internal BLOB format. This ensures proper insertion of vector values in the chosen format.
169+
Encodes a vector into the required internal BLOB format to ensure correct storage and compatibility with the system’s vector representation.
170+
171+
Functions in the `vector_convert_` family should be used in all `INSERT`, `UPDATE`, and `DELETE` statements to properly format vector values. However, they are *not* required when specifying input vectors for the `vector_full_scan` or `vector_quantize_scan` virtual tables.
172+
173+
Optionally, these functions accept a `dimension INT` argument (placed before the vector value) to enforce a stricter sanity check, ensuring the input vector has the expected dimensionality.
170174

171175
**Parameters:**
172176

0 commit comments

Comments
 (0)