gpt4all/gpt4all-chat/localdocssearch.h

#ifndef LOCALDOCSSEARCH_H
#define LOCALDOCSSEARCH_H

#include "tool.h"

#include <QObject>
#include <QString>

class LocalDocsWorker : public QObject {
    Q_OBJECT
public:
    LocalDocsWorker();
    virtual ~LocalDocsWorker() {}

    QString response() const { return m_response; }

    void request(const QList<QString> &collections, const QString &text, int count);

Q_SIGNALS:
    void requestRetrieveFromDB(const QList<QString> &collections, const QString &text, int count, QString &jsonResponse);
    void finished();

private:
    QString m_response;
};

class LocalDocsSearch : public Tool {
    Q_OBJECT
public:
    LocalDocsSearch() : Tool(), m_error(ToolEnums::Error::NoError) {}
    virtual ~LocalDocsSearch() {}

    QString run(const QJsonObject &parameters, qint64 timeout = 2000) override;
    ToolEnums::Error error() const override { return m_error; }
    QString errorString() const override { return m_errorString; }

    QString name() const override { return tr("LocalDocs Search"); }
    QString description() const override { return tr("Search the local docs"); }
    QString function() const override { return "localdocs_search"; }
    ToolEnums::PrivacyScope privacyScope() const override { return ToolEnums::PrivacyScope::Local; }
    QJsonObject exampleParams() const override;
    QJsonObject paramSchema() const override;
    bool isBuiltin() const override { return true; }
    ToolEnums::UsageMode usageMode() const override { return ToolEnums::UsageMode::ForceUsage; }
    bool excerpts() const override { return true; }

private:
    ToolEnums::Error m_error;
    QString m_errorString;
};

#endif // LOCALDOCSSEARCH_H