prodia-gen v1.0.5

Prodia-gen Module Documentation

• Update 1.0.5

• The code is now entirely written in commonjs

The prodia-gen package provides a straightforward interface for generating images through the Prodia API. Developers can effortlessly create captivating visuals with just a few lines of code. Below, you'll find an overview of the package's functions and their usage.

Models(caseNumber)

The Models function takes a caseNumber as input and retrieves the corresponding model name from the predefined modelNames array. This array contains a list of available model names. If the provided caseNumber falls within the valid range (from 1 to the length of modelNames), the function returns the associated model name. If an invalid caseNumber is provided, an error is thrown, indicating that the model ID is not valid.

generate(options)

• Parameters:

  • options.prompt (string, required): The prompt for generating the image.
  • options.cfg_scale (number, optional): The scale factor for the configuration. Default is 7.
  • options.model (number, required): The case number of the model to be used for image generation.
  • options.aspect_ratio (string, optional): The aspect ratio of the generated image. Default is 'square'.
  • options.seed (string, optional): The seed for randomization in image generation. If not provided, a random seed will be generated using generateRandomSeed().
  • options.negative_prompt (string, optional): A negative prompt for generating the image.
  • options.steps (number, optional): The number of steps in the generation process. Default is 50.
  • options.new (boolean, optional): If false then it generates consistent images else unseen before images. Default is false.

• Returns: An object containing the generated image URL.

  Installation

npm i prodia-gen

• Usage:

const { generate } = require('prodia-gen');

// Example usage to generate a consistent image
try {
  const result = await generate({
    prompt: "A mesmerizing fantasy world",
    model: 1,
    // Optional: Include other options if needed
  });

  console.log("Generated Image URL:", result);
} catch (error) {
  console.error("Error:", error.message);
}

The Models function provides transparency into the available models.

Below is an Example

const { Models } = require ("prodia-gen");
// Log the models array from the function
console.log(Models(true));

// Logs the entire model array if the provided parameter is a Boolean