Index

BaseMemory

Bases: BaseComponent

所有内存类型的基类。

注意：内存接口尚未最终确定，可能会发生变化。

Source code in llama_index/core/memory/types.py

class BaseMemory(BaseComponent):
    """所有内存类型的基类。

注意：内存接口尚未最终确定，可能会发生变化。"""

    @classmethod
    def class_name(cls) -> str:
        """获取类名。"""
        return "BaseMemory"

    @classmethod
    @abstractmethod
    def from_defaults(
        cls,
        chat_history: Optional[List[ChatMessage]] = None,
        llm: Optional[LLM] = None,
    ) -> "BaseMemory":
        """从默认值创建一个聊天内存。"""

    @abstractmethod
    def get(self, input: Optional[str] = None, **kwargs: Any) -> List[ChatMessage]:
        """获取聊天记录。"""

    @abstractmethod
    def get_all(self) -> List[ChatMessage]:
        """获取所有聊天记录。"""

    @abstractmethod
    def put(self, message: ChatMessage) -> None:
        """放置聊天记录。"""

    def put_messages(self, messages: List[ChatMessage]) -> None:
        """放置聊天记录。"""
        for message in messages:
            self.put(message)

    @abstractmethod
    def set(self, messages: List[ChatMessage]) -> None:
        """设置聊天记录。"""

    @abstractmethod
    def reset(self) -> None:
        """重置聊天记录。"""

class_name classmethod

class_name() -> str

获取类名。

Source code in llama_index/core/memory/types.py

@classmethod
def class_name(cls) -> str:
    """获取类名。"""
    return "BaseMemory"

from_defaults abstractmethod classmethod

from_defaults(
    chat_history: Optional[List[ChatMessage]] = None,
    llm: Optional[LLM] = None,
) -> BaseMemory

从默认值创建一个聊天内存。

Source code in llama_index/core/memory/types.py

@classmethod
@abstractmethod
def from_defaults(
    cls,
    chat_history: Optional[List[ChatMessage]] = None,
    llm: Optional[LLM] = None,
) -> "BaseMemory":
    """从默认值创建一个聊天内存。"""

get abstractmethod

get(
    input: Optional[str] = None, **kwargs: Any
) -> List[ChatMessage]

获取聊天记录。

Source code in llama_index/core/memory/types.py

@abstractmethod
def get(self, input: Optional[str] = None, **kwargs: Any) -> List[ChatMessage]:
    """获取聊天记录。"""

get_all abstractmethod

get_all() -> List[ChatMessage]

获取所有聊天记录。

Source code in llama_index/core/memory/types.py

@abstractmethod
def get_all(self) -> List[ChatMessage]:
    """获取所有聊天记录。"""

put abstractmethod

put(message: ChatMessage) -> None

放置聊天记录。

Source code in llama_index/core/memory/types.py

@abstractmethod
def put(self, message: ChatMessage) -> None:
    """放置聊天记录。"""

put_messages

put_messages(messages: List[ChatMessage]) -> None

放置聊天记录。

Source code in llama_index/core/memory/types.py

def put_messages(self, messages: List[ChatMessage]) -> None:
    """放置聊天记录。"""
    for message in messages:
        self.put(message)

set abstractmethod

set(messages: List[ChatMessage]) -> None

设置聊天记录。

Source code in llama_index/core/memory/types.py

@abstractmethod
def set(self, messages: List[ChatMessage]) -> None:
    """设置聊天记录。"""

reset abstractmethod

reset() -> None

重置聊天记录。

Source code in llama_index/core/memory/types.py

@abstractmethod
def reset(self) -> None:
    """重置聊天记录。"""

BaseChatStoreMemory

Bases: BaseMemory

任何的基类。

注意：内存的接口尚未最终确定，可能会发生变化。

Source code in llama_index/core/memory/types.py

class BaseChatStoreMemory(BaseMemory):
    """任何的基类。

    注意：内存的接口尚未最终确定，可能会发生变化。"""

    chat_store: BaseChatStore = Field(default_factory=SimpleChatStore)
    chat_store_key: str = Field(default=DEFAULT_CHAT_STORE_KEY)

    @classmethod
    def class_name(cls) -> str:
        """获取类名。"""
        return "BaseChatStoreMemory"

    @classmethod
    @abstractmethod
    def from_defaults(
        cls,
        chat_history: Optional[List[ChatMessage]] = None,
        llm: Optional[LLM] = None,
    ) -> "BaseChatStoreMemory":
        """从默认值创建一个聊天内存。"""

    def get_all(self) -> List[ChatMessage]:
        """获取所有聊天记录。"""
        return self.chat_store.get_messages(self.chat_store_key)

    def put(self, message: ChatMessage) -> None:
        """放置聊天记录。"""
        # ensure everything is serialized
        self.chat_store.add_message(self.chat_store_key, message)

    def set(self, messages: List[ChatMessage]) -> None:
        """设置聊天记录。"""
        self.chat_store.set_messages(self.chat_store_key, messages)

    def reset(self) -> None:
        """重置聊天记录。"""
        self.chat_store.delete_messages(self.chat_store_key)

class_name classmethod

class_name() -> str

获取类名。

Source code in llama_index/core/memory/types.py

@classmethod
def class_name(cls) -> str:
    """获取类名。"""
    return "BaseChatStoreMemory"

from_defaults abstractmethod classmethod

from_defaults(
    chat_history: Optional[List[ChatMessage]] = None,
    llm: Optional[LLM] = None,
) -> BaseChatStoreMemory

从默认值创建一个聊天内存。

Source code in llama_index/core/memory/types.py

@classmethod
@abstractmethod
def from_defaults(
    cls,
    chat_history: Optional[List[ChatMessage]] = None,
    llm: Optional[LLM] = None,
) -> "BaseChatStoreMemory":
    """从默认值创建一个聊天内存。"""

get_all

get_all() -> List[ChatMessage]

获取所有聊天记录。

Source code in llama_index/core/memory/types.py

def get_all(self) -> List[ChatMessage]:
    """获取所有聊天记录。"""
    return self.chat_store.get_messages(self.chat_store_key)

put

put(message: ChatMessage) -> None

放置聊天记录。

Source code in llama_index/core/memory/types.py

def put(self, message: ChatMessage) -> None:
    """放置聊天记录。"""
    # ensure everything is serialized
    self.chat_store.add_message(self.chat_store_key, message)

set

set(messages: List[ChatMessage]) -> None

设置聊天记录。

Source code in llama_index/core/memory/types.py

def set(self, messages: List[ChatMessage]) -> None:
    """设置聊天记录。"""
    self.chat_store.set_messages(self.chat_store_key, messages)

reset

reset() -> None

重置聊天记录。

Source code in llama_index/core/memory/types.py

def reset(self) -> None:
    """重置聊天记录。"""
    self.chat_store.delete_messages(self.chat_store_key)