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

Package-level declarations

Types

data class APIRequest(val endpoint: String, val requestData: Value, val headers: Map<String, String> = emptyMap(), val timeoutMs: Long = 30000)

AppendToContextResultData

@Serializable

data class AppendToContextResultData(val result: Value? = null)

BotLLMSearchResponseData

@Serializable

data class BotLLMSearchResponseData(val searchEntryPoint: SearchEntryPoint? = null, val groundingChunks: List<GroundingChunk>? = null, val groundingSupports: List<GroundingSupport>? = null, val webSearchQueries: List<String>? = null)

@Serializable

data class BotReadyData(val version: String, val about: Value? = null)

@Serializable

data class DataMessage(val msgType: String, val data: JsonElement)

@Serializable

data class GroundingChunk(val web: WebSource? = null)

Grounding chunk information

GroundingSegment

@Serializable

data class GroundingSegment(val partIndex: Int? = null, val startIndex: Int? = null, val endIndex: Int? = null, val text: String? = null)

Grounding segment information

GroundingSupport

@Serializable

data class GroundingSupport(val segment: GroundingSegment? = null, val groundingChunkIndices: List<Int>? = null, val confidenceScores: List<Double>? = null)

Grounding support information

LLMContextMessage

@Serializable

data class LLMContextMessage(val role: LLMContextMessage.Role, val content: String, val runImmediately: Boolean? = false)

LLMFunctionCallData

@Serializable

data class LLMFunctionCallData(val functionName: String, val toolCallID: String, val args: JsonElement)

LLMFunctionCallHandler

fun interface LLMFunctionCallHandler

LLMFunctionCallResult

@Serializable

data class LLMFunctionCallResult(val functionName: String, val toolCallID: String, val arguments: JsonElement, val result: JsonElement)

data class MediaDeviceId(val id: String)

A unique identifier for a media device.

MediaDeviceInfo

data class MediaDeviceInfo(val id: MediaDeviceId, val name: String)

Information about a media device.

data class MediaTrackId(val id: String)

An identifier for a media track.

data class Participant(val id: ParticipantId, val name: String?, val local: Boolean)

Information about a session participant.

data class ParticipantId(val id: String)

A unique identifier for a session participant.

ParticipantTracks

data class ParticipantTracks(val audio: MediaTrackId?, val video: MediaTrackId?)

Media tracks associated with a participant.

@Serializable

data class PipecatMetrics(val processing: List<PipecatMetricsData>? = null, val ttfb: List<PipecatMetricsData>? = null)

Metrics received from a Pipecat instance.

PipecatMetricsData

@Serializable

data class PipecatMetricsData(val processor: String, val value: Double)

Metrics data received from a Pipecat instance.

RTVIURLEndpoints

data class RTVIURLEndpoints(val connect: String? = "/connect", val action: String = "/action")

SearchEntryPoint

@Serializable

data class SearchEntryPoint(val renderedContent: String? = null)

Search entry point from bot LLM search response

data class Tracks(val local: ParticipantTracks, val bot: ParticipantTracks?)

Media tracks for the local user and remote bot.

@Serializable

data class Transcript(val text: String, val final: Boolean, val timestamp: String? = null, val userId: String? = null)

A written transcript of some spoken words.

enum TransportState : Enum<TransportState>

The current state of the session transport.

@Serializable

enum Type : Enum<Type>

@Serializable(with = ValueSerializer::class)

sealed interface Value

@Serializable

data class WebSource(val uri: String? = null, val title: String? = null)

Web source information from bot LLM search response