Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

cstar.io.retriever.Retriever.save

Retriever.save(target_dir: Path) → Path

Save this object to the given directory.

This method performs common setup ( ensuring the target directory exists) and then calls the subclass-defined _save() method for the actual save.