API reference¶
This section provides reference documentation for the TrulyNatural SDK API. This includes the native C interface and the generated Java and Python bindings.
- Overview
- Design goals and high-level overview of how everything fits together. Start here.
- New to embedding? See Your first program.
- Inference
- Functions, classes, and methods for evaluating models.
- I/O
- Streamed input and output adapters. Inference uses these for all binary and text input and output.
- Constants
- TrulyNatural SDK metadata available during the compile or build phase, for example the SDK VERSION.
- Setting keys
- Settings are strings used as keys in Session inference object function or method calls. This section provides an exhaustive list of all supported keys.
- Library configuration
- Describes functions and settings that control overall TrulyNatural SDK library behavior.
- These are most useful on small platforms with limited memory, and relevant to the native C API only. Library configuration is not available in other language bindings.
- Memory management
- Describes heap memory management used by the TrulyNatural SDK C language binding. The Java and Python bindings manage native handles from their language runtimes.
- Integrate with your build
- Describes how to add the TrulyNatural SDK to your own application's build system.
- C examples
- Sample code that uses the C API.
- Java examples
- Sample code that uses the Desktop Java API.
- Python examples
- Sample code that uses the Python binding and the SDK wheel with uv.
- Android examples
- Sample code that uses Java on Android. Callable from Kotlin; see API overview § Kotlin on Android.
- iOS examples
- Sample code that uses Swift with a bridging header to the C API.