Install
Works with Drupal: ^11.2Using Composer to manage Drupal site dependencies
Alternative installation files
Download tar.gz
105.65 KB
MD5: fc85ed835b289efd375d6c6f2180ea93
SHA-1: 4cac0fb9bc2c353bf7abcbdc0f2dad6f6fa0e2bc
SHA-256: 9c9b72f003df17f926f0c29978e41fd4331d465d346929a706fb0d7800ad53b1
Download zip
168.62 KB
MD5: 82c4da7edb0d299c01567753f32da6f6
SHA-1: 02a9cd16ee21f822c35fa9da9aff767a84418a8b
SHA-256: b96f6e70ee1977088e4f8a07a03463207022fddb70d8c4b2d83482d90a0b1c2f
Release notes
The first release on drupal.org. Search API Instant shows results while visitors type, from one or more Search API indexes, in a floating launcher, a block or a search page.
What it does
- Searches as configuration entities. Each search has its own engine, indexes, limits and launcher; the floating launcher shows the default search.
- Keyword engine on any Search API backend (database, Solr, Elasticsearch, OpenSearch), with partial-word title matching; several indexes per search are merged by rank.
- Semantic engine on AI Search indexes, fusing in literal matches from keyword indexes.
- Fallbacks: a search hands over to another while its index fills or when its server is down or fails.
- Access-checked and cache-safe results, field access in excerpts, and restricted searches with their own permission.
- Optional submodules for AI agents: Search API Instant tools (Tool API) and Search API Instant MCP (MCP Server), each with a search tool and an administrator's status tool.
hook_search_api_instant_result_alter(),hook_search_api_instant_answer_alter()andhook_search_api_instant_status_alter(); engines are plugins; thesearch_api_instant.searcherservice can be replaced or decorated.
Requirements
- Drupal 11.2 or later
- Search API 1.38 or later
- Optional: AI Search (semantic engine), Tool or MCP Server (agent tools)
About this beta
- The configuration schema and public APIs are not expected to change before 1.0.0; any change will come with an update path.
- Before this release the module was reviewed twice for security in the manner of the Drupal Security Team, and the findings were fixed. Security advisory coverage applies to stable releases, from 1.0.0.
- The semantic engine has been checked against AI Search 1.3; AI Search 2.0 has not been checked yet.
Upgrading from the earlier package
Sites that installed fivepaths/search_api_instant (1.0.0-alpha1 to alpha5) can switch to drupal/search_api_instant: the code and the update path are the same. Run drush updatedb and export the configuration afterwards.