Package com.google.adk.artifacts

Interface BaseArtifactService

All Known Implementing Classes:
GcsArtifactService, InMemoryArtifactService
public interface BaseArtifactService
Base interface for artifact services.

  • Method Details

    • saveArtifact

      io.reactivex.rxjava3.core.Single<Integer> saveArtifact(String appName, String userId, String sessionId, String filename, com.google.genai.types.Part artifact)
      Saves an artifact.
      Parameters:
      appName - the app name
      userId - the user ID
      sessionId - the session ID
      filename - the filename
      artifact - the artifact
      Returns:
      the revision ID (version) of the saved artifact.

    • saveAndReloadArtifact

      default io.reactivex.rxjava3.core.Single<com.google.genai.types.Part> saveAndReloadArtifact(String appName, String userId, String sessionId, String filename, com.google.genai.types.Part artifact)
      Saves an artifact and returns it with fileData if available.

      Implementations should override this default method for efficiency, as the default performs two I/O operations (save then load).

      Parameters:
      appName - the app name
      userId - the user ID
      sessionId - the session ID
      filename - the filename
      artifact - the artifact to save
      Returns:
      the saved artifact with fileData if available.

    • loadArtifact

      io.reactivex.rxjava3.core.Maybe<com.google.genai.types.Part> loadArtifact(String appName, String userId, String sessionId, String filename, Optional<Integer> version)
      Gets an artifact.
      Parameters:
      appName - the app name
      userId - the user ID
      sessionId - the session ID
      filename - the filename
      version - Optional version number. If null, loads the latest version.
      Returns:
      the artifact or empty if not found

    • listArtifactKeys

      io.reactivex.rxjava3.core.Single<ListArtifactsResponse> listArtifactKeys(String appName, String userId, String sessionId)
      Lists all the artifact filenames within a session.
      Parameters:
      appName - the app name
      userId - the user ID
      sessionId - the session ID
      Returns:
      the list artifact response containing filenames

    • deleteArtifact

      io.reactivex.rxjava3.core.Completable deleteArtifact(String appName, String userId, String sessionId, String filename)
      Deletes an artifact.
      Parameters:
      appName - the app name
      userId - the user ID
      sessionId - the session ID
      filename - the filename

    • listVersions

      io.reactivex.rxjava3.core.Single<com.google.common.collect.ImmutableList<Integer>> listVersions(String appName, String userId, String sessionId, String filename)
      Lists all the versions (as revision IDs) of an artifact.
      Parameters:
      appName - the app name
      userId - the user ID
      sessionId - the session ID
      filename - the artifact filename
      Returns:
      A list of integer version numbers.