Back to Genai Toolbox

cloud-storage-delete-object

docs/en/integrations/cloud-storage/tools/cloud-storage-delete-object.md

1.2.01.8 KB
Original Source

About

A cloud-storage-delete-object tool deletes a single object from a Cloud Storage bucket.

Compatible Sources

{{< compatible-sources >}}

Requirements

The Cloud Storage credentials must be able to delete the target object.

Parameters

parametertyperequireddescription
bucketstringtrueName of the Cloud Storage bucket containing the object to delete.
objectstringtrueFull object name (path) within the bucket, e.g. path/to/file.txt.

Example

yaml
kind: tool
name: delete_object
type: cloud-storage-delete-object
source: my-gcs-source
description: Use this tool to delete Cloud Storage objects.

Output Format

The tool returns a JSON object with:

fieldtypedescription
bucketstringCloud Storage bucket containing the object.
objectstringCloud Storage object name that was deleted.
deletedbooleanWhether the delete request completed.

Reference

fieldtyperequireddescription
typestringtrueMust be "cloud-storage-delete-object".
sourcestringtrueName of the Cloud Storage source to delete objects in.
descriptionstringtrueDescription of the tool that is passed to the LLM.