ReUseX  0.0.5
3D Point Cloud Processing for Building Reuse
Loading...
Searching...
No Matches
reusex::vision::OpenAiCompatibleVlmClient Class Reference

#include <OpenAiCompatibleVlmClient.hpp>

Inheritance diagram for reusex::vision::OpenAiCompatibleVlmClient:
Collaboration diagram for reusex::vision::OpenAiCompatibleVlmClient:

Public Member Functions

 OpenAiCompatibleVlmClient (std::string base_url, std::string model, std::string api_key, int connect_timeout_s=10, int total_timeout_s=120)
VlmResult describe (const cv::Mat &crop, const std::string &prompt) override
 Describe crop (a BGR CV_8UC3 image) given prompt.
int connect_timeout_s () const
int total_timeout_s () const
Public Member Functions inherited from reusex::vision::IVlmClient
virtual ~IVlmClient ()=default

Detailed Description

Definition at line 16 of file OpenAiCompatibleVlmClient.hpp.

Constructor & Destructor Documentation

◆ OpenAiCompatibleVlmClient()

reusex::vision::OpenAiCompatibleVlmClient::OpenAiCompatibleVlmClient ( std::string base_url,
std::string model,
std::string api_key,
int connect_timeout_s = 10,
int total_timeout_s = 120 )
Parameters
base_urle.g. "http://localhost:11434/v1" (the "/chat/completions" suffix is appended if absent).
modelModel name.
api_keyOptional bearer token; empty disables the header.
connect_timeout_sCURLOPT_CONNECTTIMEOUT value in seconds (0 = no limit). Required for multithreaded programs to avoid blocking forever on a hung endpoint.
total_timeout_sCURLOPT_TIMEOUT value in seconds (0 = no limit).

References connect_timeout_s(), and total_timeout_s().

Member Function Documentation

◆ connect_timeout_s()

int reusex::vision::OpenAiCompatibleVlmClient::connect_timeout_s ( ) const
inline

Definition at line 33 of file OpenAiCompatibleVlmClient.hpp.

Referenced by OpenAiCompatibleVlmClient().

◆ describe()

VlmResult reusex::vision::OpenAiCompatibleVlmClient::describe ( const cv::Mat & crop,
const std::string & prompt )
overridevirtual

Describe crop (a BGR CV_8UC3 image) given prompt.

Implements reusex::vision::IVlmClient.

◆ total_timeout_s()

int reusex::vision::OpenAiCompatibleVlmClient::total_timeout_s ( ) const
inline

Definition at line 34 of file OpenAiCompatibleVlmClient.hpp.

Referenced by OpenAiCompatibleVlmClient().


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