Expand description
§aimux-core
Core abstractions for the aimux toolkit.
Architecture (aligned with Vercel AI SDK V4):
User-facing API Provider-facing trait
────────────── ─────────────────────
generate_text() ──► LanguageModel::do_generate()
stream_text() ──► LanguageModel::do_stream()The user calls generate_text / stream_text (free functions).
These convert user messages into LanguageModelPrompt, build CallOptions,
and call LanguageModel::do_generate / do_stream on the provider implementation.
Re-exports§
pub use embedding_model::EmbeddingModel;pub use error::AiMuxError;pub use files_model::Files;pub use image_model::ImageModel;pub use language_model::LanguageModel;pub use provider::Provider;pub use reranking_model::RerankingModel;pub use search_model::SearchModel;pub use speech_model::SpeechModel;pub use transcription_model::TranscriptionModel;pub use video_model::VideoModel;
Modules§
- content
- Content parts shared between user-facing and provider-facing messages.
- embedding_
model - The
EmbeddingModeltrait — the provider-facing interface for text embeddings. - error
- Error types for aimux-core.
- files_
model - The
Filestrait — the provider-facing interface for file management. - generate
- User-facing API:
generate_textandstream_text. - image_
model - The
ImageModeltrait — the provider-facing interface for image generation. - json_
repair - JSON repair and partial-JSON parsing helpers.
- language_
model - The
LanguageModeltrait — the provider-facing interface. - language_
model_ message - Provider-facing message types.
- math
- Math helpers ported from the Vercel AI SDK TypeScript
utilpackage. - message
- User-facing message types.
- model_
id - Model identifier helpers.
- options
CallOptions— the provider-facing options passed todo_generate/do_stream.- prelude
- Convenience re-exports.
- provider
- The
Providertrait — a factory that createsLanguageModelinstances. - reranking_
model - The
RerankingModeltrait — the provider-facing interface for reranking. - result
- Result types for
do_generateanddo_stream. - search_
model - The
SearchModeltrait — the provider-facing interface for web search. - shared
- Shared V4 value types used across all non-chat model traits.
- speech_
model - The
SpeechModeltrait — the provider-facing interface for text-to-speech. - stream_
part StreamPart— the individual chunk types emitted bydo_stream.- tool
- Tool / function-calling types.
- transcription_
model - The
TranscriptionModeltrait — the provider-facing interface for speech-to-text. - types
- Shared value types: FinishReason, Usage, Warning, ResponseMetadata.
- util
- Utility functions ported from the Vercel AI SDK TypeScript
utilpackage. - video_
model - The
VideoModeltrait — the provider-facing interface for video generation.