v7

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0112015.7 KB

Data

Vector Query

post/v1/table/{name}/query/

Path parameters

namestring required

name of the table

Request body

{"stackTrail":"paths:/v1/table/{name}/query/:post:requestBody:content:application/json:schema:properties:vector","oasType":"schema","type":"unknown","description":"The targetted vector to search for. Required.\n"}

vector_columnstring

The column to query, it can be inferred from the schema if there is only one vector column.

prefilterboolean

Whether to prefilter the data. Optional.

kinteger

The number of search results to return. Default is 10.

distance_typestring

The distance metric to use for search. l2, Cosine, Dot and Hamming are supported. Default is l2.

bypass_vector_indexboolean

Whether to bypass vector index. Optional.

filterstring

A filter expression that specifies the rows to query. Optional.

columnsstring[]

The columns to return. Optional.

nprobeinteger

The number of probes to use for search. Optional.

refine_factorinteger

The refine factor to use for search. Optional.

fast_searchboolean

Whether to use fast search. Optional.

Response

top k results if query is successfully executed