Skip to main content

MemoryApi

Struct MemoryApi 

Source
pub struct MemoryApi { /* private fields */ }
Expand description

Agent memory management

Implementations§

Source§

impl MemoryApi

Source

pub async fn delete_memory_entry( &self, agent_id: &str, entry_id: &str, ) -> Result<DeleteMemoryEntryResponse>

Delete memory entry

DELETE /api/v1/agents/{agentId}/memory/{entryId}

Required scopes: memory:write.

Source

pub async fn get_core_memory_block( &self, agent_id: &str, label: &str, ) -> Result<CoreMemoryBlock>

Get a core memory block

GET /api/v1/agents/{agentId}/memory/core/{label}

Required scopes: memory:read.

Source

pub async fn get_memories_by_entity( &self, agent_id: &str, entity_id: &str, ) -> Result<GetMemoriesByEntityResponse>

Get memory entries associated with an entity

GET /api/v1/agents/{agentId}/memory/entities/{entityId}

Required scopes: memory:read.

Source

pub async fn get_memory_entry( &self, agent_id: &str, entry_id: &str, ) -> Result<Value>

Get memory entry

GET /api/v1/agents/{agentId}/memory/{entryId}

Required scopes: memory:read.

Source

pub async fn import_agent_memory( &self, agent_id: &str, body: &ImportAgentMemoryRequest, ) -> Result<ImportAgentMemoryResponse>

Put back what an export took out

Accepts the memory.json an account export writes: a flat entries array, or agents\[\].entries (every agent’s entries are imported into THIS agent). Each entry is tagged imported. Dedup is the store’s: re-importing the same file returns the existing entries as duplicates instead of doubling them. A file with no entries is 400.

POST /api/v1/agents/{agentId}/memory/import

Required scopes: memory:write.

Source

pub async fn ingest_memory( &self, agent_id: &str, body: &IngestMemoryRequest, ) -> Result<IngestMemoryResponse>

Ingest a file into agent memory

Chunks the file content (default 600 chars), embeds each chunk, and stores embeddings as memory entries. Source: pre-uploaded file_id (preferred) or inline content. Max 2 MB of text per ingest call; rate-limited and quota-counted.

POST /api/v1/agents/{agentId}/memory/ingest

Required scopes: memory:write.

Source

pub async fn list_memories( &self, agent_id: &str, params: &ListMemoriesParams, ) -> Result<ListMemoriesResponse>

List recent memories for an agent

GET /api/v1/agents/{agentId}/memory

Required scopes: memory:read.

Source

pub async fn search( &self, agent_id: &str, body: &Value, ) -> Result<SearchMemoryResponse>

Search agent memories

POST /api/v1/agents/{agentId}/memory/search

Required scopes: memory:write.

Source

pub async fn update_agent_memory_entry( &self, agent_id: &str, entry_id: &str, body: &Map<String, Value>, ) -> Result<MemoryEntry>

Update memory entry

PUT /api/v1/agents/{agentId}/memory/{entryId}

Required scopes: memory:write.

Source

pub async fn update_core_memory_block( &self, agent_id: &str, label: &str, body: &UpdateCoreMemoryBlockRequest, ) -> Result<CoreMemoryBlock>

Update a core memory block

PUT /api/v1/agents/{agentId}/memory/core/{label}

Required scopes: memory:write.

Trait Implementations§

Source§

impl Clone for MemoryApi

Source§

fn clone(&self) -> MemoryApi

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MemoryApi

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more