rtvi

type BotReadyData ¶

type BotReadyData struct {
	Version string `json:"version"`
}

BotReadyData is the payload of a bot-ready message.

type ErrorData ¶

type ErrorData struct {
	Error string `json:"error"`
	Fatal bool   `json:"fatal"`
}

ErrorData is the payload of an error message.

type Incoming ¶

type Incoming struct {
	Label string          `json:"label"`
	Type  string          `json:"type"`
	ID    string          `json:"id"`
	Data  json.RawMessage `json:"data"`
}

Incoming is a received RTVI message with its data left as raw JSON for type-specific decoding.

func ParseIncoming(raw []byte) (Incoming, error)

type Message ¶

type Message struct {
	Label string `json:"label"`
	Type  string `json:"type"`
	ID    string `json:"id,omitempty"`
	Data  any    `json:"data,omitempty"`
}

Message is the RTVI message envelope. Outgoing event messages omit id; bot-ready and responses echo the request id.

func BotLLMText(text string) Message

func BotReady(id string) Message

func BotTTSText(text string) Message

func BotTranscription(text string) Message

func Error(msg string, fatal bool) Message

func Metrics(data MetricsData) Message

func UserTranscription(text, userID, timestamp string, final bool) Message

type MetricData ¶

type MetricData struct {
	Processor string  `json:"processor"`
	Value     float64 `json:"value"`
	Model     string  `json:"model,omitempty"`
}

MetricData is one timing or count entry in a metrics message (ttfb, processing or characters). Value is in seconds for timings, or a count.

type MetricsData ¶

type MetricsData struct {
	TTFB       []MetricData      `json:"ttfb,omitempty"`
	Processing []MetricData      `json:"processing,omitempty"`
	Characters []MetricData      `json:"characters,omitempty"`
	Tokens     []TokenMetricData `json:"tokens,omitempty"`
}

MetricsData is the payload of a metrics message: each kind is a list so a single message can report several processors at once.

type Processor ¶

type Processor struct {
	*processor.Base
}

Processor bridges a pipeline to an RTVI client. It completes the handshake — replying to client-ready with bot-ready — and reports pipeline events (transcriptions, speaking state, errors, LLM text) to the client as RTVI messages. Place it in the pipeline upstream of the output transport, which carries the messages to the client.

Incoming client messages arrive as InputTransportMessageFrames; outgoing messages are pushed downstream as OutputTransportMessageFrames.

func NewProcessor() *Processor

func (p *Processor) ProcessFrame(ctx context.Context, f frames.Frame, dir processor.Direction) error

type TextData ¶

type TextData struct {
	Text string `json:"text"`
}

TextData is the payload of text messages (bot-transcription, bot-tts-text, bot-llm-text).

type TokenMetricData ¶

type TokenMetricData struct {
	Processor        string `json:"processor"`
	Model            string `json:"model,omitempty"`
	PromptTokens     int64  `json:"prompt_tokens"`
	CompletionTokens int64  `json:"completion_tokens"`
	TotalTokens      int64  `json:"total_tokens"`
}

TokenMetricData is one LLM token-usage entry in a metrics message.

type UserTranscriptionData ¶

type UserTranscriptionData struct {
	Text      string `json:"text"`
	UserID    string `json:"user_id"`
	Timestamp string `json:"timestamp"`
	Final     bool   `json:"final"`
}

UserTranscriptionData is the payload of a user-transcription message.