Skip to main content

sdk.standardisedgeneratefunction

Home > @kittl/sdk > StandardisedGenerateFunction

StandardisedGenerateFunction type​

The type for the generate function for the AI generator tool. This is the function that will be called when the user submits their generation request.

Signature:

export type StandardisedGenerateFunction = (settings: {
    prompt: string;
    referenceFrameMode?: ReferenceFrameMode;
    previewImages?: {
        id: string;
        preview?: string;
    }[];
    aspectRatio?: string;
    model?: {
        id: string;
    } | {
        key: string;
    };
    numberToGenerate?: number;
    additionalParams?: Record<string, unknown>;
}) => Promise<void>;

References: ReferenceFrameMode