AbstractOpenAiCompatibleTextGenerationModel::getMessagePartContentData( WordPress\AiClient\Messages\DTO\MessagePart $part ): WordPress\AiClient\Providers\OpenAiCompatibleImplementation\?array<string,

Compatibility

Present in 2 of the 5 tracked releases, added in 0.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$partWordPress\AiClient\Messages\DTO\MessagePart

The message part to get the data for.

Return value

WordPress\AiClient\Providers\OpenAiCompatibleImplementation\?array<string,

mixed> The data for the message content part, or null if not applicable.

Performance profile

How much work a call to AbstractOpenAiCompatibleTextGenerationModel::getMessagePartContentData() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

13–34

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 100.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 11 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost AbstractOpenAiCompatibleTextGenerationModel::getMessagePartContentData() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• \WordPress\AiClient\Common\Exception\RuntimeException::__construct()
• \WordPress\AiClient\Common\Exception\InvalidArgumentException::__construct()

Source code

View on Trac ↗View on GitHub ↗

227    protected function getMessagePartContentData(MessagePart $part): ?array228    {229        $type = $part->getType();230        if ($type->isText()) {231            /*232             * The OpenAI Chat Completions API spec does not support annotating thought parts as input,233             * so we instead skip them.234             */235            if ($part->getChannel()->isThought()) {236                return null;237            }238            return ['type' => 'text', 'text' => $part->getText()];239        }240        if ($type->isFile()) {241            $file = $part->getFile();242            if (!$file) {243                // This should be impossible due to class internals, but still needs to be checked.244                throw new RuntimeException('The file typed message part must contain a file.');245            }246            if ($file->isRemote()) {247                if ($file->isImage()) {248                    return ['type' => 'image_url', 'image_url' => ['url' => $file->getUrl()]];249                }250                throw new InvalidArgumentException(sprintf('Unsupported MIME type "%s" for remote file message part.', $file->getMimeType()));251            }252            // Else, it is an inline file.253            if ($file->isImage()) {254                return ['type' => 'image_url', 'image_url' => ['url' => $file->getDataUri()]];255            }256            if ($file->isAudio()) {257                return ['type' => 'input_audio', 'input_audio' => ['data' => $file->getBase64Data(), 'format' => $file->getMimeTypeObject()->toExtension()]];258            }259            throw new InvalidArgumentException(sprintf('Unsupported MIME type "%s" for inline file message part.', $file->getMimeType()));260        }261        if ($type->isFunctionCall()) {262            // Skip, as this is separately included. See `getMessagePartToolCallData()`.263            return null;264        }265        if ($type->isFunctionResponse()) {266            // Special case: Function response.267            throw new InvalidArgumentException('The API only allows a single function response, as the only content of the message.');268        }269        throw new InvalidArgumentException(sprintf('Unsupported message part type "%s".', $type));270    }

Changelog

Introduced in 0.1.0. Unchanged from 7.0.4 through 7.1.0.

1. 7.0.4
2. 7.1.0

Signature, return type and hooks compared across 2 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/php-ai-client/src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleTextGenerationModel.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.