Skip to content

Index

Base interface class for storing chat history per user.

BaseChatStore #

Bases: BaseComponent

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
10
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
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

Get class name.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
11
12
13
14
@classmethod
def class_name(cls) -> str:
    """Get class name."""
    return "BaseChatStore"

set_messages abstractmethod #

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

Set messages for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
16
17
18
19
@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]

Get messages for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
21
22
23
24
@abstractmethod
def get_messages(self, key: str) -> List[ChatMessage]:
    """Get messages for a key."""
    ...

add_message abstractmethod #

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

Add a message for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
26
27
28
29
@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]]

Delete messages for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
31
32
33
34
@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]

Delete specific message for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
36
37
38
39
@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]

Delete last message for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
41
42
43
44
@abstractmethod
def delete_last_message(self, key: str) -> Optional[ChatMessage]:
    """Delete last message for a key."""
    ...

get_keys abstractmethod #

get_keys() -> List[str]

Get all keys.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
46
47
48
49
@abstractmethod
def get_keys(self) -> List[str]:
    """Get all keys."""
    ...

aset_messages async #

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

Async version of Get messages for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
51
52
53
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]

Async version of Get messages for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
55
56
57
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

Async version of Add a message for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
59
60
61
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]]

Async version of Delete messages for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
63
64
65
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]

Async version of Delete specific message for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
67
68
69
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]

Async version of Delete last message for a key.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
71
72
73
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]

Async version of Get all keys.

Source code in llama-index-core/llama_index/core/storage/chat_store/base.py 
75
76
77
async def aget_keys(self) -> List[str]:
    """Async version of Get all keys."""
    return await asyncio.to_thread(self.get_keys)