Meilisearch icon

Meilisearch

Consume Meilisearch API

Actions33

Settings → Update Index Settings

AI-generated

Overview

This node operation updates the settings of a specified index in Meilisearch. It allows users to configure various index settings such as displayed attributes, distinct attribute, filterable attributes, ranking rules, searchable attributes, sortable attributes, stop words, typo tolerance settings, synonyms, and more. The node supports waiting for the update task to complete with optional polling and exponential backoff to handle asynchronous task processing. This operation is useful for customizing how search behaves on an index, improving search relevance, and managing index behavior dynamically.

Use Case Examples

  1. Updating the displayed attributes of an index to show only specific fields in search results.
  2. Enabling or disabling typo tolerance and configuring its parameters to improve search accuracy.
  3. Setting synonyms to enhance search query matching by associating related terms.
  4. Configuring ranking rules to prioritize search results based on custom criteria.

Properties

Name Meaning
UID Name of the index to update settings for, selected from available indexes.
Displayed Attributes Fields displayed in the returned documents; defaults to all fields if unspecified.
Distinct Attribute Field used to return documents with distinct values in search results.
Filterable Attributes Fields that can be used in filters; no fields are filterable if unspecified.
Max Values Per Facet Maximum number of facet values to return for each facet during a search.
Max Total Hits Maximum number of hits to return for a search.
Ranking Rules List of ranking rules in order of importance to influence search result ordering.
Searchable Attributes Fields in which to search for matching query words, sorted by importance.
Sortable Attributes Attributes used when sorting search results.
Stop Words Words ignored by Meilisearch when present in search queries.
Typo Tolerance Enabled Whether to enable typo tolerance in search queries.
Min Word Size For One Typo Minimum word size to allow one typo in search queries.
Min Word Size For Two Typos Minimum word size to allow two typos in search queries.
Disable Typo Tolerance On Words Comma-separated list of words to disable typo tolerance on.
Disable Typo Tolerance On Attributes Comma-separated list of attributes to disable typo tolerance on.
Synonyms Groups of synonyms to enhance search query matching, each with a primary word and synonyms string.
Wait for Completion Whether to wait for the update task to complete before returning.
Use Exponential Backoff If waiting for completion, whether to use exponential backoff for polling intervals.
Polling Interval (ms) Fixed interval between polling requests in milliseconds, used if exponential backoff is disabled.
Initial Polling Interval (ms) Starting interval between polling requests in milliseconds, increases by 1.5x every 5 attempts if exponential backoff is enabled.
Max Polling Interval (ms) Maximum interval between polling requests when using exponential backoff.
Timeout (seconds) Maximum time to wait for task completion in seconds when waiting for completion.

Output

JSON

  • json
    • taskUid - Unique identifier of the update task.
    • status - Status of the update task (e.g., succeeded, failed, canceled).
    • details - Additional details about the task result or error if any.

Dependencies

  • Meilisearch API with authentication credentials

Troubleshooting

  • If the node times out waiting for task completion, increase the timeout setting or disable waiting for completion.
  • Ensure the UID of the index is correct and the index exists to avoid errors.
  • If the API returns errors, check the validity and format of the settings parameters, especially JSON strings like synonyms.
  • Network or authentication issues may cause request failures; verify API credentials and network connectivity.

Links

Discussion