Skip to main content

GenerateImageParams

ug-js-sdk

ug-js-sdk / GenerateImageParams

Interface: GenerateImageParams

Defined in: conversation-manager/types.ts:16

Parameters for image generation via the REST API. These parameters work with both Bria and Replicate providers.

Example​

const params: GenerateImageParams = {
  provider: 'bria',
  prompt: 'A sunset over mountains',
  aspect_ratio: '16:9',
};

Properties​

prompt​

prompt: string

Defined in: conversation-manager/types.ts:18

The text prompt describing the image to generate

provider​

provider: "bria" | "replicate"

Defined in: conversation-manager/types.ts:20

The image generation provider to use

negative_prompt?​

optional negative_prompt: string

Defined in: conversation-manager/types.ts:24

Text describing what to avoid in the generated image

aspect_ratio?​

optional aspect_ratio: string

Defined in: conversation-manager/types.ts:26

Aspect ratio for the generated image (e.g., '16:9', '1:1')

seed?​

optional seed: number

Defined in: conversation-manager/types.ts:28

Seed for reproducible generation

inference_steps?​

optional inference_steps: number

Defined in: conversation-manager/types.ts:30

Number of inference steps for the generation process

generation_type?​

optional generation_type: "fast" | "tailored"

Defined in: conversation-manager/types.ts:34

Generation type for Bria: 'fast' for quick generation, 'tailored' for higher quality

model?​

optional model: string

Defined in: conversation-manager/types.ts:36

Specific model to use for generation

image?​

optional image: string

Defined in: conversation-manager/types.ts:38

Base64 encoded image for image-to-image generation

strength?​

optional strength: number

Defined in: conversation-manager/types.ts:40

Strength of the transformation for image-to-image (0.0 to 1.0)

guidance_scale?​

optional guidance_scale: number

Defined in: conversation-manager/types.ts:42

Guidance scale for generation (higher = more adherence to prompt)

lora_weights?​

optional lora_weights: string

Defined in: conversation-manager/types.ts:46

URL to LoRA weights for Replicate models

lora_scale?​

optional lora_scale: number

Defined in: conversation-manager/types.ts:48

Scale factor for LoRA weights (typically -1 to 3)