wppaste
WordPress

AbstractOpenAiCompatibleTextGenerationModel::prepareOutputModalitiesParam( WordPress\AiClient\Providers\OpenAiCompatibleImplementation\array<ModalityEnum> $modalities ): WordPress\AiClient\Providers\OpenAiCompatibleImplementation\list<string>

Since
0.1.0
Source
wp-includes/php-ai-client/src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleTextGenerationModel.php:336
Prepares the output modalities parameter for the API request.

Compatibility

WordPress
since 0.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$modalitiesWordPress\AiClient\Providers\OpenAiCompatibleImplementation\array<ModalityEnum>
The modalities to prepare.

Return value

WordPress\AiClient\Providers\OpenAiCompatibleImplementation\list<string>
The prepared modalities parameter.

Performance profile

How much work a call to AbstractOpenAiCompatibleTextGenerationModel::prepareOutputModalitiesParam() 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
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
5–20

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

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 · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always5–6none
!$modalities && !->isText() && !->isImage() && !->isAudio()20->isText(), ->isImage(), ->isAudio()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev315–205
8.5315–205
8.4315–2051 fewer instruction than PHP 8.3
8.3325–215
8.2325–215
8.1325–215
7.4325–215

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

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

Source code

    protected function prepareOutputModalitiesParam(array $modalities): array    {        $prepared = [];        foreach ($modalities as $modality) {            if ($modality->isText()) {                $prepared[] = 'text';            } elseif ($modality->isImage()) {                $prepared[] = 'image';            } elseif ($modality->isAudio()) {                $prepared[] = 'audio';            } else {                throw new InvalidArgumentException(sprintf('Unsupported output modality "%s".', $modality));            }        }        return $prepared;    }

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.