Hypervel\Ai\Ai | Hypervel API

class Ai extends Facade mixin AiManager

Constants

protected STATE_CONTEXT_KEY

The context key for the coroutine-local facade roots.

Properties

static protected Container\|null	$app	The application instance being facaded.	from Facade
static protected array	$resolvedInstance	The resolved object instances.	from Facade
static protected array<string, true>	$scopedAccessors	Accessors whose resolved objects belong to a coroutine scope.	from Facade
static protected array<string, int>	$coroutineAccessors	Accessors with coroutine-local roots, and their current generation.	from Facade
static protected bool	$cached	Indicates if the resolved instance should be cached.	from Facade

Methods

static void

resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from Facade

static MockInterface|null

spy()

Convert the facade into a Mockery spy.

from Facade

static MockInterface

partialMock()

Initiate a partial mock on the facade.

from Facade

static CompositeExpectation|Expectation|HigherOrderMessage

shouldReceive()

Initiate a mock expectation on the facade.

from Facade

static CompositeExpectation|Expectation|ExpectsHigherOrderMessage

expects()

Initiate a mock expectation on the facade.

from Facade

static MockInterface

createFreshMockInstance()

Create a fresh mock instance for the given class.

from Facade

static MockInterface

createMock()

Create a fresh mock instance for the given class.

from Facade

static bool

isMock()

Determines whether a mock is set as the instance of the facade.

from Facade

static string|null

getMockableClass()

Get the mockable class for the bound instance.

from Facade

static void

swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from Facade

static bool

isFake()

Determines whether a "fake" has been set as the facade instance.

from Facade

static mixed

getFacadeRoot()

Get the root object behind the facade.

from Facade

static string

getFacadeAccessor()

Get the registered name of the component.

static mixed

resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from Facade

static void

clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

from Facade

static void

clearResolvedInstances()

Clear all of the resolved instances.

from Facade

static Collection

defaultAliases()

Get the application default aliases.

from Facade

static Container|null

getFacadeApplication()

Get the application instance behind the facade.

from Facade

static void

setFacadeApplication(Container|null $app)

Set the application instance.

from Facade

static mixed

__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from Facade

static AiManager

assertAgentNeverPrompted(string $agent)

No description

static AiManager

assertAgentNeverQueued(string $agent)

No description

static AiManager

assertAgentNotPrompted(string $agent, Closure|string $callback, array|null $prompts = 'null', string|null $message = 'null')

No description

static AiManager

assertAgentNotQueued(string $agent, Closure|string $callback)

No description

static AiManager

assertAgentWasPrompted(string $agent, Closure|string $callback, array|null $prompts = 'null', string|null $message = 'null')

No description

static AiManager

assertAgentWasPromptedTimes(string $agent, int $times = '1')

No description

static AiManager

assertAgentWasQueued(string $agent, Closure|string $callback)

No description

static AiManager

assertAudioGenerated(Closure $callback)

No description

static AiManager

assertAudioNotGenerated(Closure $callback)

No description

static AiManager

assertAudioNotQueued(Closure $callback)

No description

static AiManager

assertAudioQueued(Closure $callback)

No description

static AiManager

assertClassified(Closure $callback)

No description

static AiManager

assertEmbeddingsGenerated(Closure $callback)

No description

static AiManager

assertEmbeddingsNotGenerated(Closure $callback)

No description

static AiManager

assertEmbeddingsNotQueued(Closure $callback)

No description

static AiManager

assertEmbeddingsQueued(Closure $callback)

No description

static AiManager

assertFileAddedToStore(Closure|string $storeId, string|null $fileId = 'null')

No description

static AiManager

assertFileDeleted(Closure|string $callback)

No description

static AiManager

assertFileNotAddedToStore(Closure|string $storeId, string|null $fileId = 'null')

No description

static AiManager

assertFileNotDeleted(Closure|string $callback)

No description

static AiManager

assertFileNotRemovedFromStore(Closure|string $storeId, string|null $fileId = 'null')

No description

static AiManager

assertFileNotUploaded(Closure $callback)

No description

static AiManager

assertFileRemovedFromStore(Closure|string $storeId, string|null $fileId = 'null')

No description

static AiManager

assertFileUploaded(Closure $callback)

No description

static AiManager

assertImageGenerated(Closure $callback)

No description

static AiManager

assertImageNotGenerated(Closure $callback)

