Skip to content
AgentsKit

@agentskit/memory β€” Interfaces

API interfaces for @agentskit/memory.

#Interface: AgentskitMemoryStore

Defined in: packages/memory/src/kv-store-types.ts:10

Minimal KV store contract.

#Properties

#id

readonly id: string | undefined

Defined in: packages/memory/src/kv-store-types.ts:11

#Methods

#get()

get(key): Promise<unknown>

Defined in: packages/memory/src/kv-store-types.ts:12

#Parameters

key

string

#Returns

Promise<unknown>


#set()

set(key, value): Promise<void>

Defined in: packages/memory/src/kv-store-types.ts:13

#Parameters

key

string

value

unknown

#Returns

Promise<void>


#Interface: ChatMemoryRedactionOptions

Defined in: packages/memory/src/redaction.ts:36

Rules, mode, and token vault settings for chat-memory redaction.

#Extended by

#Properties

#allowedRoles?

optional allowedRoles?: string[]

Defined in: packages/memory/src/redaction.ts:47

Roles allowed to reveal β€” required when mode === 'tokenize'.


#audit?

optional audit?: RedactionAuditSink

Defined in: packages/memory/src/redaction.ts:49

Optional audit sink threaded into the vault tokenize() calls.


#mode?

optional mode?: RedactionMode

Defined in: packages/memory/src/redaction.ts:43


#rules

rules: PIIRule[]

Defined in: packages/memory/src/redaction.ts:42

Rules to apply. Pass DEFAULT_PII_RULES for the baseline set, compilePIITaxonomy(json) for a custom JSON taxonomy, or any hand-rolled PIIRule[]. Same shape as createPIIRedactor.


#vault?

optional vault?: RedactionVault

Defined in: packages/memory/src/redaction.ts:45

Required when mode === 'tokenize'.


#Interface: ChromaConfig

Defined in: packages/memory/src/vector/chroma.ts:6

URL, optional API key, and collection settings for Chroma.

#Extends

#Properties

#apiKey?

optional apiKey?: string

Defined in: packages/memory/src/vector/chroma.ts:15

Chroma token sent through the x-chroma-token header.


#collection

collection: string

Defined in: packages/memory/src/vector/chroma.ts:9


#database?

optional database?: string

Defined in: packages/memory/src/vector/chroma.ts:13

Chroma database. Defaults to default_database.


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/memory/src/vector/http.ts:10

Fetch implementation for remote vector calls. Defaults to globalThis.fetch.

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Example

qdrant({ url, collection: 'docs', fetch: globalThis.fetch })

#Inherited from

RemoteHttpConfig.fetch


#headers?

optional headers?: Record<string, string>

Defined in: packages/memory/src/vector/chroma.ts:17

Additional headers for hosted or proxied Chroma deployments.


#maxResponseBytes?

optional maxResponseBytes?: number

Defined in: packages/memory/src/vector/http.ts:22

Maximum response body size in bytes. Defaults to 2 MiB and must be a positive safe integer. Overflow rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', maxResponseBytes: 1_000_000 })

#Inherited from

RemoteHttpConfig.maxResponseBytes


#signal?

optional signal?: AbortSignal

Defined in: packages/memory/src/vector/http.ts:24

Caller-owned signal relayed to remote requests.

#Inherited from

RemoteHttpConfig.signal


#tenant?

optional tenant?: string

Defined in: packages/memory/src/vector/chroma.ts:11

Chroma tenant. Defaults to default_tenant.


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/memory/src/vector/http.ts:16

Request timeout in milliseconds. Defaults to 15_000; must be a positive safe integer. Expiry rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', timeoutMs: 5_000 })

#Inherited from

RemoteHttpConfig.timeoutMs


#topK?

optional topK?: number

Defined in: packages/memory/src/vector/chroma.ts:18


#url

url: string

Defined in: packages/memory/src/vector/chroma.ts:8

Base URL of a running Chroma HTTP server.


#Interface: CreateKvMemoryFromConfigOpts

Defined in: packages/memory/src/kv-store-factory.ts:54

Options and injected drivers for creating a configured KV memory store.

#Properties

#config

readonly config: KvMemoryConfig

Defined in: packages/memory/src/kv-store-factory.ts:55


#embedder?

readonly optional embedder?: MemoryEmbedderLike

Defined in: packages/memory/src/kv-store-factory.ts:60


#localStorageFilePath?

readonly optional localStorageFilePath?: string

Defined in: packages/memory/src/kv-store-factory.ts:57


#redis?

readonly optional redis?: RedisLike

Defined in: packages/memory/src/kv-store-factory.ts:58


#sqlite?

readonly optional sqlite?: SqliteOpener

Defined in: packages/memory/src/kv-store-factory.ts:56


#vectorStore?

readonly optional vectorStore?: MemoryVectorStoreLike

Defined in: packages/memory/src/kv-store-factory.ts:59


#Interface: CreateLocalStorageStoreOpts

Defined in: packages/memory/src/kv-store-basic.ts:127

Options for creating a browser local-storage or file fallback store.

#Properties

#config

readonly config: LocalStorageKvConfig

Defined in: packages/memory/src/kv-store-basic.ts:128


#filePath?

readonly optional filePath?: string

Defined in: packages/memory/src/kv-store-basic.ts:130


#storage?

readonly optional storage?: LocalStorageLike

Defined in: packages/memory/src/kv-store-basic.ts:129


#Interface: CreateRedisStoreOpts

Defined in: packages/memory/src/kv-store-redis.ts:12

Redis store settings and injected Redis client.

#Properties

#client

readonly client: RedisLike

Defined in: packages/memory/src/kv-store-redis.ts:14


#config

readonly config: RedisKvConfig

Defined in: packages/memory/src/kv-store-redis.ts:13


#Interface: CreateSqliteStoreOpts

Defined in: packages/memory/src/kv-store-sqlite.ts:13

SQLite store settings and injected database opener.

#Properties

#config

readonly config: SqliteKvConfig

Defined in: packages/memory/src/kv-store-sqlite.ts:14


#open

readonly open: SqliteOpener

Defined in: packages/memory/src/kv-store-sqlite.ts:15


#Interface: CreateVectorStoreOpts

Defined in: packages/memory/src/kv-store-vector.ts:15

Dependencies for creating a vector-backed key-value store.

#Properties

#config

readonly config: VectorKvConfig

Defined in: packages/memory/src/kv-store-vector.ts:16


#embedder

readonly embedder: MemoryEmbedderLike

Defined in: packages/memory/src/kv-store-vector.ts:18


#vectorStore

readonly vectorStore: MemoryVectorStoreLike

Defined in: packages/memory/src/kv-store-vector.ts:17


#Interface: EncryptedEnvelope

Defined in: packages/memory/src/encrypted.ts:32

Base64 ciphertext, initialization vector, and content-length marker.

#Properties

#ciphertext

ciphertext: string

Defined in: packages/memory/src/encrypted.ts:33


#iv

iv: string

Defined in: packages/memory/src/encrypted.ts:34


#length

length: number

Defined in: packages/memory/src/encrypted.ts:36

Plaintext-length marker so the agent sees a non-empty content hint.


#Interface: EncryptedMemoryOptions

Defined in: packages/memory/src/encrypted.ts:19

Backing memory, encryption key, and optional Web Crypto adapters.

#Properties

#aad?

optional aad?: Uint8Array<ArrayBufferLike>

Defined in: packages/memory/src/encrypted.ts:28

Optional AAD β€” content that binds ciphertext to context (user id, room).


#backing

backing: ChatMemory

