PromptBuilder::generateResult( WordPress\AiClient\Providers\Models\Enums\CapabilityEnum|null $capability = null ): WordPress\AiClient\Results\DTO\GenerativeAiResult
- Since
- 0.1.0
- Source
wp-includes/php-ai-client/src/Builders/PromptBuilder.php:812
Description
This is the primary execution method that generates a result (containing potentially multiple candidates) based on the specified capability or the configured output modality.
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|nulloptional- Optional capability to use for generation.
If null, capability is inferred from output modality.Default:null
Return value
WordPress\AiClient\Results\DTO\GenerativeAiResult- The generated result containing candidates.
Performance profile
How much work a call to PromptBuilder::generateResult() 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
- 40–57
- 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 57.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost PromptBuilder::generateResult() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$capability !== null | 40–45 | ->validateMessages(), ->getConfiguredModel(), ->dispatchEvent(), ->executeModelGeneration(), ->dispatchEvent() |
$capability === null | 48 | ->validateMessages(), ->inferCapabilityFromOutputModalities(), ->getConfiguredModel(), ->dispatchEvent(), ->executeModelGeneration(), ->dispatchEvent() |
| always | 53–54 | ->validateMessages(), ->inferCapabilityFromModelInterfaces(), ->getConfiguredModel(), ->dispatchEvent(), ->executeModelGeneration(), ->dispatchEvent() |
$capability === null | 56–57 | ->validateMessages(), ->inferCapabilityFromModelInterfaces(), ->inferCapabilityFromOutputModalities(), ->getConfiguredModel(), ->dispatchEvent(), ->executeModelGeneration(), ->dispatchEvent() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 57 instructions, 40–57 executed per call, 4 branches. The work does not change between versions.
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 · 8
- \WordPress\AiClient\Builders\PromptBuilder::validateMessages()
- \WordPress\AiClient\Builders\PromptBuilder::inferCapabilityFromModelInterfaces()
- \WordPress\AiClient\Builders\PromptBuilder::inferCapabilityFromOutputModalities()
- \WordPress\AiClient\Builders\PromptBuilder::getConfiguredModel()
- \WordPress\AiClient\Builders\PromptBuilder::dispatchEvent()
- \WordPress\AiClient\Events\BeforeGenerateResultEvent::__construct()
- \WordPress\AiClient\Builders\PromptBuilder::executeModelGeneration()
- \WordPress\AiClient\Events\AfterGenerateResultEvent::__construct()
Source code
public function generateResult(?CapabilityEnum $capability = null): GenerativeAiResult { $this->validateMessages(); // If capability is not provided, infer it if ($capability === null) { // First try to infer from a specific model if one is set if ($this->model !== null) { $inferredCapability = $this->inferCapabilityFromModelInterfaces($this->model); if ($inferredCapability !== null) { $capability = $inferredCapability; } } // If still no capability, infer from output modalities if ($capability === null) { $capability = $this->inferCapabilityFromOutputModalities(); } } $model = $this->getConfiguredModel($capability); // Dispatch BeforeGenerateResultEvent $this->dispatchEvent(new BeforeGenerateResultEvent($this->messages, $model, $capability)); // Route to the appropriate generation method based on capability $result = $this->executeModelGeneration($model, $capability, $this->messages); // Dispatch AfterGenerateResultEvent $this->dispatchEvent(new AfterGenerateResultEvent($this->messages, $model, $capability, $result)); return $result; }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.