barrel_embed_voyage (barrel_embed v2.3.1)

View Source

Voyage AI embedding provider

Uses Voyage AI's Embeddings API for embedding generation. Voyage AI provides state-of-the-art embeddings optimized for retrieval.

Requirements

A Voyage AI API key, either: - Set via VOYAGE_API_KEY environment variable - Passed in config as api_key => <<"...">>>

Configuration

   Config = #{
       api_key => <<"...">>,                           %% API key (or use env var)
       url => <<"https://api.voyageai.com/v1">>,       %% API base URL (default)
       model => <<"voyage-3">>,                        %% Model name (default, 1024 dims)
       timeout => 30000,                               %% Timeout in ms (default)
       dimension => 1024                               %% Vector dimension (default)
   }.

Supported Models

- <<"voyage-3">> - Default, 1024 dims, best quality - <<"voyage-3-lite">> - 512 dims, faster/cheaper - <<"voyage-code-3">> - 1024 dims, optimized for code - <<"voyage-finance-2">> - 1024 dims, financial domain - <<"voyage-law-2">> - 1024 dims, legal domain - <<"voyage-large-2">> - 1536 dims, legacy high quality

Summary

Functions

Check if Voyage AI API is available.

Get dimension for this provider.

Generate embedding for a single text.

Generate embeddings for multiple texts. Voyage AI supports native batch embedding.

Initialize the provider.

Provider name.

Functions

available(Config)

-spec available(map()) -> boolean().

Check if Voyage AI API is available.

dimension(Config)

-spec dimension(map()) -> pos_integer().

Get dimension for this provider.

embed(Text, Config)

-spec embed(binary(), map()) -> {ok, [float()]} | {error, term()}.

Generate embedding for a single text.

embed_batch(Texts, Config)

-spec embed_batch([binary()], map()) -> {ok, [[float()]]} | {error, term()}.

Generate embeddings for multiple texts. Voyage AI supports native batch embedding.

init(Config)

-spec init(map()) -> {ok, map()} | {error, term()}.

Initialize the provider.

name()

-spec name() -> atom().

Provider name.