Section ID:
DOC-API-MODEL-schema-q8s584s888#overview
ScoredVector
Vector match with score and optional payloads
Type-reference view: API Schema 6vbcrt8mlp. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-q8s584s888#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-q8s584s888#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-q8s584s888#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-q8s584s888#request-field-idid | string | Optional | Identifier of the vector record returned by the search. |
Section ID: DOC-API-MODEL-schema-q8s584s888#request-field-scorescore | number (double) or string (NaN, Infinity, -Infinity) | Optional | Similarity score reported by the vector search provider. |
Section ID: DOC-API-MODEL-schema-q8s584s888#request-field-valuesvalues | Array of number (double) or string (NaN, Infinity, -Infinity) | Optional | Present if include_values=true. |
Section ID: DOC-API-MODEL-schema-q8s584s888#request-field-metadatametadata | Map from string to JSON value | Optional | Present if include_metadata=true. |
Section ID: DOC-API-MODEL-schema-q8s584s888#request-field-namespacenamespace | string | Optional | Namespace used to group vector records. |
In responses
Section ID: DOC-API-MODEL-schema-q8s584s888#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-q8s584s888#field-idSection ID: DOC-API-MODEL-schema-q8s584s888#response-field-idid | string | Optional | Identifier of the vector record returned by the search. |
Section ID: DOC-API-MODEL-schema-q8s584s888#field-scoreSection ID: DOC-API-MODEL-schema-q8s584s888#response-field-scorescore | number (double) or string (NaN, Infinity, -Infinity) | Optional | Similarity score reported by the vector search provider. |
Section ID: DOC-API-MODEL-schema-q8s584s888#field-valuesSection ID: DOC-API-MODEL-schema-q8s584s888#response-field-valuesvalues | Array of number (double) or string (NaN, Infinity, -Infinity) | Optional | Present if include_values=true. |
Section ID: DOC-API-MODEL-schema-q8s584s888#field-metadataSection ID: DOC-API-MODEL-schema-q8s584s888#response-field-metadatametadata | Map from string to JSON value | Optional | Present if include_metadata=true. |
Section ID: DOC-API-MODEL-schema-q8s584s888#field-namespaceSection ID: DOC-API-MODEL-schema-q8s584s888#response-field-namespacenamespace | string | Optional | Namespace used to group vector records. |
Where used
Section ID: DOC-API-MODEL-schema-q8s584s888#where-used
| Reference | Relationship |
|---|---|
| ScoredVector | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-q8s584s888