[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  declare (strict_types=1);
   4  namespace WordPress\AiClient\Providers\ApiBasedImplementation\Contracts;
   5  
   6  use WordPress\AiClient\Providers\Http\DTO\RequestOptions;
   7  use WordPress\AiClient\Providers\Models\Contracts\ModelInterface;
   8  /**
   9   * Interface for API-based AI models that support HTTP transport configuration.
  10   *
  11   * This interface extends ModelInterface to add request options support
  12   * for models that communicate with external APIs via HTTP.
  13   *
  14   * @since 0.3.0
  15   */
  16  interface ApiBasedModelInterface extends ModelInterface
  17  {
  18      /**
  19       * Sets the request options for HTTP transport.
  20       *
  21       * @since 0.3.0
  22       *
  23       * @param RequestOptions $requestOptions The request options to use.
  24       * @return void
  25       */
  26      public function setRequestOptions(RequestOptions $requestOptions): void;
  27      /**
  28       * Gets the request options for HTTP transport.
  29       *
  30       * @since 0.3.0
  31       *
  32       * @return RequestOptions|null The request options, or null if not set.
  33       */
  34      public function getRequestOptions(): ?RequestOptions;
  35  }