结构体

StateChangeEvent

Objective-C

@objc public class StateChangeEvent: NSObject {
@objc public let state: AgentState
@objc public let turnId: Int
@objc public let timestamp: TimeInterval
@objc public let reason: String
@objc public init(state: AgentState, turnId: Int, timestamp: TimeInterval, reason: String)
public override var description: String {
return "StateChangeEvent(state: \(state), turnId: \(turnId), timestamp: \(timestamp), reason: \(reason))"
}
}

StateChangeEvent 表示智能体状态变化事件，包含完整状态信息和时间戳。

用于追踪会话流程并更新用户界面状态指示器。

成员参数

参数	数据类型	描述
state	AgentState	当前智能体状态。详见 AgentState。
turnId	Int	会话轮次 ID，用于标识特定的会话轮次。
timestamp	TimeInterval	事件发生的时间戳（自 1970 年 1 月 1 日 UTC 起的毫秒数）。
reason	String	状态变化的原因。

InterruptEvent

Objective-C

@objc public class InterruptEvent: NSObject {
@objc public let turnId: Int
@objc public let timestamp: TimeInterval
@objc public init(turnId: Int, timestamp: TimeInterval)
public override var description: String {
return "InterruptEvent(turnId: \(turnId), timestamp: \(timestamp))"
}
}

表示 InterruptEvent 会话中断事件。

通常在用户主动打断 AI 发言或系统检测到高优先级消息时触发，用于记录中断行为并执行相应处理。

成员参数

参数	数据类型	描述
turnId	Int	被中断的会话轮次 ID。
timestamp	TimeInterval	中断事件发生的时间戳（自 1970 年 1 月 1 日 UTC 起的毫秒数）。

Metric

Objective-C

@objc public class Metric: NSObject {
    @objc public let type: ModuleType
    @objc public let name: String
    @objc public let value: Double
    @objc public let timestamp: TimeInterval
    @objc public init(type: ModuleType, name: String, value: Double, timestamp: TimeInterval)
    public override var description: String {
        return "Metric(type: \(type.stringValue), name: \(name), value: \(value), timestamp: \(timestamp))"
    }
}

Metric 用于记录和传输系统性能数据。

例如 LLM 推理延迟、TTS 合成延迟等。该数据可用于性能监控、系统优化和用户体验改进。

成员参数

参数	数据类型	描述
type	ModuleType	指标类型。详见 ModuleType。
name	String	具体性能项的指标名称。
value	Double	指标值，通常为延迟时间（毫秒）或其他定量指标。
timestamp	TimeInterval	指标记录的时间戳（自 1970 年 1 月 1 日 UTC 起的毫秒数）。

ModuleError

Objective-C

@objc public class ModuleError: NSObject {
@objc public let type: ModuleType
@objc public let code: Int
@objc public let message: String
@objc public let timestamp: TimeInterval
@objc public init(type: ModuleType, code: Int, message: String, timestamp: TimeInterval)
public override var description: String {
return "ModuleError(type: \(type.stringValue), code: \(code), message: \(message), timestamp: \(timestamp))"
}
}

ModuleError 用于处理和上报 AI 模块相关错误信息。

包含错误类型、错误码、错误描述和时间戳，便于错误监控、日志记录和故障排查。

成员参数

参数	数据类型	描述
type	ModuleType	错误类型。详见 ModuleType。
code	Int	用于标识特定错误条件的错误码。
message	String	提供详细错误说明的错误描述信息。
timestamp	TimeInterval	错误发生的时间戳（自 1970 年 1 月 1 日 UTC 起的毫秒数）。

Transcription

Objective-C

@objc public class Transcription: NSObject {
@objc public let turnId: Int
@objc public let userId: String
@objc public let text: String
@objc public var status: TranscriptionStatus
@objc public var type: TranscriptionType
}

Transcription 用于表示用户可见的转录消息。

用于在用户界面层渲染转录内容的完整数据类。

成员参数

参数	数据类型	描述
turnId	Int	会话轮次的唯一标识符。
userId	String	与该转录关联的用户标识符。
text	String	实际的转录文本内容。
status	TranscriptionStatus	转录的当前状态。详见 TranscriptionStatus。
type	TranscriptionType	转录的当前类型（代理或用户）。详见 TranscriptionType。

ConversationalAIAPIError

Objective-C

@objc public class ConversationalAIAPIError: NSObject {
@objc public let type: ConversationalAIAPIErrorType
@objc public let code: Int
@objc public let message: String
@objc public init(type: ConversationalAIAPIErrorType, code: Int, message: String)
public override var description: String {
return "ConversationalAIAPIError(type: \(type), code: \(code), message: \(message))"
}
}

用于记录和传递错误信息的类。

成员参数

参数	数据类型	描述
type	ConversationalAIAPIErrorType	错误类型。详见 ConversationalAIAPIErrorType。
code	Int	用于标识特定错误条件的错误码。
message	String	提供详细错误说明的错误描述信息。

ConversationalAIAPIConfig

Objective-C

@objc public class ConversationalAIAPIConfig: NSObject {
    @objc public weak var rtcEngine: AgoraRtcEngineKit?
    @objc public weak var rtmEngine: AgoraRtmClientKit?
    @objc public var renderMode: TranscriptionRenderMode
    @objc public var enableLog: Bool
}

Conversational AI API 的初始化配置类。

包含初始化 Conversational AI API 所需的配置参数，包括用于音视频通信的 rtcEngine、用于消息通信的 rtmEngine，以及转写渲染模式设置。

成员参数

参数	数据类型	描述
rtcEngine	AgoraRtcEngineKit?	用于音视频通信的引擎实例。详见 AgoraRtcEngineKit。
rtmEngine	AgoraRtmClientKit?	用于实时消息通信的客户端实例。详见 AgoraRtmClientKit。
renderMode	TranscriptionRenderMode	转写渲染模式。详见 TranscriptionRenderMode。
enableLog	Bool	是否启用详细日志记录： YES：启用详细日志记录。 NO：（默认）不启用日志记录。