Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

Document → Search

AI-generated

Overview

This node performs a search operation on a specified collection within a Typesense instance. It allows users to query documents based on search text, filter results, sort them, and paginate through them. The node supports advanced search features such as faceting, including or excluding specific fields in the results, and returning all or a limited number of documents. This is useful for applications that require full-text search capabilities, filtering, and sorting of large datasets stored in Typesense collections, such as product catalogs, document repositories, or user data.

Use Case Examples

  1. Searching a product catalog collection for items matching a search term across multiple fields, filtering by price range, sorting by popularity, and retrieving paginated results.
  2. Querying a document collection to find records matching specific keywords, faceting results by categories, and including only relevant fields in the output.

Properties

Name Meaning
Collection Name Selects the collection from the Typesense instance to search in.
Search Query The text query to search for in the selected collection.
Query By Specifies the fields within the collection to search in. Multiple fields can be selected.
Filter By A 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 the search results by, allowing aggregation and categorization.
Return All Determines whether to return all matching documents or limit the number of results.
Limit Maximum number of documents 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.

Output

JSON

  • results - Array of documents matching the search query with their fields and metadata.
  • facet_counts - Aggregated counts for the specified facet fields.
  • found - Total number of documents found matching the query.
  • page - Current page number of the search results.
  • request_params - Parameters used in the search request for reference.

Dependencies

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

Troubleshooting

  • Ensure the collection name is correctly selected and exists in the Typesense instance to avoid errors loading collections or fields.
  • Verify that the search query and filter expressions are correctly formatted to prevent search failures.
  • If no fields are selected in 'Query By', the search may not return expected results; select appropriate fields to search in.
  • Pagination parameters such as 'Page' and 'Limit' should be within valid ranges to avoid errors or empty results.

Links

  • Typesense Documentation - Official documentation for the Typesense search platform, including API references and usage guides.

Discussion