Back to Runanywhere Sdks

Kotlin SDK — public API surface map

bindings/kotlin/docs/reference/public-api-surface.md

0.20.252.9 KB
Original Source

Kotlin SDK — public API surface map

Full file → capability → signature map for the RunAnywhere extension functions. Entry point: RunAnywhere (object singleton, src/main/kotlin/com/runanywhere/sdk/public/RunAnywhere.kt). Every feature API is an extension function on it, organized one-per-file under src/main/kotlin/com/runanywhere/sdk/public/extensions/. See the top-level AGENTS.md for the surrounding architecture (JNI bridge, event system, error handling); this file is just the index.

FileCapability
LLM/RunAnywhereTextGeneration.ktgenerate(prompt, RALLMGenerationOptions?) → RALLMGenerationResult, generateStream(...) → Flow<RALLMStreamEvent>, suspend cancelGeneration()
STT/RunAnywhereSTT.kttranscribe(audio, RASTTOptions), transcribeStream(Flow<ByteArray>, RASTTOptions?) → Flow<RASTTPartialResult>
TTS/RunAnywhereTTS.ktsynthesize(text, RATTSOptions), speak(), synthesizeStream() → Flow<RATTSOutput>, stopSpeaking(), stopSynthesis()
VAD/RunAnywhereVAD.ktdetectVoiceActivity(), streamVAD(Flow<ByteArray>, RAVADOptions?), resetVAD()
VLM/RunAnywhereVisionLanguage.ktdescribeImage(), processImage(), processImageStream()
VoiceAgent/RunAnywhereVoiceAgent.ktFull voice pipeline: initializeVoiceAgent(VoiceAgentConfig), streamVoiceAgent() → Flow<VoiceEvent>, processVoiceTurn(), cleanupVoiceAgent()
Models/RunAnywhereModelLifecycle.ktloadModel(RAModelLoadRequest), unloadModel(ModelUnloadRequest), currentModel(CurrentModelRequest), componentLifecycleSnapshot()
Models/RunAnywhereModelRegistry.ktregisterModel(), downloadModel(), availableModels(), deleteModel(), model CRUD
RunAnywhere+RAG.ktragCreatePipeline(), ragIngest(), ragQuery()
RunAnywhere+ToolCalling.ktregisterTool(), generateWithTools()
RunAnywhere+StructuredOutput.ktgenerateStructured(), JSON schema-constrained generation
RunAnywhere+LoRA.ktLoRA adapter load/remove/registry
RunAnywhere+Diffusion.ktImage generation pipeline
RunAnywhere+Solutions.ktDeclarative YAML-based pipeline orchestration
RunAnywhere+Storage.ktStorage info, cache management, model storage metrics
RunAnywhere+Auth.ktgetUserId(), isAuthenticated, device registration status
RunAnywhere+Hardware.ktHardwareProfile, NPU/accelerator detection

Overlap with docs/Documentation.md

docs/Documentation.md ("Complete API reference") predates this table's bottom nine rows — it has narrated usage examples for Core/LLM/STT/TTS/VAD/VoiceAgent/Model Management only. It has not been updated for RAG, ToolCalling, StructuredOutput, LoRA, Diffusion, Solutions, Storage, Auth, or Hardware. Treat this file as the current, complete index; treat Documentation.md as narrated-examples-for-a-subset, not exhaustive.