How to implement 'delete_artifact'

[RoystonDAlmeida]

Please mention a code snippet for 'delete_artifact'. The documentation link Google ADK Artifacts does not have any implementation of 'delete_artifact'

[hangfei]

@adk-bot

[hangfei]

@polong-lin @joefernandez to see if we can add some documentation around this.

[adk-bot]

Response from ADK Answering Agent (experimental, answer may be inaccurate)

TLDR: The delete_artifact function is a method of the ArtifactService and is not directly exposed through the ToolContext in the same way as save_artifact and load_artifact.

---

Hello! You are correct that the documentation you linked does not contain a code snippet for delete_artifact in the context of agent tool code. [4] This is because the ToolContext object, which provides methods like save_artifact and load_artifact for use within tools, does not currently expose a delete_artifact method.

The delete_artifact method is part of the BaseArtifactService interface and its implementations (e.g., FileArtifactService, GcsArtifactService). [1] You can see its signature in the source code:

async def delete_artifact(
    self, *, app_name: str, user_id: str, filename: str, session_id: Optional[str] = None
) -> None:

This method can be called on an instance of an artifact service. For example, internal tests use it like this: [2]

await artifact_service.delete_artifact(
    app_name="test_app",
    user_id="test_user",
    session_id="test_session",
    filename="test.txt",
)

Additionally, the ADK web server exposes this functionality through a REST API endpoint. A DELETE request to /apps/{app_name}/users/{user_id}/sessions/{session_id}/artifacts/{artifact_name} will trigger the delete_artifact method on the configured artifact service. [3]

While you cannot call delete_artifact directly from the ToolContext, you could interact with the ArtifactService directly if your environment allows it, or by making an HTTP request to the ADK web server's REST API endpoint.

---

[1] https://github.com/google/adk-python/blob/main/src/google/adk/artifacts/base_artifact_service.py
[2] https://github.com/google/adk-python/blob/main/tests/unittests/artifacts/test_artifact_service.py
[3] https://github.com/google/adk-python/blob/main/src/google/adk/cli/adk_web_server.py
[4] https://google.github.io/adk-docs/artifacts/

[adk-bot]

Response from ADK Answering Agent (experimental, answer may be inaccurate)

TLDR: The delete_artifact method is part of the ArtifactService but is not exposed through the CallbackContext or ToolContext. Therefore, it cannot be called directly from an agent's tool.

---

Hello! I've looked into your question about implementing delete_artifact.

Currently, the ADK's CallbackContext and ToolContext provide methods for save_artifact and load_artifact, but there is no direct way to call delete_artifact from within an agent's tool or callback. [1]

The delete_artifact method is defined in the BaseArtifactService interface, which is responsible for managing the lifecycle of artifacts. The InMemoryArtifactService provides a concrete implementation of this method. [2] However, this functionality is not exposed to the agent through the context objects.

This means that while the underlying artifact management system has the capability to delete artifacts, this operation is not intended to be performed directly by the agent's application logic.

For more details, you can refer to the InMemoryArtifactService implementation:

• InMemoryArtifactService: This class provides an in-memory implementation of the ArtifactService and includes the delete_artifact method. You can view the source code for this implementation [2].

I hope this clarifies the current capabilities of the ADK regarding artifact management from within an agent.

---

[1] https://google.github.io/adk-docs/artifacts/
[2] https://github.com/google/adk-python/blob/main/src/google/adk/artifacts/in_memory_artifact_service.py

[sanketpatil06]

Hoping this issue is resolved, marking it as closed. Please feel free reach out for any further issue.