CoreFiles by mySites.guru
ModelResolutionTrait.php92 lines, 3,255 bytes, from wordpress-7.2-beta2.zip
Raw History Compare with 7.2-beta1
md5
8a57cedd4fc1a64ebe1ad22e86af5d3a
sha1
ffc0b8425f1141655f5667e9fc0624eb6f78cbad
sha256
9349df9f9016f8d89577a18c92a958a8015f16b5f5b8d2d21360250a300e55df
<?php

declare (strict_types=1);
namespace WordPress\AiClient\Builders\Traits;

use WordPress\AiClient\Common\Exception\InvalidArgumentException;
use WordPress\AiClient\Providers\Http\DTO\RequestOptions;
use WordPress\AiClient\Providers\ModelResolver;
use WordPress\AiClient\Providers\Models\Contracts\ModelInterface;
/**
 * Provides shared model selection methods for builders.
 *
 * Builders that resolve a model from the available providers (e.g.
 * {@see \WordPress\AiClient\Builders\PromptBuilder}) use this trait to expose a consistent fluent API
 * for choosing a model, provider, preferences, and request options. Model selection state and logic
 * live on the {@see ModelResolver} owned by the builder. Model configuration is handled by the
 * composed {@see ModelConfigurationTrait}.
 *
 * @since 1.4.0
 *
 * @phpstan-import-type ProviderModelTuple from ModelResolver
 */
trait ModelResolutionTrait
{
    use \WordPress\AiClient\Builders\Traits\ModelConfigurationTrait;
    /**
     * @var ModelResolver The resolver that owns model selection state and logic.
     */
    protected ModelResolver $modelResolver;
    /**
     * Sets the model to use for generation.
     *
     * The model's configuration will be merged with the builder's configuration,
     * with the builder's configuration taking precedence for any overlapping settings.
     *
     * @since 0.1.0
     *
     * @param ModelInterface $model The model to use.
     * @return self
     */
    public function usingModel(ModelInterface $model): self
    {
        $this->modelResolver->setModel($model);
        // Merge model's config with builder's config, with builder's config taking precedence
        $this->mergeModelConfig($model->getConfig());
        return $this;
    }
    /**
     * Sets preferred models to evaluate in order.
     *
     * @since 0.2.0
     *
     * @param string|ModelInterface|ProviderModelTuple ...$preferredModels 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 self
     *
     * @throws InvalidArgumentException When a preferred model has an invalid type or identifier.
     */
    public function usingModelPreference(...$preferredModels): self
    {
        $this->modelResolver->setModelPreferences(...$preferredModels);
        return $this;
    }
    /**
     * Sets the provider to use for generation.
     *
     * @since 0.1.0
     *
     * @param string $providerIdOrClassName The provider ID or class name.
     * @return self
     */
    public function usingProvider(string $providerIdOrClassName): self
    {
        $this->modelResolver->setProvider($providerIdOrClassName);
        return $this;
    }
    /**
     * Sets the request options for HTTP transport.
     *
     * @since 0.3.0
     *
     * @param RequestOptions $requestOptions The request options.
     * @return self
     */
    public function usingRequestOptions(RequestOptions $requestOptions): self
    {
        $this->modelResolver->setRequestOptions($requestOptions);
        return $this;
    }
}

The same content is in 6 releases, WordPress 7.2-beta1 to 7.2-RC1. See them all, or every version of this file.