Skip to main content

FileBasedStorage

Struct FileBasedStorage 

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

基于文件的持久化存储

文件结构:

memory/
├── data.json              # KV 存储 (MemoryValue items)
├── MEMORY.md              # 长期记忆
├── sessions/              # 会话历史
│   ├── <session_id>.json  # 单个会话的消息历史
├── 2024-01-15.md          # 每日笔记 (YYYY-MM-DD.md)
└── ...

§特性

  • 持久化到磁盘
  • 线程安全 (Arc<RwLock>)
  • 原子文件写入 (临时文件 + rename)
  • 懒加载 (启动时从文件加载到内存)

Implementations§

Source§

impl FileBasedStorage

Source

pub async fn new( base_dir: impl AsRef<Path>, ) -> Result<FileBasedStorage, AgentError>

创建新的基于文件的存储

§参数
  • base_dir: 基础目录,将在其下创建 memory/ 和 memory/sessions/
§示例
use mofa_foundation::agent::components::memory::FileBasedStorage;

let storage = FileBasedStorage::new("/tmp/workspace").await?;
Source

pub async fn read_today_file(&self) -> Result<String, AgentError>

读取今日笔记内容

Source

pub async fn append_today_file(&self, content: &str) -> Result<(), AgentError>

追加内容到今日笔记

Source

pub async fn read_long_term_file(&self) -> Result<String, AgentError>

读取长期记忆 (MEMORY.md)

Source

pub async fn write_long_term_file( &self, content: &str, ) -> Result<(), AgentError>

写入长期记忆 (MEMORY.md)

Source

pub async fn get_recent_memories_files( &self, days: u32, ) -> Result<String, AgentError>

获取最近 N 天的记忆

Source

pub async fn get_memory_context(&self) -> Result<String, AgentError>

获取记忆上下文

Source

pub async fn read_today(&self) -> Result<String, AgentError>

读取今日笔记

Source

pub async fn append_today(&self, content: &str) -> Result<(), AgentError>

追加今日笔记

Source

pub async fn read_long_term(&self) -> Result<String, AgentError>

读取长期记忆

Source

pub async fn write_long_term(&self, content: &str) -> Result<(), AgentError>

写入长期记忆

Source

pub async fn get_recent_memories(&self, days: u32) -> Result<String, AgentError>

获取最近记忆

Trait Implementations§

Source§

impl Memory for FileBasedStorage

Source§

fn store<'life0, 'life1, 'async_trait>( &'life0 mut self, key: &'life1 str, value: MemoryValue, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, FileBasedStorage: 'async_trait,

存储记忆项
Source§

fn retrieve<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<MemoryValue>, AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, FileBasedStorage: 'async_trait,

检索记忆项
Source§

fn remove<'life0, 'life1, 'async_trait>( &'life0 mut self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, FileBasedStorage: 'async_trait,

删除记忆项
Source§

fn search<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<MemoryItem>, AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, FileBasedStorage: 'async_trait,

语义搜索
Source§

fn clear<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, FileBasedStorage: 'async_trait,

清空所有记忆
Source§

fn get_history<'life0, 'life1, 'async_trait>( &'life0 self, session_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<Message>, AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, FileBasedStorage: 'async_trait,

获取对话历史
Source§

fn add_to_history<'life0, 'life1, 'async_trait>( &'life0 mut self, session_id: &'life1 str, message: Message, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, FileBasedStorage: 'async_trait,

添加对话消息
Source§

fn clear_history<'life0, 'life1, 'async_trait>( &'life0 mut self, session_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, FileBasedStorage: 'async_trait,

清空对话历史
Source§

fn stats<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<MemoryStats, AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, FileBasedStorage: 'async_trait,

获取记忆统计
Source§

fn memory_type(&self) -> &str

记忆类型名称
Source§

fn contains<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, AgentError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

检查是否存在

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Message for T
where T: Any + Send + 'static,

Source§

fn from_boxed(m: BoxedMessage) -> Result<Self, BoxedDowncastErr>

Convert a BoxedMessage to this concrete type
Source§

fn box_message(self, pid: &ActorId) -> Result<BoxedMessage, BoxedDowncastErr>

Convert this message to a BoxedMessage
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> State for T
where T: Any + Send + 'static,