[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  declare (strict_types=1);
   4  namespace WordPress\AiClient\Providers\Contracts;
   5  
   6  use WordPress\AiClient\Common\Exception\InvalidArgumentException;
   7  use WordPress\AiClient\Providers\Models\DTO\ModelMetadata;
   8  /**
   9   * Interface for accessing model metadata within a provider.
  10   *
  11   * Provides methods to list, check, and retrieve model metadata
  12   * for all models supported by a provider.
  13   *
  14   * @since 0.1.0
  15   */
  16  interface ModelMetadataDirectoryInterface
  17  {
  18      /**
  19       * Lists all available model metadata.
  20       *
  21       * @since 0.1.0
  22       *
  23       * @return list<ModelMetadata> Array of model metadata.
  24       */
  25      public function listModelMetadata(): array;
  26      /**
  27       * Checks if metadata exists for a specific model.
  28       *
  29       * @since 0.1.0
  30       *
  31       * @param string $modelId Model identifier.
  32       * @return bool True if metadata exists, false otherwise.
  33       */
  34      public function hasModelMetadata(string $modelId): bool;
  35      /**
  36       * Gets metadata for a specific model.
  37       *
  38       * @since 0.1.0
  39       *
  40       * @param string $modelId Model identifier.
  41       * @return ModelMetadata Model metadata.
  42       * @throws InvalidArgumentException If model metadata not found.
  43       */
  44      public function getModelMetadata(string $modelId): ModelMetadata;
  45  }