Typesense Search API
Quick Start
- Make sure you have a Typesense server running
- Enable the module
- Create a new Search API Typesense server at
/admin/config/search/search-api/add-server
as per the Search API documentation, selecting "Search API Typesense" as Backend option.
- Configure the server credentials at
/admin/config/search/search-api/server/{server_name}/edit
- Create a new index on the server and add fields at
/admin/config/search/search-api/add-index
and replace Search API datatype with Typesense datatype (for example string becomes Typesense: string).
- Configure the Typesense Schema processor at
/admin/config/search/search-api/index/{index_name}/processors
- Index content from the UI or cli
Now your brand-new index is a Typesense collection, that you can check from Typesense dashboard.
There are sure to be bugs :)
Typesense documentation
You can find a clear and valuable documentation on the Typesense API Reference.
On this page
Languages
PHP97.2%JavaScript1.6%Twig1.2%
Contributors
Created January 12, 2024
Updated January 12, 2024