Skip to content

SummaryBlock

Defined in: src/types/messages.ts:828

A summary of earlier conversation history that takes the summarized messages’ place.

Through an agent, a model without serverSideSummary, or one that did not write it (provider), gets the text.

new SummaryBlock(data): SummaryBlock;

Defined in: src/types/messages.ts:849

ParameterType
dataSummaryBlockData

SummaryBlock

readonly type: "summaryBlock";

Defined in: src/types/messages.ts:832

Discriminator for summary content.


readonly provider?: string;

Defined in: src/types/messages.ts:837

Name of the provider that wrote the summary server-side, for example 'anthropic'.

SummaryBlockData.provider


readonly signature?: string;

Defined in: src/types/messages.ts:842

Signature the provider returned with the summary, sent back unchanged.

SummaryBlockData.signature


readonly text: string;

Defined in: src/types/messages.ts:847

The summary text.

SummaryBlockData.text

toJSON(): {
summary: SummaryBlockData;
};

Defined in: src/types/messages.ts:859

Serializes the SummaryBlock to a JSON-compatible ContentBlockData object. Called automatically by JSON.stringify().

{
summary: SummaryBlockData;
}
NameTypeDefined in
summarySummaryBlockDatasrc/types/messages.ts:859

JSONSerializable.toJSON


static fromJSON(data): SummaryBlock;

Defined in: src/types/messages.ts:875

Creates a SummaryBlock instance from its wrapped data format.

ParameterTypeDescription
data{ summary: SummaryBlockData; }Wrapped SummaryBlockData to deserialize
data.summarySummaryBlockData-

SummaryBlock

SummaryBlock instance