Skip to main content

VectorSearchResult

Struct VectorSearchResult 

Source
pub struct VectorSearchResult {
    pub record: Value,
    pub score: Option<f64>,
    pub score_kind: Option<String>,
}
Expand description

One search hit: the record, and the provider’s score for it.

Fields§

§record: Value

The record, keyed by logical field name.

§score: Option<f64>

The provider’s similarity or distance score, or None when the provider reports none.

Read the direction from Self::score_kind when it is set, and only otherwise from the collection’s DistanceFunction::higher_is_closer.

§score_kind: Option<String>

What kind of number Self::score is, when the declared distance function does not describe it.

The collection’s distance function is a request — rank by this — and on several services it does not describe what comes back. Azure AI Search answers a vector query with a relevance score where higher is better whatever metric the profile declares, and answers a hybrid query with a reciprocal-rank-fusion score that is not a distance at all. A caller thresholding or fusing on score under the definition’s higher_is_closer would invert the ranking, so the connector says what it actually returned. Mirrors upstream’s score_kind result metadata.

None means the score is in the collection’s declared distance function, as InMemoryVectorStore returns. The values this workspace emits are Self::SCORE_KIND_RELEVANCE and Self::SCORE_KIND_RRF, both higher-is-closer.

Implementations§

Source§

impl VectorSearchResult

Source

pub const SCORE_KIND_RELEVANCE: &'static str = "relevance"

A provider relevance score: higher is a better match, and the value is not a distance in the declared metric.

Source

pub const SCORE_KIND_RRF: &'static str = "rrf"

A reciprocal-rank-fusion score from a hybrid query: higher is a better match, and it is a rank combination rather than any distance.

Source

pub fn higher_is_closer( &self, distance: Option<&DistanceFunction>, ) -> Option<bool>

Whether a higher Self::score means a closer match, given the collection’s declared distance function.

Prefers Self::score_kind over distance, which is the whole point of the field: on a service that ignores the declared metric when scoring, the definition is the wrong thing to read. None when neither answers.

Trait Implementations§

Source§

impl Clone for VectorSearchResult

Source§

fn clone(&self) -> VectorSearchResult

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 VectorSearchResult

Source§

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

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

impl<'de> Deserialize<'de> for VectorSearchResult

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<VectorSearchResult, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for VectorSearchResult

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for VectorSearchResult

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for VectorSearchResult

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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