tool.h

Go to the documentation of this file.

 
#pragma once
 
#include <neograph/api.h>
#include <neograph/tool_execution.h>
#include <neograph/types.h>
 
#include <asio/awaitable.hpp>
 
#include <chrono>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>
namespace neograph::graph {
class CancelToken;
}
 
namespace neograph {
class HookRuntime;
class ToolEffectBroker;
 
struct ToolExecutionContext {
    std::shared_ptr<graph::CancelToken> cancel_token;
    std::shared_ptr<ToolExecutionController> controller;
    ToolExecutionIdentity identity;
    std::shared_ptr<ToolEffectBroker> effect_broker;
    std::string effect_task_id;
    ToolEffectGrantIdentity effect_grant;
    std::optional<std::chrono::steady_clock::time_point> deadline;
    std::shared_ptr<HookRuntime> hook_runtime;
    std::uint8_t requested_priority = 0;
    std::uint8_t inherited_priority = 0;
};
 
class NEOGRAPH_API ContextualAsyncTool {
  public:
    virtual ~ContextualAsyncTool() = default;
 
    virtual asio::awaitable<std::string> execute_async(
        const json& arguments, ToolExecutionContext context) = 0;
};
 
struct NEOGRAPH_API ToolProcessSpec {
    std::vector<std::string> argv;
    std::vector<std::string> environment;
    std::string working_directory;
    std::string stdin_data;
    bool interactive = false;
};
 
class NEOGRAPH_API ProcessTool {
public:
    virtual ~ProcessTool() = default;
    virtual ToolProcessSpec prepare_process(
        const json& arguments, const ToolExecutionContext& context) const = 0;
};
 
class NEOGRAPH_API Tool {
  public:
    virtual ~Tool() = default;
 
    virtual ChatTool get_definition() const = 0;
 
    virtual std::string execute(const json& arguments) = 0;
 
    virtual std::string get_name() const = 0;
 
    virtual asio::awaitable<std::string> execute_async(const json& arguments);
};
 
class NEOGRAPH_API AsyncTool : public Tool {
  public:
    asio::awaitable<std::string> execute_async(const json& arguments) override = 0;
 
    std::string execute(const json& arguments) final;
};
 
} // namespace neograph