e04ed9c211
CF: Deploy Dev Docs / deploy (push) Has been cancelled
Sync Labels / build (push) Has been cancelled
tests / unit tests (macos-latest) (push) Has been cancelled
tests / unit tests (windows-latest) (push) Has been cancelled
tests / unit tests (ubuntu-latest) (push) Has been cancelled
2.4 KiB
2.4 KiB
title, type, weight, description
| title | type | weight | description |
|---|---|---|---|
| cloud-storage-delete-object | docs | 10 | A "cloud-storage-delete-object" tool deletes a Cloud Storage object. |
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
| parameter | type | required | description |
|---|---|---|---|
| bucket | string | true | Name of the Cloud Storage bucket containing the object to delete. |
| object | string | true | Full object name (path) within the bucket, e.g. path/to/file.txt. |
If bucket is configured on the tool, it is removed from the parameter list and
the configured bucket is used for every invocation.
Example
kind: tool
name: delete_object
type: cloud-storage-delete-object
source: my-gcs-source
description: Use this tool to delete Cloud Storage objects.
kind: tool
name: delete_reports
type: cloud-storage-delete-object
source: my-gcs-source
description: Use this tool to delete report objects from Cloud Storage.
bucket: analytics-exports
Output Format
The tool returns a JSON object with:
| field | type | description |
|---|---|---|
| bucket | string | Cloud Storage bucket containing the object. |
| object | string | Cloud Storage object name that was deleted. |
| deleted | boolean | Whether the delete request completed. |
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be "cloud-storage-delete-object". |
| source | string | true | Name of the Cloud Storage source to delete objects in. |
| description | string | true | Description of the tool that is passed to the LLM. |
| bucket | string | false | Cloud Storage bucket to use for every invocation. When set, bucket is hidden from the tool parameters. |