image

OpenAI image generation service implementation.

This module provides integration with OpenAI’s DALL-E image generation API for creating images from text prompts.

class pipecat.services.openai.image.OpenAIImageGenSettings(model: str | None | _NotGiven = <factory>, extra: dict[str, Any]=<factory>, image_size: str | None | _NotGiven = <factory>)[source]

Bases: ImageGenSettings

Settings for the OpenAI image generation service.

Parameters:

  • model – DALL-E model identifier.

  • image_size – Target size for generated images.

image_size: str | None | _NotGiven
class pipecat.services.openai.image.OpenAIImageGenService(*, api_key: str, base_url: str | None = None, aiohttp_session: ClientSession, image_size: Literal['256x256', '512x512', '1024x1024', '1792x1024', '1024x1792'] | None = None, model: str | None = None, settings: OpenAIImageGenSettings | None = None)[source]

Bases: ImageGenService

OpenAI DALL-E image generation service.

Provides image generation capabilities using OpenAI’s DALL-E models. Supports various image sizes and can generate images from text prompts with configurable quality and style parameters.

Settings

alias of OpenAIImageGenSettings

__init__(*, api_key: str, base_url: str | None = None, aiohttp_session: ClientSession, image_size: Literal['256x256', '512x512', '1024x1024', '1792x1024', '1024x1792'] | None = None, model: str | None = None, settings: OpenAIImageGenSettings | None = None)[source]

Initialize the OpenAI image generation service.

Parameters:

  • api_key – OpenAI API key for authentication.

  • base_url – Custom base URL for OpenAI API. If None, uses default.

  • aiohttp_session – HTTP session for downloading generated images.

  • image_size –

    Target size for generated images. Defaults to “1024x1024”.

    Deprecated since version 0.0.105: Use settings=OpenAIImageGenService.Settings(image_size=...) instead.

  • model –

    DALL-E model to use for generation. Defaults to “dall-e-3”.

    Deprecated since version 0.0.105: Use settings=OpenAIImageGenService.Settings(model=...) instead.

  • settings – Runtime-updatable settings. When provided alongside deprecated parameters, settings values take precedence.

async run_image_gen(prompt: str) → AsyncGenerator[Frame, None][source]

Generate an image from a text prompt using OpenAI’s DALL-E.

Parameters:

prompt – Text description of the image to generate.

Yields:

Frame – URLImageRawFrame containing the generated image data.