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::openai::chat Class Reference
Inheritance diagram for docwire::openai::chat:
docwire::chain_element docwire::with_pimpl< chat > docwire::with_pimpl< chain_element > docwire::with_pimpl_base docwire::with_pimpl_base docwire::openai::analyze_data docwire::openai::classify docwire::openai::detect_sentiment docwire::openai::extract_entities docwire::openai::extract_keywords docwire::openai::find docwire::openai::summarize docwire::openai::translate_to

Public Member Functions

 chat (const std::string &system_message, const std::string &api_key, Model model=Model::gpt_5, float temperature=0.7, ImageDetail image_detail=ImageDetail::automatic)
 
continuation operator() (message_ptr msg, const message_callbacks &emit_message) override
 Executes transform operation for given node data. More...
 
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
 

Additional Inherited Members

- Protected Types inherited from docwire::with_pimpl< chain_element >
using impl_type = pimpl_impl< chain_element >
 
- Protected Types inherited from docwire::with_pimpl< chat >
using impl_type = pimpl_impl< chat >
 
- 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< chat >
impl_typecreate_impl (Args &&... args)
 
 with_pimpl (Args &&... args)
 
 with_pimpl (with_pimpl< chat > &&other) noexcept
 
 with_pimpl (std::nullptr_t)
 
with_pimploperator= (with_pimpl &&other) noexcept
 
impl_typeimpl ()
 
const impl_typeimpl () const
 

Detailed Description

Definition at line 66 of file chat.h.

Member Function Documentation

◆ is_leaf()

bool docwire::openai::chat::is_leaf ( ) const
inlineoverridevirtual

Check if chain element is a leaf (last element which doesn't produce any messages). At this moment only exporters are leafs.

Returns
true if leaf

Implements docwire::chain_element.

Definition at line 80 of file chat.h.

◆ operator()()

continuation docwire::openai::chat::operator() ( message_ptr  msg,
const message_callbacks emit_message 
)
overridevirtual

Executes transform operation for given node data.

See also
docwire::message_ptr
docwire::message_callbacks
Parameters
msgThe input message to process.
emit_messageCallback invoked to emit produced messages.

Implements docwire::chain_element.


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