API Reference aludel v#0.2.0

Copy Markdown View Source

Modules

Aludel keeps the contexts that define your domain and business logic.

Converts documents between formats for LLM consumption.

Context for managing evaluation suites, test cases, and runs.

Parses and validates assertion payloads from suite editor forms.

Validates and persists uploaded documents for suite test cases.

Schema for evaluation test suites.

Schema for tracking suite execution results.

Owns suite execution launch under explicit supervision.

Schema for individual test cases within a suite.

Schema for file attachments associated with test cases.

Coordinates suite test case editing workflows outside the web layer.

Validates file content against claimed MIME types using magic bytes.

Generic HTTP client adapter behaviour.

ImageMagick adapter for document conversion.

Behaviour for document conversion adapters.

Default LLM HTTP client using ReqLLM.

Behaviour for LLM provider implementations.

Configuration utilities for LLM provider implementations.

Shared error parsing logic for LLM provider adapters.

Anthropic Claude API adapter implementation.

Google Gemini LLM provider implementation.

Ollama API adapter implementation.

OpenAI LLM provider implementation.

AWS S3-backed document storage adapter.

Behaviour for the AWS storage adapter's S3 client boundary.

Default AWS client implementation backed by ExAws.S3.

ExAws HTTP client implementation backed by Req.

Google Cloud Storage-backed document storage adapter.

Behaviour for the GCS storage adapter's Google API client boundary.

Default GCS client implementation backed by google_api_storage and Goth.

Local filesystem adapter for document storage.

Behaviour for external document storage adapters.

LLM client abstraction for multi-provider support.

Context for managing projects that organize prompts and test suites.

Schema for organizing prompts and test suites into projects.

Context for managing prompts and their versions.

Functions for analyzing prompt version evolution and performance metrics.

Schema for managing prompts.

Schema for prompt versions.

Context for managing AI provider configurations.

Resolves pricing for a given provider and model.

Schema for AI provider configurations.

Central repository accessor for Aludel.

Context for managing runs and run results.

Result of executing a run across one or more providers.

Owns run launch and provider execution under explicit supervision.

Schema for managing runs.

Schema for run results.

Recent activity feeds and time-series activity reporting.

Cost reporting and breakdowns for the dashboard.

Latency reporting and provider breakdowns.

Top-line dashboard metrics and period comparisons.

Domain-facing facade for document storage backends.

Serves pre-compiled static assets for Aludel dashboard.

LiveView on_mount hook for Aludel dashboard authentication.

Provides core UI components.

LiveView hooks for common functionality across all LiveViews.

Behavior for customizing dashboard access and user identification.

Provides the aludel_dashboard macro for mounting Aludel in host apps.

Mix Tasks

Installs Aludel by copying migrations to the host application.

Runs Aludel seed data.