Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Indexes → Search Index

AI-generated

Overview

This node operation performs a search query on a specified Meilisearch index. It allows users to search for documents within an index using various parameters such as query string, pagination, filtering, facets, attributes to retrieve or highlight, sorting, and matching strategy. This is useful for applications that need to retrieve and display search results from a Meilisearch index based on user-defined criteria.

Use Case Examples

  1. Searching a movie database index for films matching a specific genre and director.
  2. Retrieving paginated search results with highlighted matching terms for a product catalog.
  3. Filtering search results by attributes and sorting them by price or release date.

Properties

Name Meaning
UID Name of the index to search in.
Search Query The query string to search for in the index.
Offset Number of results to skip before starting to return results.
Limit Maximum number of results to return.
Hits Per Page Maximum number of results per page.
Page Specific page of results to request.
Filter String Filter query string to narrow down search results.
Facets String Comma-separated list of facets to display counts for.
Attributes To Retrieve Comma-separated list of attributes to include in returned documents.
Attributes To Crop Comma-separated list of attributes whose values should be cropped.
Crop Length Maximum length of cropped attribute values in words.
Crop Marker String to mark crop boundaries in attribute values.
Attributes To Highlight Comma-separated list of attributes to highlight matching terms in.
Highlight Pre Tag String inserted at the start of a highlighted term.
Highlight Post Tag String inserted at the end of a highlighted term.
Show Matches Position Whether to return the location of matching terms.

Output

JSON

  • json - The search results returned from the Meilisearch index, including matched documents and metadata.

Dependencies

  • Requires Meilisearch API credentials for authentication.

Troubleshooting

  • Ensure the UID (index name) is correctly specified and exists in Meilisearch.
  • Verify that the query string and filter syntax are valid according to Meilisearch documentation.
  • Check API credentials and host URL configuration for connectivity issues.
  • If waiting for task completion, ensure the task UID is correctly handled and the task completes within the timeout period.

Links

Discussion