adk-typescript/dist/artifacts/BaseArtifactService.d.ts

TypeScript port of Google's Agent Development Kit (ADK)

import { Part } from '../models/types';
/**
 * Parameters for artifact operations.
 */
export interface ArtifactParams {
    /** The application name */
    appName: string;
    /** The user ID */
    userId: string;
    /** The session ID */
    sessionId: string;
    /** The filename of the artifact */
    filename: string;
    /** The version of the artifact (for load operations) */
    version?: number;
    /** The artifact content (for save operations) */
    artifact?: Part;
}
/**
 * Interface for artifact services.
 * Artifact services provide functionality to store and retrieve artifacts.
 */
export interface BaseArtifactService {
    /**
     * Loads an artifact.
     *
     * @param params The artifact parameters
     * @returns The loaded artifact, or undefined if not found
     */
    loadArtifact(params: ArtifactParams): Part | undefined | Promise<Part | undefined>;
    /**
     * Saves an artifact.
     *
     * @param params The artifact parameters
     * @returns The version of the saved artifact
     */
    saveArtifact(params: ArtifactParams): number | Promise<number>;
    /**
     * Deletes an artifact.
     *
     * @param params The artifact parameters
     * @returns A promise that resolves when the operation is complete
     */
    deleteArtifact(params: ArtifactParams): Promise<void>;
    /**
     * Lists all the artifact filenames within a session.
     *
     * @param params The artifact parameters
     * @returns A list of all artifact filenames within a session
     */
    listArtifactKeys(params: ArtifactParams): string[] | Promise<string[]>;
    /**
     * Lists all versions of an artifact.
     *
     * @param params The artifact parameters
     * @returns A list of all available versions of the artifact
     */
    listVersions(params: ArtifactParams): number[] | Promise<number[]>;
}