llm4s-core
API
Generated with
llm4s-core/org.llm4s/org.llm4s.imagegeneration/ImageGeneration

ImageGeneration

org.llm4s.imagegeneration.ImageGeneration
object ImageGeneration

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def client(config: ImageGenerationConfig): Either[ImageGenerationError, ImageGenerationClient]

Factory method for getting a client with the right configuration

Factory method for getting a client with the right configuration

Attributes

def editImage(imagePath: Path, prompt: String, maskPath: Option[Path], config: ImageGenerationConfig, options: ImageEditOptions): Either[ImageGenerationError, Seq[GeneratedImage]]

Convenience method for edit image

Convenience method for edit image

Attributes

def editImageAsync(imagePath: Path, prompt: String, maskPath: Option[Path], config: ImageGenerationConfig, options: ImageEditOptions)(implicit ec: ExecutionContext): Future[Either[ImageGenerationError, Seq[GeneratedImage]]]

Convenience method for editing an image asynchronously

Convenience method for editing an image asynchronously

Attributes

def generateImage(prompt: String, config: ImageGenerationConfig, options: ImageGenerationOptions): Either[ImageGenerationError, GeneratedImage]

Convenience method for quick image generation

Convenience method for quick image generation

Attributes

def generateImageAsync(prompt: String, config: ImageGenerationConfig, options: ImageGenerationOptions)(implicit ec: ExecutionContext): Future[Either[ImageGenerationError, GeneratedImage]]

Convenience method for generating an image asynchronously

Convenience method for generating an image asynchronously

Attributes

def generateImages(prompt: String, count: Int, config: ImageGenerationConfig, options: ImageGenerationOptions): Either[ImageGenerationError, Seq[GeneratedImage]]

Convenience method for generating multiple images

Convenience method for generating multiple images

Attributes

def generateImagesAsync(prompt: String, count: Int, config: ImageGenerationConfig, options: ImageGenerationOptions)(implicit ec: ExecutionContext): Future[Either[ImageGenerationError, Seq[GeneratedImage]]]

Convenience method for generating multiple images asynchronously

Convenience method for generating multiple images asynchronously

Attributes

def generateWithOpenAI(prompt: String, apiKey: String, options: ImageGenerationOptions, model: String): Either[ImageGenerationError, GeneratedImage]

Convenience method for quick OpenAI image generation

Convenience method for quick OpenAI image generation

Attributes

def generateWithStabilityAI(prompt: String, apiKey: String, options: ImageGenerationOptions, model: String): Either[ImageGenerationError, GeneratedImage]

Convenience method for quick Stability AI image generation

Convenience method for quick Stability AI image generation

Attributes

def generateWithStableDiffusion(prompt: String, options: ImageGenerationOptions, baseUrl: String): Either[ImageGenerationError, GeneratedImage]

Convenience method for quick Stable Diffusion image generation

Convenience method for quick Stable Diffusion image generation

Attributes

def healthCheck(config: ImageGenerationConfig): Either[ImageGenerationError, ServiceStatus]

Check service health

Check service health

Attributes

def huggingFaceClient(apiKey: String, model: String): Either[ImageGenerationError, ImageGenerationClient]

Get a HuggingFace client with the required API key.

Get a HuggingFace client with the required API key.

This is a convenience method for creating a client that connects to the HuggingFace Inference API for image generation.

Value parameters

apiKey

Your HuggingFace API token (required).

model

The specific model to use for generation. Defaults to a standard Stable Diffusion model.

Attributes

Returns

Either an error or an ImageGenerationClient instance configured for HuggingFace.

def openAIClient(apiKey: String, model: String): Either[ImageGenerationError, ImageGenerationClient]

Get an OpenAI client with the required API key.

Get an OpenAI client with the required API key.

This is a convenience method for creating a client that connects to the OpenAI API for image generation.

Value parameters

apiKey

Your OpenAI API key (required).

model

The model version to use. Defaults to gpt-image-1.

Attributes

Returns

Either an error or an ImageGenerationClient instance configured for OpenAI.

def stabilityAIClient(apiKey: String, model: String): Either[ImageGenerationError, ImageGenerationClient]

Get a Stability AI client with the required API key.

Get a Stability AI client with the required API key.

This is a convenience method for creating a client that connects to the Stability AI API for image generation.

Value parameters

apiKey

Your Stability AI API key (required).

model

The specific engine/model to use for generation. Defaults to stable-diffusion-xl-1024-v1-0.

Attributes

Returns

Either an error or an ImageGenerationClient instance configured for Stability AI.

def stableDiffusionClient(baseUrl: String, apiKey: Option[String]): Either[ImageGenerationError, ImageGenerationClient]

Get a Stable Diffusion client with default local configuration

Get a Stable Diffusion client with default local configuration

Attributes

Generated with