yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
yaze::cli::agent::ToolSchema Struct Reference

Complete tool schema for LLM documentation. More...

#include <tool_schemas.h>

Public Member Functions

std::string ToJson () const
 Generate JSON schema for function calling APIs.
 
std::string ToMarkdown () const
 Generate markdown documentation for a tool.
 

Public Attributes

std::string name
 
std::string category
 
std::string description
 
std::string detailed_help
 
std::vector< ArgumentSchemaarguments
 
std::vector< std::string > examples
 
std::vector< std::string > related_tools
 
bool requires_rom = true
 
bool requires_grpc = false
 

Detailed Description

Complete tool schema for LLM documentation.

Definition at line 58 of file tool_schemas.h.

Member Function Documentation

◆ ToJson()

std::string yaze::cli::agent::ToolSchema::ToJson ( ) const
inline

Generate JSON schema for function calling APIs.

Definition at line 72 of file tool_schemas.h.

References arguments, category, description, examples, name, related_tools, requires_grpc, and requires_rom.

◆ ToMarkdown()

std::string yaze::cli::agent::ToolSchema::ToMarkdown ( ) const
inline

Generate markdown documentation for a tool.

Definition at line 148 of file tool_schemas.h.

References arguments, category, description, detailed_help, examples, name, and related_tools.

Member Data Documentation

◆ name

std::string yaze::cli::agent::ToolSchema::name

◆ category

std::string yaze::cli::agent::ToolSchema::category

Definition at line 60 of file tool_schemas.h.

Referenced by ToJson(), and ToMarkdown().

◆ description

std::string yaze::cli::agent::ToolSchema::description

Definition at line 61 of file tool_schemas.h.

Referenced by ToJson(), and ToMarkdown().

◆ detailed_help

std::string yaze::cli::agent::ToolSchema::detailed_help

Definition at line 62 of file tool_schemas.h.

Referenced by ToMarkdown().

◆ arguments

std::vector<ArgumentSchema> yaze::cli::agent::ToolSchema::arguments

Definition at line 63 of file tool_schemas.h.

Referenced by ToJson(), and ToMarkdown().

◆ examples

std::vector<std::string> yaze::cli::agent::ToolSchema::examples

Definition at line 64 of file tool_schemas.h.

Referenced by ToJson(), and ToMarkdown().

◆ related_tools

std::vector<std::string> yaze::cli::agent::ToolSchema::related_tools

Definition at line 65 of file tool_schemas.h.

Referenced by ToJson(), and ToMarkdown().

◆ requires_rom

bool yaze::cli::agent::ToolSchema::requires_rom = true

Definition at line 66 of file tool_schemas.h.

Referenced by ToJson().

◆ requires_grpc

bool yaze::cli::agent::ToolSchema::requires_grpc = false

Definition at line 67 of file tool_schemas.h.

Referenced by ToJson().


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