class TypeSafeProvider extends Provider implements ClassificationProvider

Traits

Properties

protected ClassificationGateway $classificationGateway from  HasClassificationGateway

Methods

__construct(array $config, Dispatcher $events)

Create a TypeSafe provider instance.

string
name()

Get the name of the underlying AI provider.

from  Provider
string
driver()

Get the name of the underlying AI driver.

from  Provider
array
providerCredentials()

Get the credentials for the underlying AI provider.

from  Provider
array
additionalConfiguration()

Get the provider connection configuration other than the driver, key, and name.

from  Provider
withHeaders(array $headers)

Get a provider instance that sends the given HTTP headers with each request.

from  Provider
mixed
dispatchingFailure(Closure $call, Closure $failed)

Run the given gateway call, dispatching the event built from its exception before rethrowing.

from  Provider
static array
formatProviderAndModelList(Provider|Lab|array|string $providers, string|null $model = null)

Format the given provider / model list.

from  Provider
static array
providerAndModelPairs(Provider|Lab|array|string $providers, string|null $model = null)

Get provider and model pairs without discarding on-demand instances.

from  Provider
array
__serialize()

Get the serializable representation of the provider.

from  Provider
void
__unserialize(array $data)

Restore the provider from its serialized representation.

from  Provider
string
__toString()

Convert the provider to its string representation.

from  Provider
classify(string|array $state, array $questions, string|null $model = null, int $timeout = 30, array $providerOptions = [], array $attachments = [])

Answer the given questions about the state.

bool
supportsClassificationAttachments()

Determine if the provider can classify attachments alongside the state.

classificationGateway()

Get the provider's classification gateway.

useClassificationGateway(ClassificationGateway $gateway)

Set the provider's classification gateway.

string
defaultClassificationModel()

Get the name of the default classification model.

Details

at line 22
__construct(array $config, Dispatcher $events)

Create a TypeSafe provider instance.

Parameters

array $config
Dispatcher $events

in Provider at line 34
string name()

Get the name of the underlying AI provider.

Return Value

string

in Provider at line 42
string driver()

Get the name of the underlying AI driver.

Return Value

string

in Provider at line 50
array providerCredentials()

Get the credentials for the underlying AI provider.

Return Value

array

in Provider at line 60
array additionalConfiguration()

Get the provider connection configuration other than the driver, key, and name.

Return Value

array

in Provider at line 72
Provider withHeaders(array $headers)

internal  
 

Get a provider instance that sends the given HTTP headers with each request.

Parameters

array $headers

Return Value

Provider

in Provider at line 92
protected mixed dispatchingFailure(Closure $call, Closure $failed)

Run the given gateway call, dispatching the event built from its exception before rethrowing.

Parameters

Closure $call
Closure $failed

Return Value

mixed

in Provider at line 114
static array formatProviderAndModelList(Provider|Lab|array|string $providers, string|null $model = null)

Format the given provider / model list.

Parameters

Provider|Lab|array|string $providers
string|null $model

Return Value

array

in Provider at line 132
static array providerAndModelPairs(Provider|Lab|array|string $providers, string|null $model = null)

internal  
 

Get provider and model pairs without discarding on-demand instances.

Parameters

Provider|Lab|array|string $providers
string|null $model

Return Value

array

in Provider at line 164
array __serialize()

Get the serializable representation of the provider.

Return Value

array

in Provider at line 174
void __unserialize(array $data)

Restore the provider from its serialized representation.

Parameters

array $data

Return Value

void

in Provider at line 190
string __toString()

Convert the provider to its string representation.

Return Value

string

in Classifies at line 30
ClassificationResponse classify(string|array $state, array $questions, string|null $model = null, int $timeout = 30, array $providerOptions = [], array $attachments = [])

Answer the given questions about the state.

Parameters

string|array $state
array $questions
string|null $model
int $timeout
array $providerOptions
array $attachments

Return Value

ClassificationResponse

at line 39
bool supportsClassificationAttachments()

Determine if the provider can classify attachments alongside the state.

Return Value

bool

at line 47
ClassificationGateway classificationGateway()

Get the provider's classification gateway.

Return Value

ClassificationGateway

HasClassificationGateway useClassificationGateway(ClassificationGateway $gateway)

Set the provider's classification gateway.

Changing a shared provider's gateway affects subsequent operations.

Parameters

ClassificationGateway $gateway

Return Value

HasClassificationGateway

at line 31
string defaultClassificationModel()

Get the name of the default classification model.

Return Value

string