ESC
Ask Kestra AI
ESC
Kestra AI

Hi! I'm your Kestra AI assistant.
Ask me anything about workflows.

EXAMPLE QUESTIONS

How to deploy Kestra inside Kubernetes?
What is a task runner?
How to handle errors & retry on flow?

Typesense FacetSearch

Typesense FacetSearch

Certified

Search with facets in Typesense

Performs a search and computes facet counts on the specified fields.

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

Search documents with facet

yaml
id: typesense_facet_search
namespace: company.team

tasks:
  - id: facet_search
    type: io.kestra.plugin.typesense.FacetSearch
    apiKey: "{{ secret('TYPESENSE_API_KEY') }}"
    port: 8108
    host: localhost
    collection: Countries
    query: Paris
    queryBy: capital
    filter: "countryName: [France, England]"
    sortBy: "gdp:desc"
    facetBy: gdp
Properties

Typesense API key

Admin or search key used for this request; must allow access to the target collection

Collection name

Name of the Typesense collection; value is rendered before each call

Facet fields

Comma-separated list passed to facet_by to compute facet counts.

Typesense host

Hostname or IP address of the Typesense cluster node or load balancer

Typesense port

TCP port for the Typesense HTTP API; 8108 is the Typesense default

Search query

Free-text query string sent as q to Typesense. Required.

Query fields

Comma-separated collection fields used for query_by. Order matters for tie-breaking.

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

Filter expression

Optional filter_by clause to pre-filter results.

Use HTTPS

Default false (HTTP). Set to true to call Typesense over HTTPS/TLS

Sort expression

Optional sort_by clause. Example: gdp: desc.

Hit count

Number of documents returned by Typesense for this search.

Formaturi

Results URI

Storage URI of the Amazon ION results file.

More Plugins in this Category

Scrapy CLI
Scrapy CLI

Tasks that run Scrapy spiders and CLI commands to scrape data from websites.

Data

1 tasks

Supabase
Supabase

Tasks that call Supabase APIs for data and storage operations.

Data

5 tasks