agents::Parameter Struct Reference

Parameter type for tools and LLM calls. More...

#include <types.h>

Public Attributes
std::string	name
	The name of the parameter.
std::string	description
	The description of the parameter.
std::string	type
	The type of the parameter.
bool	required
	Whether the parameter is required.
std::optional< JsonObject >	default_value = std::nullopt
	The default value of the parameter.
std::optional< JsonObject >	items = std::nullopt
	Element schema for type: "array" parameters.
std::optional< JsonObject >	properties = std::nullopt
	Nested property schema for type: "object" parameters.
std::optional< JsonObject >	enum_values = std::nullopt
	Allowed enum values for the parameter.

Detailed Description

Parameter type for tools and LLM calls.

Note

This is a parameter type for tools and LLM calls. It contains the name, description, type, required, and default value.

Member Data Documentation

enum_values

std::optional<JsonObject> agents::Parameter::enum_values = std::nullopt

Allowed enum values for the parameter.

Note

Captured from the source JSON schema's enum field.

items

std::optional<JsonObject> agents::Parameter::items = std::nullopt

Element schema for type: "array" parameters.

Note

Required by some providers (e.g. Gemini). Defaults to {"type": "string"} when ingested from a source schema that omits it.

properties

std::optional<JsonObject> agents::Parameter::properties = std::nullopt

Nested property schema for type: "object" parameters.

Note

Captured from the source JSON schema's properties field.