pipecat-client-android/ai.pipecat.client.types/BotOutputData

BotOutputData

@Serializable

data class BotOutputData(val text: String, val aggregatedBy: String, val spoken: Boolean? = null, val willBeSpoken: Boolean? = null, val spokenStatus: BotOutputData.SpokenStatus? = null, val spokenProgress: BotOutputProgressData? = null, val segmentId: Int? = null)

Streaming bot output tokens/chunks.

Example (Protocol 2.0.0): {"text":"your","aggregated_by":"word","will_be_spoken":true,"spoken_status":"in-progress","segment_id":1}

Constructors

constructor(text: String, aggregatedBy: String, spoken: Boolean? = null, willBeSpoken: Boolean? = null, spokenStatus: BotOutputData.SpokenStatus? = null, spokenProgress: BotOutputProgressData? = null, segmentId: Int? = null)

Types

@Serializable

enum SpokenStatus : Enum<BotOutputData.SpokenStatus>

Protocol 2.0.0: Lifecycle stage of a spoken segment.

Properties

@SerialName(value = "aggregated_by")

val aggregatedBy: String

@SerialName(value = "segment_id")

val segmentId: Int? = null

Protocol 2.0.0: Correlates progress events for the same spoken segment.

val ~~spoken~~: Boolean? = null

Deprecated (Protocol 1.4.x). Use willBeSpoken instead.

@SerialName(value = "spoken_progress")

val spokenProgress: BotOutputProgressData? = null

Protocol 2.0.0: Word-level progress through the spoken segment.

@SerialName(value = "spoken_status")

val spokenStatus: BotOutputData.SpokenStatus? = null

Protocol 2.0.0: Current lifecycle stage of the spoken segment.

val text: String

@SerialName(value = "will_be_spoken")

val willBeSpoken: Boolean? = null

Protocol 2.0.0: Whether this text will be spoken by TTS.