Index
RefDocInfo
dataclass
#
Bases: DataClassJsonMixin
Dataclass to represent ingested documents.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
node_ids |
List
|
|
[]
|
metadata |
Dict[str, Any]
|
|
{}
|
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
16 17 18 19 20 21 |
|
BaseDocumentStore #
Bases: ABC
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
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 |
|
persist #
persist(persist_path: str = DEFAULT_PERSIST_PATH, fs: Optional[AbstractFileSystem] = None) -> None
Persist the docstore to a file.
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
26 27 28 29 30 31 |
|
delete_document
abstractmethod
#
delete_document(doc_id: str, raise_error: bool = True) -> None
Delete a document from the store.
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
69 70 71 72 |
|
adelete_document
abstractmethod
async
#
adelete_document(doc_id: str, raise_error: bool = True) -> None
Delete a document from the store.
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
74 75 76 77 |
|
get_all_ref_doc_info
abstractmethod
#
get_all_ref_doc_info() -> Optional[Dict[str, RefDocInfo]]
Get a mapping of ref_doc_id -> RefDocInfo for all ingested documents.
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
121 122 123 |
|
aget_all_ref_doc_info
abstractmethod
async
#
aget_all_ref_doc_info() -> Optional[Dict[str, RefDocInfo]]
Get a mapping of ref_doc_id -> RefDocInfo for all ingested documents.
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
125 126 127 |
|
get_ref_doc_info
abstractmethod
#
get_ref_doc_info(ref_doc_id: str) -> Optional[RefDocInfo]
Get the RefDocInfo for a given ref_doc_id.
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
129 130 131 |
|
aget_ref_doc_info
abstractmethod
async
#
aget_ref_doc_info(ref_doc_id: str) -> Optional[RefDocInfo]
Get the RefDocInfo for a given ref_doc_id.
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
133 134 135 |
|
delete_ref_doc
abstractmethod
#
delete_ref_doc(ref_doc_id: str, raise_error: bool = True) -> None
Delete a ref_doc and all it's associated nodes.
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
137 138 139 |
|
adelete_ref_doc
abstractmethod
async
#
adelete_ref_doc(ref_doc_id: str, raise_error: bool = True) -> None
Delete a ref_doc and all it's associated nodes.
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
141 142 143 |
|
get_nodes #
get_nodes(node_ids: List[str], raise_error: bool = True) -> List[BaseNode]
Get nodes from docstore.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
node_ids |
List[str]
|
node ids |
required |
raise_error |
bool
|
raise error if node_id not found |
True
|
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
146 147 148 149 150 151 152 153 154 155 156 |
|
aget_nodes
async
#
aget_nodes(node_ids: List[str], raise_error: bool = True) -> List[BaseNode]
Get nodes from docstore.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
node_ids |
List[str]
|
node ids |
required |
raise_error |
bool
|
raise error if node_id not found |
True
|
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
|
get_node #
get_node(node_id: str, raise_error: bool = True) -> BaseNode
Get node from docstore.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
node_id |
str
|
node id |
required |
raise_error |
bool
|
raise error if node_id not found |
True
|
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
173 174 175 176 177 178 179 180 181 182 183 184 |
|
aget_node
async
#
aget_node(node_id: str, raise_error: bool = True) -> BaseNode
Get node from docstore.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
node_id |
str
|
node id |
required |
raise_error |
bool
|
raise error if node_id not found |
True
|
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
186 187 188 189 190 191 192 193 194 195 196 197 |
|
get_node_dict #
get_node_dict(node_id_dict: Dict[int, str]) -> Dict[int, BaseNode]
Get node dict from docstore given a mapping of index to node ids.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
node_id_dict |
Dict[int, str]
|
mapping of index to node ids |
required |
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
199 200 201 202 203 204 205 206 207 208 |
|
aget_node_dict
async
#
aget_node_dict(node_id_dict: Dict[int, str]) -> Dict[int, BaseNode]
Get node dict from docstore given a mapping of index to node ids.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
node_id_dict |
Dict[int, str]
|
mapping of index to node ids |
required |
Source code in llama-index-core/llama_index/core/storage/docstore/types.py
210 211 212 213 214 215 216 217 218 219 220 |
|