DOC-API-MODEL-schema-q9cp251mpk#overview
Vector
Canonical vector record shared across vector DB services
Type-reference view: API Schema 6vhb5mpe0m. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-q9cp251mpk#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-q9cp251mpk#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-q9cp251mpk#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-q9cp251mpk#request-field-idid | string | Required in requests | Identifier used to address the vector record within its namespace. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-q9cp251mpk#request-field-valuesvalues | Array of number (double) or string (NaN, Infinity, -Infinity) | Optional | Dense vector values. |
Section ID: DOC-API-MODEL-schema-q9cp251mpk#request-field-sparsevaluessparseValues | SparseValues | Optional | Optional sparse component. |
Section ID: DOC-API-MODEL-schema-q9cp251mpk#request-field-metadatametadata | Map from string to JSON value | Optional | Provider metadata (JSON object). |
Section ID: DOC-API-MODEL-schema-q9cp251mpk#request-field-namespacenamespace | string | Optional | Optional namespace/bucket. |
Section ID: DOC-API-MODEL-schema-q9cp251mpk#request-field-updatedatupdatedAt | string (date-time) | Optional | Time when this record was last updated. |
Request validation
Section ID: DOC-API-MODEL-schema-q9cp251mpk#request-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
id | Minimum length | 1 |
In responses
Section ID: DOC-API-MODEL-schema-q9cp251mpk#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-q9cp251mpk#field-idSection ID: DOC-API-MODEL-schema-q9cp251mpk#response-field-idid | string | Required in requests | Identifier used to address the vector record within its namespace. |
Section ID: DOC-API-MODEL-schema-q9cp251mpk#field-valuesSection ID: DOC-API-MODEL-schema-q9cp251mpk#response-field-valuesvalues | Array of number (double) or string (NaN, Infinity, -Infinity) | Optional | Dense vector values. |
Section ID: DOC-API-MODEL-schema-q9cp251mpk#field-sparsevaluesSection ID: DOC-API-MODEL-schema-q9cp251mpk#response-field-sparsevaluessparseValues | SparseValues | Optional | Optional sparse component. |
Section ID: DOC-API-MODEL-schema-q9cp251mpk#field-metadataSection ID: DOC-API-MODEL-schema-q9cp251mpk#response-field-metadatametadata | Map from string to JSON value | Optional | Provider metadata (JSON object). |
Section ID: DOC-API-MODEL-schema-q9cp251mpk#field-namespaceSection ID: DOC-API-MODEL-schema-q9cp251mpk#response-field-namespacenamespace | string | Optional | Optional namespace/bucket. |
Section ID: DOC-API-MODEL-schema-q9cp251mpk#field-updatedatSection ID: DOC-API-MODEL-schema-q9cp251mpk#response-field-updatedatupdatedAt | string (date-time) | Optional | Time when this record was last updated. |
DOC-API-MODEL-schema-q9cp251mpk#validation
Request validation
Section ID: DOC-API-MODEL-schema-q9cp251mpk#response-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
id | Minimum length | 1 |
Where used
Section ID: DOC-API-MODEL-schema-q9cp251mpk#where-used
| Reference | Relationship |
|---|---|
| Vector | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-q9cp251mpk