Skip to main content

VectorSearchOptions

Struct VectorSearchOptions 

Source
pub struct VectorSearchOptions {
    pub top: usize,
    pub skip: usize,
    pub include_vectors: bool,
    pub vector_field_name: Option<String>,
    pub filter: Option<FilterExpression>,
    pub provider_filter: Option<String>,
}
Expand description

Paging and shaping options for a search.

Fields§

§top: usize

Maximum number of records to return. Must be greater than zero.

§skip: usize

Number of leading records to skip.

§include_vectors: bool

Whether returned records carry their vector fields.

§vector_field_name: Option<String>

Which vector field to search, when the collection has several.

§filter: Option<FilterExpression>

A portable filter, translated by each connector into its own dialect.

See filters for the operator set and its semantics. A connector that cannot express an operator refuses the search rather than dropping the condition — a dropped filter reads as a passing retrieval test while scoping is silently broken.

§provider_filter: Option<String>

A filter in the provider’s own dialect, passed through verbatim.

The escape hatch for what the portable operator set cannot say — Azure AI Search’s search.ismatch, a geo predicate, a provider function. It is not portable: a collection swapped for another provider’s will reject it. When both this and Self::filter are set, a connector conjoins them.

Implementations§

Source§

impl VectorSearchOptions

Source

pub fn new(top: usize) -> VectorSearchOptions

Source

pub fn with_skip(self, skip: usize) -> VectorSearchOptions

Source

pub fn with_include_vectors(self, include: bool) -> VectorSearchOptions

Source

pub fn with_vector_field_name( self, name: impl Into<String>, ) -> VectorSearchOptions

Source

pub fn with_filter( self, filter: impl Into<FilterExpression>, ) -> VectorSearchOptions

Scope the search with a portable FilterExpression.

Source

pub fn with_provider_filter( self, filter: impl Into<String>, ) -> VectorSearchOptions

Scope the search with a filter in the provider’s own dialect.

Source

pub fn validate(&self) -> Result<(), Error>

Reject options a provider cannot act on. Mirrors upstream’s _validate_paging; skip needs no check because usize cannot be negative.

Trait Implementations§

Source§

impl Clone for VectorSearchOptions

Source§

fn clone(&self) -> VectorSearchOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VectorSearchOptions

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Default for VectorSearchOptions

Source§

fn default() -> VectorSearchOptions

Returns the “default value” for a type. Read more
Source§

impl PartialEq for VectorSearchOptions

Source§

fn eq(&self, other: &VectorSearchOptions) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for VectorSearchOptions

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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 = !

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

fn try_from(value: U) -> Result<T, !>

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<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