No description

static AiManager

assertImageNotQueued(Closure $callback)

No description

static AiManager

assertImageQueued(Closure $callback)

No description

static AiManager

assertNoAudioGenerated()

No description

static AiManager

assertNoAudioQueued()

No description

static AiManager

assertNoEmbeddingsGenerated()

No description

static AiManager

assertNoEmbeddingsQueued()

No description

static AiManager

assertNoFilesDeleted()

No description

static AiManager

assertNoFilesUploaded()

No description

static AiManager

assertNoImagesGenerated()

No description

static AiManager

assertNoImagesQueued()

No description

static AiManager

assertNoStoresCreated()

No description

static AiManager

assertNoStoresDeleted()

No description

static AiManager

assertNotClassified(Closure $callback)

No description

static AiManager

assertNothingClassified()

No description

static AiManager

assertNothingReranked()

No description

static AiManager

assertNoTranscriptionsGenerated()

No description

static AiManager

assertNoTranscriptionsQueued()

No description

static AiManager

assertNotReranked(Closure $callback)

No description

static AiManager

assertReranked(Closure $callback)

No description

static AiManager

assertStoreCreated(Closure|string $callback)

No description

static AiManager

assertStoreDeleted(Closure|string $callback)

No description

static AiManager

assertStoreNotCreated(Closure|string $callback)

No description

static AiManager

assertStoreNotDeleted(Closure|string $callback)

No description

static AiManager

assertTranscriptionGenerated(Closure $callback)

No description

static AiManager

assertTranscriptionNotGenerated(Closure $callback)

No description

static AiManager

assertTranscriptionNotQueued(Closure $callback)

No description

static AiManager

assertTranscriptionQueued(Closure $callback)

No description

static bool

audioIsFaked()

No description

static AudioProvider

audioProvider(Provider|string|null $name = 'null')

No description

static Provider

build(array $config)

No description

static Closure

captureContext()

No description

static void

captureContextUsing(Closure $capture)

No description

static bool

classificationIsFaked()

No description

static ClassificationProvider

classificationProvider(Provider|string|null $name = 'null')

No description

static string|int|null

conversationPartition()

No description

static string|null

conversationPartitionColumn()

No description

static AnthropicProvider

createAnthropicDriver(array $config)

No description

static AzureOpenAiProvider

createAzureDriver(array $config)

No description

static BedrockProvider

createBedrockDriver(array $config)

No description

static CohereProvider

createCohereDriver(array $config)

No description

static DeepSeekProvider

createDeepseekDriver(array $config)

No description

static ElevenLabsProvider

createElevenDriver(array $config)

No description

static GeminiProvider

createGeminiDriver(array $config)

No description

static GroqProvider

createGroqDriver(array $config)

No description

static JinaProvider

createJinaDriver(array $config)

No description

static MistralProvider

createMistralDriver(array $config)

No description

static OllamaProvider

createOllamaDriver(array $config)

No description

static OpenAiCompatibleProvider

createOpenaiCompatibleDriver(array $config)

No description

static OpenAiProvider

createOpenaiDriver(array $config)

No description

static OpenRouterProvider

createOpenrouterDriver(array $config)

No description

static TypeSafeProvider

createTypesafeDriver(array $config)

No description

static VoyageAiProvider

createVoyageaiDriver(array $config)

No description

static XaiProvider

createXaiDriver(array $config)

No description

static EmbeddingProvider

embeddingProvider(Provider|string|null $name = 'null')

No description

static bool

embeddingsAreFaked()

No description

static string|null

embeddingsCacheScope()

No description

static AiManager

extend(string $name, Closure $callback)

No description

static AudioProvider

fakeableAudioProvider(Provider|string|null $name = 'null')

No description

static ClassificationProvider

fakeableClassificationProvider(Provider|string|null $name = 'null')

No description

static EmbeddingProvider

fakeableEmbeddingProvider(Provider|string|null $name = 'null')

No description

static FileProvider

fakeableFileProvider(Provider|string|null $name = 'null')

No description

static ImageProvider

fakeableImageProvider(Provider|string|null $name = 'null')

No description

static RerankingProvider

fakeableRerankingProvider(Provider|string|null $name = 'null')

No description

static StoreProvider

fakeableStoreProvider(Provider|string|null $name = 'null')

No description

static TranscriptionProvider

fakeableTranscriptionProvider(Provider|string|null $name = 'null')

