Overview

This node interacts with the Typesense search platform, specifically supporting operations on various resources including documents. For the Document resource with the Delete operation, it deletes a specified document from a selected collection in a Typesense instance. This is useful for managing and maintaining the data within your search collections by removing outdated or unwanted documents.

Use Case Examples

1. Deleting a document by its ID from a specific collection to keep the search index up to date.
2. Removing a document that is no longer relevant or contains incorrect information from a Typesense collection.

Properties

Output

JSON

• deletedDocument - Details or confirmation of the deleted document returned from the Typesense API.

Dependencies

• Requires an API key credential for authenticating with the Typesense instance.

Troubleshooting

• Ensure the collection name is correctly selected and exists in the Typesense instance; otherwise, the deletion will fail.
• Verify the document ID is correct and exists in the specified collection to avoid errors indicating the document was not found.
• Common error messages include resource not supported if an invalid resource is selected, or API errors if authentication fails or the Typesense service is unreachable.

Links

• Typesense Documentation - Official documentation for the Typesense search platform, useful for understanding collections, documents, and API operations.