- md5
- 8adc33918da473edb89bf969dc68c6f4
- sha1
- 1c36e50817b342b7c326319f3a95332ea717ff5b
- sha256
- b8a9eb9f29aa2631cbb7b38521949650ef16c92b138ec1d3fab320ec0ed91da6
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
<?php
declare (strict_types=1);
namespace WordPress\AiClient\Providers\ApiBasedImplementation;
use WordPress\AiClient\AiClient;
use WordPress\AiClient\Common\Contracts\CachesDataInterface;
use WordPress\AiClient\Common\Exception\InvalidArgumentException;
use WordPress\AiClient\Common\Traits\WithDataCachingTrait;
use WordPress\AiClient\Providers\Contracts\ModelMetadataDirectoryInterface;
use WordPress\AiClient\Providers\Http\Contracts\WithHttpTransporterInterface;
use WordPress\AiClient\Providers\Http\Contracts\WithRequestAuthenticationInterface;
use WordPress\AiClient\Providers\Http\Traits\WithHttpTransporterTrait;
use WordPress\AiClient\Providers\Http\Traits\WithRequestAuthenticationTrait;
use WordPress\AiClient\Providers\Models\DTO\ModelMetadata;
/**
* Base class for an API-based model metadata directory for a provider.
*
* @since 0.1.0
*/
abstract class AbstractApiBasedModelMetadataDirectory implements ModelMetadataDirectoryInterface, WithHttpTransporterInterface, WithRequestAuthenticationInterface, CachesDataInterface
{
use WithHttpTransporterTrait;
use WithRequestAuthenticationTrait;
use WithDataCachingTrait;
/**
* The cache key suffix for the models list.
*
* @since 0.4.0
*
* @var string
*/
private const MODELS_CACHE_KEY = 'models';
/**
* Request-local cache for explicit model metadata lookups.
*
* @since 1.5.0
*
* @var array<string, ModelMetadata|null>
*/
private array $explicitModelMetadataCache = [];
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
final public function listModelMetadata(): array
{
$modelsMetadata = $this->getModelMetadataMap();
$explicitModelsMetadata = $this->getExplicitModelMetadataMap(array_keys($modelsMetadata));
return array_values(array_replace($modelsMetadata, $explicitModelsMetadata));
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
final public function hasModelMetadata(string $modelId): bool
{
if (isset($this->getExplicitModelMetadataMap([$modelId])[$modelId])) {
return \true;
}
$modelsMetadata = $this->getModelMetadataMap();
return isset($modelsMetadata[$modelId]);
}
/**
* {@inheritDoc}
*
* @since 0.1.0
*/
final public function getModelMetadata(string $modelId): ModelMetadata
{
$explicitModelsMetadata = $this->getExplicitModelMetadataMap([$modelId]);
if (isset($explicitModelsMetadata[$modelId])) {
return $explicitModelsMetadata[$modelId];
}
$modelsMetadata = $this->getModelMetadataMap();
if (!isset($modelsMetadata[$modelId])) {
throw new InvalidArgumentException(sprintf('No model with ID %s was found in the provider', $modelId));
}
return $modelsMetadata[$modelId];
}
/**
* Gets explicit model metadata using request-local memoization.
*
* @since 1.5.0
*
* @param list<string> $modelIds Model IDs for which to get explicit metadata.
* @return array<string, ModelMetadata> Map of model ID to explicit model metadata.
*/
private function getExplicitModelMetadataMap(array $modelIds): array
{
$uncheckedModelIds = [];
foreach ($modelIds as $modelId) {
if (!array_key_exists($modelId, $this->explicitModelMetadataCache)) {
$uncheckedModelIds[] = $modelId;
}
}
if ($uncheckedModelIds) {
$explicitModelsMetadata = $this->createModelMetadataForExplicitModelIds($uncheckedModelIds);
foreach ($uncheckedModelIds as $modelId) {
$this->explicitModelMetadataCache[$modelId] = $explicitModelsMetadata[$modelId] ?? null;
}
}
return array_filter(array_intersect_key($this->explicitModelMetadataCache, array_flip($modelIds)));
}
/**
* Returns the map of model ID to model metadata for all models from the provider.
*
* @since 0.1.0
*
* @return array<string, ModelMetadata> Map of model ID to model metadata.
*/
private function getModelMetadataMap(): array
{
/** @var array<string, ModelMetadata> */
return $this->cached(self::MODELS_CACHE_KEY, fn() => $this->sendListModelsRequest(), 86400);
}
/**
* {@inheritDoc}
*
* @since 0.4.0
*/
protected function getCachedKeys(): array
{
return [self::MODELS_CACHE_KEY];
}
/**
* {@inheritDoc}
*
* @since 0.4.0
*/
protected function getBaseCacheKey(): string
{
return 'ai_client_' . AiClient::VERSION . '_' . md5(static::class);
}
/**
* Creates metadata for explicit model IDs without listing provider models.
*
* Providers whose APIs accept arbitrary/current model IDs can override this to avoid a live list-models request
* when callers already know the model ID they want to instantiate.
*
* @since 1.5.0
*
* @param list<string> $modelIds The explicit model IDs.
* @return array<string, ModelMetadata> Map of model ID to model metadata. Omit IDs that should fall back to the
* provider models list.
*/
protected function createModelMetadataForExplicitModelIds(array $modelIds): array
{
return [];
}
/**
* Sends the API request to list models from the provider and returns the map of model ID to model metadata.
*
* @since 0.1.0
*
* @return array<string, ModelMetadata> Map of model ID to model metadata.
*/
abstract protected function sendListModelsRequest(): array;
}
The same content is in 5 releases, WordPress 7.2-beta1 to 7.2-beta5. See them all, or every version of this file.