Skip to main content
POST
BM25 full-text search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

database
string
required

Target database.

Body

application/json

POST /v1/bm25_search/{database}. Projection is optional (absent ⇒ the engine-native _id + score).

field_name
string
required
k
integer
required
Required range: x >= 0
mode
enum<string>
required

Boolean mode for a multi-term FTS query. Accepted case-insensitively on the wire ("or", "Or", "OR"); serialized canonically lowercase.

Available options:
or,
and
query
string
required
table_name
string
required
projection
string[] | null
stats
null | enum<string>

BM25 corpus statistics for idf scoring. Absent ⇒ the engine default (per-superfile); the engine SDK's remote transport always sends it.

Available options:
per_superfile,
global

Response

Matching rows as an Arrow IPC stream (application/vnd.apache.arrow.stream), or JSON when the request sends Accept: application/json.

Last modified on August 19, 2026