/metadata/vectors/nearestFind Nearest Vectors
Create nearest. (Data, Queries & Vectors) POST /@:projectSlug/metadata/vectors/nearest.
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| surface * | string | A surface label The scope is 1 to 128 characters of letters, digits, Only a collection surface is accepted here. |
| column * | string | The declared vector column to rank by, as Not a protected column. |
| embedding * | number[] | The query vector. Its length must match the column's dimension. |
| k | integer | How many nearest rows to return, as the vector search |
| metric | string | The distance metric, as the vector search |
| where | object[] | Filters on declared columns, as in POST /metadata/query. |
| field * | string | The field to filter on. On a collection surface, On a telemetry surface, |
| op * | "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "contains" | "startsWith" | "endsWith" | "in" | "notIn" | "and" | "or" | "not" | The operator. A protected (encrypted) column allows only |
| value * | any | The value to compare with. Other operators take one string, number or boolean. |
| One of: string | ||
| or: number | ||
| or: boolean | ||
| or: null | ||
| or: any[] | ||
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 400 | K9O_INVALID_FIELD_VALUE | The body is malformed: an unknown field, a wrong type, or an unsupported where operator. |
| 400 | K9O_UNKNOWN_SURFACE | A surface is not collection:<name>, storage:<bucket> or telemetry:<eventType>. |
| 400 | K9O_METADATA_FIELD_NOT_INDEXED | A field is not a declared metadata field of the surface (ch04 §1.3.1); declare it with PUT /metadata/index/{collection}. |
| 400 | K9O_INVALID_FILTER | The embedding does not match the column, or a where value is invalid. |
| 401 | K9O_INVALID_CREDENTIALS | The caller is not authenticated. |
| 403 | K9O_ACCESS_DENIED | The caller has no read access to the collection (the record read's own gate). |
| 403 | K9O_EXTENSION_PERMISSION_DENIED | An extension token: the Metadata API is not extension-callable yet. |
| data * | object[] | The matching rows. A query over several surfaces lists each surface's rows in the order the surfaces were named. |
| surface * | string | The surface label the row came from, as sent. |
| scope * | string | The surface's scope: the collection name, or the audit event type for telemetry. |
| recordId | string | The record's id. Present on collection rows only. |
| eventId | string | The audit event's id. Present on telemetry rows only. |
| metadata * | object | For a collection surface: the record's declared metadata columns (see PUT /metadata/index/{collection}), keyed by column name, with each value as the record read returns it (string, number, boolean, null, or an array or object for array and jsonb columns). A declared column the record read did not return is absent. For a telemetry surface: the audit event as GET /audit-log returns it. |
| meta * | any | Request metadata (request id, trace id, timing and cost) plus |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.metadata.vectors.nearest({})Showing example in TypeScript
{
"surface": "string",
"column": "string",
"embedding": [
0
],
"k": 0,
"metric": "string",
"where": [
{
"field": "string",
"op": "eq",
"value": "string"
}
]
}{
"data": [
{
"surface": "string",
"scope": "string",
"recordId": "string",
"eventId": "string"
}
]
}