Description
The OpenAIImage component is a component that collaborates with the AI functions provided by OpenAI. OpenAIImage can invoke a function to generate images from the entered prompts.
※To use this OpenAIImage component, you need to obtain an API Key in advance to call OpenAI's AI functions. For how to obtain an API Key on the OpenAI site, please refer to OpenAI API Key Setup.
Component Properties
| Property Name | Description | Example |
|---|---|---|
| Basic Properties | Specifies the basic properties of the 'OpenAI' category | |
| API Key | API Key ※1 | |
| Organization Id | Organization ID ※1 | |
| User | User name | |
| Operation | Select the operation from Image Creation, Image Editing, Similar Image Generation | Create Image Edit Image Make Image Variation |
| Prompt | Prompt (only for Image Creation or Image Editing operations) | |
| Image File | Image PNG file (only for Image Editing or Similar Image Generation operations) | |
| Mask File | Mask PNG file less than 4MB, use an image of the same size as the Image File (only for Image Editing operations) | |
| n | Number of responses generated per prompt | |
| Image Size | Size of the image to be generated | 1024px by 1024px 512px by 512px 256px by 256px |
| Response Format | Generated data format File URL Base64 | File URL Base64 |
| Filename | Output filename (only for File format data) | |
| File Overwrite | Overwrite output file (only for File format data) If you do not overwrite the file and a file with the same name exists, it will be saved with "-N" appended to the end |
※ For details of each property related to OpenAI, please refer to OpenAI API Reference.
※1 To use the OpenAIImage component, you need to obtain an API key. For how to obtain an API key, please refer to OpenAI API Key Setup.
Operation Property
・When specifying Create Image
Use a square image less than 4MB for the Image File
・When specifying Edit Image
Use a square image less than 4MB for the Image File, if specifying a Mask File, use an image of the same size as the Image File.
Output Payload
| Output Payload | Description |
|---|---|
cv.Payload | If the Response Format property is a file, the filepath of the written file is stored, if URL, the URL is stored, if Base64, the generated data encoded in Base64 is stored |