Skip to content

Latest commit

 

History

History
71 lines (58 loc) · 1.98 KB

File metadata and controls

71 lines (58 loc) · 1.98 KB
title batch_get_documents
description Retrieve multiple documents by their IDs in a single batch operation
```python def batch_get_documents( document_ids: List[str], folder_name: Optional[Union[str, List[str]]] = None, ) -> List[Document] ``` ```python async def batch_get_documents( document_ids: List[str], folder_name: Optional[Union[str, List[str]]] = None, ) -> List[Document] ```

Parameters

  • document_ids (List[str]): List of document IDs to retrieve
  • folder_name (str | List[str], optional): Optional folder scope. Accepts canonical paths or a list of paths/names.

Returns

  • List[Document]: List of document metadata for found documents

Examples

```python from morphik import Morphik
db = Morphik()

docs = db.batch_get_documents(["doc_123", "doc_456", "doc_789"])
for doc in docs:
    print(f"Document {doc.external_id}: {doc.metadata.get('title')}")
```
```python from morphik import AsyncMorphik
async with AsyncMorphik() as db:
    docs = await db.batch_get_documents(["doc_123", "doc_456", "doc_789"])
    for doc in docs:
        print(f"Document {doc.external_id}: {doc.metadata.get('title')}")
```

Document Properties

Each Document object in the returned list has the following properties:

  • external_id (str): Unique document identifier
  • content_type (str): Content type of the document
  • filename (Optional[str]): Original filename if available
  • metadata (Dict[str, Any]): User-defined metadata
  • storage_info (Dict[str, str]): Storage-related information
  • system_metadata (Dict[str, Any]): System-managed metadata
  • chunk_ids (List[str]): IDs of document chunks
  • folder_path (Optional[str]): Canonical folder path (includes nested parents when scoped)