Back to Genai Toolbox

firestore-delete-documents

docs/en/integrations/firestore/tools/firestore-delete-documents.md

1.1.01.1 KB
Original Source

About

A firestore-delete-documents tool deletes multiple documents from Firestore by their paths.

firestore-delete-documents takes one input parameter documentPaths which is an array of document paths to delete. The tool uses Firestore's BulkWriter for efficient batch deletion and returns the success status for each document.

Compatible Sources

{{< compatible-sources >}}

Example

yaml
kind: tool
name: delete_user_documents
type: firestore-delete-documents
source: my-firestore-source
description: Use this tool to delete multiple documents from Firestore.

Reference

fieldtyperequireddescription
typestringtrueMust be "firestore-delete-documents".
sourcestringtrueName of the Firestore source to delete documents from.
descriptionstringtrueDescription of the tool that is passed to the LLM.