CachePointBlock
Defined in: src/types/messages.ts:556
Cache point block for prompt caching. Marks a position in a message or system prompt where caching should occur.
Implements
Section titled “Implements”CachePointBlockDataJSONSerializable<{cachePoint:CachePointBlockData; }>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CachePointBlock(data): CachePointBlock;Defined in: src/types/messages.ts:573
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | CachePointBlockData |
Returns
Section titled “Returns”CachePointBlock
Properties
Section titled “Properties”readonly type: "cachePointBlock";Defined in: src/types/messages.ts:560
Discriminator for cache point.
cacheType
Section titled “cacheType”readonly cacheType: "default";Defined in: src/types/messages.ts:565
The cache type. Currently only ‘default’ is supported.
Implementation of
Section titled “Implementation of”readonly optional ttl?: string;Defined in: src/types/messages.ts:571
Optional TTL for the cache entry. See CachePointBlockData.ttl for the provider-specific value space.
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”toJSON()
Section titled “toJSON()”toJSON(): { cachePoint: CachePointBlockData;};Defined in: src/types/messages.ts:584
Serializes the CachePointBlock to a JSON-compatible ContentBlockData object. Called automatically by JSON.stringify().
Returns
Section titled “Returns”{ cachePoint: CachePointBlockData;}| Name | Type | Defined in |
|---|---|---|
cachePoint | CachePointBlockData | src/types/messages.ts:584 |
Implementation of
Section titled “Implementation of”JSONSerializable.toJSONfromJSON()
Section titled “fromJSON()”static fromJSON(data): CachePointBlock;Defined in: src/types/messages.ts:599
Creates a CachePointBlock instance from its wrapped data format.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
data | { cachePoint: CachePointBlockData; } | Wrapped CachePointBlockData to deserialize |
data.cachePoint | CachePointBlockData | - |
Returns
Section titled “Returns”CachePointBlock
CachePointBlock instance