novelai-sdk-unofficial / GenerateImageParamsSchema

Variable: GenerateImageParamsSchema

const GenerateImageParamsSchema: ZodObject<{ cfgRescale: ZodDefault<ZodNumber>; characterReferences: ZodOptional<ZodArray<ZodObject<{ fidelity: ZodDefault<ZodNumber>; image: ZodUnion<readonly [ZodString, ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>, ZodCustom<ArrayBuffer, ArrayBuffer>]>; type: ZodDefault<ZodEnum<{ character: "character"; character&style: "character&style"; }>>; }, $strip>>>; characters: ZodOptional<ZodArray<ZodObject<{ enabled: ZodDefault<ZodBoolean>; negativePrompt: ZodDefault<ZodString>; position: ZodDefault<ZodUnion<readonly [ZodEnum<{ A1: ...; A2: ...; A3: ...; A4: ...; A5: ...; B1: ...; B2: ...; B3: ...; B4: ...; B5: ...; C1: ...; C2: ...; C3: ...; C4: ...; C5: ...; D1: ...; D2: ...; D3: ...; D4: ...; D5: ...; E1: ...; E2: ...; E3: ...; E4: ...; E5: ...; }>, ZodTuple<[..., ...], null>]>>; prompt: ZodString; }, $strip>>>; controlnet: ZodOptional<ZodObject<{ images: ZodArray<ZodObject<{ controlnetModel: ZodOptional<ZodEnum<{ nai-diffusion-3: ...; nai-diffusion-3-furry: ...; nai-diffusion-4-5-curated: ...; nai-diffusion-4-5-full: ...; nai-diffusion-4-curated: ...; nai-diffusion-4-full: ...; }>>; image: ZodUnion<readonly [ZodString, ZodCustom<..., ...>, ZodCustom<..., ...>]>; infoExtracted: ZodDefault<ZodNumber>; strength: ZodDefault<ZodNumber>; }, $strip>>; strength: ZodDefault<ZodNumber>; }, $strip>>; i2i: ZodOptional<ZodObject<{ image: ZodUnion<readonly [ZodString, ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>, ZodCustom<ArrayBuffer, ArrayBuffer>]>; mask: ZodOptional<ZodUnion<readonly [ZodString, ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>, ZodCustom<ArrayBuffer, ArrayBuffer>]>>; noise: ZodDefault<ZodNumber>; strength: ZodDefault<ZodNumber>; }, $strip>>; imageFormat: ZodOptional<ZodEnum<{ png: "png"; webp: "webp"; }>>; model: ZodDefault<ZodEnum<{ nai-diffusion-3: "nai-diffusion-3"; nai-diffusion-3-furry: "nai-diffusion-3-furry"; nai-diffusion-4-5-curated: "nai-diffusion-4-5-curated"; nai-diffusion-4-5-full: "nai-diffusion-4-5-full"; nai-diffusion-4-curated: "nai-diffusion-4-curated"; nai-diffusion-4-full: "nai-diffusion-4-full"; }>>; negativePrompt: ZodOptional<ZodString>; noiseSchedule: ZodDefault<ZodEnum<{ exponential: "exponential"; karras: "karras"; polyexponential: "polyexponential"; }>>; nSamples: ZodDefault<ZodNumber>; prompt: ZodString; quality: ZodDefault<ZodBoolean>; sampler: ZodDefault<ZodEnum<{ ddim: "ddim"; k_dpm_2: "k_dpm_2"; k_dpm_2_ancestral: "k_dpm_2_ancestral"; k_dpmpp_2m: "k_dpmpp_2m"; k_dpmpp_2s_ancestral: "k_dpmpp_2s_ancestral"; k_dpmpp_sde: "k_dpmpp_sde"; k_euler: "k_euler"; k_euler_ancestral: "k_euler_ancestral"; }>>; scale: ZodDefault<ZodNumber>; seed: ZodDefault<ZodOptional<ZodNumber>>; size: ZodDefault<ZodUnion<readonly [ZodEnum<{ landscape: "landscape"; large_landscape: "large_landscape"; large_portrait: "large_portrait"; portrait: "portrait"; square: "square"; }>, ZodTuple<[ZodNumber, ZodNumber], null>]>>; steps: ZodDefault<ZodNumber>; ucPreset: ZodDefault<ZodEnum<{ furry_focus: "furry_focus"; human_focus: "human_focus"; light: "light"; none: "none"; strong: "strong"; }>>; varietyBoost: ZodDefault<ZodBoolean>; }, $strip>

Defined in: src/types/user/image.ts:203

High-level parameters for image generation

This is a user-friendly interface that provides sensible defaults and validation for all parameters.