← Agent Memory / agent-memory / api

API Workers

Используйте Workers API, чтобы получать доступ к Agent Memory из вашего Worker. Привязка соединяет ваш Worker с пространство имён содержащее профили, которые представляют собой изолированные хранилища памяти для вашего агента.

Добавьте agent_memory запись в конфигурацию Wrangler. binding поле задаёт имя переменной, которую вы используете в коде Worker, а namespace поле указывает пространство имён Agent Memory, к которому выполняется привязка.

{
  "$schema": "./node_modules/wrangler/config-schema.json",
  "agent_memory": [
    {
      "binding": "MEMORY",
      "namespace": "<NAMESPACE_NAME>"
    }
  ]
}

[[agent_memory]]
binding = "MEMORY"
namespace = "<NAMESPACE_NAME>"

Чтобы привязать несколько пространств имён, добавьте несколько записей в agent_memory массив.

Запустите npx wrangler types чтобы сгенерировать тип привязки в worker-configuration.d.ts:

interface Env {
	MEMORY: AgentMemoryNamespace;
}

Используйте методы пространства имён у привязки, чтобы получать доступ к профилям памяти и управлять ими.

Возвращает профиль памяти по имени. Если профиль не существует, Agent Memory создаёт его.

• profileName string обязательно: имя профиля для доступа. Максимум 100 символов.
• Возвращает Promise<AgentMemoryProfile>

Первые getProfile() вызов для нового профиля может занять больше времени, пока Agent Memory создаёт профиль.

Помечает профиль и все связанные с ним воспоминания и сообщения для удаления.

• profileName string обязательно: имя профиля для удаления. Максимум 100 символов.
• Возвращает Promise<void>

Вызывайте методы профиля после того, как получите его через привязку.

type AgentMemoryMemory = {
	id: string;
	type: "fact" | "event" | "instruction" | "task";
	summary: string;
	content: string;
	sessionId: string | null;
	createdAt: Date;
	updatedAt: Date;
};

Обрабатывает разговор и извлекает из него структурированные воспоминания. Agent Memory автоматически определяет факты, события, инструкции и задачи, поэтому вам не нужно указывать, что именно запоминать.

• messages Iterable<AgentMemoryMessage> обязательно: сообщения разговора для обработки.
• options.sessionId string | null необязательно: идентификатор сессии разговора. Максимум 64 символа. Если не указан, Agent Memory формирует его на основе содержимого сообщения.
• Возвращает Promise<void>

type AgentMemoryMessage = {
	role: "system" | "user" | "assistant";
	content: string; // Max 32 KB
	timestamp?: Date;
};

ingest() идемпотентен. Повторная загрузка того же разговора не создаёт дублирующиеся записи памяти.

Явно сохраняет одно воспоминание. Используйте remember() когда ваше приложение или агент уже знает, что нужно сохранить, вместо передачи разговора в ingest() для извлечения.

• memory.content string обязательно: содержимое записи памяти для сохранения. Сервис автоматически классифицирует его и формирует краткое описание.
• memory.sessionId string | null необязательно: идентификатор связанной сессии разговора.
• Возвращает Promise<AgentMemoryMemory>

Выполняет поиск по сохранённым воспоминаниям в профиле и возвращает обобщённый ответ, основанный на сохранённом содержимом.

• query string обязательно: вопрос или поисковый запрос на естественном языке. Максимум 1 КБ (1,024 байта UTF-8).
• options.thinkingLevel "low" | "medium" | "high" необязательно (по умолчанию: "low"): управляет широтой поиска. Более высокие уровни просматривают больше кандидатов, но работают дольше.
• options.responseLength "short" | "medium" | "long" необязательно (по умолчанию: "medium"): управляет подробностью сформированного ответа.
• options.referenceDate Date | string необязательно: опорная точка по времени для запросов, зависящих от даты.
• Возвращает Promise<AgentMemoryRecallResult>

type AgentMemoryRecallResult = {
	count: number;
	answer: string;
	candidates: AgentMemoryScoredCandidate[];
};

type AgentMemoryScoredCandidate = {
	id: string;
	summary: string;
	sessionId: string | null;
	score: number;
};

Если ни одна запись не соответствует запросу, recall() возвращает пустой ответ.

Возвращает список воспоминаний, сохранённых в профиле. Предоставляет постраничное представление сохранённых воспоминаний с возможностью фильтрации. Используйте возвращённый cursor (если присутствует) для получения следующей страницы.

• options.limit number необязательно (по умолчанию: 20, максимум: 500): максимальное количество записей памяти для возврата.
• options.cursor string необязательно: непрозрачный курсор с предыдущей страницы.
• options.sessionId string необязательно: фильтр по точному совпадению сессии.
• options.type "fact" | "event" | "instruction" | "task" необязательно: фильтр по точному совпадению типа записи памяти.
• Возвращает Promise<AgentMemoryListMemoriesResult>

type AgentMemoryMemoryListEntry = Omit<AgentMemoryMemory, "content">;

type AgentMemoryListMemoriesResult = {
	memories: AgentMemoryMemoryListEntry[];
	cursor?: string;
};

Записи списка не включают content. Используйте get(memoryId) чтобы получить полную запись памяти.

Возвращает воспоминание по идентификатору.

• memoryId string обязательно: ID записи памяти.
• Возвращает Promise<AgentMemoryMemory>

Выбрасывает ошибку, если воспоминание не существует.

Удаляет запись по идентификатору. Удаляет саму запись и все связанные с ней исходные сообщения. Возвращает удалённую запись.

• memoryId string обязательно: ID записи памяти.
• Возвращает Promise<AgentMemoryMemory>

Выбрасывает ошибку, если воспоминание не существует.

Помечает для удаления все воспоминания и сообщения в профиле, помеченные указанным идентификатором сессии. Записи других сессий в том же профиле не затрагиваются. Операция идемпотентна: удаление идентификатора сессии, для которого нет записей, ничего не делает.

• sessionId string обязательно: ID сессии для удаления. Максимум 64 символа.
• Возвращает Promise<void>

Формирует структурированную сводку в формате Markdown обо всём, что хранится в профиле памяти. Используйте её, чтобы посмотреть, что Agent Memory помнит о профиле.

• options.sessionId string | null необязательно: ID сессии, определяющий раздел "Last Session" в сводке. Если не указан, Agent Memory использует последнюю сессию.
• Возвращает Promise<AgentMemoryGetSummaryResponse>

type AgentMemoryGetSummaryResponse = {
	summary: string;
};

См. Лимиты для полного списка ограничений.