Skip to main content

Crate novelai_bridge

Crate novelai_bridge 

Source

Structs§

BridgeError
Unified error type returned by this crate.
Character
Character prompt input used by V4/V4.5 models.
CharacterPosition
Normalized character position in the [0, 1] range.
CharacterReference
Character reference input used by V4.5 models.
Client
High-level NovelAI image API client.
ClientOptions
Options used to construct a Client with the default ReqwestTransport.
ControlNetConfig
Controlnet-style configuration.
ControlNetInput
One controlnet-style reference input.
EncodeVibeRequest
Request used by crate::Client::encode_vibe.
GenerateImageRequest
Request used by crate::Client::generate.
GenerateImageStreamRequest
Request used by crate::Client::generate_stream.
GeneratedImage
Generated image payload.
ImageSize
Image dimensions in pixels.
ImageStreamChunk
Parsed stream chunk emitted by NovelAI image streaming.
Img2ImgRequest
Image-to-image input.
PngMetadata
Parsed metadata recovered from a PNG image payload.
ReqwestTransport
Default Transport implementation backed by reqwest + rustls.
RunDirectorToolRequest
Request used by crate::Client::run_director_tool.
SubscriptionInfo
Subscription summary returned by crate::Client::get_subscription.
VibeMetadataEntry
A single vibe-related metadata entry recovered from a PNG payload.

Enums§

ApiKeySource
Selects how the API key is resolved.
BridgeErrorCode
Stable error codes returned by this crate.
CharacterReferenceType
Character reference behavior used by V4.5 director references.
DirectorTool
Supported NovelAI director tools.
ImageFormat
Supported generated image output formats.
Model
Supported NovelAI image models.
NoiseSchedule
Supported noise schedules.
Sampler
Supported image samplers.
StreamMode
Supported image stream modes.
UcPreset
Built-in UC presets supported by NovelAI.
VibeMetadataSource
Indicates where a vibe metadata entry was recovered from.

Constants§

DEFAULT_API_BASE
Default base URL for non-image API endpoints.
DEFAULT_IMAGE_BASE
Default base URL for image-generation endpoints.
DEFAULT_TIMEOUT_MS
Default HTTP timeout used by ClientOptions, in milliseconds.

Traits§

Transport
Abstraction over the HTTP transport used by crate::Client.

Functions§

extract_embedded_vibe_document_from_png_bytes
Extracts the serialized embedded vibe document from raw PNG bytes when present.
parse_png_metadata_from_bytes
Parses PNG metadata from raw PNG bytes.
parse_png_metadata_from_payload
Parses PNG metadata from a base64 payload or image data URL.

Type Aliases§

ImageStreamItem
A single parsed item yielded by Client::generate_stream.
ImageStreamResult
The streaming result returned by Client::generate_stream.