Actions33
- Documents Actions
- General Actions
- Indexes Actions
- Keys Actions
- Search Actions
- Settings Actions
- Tasks Actions
Search → Search Index
AI-generatedOverview
This node performs a search operation on a specified Meilisearch index. It allows users to query the index with various parameters such as query string, pagination, filtering, facets, attributes to retrieve or highlight, sorting, and matching strategy. This is useful for retrieving relevant search results from a Meilisearch index based on complex search criteria.
Use Case Examples
- Searching a movie database index for horror or mystery genres directed by a specific director.
- Retrieving paginated search results with specific attributes highlighted and cropped for display.
- Filtering search results by specific facets and sorting them by price or release date.
Properties
| Name | Meaning |
|---|---|
| UID | Name of the index to search in. |
| Additional Fields | Additional search parameters such as query string, offset, limit, hits per page, page number, filter string, facets, attributes to retrieve, crop settings, highlight settings, show matches position, sort order, and matching strategy. |
Output
JSON
jsonhits- Array of search result documents matching the query.estimatedTotalHits- Estimated total number of hits for the query.offset- Number of results skipped (offset).limit- Maximum number of results returned (limit).processingTimeMs- Time taken to process the search query in milliseconds.query- The original search query string.
Dependencies
- An API key credential for Meilisearch API authentication
Troubleshooting
- Ensure the UID (index name) is correctly specified and exists in Meilisearch.
- Verify that the API credentials are valid and have the necessary permissions.
- Check that the query string and other parameters are correctly formatted.
- If the node times out waiting for task completion, increase the timeout or check the Meilisearch server status.
Links
- Meilisearch Search API Documentation - Official documentation for the Meilisearch search endpoint and its parameters.