API/behavior changes

indexingFragments parameter

The new indexingFragments embedder setting is available for embedders with source rest.

It is an object whose keys can be freely chosen by the user, and values are “indexing request fragment” objects.

When processing a document, Meilisearch assembles the request fragments for that document, and when enough request fragments have been assembled, send a request to the remote embedder.

When indexingFragments is present and non-null, then the following changes occur:

1. documentTemplate must be absent or null, otherwise an error is raised.
2. request should not use the "{{text}}" placeholder, but rather the "{{fragment}}" placeholder, standing for the various fragments being assembled.

searchFragment parameter

The new searchFragments embedder setting is available for embedders with source rest.

It is an object whose keys can be freely chosen by the user, and values are “search request fragment” objects.

When processing a search, Meilisearch finds a matching request fragment for that search query, and send a request to the remote embedder.

The request fragment object

A request fragment is a JSON object with the following fields:

• value: an arbitrary JSON value that must match the part (fragment) of a request to the remote REST embedder describing one input to embed.
  • Several of such fragments are assembled in a single request to the embedder.
  • Required without a default value.
  • Each string value inside this JSON value is interpreted as a liquid template that is rendered with the following context, depending on whether the fragment is in indexingFragments or in searchFragments:
    • In indexingFragments :
      • {{doc.attribute}} is replaced by the content of the field attribute in the document at indexing time. The fragment cannot be generated at search time.
    • in searchFragments:
      • {{q}} is replaced by the content of the q field at search time. The fragment cannot be generated at indexing time.
      • {{media.attribute}} is replaced by the content of the field attribute in the media search query. The fragment cannot be generated at indexing time.
    • As this is a liquid template, any of the filters available in liquid templates are also available here.
    • If the liquid template does not render for some reason (such as a missing field), then the corresponding fragment will not be generated for that document or media search query.

media search query parameter

Search queries can now contain an additional media parameter.

• This parameter is either null or a JSON object with arbitrary keys.