Expand description
siumai-provider-openai-compatible
Legacy crate name for the OpenAI(-like) protocol family.
Downstream code should prefer siumai-protocol-openai. This crate remains as a compatibility
alias and re-exports the full public surface from siumai-protocol-openai.
In the workspace split (beta.5+), this crate also hosts the OpenAI-compatible provider implementation (vendor adapters + routing), aligned with the Vercel AI SDK package layout.
Modules§
- auth
- Authentication helpers and token providers. This module defines a minimal trait to supply Bearer tokens (e.g., for Vertex AI).
- builder
- Builder utilities shared across provider crates.
- client
- Client Module
- core
- Core Abstractions
- defaults
- Default Configuration Values
- encoding
- Provider wire-format encoders.
- error
- Error handling (re-export).
- execution
- Execution Layer - Unified Public API
- hosted_
tools - Provider-defined tools (core crate).
- observability
- Observability entrypoint: unified namespace for tracing and telemetry.
- provider_
metadata - Protocol-owned typed metadata views. Typed response metadata (protocol-owned).
- provider_
options - Provider-owned typed option structs for OpenAI-compatible vendors. Provider-owned typed option structs for OpenAI-compatible vendors.
- providers
- OpenAI-compatible providers (vendor presets, adapter registry, client).
Provider implementations hosted by
siumai-provider-openai-compatible. - retry
- Retry module (ergonomic namespace)
- retry_
api - Public Retry API Facade
- standards
- Protocol standards owned by this crate.
- streaming
- Streaming Module
- tools
- Provider-defined tool factories (re-export).
- traits
- Core Trait Definitions
- types
- Core data type definitions (re-export).
- utils
- Utility modules for siumai
Macros§
- siumai_
for_ each_ openai_ compatible_ provider - Enumerates all supported OpenAI-compatible provider ids.
Enums§
- LlmError
- The primary error type for the LLM library.