ApiEmbedding

Struct ApiEmbedding 

Source
pub struct ApiEmbedding { /* private fields */ }
Expand description

API-based embedding provider (OpenAI, Anthropic, Cohere, etc.)

Supports any API that accepts JSON and returns embeddings in a standard format.

§Example (OpenAI)

use ruvector_core::embeddings::{EmbeddingProvider, ApiEmbedding};

let provider = ApiEmbedding::openai("sk-...", "text-embedding-3-small");
let embedding = provider.embed("hello world")?;

Implementations§

Source§

impl ApiEmbedding

Source

pub fn new( api_key: String, endpoint: String, model: String, dimensions: usize, ) -> Self

Create a new API embedding provider

§Arguments
  • api_key - API key for authentication
  • endpoint - API endpoint URL
  • model - Model identifier
  • dimensions - Expected embedding dimensions
Source

pub fn openai(api_key: &str, model: &str) -> Self

Create OpenAI embedding provider

§Models
  • text-embedding-3-small - 1536 dimensions, $0.02/1M tokens
  • text-embedding-3-large - 3072 dimensions, $0.13/1M tokens
  • text-embedding-ada-002 - 1536 dimensions (legacy)
Source

pub fn cohere(api_key: &str, model: &str) -> Self

Create Cohere embedding provider

§Models
  • embed-english-v3.0 - 1024 dimensions
  • embed-multilingual-v3.0 - 1024 dimensions
Source

pub fn voyage(api_key: &str, model: &str) -> Self

Create Voyage AI embedding provider

§Models
  • voyage-2 - 1024 dimensions
  • voyage-large-2 - 1536 dimensions

Trait Implementations§

Source§

impl Clone for ApiEmbedding

Source§

fn clone(&self) -> ApiEmbedding

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl EmbeddingProvider for ApiEmbedding

Source§

fn embed(&self, text: &str) -> Result<Vec<f32>>

Generate embedding vector for the given text
Source§

fn dimensions(&self) -> usize

Get the dimensionality of embeddings produced by this provider
Source§

fn name(&self) -> &str

Get a description of this provider (for logging/debugging)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more