LlamaIndex Search K

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

BaseDocumentStore #
Bases: ABC

Source code in llama-index-core/llama_index/core/storage/docstore/types.py

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

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

Ask AI
stable
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

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

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

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

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

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

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

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

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

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

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

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

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

Previous Next
Firestore Mongodb