PromptBuilder::getConfiguredModel( WordPress\AiClient\Providers\Models\Enums\CapabilityEnum $capability ): WordPress\AiClient\Providers\Models\Contracts\ModelInterface
- Since
- 0.1.0
- Source
wp-includes/php-ai-client/src/Builders/PromptBuilder.php:1148
Description
If a model has been explicitly set, validates it meets requirements and returns it.
Otherwise, finds a suitable model based on the prompt requirements.
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
$capabilityWordPress\AiClient\Providers\Models\Enums\CapabilityEnum- The capability the model will be using.
Return value
WordPress\AiClient\Providers\Models\Contracts\ModelInterface- The model to use.
Performance profile
How much work a call to PromptBuilder::getConfiguredModel() 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
- Scaling
- Constant
- Instructions
- 29–55
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 109.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost PromptBuilder::getConfiguredModel() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 29 | ::ModelRequirements(), ->setConfig(), ->bindModelDependencies(), ->bindModelRequestOptions() |
empty($candidateMap) | 31–39 | ::ModelRequirements(), ->getCandidateModelsMap() |
!empty($candidateMap) && empty($value) | 42 | ::ModelRequirements(), ->getCandidateModelsMap(), reset(), ->getProviderModel(), ->bindModelRequestOptions() |
!empty($candidateMap) && !empty($value) && empty($matchingPreferences) | 53 | ::ModelRequirements(), ->getCandidateModelsMap(), array_flip(), array_intersect_key(), reset(), ->getProviderModel(), ->bindModelRequestOptions() |
!empty($candidateMap) && !empty($value) && !empty($matchingPreferences) | 55 | ::ModelRequirements(), ->getCandidateModelsMap(), array_flip(), array_intersect_key(), key(), ->getProviderModel(), ->bindModelRequestOptions() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 109 | 29–55 | 5 | |
| 8.5 | 109 | 29–55 | 5 | |
| 8.4 | 109 | 29–55 | 5 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 111 | 29–55 | 5 | |
| 8.2 | 111 | 29–55 | 5 | 4 fewer instructions than PHP 8.1 |
| 8.1 | 115 | 29–57 | 5 | |
| 7.4 | 115 | 29–57 | 5 |
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 · 4
- \WordPress\AiClient\Providers\Models\DTO\ModelRequirements::fromPromptData()
- \WordPress\AiClient\Builders\PromptBuilder::bindModelRequestOptions()
- \WordPress\AiClient\Builders\PromptBuilder::getCandidateModelsMap()
- \WordPress\AiClient\Common\Exception\InvalidArgumentException::__construct()
Source code
private function getConfiguredModel(CapabilityEnum $capability): ModelInterface { $requirements = ModelRequirements::fromPromptData($capability, $this->messages, $this->modelConfig); if ($this->model !== null) { // Explicit model was provided via usingModel(); just update config and bind dependencies. $model = $this->model; $model->setConfig($this->modelConfig); $this->registry->bindModelDependencies($model); $this->bindModelRequestOptions($model); return $model; } // Retrieve the candidate models map which satisfies the requirements. $candidateMap = $this->getCandidateModelsMap($requirements); if (empty($candidateMap)) { $message = sprintf('No models found that support %s for this prompt.', $capability->value); if ($this->providerIdOrClassName !== null) { $message = sprintf('No models found for provider "%s" that support %s for this prompt.', $this->providerIdOrClassName, $capability->value); } throw new InvalidArgumentException($message); } // Check if any preferred models match the candidates, in priority order. if (!empty($this->modelPreferenceKeys)) { // Find preferences that match available candidates, preserving preference order. $matchingPreferences = array_intersect_key(array_flip($this->modelPreferenceKeys), $candidateMap); if (!empty($matchingPreferences)) { // Get the first matching preference key $firstMatchKey = key($matchingPreferences); [$providerId, $modelId] = $candidateMap[$firstMatchKey]; $model = $this->registry->getProviderModel($providerId, $modelId, $this->modelConfig); $this->bindModelRequestOptions($model); return $model; } } // No preference matched; fall back to the first candidate discovered. [$providerId, $modelId] = reset($candidateMap); $model = $this->registry->getProviderModel($providerId, $modelId, $this->modelConfig); $this->bindModelRequestOptions($model); return $model; }Changelog
Introduced in 0.1.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.