Actions50
- Collection Actions
- Document Actions
- Search Actions
- Analytics Actions
- API Key Actions
- Alias Actions
- Synonym Actions
- Override Actions
- Conversation Actions
Search → Search
AI-generatedOverview
This node performs search operations on a Typesense search platform collection. It allows users to execute detailed search queries with various options such as filtering, sorting, faceting, typo tolerance, ranking, highlighting, grouping, caching, and advanced search parameters. This node is useful for retrieving relevant search results from a Typesense collection based on complex search criteria, supporting use cases like product search, document retrieval, and data exploration.
Use Case Examples
- Search a product catalog collection for items matching a query string, filtering by price and sorting by popularity.
- Perform a faceted search on a document collection to retrieve documents matching keywords and grouped by categories.
- Use typo tolerance and ranking options to improve search result relevance in a customer support knowledge base.
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 in the collection schema to search within. 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 aggregation and grouping. |
| 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 query, such as number of typos allowed, token handling, and enabling/disabling typo tolerance. |
| 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 parameters like presets, stopwords, validation, conversation context, and search cutoff time. |
Output
JSON
results- Array of search result objects returned from the Typesense collection query.
Dependencies
- Typesense search platform API
- An API key credential for authentication
Troubleshooting
- Ensure the selected collection exists and is accessible in the Typesense instance.
- Verify that the API key credential is valid and has appropriate permissions.
- Check that the query and filter expressions are correctly formatted according to Typesense syntax.
- If no results are returned, try adjusting the queryBy fields or removing restrictive filters.
- For pagination issues, verify the page and limit parameters are within valid ranges.
Links
- Typesense Documentation - Official documentation for the Typesense search platform, including API reference and search query syntax.