Defined in: packages/memory/src/encrypted.ts:20


#getRandomValues?

optional getRandomValues?: <T>(array) => T

Defined in: packages/memory/src/encrypted.ts:26

Random source. Defaults to globalThis.crypto.getRandomValues.

#Type Parameters

T

T extends ArrayBufferView<ArrayBufferLike>

#Parameters

array

T

#Returns

T


#key

key: Uint8Array<ArrayBufferLike> | CryptoKey

Defined in: packages/memory/src/encrypted.ts:22

32-byte raw key (e.g. crypto.getRandomValues(new Uint8Array(32))).


#subtle?

optional subtle?: SubtleCrypto

Defined in: packages/memory/src/encrypted.ts:24

Override for tests. Defaults to globalThis.crypto.subtle.


#Interface: FileKvConfig

Defined in: packages/memory/src/kv-store-types.ts:60

Configuration for the JSON file key-value backend.

#Extends

  • CommonKvConfig

#Properties

#backend

readonly backend: "file"

Defined in: packages/memory/src/kv-store-types.ts:61


#maxMessages?

readonly optional maxMessages?: number

Defined in: packages/memory/src/kv-store-types.ts:51

#Inherited from

CommonKvConfig.maxMessages


#path

readonly path: string

Defined in: packages/memory/src/kv-store-types.ts:62


#ttlSeconds?

readonly optional ttlSeconds?: number

Defined in: packages/memory/src/kv-store-types.ts:52

#Inherited from

CommonKvConfig.ttlSeconds


#Interface: FileVectorMemoryConfig

Defined in: packages/memory/src/file-vector.ts:7

On-disk path and optional vector-store adapter for file vector memory.

#Properties

#path

path: string

Defined in: packages/memory/src/file-vector.ts:8


#store?

optional store?: VectorStore

Defined in: packages/memory/src/file-vector.ts:9


#Interface: ForgetReport

Defined in: packages/memory/src/forget.ts:30

Per-backend result returned by subject-data deletion.

#Properties

#at

at: string

Defined in: packages/memory/src/forget.ts:34

ISO timestamp of the deletion.


#backend

backend: string

Defined in: packages/memory/src/forget.ts:31


#deletedCount

deletedCount: number

Defined in: packages/memory/src/forget.ts:32


#failures?

optional failures?: object[]

Defined in: packages/memory/src/forget.ts:36

Records the deletion couldn't reach (offline replica, missing index).

#id

id: string

#reason

reason: string


#Interface: ForgetSubjectResult

Defined in: packages/memory/src/forget.ts:40

Aggregate outcome of deleting a subject from multiple memory backends.

#Properties

#evidenceHash

evidenceHash: string

Defined in: packages/memory/src/forget.ts:48

Hash you can sign into the audit log to prove the deletion ran.


#incomplete

incomplete: boolean

Defined in: packages/memory/src/forget.ts:45


#reports

reports: ForgetReport[]

Defined in: packages/memory/src/forget.ts:42


#skippedBackends

skippedBackends: string[]

Defined in: packages/memory/src/forget.ts:44

Inputs without the capability, which require an explicit out-of-band deletion.


#subjectId

subjectId: string

Defined in: packages/memory/src/forget.ts:41


#totalDeleted

totalDeleted: number

Defined in: packages/memory/src/forget.ts:46


#Interface: ForgettableMemory

Defined in: packages/memory/src/forget.ts:19

GDPR / LGPD / CCPA data-subject deletion. ADR-0003 deferred retention; this module is the "forget the user" half.

