[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/php-ai-client/src/Providers/Models/DTO/ -> ModelRequirements.php (summary)

(no description)

File Size: 315 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ModelRequirements:: (10 methods):
  __construct()
  getRequiredCapabilities()
  getRequiredOptions()
  areMetBy()
  fromPromptData()
  toRequiredOptions()
  includeInRequiredOptions()
  getJsonSchema()
  toArray()
  fromArray()


Class: ModelRequirements  - X-Ref

Represents requirements that implementing code has for AI model selection.

This class defines the capabilities and options that a model must support
in order to be considered suitable for the implementing code's needs.

__construct(array $requiredCapabilities, array $requiredOptions)   X-Ref
Constructor.

param: list<CapabilityEnum> $requiredCapabilities The capabilities that the model must support.
param: list<RequiredOption> $requiredOptions The options that the model must support with specific values.

getRequiredCapabilities()   X-Ref
Gets the capabilities that the model must support.

return: list<CapabilityEnum> The required capabilities.

getRequiredOptions()   X-Ref
Gets the options that the model must support with specific values.

return: list<RequiredOption> The required options.

areMetBy(\WordPress\AiClient\Providers\Models\DTO\ModelMetadata $metadata)   X-Ref
Checks whether the given model metadata meets these requirements.

return: bool True if the model meets all requirements, false otherwise.
param: ModelMetadata $metadata The model metadata to check against.

fromPromptData(CapabilityEnum $capability, array $messages, \WordPress\AiClient\Providers\Models\DTO\ModelConfig $modelConfig)   X-Ref
Creates ModelRequirements from prompt data and model configuration.

return: self The created requirements.
param: CapabilityEnum $capability The capability the model must support.
param: list<Message> $messages The messages in the conversation.
param: ModelConfig $modelConfig The model configuration.

toRequiredOptions(\WordPress\AiClient\Providers\Models\DTO\ModelConfig $modelConfig)   X-Ref
Converts ModelConfig to an array of RequiredOptions.

return: list<RequiredOption> The required options.
param: ModelConfig $modelConfig The model configuration.

includeInRequiredOptions(array $requiredOptions, \WordPress\AiClient\Providers\Models\DTO\RequiredOption $newOption)   X-Ref
Includes a RequiredOption in the array, ensuring no duplicates based on option name.

return: list<RequiredOption> The updated required options array.
param: list<RequiredOption> $requiredOptions The existing required options.
param: RequiredOption $newOption The new option to include.

getJsonSchema()   X-Ref
{@inheritDoc}


toArray()   X-Ref
{@inheritDoc}

return: ModelRequirementsArrayShape

fromArray(array $array)   X-Ref
{@inheritDoc}




Generated : Sat Jun 13 09:38:55 2026 Cross-referenced by PHPXref