| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 390 lines (19 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ModelRequirements:: (13 methods):
__construct()
getRequiredCapabilities()
getRequiredOptions()
areMetBy()
getUnmetRequirements()
fromPromptData()
fromEmbeddingData()
inputModalityForPart()
toRequiredOptions()
includeInRequiredOptions()
getJsonSchema()
toArray()
fromArray()
Class: ModelRequirements - X-Ref
Represents requirements that implementing code has for AI model selection.| __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. |
| getUnmetRequirements(\WordPress\AiClient\Providers\Models\DTO\ModelMetadata $metadata) X-Ref |
| Determines which of these requirements the given model metadata does not meet. Unlike {@see self::areMetBy()}, this method reports the specific capabilities and options that are unsupported, so that calling code can explain why a model is unsuitable. return: UnmetModelRequirementsShape The unsupported capabilities and options. Both lists are empty if the 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. |
| fromEmbeddingData(array $inputs, \WordPress\AiClient\Providers\Models\DTO\ModelConfig $modelConfig) X-Ref |
| Creates ModelRequirements from embedding input data and model configuration. Unlike {@see self::fromPromptData()}, embedding inputs are independent items rather than a conversation, so no chat history capability is inferred. Each input contributes its input modality (text or file) to the requirements. return: self The created requirements. param: list<MessagePart> $inputs The embedding inputs. param: ModelConfig $modelConfig The model configuration. |
| inputModalityForPart(MessagePart $part) X-Ref |
| Determines the input modality contributed by a message part, if any. return: ModalityEnum|null The input modality, or null if the part contributes none. param: MessagePart $part The message part to analyze. |
| 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 : Sun Nov 1 08:20:35 2026 | Cross-referenced by PHPXref |