Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

Document → Import

AI-generated

Overview

This node integrates with the Typesense search platform to import documents into a specified collection. It is useful for bulk uploading or updating documents in a Typesense collection, supporting various import actions like create, update, upsert, and emplace. Practical applications include syncing data from external sources into Typesense for search indexing or batch updating existing documents.

Use Case Examples

  1. Import a batch of product data into a Typesense collection for e-commerce search functionality.
  2. Update user profiles in a Typesense collection by importing JSONL formatted data with the 'update' action.
  3. Upsert documents to ensure new entries are created and existing ones updated in a Typesense collection.

Properties

Name Meaning
Collection Name Selects the target collection in the Typesense instance where documents will be imported.
Documents Data (JSONL) The documents to import, provided in JSONL (newline-delimited JSON) format, where each line is a valid JSON document.
Import Parameters Additional options to control the import behavior, including batch size, return options, action type, handling of dirty values, and remote embedding batch size.

Output

JSON

  • importResult - The response from the Typesense API after importing documents, which may include status, IDs, or documents depending on parameters.

Dependencies

  • Requires a Typesense API key credential to authenticate with the Typesense instance.

Troubleshooting

  • Ensure the collection name is correctly selected and exists in the Typesense instance to avoid errors loading collections.
  • Validate that the documents data is correctly formatted in JSONL format; invalid JSON lines will cause import failures.
  • Check the batch size parameter to avoid too large batches that might cause timeouts or memory issues.
  • If the node throws errors related to unsupported resources or operations, verify that the resource is set to 'Document' and operation to 'Import'.
  • Handle API errors gracefully by enabling 'Continue On Fail' if partial import success is acceptable.

Discussion