DOC-API-MODEL-enum-q9e32qbsm3#overview
VectorMetric
Distance/similarity metric for vector indexes
Type-reference view: API Enum 6u3eomk7tb. Request and response views describe this type; they do not declare an endpoint.
Usage profiles
Section ID: DOC-API-MODEL-enum-q9e32qbsm3#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-enum-q9e32qbsm3#request
API JSON uses JSON field names (camelCase).
JSON shape: string (VECTOR_METRIC_COSINE, VECTOR_METRIC_DOT_PRODUCT, VECTOR_METRIC_EUCLIDEAN) or integer (int32).
Distance/similarity metric for vector indexes
| Value | No. | Form | Meaning |
|---|---|---|---|
VECTOR_METRIC_COSINE | 0 | Canonical | Compare vectors using cosine similarity. |
VECTOR_METRIC_DOT_PRODUCT | 1 | Canonical | Compare vectors using their dot product. |
VECTOR_METRIC_EUCLIDEAN | 2 | Canonical | Compare vectors using Euclidean distance. |
In responses
Section ID: DOC-API-MODEL-enum-q9e32qbsm3#response
API JSON uses JSON field names (camelCase).
JSON shape: string (VECTOR_METRIC_COSINE, VECTOR_METRIC_DOT_PRODUCT, VECTOR_METRIC_EUCLIDEAN) or integer (int32).
Distance/similarity metric for vector indexes
| Value | No. | Form | Meaning |
|---|---|---|---|
VECTOR_METRIC_COSINE | 0 | Canonical | Compare vectors using cosine similarity. |
VECTOR_METRIC_DOT_PRODUCT | 1 | Canonical | Compare vectors using their dot product. |
VECTOR_METRIC_EUCLIDEAN | 2 | Canonical | Compare vectors using Euclidean distance. |
Where used
Section ID: DOC-API-MODEL-enum-q9e32qbsm3#where-used
| Reference | Relationship |
|---|---|
| VectorMetric | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-enum-q9e32qbsm3