跳转到内容

索引

用于按用户存储聊天记录的基础接口类。

基础聊天存储 #

基类：EventBaseComponent

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
class BaseChatStore(BaseComponent):
    @classmethod
    def class_name(cls) -> str:
        """Get class name."""
        return "BaseChatStore"

    @abstractmethod
    def set_messages(self, key: str, messages: List[ChatMessage]) -> None:
        """Set messages for a key."""
        ...

    @abstractmethod
    def get_messages(self, key: str) -> List[ChatMessage]:
        """Get messages for a key."""
        ...

    @abstractmethod
    def add_message(self, key: str, message: ChatMessage) -> None:
        """Add a message for a key."""
        ...

    @abstractmethod
    def delete_messages(self, key: str) -> Optional[List[ChatMessage]]:
        """Delete messages for a key."""
        ...

    @abstractmethod
    def delete_message(self, key: str, idx: int) -> Optional[ChatMessage]:
        """Delete specific message for a key."""
        ...

    @abstractmethod
    def delete_last_message(self, key: str) -> Optional[ChatMessage]:
        """Delete last message for a key."""
        ...

    @abstractmethod
    def get_keys(self) -> List[str]:
        """Get all keys."""
        ...

    async def aset_messages(self, key: str, messages: List[ChatMessage]) -> None:
        """Async version of Get messages for a key."""
        await asyncio.to_thread(self.set_messages, key, messages)

    async def aget_messages(self, key: str) -> List[ChatMessage]:
        """Async version of Get messages for a key."""
        return await asyncio.to_thread(self.get_messages, key)

    async def async_add_message(self, key: str, message: ChatMessage) -> None:
        """Async version of Add a message for a key."""
        await asyncio.to_thread(self.add_message, key, message)

    async def adelete_messages(self, key: str) -> Optional[List[ChatMessage]]:
        """Async version of Delete messages for a key."""
        return await asyncio.to_thread(self.delete_messages, key)

    async def adelete_message(self, key: str, idx: int) -> Optional[ChatMessage]:
        """Async version of Delete specific message for a key."""
        return await asyncio.to_thread(self.delete_message, key, idx)

    async def adelete_last_message(self, key: str) -> Optional[ChatMessage]:
        """Async version of Delete last message for a key."""
        return await asyncio.to_thread(self.delete_last_message, key)

    async def aget_keys(self) -> List[str]:
        """Async version of Get all keys."""
        return await asyncio.to_thread(self.get_keys)

class_name classmethod #

class_name() -> str

获取类名。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
12
13
14
15
@classmethod
def class_name(cls) -> str:
    """Get class name."""
    return "BaseChatStore"

set_messages abstractmethod #

set_messages(key: str, messages: List[ChatMessage]) -> None

为某个键设置消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
17
18
19
20
@abstractmethod
def set_messages(self, key: str, messages: List[ChatMessage]) -> None:
    """Set messages for a key."""
    ...

get_messages abstractmethod #

get_messages(key: str) -> List[ChatMessage]

获取指定键的消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
22
23
24
25
@abstractmethod
def get_messages(self, key: str) -> List[ChatMessage]:
    """Get messages for a key."""
    ...

add_message abstractmethod #

add_message(key: str, message: ChatMessage) -> None

为某个键添加一条消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
27
28
29
30
@abstractmethod
def add_message(self, key: str, message: ChatMessage) -> None:
    """Add a message for a key."""
    ...

delete_messages abstractmethod #

delete_messages(key: str) -> Optional[List[ChatMessage]]

删除某个键的消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
32
33
34
35
@abstractmethod
def delete_messages(self, key: str) -> Optional[List[ChatMessage]]:
    """Delete messages for a key."""
    ...

delete_message abstractmethod #

delete_message(key: str, idx: int) -> Optional[ChatMessage]

删除特定键对应的消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
37
38
39
40
@abstractmethod
def delete_message(self, key: str, idx: int) -> Optional[ChatMessage]:
    """Delete specific message for a key."""
    ...

delete_last_message abstractmethod #

delete_last_message(key: str) -> Optional[ChatMessage]

删除某个键的最后一条消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
42
43
44
45
@abstractmethod
def delete_last_message(self, key: str) -> Optional[ChatMessage]:
    """Delete last message for a key."""
    ...

get_keys abstractmethod #

get_keys() -> List[str]

获取所有键。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
47
48
49
50
@abstractmethod
def get_keys(self) -> List[str]:
    """Get all keys."""
    ...

aset_messages async #

aset_messages(key: str, messages: List[ChatMessage]) -> None

异步版本：根据键获取消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
52
53
54
async def aset_messages(self, key: str, messages: List[ChatMessage]) -> None:
    """Async version of Get messages for a key."""
    await asyncio.to_thread(self.set_messages, key, messages)

aget_messages async #

aget_messages(key: str) -> List[ChatMessage]

异步版本：根据键获取消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
56
57
58
async def aget_messages(self, key: str) -> List[ChatMessage]:
    """Async version of Get messages for a key."""
    return await asyncio.to_thread(self.get_messages, key)

async_add_message async #

async_add_message(key: str, message: ChatMessage) -> None

异步版本的为某个键添加消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
60
61
62
async def async_add_message(self, key: str, message: ChatMessage) -> None:
    """Async version of Add a message for a key."""
    await asyncio.to_thread(self.add_message, key, message)

adelete_messages async #

adelete_messages(key: str) -> Optional[List[ChatMessage]]

异步版本：根据键删除消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
64
65
66
async def adelete_messages(self, key: str) -> Optional[List[ChatMessage]]:
    """Async version of Delete messages for a key."""
    return await asyncio.to_thread(self.delete_messages, key)

adelete_message async #

adelete_message(key: str, idx: int) -> Optional[ChatMessage]

异步版本：根据键删除特定消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
68
69
70
async def adelete_message(self, key: str, idx: int) -> Optional[ChatMessage]:
    """Async version of Delete specific message for a key."""
    return await asyncio.to_thread(self.delete_message, key, idx)

adelete_last_message async #

adelete_last_message(key: str) -> Optional[ChatMessage]

异步版本：根据键删除最后一条消息。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
72
73
74
async def adelete_last_message(self, key: str) -> Optional[ChatMessage]:
    """Async version of Delete last message for a key."""
    return await asyncio.to_thread(self.delete_last_message, key)

aget_keys async #

aget_keys() -> List[str]

获取所有键的异步版本。

workflows/handler.py 中的源代码llama_index/core/storage/chat_store/base.py 
76
77
78
async def aget_keys(self) -> List[str]:
    """Async version of Get all keys."""
    return await asyncio.to_thread(self.get_keys)

选项： 成员：- BaseChatStore