interface RerankingProvider implements Provider

Methods

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
rerank(array $documents, string $query, int|null $limit = null, string|null $model = null, int $timeout = 30, array $providerOptions = [])

Rerank the given documents based on their relevance to the query.

rerankingGateway()

Get the provider's reranking gateway.

useRerankingGateway(RerankingGateway $gateway)

Set the provider's reranking gateway.

string
defaultRerankingModel()

Get the name of the default reranking model.

Details

in Provider at line 12
string name()

Get the name of the underlying AI provider.

Return Value

string

in Provider at line 17
string driver()

Get the name of the underlying AI driver.

Return Value

string

in Provider at line 24
array providerCredentials()

Get the credentials for the underlying AI provider.

Return Value

array

in Provider at line 31
array additionalConfiguration()

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

Return Value

array

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

internal  
 

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

Parameters

array $headers

Return Value

Provider

at line 19
RerankingResponse rerank(array $documents, string $query, int|null $limit = null, string|null $model = null, int $timeout = 30, array $providerOptions = [])

Rerank the given documents based on their relevance to the query.

Parameters

array $documents
string $query
int|null $limit
string|null $model
int $timeout
array $providerOptions

Return Value

RerankingResponse

at line 24
RerankingGateway rerankingGateway()

Get the provider's reranking gateway.

Return Value

RerankingGateway

at line 29
RerankingProvider useRerankingGateway(RerankingGateway $gateway)

Set the provider's reranking gateway.

Parameters

RerankingGateway $gateway

Return Value

RerankingProvider

at line 35
string defaultRerankingModel()

Get the name of the default reranking model.

Return Value

string