IVlmClient.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Povl Filip Sonne-Frederiksen
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
// Provider-agnostic interface for a vision-language model that describes an
// image crop (#373). The concrete OpenAiCompatibleVlmClient talks to any
// OpenAI-compatible chat/completions endpoint (local Ollama by default, or a
// cloud provider). The interface exists so the `describe()` stage can be driven
// by a fake client in tests without any network.
 
#include "reusex/vision/vlm_protocol.hpp"
 
#include <string>
 
// Forward-declared to keep OpenCV out of this public header (STANDARDS §2).
namespace cv {
class Mat;
}
 
namespace reusex::vision {

struct IVlmClient {
  virtual ~IVlmClient() = default;

  virtual VlmResult describe(const cv::Mat &crop,
                             const std::string &prompt) = 0;
};
 
} // namespace reusex::vision