describe.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
 
// The `rux create attributes` pipeline stage (#373): for each MATERIAL passport
// in the project, resolve its linked instance(s), crop the best sensor view of
// their points, ask a vision-language model to describe the material, and store
// a free-text description + arbitrary key/value attributes in ProjectDB keyed
// by the material GUID (for MaterialPassport use).
 
#include <cstddef>
#include <filesystem>
#include <string>
 
namespace reusex::vision {
 
struct IVlmClient;

struct DescribeConfig {
  std::string api_url = "http://localhost:11434/v1";
  std::string model = "qwen2.5vl";
  std::string api_key;
  std::string instances_cloud = "instances";
  std::string point_cloud = "cloud";
  std::string prompt;
  bool skip_existing = false;
  int crop_padding = 8;
  int min_view_points = 20;
  std::size_t max_points_per_frame = 5000;
  int connect_timeout_s = 10;
  int total_timeout_s = 120;
};

std::string default_describe_prompt();

int describe(const std::filesystem::path &dbPath, const DescribeConfig &config);

int describe_with_client(const std::filesystem::path &dbPath,
                         const DescribeConfig &config, IVlmClient &client);
 
} // namespace reusex::vision