Meilisearch FacetSearch

Meilisearch FacetSearch

Certified

Search facets in Meilisearch

Runs a facet search on a Meilisearch index and writes the facet hits to an .ion file in Kestra storage. Facet attributes must be configured as filterable in the index settings; filters default to none.

yaml
type: io.kestra.plugin.meilisearch.FacetSearch

Sample facet search

yaml
id: meilisearch_facet_search_flow
namespace: company.team

variables:
  index: movies
  facetQuery: fiction
  facetName: genre
  host: http://172.18.0.3:7700/

tasks:
  - id: facet_search_documents
    type: io.kestra.plugin.meilisearch.FacetSearch
    index: "{{ vars.index }}"
    facetQuery: "{{ vars.facetQuery }}"
    facetName: "{{ vars.facetName }}"
    filters:
      - "rating > 3"
    url: "{{ vars.host }}"
    key: "{{ secret('MEILISEARCH_MASTER_KEY') }}"

  - id: to_json
    type: io.kestra.plugin.serdes.json.IonToJson
    from: "{{ outputs.facet_search_documents.uri }}"
Properties

Facet name

Facet attribute configured as filterable (e.g., facetName "genre" on a film index).

Index

Name of the Meilisearch index to search.

Meilisearch connection key

Meilisearch connection URL

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Facet query

Query string applied to the specified facet; optional.

SubTypestring
Default[]

Filters

List of Meilisearch filters applied to the facet search; defaults to an empty list.

Total hits

Number of facet hits returned by the request.

Formaturi

Output URI

URI in Kestra storage to the .ion file with facet search results.