PromptBuilder::usingModelPreference( string|WordPress\AiClient\Providers\Models\Contracts\ModelInterface|WordPress\AiClient\Builders\array{0:string,1:string} $preferredModels ): self
- Since
- 0.2.0
- Source
wp-includes/php-ai-client/src/Builders/PromptBuilder.php:256
Compatibility
- WordPress
- since 0.2.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.2.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$preferredModelsstring|WordPress\AiClient\Providers\Models\Contracts\ModelInterface|WordPress\AiClient\Builders\array{0:string,1:string}- The preferred models as model IDs, model instances, or [provider ID, model ID] tuples. For broader compatibility, it is recommended you specify only model IDs or model instances, as that will allow for different providers that expose the same model to be considered.
Return value
self
Performance profile
How much work a call to PromptBuilder::usingModelPreference() 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
- Light
- Scaling
- Scales with input
- Instructions
- 7–19
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 85.
Nothing here hands control to plugin code.
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 PromptBuilder::usingModelPreference() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 7–16 | none |
$preferredModels !== false && !$preferredModels && is_array($preferredModel) | 16–19 | array_is_list() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 85 | 7–19 | 8 | |
| 8.5 | 85 | 7–19 | 8 | 1 fewer instruction than PHP 8.4 |
| 8.4 | 86 | 7–19 | 8 | |
| 8.3 | 86 | 7–19 | 8 | |
| 8.2 | 86 | 7–19 | 8 | |
| 8.1 | 86 | 7–19 | 8 | |
| 7.4 | 86 | 7–19 | 8 |
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 · 5
- array_is_list()Polyfill for `array_is_list()` function added in PHP 8.1.
- \WordPress\AiClient\Common\Exception\InvalidArgumentException::__construct()
- \WordPress\AiClient\Builders\PromptBuilder::normalizePreferenceIdentifier()
- \WordPress\AiClient\Builders\PromptBuilder::createProviderModelPreferenceKey()
- \WordPress\AiClient\Builders\PromptBuilder::createModelPreferenceKey()
Source code
public function usingModelPreference(...$preferredModels): self { if ($preferredModels === []) { throw new InvalidArgumentException('At least one model preference must be provided.'); } $preferenceKeys = []; foreach ($preferredModels as $preferredModel) { if (is_array($preferredModel)) { // [model identifier, provider ID] tuple if (!array_is_list($preferredModel) || count($preferredModel) !== 2) { throw new InvalidArgumentException('Model preference tuple must contain model identifier and provider ID.'); } [$providerId, $modelId] = $preferredModel; $modelId = $this->normalizePreferenceIdentifier($modelId); $providerId = $this->normalizePreferenceIdentifier($providerId, 'Model preference provider identifiers cannot be empty.'); $preferenceKey = $this->createProviderModelPreferenceKey($providerId, $modelId); } elseif ($preferredModel instanceof ModelInterface) { // Model instance $modelId = $preferredModel->metadata()->getId(); $providerId = $preferredModel->providerMetadata()->getId(); $preferenceKey = $this->createProviderModelPreferenceKey($providerId, $modelId); } elseif (is_string($preferredModel)) { // Model ID $modelId = $this->normalizePreferenceIdentifier($preferredModel); $preferenceKey = $this->createModelPreferenceKey($modelId); } else { // Invalid type throw new InvalidArgumentException('Model preferences must be model identifiers, instances of ModelInterface, ' . 'or provider/model tuples.'); } $preferenceKeys[] = $preferenceKey; } $this->modelPreferenceKeys = $preferenceKeys; return $this; }Changelog
Introduced in 0.2.0. Unchanged from 7.0.4 through 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/Builders/PromptBuilder.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.