/
types.py
221 lines (172 loc) · 6.48 KB
/
types.py
1
2
3
4
5
6
7
8
9
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
import os
from abc import ABC, abstractmethod
from dataclasses import dataclass, field
from typing import Any, Dict, List, Optional, Sequence
import fsspec
from dataclasses_json import DataClassJsonMixin
from llama_index.legacy.schema import BaseNode
from llama_index.legacy.storage.kvstore.types import DEFAULT_BATCH_SIZE
DEFAULT_PERSIST_FNAME = "docstore.json"
DEFAULT_PERSIST_DIR = "./storage"
DEFAULT_PERSIST_PATH = os.path.join(DEFAULT_PERSIST_DIR, DEFAULT_PERSIST_FNAME)
@dataclass
class RefDocInfo(DataClassJsonMixin):
"""Dataclass to represent ingested documents."""
node_ids: List = field(default_factory=list)
metadata: Dict[str, Any] = field(default_factory=dict)
class BaseDocumentStore(ABC):
# ===== Save/load =====
def persist(
self,
persist_path: str = DEFAULT_PERSIST_PATH,
fs: Optional[fsspec.AbstractFileSystem] = None,
) -> None:
"""Persist the docstore to a file."""
# ===== Main interface =====
@property
@abstractmethod
def docs(self) -> Dict[str, BaseNode]:
...
@abstractmethod
def add_documents(
self,
docs: Sequence[BaseNode],
allow_update: bool = True,
batch_size: int = DEFAULT_BATCH_SIZE,
store_text: bool = True,
) -> None:
...
@abstractmethod
async def async_add_documents(
self,
docs: Sequence[BaseNode],
allow_update: bool = True,
batch_size: int = DEFAULT_BATCH_SIZE,
store_text: bool = True,
) -> None:
...
@abstractmethod
def get_document(self, doc_id: str, raise_error: bool = True) -> Optional[BaseNode]:
...
@abstractmethod
async def aget_document(
self, doc_id: str, raise_error: bool = True
) -> Optional[BaseNode]:
...
@abstractmethod
def delete_document(self, doc_id: str, raise_error: bool = True) -> None:
"""Delete a document from the store."""
...
@abstractmethod
async def adelete_document(self, doc_id: str, raise_error: bool = True) -> None:
"""Delete a document from the store."""
...
@abstractmethod
def document_exists(self, doc_id: str) -> bool:
...
@abstractmethod
async def adocument_exists(self, doc_id: str) -> bool:
...
# ===== Hash =====
@abstractmethod
def set_document_hash(self, doc_id: str, doc_hash: str) -> None:
...
@abstractmethod
async def aset_document_hash(self, doc_id: str, doc_hash: str) -> None:
...
@abstractmethod
def set_document_hashes(self, doc_hashes: Dict[str, str]) -> None:
...
@abstractmethod
async def aset_document_hashes(self, doc_hashes: Dict[str, str]) -> None:
...
@abstractmethod
def get_document_hash(self, doc_id: str) -> Optional[str]:
...
@abstractmethod
async def aget_document_hash(self, doc_id: str) -> Optional[str]:
...
@abstractmethod
def get_all_document_hashes(self) -> Dict[str, str]:
...
@abstractmethod
async def aget_all_document_hashes(self) -> Dict[str, str]:
...
# ==== Ref Docs =====
@abstractmethod
def get_all_ref_doc_info(self) -> Optional[Dict[str, RefDocInfo]]:
"""Get a mapping of ref_doc_id -> RefDocInfo for all ingested documents."""
@abstractmethod
async def aget_all_ref_doc_info(self) -> Optional[Dict[str, RefDocInfo]]:
"""Get a mapping of ref_doc_id -> RefDocInfo for all ingested documents."""
@abstractmethod
def get_ref_doc_info(self, ref_doc_id: str) -> Optional[RefDocInfo]:
"""Get the RefDocInfo for a given ref_doc_id."""
@abstractmethod
async def aget_ref_doc_info(self, ref_doc_id: str) -> Optional[RefDocInfo]:
"""Get the RefDocInfo for a given ref_doc_id."""
@abstractmethod
def delete_ref_doc(self, ref_doc_id: str, raise_error: bool = True) -> None:
"""Delete a ref_doc and all it's associated nodes."""
@abstractmethod
async def adelete_ref_doc(self, ref_doc_id: str, raise_error: bool = True) -> None:
"""Delete a ref_doc and all it's associated nodes."""
# ===== Nodes =====
def get_nodes(
self, node_ids: List[str], raise_error: bool = True
) -> List[BaseNode]:
"""Get nodes from docstore.
Args:
node_ids (List[str]): node ids
raise_error (bool): raise error if node_id not found
"""
return [self.get_node(node_id, raise_error=raise_error) for node_id in node_ids]
async def aget_nodes(
self, node_ids: List[str], raise_error: bool = True
) -> List[BaseNode]:
"""Get nodes from docstore.
Args:
node_ids (List[str]): node ids
raise_error (bool): raise error if node_id not found
"""
return [
await self.aget_node(node_id, raise_error=raise_error)
for node_id in node_ids
]
def get_node(self, node_id: str, raise_error: bool = True) -> BaseNode:
"""Get node from docstore.
Args:
node_id (str): node id
raise_error (bool): raise error if node_id not found
"""
doc = self.get_document(node_id, raise_error=raise_error)
if not isinstance(doc, BaseNode):
raise ValueError(f"Document {node_id} is not a Node.")
return doc
async def aget_node(self, node_id: str, raise_error: bool = True) -> BaseNode:
"""Get node from docstore.
Args:
node_id (str): node id
raise_error (bool): raise error if node_id not found
"""
doc = await self.aget_document(node_id, raise_error=raise_error)
if not isinstance(doc, BaseNode):
raise ValueError(f"Document {node_id} is not a Node.")
return doc
def get_node_dict(self, node_id_dict: Dict[int, str]) -> Dict[int, BaseNode]:
"""Get node dict from docstore given a mapping of index to node ids.
Args:
node_id_dict (Dict[int, str]): mapping of index to node ids
"""
return {
index: self.get_node(node_id) for index, node_id in node_id_dict.items()
}
async def aget_node_dict(self, node_id_dict: Dict[int, str]) -> Dict[int, BaseNode]:
"""Get node dict from docstore given a mapping of index to node ids.
Args:
node_id_dict (Dict[int, str]): mapping of index to node ids
"""
return {
index: await self.aget_node(node_id)
for index, node_id in node_id_dict.items()
}