Voyage AI

Configuration

'voyageai' => [
    'api_key' => env('VOYAGEAI_API_KEY', ''),
],

Provider specific options

You can change some options on your request specific to Voyage AI by using ->withProviderMeta().

Input type

By default, Voyage AI generates general purpose vectors.

However, they taylor your vectors for the task they are intended for - for search ("query") or for retrieval ("document"):

For search / querying:

use PrismPHP\Prism\Enums\Provider;
use PrismPHP\Prism\Prism;

Prism::embeddings()
    ->using(Provider::VoyageAI, 'voyage-3-lite')
    ->fromInput('The food was delicious and the waiter...')
    ->withProviderMeta(Provider::VoyageAI, ['inputType' => 'query'])
    ->generate();

For document retrieval:

use PrismPHP\Prism\Enums\Provider;
use PrismPHP\Prism\Prism;

Prism::embeddings()
    ->using(Provider::VoyageAI, 'voyage-3-lite')
    ->fromInput('The food was delicious and the waiter...')
    ->withProviderMeta(Provider::VoyageAI, ['inputType' => 'document'])
    ->generate();

Truncation

By default, Voyage AI truncates inputs that are over the context length.

You can force it to throw an error instead by setting truncation to false.

use PrismPHP\Prism\Enums\Provider;
use PrismPHP\Prism\Prism;

Prism::embeddings()
    ->using(Provider::VoyageAI, 'voyage-3-lite')
    ->fromInput('The food was delicious and the waiter...')
    ->withProviderMeta(Provider::VoyageAI, ['truncation' => false])
    ->generate();

Truncation