Skip to main content

SemanticQuery

sphereql_embed::query

Struct SemanticQuery

pub struct SemanticQuery;

Expand description

Builds SphereQL Regions from semantic constraints on embeddings.

Implementations§

impl SemanticQuery

pub fn within_angle<P: Projection>( query: &Embedding, projection: &P, max_angular_distance: f64, ) -> Region

Spherical cap: all points within max_angular_distance radians of the query.

pub fn above_similarity<P: Projection>( query: &Embedding, projection: &P, min_similarity: f64, ) -> Region

Spherical cap from a cosine similarity threshold. cos_sim >= threshold ↔ angular_distance <= arccos(threshold).

pub fn in_shell(inner: f64, outer: f64) -> Region

Radial shell: embeddings whose projected radius falls in [inner, outer].

pub fn similar_in_shell<P: Projection>( query: &Embedding, projection: &P, min_similarity: f64, shell_inner: f64, shell_outer: f64, ) -> Region

Intersection of a similarity cap with a radial shell. “Semantically similar AND within a magnitude/metadata range.”

Auto Trait Implementations§

impl Freeze for SemanticQuery

impl RefUnwindSafe for SemanticQuery

impl Send for SemanticQuery

impl Sync for SemanticQuery

impl Unpin for SemanticQuery

impl UnsafeUnpin for SemanticQuery

impl UnwindSafe for SemanticQuery

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.