Skip to main content

Parameters

  • document_id (str): ID of the document

Returns

  • Document: Document metadata

Examples

Document Properties

The Document object returned by this method 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

Document Methods

The Document object also provides the following methods:
  • update_with_text(): Update the document with new text content
  • update_with_file(): Update the document with content from a file
  • update_metadata(): Update the document’s metadata only