Structs§
- Bridge
Error - Unified error type returned by this crate.
- Character
- Character prompt input used by V4/V4.5 models.
- Character
Position - Normalized character position in the
[0, 1]range. - Character
Reference - Character reference input used by V4.5 models.
- Client
- High-level NovelAI image API client.
- Client
Options - Options used to construct a
Clientwith the defaultReqwestTransport. - Control
NetConfig - Controlnet-style configuration.
- Control
NetInput - One controlnet-style reference input.
- Encode
Vibe Request - Request used by
crate::Client::encode_vibe. - Generate
Image Request - Request used by
crate::Client::generate. - Generate
Image Stream Request - Request used by
crate::Client::generate_stream. - Generated
Image - Generated image payload.
- Image
Size - Image dimensions in pixels.
- Image
Stream Chunk - Parsed stream chunk emitted by NovelAI image streaming.
- Img2
ImgRequest - Image-to-image input.
- PngMetadata
- Parsed metadata recovered from a PNG image payload.
- Reqwest
Transport - Default
Transportimplementation backed byreqwest + rustls. - RunDirector
Tool Request - Request used by
crate::Client::run_director_tool. - Subscription
Info - Subscription summary returned by
crate::Client::get_subscription. - Vibe
Metadata Entry - A single vibe-related metadata entry recovered from a PNG payload.
Enums§
- ApiKey
Source - Selects how the API key is resolved.
- Bridge
Error Code - Stable error codes returned by this crate.
- Character
Reference Type - Character reference behavior used by V4.5 director references.
- Director
Tool - Supported NovelAI director tools.
- Image
Format - Supported generated image output formats.
- Model
- Supported NovelAI image models.
- Noise
Schedule - Supported noise schedules.
- Sampler
- Supported image samplers.
- Stream
Mode - Supported image stream modes.
- UcPreset
- Built-in UC presets supported by NovelAI.
- Vibe
Metadata Source - 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§
- Image
Stream Item - A single parsed item yielded by
Client::generate_stream. - Image
Stream Result - The streaming result returned by
Client::generate_stream.