Typesense icon

Typesense

Interact with the Typesense search platform

Search → Multi Search

AI-generated

Overview

This node performs a multi-search operation across multiple collections in a Typesense search platform. It allows users to specify multiple collections to search within, define search queries, filter and sort results, and customize search behavior with options like typo tolerance, ranking, highlighting, faceting, grouping, caching, and advanced search parameters. This node is useful for scenarios where comprehensive search results are needed from multiple data collections, such as searching product catalogs, document repositories, or customer databases simultaneously.

Use Case Examples

  1. A user wants to search for a product name across multiple product collections to get aggregated search results.
  2. A business needs to perform a multi-collection search to find relevant documents matching a query with specific filters and sorting criteria.

Properties

Name Meaning
Collections Comma-separated list of collection names for multi-search. Specifies which collections to search across.
Search Query The text query to search for. This is a required field for the search operation.
Query By Fields within the collections to search in. Multiple fields can be selected from the collection schema.
Filter By Filter expression to narrow down search results based on field values.
Sort By Field to sort the search results by, with optional ascending or descending order.
Facet By Fields to facet by, allowing aggregation of search results by these fields.
Return All Boolean flag to return all 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 query, such as enabling typo tolerance, number of typos allowed, and token handling.
Ranking & Relevance Options to customize ranking and relevance of search results, including query weights, text match type, prioritization, pinned/hidden hits, synonyms, and exhaustive search.
Highlighting Options to enable and customize highlighting of matched terms in the search results.
Faceting Options Settings to control faceting behavior, such as facet strategy, max facet values, and facet query parameters.
Grouping Options Options to control grouping of search results, such as grouping missing values.
Filter Options Settings to enable lazy filtering and limit filter candidates.
Caching Options to enable caching of search results and set cache TTL (time to live).
Advanced Options Additional advanced search parameters like preset, stopwords, validation, conversation context, and search cutoff time.

Output

JSON

  • results - Array of search results from the multi-search operation, containing matched documents and metadata.

Dependencies

  • Requires a Typesense API key credential to authenticate and interact with the Typesense search platform.

Troubleshooting

  • Common issues include invalid collection names or fields, resulting in errors when loading collections or fields.
  • Errors may occur if the search query is missing or malformed.
  • Network or authentication errors can happen if the Typesense API key is invalid or missing.
  • To resolve errors, ensure collections and fields exist, the query is valid, and credentials are correctly configured.

Links

  • Typesense Documentation - Official documentation for the Typesense search platform, useful for understanding search parameters and API usage.

Discussion