You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**`spatial_expr_1`**| An array of `float32` or smaller.|
36
36
|**`spatial_expr_2`**| An array of `float32` or smaller.|
37
-
|**`bool_expr`**| A boolean specifying how the computed value is used in an ORDER BY expression. If `true`, then brute force is used. A value of `false`will leverage any index defined on the vector property, if it exists. Default value is `false`.|
37
+
|**`bool_expr`**| A boolean specifying how the computed value is used in an ORDER BY expression. If `true`, then brute force is used. A value of `false`leverages any index defined on the vector property, if it exists. Default value is `false`.|
38
38
|**`obj_expr`**| A JSON formatted object literal used to specify options for the vector distance calculation. Valid items include `distanceFunction` and `dataType`.|
39
-
|**`distanceFunction`**| The function used to compute similarity score.`cosine`, `euclidean`, or `dotproduct`. Default value is `cosine`.|
39
+
| **`distanceFunction`** | The metric used to compute distance/similarity.
40
40
|**`dataType`**| The data type of the vectors. `float32`, `float16`, `int8`, `uint8` values. Default value is `float32`. |
41
41
42
+
43
+
Supported metrics for `distanceFunction` are:
44
+
*[cosine](https://en.wikipedia.org/wiki/Cosine_similarity), which has values from -1 (least similar) to +1 (most similar).
45
+
*[dotproduct](https://en.wikipedia.org/wiki/Dot_product), which has values from -inf (least similar) to +inf (most similar).
46
+
*[euclidean](https://en.wikipedia.org/wiki/Euclidean_distance), which has values from 0 (most similar) to +inf (least similar).
47
+
42
48
## Return types
43
49
44
50
Returns a numeric expression that enumerates the similarity score between two expressions.
@@ -62,8 +68,8 @@ ORDER BY VectorDistance(c.vector1, c.vector2)
62
68
## Remarks
63
69
- This function requires enrollment in the [Azure Cosmos DB NoSQL Vector Search preview feature](../vector-search.md#enroll-in-the-vector-search-preview-feature).
64
70
- This function benefits from a [vector index](../../index-policy.md#vector-indexes)
65
-
- if `false` is given as the optional `bool_expr`, then the vector index defined on the path is used, if one exists. If no index is defined on the vector path, then this will revert to full scan and incur higher RU charges and higher latency than if using a vector index.
66
-
- When `VectorDistance` is used in an `ORDER BY` clause, no direction can be specified for the `ORDER BY`, as the results will always be sorted in order of most similar (first) to least similar (last) based on the similarity metric used. If a direction such as `ASC` or `DESC` is specified, an error will occur.
71
+
- if `false` is given as the optional `bool_expr`, then the vector index defined on the path is used, if one exists. If no index is defined on the vector path, then this reverts to full scan and incurs higher RU charges and higher latency than if using a vector index.
72
+
- When `VectorDistance` is used in an `ORDER BY` clause, no direction can be specified for the `ORDER BY`, as the results are always sorted in order of most similar (first) to least similar (last) based on the similarity metric used. If a direction such as `ASC` or `DESC` is specified, an error occurs.
0 commit comments