Typesense FacetSearch
CertifiedSearch with facets in Typesense
Typesense FacetSearch
Search with facets in Typesense
Performs a search and computes facet counts on the specified fields.
type: io.kestra.plugin.typesense.FacetSearchExamples
Search documents with facet
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
apiKey *Requiredstring
Typesense API key
Admin or search key used for this request; must allow access to the target collection
collection *Requiredstring
Collection name
Name of the Typesense collection; value is rendered before each call
facetBy *Requiredstring
Facet fields
Comma-separated list passed to facet_by to compute facet counts.
host *Requiredstring
Typesense host
Hostname or IP address of the Typesense cluster node or load balancer
port *Requiredstring
Typesense port
TCP port for the Typesense HTTP API; 8108 is the Typesense default
query *Requiredstring
Search query
Free-text query string sent as q to Typesense. Required.
queryBy *Requiredstring
Query fields
Comma-separated collection fields used for query_by. Order matters for tie-breaking.
filter string
Filter expression
Optional filter_by clause to pre-filter results.
https booleanstring
Use HTTPS
Default false (HTTP). Set to true to call Typesense over HTTPS/TLS
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
sortBy string
Sort expression
Optional sort_by clause. Example: gdp: desc.
Outputs
totalHits integer
Hit count
Number of documents returned by Typesense for this search.
uri string
uriResults URI
Storage URI of the Amazon ION results file.
