Coze Helper

Public header: #include "brookesia/agent_helper/coze.hpp"

Overview

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

API Reference

Header File

agent/brookesia_agent_helper/include/brookesia/agent_helper/coze.hpp

Classes

class Coze : public esp_brookesia::service::helper::Base<Coze>

Helper schema definitions for the Coze agent service.

Public Types

enum class CozeEvent

Coze-specific events surfaced by the agent.

Values:

enumerator InsufficientCreditsBalance

enumerator Max

Public Static Functions

static inline constexpr std::string_view get_name()

Name of the Coze 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 Coze 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 Coze agent.

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

struct AuthInfo

Credentials required to authenticate with the Coze backend.

Public Members

std::string session_name: Session name used by the Coze SDK.

std::string device_id: Unique device identifier.

std::string custom_consumer: Consumer identifier passed to the backend.

std::string app_id: Application id.

std::string user_id: End-user id.

std::string public_key: Public key used for authentication.

std::string private_key: Private key used for authentication.

struct Info

Persistent Coze agent configuration.

Public Members

AuthInfo authorization: Authentication material.

std::vector<RobotInfo> robots: Available robot definitions.

struct RobotInfo

Metadata for one available Coze robot.

Public Members

std::string name: Human-readable robot name.

std::string bot_id: Coze bot identifier.

std::string voice_id: Voice profile identifier.

std::string description: Optional robot description.