API reference 

Reference for major public classes used by dependent extensions.

AiRequestService 

Namespace:
NITSAN\NsAiUniverse\Service\AiRequestService

Key method:

Main request API 
public function sendRequest(
    string $modelType,
    array $messages,
    string $aiSelectedModel = '',
    array $options = [],
    bool $logRequest = true,
    string $module = '',
    string $scope = ''
): string
Copied!

BaseClient 

Namespace:
NITSAN\NsAiUniverse\Client\BaseClient

Important methods:

  • getRequestData()
  • getResponseData()
  • getStreamRequestData()
  • getStreamChunkText()
  • getEmbeddingRequestData()
  • parseEmbeddingResponse()
  • getOpenAiUsageData()

AiStatisticsService 

Namespace:
NITSAN\NsAiUniverse\Service\AiStatisticsService

Main method:

  • getOpenAiStatistics(string $date = '', int $dateScope = 0, bool $forceRefresh = false): array

AiEngineConfiguration 

Namespace:
NITSAN\NsAiUniverse\Configuration\AiEngineConfiguration

Main methods:

  • getTextGenerationAIEngines(bool $ignoreConfig = false): array
  • getAllAIEngines(bool $ignoreConfig = false): array

HttpAuthUtility 

Namespace:
NITSAN\NsAiUniverse\Utility\HttpAuthUtility

Main methods:

  • fetchContentFromUrl(string $url): string
  • addAuthHeader(ServerRequestInterface $request): ServerRequestInterface
  • isBasicAuthEnabled(): bool

AiUniverseUtilityHelper 

Namespace:
NITSAN\NsAiUniverse\Utility\AiUniverseUtilityHelper

Main methods:

  • getExtensionConf(string $extensionKey = 'ns_aiuniverse'): array
  • setExtensionConf(array $value, string $extensionKey = 'ns_aiuniverse'): void
  • isApiKeySet(string $extensionKey = 'ns_aiuniverse', string $apiKeyName = 'openai_api_key'): bool