textSearch
Search text-indexed records by keywords with BM25 ranking; filter by labels and conditions, paginate results, and count all matches.
Instructions
Keyword (BM25) search over a text index: records matching query, best first (__score), among those labels and where select. total counts every match. Query syntax: words match any (or all with allTerms), "quoted phrases", -excluded, +required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | Results to skip for pagination (default 0). | |
| index | No | Text index name (from listTextIndexes). Defaults to the one ready text index of the first label. | |
| limit | No | Maximum number of results (default 10). | |
| query | Yes | Keywords to match. | |
| where | No | Filter applied before ranking. | |
| labels | No | Record labels to search. | |
| phrase | No | Match the keywords as one phrase. | |
| allTerms | No | Every keyword must match (AND) instead of any (OR). | |
| property | No | Narrows the choice of text index to one over this property. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | ||
| total | Yes |