Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

Search → Advanced Search

AI-generated

Overview

This node performs an advanced search operation on a specified collection within a Typesense instance. It allows users to execute complex search queries with various customizable parameters such as filtering, sorting, faceting, pagination, typo tolerance, ranking, highlighting, grouping, caching, and advanced search options. This node is beneficial for scenarios where precise and flexible search capabilities are required, such as searching large datasets, e-commerce product searches, or content discovery platforms.

Use Case Examples

  1. Searching a product catalog with filters on price and category, sorting by popularity, and highlighting matched terms.
  2. Performing a faceted search on a document collection to retrieve categorized results with pagination.
  3. Executing typo-tolerant searches to improve user experience in search interfaces.

Properties

Name Meaning
Collection Name Select a collection from your Typesense instance to search in.
Search Query The text query to search for in the selected collection.
Query By Fields within the collection to search in. Multiple fields can be selected.
Filter By Filter expression to narrow down search results (e.g., num_employees:>100).
Sort By Field to sort the search results by, with optional ascending or descending order.
Facet By Fields to facet the search results by, allowing categorization of results.
Return All Whether to return all matching results or limit the number of results.
Limit Maximum number of results to retrieve when Return All is false.
Page Page number for paginated results.
Include Fields Fields to include in the search results. If empty, all fields are included.
Exclude Fields Fields to exclude from the search results.
Typo Tolerance Options Settings to control typo tolerance behavior in the search, such as enabling typo tolerance, number of typos allowed, and token handling.
Ranking & Relevance Options to customize ranking and relevance of search results, including weights, exact match prioritization, synonyms, and overrides.
Highlighting Options to enable and customize highlighting of matched terms in the search results.
Faceting Options Settings to control faceting behavior, such as strategy, max facet values, and sampling.
Grouping Options Options to control grouping of search results, including handling of missing values.
Filter Options Settings related to filtering behavior, such as lazy filtering and max filter candidates.
Caching Options to enable caching of search results and set cache TTL (time to live).
Advanced Options Additional advanced search settings, including presets, stopwords, validation, conversation context, and search cutoff time.

Output

JSON

  • results - Array of search results matching the query and applied filters.
  • facets - Faceted data based on the specified facet fields.
  • found - Total number of results found for the query.
  • page - Current page number of the results.
  • per_page - Number of results per page.

Dependencies

  • Typesense API key credential for authentication with the Typesense instance.

Troubleshooting

  • Ensure the selected collection exists in the Typesense instance; otherwise, the node will return an error about missing collections.
  • Verify that the fields specified in 'Query By', 'Sort By', 'Facet By', 'Include Fields', and 'Exclude Fields' exist in the collection schema to avoid errors.
  • If the search query is empty or invalid, the node may return no results or an error; provide a valid search query string.
  • When using typo tolerance options, ensure the values are within allowed ranges to prevent unexpected behavior.
  • If pagination parameters are incorrect (e.g., page number less than 1), the node may return errors or empty results; use valid pagination values.

Links

Discussion