public/types/types library
Public Types
Exports all public types for the RunAnywhere SDK.
Classes
- ArrayToolValue
- BoolToolValue
- ComponentLoadState
- State of a voice agent component
- ComponentLoadStateLoaded
- Component loaded state
- ComponentLoadStateNotLoaded
- Component not loaded state
- DownloadProgress
-
Download progress information
Matches Swift
DownloadProgress. - LLMGenerationOptions
- Options for LLM text generation Matches Swift's LLMGenerationOptions
- LLMGenerationResult
- Result of LLM text generation Matches Swift's LLMGenerationResult
- LLMStreamingResult
- Result of streaming LLM text generation Matches Swift's LLMStreamingResult
- NullToolValue
- NumberToolValue
- ObjectToolValue
- RAGConfiguration
- Configuration for the RAG pipeline.
- RAGQueryOptions
- Options for a RAG query.
- RAGResult
- The result of a RAG query.
- RAGSearchResult
- A single retrieved chunk from vector search.
- StringToolValue
- StructuredOutputConfig
- Configuration for structured output generation Mirrors Swift's StructuredOutputConfig
-
StructuredOutputResult<
T> - Result for structured output generation with parsed result and metrics
- StructuredOutputValidation
- Structured output validation result Mirrors Swift's StructuredOutputValidation
- STTCapability
- Speech-to-Text capability information
- STTResult
- Result of STT transcription Matches Swift's STTOutput
- SupabaseConfig
- Supabase configuration for development mode
- ToolCall
- A request from the LLM to execute a tool
- ToolCallFormatName
- Constants for tool call format names.
- ToolCallingOptions
- Options for tool-enabled generation
- ToolCallingResult
- Result of a generation that may include tool calls
- ToolDefinition
- Definition of a tool that the LLM can use
- ToolParameter
- A single parameter definition for a tool
- ToolResult
- Result of executing a tool
- ToolValue
-
A type-safe representation of JSON values for tool arguments and results.
Avoids using
dynamicwhile supporting all JSON types. - TTSCapability
- Text-to-Speech capability information
- TTSResult
- Result of TTS synthesis Matches Swift's TTSOutput
- VLMImage
- Image input for VLM - handles Dart-native image formats
- VLMImageFormat
- Image format variants (sealed class for type safety)
- VLMImageFormatBase64
- Base64 format
- VLMImageFormatFilePath
- File path format
- VLMImageFormatRgbPixels
- RGB pixels format
- VLMResult
- Result from VLM generation Matches iOS VLMResult
- VLMStreamingResult
- Streaming result for VLM generation Matches iOS VLMStreamingResult, adapted for Dart async patterns
- VoiceAgentComponentStates
- States of all voice agent components (STT, LLM, TTS)
Enums
- DownloadProgressStage
- Download progress stage (more detailed than state)
- DownloadProgressState
- Download progress state
- MessageRole
- Role of a message in a conversation
- ToolParameterType
- Supported parameter types for tool arguments
- VLMErrorCode
- VLM-specific error codes Matches iOS SDKError.VLMErrorCode exactly
Functions
-
dynamicMapToToolValueMap(
Map< String, dynamic> map) → Map<String, ToolValue> - Convert Map<String, dynamic> to Map<String, ToolValue>
-
toolResultToJsonString(
Map< String, ToolValue> result) → String - Convert Map<String, ToolValue> to JSON string
-
toolsToJson(
List< ToolDefinition> tools) → String - Serialize tools to JSON string
Typedefs
Exceptions / Errors
- StructuredOutputError
- Structured output errors Mirrors Swift's StructuredOutputError