Reference Documentation (Code API)

This section contains the reference documentation for the public API of the project. Quick links to the most important classes and functions are provided below.

SDK

aana.AanaSDK - The main class for interacting with the Aana SDK. Use it to register endpoints and deployments and to start the server.

Endpoint

aana.api.Endpoint - The base class for defining endpoints in the Aana SDK.

Deployments

Deployments contains information about how to deploy models with a number of predefined deployments for such models as Whisper, LLMs, Hugging Face models, and more.

Models

• Media Models - Models for working with media types like audio, video, and images.
• Automatic Speech Recognition (ASR) Models - Models for working with automatic speech recognition (ASR) models.
• Caption Models - Models for working with captions.
• Chat Models - Models for working with chat models.
• Image Chat Models - Models for working with visual-text content for visual-language models.
• Custom Config - Custom Config model can be used to pass arbitrary configuration to the deployment.
• Sampling Models - Contains Sampling Parameters model which can be used to pass sampling parameters to the LLM models.
• Time Models - Contains time models like TimeInterval.
• Types Models - Contains types models like Dtype.
• Video Models - Models for working with video files.
• Whisper Models - Models for working with whispers.