Semantic Search (Experimental)
This is an experimental feature, built on the experimental Embeddings feature. The request contract, behaviour and APIs may still change in breaking ways between releases.
Semantic search matches by meaning instead of by words. "british roadster" finds a Triumph TR 3 and a Jaguar XK140 even though neither text contains the phrase, and "red sports car" finds red sports cars by what the picture looks like, with no tagging involved.
It appears as an extra search mode next to Studio's existing full-text search. Which modes are offered depends on what is embedded:
| Surface | Modes |
|---|---|
| Assets | Full text search, Smart search: Text, Smart search: Image |
| Data objects | Full text search, Smart search: Text |
| Documents | Full text search only — documents carry no embeddings |
The same modes are available in two places: the quick search dialog and the Search & Filter panel of any grid. See Search Modes.
Features
- Hybrid by construction. The semantic clause joins the same bool query as everything else, so column filters, full-text search and workspace permissions all still apply.
- Available everywhere a listing is. Quick search, asset grids and data object grids, through one registered search mode rather than a separate screen.
- Degrades instead of failing. If the inference service cannot embed the query, the grid returns plain results and logs a warning.
- Scriptable. The same search is reachable as a column filter inside the ordinary grid request, and as a standalone endpoint.
Requirements
- Embeddings enabled, with a
semantic_text_searchusage for text search and animage_searchusage for image search. - OpenSearch, or Elasticsearch where every asset and data object index was created on 8.12.1 or newer. Older Elasticsearch indices cannot combine a kNN clause with the workspace query, so the feature is switched off rather than returning wrong results.
- The
bptb_semantic_search_permissionuser permission, see User Permissions.
Where any of these is missing, the smart modes are simply not offered — there is nothing to switch off.
Pages in this chapter
- Search Modes: the modes in Studio, what each one matches, and where they appear.
- Grid and Search Filter: the
bpt.semanticSearchcolumn filter, result ordering and degrade behaviour. - Global Endpoint: the standalone search endpoint, and the availability data the UI reads.
