DocWire SDK
DocWire SDK: Award-winning modern data processing in C++20. SourceForge Community Choice & Microsoft support. AI-driven processing. Supports nearly 100 data formats, including email boxes and OCR. Boost efficiency in text extraction, web data extraction, data mining, document analysis. Offline processing possible for security and confidentiality
docwire::ai::local::passage::embedder Class Reference

Embeds a passage (document chunk) using the local AI model's default passage prefix. The appropriate prefix for the underlying model (e.g. "passage: " for multilingual-e5-small) is applied automatically. No model-specific knowledge required at the call site. More...

#include <local_ai_embed.h>

Inheritance diagram for docwire::ai::local::passage::embedder:
docwire::ai::embed docwire::chain_element docwire::with_pimpl< embed > docwire::with_pimpl< chain_element > docwire::with_pimpl_base docwire::with_pimpl_base

Additional Inherited Members

- Public Member Functions inherited from docwire::ai::embed
 embed (not_null< std::shared_ptr< ai_runner >> model_runner, std::string prefix)
 Construct a local AI embed chain element with a specific model runner and prefix. More...
 
continuation operator() (message_ptr msg, const message_callbacks &emit_message) override
 
bool is_leaf () const override
 Check if chain element is a leaf (last element which doesn't produce any messages). At this moment only exporters are leafs. More...
 
- Public Member Functions inherited from docwire::chain_element
 chain_element (chain_element &&)=default
 
chain_elementoperator= (chain_element &&)=default
 
virtual bool is_generator () const
 
- Protected Types inherited from docwire::with_pimpl< chain_element >
using impl_type = pimpl_impl< chain_element >
 
- Protected Types inherited from docwire::with_pimpl< embed >
using impl_type = pimpl_impl< embed >
 
- Protected Member Functions inherited from docwire::with_pimpl< chain_element >
impl_typecreate_impl (Args &&... args)
 
 with_pimpl (Args &&... args)
 
 with_pimpl (with_pimpl< chain_element > &&other) noexcept
 
 with_pimpl (std::nullptr_t)
 
with_pimploperator= (with_pimpl &&other) noexcept
 
impl_typeimpl ()
 
const impl_typeimpl () const
 
- Protected Member Functions inherited from docwire::with_pimpl< embed >
impl_typecreate_impl (Args &&... args)
 
 with_pimpl (Args &&... args)
 
 with_pimpl (with_pimpl< embed > &&other) noexcept
 
 with_pimpl (std::nullptr_t)
 
with_pimploperator= (with_pimpl &&other) noexcept
 
impl_typeimpl ()
 
const impl_typeimpl () const
 

Detailed Description

Embeds a passage (document chunk) using the local AI model's default passage prefix. The appropriate prefix for the underlying model (e.g. "passage: " for multilingual-e5-small) is applied automatically. No model-specific knowledge required at the call site.

Definition at line 26 of file local_ai_embed.h.


The documentation for this class was generated from the following file: