Search API Typesense
This module provides a backend for the Search API module that uses Typesense for search functionality. It allows you to manage your Typesense collections and schema directly from Drupal and supports features like synonyms, stopwords, and API key management.
Provides a Typesense Backend to Search API.
The current implementation allows for creating and managing a Typesense collection directly from the Drupal UI.
At the moment, the module doesn't support creating a search page using the Views module (like other Search API backends); this is by design, as implementing the search in the front end has many advantages, first of all, speed.
See how it works: here.
Getting started
- Download and install Typesense
- Install and enable the module
- Create a new Search API server using the Typesense server created in step 1
- Create a new Search API index using the Search API server created in step 3
- Add fields to the index created in step 4, including at least one numeric field that can be used for sorting
- Configure the Typesense collection's schema using the Schema tab at
/admin/config/search/search-api/index/${index_name}/schema. Indexing content will not be possible unless this step has been completed.
If you're on DDEV, you can use an add-on to download a run Typesense inside DDEV, just type:
ddev add-on get lussoluca/ddev-typesense
Currently implemented features
Typesense Search API Backend
Search API features
The module includes a Typesense Search API Backend that can be used for the creation and management of a Typesense collection, including:
- Server creation
- Index creation
- Typesense schema management
- Indexing
- Synonyms
- Curations
- Stopwords
- API key management
- Embedding and semantic search