No description

static FakeTextGateway

fakeAgent(string $agent, Closure|array $responses = '[]')

No description

static FakeAudioGateway

fakeAudio(Closure|array $responses = '[]')

No description

static FakeAudioGateway|null

fakeAudioGateway()

No description

static FakeClassificationGateway

fakeClassification(Closure|array $responses = '[]')

No description

static FakeClassificationGateway|null

fakeClassificationGateway()

No description

static FakeEmbeddingGateway|null

fakeEmbeddingGateway()

No description

static FakeEmbeddingGateway

fakeEmbeddings(Closure|array $responses = '[]')

No description

static FakeFileGateway|null

fakeFileGateway()

No description

static FakeFileGateway

fakeFiles(Closure|array $responses = '[]')

No description

static FakeTextGateway

fakeGatewayFor(Agent $agent)

No description

static FakeImageGateway|null

fakeImageGateway()

No description

static FakeImageGateway

fakeImages(Closure|array $responses = '[]')

No description

static FakeRerankingGateway

fakeReranking(Closure|array $responses = '[]')

No description

static FakeRerankingGateway|null

fakeRerankingGateway()

No description

static FakeStoreGateway|null

fakeStoreGateway()

No description

static FakeStoreGateway

fakeStores(Closure|array $responses = '[]')

No description

static FakeTranscriptionGateway|null

fakeTranscriptionGateway()

No description

static FakeTranscriptionGateway

fakeTranscriptions(Closure|array $responses = '[]')

No description

static FileProvider

fileProvider(Provider|string|null $name = 'null')

No description

static bool

filesAreFaked()

No description

static void

flushState()

No description

static AiManager

forgetInstance(array|string|null $name = 'null')

No description

static string

getDefaultInstance()

No description

static array

getInstanceConfig(string $name)

No description

static bool

hasFakeGatewayFor(Agent|string $agent)

No description

static ImageProvider

imageProvider(Provider|string|null $name = 'null')

No description

static bool

imagesAreFaked()

No description

static mixed

instance(Provider|string|null $name = 'null')

No description

static void

purge(string|null $name = 'null')

No description

static AiManager

recordAudioGeneration(QueuedAudioPrompt $prompt)

No description

static AiManager

recordClassification(ClassificationPrompt $prompt)

No description

static AiManager

recordEmbeddingsGeneration(QueuedEmbeddingsPrompt $prompt)

No description

static AiManager

recordFileAddition(string $storeId, string $fileId, HasProviderId|string $file)

No description

static AiManager

recordFileDeletion(string $fileId)

No description

static AiManager

recordFileRemoval(string $storeId, string $fileId)

No description

static AiManager

recordFileUpload(StorableFile $file)

No description

static AiManager

recordImageGeneration(QueuedImagePrompt $prompt)

No description

static AiManager

recordPrompt(QueuedAgentPrompt $prompt)

No description

static AiManager

recordReranking(RerankingPrompt $prompt)

No description

static AiManager

recordStoreCreation(string $name, string|null $description = 'null', Collection|null $fileIds = 'null', DateInterval|null $expiresWhenIdleFor = 'null')

No description

static AiManager

recordStoreDeletion(string $storeId)

No description

static AiManager

recordTranscriptionGeneration(QueuedTranscriptionPrompt $prompt)

No description

static bool

rerankingIsFaked()

No description

static RerankingProvider

rerankingProvider(Provider|string|null $name = 'null')

No description

static void

resolveConversationPartitionUsing(string $column, Closure $resolver)

No description

static void

resolveEmbeddingsCacheScopeUsing(Closure $resolver)

No description

static void

resolveProviderConfigUsing(Closure $resolver)

No description

static AiManager

setApplication(Application $app)

No description

static void

setDefaultInstance(string $name)

No description

static StoreProvider

storeProvider(Provider|string|null $name = 'null')

No description

static bool

storesAreFaked()

No description

static TextProvider

textProvider(Provider|string|null $name = 'null')

No description

static TextProvider

textProviderFor(Agent $agent, Provider|string|null $name = 'null')

No description

static TranscriptionProvider

transcriptionProvider(Provider|string|null $name = 'null')

No description

static bool

transcriptionsAreFaked()

No description

Details

in Facade at line 85
`static void resolved(Closure $callback)`

Run a Closure when the facade has been resolved.

The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure

$callback