Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

Override → Create

AI-generated

Overview

This node operation creates an override in a Typesense collection. Overrides allow customizing search behavior by specifying rules that trigger the override, documents to include or exclude in search results, and additional options such as filtering, sorting, query replacement, and metadata. This is useful for tailoring search results based on specific queries or conditions, for example, promoting certain documents or filtering results dynamically.

Use Case Examples

  1. Create an override to promote specific documents when a user searches for a particular query.
  2. Exclude certain documents from search results based on a rule triggered by the search query.
  3. Replace the user's search query with a predefined query to improve search relevance.

Properties

Name Meaning
Collection Name Selects the Typesense collection where the override will be created.
Override ID Unique identifier for the override to be created.
JSON Input Determines whether the override configuration is provided as raw JSON or through structured fields.
Override (JSON) Raw JSON string defining the override configuration, used if JSON Input is true.
Rule Defines the search query and match type that trigger the override.
Includes Documents to explicitly include in search results, with specified positions.
Excludes Documents to exclude from search results.
Additional Options Optional parameters to further customize the override behavior, such as filtering, sorting, query replacement, token removal, curated hits filtering, metadata, and effective time range.

Output

JSON

  • overrideId - The unique identifier of the created override.
  • collection - The collection in which the override was created.
  • rule
    • query - The search query that triggers the override.
    • match - The match type for the query (exact or contains).
  • includes - List of documents included in the search results with their positions.
  • excludes - List of documents excluded from the search results.
  • additionalOptions
    • filter_by - Filter clause applied to matching queries.
    • sort_by - Sort clause applied to matching queries.
    • replace_query - Replacement query string.
    • remove_matched_tokens - Flag indicating if matched tokens are removed from the query.
    • filter_curated_hits - Flag indicating if filter conditions apply to curated records.
    • metadata - Custom metadata returned when the rule is triggered.
    • effective_from_ts - Unix timestamp when the override becomes active.
    • effective_to_ts - Unix timestamp when the override expires.

Dependencies

  • Typesense API key credential

Troubleshooting

  • Ensure the selected collection exists in your Typesense instance; otherwise, the node will fail to create the override.
  • Validate the JSON input if using raw JSON to avoid syntax errors that prevent override creation.
  • Check that the override ID is unique within the collection to avoid conflicts.
  • If the node throws errors related to unsupported resources or operations, verify that the resource is set to 'Override' and operation to 'Create'.
  • Network or authentication issues with the Typesense API key credential can cause failures; verify credentials and connectivity.

Links

Discussion