Design: rather than mutate every memory contract (and break the public API freeze, RFC-0007), we attach forgetSubject as a capability on a memory instance. Backends that can implement it declare a subjectFilter (how to recognise records belonging to a subject) and deleteFn (how to remove them). forgetSubject(memory, subjectId) walks every backend the runtime is configured with and runs the deletion, returning a per-backend report you can sign into the audit log (#162).

Closes issue #798.

#Properties

#__agentskitBackend

__agentskitBackend: string

Defined in: packages/memory/src/forget.ts:24

Backend identifier ('pgvector', 'pinecone', 'sqlite', etc.). Used for the audit-log entry and for the per-backend report.


#forgetSubject

forgetSubject: (subjectId) => Promise<ForgetReport>

Defined in: packages/memory/src/forget.ts:26

Delete every record where metadata.subjectId === subjectId.

#Parameters

subjectId

string

#Returns

Promise<ForgetReport>


#Interface: GraphEdge<TProps>

Defined in: packages/memory/src/graph.ts:20

Directed relationship between two graph nodes.

#Type Parameters

#TProps

TProps = Record<string, unknown>

#Properties

#from

from: string

Defined in: packages/memory/src/graph.ts:24


#id

id: string

Defined in: packages/memory/src/graph.ts:21


#label

label: string

Defined in: packages/memory/src/graph.ts:23

Verb / relation type β€” 'knows', 'works-at', 'cites'.


#properties?

optional properties?: TProps

Defined in: packages/memory/src/graph.ts:28


#to

to: string

Defined in: packages/memory/src/graph.ts:25


#weight?

optional weight?: number

Defined in: packages/memory/src/graph.ts:27

Optional weight β€” confidence, recency, or frequency.


#Interface: GraphMemory

Defined in: packages/memory/src/graph.ts:40

Knowledge-graph operations accepted by graph memory consumers.

#Properties

#clear?

optional clear?: () => Promise<void>

Defined in: packages/memory/src/graph.ts:50

#Returns

Promise<void>


#deleteEdge

deleteEdge: (id) => Promise<void>

Defined in: packages/memory/src/graph.ts:49

#Parameters

id

string

#Returns

Promise<void>


#deleteNode

deleteNode: (id) => Promise<void>

Defined in: packages/memory/src/graph.ts:48

#Parameters

id

string

#Returns

Promise<void>


#findEdges

findEdges: <T>(query?) => Promise<GraphEdge<T>[]>

Defined in: packages/memory/src/graph.ts:45

#Type Parameters

T

T

#Parameters

query?

GraphQuery

#Returns

Promise<GraphEdge<T>[]>


#findNodes

findNodes: <T>(query?) => Promise<GraphNode<T>[]>

Defined in: packages/memory/src/graph.ts:44

#Type Parameters

T

T

#Parameters

query?

GraphQuery

#Returns

Promise<GraphNode<T>[]>


#getNode

getNode: <T>(id) => Promise<GraphNode<T> | null>

Defined in: packages/memory/src/graph.ts:43

#Type Parameters

T

T

#Parameters

id

string

#Returns

Promise<GraphNode<T> | null>


#neighbors

neighbors: <T>(id, options?) => Promise<GraphNode<T>[]>

Defined in: packages/memory/src/graph.ts:47

Breadth-first neighbors of id up to depth. Default 1.

#Type Parameters

T

T

#Parameters

id

string

options?
depth?

number

label?

string

#Returns

Promise<GraphNode<T>[]>


#upsertEdge

upsertEdge: <T>(edge) => Promise<GraphEdge<T>>

Defined in: packages/memory/src/graph.ts:42

#Type Parameters

T

T

#Parameters

edge

GraphEdge<T>

#Returns

Promise<GraphEdge<T>>


#upsertNode

upsertNode: <T>(node) => Promise<GraphNode<T>>

Defined in: packages/memory/src/graph.ts:41

#Type Parameters

T

T

#Parameters

node

GraphNode<T>

#Returns

Promise<GraphNode<T>>


#Interface: GraphNode<TProps>

Defined in: packages/memory/src/graph.ts:8

Non-linear memory: a typed knowledge graph. Use for facts the agent should remember beyond a single conversation β€” entities, relationships, derived beliefs. Designed to be backed by anything from an in-memory Map (tests, demos) to Neo4j / Memgraph / Neptune.

#Type Parameters

#TProps

TProps = Record<string, unknown>

#Properties

#createdAt?

optional createdAt?: string

Defined in: packages/memory/src/graph.ts:14

ISO timestamp when the node was first inserted.


#id

id: string

Defined in: packages/memory/src/graph.ts:9


#kind

kind: string

Defined in: packages/memory/src/graph.ts:11

Type / label β€” 'person', 'company', 'topic'.


#properties?

optional properties?: TProps

Defined in: packages/memory/src/graph.ts:12


#updatedAt?

optional updatedAt?: string

Defined in: packages/memory/src/graph.ts:16

ISO timestamp of the latest update.


#Interface: GraphQuery

Defined in: packages/memory/src/graph.ts:32

Optional node or edge fields used to filter graph lookups.

#Properties

#from?

optional from?: string

Defined in: packages/memory/src/graph.ts:35


#kind?

optional kind?: string

Defined in: packages/memory/src/graph.ts:33


#label?

optional label?: string

Defined in: packages/memory/src/graph.ts:34


#to?

optional to?: string

Defined in: packages/memory/src/graph.ts:36


#Interface: HierarchicalMemory

Defined in: packages/memory/src/hierarchical.ts:48

Tiered chat memory with accessors for archival history and the working window.

#Extends

  • ChatMemory

#Properties

#archival

archival: () => Promise<Message[]>

Defined in: packages/memory/src/hierarchical.ts:50

Full archival history. Always the source of truth.

#Returns

Promise<Message[]>


#clear?

optional clear?: (options?) => MaybePromise<void>

Defined in: packages/core/dist/memory-DZZNsfnt.d.ts:27

#Parameters

options?

MemoryOperationOptions

#Returns

MaybePromise<void>

#Inherited from

ChatMemory.clear


#load

load: (options?) => MaybePromise<Message[]>

Defined in: packages/core/dist/memory-DZZNsfnt.d.ts:25

#Parameters

options?

MemoryOperationOptions

#Returns

MaybePromise<Message[]>

#Inherited from

ChatMemory.load


#region?

optional region?: DataRegion

Defined in: packages/core/dist/memory-DZZNsfnt.d.ts:24

Data-residency region for this memory backend, when known.

#Inherited from

ChatMemory.region


#save

save: (messages, options?) => MaybePromise<void>

Defined in: packages/core/dist/memory-DZZNsfnt.d.ts:26

#Parameters

messages

Message[]

options?

MemoryOperationOptions

#Returns

MaybePromise<void>

#Inherited from

ChatMemory.save


#working

working: () => Promise<Message[]>

Defined in: packages/memory/src/hierarchical.ts:52

Current working-window snapshot.

#Returns

Promise<Message[]>


#Interface: HierarchicalMemoryOptions

Defined in: packages/memory/src/hierarchical.ts:25

Working, recall, and archival stores used by hierarchical memory.

#Properties

#archival

archival: ChatMemory

Defined in: packages/memory/src/hierarchical.ts:29

Cold storage β€” every message ever seen is written here.


#recall?

optional recall?: HierarchicalRecall

Defined in: packages/memory/src/hierarchical.ts:35

Mid-term recall layer (usually a vector store). Optional; without it the hub behaves like virtualized memory with a hard backing store.


#recallTopK?

optional recallTopK?: number

Defined in: packages/memory/src/hierarchical.ts:44

Max recalled messages to splice on each load(). Default 5.


#working

working: ChatMemory

Defined in: packages/memory/src/hierarchical.ts:27

Hot window β€” the messages always loaded in full.


#workingLimit?

optional workingLimit?: number

Defined in: packages/memory/src/hierarchical.ts:40

Maximum messages to keep in working. Older messages spill into recall + archival. Default 50.


#Interface: HierarchicalRecall

Defined in: packages/memory/src/hierarchical.ts:7

Search and indexing operations for the recall tier of hierarchical memory.

#Properties

#clear?

optional clear?: () => void | Promise<void>

Defined in: packages/memory/src/hierarchical.ts:21

Remove all indexed messages when the parent memory is cleared.

#Returns

void | Promise<void>


#index

index: (message) => void | Promise<void>

Defined in: packages/memory/src/hierarchical.ts:13

Index a message for later retrieval. Called once per message as it moves from working β†’ recall (usually: embed + store in a vector DB).

#Parameters

message

Message

#Returns

void | Promise<void>


#query

query: (input) => Message[] | Promise<Message[]>

Defined in: packages/memory/src/hierarchical.ts:19

Given the hot working window, return up to topK messages from the recall tier that are relevant to the current turn. The hub splices results chronologically alongside the working window.

#Parameters

input
topK

number

working

Message[]

#Returns

Message[] | Promise<Message[]>


#Interface: InMemoryKvConfig

Defined in: packages/memory/src/kv-store-types.ts:56

Configuration for the in-memory key-value backend.

#Extends

  • CommonKvConfig

#Properties

#backend

readonly backend: "in-memory"

Defined in: packages/memory/src/kv-store-types.ts:57


#maxMessages?

readonly optional maxMessages?: number

Defined in: packages/memory/src/kv-store-types.ts:51

#Inherited from

CommonKvConfig.maxMessages


#ttlSeconds?

readonly optional ttlSeconds?: number

Defined in: packages/memory/src/kv-store-types.ts:52

#Inherited from

CommonKvConfig.ttlSeconds


#Interface: KvEntry

Defined in: packages/memory/src/kv-store-types.ts:17

Stored value and insertion timestamp used by the KV backends.

#Properties

#insertedAt

readonly insertedAt: number

Defined in: packages/memory/src/kv-store-types.ts:19


#value

readonly value: unknown

Defined in: packages/memory/src/kv-store-types.ts:18


#Interface: LocalStorageKvConfig

Defined in: packages/memory/src/kv-store-types.ts:82

Configuration for the browser local-storage key-value backend.

#Extends

  • CommonKvConfig

#Properties

#backend

readonly backend: "localstorage"

Defined in: packages/memory/src/kv-store-types.ts:83


#key

readonly key: string

Defined in: packages/memory/src/kv-store-types.ts:84


#maxMessages?

readonly optional maxMessages?: number

Defined in: packages/memory/src/kv-store-types.ts:51

#Inherited from

CommonKvConfig.maxMessages


#ttlSeconds?

readonly optional ttlSeconds?: number

Defined in: packages/memory/src/kv-store-types.ts:52

#Inherited from

CommonKvConfig.ttlSeconds


#Interface: LocalStorageLike

Defined in: packages/memory/src/kv-store-types.ts:145

Minimal Web Storage methods required by the local-storage backend.

#Methods

#getItem()

getItem(key): string | null

Defined in: packages/memory/src/kv-store-types.ts:146

#Parameters

key

string

#Returns

string | null


#setItem()

setItem(key, value): void

Defined in: packages/memory/src/kv-store-types.ts:147

#Parameters

key

string

value

string

#Returns

void


#Interface: MemoryEmbedderLike

Defined in: packages/memory/src/kv-store-types.ts:140

Embedder contract used by vector-backed KV memory.

#Methods

#embed()

embed(texts): Promise<number[][]>

Defined in: packages/memory/src/kv-store-types.ts:141

#Parameters

texts

readonly string[]

#Returns

Promise<number[][]>


#Interface: MemoryVectorStoreLike

Defined in: packages/memory/src/kv-store-types.ts:124

Minimal vector store operations required by vector-backed KV memory.

#Methods

#query()

query(vec, k, filter?): Promise<readonly object[]>

Defined in: packages/memory/src/kv-store-types.ts:132

#Parameters

vec

readonly number[]

k

number

filter?

Record<string, unknown>

#Returns

Promise<readonly object[]>


#upsert()

upsert(rows): Promise<void>

Defined in: packages/memory/src/kv-store-types.ts:125

#Parameters

rows

readonly object[]

#Returns

Promise<void>


#Interface: MilvusConfig

Defined in: packages/memory/src/vector/milvus.ts:6

URL, collection, and credentials for a Milvus-compatible HTTP API.

#Extends

#Properties

#collection

collection: string

Defined in: packages/memory/src/vector/milvus.ts:11


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/memory/src/vector/http.ts:10

Fetch implementation for remote vector calls. Defaults to globalThis.fetch.

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Example

qdrant({ url, collection: 'docs', fetch: globalThis.fetch })

#Inherited from

RemoteHttpConfig.fetch


#maxResponseBytes?

optional maxResponseBytes?: number

Defined in: packages/memory/src/vector/http.ts:22

Maximum response body size in bytes. Defaults to 2 MiB and must be a positive safe integer. Overflow rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', maxResponseBytes: 1_000_000 })

#Inherited from

RemoteHttpConfig.maxResponseBytes


#signal?

optional signal?: AbortSignal

Defined in: packages/memory/src/vector/http.ts:24

Caller-owned signal relayed to remote requests.

#Inherited from

RemoteHttpConfig.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/memory/src/vector/http.ts:16

Request timeout in milliseconds. Defaults to 15_000; must be a positive safe integer. Expiry rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', timeoutMs: 5_000 })

#Inherited from

RemoteHttpConfig.timeoutMs


#token?

optional token?: string

Defined in: packages/memory/src/vector/milvus.ts:10

API key / Zilliz Cloud token (Bearer).


#topK?

optional topK?: number

Defined in: packages/memory/src/vector/milvus.ts:14


#url

url: string

Defined in: packages/memory/src/vector/milvus.ts:8

Milvus REST endpoint, e.g. https://in03-xxx.api.gcp-us-west1.zillizcloud.com.


#vectorField?

optional vectorField?: string

Defined in: packages/memory/src/vector/milvus.ts:13

Vector field name in the schema. Default vector.


#Interface: MongoAtlasVectorConfig

Defined in: packages/memory/src/vector/mongo-atlas.ts:22

Collection adapter and search settings for MongoDB Atlas vector memory.

#Properties

#collection

collection: MongoCollectionLike

Defined in: packages/memory/src/vector/mongo-atlas.ts:23


#indexName

indexName: string

Defined in: packages/memory/src/vector/mongo-atlas.ts:25

Atlas Search index name on the embedding field.


#numCandidates?

optional numCandidates?: number

Defined in: packages/memory/src/vector/mongo-atlas.ts:29

numCandidates for $vectorSearch. Default topK * 10.


#topK?

optional topK?: number

Defined in: packages/memory/src/vector/mongo-atlas.ts:30


#vectorField?

optional vectorField?: string

Defined in: packages/memory/src/vector/mongo-atlas.ts:27

Field that holds the embedding vector. Default embedding.


#Interface: MongoCollectionLike

Defined in: packages/memory/src/vector/mongo-atlas.ts:11

MongoDB Atlas Vector Search adapter. Caller injects a typed collection shape (drop-in for the official mongodb driver's Collection type) so we don't bundle a driver. Atlas' $vectorSearch aggregation runs server-side; we just translate store / search / delete to insertMany + aggregate + deleteMany.

#Methods

#aggregate()

aggregate<T>(pipeline): object

Defined in: packages/memory/src/vector/mongo-atlas.ts:16

#Type Parameters

T

T = Record<string, unknown>

#Parameters

pipeline

Record<string, unknown>[]

#Returns

object

toArray()

toArray(): Promise<T[]>

Returns

Promise<T[]>


#bulkWrite()?

optional bulkWrite(operations, options?): Promise<unknown>

Defined in: packages/memory/src/vector/mongo-atlas.ts:14

#Parameters

operations

Record<string, unknown>[]

options?

unknown

#Returns

Promise<unknown>


#deleteMany()

deleteMany(filter): Promise<unknown>

Defined in: packages/memory/src/vector/mongo-atlas.ts:15

#Parameters

filter

Record<string, unknown>

#Returns

Promise<unknown>


#insertMany()

insertMany(docs, options?): Promise<unknown>

Defined in: packages/memory/src/vector/mongo-atlas.ts:12

#Parameters

docs

Record<string, unknown>[]

options?

unknown

#Returns

Promise<unknown>


#updateOne()?

optional updateOne(filter, update, options?): Promise<unknown>

Defined in: packages/memory/src/vector/mongo-atlas.ts:13

#Parameters

filter

Record<string, unknown>

update

Record<string, unknown>

options?

unknown

#Returns

Promise<unknown>


#Interface: PersonalizationProfile

Defined in: packages/memory/src/personalization.ts:8

Personalization β€” a persisted profile per subject (user id, account id, device). The agent reads it on every run to condition responses; the runtime updates it when new facts appear.

#Properties

#subjectId

subjectId: string

Defined in: packages/memory/src/personalization.ts:9


#traits

traits: Record<string, unknown>

Defined in: packages/memory/src/personalization.ts:11

Human-editable notes, facts, preferences.


#updatedAt

updatedAt: string

Defined in: packages/memory/src/personalization.ts:13

ISO timestamp of the latest update.


#Interface: PersonalizationStore

Defined in: packages/memory/src/personalization.ts:17

Persistence contract for retrieving, replacing, merging, and deleting profiles.

#Properties

#delete?

optional delete?: (subjectId) => Promise<void>

Defined in: packages/memory/src/personalization.ts:21

#Parameters

subjectId

string

#Returns

Promise<void>


#get

get: (subjectId) => Promise<PersonalizationProfile | null>

Defined in: packages/memory/src/personalization.ts:18

#Parameters

subjectId

string

#Returns

Promise<PersonalizationProfile | null>


#merge

merge: (subjectId, traits) => Promise<PersonalizationProfile>

Defined in: packages/memory/src/personalization.ts:20

#Parameters

subjectId

string

traits

Record<string, unknown>

#Returns

Promise<PersonalizationProfile>


#set

set: (profile) => Promise<void>

Defined in: packages/memory/src/personalization.ts:19

#Parameters

profile

PersonalizationProfile

#Returns

Promise<void>


#Interface: PgVectorConfig

Defined in: packages/memory/src/vector/pgvector.ts:21

SQL runner, table, and search defaults for pgvector memory.

#Properties

#runner

runner: PgVectorRunner

Defined in: packages/memory/src/vector/pgvector.ts:22


#table?

optional table?: string

Defined in: packages/memory/src/vector/pgvector.ts:24

Table name. Default 'agentskit_vectors'.


#topK?

optional topK?: number

Defined in: packages/memory/src/vector/pgvector.ts:26

Default topK for search. Default 10.


#Interface: PgVectorRunner

Defined in: packages/memory/src/vector/pgvector.ts:13

Async SQL query adapter used by the pgvector backend.

#Properties

#query

query: <T>(sql, params) => Promise<{ rows: T[]; }>

Defined in: packages/memory/src/vector/pgvector.ts:14

#Type Parameters

T

T = Record<string, unknown>

#Parameters

sql

string

params

unknown[]

#Returns

Promise<{ rows: T[]; }>


#Interface: PineconeConfig

Defined in: packages/memory/src/vector/pinecone.ts:5

Index URL, API key, namespace, and search settings for Pinecone.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/memory/src/vector/pinecone.ts:8


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/memory/src/vector/http.ts:10

Fetch implementation for remote vector calls. Defaults to globalThis.fetch.

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Example

qdrant({ url, collection: 'docs', fetch: globalThis.fetch })

#Inherited from

RemoteHttpConfig.fetch


#indexUrl

indexUrl: string

Defined in: packages/memory/src/vector/pinecone.ts:7

Full index URL, e.g. https://&lt;idx>-&lt;project>.svc.&lt;region>.pinecone.io.


#maxResponseBytes?

optional maxResponseBytes?: number

Defined in: packages/memory/src/vector/http.ts:22

Maximum response body size in bytes. Defaults to 2 MiB and must be a positive safe integer. Overflow rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', maxResponseBytes: 1_000_000 })

#Inherited from

RemoteHttpConfig.maxResponseBytes


#namespace?

optional namespace?: string

Defined in: packages/memory/src/vector/pinecone.ts:10

Namespace. Default ''.


#signal?

optional signal?: AbortSignal

Defined in: packages/memory/src/vector/http.ts:24

Caller-owned signal relayed to remote requests.

#Inherited from

RemoteHttpConfig.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/memory/src/vector/http.ts:16

Request timeout in milliseconds. Defaults to 15_000; must be a positive safe integer. Expiry rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', timeoutMs: 5_000 })

#Inherited from

RemoteHttpConfig.timeoutMs


#topK?

optional topK?: number

Defined in: packages/memory/src/vector/pinecone.ts:12

Default topK for search. Default 10.


#Interface: QdrantConfig

Defined in: packages/memory/src/vector/qdrant.ts:6

Endpoint, collection, credentials, and search defaults for Qdrant.

#Extends

#Properties

#apiKey?

optional apiKey?: string

Defined in: packages/memory/src/vector/qdrant.ts:9


#collection

collection: string

Defined in: packages/memory/src/vector/qdrant.ts:10


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/memory/src/vector/http.ts:10

Fetch implementation for remote vector calls. Defaults to globalThis.fetch.

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Example

qdrant({ url, collection: 'docs', fetch: globalThis.fetch })

#Inherited from

RemoteHttpConfig.fetch


#maxResponseBytes?

optional maxResponseBytes?: number

Defined in: packages/memory/src/vector/http.ts:22

Maximum response body size in bytes. Defaults to 2 MiB and must be a positive safe integer. Overflow rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', maxResponseBytes: 1_000_000 })

#Inherited from

RemoteHttpConfig.maxResponseBytes


#signal?

optional signal?: AbortSignal

Defined in: packages/memory/src/vector/http.ts:24

Caller-owned signal relayed to remote requests.

#Inherited from

RemoteHttpConfig.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/memory/src/vector/http.ts:16

Request timeout in milliseconds. Defaults to 15_000; must be a positive safe integer. Expiry rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', timeoutMs: 5_000 })

#Inherited from

RemoteHttpConfig.timeoutMs


#topK?

optional topK?: number

Defined in: packages/memory/src/vector/qdrant.ts:11


#url

url: string

Defined in: packages/memory/src/vector/qdrant.ts:8

Base URL, e.g. https://xxx.cluster-qdrant.io.


#Interface: RedisChatMemoryConfig

Defined in: packages/memory/src/redis-chat.ts:13

Redis connection and key-prefix settings for chat memory.

#Extends

#Properties

#client?

optional client?: RedisClientAdapter

Defined in: packages/memory/src/redis-client.ts:21

#Inherited from

RedisConnectionConfig.client


#conversationId?

optional conversationId?: string

Defined in: packages/memory/src/redis-chat.ts:15


#keyPrefix?

optional keyPrefix?: string

Defined in: packages/memory/src/redis-chat.ts:14


#url

url: string

Defined in: packages/memory/src/redis-client.ts:20

#Inherited from

RedisConnectionConfig.url


#Interface: RedisClientAdapter

Defined in: packages/memory/src/redis-client.ts:9

Redis client operations used by the chat and vector memory backends.

#Methods

#call()

call(command, ...args): Promise<unknown>

Defined in: packages/memory/src/redis-client.ts:15

#Parameters

command

string

args

...(string | number | Buffer<ArrayBufferLike>)[]

#Returns

Promise<unknown>


#del()

del(key): Promise<void>

Defined in: packages/memory/src/redis-client.ts:12

#Parameters

key

string | string[]

#Returns

Promise<void>


#disconnect()

disconnect(): Promise<void>

Defined in: packages/memory/src/redis-client.ts:14

#Returns

Promise<void>


#get()

get(key): Promise<string | null>

Defined in: packages/memory/src/redis-client.ts:10

#Parameters

key

string

#Returns

Promise<string | null>


#keys()

keys(pattern): Promise<string[]>

Defined in: packages/memory/src/redis-client.ts:13

#Parameters

pattern

string

#Returns

Promise<string[]>


#set()

set(key, value): Promise<void>

Defined in: packages/memory/src/redis-client.ts:11

#Parameters

key

string

value

string

#Returns

Promise<void>


#Interface: RedisConnectionConfig

Defined in: packages/memory/src/redis-client.ts:19

Connection URL and optional injected Redis adapter.

#Extended by

#Properties

#client?

optional client?: RedisClientAdapter

Defined in: packages/memory/src/redis-client.ts:21


#url

url: string

Defined in: packages/memory/src/redis-client.ts:20


#Interface: RedisKvConfig

Defined in: packages/memory/src/kv-store-types.ts:70

Configuration for the Redis key-value backend.

#Extends

  • CommonKvConfig

#Properties

#backend

readonly backend: "redis"

Defined in: packages/memory/src/kv-store-types.ts:71


#maxMessages?

readonly optional maxMessages?: number

Defined in: packages/memory/src/kv-store-types.ts:51

#Inherited from

CommonKvConfig.maxMessages


#prefix

readonly prefix: string

Defined in: packages/memory/src/kv-store-types.ts:73


#ttlSeconds?

readonly optional ttlSeconds?: number

Defined in: packages/memory/src/kv-store-types.ts:52

#Inherited from

CommonKvConfig.ttlSeconds


#url

readonly url: string

Defined in: packages/memory/src/kv-store-types.ts:72


#Interface: RedisLike

Defined in: packages/memory/src/kv-store-types.ts:99

Minimal Redis client operations required by the memory backends.

#Methods

#del()

del(key): Promise<unknown>

Defined in: packages/memory/src/kv-store-types.ts:102

#Parameters

key

string

#Returns

Promise<unknown>


#get()

get(key): Promise<string | null>

Defined in: packages/memory/src/kv-store-types.ts:100

#Parameters

key

string

#Returns

Promise<string | null>


#keys()

keys(pattern): Promise<readonly string[]>

Defined in: packages/memory/src/kv-store-types.ts:103

#Parameters

pattern

string

#Returns

Promise<readonly string[]>


#set()

set(key, value, options?): Promise<unknown>

Defined in: packages/memory/src/kv-store-types.ts:101

#Parameters

key

string

value

string

options?
EX?

number

#Returns

Promise<unknown>


#Interface: RedisVectorMemoryConfig

Defined in: packages/memory/src/redis-vector.ts:6

Redis connection and index settings for vector memory.

#Extends

#Properties

#client?

optional client?: RedisClientAdapter

Defined in: packages/memory/src/redis-client.ts:21

#Inherited from

RedisConnectionConfig.client


#dimensions?

optional dimensions?: number

Defined in: packages/memory/src/redis-vector.ts:9


#indexName?

optional indexName?: string

Defined in: packages/memory/src/redis-vector.ts:7


#keyPrefix?

optional keyPrefix?: string

Defined in: packages/memory/src/redis-vector.ts:8


#url

url: string

Defined in: packages/memory/src/redis-client.ts:20

#Inherited from

RedisConnectionConfig.url


#Interface: RemoteHttpConfig

Defined in: packages/memory/src/vector/http.ts:5

Shared credentials, fetch, and timeout settings for HTTP vector stores.

#Extended by

#Properties

#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/memory/src/vector/http.ts:10

Fetch implementation for remote vector calls. Defaults to globalThis.fetch.

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Example

qdrant({ url, collection: 'docs', fetch: globalThis.fetch })

#maxResponseBytes?

optional maxResponseBytes?: number

Defined in: packages/memory/src/vector/http.ts:22

Maximum response body size in bytes. Defaults to 2 MiB and must be a positive safe integer. Overflow rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', maxResponseBytes: 1_000_000 })

#signal?

optional signal?: AbortSignal

Defined in: packages/memory/src/vector/http.ts:24

Caller-owned signal relayed to remote requests.


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/memory/src/vector/http.ts:16

Request timeout in milliseconds. Defaults to 15_000; must be a positive safe integer. Expiry rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', timeoutMs: 5_000 })

#Interface: SqliteChatMemoryConfig

Defined in: packages/memory/src/sqlite.ts:15

Database path and optional SQLite opener for chat memory.

#Properties

#conversationId?

optional conversationId?: string

Defined in: packages/memory/src/sqlite.ts:17


#path

path: string

Defined in: packages/memory/src/sqlite.ts:16


#Interface: SqliteKvConfig

Defined in: packages/memory/src/kv-store-types.ts:65

Configuration for the SQLite key-value backend.

#Extends

  • CommonKvConfig

#Properties

#backend

readonly backend: "sqlite"

Defined in: packages/memory/src/kv-store-types.ts:66


#maxMessages?

readonly optional maxMessages?: number

Defined in: packages/memory/src/kv-store-types.ts:51

#Inherited from

CommonKvConfig.maxMessages


#path

readonly path: string

Defined in: packages/memory/src/kv-store-types.ts:67


#ttlSeconds?

readonly optional ttlSeconds?: number

Defined in: packages/memory/src/kv-store-types.ts:52

#Inherited from

CommonKvConfig.ttlSeconds


#Interface: SqliteLike

Defined in: packages/memory/src/kv-store-types.ts:114

Minimal SQLite database operations required by memory stores.

#Methods

#exec()

exec(sql): void

Defined in: packages/memory/src/kv-store-types.ts:115

#Parameters

sql

string

#Returns

void


#prepare()

prepare(sql): SqliteStmt

Defined in: packages/memory/src/kv-store-types.ts:116

#Parameters

sql

string

#Returns

SqliteStmt


#transaction()?

optional transaction<T>(fn): T

Defined in: packages/memory/src/kv-store-types.ts:117

#Type Parameters

T

T extends (...args) => unknown

#Parameters

fn

T

#Returns

T


#Interface: SqliteStmt

Defined in: packages/memory/src/kv-store-types.ts:107

Minimal prepared-statement operations used by SQLite memory stores.

#Methods

#all()

all(...params): unknown[]

Defined in: packages/memory/src/kv-store-types.ts:110

#Parameters

params

...unknown[]

#Returns

unknown[]


#get()

get(...params): unknown

Defined in: packages/memory/src/kv-store-types.ts:109

#Parameters

params

...unknown[]

#Returns

unknown


#run()

run(...params): void

Defined in: packages/memory/src/kv-store-types.ts:108

#Parameters

params

...unknown[]

#Returns

void


#Interface: SupabaseVectorStoreConfig

Defined in: packages/memory/src/vector/supabase.ts:5

Supabase client and table settings for vector memory.

#Properties

#matchFunction?

optional matchFunction?: string

Defined in: packages/memory/src/vector/supabase.ts:13

Purpose-specific similarity-search RPC. Default match_agentskit_vectors.


#serviceRoleKey

serviceRoleKey: string

Defined in: packages/memory/src/vector/supabase.ts:9

Service-role key (server-side only).


#table?

optional table?: string

Defined in: packages/memory/src/vector/supabase.ts:11

Table name. Default agentskit_vectors.


#topK?

optional topK?: number

Defined in: packages/memory/src/vector/supabase.ts:15

Default topK for search. Default 10.


#url

url: string

Defined in: packages/memory/src/vector/supabase.ts:7

Supabase project URL, e.g. https://xyz.supabase.co.


#Interface: TursoChatMemoryConfig

Defined in: packages/memory/src/turso.ts:15

Turso URL, auth token, and optional database client settings.

#Properties

#authToken?

optional authToken?: string

Defined in: packages/memory/src/turso.ts:19

Auth token β€” required for hosted (libsql://) URLs.


#conversationId?

optional conversationId?: string

Defined in: packages/memory/src/turso.ts:20


#url

url: string

Defined in: packages/memory/src/turso.ts:17

libSQL URL β€” file:..., libsql://..., or http://...


#Interface: UpstashVectorConfig

Defined in: packages/memory/src/vector/upstash.ts:5

REST URL, token, and index settings for Upstash Vector.

#Extends

#Properties

#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/memory/src/vector/http.ts:10

Fetch implementation for remote vector calls. Defaults to globalThis.fetch.

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Example

qdrant({ url, collection: 'docs', fetch: globalThis.fetch })

#Inherited from

RemoteHttpConfig.fetch


#maxResponseBytes?

optional maxResponseBytes?: number

Defined in: packages/memory/src/vector/http.ts:22

Maximum response body size in bytes. Defaults to 2 MiB and must be a positive safe integer. Overflow rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', maxResponseBytes: 1_000_000 })

#Inherited from

RemoteHttpConfig.maxResponseBytes


#signal?

optional signal?: AbortSignal

Defined in: packages/memory/src/vector/http.ts:24

Caller-owned signal relayed to remote requests.

#Inherited from

RemoteHttpConfig.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/memory/src/vector/http.ts:16

Request timeout in milliseconds. Defaults to 15_000; must be a positive safe integer. Expiry rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', timeoutMs: 5_000 })

#Inherited from

RemoteHttpConfig.timeoutMs


#token

token: string

Defined in: packages/memory/src/vector/upstash.ts:7


#topK?

optional topK?: number

Defined in: packages/memory/src/vector/upstash.ts:8


#url

url: string

Defined in: packages/memory/src/vector/upstash.ts:6


#Interface: VectorKvConfig

Defined in: packages/memory/src/kv-store-types.ts:76

Configuration for the vector-backed key-value backend.

#Extends

  • CommonKvConfig

#Properties

#backend

readonly backend: "vector"

Defined in: packages/memory/src/kv-store-types.ts:77


#collection

readonly collection: string

Defined in: packages/memory/src/kv-store-types.ts:79


#maxMessages?

readonly optional maxMessages?: number

Defined in: packages/memory/src/kv-store-types.ts:51

#Inherited from

CommonKvConfig.maxMessages


#provider

readonly provider: string

Defined in: packages/memory/src/kv-store-types.ts:78


#ttlSeconds?

readonly optional ttlSeconds?: number

Defined in: packages/memory/src/kv-store-types.ts:52

#Inherited from

CommonKvConfig.ttlSeconds


#Interface: VectorMemoryRedactionOptions

Defined in: packages/memory/src/redaction.ts:53

Redaction and tokenization settings for vector document content.

#Extends

#Properties

#allowedRoles?

optional allowedRoles?: string[]

Defined in: packages/memory/src/redaction.ts:47

Roles allowed to reveal β€” required when mode === 'tokenize'.

#Inherited from

ChatMemoryRedactionOptions.allowedRoles


#audit?

optional audit?: RedactionAuditSink

Defined in: packages/memory/src/redaction.ts:49

Optional audit sink threaded into the vault tokenize() calls.

#Inherited from

ChatMemoryRedactionOptions.audit


#mode?

optional mode?: RedactionMode

Defined in: packages/memory/src/redaction.ts:43

#Inherited from

ChatMemoryRedactionOptions.mode


#rules

rules: PIIRule[]

Defined in: packages/memory/src/redaction.ts:42

Rules to apply. Pass DEFAULT_PII_RULES for the baseline set, compilePIITaxonomy(json) for a custom JSON taxonomy, or any hand-rolled PIIRule[]. Same shape as createPIIRedactor.

#Inherited from

ChatMemoryRedactionOptions.rules


#vault?

optional vault?: RedactionVault

Defined in: packages/memory/src/redaction.ts:45

Required when mode === 'tokenize'.

#Inherited from

ChatMemoryRedactionOptions.vault


#Interface: VectorStore

Defined in: packages/memory/src/vector-store.ts:16

Backend-neutral upsert, query, and delete contract for vector data.

#Methods

#delete()

delete(ids): Promise<void>

Defined in: packages/memory/src/vector-store.ts:19

#Parameters

ids

string[]

#Returns

Promise<void>


#query()

query(vector, topK): Promise<VectorStoreResult[]>

Defined in: packages/memory/src/vector-store.ts:18

#Parameters

vector

number[]

topK

number

#Returns

Promise<VectorStoreResult[]>


#upsert()

upsert(docs): Promise<void>

Defined in: packages/memory/src/vector-store.ts:17

#Parameters

docs

VectorStoreDocument[]

#Returns

Promise<void>


#Interface: VectorStoreDocument

Defined in: packages/memory/src/vector-store.ts:2

Vector and metadata fields stored by a backend-neutral vector store.

#Properties

#id

id: string

Defined in: packages/memory/src/vector-store.ts:3


#metadata

metadata: Record<string, unknown>

Defined in: packages/memory/src/vector-store.ts:5


#vector

vector: number[]

Defined in: packages/memory/src/vector-store.ts:4


#Interface: VectorStoreResult

Defined in: packages/memory/src/vector-store.ts:9

Search result returned by a backend-neutral vector store.

#Properties

#id

id: string

Defined in: packages/memory/src/vector-store.ts:10


#metadata

metadata: Record<string, unknown>

Defined in: packages/memory/src/vector-store.ts:12


#score

score: number

Defined in: packages/memory/src/vector-store.ts:11


#Interface: WeaviateConfig

Defined in: packages/memory/src/vector/weaviate.ts:6

Endpoint, class, credentials, and search settings for Weaviate.

#Extends

#Properties

#apiKey?

optional apiKey?: string

Defined in: packages/memory/src/vector/weaviate.ts:10

Optional API key (Weaviate Cloud Services).


#className

className: string

Defined in: packages/memory/src/vector/weaviate.ts:12

Class name in the Weaviate schema.


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/memory/src/vector/http.ts:10

Fetch implementation for remote vector calls. Defaults to globalThis.fetch.

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Example

qdrant({ url, collection: 'docs', fetch: globalThis.fetch })

#Inherited from

RemoteHttpConfig.fetch


#maxResponseBytes?

optional maxResponseBytes?: number

Defined in: packages/memory/src/vector/http.ts:22

Maximum response body size in bytes. Defaults to 2 MiB and must be a positive safe integer. Overflow rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', maxResponseBytes: 1_000_000 })

#Inherited from

RemoteHttpConfig.maxResponseBytes


#signal?

optional signal?: AbortSignal

Defined in: packages/memory/src/vector/http.ts:24

Caller-owned signal relayed to remote requests.

#Inherited from

RemoteHttpConfig.signal


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/memory/src/vector/http.ts:16

Request timeout in milliseconds. Defaults to 15_000; must be a positive safe integer. Expiry rejects with AK_MEMORY_REMOTE_HTTP.

#Example

qdrant({ url, collection: 'docs', timeoutMs: 5_000 })

#Inherited from

RemoteHttpConfig.timeoutMs


#topK?

optional topK?: number

Defined in: packages/memory/src/vector/weaviate.ts:13


#url

url: string

Defined in: packages/memory/src/vector/weaviate.ts:8

Cluster URL, e.g. https://my-cluster.weaviate.network.


#Interface: WebStorageLike

Defined in: packages/memory/src/web-storage.ts:6

Minimal Web Storage methods required by browser chat memory.

#Properties

#getItem

readonly getItem: (key) => string | null

Defined in: packages/memory/src/web-storage.ts:7

#Parameters

key

string

#Returns

string | null


#removeItem

readonly removeItem: (key) => void

Defined in: packages/memory/src/web-storage.ts:9

#Parameters

key

string

#Returns

void


#setItem

readonly setItem: (key, value) => void

Defined in: packages/memory/src/web-storage.ts:8

#Parameters

key

string

value

string

#Returns

void


#Interface: WebStorageMemoryMigration

Defined in: packages/memory/src/web-storage.ts:13

Adapter for reading legacy records into canonical AgentsKit messages.

#Properties

#keys

readonly keys: readonly string[]

Defined in: packages/memory/src/web-storage.ts:14


#read

readonly read: (value, key) => readonly Message[] | undefined

Defined in: packages/memory/src/web-storage.ts:15

#Parameters

value

unknown

key

string

#Returns

readonly Message[] | undefined


#Interface: WebStorageMemoryOptions

Defined in: packages/memory/src/web-storage.ts:19

Storage key, bounds, and optional migration settings for web memory.

#Properties

#getStorage

readonly getStorage: () => WebStorageLike | undefined

Defined in: packages/memory/src/web-storage.ts:21

#Returns

WebStorageLike | undefined


#key

readonly key: string

Defined in: packages/memory/src/web-storage.ts:20


#maxMessages?

readonly optional maxMessages?: number

Defined in: packages/memory/src/web-storage.ts:22


#maxRecordBytes?

readonly optional maxRecordBytes?: number

Defined in: packages/memory/src/web-storage.ts:23


#migration?

readonly optional migration?: WebStorageMemoryMigration

Defined in: packages/memory/src/web-storage.ts:24

Explore nearby

On this page

Interface: AgentskitMemoryStorePropertiesidMethodsget()ParameterskeyReturnsset()ParameterskeyvalueReturnsInterface: ChatMemoryRedactionOptionsExtended byPropertiesallowedRoles?audit?mode?rulesvault?Interface: ChromaConfigExtendsPropertiesapiKey?collectiondatabase?fetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsExampleInherited fromheaders?maxResponseBytes?ExampleInherited fromsignal?Inherited fromtenant?timeoutMs?ExampleInherited fromtopK?urlInterface: CreateKvMemoryFromConfigOptsPropertiesconfigembedder?localStorageFilePath?redis?sqlite?vectorStore?Interface: CreateLocalStorageStoreOptsPropertiesconfigfilePath?storage?Interface: CreateRedisStoreOptsPropertiesclientconfigInterface: CreateSqliteStoreOptsPropertiesconfigopenInterface: CreateVectorStoreOptsPropertiesconfigembeddervectorStoreInterface: EncryptedEnvelopePropertiesciphertextivlengthInterface: EncryptedMemoryOptionsPropertiesaad?backinggetRandomValues?Type ParametersTParametersarrayReturnskeysubtle?Interface: FileKvConfigExtendsPropertiesbackendmaxMessages?Inherited frompathttlSeconds?Inherited fromInterface: FileVectorMemoryConfigPropertiespathstore?Interface: ForgetReportPropertiesatbackenddeletedCountfailures?idreasonInterface: ForgetSubjectResultPropertiesevidenceHashincompletereportsskippedBackendssubjectIdtotalDeletedInterface: ForgettableMemoryProperties__agentskitBackendforgetSubjectParameterssubjectIdReturnsInterface: GraphEdge<TProps>Type ParametersTPropsPropertiesfromidlabelproperties?toweight?Interface: GraphMemoryPropertiesclear?ReturnsdeleteEdgeParametersidReturnsdeleteNodeParametersidReturnsfindEdgesType ParametersTParametersquery?ReturnsfindNodesType ParametersTParametersquery?ReturnsgetNodeType ParametersTParametersidReturnsneighborsType ParametersTParametersidoptions?depth?label?ReturnsupsertEdgeType ParametersTParametersedgeReturnsupsertNodeType ParametersTParametersnodeReturnsInterface: GraphNode<TProps>Type ParametersTPropsPropertiescreatedAt?idkindproperties?updatedAt?Interface: GraphQueryPropertiesfrom?kind?label?to?Interface: HierarchicalMemoryExtendsPropertiesarchivalReturnsclear?Parametersoptions?ReturnsInherited fromloadParametersoptions?ReturnsInherited fromregion?Inherited fromsaveParametersmessagesoptions?ReturnsInherited fromworkingReturnsInterface: HierarchicalMemoryOptionsPropertiesarchivalrecall?recallTopK?workingworkingLimit?Interface: HierarchicalRecallPropertiesclear?ReturnsindexParametersmessageReturnsqueryParametersinputtopKworkingReturnsInterface: InMemoryKvConfigExtendsPropertiesbackendmaxMessages?Inherited fromttlSeconds?Inherited fromInterface: KvEntryPropertiesinsertedAtvalueInterface: LocalStorageKvConfigExtendsPropertiesbackendkeymaxMessages?Inherited fromttlSeconds?Inherited fromInterface: LocalStorageLikeMethodsgetItem()ParameterskeyReturnssetItem()ParameterskeyvalueReturnsInterface: MemoryEmbedderLikeMethodsembed()ParameterstextsReturnsInterface: MemoryVectorStoreLikeMethodsquery()Parametersveckfilter?Returnsupsert()ParametersrowsReturnsInterface: MilvusConfigExtendsPropertiescollectionfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsExampleInherited frommaxResponseBytes?ExampleInherited fromsignal?Inherited fromtimeoutMs?ExampleInherited fromtoken?topK?urlvectorField?Interface: MongoAtlasVectorConfigPropertiescollectionindexNamenumCandidates?topK?vectorField?Interface: MongoCollectionLikeMethodsaggregate()Type ParametersTParameterspipelineReturnstoArray()ReturnsbulkWrite()?Parametersoperationsoptions?ReturnsdeleteMany()ParametersfilterReturnsinsertMany()Parametersdocsoptions?ReturnsupdateOne()?Parametersfilterupdateoptions?ReturnsInterface: PersonalizationProfilePropertiessubjectIdtraitsupdatedAtInterface: PersonalizationStorePropertiesdelete?ParameterssubjectIdReturnsgetParameterssubjectIdReturnsmergeParameterssubjectIdtraitsReturnssetParametersprofileReturnsInterface: PgVectorConfigPropertiesrunnertable?topK?Interface: PgVectorRunnerPropertiesqueryType ParametersTParameterssqlparamsReturnsInterface: PineconeConfigExtendsPropertiesapiKeyfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsExampleInherited fromindexUrlmaxResponseBytes?ExampleInherited fromnamespace?signal?Inherited fromtimeoutMs?ExampleInherited fromtopK?Interface: QdrantConfigExtendsPropertiesapiKey?collectionfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsExampleInherited frommaxResponseBytes?ExampleInherited fromsignal?Inherited fromtimeoutMs?ExampleInherited fromtopK?urlInterface: RedisChatMemoryConfigExtendsPropertiesclient?Inherited fromconversationId?keyPrefix?urlInherited fromInterface: RedisClientAdapterMethodscall()ParameterscommandargsReturnsdel()ParameterskeyReturnsdisconnect()Returnsget()ParameterskeyReturnskeys()ParameterspatternReturnsset()ParameterskeyvalueReturnsInterface: RedisConnectionConfigExtended byPropertiesclient?urlInterface: RedisKvConfigExtendsPropertiesbackendmaxMessages?Inherited fromprefixttlSeconds?Inherited fromurlInterface: RedisLikeMethodsdel()ParameterskeyReturnsget()ParameterskeyReturnskeys()ParameterspatternReturnsset()Parameterskeyvalueoptions?EX?ReturnsInterface: RedisVectorMemoryConfigExtendsPropertiesclient?Inherited fromdimensions?indexName?keyPrefix?urlInherited fromInterface: RemoteHttpConfigExtended byPropertiesfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsExamplemaxResponseBytes?Examplesignal?timeoutMs?ExampleInterface: SqliteChatMemoryConfigPropertiesconversationId?pathInterface: SqliteKvConfigExtendsPropertiesbackendmaxMessages?Inherited frompathttlSeconds?Inherited fromInterface: SqliteLikeMethodsexec()ParameterssqlReturnsprepare()ParameterssqlReturnstransaction()?Type ParametersTParametersfnReturnsInterface: SqliteStmtMethodsall()ParametersparamsReturnsget()ParametersparamsReturnsrun()ParametersparamsReturnsInterface: SupabaseVectorStoreConfigPropertiesmatchFunction?serviceRoleKeytable?topK?urlInterface: TursoChatMemoryConfigPropertiesauthToken?conversationId?urlInterface: UpstashVectorConfigExtendsPropertiesfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsExampleInherited frommaxResponseBytes?ExampleInherited fromsignal?Inherited fromtimeoutMs?ExampleInherited fromtokentopK?urlInterface: VectorKvConfigExtendsPropertiesbackendcollectionmaxMessages?Inherited fromproviderttlSeconds?Inherited fromInterface: VectorMemoryRedactionOptionsExtendsPropertiesallowedRoles?Inherited fromaudit?Inherited frommode?Inherited fromrulesInherited fromvault?Inherited fromInterface: VectorStoreMethodsdelete()ParametersidsReturnsquery()ParametersvectortopKReturnsupsert()ParametersdocsReturnsInterface: VectorStoreDocumentPropertiesidmetadatavectorInterface: VectorStoreResultPropertiesidmetadatascoreInterface: WeaviateConfigExtendsPropertiesapiKey?classNamefetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsExampleInherited frommaxResponseBytes?ExampleInherited fromsignal?Inherited fromtimeoutMs?ExampleInherited fromtopK?urlInterface: WebStorageLikePropertiesgetItemParameterskeyReturnsremoveItemParameterskeyReturnssetItemParameterskeyvalueReturnsInterface: WebStorageMemoryMigrationPropertieskeysreadParametersvaluekeyReturnsInterface: WebStorageMemoryOptionsPropertiesgetStorageReturnskeymaxMessages?maxRecordBytes?migration?