Expand description
siumai-protocol-openai
OpenAI(-like) protocol family mapping for siumai.
This crate owns the vendor-agnostic protocol layer for the OpenAI family:
- OpenAI-like protocol mapping (Chat/Embedding/Image/Rerank)
- OpenAI-compatible protocol building blocks (types + transformers)
- OpenAI Responses API mapping (feature-gated)
Provider crates (e.g. siumai-provider-openai, siumai-provider-xai,
siumai-provider-openai-compatible) should depend on this crate, and keep provider-specific
quirks behind provider-owned presets/wrappers.
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).
- 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
Enums§
- LlmError
- The primary error type for the LLM library.