COBS Python API Reference

Classes and Types

FileType	Enum of indexable file types
DocumentEntry	DocumentEntry object specifying a document to be indexed.
DocumentList	List of DocumentEntry objects for indexing
ClassicIndexParameters	Parameter object for classic_construct()
CompactIndexParameters	Parameter object for compact_construct()
Search	Search object to run queries on COBS indices

Methods

classic_construct(input, out_file, ...)	Construct a COBS Classic Index from a path of input files.
classic_construct_list(list, out_file, ...)	Construct a COBS Classic Index from a pre-populated DocumentList object.
compact_construct(input, out_file, ...)	Construct a COBS Compact Index from a path of input files.
compact_construct_list(list, out_file, ...)	Construct a COBS Compact Index from a pre-populated DocumentList object.
disable_cache([disable])	disable FastA/FastQ cache files globally