TextAutoGenerateText::TextAutoGenerateTextPlugin Class
class TextAutoGenerateText::TextAutoGenerateTextPluginThe TextAutoGenerateTextPlugin class Author: Laurent Montel <montel@kde.org>. More...
| Header: | #include <TextAutoGenerateText/TextAutoGenerateTextPlugin> |
| Inherits: | QObject |
Public Types
| struct | EditSendInfo |
| struct | ModelInfoNameAndIdentifier |
| struct | SendToAssistantInfo |
| enum class | EngineType { Local, Network } |
Public Functions
| TextAutoGenerateTextPlugin(TextAutoGenerateText::TextAutoGenerateManager *manager, TextAutoGenerateText::TextAutoGenerateTextInstance *instance, QObject *parent = nullptr) | |
| virtual | ~TextAutoGenerateTextPlugin() override |
| virtual TextAutoGenerateText::TextAutoGenerateTextPlugin::ActivateInstanceActionInfo | activateInstanceAction() |
| virtual void | askToAssistant(const QString &msg) = 0 |
| virtual void | cancelRequest(const QByteArray &uuid) |
| virtual TextAutoGenerateText::TextAutoGenerateReply * | chatCompletion(const TextAutoGenerateText::TextAutoGenerateTextRequest &request) |
| virtual void | clear() |
| virtual QString | currentModel() const = 0 |
| virtual QString | displayName() const = 0 |
| void | editMessage(const TextAutoGenerateText::TextAutoGenerateTextPlugin::EditSendInfo &info) |
| virtual QString | engineName() const = 0 |
| virtual TextAutoGenerateText::TextAutoGenerateTextPlugin::EngineType | engineType() const = 0 |
| virtual bool | hasAudioSupport() const = 0 |
| virtual bool | hasOcrSupport() const = 0 |
| virtual bool | hasSystemMessageSupport() const |
| virtual bool | hasTextOnlySupport() const |
| virtual bool | hasThinkSupport() const = 0 |
| virtual bool | hasToolsSupport() const = 0 |
| virtual bool | hasVisionSupport() const = 0 |
| QByteArray | instanceUuid() const |
| virtual bool | isLocalServer() const |
| virtual void | load(const KConfigGroup &config) |
| TextAutoGenerateText::TextAutoGenerateManager * | manager() const |
| QList<TextAutoGenerateText::TextAutoGenerateTextPlugin::ModelInfoNameAndIdentifier> | models() const |
| bool | ready() const |
| virtual void | remove() |
| virtual void | save(KConfigGroup &config) |
| void | sendMessage(const TextAutoGenerateText::TextAutoGenerateTextPlugin::EditSendInfo &info) |
| virtual void | setCurrentModel(const QString &) = 0 |
| virtual void | setDisplayName(const QString &newName) = 0 |
| void | setHasError(bool error) |
| void | setReady(bool newReady) |
| virtual QString | shareNamePrompt() const |
| virtual void | showConfigureDialog(QWidget *parentWidget) = 0 |
| virtual QString | thinkingLevel() const |
| virtual TextAutoGenerateText::TextAutoGenerateMessage::ToolCallFormat | toolCallFormat() const |
| virtual QString | translatedPluginName() const = 0 |
Signals
| void | askToAssistantAnswer(const TextAutoGenerateText::TextAutoGenerateReply::Response &message) |
| void | askToAssistantDone() |
| void | callTools(const QList<TextAutoGenerateText::TextAutoGenerateReply::ToolCallArgumentInfo> &info) |
| void | configChanged() |
| void | currentModelChanged() |
| void | downloadErrorOccurred(const QString &message) |
| void | downloadModelFinished(const QString &modelName) |
| void | errorOccurred(QNetworkReply::NetworkError e, const QString &errorString) |
| void | initializedDone() |
| void | processStartFailed(const QString &errorStr) |
| void | processStartSuccessed() |
Static Public Members
| QString | convertEngineType(TextAutoGenerateText::TextAutoGenerateTextPlugin::EngineType type) |
Protected Functions
| void | cancelToolCalls(const QByteArray &uuid) |
| TextAutoGenerateText::TextAutoGenerateTextRequest | convertSendToAssistantInfoToTextRequest(const TextAutoGenerateText::TextAutoGenerateTextPlugin::SendToAssistantInfo &info) const |
| QString | fallBackModel() const |
| void | processToolCalls(const TextAutoGenerateText::TextAutoGenerateTextPlugin::SendToAssistantInfo &info, const TextAutoGenerateText::TextAutoGenerateReply::Response &response) |
| virtual void | sendToAssistant(const TextAutoGenerateText::TextAutoGenerateTextPlugin::SendToAssistantInfo &info) = 0 |
Detailed Description
Member Type Documentation
enum class TextAutoGenerateTextPlugin::EngineType
The EngineType enum
Member Function Documentation
[explicit] TextAutoGenerateTextPlugin::TextAutoGenerateTextPlugin(TextAutoGenerateText::TextAutoGenerateManager *manager, TextAutoGenerateText::TextAutoGenerateTextInstance *instance, QObject *parent = nullptr)
[override virtual noexcept] TextAutoGenerateTextPlugin::~TextAutoGenerateTextPlugin()
[virtual] TextAutoGenerateText::TextAutoGenerateTextPlugin::ActivateInstanceActionInfo TextAutoGenerateTextPlugin::activateInstanceAction()
activateInstanceAction Returns widget as button or other for activate
[pure virtual] void TextAutoGenerateTextPlugin::askToAssistant(const QString &msg)
[signal] void TextAutoGenerateTextPlugin::askToAssistantAnswer(const TextAutoGenerateText::TextAutoGenerateReply::Response &message)
[signal] void TextAutoGenerateTextPlugin::askToAssistantDone()
[signal] void TextAutoGenerateTextPlugin::callTools(const QList<TextAutoGenerateText::TextAutoGenerateReply::ToolCallArgumentInfo> &info)
[virtual] void TextAutoGenerateTextPlugin::cancelRequest(const QByteArray &uuid)
[protected] void TextAutoGenerateTextPlugin::cancelToolCalls(const QByteArray &uuid)
Cancel tool calls of message uuid (all tool calls if uuid is empty). Running requests of MCP servers are cancelled.
[virtual] TextAutoGenerateText::TextAutoGenerateReply *TextAutoGenerateTextPlugin::chatCompletion(const TextAutoGenerateText::TextAutoGenerateTextRequest &request)
Send request (messages already created) to LLM, without adding messages in a chat. Caller owns returned reply. Returns nullptr when not supported (default).
[virtual] void TextAutoGenerateTextPlugin::clear()
[signal] void TextAutoGenerateTextPlugin::configChanged()
[static] QString TextAutoGenerateTextPlugin::convertEngineType(TextAutoGenerateText::TextAutoGenerateTextPlugin::EngineType type)
[protected] TextAutoGenerateText::TextAutoGenerateTextRequest TextAutoGenerateTextPlugin::convertSendToAssistantInfoToTextRequest(const TextAutoGenerateText::TextAutoGenerateTextPlugin::SendToAssistantInfo &info) const
[pure virtual] QString TextAutoGenerateTextPlugin::currentModel() const
See also setCurrentModel().
[signal] void TextAutoGenerateTextPlugin::currentModelChanged()
[pure virtual] QString TextAutoGenerateTextPlugin::displayName() const
See also setDisplayName().
[signal] void TextAutoGenerateTextPlugin::downloadErrorOccurred(const QString &message)
[signal] void TextAutoGenerateTextPlugin::downloadModelFinished(const QString &modelName)
void TextAutoGenerateTextPlugin::editMessage(const TextAutoGenerateText::TextAutoGenerateTextPlugin::EditSendInfo &info)
[pure virtual] QString TextAutoGenerateTextPlugin::engineName() const
[pure virtual] TextAutoGenerateText::TextAutoGenerateTextPlugin::EngineType TextAutoGenerateTextPlugin::engineType() const
[signal] void TextAutoGenerateTextPlugin::errorOccurred(QNetworkReply::NetworkError e, const QString &errorString)
[protected] QString TextAutoGenerateTextPlugin::fallBackModel() const
[pure virtual] bool TextAutoGenerateTextPlugin::hasAudioSupport() const
[pure virtual] bool TextAutoGenerateTextPlugin::hasOcrSupport() const
[virtual] bool TextAutoGenerateTextPlugin::hasSystemMessageSupport() const
hasSystemMessageSupport Returns true if instance has system message support
[virtual] bool TextAutoGenerateTextPlugin::hasTextOnlySupport() const
hasTextOnlySupport Returns true if we just have text only support
[pure virtual] bool TextAutoGenerateTextPlugin::hasThinkSupport() const
[pure virtual] bool TextAutoGenerateTextPlugin::hasToolsSupport() const
[pure virtual] bool TextAutoGenerateTextPlugin::hasVisionSupport() const
[signal] void TextAutoGenerateTextPlugin::initializedDone()
QByteArray TextAutoGenerateTextPlugin::instanceUuid() const
[virtual] bool TextAutoGenerateTextPlugin::isLocalServer() const
isLocalServer Returns
[virtual] void TextAutoGenerateTextPlugin::load(const KConfigGroup &config)
TextAutoGenerateText::TextAutoGenerateManager *TextAutoGenerateTextPlugin::manager() const
QList<TextAutoGenerateText::TextAutoGenerateTextPlugin::ModelInfoNameAndIdentifier> TextAutoGenerateTextPlugin::models() const
[signal] void TextAutoGenerateTextPlugin::processStartFailed(const QString &errorStr)
[signal] void TextAutoGenerateTextPlugin::processStartSuccessed()
[protected] void TextAutoGenerateTextPlugin::processToolCalls(const TextAutoGenerateText::TextAutoGenerateTextPlugin::SendToAssistantInfo &info, const TextAutoGenerateText::TextAutoGenerateReply::Response &response)
LLM asked to call tools: call them and send their results to LLM, which will answer.
bool TextAutoGenerateTextPlugin::ready() const
See also setReady().
[virtual] void TextAutoGenerateTextPlugin::remove()
[virtual] void TextAutoGenerateTextPlugin::save(KConfigGroup &config)
void TextAutoGenerateTextPlugin::sendMessage(const TextAutoGenerateText::TextAutoGenerateTextPlugin::EditSendInfo &info)
[pure virtual protected] void TextAutoGenerateTextPlugin::sendToAssistant(const TextAutoGenerateText::TextAutoGenerateTextPlugin::SendToAssistantInfo &info)
[pure virtual] void TextAutoGenerateTextPlugin::setCurrentModel(const QString &)
See also currentModel().
[pure virtual] void TextAutoGenerateTextPlugin::setDisplayName(const QString &newName)
See also displayName().
void TextAutoGenerateTextPlugin::setHasError(bool error)
void TextAutoGenerateTextPlugin::setReady(bool newReady)
See also ready().
[virtual] QString TextAutoGenerateTextPlugin::shareNamePrompt() const
shareNamePrompt Returns
[pure virtual] void TextAutoGenerateTextPlugin::showConfigureDialog(QWidget *parentWidget)
[virtual] QString TextAutoGenerateTextPlugin::thinkingLevel() const
Returns the thinking level sent to the server ("low", "high"…). Empty by default: the server default is used.
[virtual] TextAutoGenerateText::TextAutoGenerateMessage::ToolCallFormat TextAutoGenerateTextPlugin::toolCallFormat() const
Format of tool calls and tool results in messages sent to LLM. OpenAI format by default.