rig-core 0.44.0

An opinionated library for building LLM powered applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! The Voyage AI client: a [`VoyageAiConfig`] on a transport, and the models
//! it builds.

use crate::client::macros::http_client;
use crate::driver::Model;

use crate::providers::voyageai::wire::{Embeddings, Rerank, VoyageAiConfig};

http_client!(
    /// Voyage AI: its [`VoyageAiConfig`] on a transport. Every model it
    /// builds sends through that transport.
    VoyageAi,
    VoyageAiConfig
);

impl VoyageAi {
    /// Voyage AI with `api_key` and default settings, on the shared reqwest
    /// client.
    #[cfg(feature = "reqwest")]
    #[cfg_attr(docsrs, doc(cfg(feature = "reqwest")))]
    pub fn new(api_key: impl Into<crate::wire::Secret>) -> Self {
        VoyageAiConfig::new(api_key).client()
    }

    /// Voyage AI from `VOYAGE_API_KEY`, on the shared reqwest client.
    #[cfg(feature = "reqwest")]
    #[cfg_attr(docsrs, doc(cfg(feature = "reqwest")))]
    pub fn from_env() -> Result<Self, crate::client::env::EnvError> {
        Ok(VoyageAiConfig::from_env()?.client())
    }

    /// The embedding model for `model`. `ndims` is the width it reports,
    /// defaulting to the model's known width; see
    /// [`Embeddings::with_output_dimension`] to request another.
    pub fn embedding(&self, model: impl Into<String>, ndims: Option<usize>) -> Model<Embeddings> {
        self.model(self.config.embedding(model, ndims))
    }

    /// The rerank model for `model`.
    pub fn rerank(&self, model: impl Into<String>) -> Model<Rerank> {
        self.model(self.config.rerank(model))
    }
}