module pixeltable.functions.reve

Pixeltable UDFs that wrap Reve image generation API. In order to use them, the API key must be specified either with REVE_API_KEY environment variable, or as api_key in the reve section of the Pixeltable config file.

udf create()

Signature

@pxt.udf
create(
    prompt: pxt.String,
    *,
    references: pxt.Json[(Image, ...)] | None = None,
    aspect_ratio: pxt.String | None = None,
    postprocessing: pxt.Json[(Json, ...)] | None = None,
    version: pxt.String | None = None,
    model_kwargs: pxt.Json | None = None
) -> ImageResponse

Creates an image from a text prompt, optionally guided by reference images. The prompt may include <frame>0</frame>, <frame>1</frame>, etc. tags to refer to the reference images. This UDF wraps the https://api.reve.com/v2/image/create endpoint. For more information, refer to the official API documentation. Parameters:

prompt (pxt.String): prompt describing the desired image
references (pxt.Json[(Image): optional list of reference images to guide the model
aspect_ratio (Any): desired image aspect ratio, e.g. ‘3:2’, ‘16:9’, ‘1:1’, etc.
postprocessing (Any): optional list of postprocessing operations to apply to the generated image e.g. [{'process': 'effect', 'effect_name': 'low_light'}].
version (Any): specific model version to use. Latest if not specified.
model_kwargs (Any): additional keyword arguments to pass to the Reve API.

Returns:

ImageResponse: A dictionary containing the generated image ('image' key) and layout metadata ('layout' key) returned by the Reve API.

Examples: Add a computed column with generated images from text prompts:

t.add_computed_column(img=reve.create(t.prompt, aspect_ratio='1:1'))

Remove the background from an image:

t.add_computed_column(
    img=reve.create(
        'Remove the background from <frame>0</frame> and replace it with a clean white background',
        references=[t.product_img],
    )
)

Add a computed column that generates product shots in the style of a brand reference image:

t.add_computed_column(
    img=reve.create(
        'Generate a product shot of <frame>0</frame> styled to match the aesthetic of <frame>1</frame>',
        references=[t.product_img, t.brand_reference_img],
    )
)

​module pixeltable.functions.reve

​udf create()

module pixeltable.functions.reve

udf create()