OpenAI Helper

[中文]

• Public header: #include "brookesia/agent_helper/openai.hpp"

Overview

Raw Doxygen API for the OpenAI helper: types, enums, methods, and macros.

API Reference

Header File

• agent/brookesia_agent_helper/include/brookesia/agent_helper/openai.hpp

Classes

class Openai : public esp_brookesia::service::helper::Base<Openai>

Helper schema definitions for the OpenAI agent service.

Public Static Functions

static inline constexpr std::string_view get_name()

Name of the OpenAI agent service.

Returns

std::string_view Stable service name.

static inline std::span<const service::FunctionSchema> get_function_schemas()

Get the function schemas exported by the OpenAI agent.

Returns

std::span<const service::FunctionSchema> Static schema span.

static inline std::span<const service::EventSchema> get_event_schemas()

Get the event schemas exported by the OpenAI agent.

Returns

std::span<const service::EventSchema> Static schema span.

struct Info

Persistent configuration for the OpenAI agent backend.

Public Members

std::string model

Model identifier used for requests.

std::string api_key

API key used for authentication.