Skip to main content

Usage

Parameters

  • files (List[Union[str, bytes, BinaryIO, Path]]): List of files to ingest (path strings, bytes, file objects, or Path objects)
  • metadata (Dict[str, Any] | List[Dict[str, Any]], optional): Metadata to apply to the files. Can be either:
    • A single dict to apply to all files
    • A list of dicts, one per file (must match the length of files)
  • use_colpali (bool, optional): Whether to use ColPali-style embedding model. Defaults to True.
  • parallel (bool, optional): Whether to process files in parallel. Defaults to True.

Typed Metadata

When specifying metadata, you can include Python datetime, date, Decimal, or numeric types. The SDK normalizes them, sends the accompanying metadata_types, and unlocks the advanced queries outlined in Metadata Filtering.

Returns

An object containing:
  • documents: List of successfully ingested Document objects
  • errors: List of errors encountered during ingestion (each error is a dict with ‘filename’ and ‘error’ keys)

Advanced Examples

Per-File Metadata

Using Different File Input Types