Expand description
Volcengine ARK provider integration for Siumai.
This crate owns Volcengine identity, credentials, endpoint selection, typed ARK options, model advisories, and the verified ARK OpenAI dialect. Network execution is delegated to the shared OpenAI-compatible runtime without exposing that engine as the public provider owner.
Re-exports§
pub use options::ARK_BETA_IMAGE_PROCESS_HEADER;pub use options::ARK_BETA_KNOWLEDGE_SEARCH_HEADER;pub use options::ARK_BETA_MCP_HEADER;pub use options::ArkCaching;pub use options::ArkCachingType;pub use options::ArkChatOptions;pub use options::ArkMcpApproval;pub use options::ArkMcpTool;pub use options::ArkResponsesOptions;pub use options::ArkResponsesTool;pub use options::ArkThinking;pub use options::ArkThinkingType;
Modules§
Structs§
- ArkGenerated
Image - One image returned by ARK. URL and base64 payloads are redacted from
Debug. - ArkImage
Model - Portable image handle backed by one configured ARK runtime.
- ArkImage
Options - Provider-owned options for the portable ARK image adapter.
- ArkImage
Request - Full provider-owned ARK image request.
- ArkImage
Response - Native ARK image response.
- ArkImages
- Shared provider-native ARK Images client.
- ArkMedia
Source - Media source used by ARK task requests and responses.
- ArkMedia
UrlWire - ArkVideo
Create Request - Full provider-owned ARK video task creation request.
- ArkVideo
Create Result - ArkVideo
Delete Result - ArkVideo
Task - Current ARK video task representation with additive response fields retained.
- ArkVideo
Task Content - Generated media URLs. URL contents are redacted from
DebugbyArkMediaSource. - ArkVideo
Task Id - Bounded ARK video task identifier.
- ArkVideo
Task List - ArkVideo
Task List Query - Bounded query for the ARK video task list endpoint.
- ArkVideo
Tasks - Shared ARK video task client.
- ArkVideo
Usage - Bearer
Credential - A bearer credential with optional proactive-refresh time.
- Credential
Source Error - Sanitized failure returned by a dynamic credential source.
- Volcengine
Credential - Volcengine credential source.
- Volcengine
Language Model - Concrete ARK language model backed by one shared Volcengine provider runtime.
- Volcengine
Provider - Long-lived, model-independent Volcengine provider for ARK language APIs.
- Volcengine
Provider Builder - Builder for one immutable Volcengine provider runtime.
Enums§
- ArkImage
Input - One image reference accepted by the native Seedream request.
- ArkImage
Output Format - Output file format accepted by current Seedream image APIs.
- ArkImage
Response Format - Provider response representation for ARK image generation.
- ArkOptimize
Prompt Mode - Provider-owned prompt optimization mode.
- ArkSequential
Image Generation - Whether Seedream should generate a related sequence rather than one independent image.
- ArkVideo
Audio Role - ArkVideo
Content - Typed content item accepted by the ARK video task endpoint.
- ArkVideo
Image Role - ArkVideo
Resolution - ArkVideo
Service Tier - ArkVideo
Task Status - Open status carrier that preserves future provider values.
- ArkVideo
Video Role - Credential
Request - Why a dynamic source is being consulted.
- Volcengine
Config Error - Volcengine
Language Api - Public Volcengine ARK language API selection.
- Volcengine
Profile Error
Constants§
- ARK_
IMAGE_ API_ MODE - CHAT_
SOURCE - DEFAULT_
BASE_ URL - MODEL_
SOURCE - PLATFORM_
ID - PROVIDER_
ID - RESPONSES_
SOURCE - VERIFIED_
ON - VERSION