Typesense Search

Typesense Search

Certified

Search documents in Typesense

Runs a full-text/queryBy search on a collection and stores the results as an Amazon ION file in internal storage.

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

Search documents

yaml
id: typesense_search
namespace: company.team

tasks:
  - id: search
    type: io.kestra.plugin.typesense.Search
    apiKey: "{{ secret('TYPESENSE_API_KEY') }}"
    port: 8108
    host: localhost
    collection: Countries
    query: Paris
    queryBy: capital
    filter: "countryName: [France, England]"
    sortBy: "gdp:desc"
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

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.

Filter expression

Optional filter_by clause to pre-filter results.

Use HTTPS

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

Reference (ref) of the pluginDefaults to apply to this task.

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

Dataform
Dataform

Tasks that run Dataform data transformations through the Dataform CLI.

Data

1 tasks

6 blueprints

Pinecone
Pinecone

Interact with Pinecone, a managed vector database, from your Kestra workflows. Create serverless indexes, upsert vectors, query by similarity, fetch or delete vectors by ID, and inspect index statistics.

AIData

7 tasks

6 blueprints