Expand description
Provider-neutral model protocol and streaming primitives.
Structs§
- Artifact
- Bytes loaded from an artifact store together with verified metadata.
- Artifact
Page - One bounded page of artifact references in stable identity order.
- Artifact
Ref - A stable, integrity-bound reference to binary artifact content.
- Artifact
Resolving Model - Model decorator that resolves lazy artifact references immediately before provider transport while keeping transcripts and checkpoints reference-only.
- Artifact
Scope - Validated tenant or application isolation boundary for artifacts.
- Artifact
Write - Idempotent artifact creation request.
- Batch
Profile - Offline execution defaults that validate a complete response before commit.
- Capability
Audit - Machine-readable inventory of one model endpoint’s declared capabilities.
- Capability
Audit Entry - One stable feature declaration and its actionable diagnostic.
- Circuit
Breaker Config - Per-route circuit-breaker policy.
- Citation
- A normalized citation.
- Feature
Support - Support level plus machine-readable constraints.
- Generated
Image - One generated image.
- Generation
Options - Sampling and output-length options common to providers.
- Image
Generation Request - Provider-neutral image-generation request.
- Image
Generation Response - Complete image-generation result.
- InMemory
Artifact Store - Cloneable bounded in-memory artifact store for tests and local processes.
- Interactive
Profile - User-facing latency defaults that commit canonical stream events promptly.
- Message
- An ordered message sent to or returned by a model.
- Model
Call Context - Execution scope for one model invocation.
- Model
Capabilities - Capabilities of a specific model endpoint.
- Model
Capability Catalog - Application-owned capability declarations keyed by exact provider and model.
- Model
Error - A structured model-layer error.
- Model
Fallback Policy - Explicit authority for selecting another physical model after a failure.
- Model
Ref - A provider-qualified model identity.
- Model
Request - A complete provider-neutral model request.
- Model
Response - A complete canonical model response.
- Model
Retry Policy - Explicit same-route retry and backoff authority.
- Model
Route - One named physical endpoint eligible for a logical model invocation.
- Model
Route Health - Point-in-time health for one physical model route.
- Model
Router - Ordered, provider-neutral fallback routing behind the canonical
Modelboundary. - Model
Router Builder - Fluent, validation-preserving assembly of a
ModelRouter. - Model
Stream Accumulator - Strictly reconstructs a canonical response from model stream events.
- Model
Usage - Detailed usage reported by a model provider.
- Model
Warning - A visible feature degradation or translation warning.
- Production
Profile - Long-lived service defaults prioritizing correctness and Provider policy.
- Provider
Data - Provider-specific data retained without normalization.
- Provider
Event - A provider event retained without normalization.
- Provider
Runtime Profile - Provider-recommended defaults for one fully composed model runtime.
- Provider
Tool Spec - A provider-native hosted tool that has no lossless canonical function-tool form.
- Reasoning
Part - Model reasoning retained for valid round trips.
- Speech
Request - Provider-neutral text-to-speech request.
- Speech
Response - Complete synthesized speech bytes.
- Structured
Output Error - A local failure while decoding a model response into a Rust type.
- System
Router Clock - Monotonic system clock.
- System
Router Sleeper - Runtime-neutral production timer backed by
futures-timer. - Tool
Call - A completed tool call requested by a model.
- Tool
Result - A completed tool result supplied to a model.
- Tool
Spec - A model-facing tool definition.
- Transcription
Request - Provider-neutral audio-transcription request.
- Transcription
Response - Complete transcription result.
Enums§
- Artifact
Error - Typed artifact persistence or integrity failure.
- Circuit
Breaker Config Error - Invalid circuit-breaker configuration.
- Circuit
State - Public route-health state.
- Content
Block Kind - The type and initial metadata of a streamed content block.
- Content
Part - One ordered unit of model-visible content.
- Feature
Policy - Behavior when a requested feature is not natively supported.
- Finish
Reason - Why a model stopped producing output.
- Image
Format - Image output encoding requested from a generation model.
- Media
Source - A serializable media source.
- Model
Error Kind - A normalized model-layer error category.
- Model
Retry Policy Error - Invalid retry-policy configuration.
- Model
Router Build Error - Invalid logical router configuration.
- Model
Stream Event - Canonical events emitted by a streaming model call.
- Output
Format - Desired final-output format.
- Response
Mode - How the provider should deliver a model response.
- Retry
Jitter - Jitter applied to an exponential retry delay.
- Role
- The author role of a model message.
- Speech
Format - Audio encoding requested from a speech model.
- Structured
Output Error Kind - Stable category for local structured-output validation failures.
- Support
Level - How a model or adapter supports a feature.
- Tool
Choice - How a model may select tools.
Constants§
- DEFAULT_
MAX_ ARTIFACT_ BYTES - Maximum artifact size accepted by the reference store and resolver.
- MAX_
ARTIFACT_ IDEMPOTENCY_ KEY_ BYTES - Maximum UTF-8 byte length of an artifact idempotency key.
- MAX_
ARTIFACT_ NAME_ BYTES - Maximum UTF-8 byte length of an artifact display name.
- MAX_
ARTIFACT_ PAGE_ SIZE - Maximum number of artifact references returned or deleted per operation.
Traits§
- Artifact
Store - Binary artifact persistence boundary.
- Image
Generation Model - Independent image-generation model boundary.
- Model
- Object-safe boundary implemented by model provider adapters.
- Provider
Model - Stable provider identity carried by a concrete model adapter.
- Router
Clock - Clock used by model-routing resilience policy.
- Router
Sleeper - Asynchronous timer boundary used by retry backoff.
- Runtime
Profile Preset - A reviewed workload preset layered over a Provider’s protocol-safe policy.
- Speech
Model - Independent text-to-speech model boundary.
- Transcription
Model - Independent speech-to-text model boundary.
Type Aliases§
- Artifact
Future - A boxed artifact-store future.
- Extension
Map - Namespaced extension fields.
- Model
Event Stream - A provider-neutral stream of canonical model events.
- Model
Future - A boxed, sendable future returned by a model implementation.
- Router
Sleep Future - A boxed sleep future used by routing policy.