ADK for TypeScript: API Reference
    Preparing search index...

    Interface CompactedEvent

    A specialized Event type that represents a synthesized summary of past events. This is used to compress session history without losing critical context.

    interface CompactedEvent {
        actions: EventActions;
        author?: string;
        branch?: string;
        citationMetadata?: CitationMetadata;
        compactedContent: string;
        content?: Content;
        customMetadata?: { [key: string]: unknown };
        endTime: number;
        errorCode?: string;
        errorMessage?: string;
        finishReason?: FinishReason;
        goAway?: LiveServerGoAway;
        groundingMetadata?: GroundingMetadata;
        id: string;
        inputTranscription?: Transcription;
        interactionId?: string;
        interrupted?: boolean;
        invocationId: string;
        isCompacted: true;
        isScratchpad?: boolean;
        liveSessionId?: string;
        liveSessionResumptionUpdate?: LiveServerSessionResumptionUpdate;
        longRunningToolIds?: string[];
        modelVersion?: string;
        outputTranscription?: Transcription;
        partial?: boolean;
        startTime: number;
        timestamp: number;
        turnComplete?: boolean;
        usageMetadata?: GenerateContentResponseUsageMetadata;
    }

    Hierarchy (View Summary)

    Properties

    actions: EventActions

    The actions taken by the agent.

    author?: string

    "user" or the name of the agent, indicating who appended the event to the session.

    branch?: string

    The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3.

    Branch is used when multiple sub-agent shouldn't see their peer agents' conversation history.

    citationMetadata?: CitationMetadata

    The citation metadata of the response.

    compactedContent: string

    The summarized content of the compacted events.

    Optionalcontent

    content?: Content

    The content of the response.

    customMetadata?: { [key: string]: unknown }

    The custom metadata of the LlmResponse. An optional key-value pair to label an LlmResponse. NOTE: the entire object must be JSON serializable.

    endTime: number

    The end time of the context that was compacted.

    errorCode?: string

    Error code if the response is an error. Code varies by model.

    errorMessage?: string

    Error message if the response is an error.

    finishReason?: FinishReason

    The finish reason of the response.

    goAway?: LiveServerGoAway

    Server-side signal that the live connection will be closed soon. The caller should reconnect using the latest session resumption handle.

    groundingMetadata?: GroundingMetadata

    The grounding metadata of the response.

    id: string

    The unique identifier of the event. Do not assign the ID. It will be assigned by the session.

    inputTranscription?: Transcription

    Audio transcription of user input.

    interactionId?: string

    The interaction ID returned by the model, if any.

    interrupted?: boolean

    Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.

    invocationId: string

    The invocation ID of the event. Should be non-empty before appending to a session.

    isCompacted: true

    Identifies this event as a compacted event.

    isScratchpad?: boolean

    Identifies this compacted event as the persistent context scratchpad.

    liveSessionId?: string

    The session ID of the Live session.

    liveSessionResumptionUpdate?: LiveServerSessionResumptionUpdate

    The session resumption update of the LlmResponse

    longRunningToolIds?: string[]

    Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event

    modelVersion?: string

    The model version used to generate the response.

    outputTranscription?: Transcription

    Audio transcription of model output.

    partial?: boolean

    Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.

    startTime: number

    The start time of the context that was compacted.

    timestamp: number

    The timestamp of the event.

    turnComplete?: boolean

    Indicates whether the response from the model is complete. Only used for streaming mode.

    usageMetadata?: GenerateContentResponseUsageMetadata

    The usage metadata of the LlmResponse.

    Properties