Skip to main content

Crate siumai_provider_volcengine

Crate siumai_provider_volcengine 

Source
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§

models
Dated Volcengine ARK model advisories.
options
Volcengine ARK provider options.

Structs§

ArkGeneratedImage
One image returned by ARK. URL and base64 payloads are redacted from Debug.
ArkImageModel
Portable image handle backed by one configured ARK runtime.
ArkImageOptions
Provider-owned options for the portable ARK image adapter.
ArkImageRequest
Full provider-owned ARK image request.
ArkImageResponse
Native ARK image response.
ArkImages
Shared provider-native ARK Images client.
ArkMediaSource
Media source used by ARK task requests and responses.
ArkMediaUrlWire
ArkVideoCreateRequest
Full provider-owned ARK video task creation request.
ArkVideoCreateResult
ArkVideoDeleteResult
ArkVideoTask
Current ARK video task representation with additive response fields retained.
ArkVideoTaskContent
Generated media URLs. URL contents are redacted from Debug by ArkMediaSource.
ArkVideoTaskId
Bounded ARK video task identifier.
ArkVideoTaskList
ArkVideoTaskListQuery
Bounded query for the ARK video task list endpoint.
ArkVideoTasks
Shared ARK video task client.
ArkVideoUsage
BearerCredential
A bearer credential with optional proactive-refresh time.
CredentialSourceError
Sanitized failure returned by a dynamic credential source.
VolcengineCredential
Volcengine credential source.
VolcengineLanguageModel
Concrete ARK language model backed by one shared Volcengine provider runtime.
VolcengineProvider
Long-lived, model-independent Volcengine provider for ARK language APIs.
VolcengineProviderBuilder
Builder for one immutable Volcengine provider runtime.

Enums§

ArkImageInput
One image reference accepted by the native Seedream request.
ArkImageOutputFormat
Output file format accepted by current Seedream image APIs.
ArkImageResponseFormat
Provider response representation for ARK image generation.
ArkOptimizePromptMode
Provider-owned prompt optimization mode.
ArkSequentialImageGeneration
Whether Seedream should generate a related sequence rather than one independent image.
ArkVideoAudioRole
ArkVideoContent
Typed content item accepted by the ARK video task endpoint.
ArkVideoImageRole
ArkVideoResolution
ArkVideoServiceTier
ArkVideoTaskStatus
Open status carrier that preserves future provider values.
ArkVideoVideoRole
CredentialRequest
Why a dynamic source is being consulted.
VolcengineConfigError
VolcengineLanguageApi
Public Volcengine ARK language API selection.
VolcengineProfileError

Constants§

ARK_IMAGE_API_MODE
CHAT_SOURCE
DEFAULT_BASE_URL
MODEL_SOURCE
PLATFORM_ID
PROVIDER_ID
RESPONSES_SOURCE
VERIFIED_ON
VERSION

Traits§

DynamicCredentialSource