AbstractOpenAiCompatibleImageGenerationModel

57abstract class AbstractOpenAiCompatibleImageGenerationModel extends AbstractApiBasedModel implements ImageGenerationModelInterface58{59    /**60     * {@inheritDoc}61     *62     * @since 0.1.063     */64    public function generateImageResult(array $prompt): GenerativeAiResult65    {66        $httpTransporter = $this->getHttpTransporter();67        $params = $this->prepareGenerateImageParams($prompt);68        $request = $this->createRequest(HttpMethodEnum::POST(), 'images/generations', ['Content-Type' => 'application/json'], $params);69        // Add authentication credentials to the request.70        $request = $this->getRequestAuthentication()->authenticateRequest($request);71        // Send and process the request.72        $response = $httpTransporter->send($request);73        $this->throwIfNotSuccessful($response);74        return $this->parseResponseToGenerativeAiResult($response, isset($params['output_format']) && is_string($params['output_format']) ? "image/{$params['output_format']}" : 'image/png');75    }76    /**77     * Prepares the given prompt and the model configuration into parameters for the API request.78     *79     * @since 0.1.080     *81     * @param list<Message> $prompt The prompt to generate an image for. Either a single message or a list of messages82     *                              from a chat. However as of today, OpenAI compatible image generation endpoints only83     *                              support a single user message.84     * @return ImageGenerationParams The parameters for the API request.85     */86    protected function prepareGenerateImageParams(array $prompt): array87    {88        $config = $this->getConfig();89        $params = ['model' => $this->metadata()->getId(), 'prompt' => $this->preparePromptParam($prompt)];90        $candidateCount = $config->getCandidateCount();91        if ($candidateCount !== null) {92            $params['n'] = $candidateCount;93        }94        $outputFileType = $config->getOutputFileType();95        if ($outputFileType !== null) {96            $params['response_format'] = $outputFileType->isRemote() ? 'url' : 'b64_json';97        } else {98            // The 'response_format' parameter is required, so we default to 'b64_json' if not set.99            $params['response_format'] = 'b64_json';100        }101        $outputMimeType = $config->getOutputMimeType();102        if ($outputMimeType !== null) {103            $params['output_format'] = preg_replace('/^image\//', '', $outputMimeType);104        }105        $outputMediaOrientation = $config->getOutputMediaOrientation();106        $outputMediaAspectRatio = $config->getOutputMediaAspectRatio();107        if ($outputMediaOrientation !== null || $outputMediaAspectRatio !== null) {108            $params['size'] = $this->prepareSizeParam($outputMediaOrientation, $outputMediaAspectRatio);109        }110        /*111         * Any custom options are added to the parameters as well.112         * This allows developers to pass other options that may be more niche or not yet supported by the SDK.113         */114        $customOptions = $config->getCustomOptions();115        foreach ($customOptions as $key => $value) {116            if (isset($params[$key])) {117                throw new InvalidArgumentException(sprintf('The custom option "%s" conflicts with an existing parameter.', $key));118            }119            $params[$key] = $value;120        }121        /** @var ImageGenerationParams $params */122        return $params;123    }124    /**125     * Prepares the prompt parameter for the API request.126     *127     * @since 0.1.0128     *129     * @param list<Message> $messages The messages to prepare. However as of today, OpenAI compatible image generation130     *                                endpoints only support a single user message.131     * @return string The prepared prompt parameter.132     */133    protected function preparePromptParam(array $messages): string134    {135        if (count($messages) !== 1) {136            throw new InvalidArgumentException('The API requires a single user message as prompt.');