Skip to main content

.AIIMAGE_OPENAI

Erzeugt und analysiert Bilder per OpenAI (RAGAI.AIIMAGE_OPENAI).

Hintergrund

create generiert per Standard ein neues Bild; über opts.image/opts.images wird stattdessen eine Bildbearbeitung (Referenzbild(er) als Basis) angestoßen. analyzeImage ist die einzige der drei Bild-Provider-Klassen (AIIMAGE_OPENAI/_FALAI/_STABLEDIFFUSION), die auch Bild-Analyse (Vision, nicht nur Generierung) anbietet - die anderen beiden können nur erzeugen/bearbeiten.

Methoden

.create(prompt, opts?)

Generiert ein Bild per OpenAI-Modell.

ParameterTypBeschreibung
promptstring | z.input<typeof aiImageCreateSchema>Der Text-Prompt oder ein Objekt gemäß aiImageCreateSchema.
optsOmit<ImageGenerateParams, "prompt"> & &#123; image?: string, images?: string[], aspectRatio?: string &#125;Zusätzliche OpenAI-Bildoptionen.

Objekt-Form (validiert über aiImageCreateSchema):

FeldTypPflichtBeschreibung
promptstringDer Text-Prompt für die Bildgenerierung.
imagestringReferenzbild-URL für die Bildbearbeitung.
imagesarrayMehrere Referenzbilder für die Bildbearbeitung.
aspectRatiostringGewünschtes Seitenverhältnis des Ergebnisbildes.
qualitystringGewünschte Bildqualität.
modelstringDas zu verwendende Bildmodell.

Rückgabewert: Promise<AiImageFile>

Die erzeugte Bilddatei.

.getImageUrl(fileId)

Erstellt eine ladbare URL für ein zuvor erzeugtes Bild.

ParameterTypBeschreibung
fileIdstring | z.input<typeof aiImageFileIdSchema>ID der Bilddatei oder ein Objekt gemäß aiImageFileIdSchema.

Objekt-Form (validiert über aiImageFileIdSchema):

FeldTypPflichtBeschreibung
fileIdstringID der Bilddatei.

Rückgabewert: string

Die URL zum Laden des Bildes.

.analyzeImage(image, prompt?)

Lässt ein Bild von OpenAI analysieren und beschreiben.

ParameterTypBeschreibung
imagestring | z.input<typeof aiImageAnalyzeSchema>Bild-URL oder ein Objekt gemäß aiImageAnalyzeSchema.
promptstringZusätzliche Anweisung für die Analyse.

Objekt-Form (validiert über aiImageAnalyzeSchema):

FeldTypPflichtBeschreibung
imagestringBild-URL, das analysiert werden soll.
promptstringZusätzliche Anweisung für die Analyse.

Rückgabewert: Promise<string>

Die von der KI erzeugte Bildbeschreibung.