OpenAI

[中文]

  • Component registry: espressif/brookesia_agent_openai

  • Helper header: #include "brookesia/service_helper/agent/openai.hpp"

  • Helper class: esp_brookesia::service::helper::Openai

Overview

brookesia_agent_openai implements the OpenAI agent on ESP-Brookesia Agent Manager.

Features

  • OpenAI Realtime: WebRTC data channels for real-time voice and text.

  • P2P: esp_peer for signaling and data channels.

  • Audio: OPUS by default at 16 kHz, 24 kbps.

  • Data channel: Audio, text, function calls, session control, etc.

  • Low latency: Real-time duplex audio.

  • Persistence: Optional brookesia_service_storage for configuration.

Standard Include / Helper Class

  • Standard include: #include \"brookesia/service_helper/agent/openai.hpp\"

  • Helper class: esp_brookesia::service::helper::Openai

Service Interfaces

Functions

LoadData

Description

Load persisted OpenAI agent data.

Execution

  • Requires scheduler: Required

Parameters

  • No parameters.

Schema JSON
Show raw JSON 

{
  "name": "LoadData",
  "description": "Load persisted OpenAI agent data.",
  "require_scheduler": true,
  "default_timeout_ms": null,
  "parameters": [],
  "return_value": null
}
CLI Command
svc_call OpenAI LoadData

Events

This contract does not publish standard event schemas.