Skip to content

Indexer

Document Processing Orchestrator Indexer Package.

Modules:

Name Description
BaseIndexer

Abstract base class for indexing document.

BaseIndexer

Bases: ABC

Base class for document converter.

delete(**kwargs) abstractmethod

Delete document from a vector DB.

The arguments are not defined yet, it depends on the implementation. Some vector database will require: db_url, index_name, document_id.

Parameters:

Name Type Description Default
**kwargs Any

Additional keyword arguments for customization.

{}

Returns:

Name Type Description
Any Any

The response from the deletion process.

index(elements, **kwargs) abstractmethod

Index data from a source file into Elasticsearch.

Parameters:

Name Type Description Default
elements Any

The information to be indexed. Ideally formatted as List[Dict] and each Dict following the structure of model 'Element'.

required
**kwargs Any

Additional keyword arguments for customization.

{}

Returns:

Name Type Description
Any Any

The response from the indexing process.